Wed Feb 11 12:00:27 2009

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

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by load_module(), and reload().

04528 {
04529    ast_moh_start_ptr = start_ptr;
04530    ast_moh_stop_ptr = stop_ptr;
04531    ast_moh_cleanup_ptr = cleanup_ptr;
04532 }

void ast_moh_cleanup ( struct ast_channel chan  ) 

Definition at line 4562 of file channel.c.

References ast_moh_cleanup_ptr.

Referenced by ast_channel_free().

04563 {
04564    if (ast_moh_cleanup_ptr)
04565       ast_moh_cleanup_ptr(chan);
04566 }

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

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

Referenced by alsa_indicate(), app_exec(), cb_events(), 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(), say_periodic_announcement(), say_position(), sip_indicate(), and skinny_indicate().

04543 {
04544    if (ast_moh_start_ptr)
04545       return ast_moh_start_ptr(chan, mclass, interpclass);
04546 
04547    if (option_verbose > 2) {
04548       ast_verbose(VERBOSE_PREFIX_3 "Music class %s requested but no musiconhold loaded.\n", 
04549          mclass ? mclass : (interpclass ? interpclass : "default"));
04550    }
04551 
04552    return 0;
04553 }

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

References ast_moh_stop_ptr.

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

04557 {
04558    if (ast_moh_stop_ptr)
04559       ast_moh_stop_ptr(chan);
04560 }

void ast_uninstall_music_functions ( void   ) 

Definition at line 4534 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by unload_module().

04535 {
04536    ast_moh_start_ptr = NULL;
04537    ast_moh_stop_ptr = NULL;
04538    ast_moh_cleanup_ptr = NULL;
04539 }


Generated on Wed Feb 11 12:00:27 2009 for Asterisk - the Open Source PBX by  doxygen 1.4.7