Thu Jul 9 13:41:24 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 5352 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by load_module().

05355 {
05356    ast_moh_start_ptr = start_ptr;
05357    ast_moh_stop_ptr = stop_ptr;
05358    ast_moh_cleanup_ptr = cleanup_ptr;
05359 }

void ast_moh_cleanup ( struct ast_channel chan  ) 

Definition at line 5386 of file channel.c.

References ast_moh_cleanup_ptr, and chan.

Referenced by ast_channel_free().

05387 {
05388    if (ast_moh_cleanup_ptr)
05389       ast_moh_cleanup_ptr(chan);
05390 }

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:
Zero on success
non-zero on failure

Definition at line 5369 of file channel.c.

References ast_moh_start_ptr, ast_verb, and chan.

Referenced by alsa_indicate(), app_exec(), cb_events(), conf_start_moh(), console_indicate(), dahdi_indicate(), dial_exec_full(), feature_exec_app(), gtalk_indicate(), handle_setmusic(), iax2_indicate(), jingle_indicate(), key_call(), local_indicate(), mgcp_indicate(), misdn_indication(), moh_handle_digit(), monitor_dial(), oh323_indicate(), oss_indicate(), phone_indicate(), play_moh_exec(), queue_exec(), retrydial_exec(), say_periodic_announcement(), say_position(), sip_indicate(), skinny_indicate(), start_moh_exec(), TransferCallStep1(), unistim_indicate(), usbradio_indicate(), and wait_moh_exec().

05370 {
05371    if (ast_moh_start_ptr)
05372       return ast_moh_start_ptr(chan, mclass, interpclass);
05373 
05374    ast_verb(3, "Music class %s requested but no musiconhold loaded.\n", mclass ? mclass : (interpclass ? interpclass : "default"));
05375 
05376    return 0;
05377 }

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

References ast_moh_stop_ptr, and chan.

Referenced by alsa_indicate(), app_exec(), ast_quiet_chan(), cb_events(), conf_run(), console_indicate(), dahdi_indicate(), dial_exec_full(), do_bridge_masquerade(), feature_exec_app(), gtalk_indicate(), handle_setmusic(), iax2_indicate(), jingle_indicate(), key_call(), key_dial_page(), local_indicate(), mgcp_indicate(), misdn_indication(), misdn_transfer_bc(), moh_handle_digit(), monitor_dial(), oh323_indicate(), oss_indicate(), phone_indicate(), play_moh_exec(), retrydial_exec(), say_periodic_announcement(), say_position(), sip_indicate(), skinny_indicate(), stop_moh_exec(), unistim_hangup(), unistim_indicate(), usbradio_indicate(), and wait_moh_exec().

05381 {
05382    if (ast_moh_stop_ptr)
05383       ast_moh_stop_ptr(chan);
05384 }

void ast_uninstall_music_functions ( void   ) 

Definition at line 5361 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by unload_module().

05362 {
05363    ast_moh_start_ptr = NULL;
05364    ast_moh_stop_ptr = NULL;
05365    ast_moh_cleanup_ptr = NULL;
05366 }


Generated on Thu Jul 9 13:41:24 2009 for Asterisk - the Open Source PBX by  doxygen 1.4.7