Wed Oct 28 11:46:13 2009

Asterisk developer's documentation


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

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by load_module().

05414 {
05415    ast_moh_start_ptr = start_ptr;
05416    ast_moh_stop_ptr = stop_ptr;
05417    ast_moh_cleanup_ptr = cleanup_ptr;
05418 }

void ast_moh_cleanup ( struct ast_channel chan  ) 

Definition at line 5445 of file channel.c.

References ast_moh_cleanup_ptr.

Referenced by ast_channel_free().

05446 {
05447    if (ast_moh_cleanup_ptr)
05448       ast_moh_cleanup_ptr(chan);
05449 }

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

References ast_moh_start_ptr, and ast_verb.

Referenced by alsa_indicate(), app_exec(), conf_run(), 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().

05429 {
05430    if (ast_moh_start_ptr)
05431       return ast_moh_start_ptr(chan, mclass, interpclass);
05432 
05433    ast_verb(3, "Music class %s requested but no musiconhold loaded.\n", mclass ? mclass : (interpclass ? interpclass : "default"));
05434 
05435    return 0;
05436 }

void ast_moh_stop ( struct ast_channel chan  ) 

void ast_uninstall_music_functions ( void   ) 

Definition at line 5420 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by unload_module().

05421 {
05422    ast_moh_start_ptr = NULL;
05423    ast_moh_stop_ptr = NULL;
05424    ast_moh_cleanup_ptr = NULL;
05425 }


Generated on Wed Oct 28 11:46:13 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6