Mon May 14 04:50:10 2007

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

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by load_module(), and reload().

04433 {
04434    ast_moh_start_ptr = start_ptr;
04435    ast_moh_stop_ptr = stop_ptr;
04436    ast_moh_cleanup_ptr = cleanup_ptr;
04437 }

void ast_moh_cleanup ( struct ast_channel chan  ) 

Definition at line 4467 of file channel.c.

References ast_moh_cleanup_ptr.

Referenced by ast_channel_free().

04468 {
04469    if (ast_moh_cleanup_ptr)
04470       ast_moh_cleanup_ptr(chan);
04471 }

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 4447 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(), 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(), skinny_indicate(), and zt_indicate().

04448 {
04449    if (ast_moh_start_ptr)
04450       return ast_moh_start_ptr(chan, mclass, interpclass);
04451 
04452    if (option_verbose > 2) {
04453       ast_verbose(VERBOSE_PREFIX_3 "Music class %s requested but no musiconhold loaded.\n", 
04454          mclass ? mclass : (interpclass ? interpclass : "default"));
04455    }
04456 
04457    return 0;
04458 }

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

References ast_moh_stop_ptr.

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

04462 {
04463    if (ast_moh_stop_ptr)
04464       ast_moh_stop_ptr(chan);
04465 }

void ast_uninstall_music_functions ( void   ) 

Definition at line 4439 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

04440 {
04441    ast_moh_start_ptr = NULL;
04442    ast_moh_stop_ptr = NULL;
04443    ast_moh_cleanup_ptr = NULL;
04444 }


Generated on Mon May 14 04:50:10 2007 for Asterisk - the Open Source PBX by  doxygen 1.5.1