Tue Nov 16 17:07:43 2010

Asterisk developer's documentation


musiconhold.h File Reference

Music on hold handling. More...

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

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by load_module(), and reload().

04884 {
04885    ast_moh_start_ptr = start_ptr;
04886    ast_moh_stop_ptr = stop_ptr;
04887    ast_moh_cleanup_ptr = cleanup_ptr;
04888 }

void ast_moh_cleanup ( struct ast_channel chan  ) 

Definition at line 4918 of file channel.c.

References ast_moh_cleanup_ptr.

Referenced by ast_channel_free().

04919 {
04920    if (ast_moh_cleanup_ptr)
04921       ast_moh_cleanup_ptr(chan);
04922 }

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

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

Referenced by alsa_indicate(), app_exec(), conf_run(), dahdi_indicate(), feature_exec_app(), gtalk_indicate(), handle_setmusic(), iax2_indicate(), local_indicate(), mgcp_indicate(), misdn_indication(), moh0_exec(), moh1_exec(), moh3_exec(), oh323_indicate(), oss_indicate(), phone_indicate(), queue_exec(), retrydial_exec(), rna(), say_periodic_announcement(), say_position(), sip_indicate(), and skinny_indicate().

04899 {
04900    if (ast_moh_start_ptr)
04901       return ast_moh_start_ptr(chan, mclass, interpclass);
04902 
04903    if (option_verbose > 2) {
04904       ast_verbose(VERBOSE_PREFIX_3 "Music class %s requested but no musiconhold loaded.\n", 
04905          mclass ? mclass : (interpclass ? interpclass : "default"));
04906    }
04907 
04908    return 0;
04909 }

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

References ast_moh_stop_ptr.

Referenced by alsa_indicate(), app_exec(), ast_quiet_chan(), conf_run(), dahdi_indicate(), feature_exec_app(), gtalk_indicate(), handle_setmusic(), iax2_indicate(), local_indicate(), mgcp_indicate(), misdn_indication(), moh0_exec(), moh1_exec(), moh4_exec(), oh323_indicate(), oss_indicate(), phone_indicate(), queue_exec(), retrydial_exec(), say_periodic_announcement(), say_position(), sip_indicate(), and skinny_indicate().

04913 {
04914    if (ast_moh_stop_ptr)
04915       ast_moh_stop_ptr(chan);
04916 }

void ast_uninstall_music_functions ( void   ) 

Definition at line 4890 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by unload_module().

04891 {
04892    ast_moh_start_ptr = NULL;
04893    ast_moh_stop_ptr = NULL;
04894    ast_moh_cleanup_ptr = NULL;
04895 }


Generated on Tue Nov 16 17:07:43 2010 for Asterisk - the Open Source PBX by  doxygen 1.4.7