musiconhold.h File Reference

Music on hold handling. More...

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)


Detailed Description

Music on hold handling.

Definition in file musiconhold.h.


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 7385 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by load_module(), and reload().

07388 {
07389    ast_moh_start_ptr = start_ptr;
07390    ast_moh_stop_ptr = stop_ptr;
07391    ast_moh_cleanup_ptr = cleanup_ptr;
07392 }

void ast_moh_cleanup ( struct ast_channel chan  ) 

Definition at line 7417 of file channel.c.

References ast_moh_cleanup_ptr.

Referenced by ast_channel_destructor().

07418 {
07419    if (ast_moh_cleanup_ptr)
07420       ast_moh_cleanup_ptr(chan);
07421 }

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. NULL and the empty string are equivalent.
interpclass The class to use if the musicclass is not currently set on the channel structure or in the mclass argument. NULL and the empty string are equivalent.
Return values:
Zero on success
non-zero on failure

Definition at line 7401 of file channel.c.

References ast_moh_start_ptr, and ast_verb.

Referenced by alsa_indicate(), app_control_moh_start(), app_exec(), ast_ari_bridges_start_moh(), ast_bridge_channel_playfile(), ast_unreal_indicate(), chan_pjsip_indicate(), channel_do_masquerade(), conf_moh_start(), conf_moh_unsuspend(), conf_start_moh(), console_indicate(), dahdi_indicate(), dial_exec_full(), handle_setmusic(), iax2_indicate(), jingle_indicate(), limits_interval_playback(), mgcp_indicate(), misdn_indication(), moh_handle_digit(), monitor_dial(), ooh323_indicate(), oss_indicate(), participant_entertainment_start(), phone_indicate(), play_moh_exec(), queue_exec(), retrydial_exec(), rna(), say_periodic_announcement(), say_position(), sip_indicate(), skinny_indicate(), start_moh_exec(), and unistim_indicate().

07402 {
07403    if (ast_moh_start_ptr)
07404       return ast_moh_start_ptr(chan, mclass, interpclass);
07405 
07406    ast_verb(3, "Music class %s requested but no musiconhold loaded.\n", mclass ? mclass : (interpclass ? interpclass : "default"));
07407 
07408    return 0;
07409 }

void ast_moh_stop ( struct ast_channel chan  ) 

void ast_uninstall_music_functions ( void   ) 

Definition at line 7394 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, ast_moh_stop_ptr, and NULL.

Referenced by unload_module().

07395 {
07396    ast_moh_start_ptr = NULL;
07397    ast_moh_stop_ptr = NULL;
07398    ast_moh_cleanup_ptr = NULL;
07399 }


Generated on Thu Apr 16 06:32:03 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6