Wed Jan 8 2020 09:50:15

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. More...
 
void ast_moh_stop (struct ast_channel *chan)
 Turn off music on hold on a given channel. More...
 
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 8023 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by load_module(), and reload().

8026 {
8027  ast_moh_start_ptr = start_ptr;
8028  ast_moh_stop_ptr = stop_ptr;
8029  ast_moh_cleanup_ptr = cleanup_ptr;
8030 }
static int(* ast_moh_start_ptr)(struct ast_channel *, const char *, const char *)
Definition: channel.c:8019
static void(* ast_moh_cleanup_ptr)(struct ast_channel *)
Definition: channel.c:8021
static void(* ast_moh_stop_ptr)(struct ast_channel *)
Definition: channel.c:8020
void ast_moh_cleanup ( struct ast_channel chan)

Definition at line 8057 of file channel.c.

References ast_moh_cleanup_ptr.

Referenced by ast_channel_destructor().

8058 {
8059  if (ast_moh_cleanup_ptr)
8060  ast_moh_cleanup_ptr(chan);
8061 }
static void(* ast_moh_cleanup_ptr)(struct ast_channel *)
Definition: channel.c:8021
int ast_moh_start ( struct ast_channel chan,
const char *  mclass,
const char *  interpclass 
)

Turn on music on hold on a given channel.

Parameters
chanThe channel structure that will get music on hold
mclassThe class to use if the musicclass is not currently set on the channel structure.
interpclassThe class to use if the musicclass is not currently set on the channel structure or in the mclass argument.
Return values
Zeroon success
non-zeroon failure

Definition at line 8040 of file channel.c.

References ast_moh_start_ptr, and ast_verb.

Referenced by alsa_indicate(), app_exec(), ast_do_masquerade(), conf_start_moh(), console_indicate(), dahdi_indicate(), dial_exec_full(), feature_exec_app(), gtalk_indicate(), handle_setmusic(), iax2_indicate(), jingle_indicate(), key_call(), leave_conference_bridge(), local_indicate(), menu_callback(), mgcp_indicate(), misdn_indication(), moh_handle_digit(), monitor_dial(), oh323_indicate(), oss_indicate(), phone_indicate(), play_moh_exec(), post_join_marked(), post_join_unmarked(), queue_exec(), retrydial_exec(), rna(), say_periodic_announcement(), say_position(), sig_pri_indicate(), sip_indicate(), skinny_indicate(), start_moh_exec(), TransferCallStep1(), unistim_indicate(), and wait_moh_exec().

8041 {
8042  if (ast_moh_start_ptr)
8043  return ast_moh_start_ptr(chan, mclass, interpclass);
8044 
8045  ast_verb(3, "Music class %s requested but no musiconhold loaded.\n", mclass ? mclass : (interpclass ? interpclass : "default"));
8046 
8047  return 0;
8048 }
static int(* ast_moh_start_ptr)(struct ast_channel *, const char *, const char *)
Definition: channel.c:8019
#define ast_verb(level,...)
Definition: logger.h:243
void ast_uninstall_music_functions ( void  )

Definition at line 8032 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by unload_module().

8033 {
8034  ast_moh_start_ptr = NULL;
8035  ast_moh_stop_ptr = NULL;
8036  ast_moh_cleanup_ptr = NULL;
8037 }
static int(* ast_moh_start_ptr)(struct ast_channel *, const char *, const char *)
Definition: channel.c:8019
static void(* ast_moh_cleanup_ptr)(struct ast_channel *)
Definition: channel.c:8021
static void(* ast_moh_stop_ptr)(struct ast_channel *)
Definition: channel.c:8020