Sat Apr 26 2014 22:01:51

Asterisk developer's documentation


app_senddtmf.c File Reference

App to send DTMF digits. More...

#include "asterisk.h"
#include "asterisk/pbx.h"
#include "asterisk/module.h"
#include "asterisk/app.h"
#include "asterisk/manager.h"
#include "asterisk/channel.h"
Include dependency graph for app_senddtmf.c:

Go to the source code of this file.

Functions

static void __reg_module (void)
static void __unreg_module (void)
static int load_module (void)
static int manager_play_dtmf (struct mansession *s, const struct message *m)
static int senddtmf_exec (struct ast_channel *chan, const char *vdata)
static int unload_module (void)

Variables

static struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Send DTMF digits Application" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, }
static struct ast_module_infoast_module_info = &__mod_info
static const char senddtmf_name [] = "SendDTMF"

Detailed Description

App to send DTMF digits.

Author:
Mark Spencer <markster@digium.com>

Definition in file app_senddtmf.c.


Function Documentation

static void __reg_module ( void  ) [static]

Definition at line 190 of file app_senddtmf.c.

static void __unreg_module ( void  ) [static]

Definition at line 190 of file app_senddtmf.c.

static int manager_play_dtmf ( struct mansession s,
const struct message m 
) [static]

Definition at line 144 of file app_senddtmf.c.

References ast_channel_get_by_name(), ast_channel_unref, ast_senddigit(), ast_strlen_zero(), astman_get_header(), astman_send_ack(), and astman_send_error().

Referenced by load_module().

{
   const char *channel = astman_get_header(m, "Channel");
   const char *digit = astman_get_header(m, "Digit");
   struct ast_channel *chan;

   if (!(chan = ast_channel_get_by_name(channel))) {
      astman_send_error(s, m, "Channel not found");
      return 0;
   }

   if (ast_strlen_zero(digit)) {
      astman_send_error(s, m, "No digit specified");
      chan = ast_channel_unref(chan);
      return 0;
   }

   ast_senddigit(chan, *digit, 0);

   chan = ast_channel_unref(chan);

   astman_send_ack(s, m, "DTMF successfully queued");

   return 0;
}
static int senddtmf_exec ( struct ast_channel chan,
const char *  vdata 
) [static]

Definition at line 91 of file app_senddtmf.c.

References args, AST_APP_ARG, ast_app_parse_timelen(), ast_channel_get_by_name(), ast_channel_unref, AST_DECLARE_APP_ARGS, ast_dtmf_stream(), ast_log(), AST_STANDARD_APP_ARGS, ast_strlen_zero(), LOG_WARNING, and TIMELEN_MILLISECONDS.

Referenced by load_module().

{
   int res;
   char *data;
   int dinterval = 0, duration = 0;
   struct ast_channel *chan_found = NULL;
   struct ast_channel *chan_dest = chan;
   struct ast_channel *chan_autoservice = NULL;
   AST_DECLARE_APP_ARGS(args,
      AST_APP_ARG(digits);
      AST_APP_ARG(dinterval);
      AST_APP_ARG(duration);
      AST_APP_ARG(channel);
   );

   if (ast_strlen_zero(vdata)) {
      ast_log(LOG_WARNING, "SendDTMF requires an argument\n");
      return 0;
   }

   data = ast_strdupa(vdata);
   AST_STANDARD_APP_ARGS(args, data);

   if (ast_strlen_zero(args.digits)) {
      ast_log(LOG_WARNING, "The digits argument is required (0-9,*#,a-d,A-D,wfF)\n");
      return 0;
   }
   if (!ast_strlen_zero(args.dinterval)) {
      ast_app_parse_timelen(args.dinterval, &dinterval, TIMELEN_MILLISECONDS);
   }
   if (!ast_strlen_zero(args.duration)) {
      ast_app_parse_timelen(args.duration, &duration, TIMELEN_MILLISECONDS);
   }
   if (!ast_strlen_zero(args.channel)) {
      chan_found = ast_channel_get_by_name(args.channel);
      if (!chan_found) {
         ast_log(LOG_WARNING, "No such channel: %s\n", args.channel);
         return 0;
      }
      chan_dest = chan_found;
      if (chan_found != chan) {
         chan_autoservice = chan;
      }
   }
   res = ast_dtmf_stream(chan_dest, chan_autoservice, args.digits,
      dinterval <= 0 ? 250 : dinterval, duration);
   if (chan_found) {
      ast_channel_unref(chan_found);
   }

   return chan_autoservice ? 0 : res;
}
static int unload_module ( void  ) [static]

Definition at line 170 of file app_senddtmf.c.

References ast_manager_unregister(), and ast_unregister_application().

{
   int res;

   res = ast_unregister_application(senddtmf_name);
   res |= ast_manager_unregister("PlayDTMF");

   return res;
}

Variable Documentation

struct ast_module_info __mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_LOAD_ORDER , .description = "Send DTMF digits Application" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = AST_BUILDOPT_SUM, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_DEFAULT, } [static]

Definition at line 190 of file app_senddtmf.c.

Definition at line 190 of file app_senddtmf.c.

const char senddtmf_name[] = "SendDTMF" [static]

Definition at line 89 of file app_senddtmf.c.