Sat Nov 25 00:46:07 2006

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 *, 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, char *mclass)
void ast_moh_stop (struct ast_channel *chan)
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 *, char *)  start_ptr,
void(*)(struct ast_channel *)  stop_ptr,
void(*)(struct ast_channel *)  cleanup_ptr
 

Definition at line 3865 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by load_module(), and reload().

03869 {
03870    ast_moh_start_ptr = start_ptr;
03871    ast_moh_stop_ptr = stop_ptr;
03872    ast_moh_cleanup_ptr = cleanup_ptr;
03873 }

void ast_moh_cleanup struct ast_channel chan  ) 
 

Definition at line 3901 of file channel.c.

References ast_moh_cleanup_ptr.

Referenced by ast_channel_free().

03902 {
03903    if(ast_moh_cleanup_ptr)
03904         ast_moh_cleanup_ptr(chan);
03905 }

int ast_moh_start struct ast_channel chan,
char *  mclass
 

Turn on music on hold on a given channel

Definition at line 3883 of file channel.c.

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

Referenced by __login_exec(), agent_hangup(), builtin_atxfer(), builtin_blindtransfer(), do_parking_thread(), handle_request(), handle_setmusic(), moh0_exec(), moh1_exec(), moh3_exec(), pbx_builtin_waitexten(), process_sdp(), queue_exec(), retrydial_exec(), say_periodic_announcement(), say_position(), socket_read(), zt_handle_event(), and zt_hangup().

03884 {
03885    if (ast_moh_start_ptr)
03886       return ast_moh_start_ptr(chan, mclass);
03887 
03888    if (option_verbose > 2)
03889       ast_verbose(VERBOSE_PREFIX_3 "Music class %s requested but no musiconhold loaded.\n", mclass ? mclass : "default");
03890    
03891    return 0;
03892 }

void ast_moh_stop struct ast_channel chan  ) 
 

Turn off music on hold on a given channel

Definition at line 3895 of file channel.c.

References ast_moh_stop_ptr.

Referenced by __zt_exception(), agent_new(), attempt_transfer(), builtin_atxfer(), builtin_blindtransfer(), do_parking_thread(), handle_hd_hf(), handle_request(), handle_request_bye(), handle_request_refer(), handle_setmusic(), misdn_transfer_bc(), moh0_exec(), moh1_exec(), moh4_exec(), park_exec(), pbx_builtin_waitexten(), process_sdp(), retrydial_exec(), say_periodic_announcement(), say_position(), socket_read(), ss_thread(), zt_handle_event(), and zt_hangup().

03896 {
03897    if(ast_moh_stop_ptr)
03898       ast_moh_stop_ptr(chan);
03899 }

void ast_uninstall_music_functions void   ) 
 

Definition at line 3875 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

03876 {
03877    ast_moh_start_ptr = NULL;
03878    ast_moh_stop_ptr = NULL;
03879    ast_moh_cleanup_ptr = NULL;
03880 }


Generated on Sat Nov 25 00:46:07 2006 for Asterisk - the Open Source PBX by  doxygen 1.4.6