From 894045e7cf00ad0f375e0cf879745fd3d0564cc4 Mon Sep 17 00:00:00 2001 From: Richard Mudgett Date: Tue, 26 Jan 2016 17:59:28 -0600 Subject: [PATCH] app_confbridge.c: Update CONFBRIDGE and CONFBRIDGE_INFO documentation. Change-Id: Ic1f9e22ba1f2ff3b3f5cb017c5ddcd9bd48eccc7 --- apps/app_confbridge.c | 72 +++++++++++++++++++++++++++++++------------ 1 file changed, 53 insertions(+), 19 deletions(-) diff --git a/apps/app_confbridge.c b/apps/app_confbridge.c index 9bda5440d9..8ded510267 100644 --- a/apps/app_confbridge.c +++ b/apps/app_confbridge.c @@ -130,32 +130,51 @@ ASTERISK_REGISTER_FILE() - Set a custom dynamic bridge, user, or menu profile on a channel for the ConfBridge application using the same options defined in confbridge.conf. + Set a custom dynamic bridge, user, or menu profile on a channel for the + ConfBridge application using the same options available in confbridge.conf. - Type refers to which type of profile the option belongs too. Type can be bridge, user, or - menu. + To what type of conference profile the option applies. + + + + + - Option refers to confbridge.conf option that is being set dynamically on this channel, or - clear to remove already applied options from the channel. + Option refers to a confbridge.conf option + that is being set dynamically on this channel, or clear + to remove already applied profile options from the channel. + A custom profile uses the default profile type settings defined in + confbridge.conf as defaults if the profile template + is not explicitly specified first. + For bridge profiles the default template is default_bridge. + For menu profiles the default template is default_menu. + For user profiles the default template is default_user. ---- Example 1 ---- - In this example the custom set user profile on this channel will automatically be used by the ConfBridge app. - exten => 1,1,Answer() - exten => 1,n,Set(CONFBRIDGE(user,announce_join_leave)=yes) - exten => 1,n,Set(CONFBRIDGE(user,startmuted)=yes) - exten => 1,n,ConfBridge(1) + In this example the custom user profile set on the channel will + automatically be used by the ConfBridge application. + exten => 1,1,Answer() + ; In this example the effect of the following line is + ; implied: + ; same => n,Set(CONFBRIDGE(user,template)=default_user) + same => n,Set(CONFBRIDGE(user,announce_join_leave)=yes) + same => n,Set(CONFBRIDGE(user,startmuted)=yes) + same => n,ConfBridge(1) ---- Example 2 ---- - This example shows how to use a predefined user or bridge profile in confbridge.conf as a template for a dynamic profile. Here we make a admin/marked user out of the default_user profile that is already defined in confbridge.conf. - exten => 1,1,Answer() - exten => 1,n,Set(CONFBRIDGE(user,template)=default_user) - exten => 1,n,Set(CONFBRIDGE(user,admin)=yes) - exten => 1,n,Set(CONFBRIDGE(user,marked)=yes) - exten => 1,n,ConfBridge(1) + This example shows how to use a predefined user profile in + confbridge.conf as a template for a dynamic profile. + Here we make an admin/marked user out of the my_user + profile that you define in confbridge.conf. + exten => 1,1,Answer() + same => n,Set(CONFBRIDGE(user,template)=my_user) + same => n,Set(CONFBRIDGE(user,admin)=yes) + same => n,Set(CONFBRIDGE(user,marked)=yes) + same => n,ConfBridge(1) @@ -164,14 +183,29 @@ ASTERISK_REGISTER_FILE() - Type can be parties, admins, marked, or locked. + What conference information is requested. + + + Get the number of admin users in the conference. + + + Determine if the conference is locked. (0 or 1) + + + Get the number of marked users in the conference. + + + Get the number of users in the conference. + + - Conf refers to the name of the conference being referenced. + The name of the conference being referenced. - This function returns a non-negative integer for valid conference identifiers (0 or 1 for locked) and "" for invalid conference identifiers. + This function returns a non-negative integer for valid conference + names and an empty string for invalid conference names.