Codename Pineapple

Home page | Mailing list | Docs

Last updated: Sat Feb 3 05:01:37 2007

Asterisk developer's documentation :: Codename Pineapple

include » asterisk

musiconhold.h File Reference

Detailed Description

Music on hold handling.

Definition in file musiconhold.h.

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions

void ast_install_music_functions (int(*start_ptr)(struct ast_channel *, const char *, const char *), void(*stop_ptr)(struct ast_channel *), void(*cleanup_ptr)(struct ast_channel *))
void ast_moh_cleanup (struct ast_channel *chan)
int ast_moh_start (struct ast_channel *chan, const char *mclass, const char *interpclass)
 Turn on music on hold on a given channel.
void ast_moh_stop (struct ast_channel *chan)
 Turn off music on hold on a given channel.
void ast_uninstall_music_functions (void)

Function Documentation

void ast_install_music_functions (  int(*)(struct ast_channel *, const char *, const char *)  start_ptr,
void(*)(struct ast_channel *)  stop_ptr,
void(*)(struct ast_channel *)  cleanup_ptr
) 
 

Definition at line 4247 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by load_module(), and reload().

04250 {
04251    ast_moh_start_ptr = start_ptr;
04252    ast_moh_stop_ptr = stop_ptr;
04253    ast_moh_cleanup_ptr = cleanup_ptr;
04254 }

void ast_moh_cleanup (  struct ast_channel *  chan  ) 
 

Definition at line 4284 of file channel.c.

References ast_moh_cleanup_ptr.

Referenced by ast_channel_free().

04285 {
04286    if (ast_moh_cleanup_ptr)
04287       ast_moh_cleanup_ptr(chan);
04288 }

int ast_moh_start (  struct ast_channel *  chan,
const char *  mclass,
const char *  interpclass
) 
 

Turn on music on hold on a given channel.

Parameters:
chan The channel structure that will get music on hold
mclass The class to use if the musicclass is not currently set on the channel structure.
interpclass The class to use if the musicclass is not currently set on the channel structure or in the mclass argument.
Return values:
0 success
non-zero failure

Definition at line 4264 of file channel.c.

References ast_moh_start_ptr, ast_verbose(), option_verbose, and VERBOSE_PREFIX_3.

Referenced by alsa_indicate(), feature_exec_app(), gtalk_indicate(), handle_setmusic(), iax2_indicate(), jingle_indicate(), local_indicate(), mgcp_indicate(), moh0_exec(), moh1_exec(), moh3_exec(), oh323_indicate(), oss_indicate(), phone_indicate(), sip_indicate(), skinny_indicate(), and zt_indicate().

04265 {
04266    if (ast_moh_start_ptr)
04267       return ast_moh_start_ptr(chan, mclass, interpclass);
04268 
04269    if (option_verbose > 2) {
04270       ast_verbose(VERBOSE_PREFIX_3 "Music class %s requested but no musiconhold loaded.\n", 
04271          mclass ? mclass : (interpclass ? interpclass : "default"));
04272    }
04273 
04274    return 0;
04275 }

void ast_moh_stop (  struct ast_channel *  chan  ) 
 

Turn off music on hold on a given channel.

Turn off music on hold on a given channel

Definition at line 4278 of file channel.c.

References ast_moh_stop_ptr.

Referenced by alsa_indicate(), feature_exec_app(), gtalk_indicate(), handle_setmusic(), iax2_indicate(), jingle_indicate(), local_indicate(), mgcp_indicate(), misdn_transfer_bc(), moh0_exec(), moh1_exec(), moh4_exec(), oh323_indicate(), oss_indicate(), phone_indicate(), sip_indicate(), skinny_indicate(), and zt_indicate().

04279 {
04280    if (ast_moh_stop_ptr)
04281       ast_moh_stop_ptr(chan);
04282 }

void ast_uninstall_music_functions (  void   ) 
 

Definition at line 4256 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

04257 {
04258    ast_moh_start_ptr = NULL;
04259    ast_moh_stop_ptr = NULL;
04260    ast_moh_cleanup_ptr = NULL;
04261 }

Asterisk is a trademark for Digium, inc.. | Edvina.net | Asterisk.org | This documentation was generated with Doxygen