Wed Aug 15 01:25:21 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 4527 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

04530 {
04531    ast_moh_start_ptr = start_ptr;
04532    ast_moh_stop_ptr = stop_ptr;
04533    ast_moh_cleanup_ptr = cleanup_ptr;
04534 }

void ast_moh_cleanup ( struct ast_channel chan  ) 

Definition at line 4564 of file channel.c.

References ast_moh_cleanup_ptr.

04565 {
04566    if (ast_moh_cleanup_ptr)
04567       ast_moh_cleanup_ptr(chan);
04568 }

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

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

04545 {
04546    if (ast_moh_start_ptr)
04547       return ast_moh_start_ptr(chan, mclass, interpclass);
04548 
04549    if (option_verbose > 2) {
04550       ast_verbose(VERBOSE_PREFIX_3 "Music class %s requested but no musiconhold loaded.\n", 
04551          mclass ? mclass : (interpclass ? interpclass : "default"));
04552    }
04553 
04554    return 0;
04555 }

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

References ast_moh_stop_ptr.

04559 {
04560    if (ast_moh_stop_ptr)
04561       ast_moh_stop_ptr(chan);
04562 }

void ast_uninstall_music_functions ( void   ) 

Definition at line 4536 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

04537 {
04538    ast_moh_start_ptr = NULL;
04539    ast_moh_stop_ptr = NULL;
04540    ast_moh_cleanup_ptr = NULL;
04541 }


Generated on Wed Aug 15 01:25:21 2007 for Asterisk - the Open Source PBX by  doxygen 1.5.3