Fri Jan 31 13:16:42 2014

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

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by load_module(), and reload().

05281 {
05282    ast_moh_start_ptr = start_ptr;
05283    ast_moh_stop_ptr = stop_ptr;
05284    ast_moh_cleanup_ptr = cleanup_ptr;
05285 }

void ast_moh_cleanup ( struct ast_channel chan  ) 

Definition at line 5315 of file channel.c.

References ast_moh_cleanup_ptr.

Referenced by ast_channel_free().

05316 {
05317    if (ast_moh_cleanup_ptr)
05318       ast_moh_cleanup_ptr(chan);
05319 }

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 5295 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().

05296 {
05297    if (ast_moh_start_ptr)
05298       return ast_moh_start_ptr(chan, mclass, interpclass);
05299 
05300    if (option_verbose > 2) {
05301       ast_verbose(VERBOSE_PREFIX_3 "Music class %s requested but no musiconhold loaded.\n", 
05302          mclass ? mclass : (interpclass ? interpclass : "default"));
05303    }
05304 
05305    return 0;
05306 }

void ast_moh_stop ( struct ast_channel chan  ) 
void ast_uninstall_music_functions ( void   ) 

Definition at line 5287 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by unload_module().

05288 {
05289    ast_moh_start_ptr = NULL;
05290    ast_moh_stop_ptr = NULL;
05291    ast_moh_cleanup_ptr = NULL;
05292 }


Generated on 31 Jan 2014 for Asterisk - the Open Source PBX by  doxygen 1.6.1