app_confbridge / bridge_softmix: Add ability to configure REMB interval.
[asterisk/asterisk.git] / apps / confbridge / include / confbridge.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2011, Digium, Inc.
5  *
6  * David Vossel <dvossel@digium.com>
7  * Joshua Colp <jcolp@digium.com>
8  *
9  * See http://www.asterisk.org for more information about
10  * the Asterisk project. Please do not directly contact
11  * any of the maintainers of this project for assistance;
12  * the project provides a web site, mailing lists and IRC
13  * channels for your use.
14  *
15  * This program is free software, distributed under the terms of
16  * the GNU General Public License Version 2. See the LICENSE file
17  * at the top of the source tree.
18  */
19
20
21 #ifndef _CONFBRIDGE_H
22 #define _CONFBRIDGE_H
23
24 #include "asterisk.h"
25 #include "asterisk/app.h"
26 #include "asterisk/logger.h"
27 #include "asterisk/linkedlists.h"
28 #include "asterisk/channel.h"
29 #include "asterisk/bridge.h"
30 #include "asterisk/bridge_features.h"
31 #include "conf_state.h"
32
33 /*! Maximum length of a conference bridge name */
34 #define MAX_CONF_NAME AST_MAX_EXTENSION
35 /*! Maximum length of a conference pin */
36 #define MAX_PIN     80
37 /*! Maximum length of bridge/user/menu profile names */
38 #define MAX_PROFILE_NAME 128
39
40 #define DEFAULT_USER_PROFILE "default_user"
41 #define DEFAULT_BRIDGE_PROFILE "default_bridge"
42 #define DEFAULT_MENU_PROFILE "default_menu"
43
44 /*! Default minimum average magnitude threshold to determine talking by the DSP. */
45 #define DEFAULT_TALKING_THRESHOLD 160
46
47 /*! Default time in ms of silence necessary to declare talking stopped by the bridge. */
48 #define DEFAULT_SILENCE_THRESHOLD 2500
49
50 enum user_profile_flags {
51         USER_OPT_ADMIN =        (1 << 0), /*!< Set if the caller is an administrator */
52         USER_OPT_NOONLYPERSON = (1 << 1), /*!< Set if the "you are currently the only person in this conference" sound file should not be played */
53         USER_OPT_MARKEDUSER =   (1 << 2), /*!< Set if the caller is a marked user */
54         USER_OPT_STARTMUTED =   (1 << 3), /*!< Set if the caller should be initially set muted */
55         USER_OPT_MUSICONHOLD =  (1 << 4), /*!< Set if music on hold should be played if nobody else is in the conference bridge */
56         USER_OPT_QUIET =        (1 << 5), /*!< Set if no audio prompts should be played */
57         USER_OPT_ANNOUNCEUSERCOUNT = (1 << 6), /*!< Set if the number of users should be announced to the caller */
58         USER_OPT_WAITMARKED =   (1 << 7), /*!< Set if the user must wait for a marked user before starting */
59         USER_OPT_ENDMARKED =    (1 << 8), /*!< Set if the user should be kicked after the last Marked user exits */
60         USER_OPT_DENOISE =      (1 << 9), /*!< Sets if denoise filter should be used on audio before mixing. */
61         USER_OPT_ANNOUNCE_JOIN_LEAVE = (1 << 10), /*!< Sets if the user's name should be recorded and announced on join and leave. */
62         USER_OPT_TALKER_DETECT = (1 << 11), /*!< Sets if start and stop talking events should generated for this user over AMI. */
63         USER_OPT_DROP_SILENCE =  (1 << 12), /*!< Sets if silence should be dropped from the mix or not. */
64         USER_OPT_DTMF_PASS    =  (1 << 13), /*!< Sets if dtmf should be passed into the conference or not */
65         USER_OPT_ANNOUNCEUSERCOUNTALL = (1 << 14), /*!< Sets if the number of users should be announced to everyone. */
66         USER_OPT_JITTERBUFFER =  (1 << 15), /*!< Places a jitterbuffer on the user. */
67         USER_OPT_ANNOUNCE_JOIN_LEAVE_REVIEW = (1 << 16), /*!< modifies ANNOUNCE_JOIN_LEAVE - user reviews the recording before continuing */
68 };
69
70 enum bridge_profile_flags {
71         BRIDGE_OPT_RECORD_CONFERENCE = (1 << 0), /*!< Set if the conference should be recorded */
72         BRIDGE_OPT_VIDEO_SRC_LAST_MARKED = (1 << 1), /*!< Set if conference should feed video of last marked user to all participants. */
73         BRIDGE_OPT_VIDEO_SRC_FIRST_MARKED = (1 << 2), /*!< Set if conference should feed video of first marked user to all participants. */
74         BRIDGE_OPT_VIDEO_SRC_FOLLOW_TALKER = (1 << 3), /*!< Set if conference set the video feed to follow the loudest talker.  */
75         BRIDGE_OPT_RECORD_FILE_APPEND = (1 << 4), /*!< Set if the record file should be appended to between start/stops.  */
76         BRIDGE_OPT_RECORD_FILE_TIMESTAMP = (1 << 5), /*!< Set if the record file should have a timestamp appended */
77         BRIDGE_OPT_BINAURAL_ACTIVE = (1 << 6), /*!< Set if binaural convolution is activated */
78         BRIDGE_OPT_VIDEO_SRC_SFU = (1 << 7), /*!< Selective forwarding unit */
79 };
80
81 enum conf_menu_action_id {
82         MENU_ACTION_TOGGLE_MUTE = 1,
83         MENU_ACTION_PLAYBACK,
84         MENU_ACTION_PLAYBACK_AND_CONTINUE,
85         MENU_ACTION_INCREASE_LISTENING,
86         MENU_ACTION_DECREASE_LISTENING,
87         MENU_ACTION_RESET_LISTENING,
88         MENU_ACTION_RESET_TALKING,
89         MENU_ACTION_INCREASE_TALKING,
90         MENU_ACTION_DECREASE_TALKING,
91         MENU_ACTION_DIALPLAN_EXEC,
92         MENU_ACTION_ADMIN_TOGGLE_LOCK,
93         MENU_ACTION_ADMIN_KICK_LAST,
94         MENU_ACTION_LEAVE,
95         MENU_ACTION_NOOP,
96         MENU_ACTION_SET_SINGLE_VIDEO_SRC,
97         MENU_ACTION_RELEASE_SINGLE_VIDEO_SRC,
98         MENU_ACTION_PARTICIPANT_COUNT,
99         MENU_ACTION_ADMIN_TOGGLE_MUTE_PARTICIPANTS,
100         MENU_ACTION_TOGGLE_BINAURAL,
101 };
102
103 /*! The conference menu action contains both
104  *  the action id that represents the action that
105  *  must take place, along with any data associated
106  *  with that action. */
107 struct conf_menu_action {
108         enum conf_menu_action_id id;
109         union {
110                 char playback_file[PATH_MAX];
111                 struct {
112                         char context[AST_MAX_CONTEXT];
113                         char exten[AST_MAX_EXTENSION];
114                         int priority;
115                 } dialplan_args;
116         } data;
117         AST_LIST_ENTRY(conf_menu_action) action;
118 };
119
120 /*! Conference menu entries contain the DTMF sequence
121  *  and the list of actions that are associated with that
122  *  sequence. */
123 struct conf_menu_entry {
124         /*! the DTMF sequence that triggers the actions */
125         char dtmf[MAXIMUM_DTMF_FEATURE_STRING];
126         /*! The actions associated with this menu entry. */
127         AST_LIST_HEAD_NOLOCK(, conf_menu_action) actions;
128         AST_LIST_ENTRY(conf_menu_entry) entry;
129 };
130
131 /*! Conference menu structure.  Contains a list
132  * of DTMF sequences coupled with the actions those
133  * sequences invoke.*/
134 struct conf_menu {
135         char name[MAX_PROFILE_NAME];
136         AST_LIST_HEAD_NOLOCK(, conf_menu_entry) entries;
137 };
138
139 struct user_profile {
140         char name[MAX_PROFILE_NAME];
141         char pin[MAX_PIN];
142         char moh_class[128];
143         char announcement[PATH_MAX];
144         unsigned int flags;
145         unsigned int announce_user_count_all_after;
146         /*! Minimum average magnitude threshold to determine talking by the DSP. */
147         unsigned int talking_threshold;
148         /*! Time in ms of silence necessary to declare talking stopped by the bridge. */
149         unsigned int silence_threshold;
150         /*! The time in ms the user may stay in the confbridge */
151         unsigned int timeout;
152 };
153
154 enum conf_sounds {
155         CONF_SOUND_HAS_JOINED,
156         CONF_SOUND_HAS_LEFT,
157         CONF_SOUND_KICKED,
158         CONF_SOUND_MUTED,
159         CONF_SOUND_UNMUTED,
160         CONF_SOUND_ONLY_ONE,
161         CONF_SOUND_THERE_ARE,
162         CONF_SOUND_OTHER_IN_PARTY,
163         CONF_SOUND_PLACE_IN_CONF,
164         CONF_SOUND_WAIT_FOR_LEADER,
165         CONF_SOUND_LEADER_HAS_LEFT,
166         CONF_SOUND_GET_PIN,
167         CONF_SOUND_INVALID_PIN,
168         CONF_SOUND_ONLY_PERSON,
169         CONF_SOUND_LOCKED,
170         CONF_SOUND_LOCKED_NOW,
171         CONF_SOUND_UNLOCKED_NOW,
172         CONF_SOUND_ERROR_MENU,
173         CONF_SOUND_JOIN,
174         CONF_SOUND_LEAVE,
175         CONF_SOUND_PARTICIPANTS_MUTED,
176         CONF_SOUND_PARTICIPANTS_UNMUTED,
177         CONF_SOUND_BEGIN,
178         CONF_SOUND_BINAURAL_ON,
179         CONF_SOUND_BINAURAL_OFF,
180 };
181
182 struct bridge_profile_sounds {
183         AST_DECLARE_STRING_FIELDS(
184                 AST_STRING_FIELD(hasjoin);
185                 AST_STRING_FIELD(hasleft);
186                 AST_STRING_FIELD(kicked);
187                 AST_STRING_FIELD(muted);
188                 AST_STRING_FIELD(unmuted);
189                 AST_STRING_FIELD(onlyone);
190                 AST_STRING_FIELD(thereare);
191                 AST_STRING_FIELD(otherinparty);
192                 AST_STRING_FIELD(placeintoconf);
193                 AST_STRING_FIELD(waitforleader);
194                 AST_STRING_FIELD(leaderhasleft);
195                 AST_STRING_FIELD(getpin);
196                 AST_STRING_FIELD(invalidpin);
197                 AST_STRING_FIELD(onlyperson);
198                 AST_STRING_FIELD(locked);
199                 AST_STRING_FIELD(lockednow);
200                 AST_STRING_FIELD(unlockednow);
201                 AST_STRING_FIELD(errormenu);
202                 AST_STRING_FIELD(leave);
203                 AST_STRING_FIELD(join);
204                 AST_STRING_FIELD(participantsmuted);
205                 AST_STRING_FIELD(participantsunmuted);
206                 AST_STRING_FIELD(begin);
207                 AST_STRING_FIELD(binauralon);
208                 AST_STRING_FIELD(binauraloff);
209         );
210 };
211
212 struct bridge_profile {
213         char name[MAX_PROFILE_NAME];
214         char language[MAX_LANGUAGE];              /*!< Language used for playback_chan */
215         char rec_file[PATH_MAX];
216         char rec_options[128];
217         char rec_command[128];
218         unsigned int flags;
219         unsigned int max_members;          /*!< The maximum number of participants allowed in the conference */
220         unsigned int internal_sample_rate; /*!< The internal sample rate of the bridge. 0 when set to auto adjust mode. */
221         unsigned int mix_interval;  /*!< The internal mixing interval used by the bridge. When set to 0 the bridgewill use a default interval. */
222         struct bridge_profile_sounds *sounds;
223         char regcontext[AST_MAX_CONTEXT];
224         unsigned int video_update_discard; /*!< Amount of time after sending a video update request that subsequent requests should be discarded */
225         unsigned int remb_send_interval; /*!< Interval at which a combined REMB frame is sent to video sources */
226 };
227
228 /*! \brief The structure that represents a conference bridge */
229 struct confbridge_conference {
230         char name[MAX_CONF_NAME];                                         /*!< Name of the conference bridge */
231         struct confbridge_state *state;                                   /*!< Conference state information */
232         struct ast_bridge *bridge;                                        /*!< Bridge structure doing the mixing */
233         struct bridge_profile b_profile;                                  /*!< The Bridge Configuration Profile */
234         unsigned int activeusers;                                         /*!< Number of active users present */
235         unsigned int markedusers;                                         /*!< Number of marked users present */
236         unsigned int waitingusers;                                        /*!< Number of waiting users present */
237         unsigned int locked:1;                                            /*!< Is this conference bridge locked? */
238         unsigned int muted:1;                                             /*!< Is this conference bridge muted? */
239         struct ast_channel *playback_chan;                                /*!< Channel used for playback into the conference bridge */
240         struct ast_channel *record_chan;                                  /*!< Channel used for recording the conference */
241         struct ast_str *record_filename;                                  /*!< Recording filename. */
242         struct ast_str *orig_rec_file;                                    /*!< Previous b_profile.rec_file. */
243         AST_LIST_HEAD_NOLOCK(, confbridge_user) active_list;              /*!< List of users participating in the conference bridge */
244         AST_LIST_HEAD_NOLOCK(, confbridge_user) waiting_list;             /*!< List of users waiting to join the conference bridge */
245         struct ast_taskprocessor *playback_queue;                         /*!< Queue for playing back bridge announcements and managing the announcer channel */
246 };
247
248 extern struct ao2_container *conference_bridges;
249
250 struct post_join_action {
251         int (*func)(struct confbridge_user *user);
252         AST_LIST_ENTRY(post_join_action) list;
253 };
254
255 /*! \brief The structure that represents a conference bridge user */
256 struct confbridge_user {
257         struct confbridge_conference *conference;    /*!< Conference bridge they are participating in */
258         struct bridge_profile b_profile;             /*!< The Bridge Configuration Profile */
259         struct user_profile u_profile;               /*!< The User Configuration Profile */
260         char menu_name[MAX_PROFILE_NAME];            /*!< The name of the DTMF menu assigned to this user */
261         char name_rec_location[PATH_MAX];            /*!< Location of the User's name recorded file if it exists */
262         struct ast_channel *chan;                    /*!< Asterisk channel participating */
263         struct ast_bridge_features features;         /*!< Bridge features structure */
264         struct ast_bridge_tech_optimizations tech_args; /*!< Bridge technology optimizations for talk detection */
265         unsigned int suspended_moh;                  /*!< Count of active suspended MOH actions. */
266         unsigned int muted:1;                        /*!< Has the user requested to be muted? */
267         unsigned int kicked:1;                       /*!< User has been kicked from the conference */
268         unsigned int playing_moh:1;                  /*!< MOH is currently being played to the user */
269         AST_LIST_HEAD_NOLOCK(, post_join_action) post_join_list; /*!< List of sounds to play after joining */;
270         AST_LIST_ENTRY(confbridge_user) list;        /*!< Linked list information */
271 };
272
273 /*! \brief load confbridge.conf file */
274 int conf_load_config(void);
275
276 /*! \brief reload confbridge.conf file */
277 int conf_reload_config(void);
278
279 /*! \brief destroy the information loaded from the confbridge.conf file*/
280 void conf_destroy_config(void);
281
282 /*!
283  * \brief find a user profile given a user profile's name and store
284  * that profile in result structure.
285  *
286  * \param chan channel the user profile is requested for
287  * \param user_profile_name name of the profile requested (optional)
288  * \param result data contained by the user profile will be copied to this struct pointer
289  *
290  * \details If user_profile_name is not provided, this function will
291  * check for the presence of a user profile set by the CONFBRIDGE
292  * function on a channel datastore. If that doesn't exist, the
293  * default_user profile is used.
294  *
295  * \retval user profile on success
296  * \retval NULL on failure
297  */
298 const struct user_profile *conf_find_user_profile(struct ast_channel *chan, const char *user_profile_name, struct user_profile *result);
299
300 /*!
301  * \brief Find a bridge profile given a bridge profile's name and store
302  * that profile in result structure.
303  *
304  * \param chan channel the bridge profile is requested for
305  * \param bridge_profile_name name of the profile requested (optional)
306  * \param result data contained by the bridge profile will be copied to this struct pointer
307  *
308  * \details If bridge_profile_name is not provided, this function will
309  * check for the presence of a bridge profile set by the CONFBRIDGE
310  * function on a channel datastore. If that doesn't exist, the
311  * default_bridge profile is used.
312  *
313  * \retval bridge profile on success
314  * \retval NULL on failure
315  */
316 const struct bridge_profile *conf_find_bridge_profile(struct ast_channel *chan, const char *bridge_profile_name, struct bridge_profile *result);
317
318 /*!
319  * \brief find a menu profile given a menu profile's name and apply
320  * the menu in DTMF hooks.
321  *
322  * \param chan channel the menu profile is requested for
323  * \param user user profile the menu is being applied to
324  * \param menu_profile_name name of the profile requested (optional)
325  *
326  * \details If menu_profile_name is not provided, this function will
327  * check for the presence of a menu profile set by the CONFBRIDGE
328  * function on a channel datastore. If that doesn't exist, the
329  * default_menu profile is used.
330  *
331  * \retval 0 on success
332  * \retval -1 on failure
333  */
334 int conf_set_menu_to_user(struct ast_channel *chan, struct confbridge_user *user, const char *menu_profile_name);
335
336 /*!
337  * \brief Destroy a bridge profile found by 'conf_find_bridge_profile'
338  */
339 void conf_bridge_profile_destroy(struct bridge_profile *b_profile);
340
341 /*!
342  * \brief copies a bridge profile
343  * \note conf_bridge_profile_destroy must be called on the dst structure
344  */
345 void conf_bridge_profile_copy(struct bridge_profile *dst, struct bridge_profile *src);
346
347 /*!
348  * \brief Finds a menu_entry in a menu structure matched by DTMF sequence.
349  *
350  * \note the menu entry found must be destroyed using conf_menu_entry_destroy()
351  *
352  * \retval 1 success, entry is found and stored in result
353  * \retval 0 failure, no entry found for given DTMF sequence
354  */
355 int conf_find_menu_entry_by_sequence(const char *dtmf_sequence, struct conf_menu *menu, struct conf_menu_entry *result);
356
357 /*!
358  * \brief Destroys and frees all the actions stored in a menu_entry structure
359  */
360 void conf_menu_entry_destroy(struct conf_menu_entry *menu_entry);
361
362 /*!
363  * \brief Once a DTMF sequence matches a sequence in the user's DTMF menu, this function will get
364  * called to perform the menu action.
365  *
366  * \param bridge_channel Bridged channel this is involving
367  * \param user the conference user to perform the action on.
368  * \param menu_entry the menu entry that invoked this callback to occur.
369  * \param menu an AO2 referenced pointer to the entire menu structure the menu_entry
370  *        derived from.
371  *
372  * \note The menu_entry is a deep copy of the entry found in the menu structure.  This allows
373  * for the menu_entry to be accessed without requiring the menu lock.  If the menu must
374  * be accessed, the menu lock must be held.  Reference counting of the menu structure is
375  * handled outside of the scope of this function.
376  *
377  * \retval 0 success
378  * \retval -1 failure
379  */
380 int conf_handle_dtmf(
381         struct ast_bridge_channel *bridge_channel,
382         struct confbridge_user *user,
383         struct conf_menu_entry *menu_entry,
384         struct conf_menu *menu);
385
386
387 /*! \brief Looks to see if sound file is stored in bridge profile sounds, if not
388  *  default sound is provided.*/
389 const char *conf_get_sound(enum conf_sounds sound, struct bridge_profile_sounds *custom_sounds);
390
391 int func_confbridge_helper(struct ast_channel *chan, const char *cmd, char *data, const char *value);
392
393 /*!
394  * \brief Play sound file into conference bridge
395  *
396  * \param conference The conference bridge to play sound file into
397  * \param filename Sound file to play
398  *
399  * \retval 0 success
400  * \retval -1 failure
401  */
402 int play_sound_file(struct confbridge_conference *conference, const char *filename);
403
404 /*!
405  * \brief Play sound file into conference bridge asynchronously
406  *
407  * If the initiator parameter is non-NULL, then the playback will wait for
408  * that initiator channel to get back in the bridge before playing the sound
409  * file. This way, the initiator has no danger of hearing a "clipped" file.
410  *
411  * \param conference The conference bridge to play sound file into
412  * \param filename Sound file to play
413  * \param initiator Channel that initiated playback.
414  *
415  * \retval 0 success
416  * \retval -1 failure
417  */
418 int async_play_sound_file(struct confbridge_conference *conference, const char *filename,
419         struct ast_channel *initiator);
420
421 /*!
422  * \brief Indicate the initiator of an async sound file is ready for it to play.
423  *
424  * When playing an async sound file, the initiator is typically either out of the bridge
425  * or not in a position to hear the queued announcement. This function lets the announcement
426  * thread know that the initiator is now ready for the sound to play.
427  *
428  * If an async announcement was queued and no initiator channel was provided, then this is
429  * a no-op
430  *
431  * \param chan The channel that initiated the async announcement
432  */
433 void async_play_sound_ready(struct ast_channel *chan);
434
435 /*! \brief Callback to be called when the conference has become empty
436  * \param conference The conference bridge
437  */
438 void conf_ended(struct confbridge_conference *conference);
439
440 /*!
441  * \brief Update the actual mute status of the user and set it on the bridge.
442  *
443  * \param user User to update the mute status.
444  *
445  * \return Nothing
446  */
447 void conf_update_user_mute(struct confbridge_user *user);
448
449 /*!
450  * \brief Stop MOH for the conference user.
451  *
452  * \param user Conference user to stop MOH on.
453  *
454  * \return Nothing
455  */
456 void conf_moh_stop(struct confbridge_user *user);
457
458 /*!
459  * \brief Start MOH for the conference user.
460  *
461  * \param user Conference user to start MOH on.
462  *
463  * \return Nothing
464  */
465 void conf_moh_start(struct confbridge_user *user);
466
467 /*! \brief Attempt to mute/play MOH to the only user in the conference if they require it
468  * \param conference A conference bridge containing a single user
469  */
470 void conf_mute_only_active(struct confbridge_conference *conference);
471
472 /*! \brief Callback to execute any time we transition from zero to one active users
473  * \param conference The conference bridge with a single active user joined
474  * \retval 0 success
475  * \retval -1 failure
476  */
477 void conf_handle_first_join(struct confbridge_conference *conference);
478
479 /*! \brief Handle actions every time a waitmarked user joins w/o a marked user present
480  * \param user The waitmarked user
481  * \retval 0 success
482  * \retval -1 failure
483  */
484 int conf_handle_inactive_waitmarked(struct confbridge_user *user);
485
486 /*! \brief Handle actions whenever an unmarked user joins an inactive conference
487  * \note These actions seem like they could apply just as well to a marked user
488  * and possibly be made to happen any time transitioning to a single state.
489  *
490  * \param user The unmarked user
491  */
492 int conf_handle_only_unmarked(struct confbridge_user *user);
493
494 /*! \brief Handle when a conference moves to having more than one active participant
495  * \param conference The conference bridge with more than one active participant
496  */
497 void conf_handle_second_active(struct confbridge_conference *conference);
498
499 /*! \brief Add a conference bridge user as an unmarked active user of the conference
500  * \param conference The conference bridge to add the user to
501  * \param user The conference bridge user to add to the conference
502  */
503 void conf_add_user_active(struct confbridge_conference *conference, struct confbridge_user *user);
504
505 /*! \brief Add a conference bridge user as a marked active user of the conference
506  * \param conference The conference bridge to add the user to
507  * \param user The conference bridge user to add to the conference
508  */
509 void conf_add_user_marked(struct confbridge_conference *conference, struct confbridge_user *user);
510
511 /*! \brief Add a conference bridge user as an waiting user of the conference
512  * \param conference The conference bridge to add the user to
513  * \param user The conference bridge user to add to the conference
514  */
515 void conf_add_user_waiting(struct confbridge_conference *conference, struct confbridge_user *user);
516
517 /*! \brief Remove a conference bridge user from the unmarked active conference users in the conference
518  * \param conference The conference bridge to remove the user from
519  * \param user The conference bridge user to remove from the conference
520  */
521 void conf_remove_user_active(struct confbridge_conference *conference, struct confbridge_user *user);
522
523 /*! \brief Remove a conference bridge user from the marked active conference users in the conference
524  * \param conference The conference bridge to remove the user from
525  * \param user The conference bridge user to remove from the conference
526  */
527 void conf_remove_user_marked(struct confbridge_conference *conference, struct confbridge_user *user);
528
529 /*! \brief Remove a conference bridge user from the waiting conference users in the conference
530  * \param conference The conference bridge to remove the user from
531  * \param user The conference bridge user to remove from the conference
532  */
533 void conf_remove_user_waiting(struct confbridge_conference *conference, struct confbridge_user *user);
534
535 /*! \brief Queue a function to run with the given conference bridge user as an argument once the state transition is complete
536  * \param user The conference bridge user to pass to the function
537  * \param func The function to queue
538  * \retval 0 success
539  * \retval non-zero failure
540  */
541 int conf_add_post_join_action(struct confbridge_user *user, int (*func)(struct confbridge_user *user));
542
543 /*!
544  * \since 12.0
545  * \brief get the confbridge start stasis message type
546  *
547  * \retval stasis message type for confbridge start messages if it's available
548  * \retval NULL if it isn't
549  */
550 struct stasis_message_type *confbridge_start_type(void);
551
552 /*!
553  * \since 12.0
554  * \brief get the confbridge end stasis message type
555  *
556  * \retval stasis message type for confbridge end messages if it's available
557  * \retval NULL if it isn't
558  */
559 struct stasis_message_type *confbridge_end_type(void);
560
561 /*!
562  * \since 12.0
563  * \brief get the confbridge join stasis message type
564  *
565  * \retval stasis message type for confbridge join messages if it's available
566  * \retval NULL if it isn't
567  */
568 struct stasis_message_type *confbridge_join_type(void);
569
570 /*!
571  * \since 12.0
572  * \brief get the confbridge leave stasis message type
573  *
574  * \retval stasis message type for confbridge leave messages if it's available
575  * \retval NULL if it isn't
576  */
577 struct stasis_message_type *confbridge_leave_type(void);
578
579 /*!
580  * \since 12.0
581  * \brief get the confbridge start_record stasis message type
582  *
583  * \retval stasis message type for confbridge start_record messages if it's available
584  * \retval NULL if it isn't
585  */
586 struct stasis_message_type *confbridge_start_record_type(void);
587
588 /*!
589  * \since 12.0
590  * \brief get the confbridge stop_record stasis message type
591  *
592  * \retval stasis message type for confbridge stop_record messages if it's available
593  * \retval NULL if it isn't
594  */
595 struct stasis_message_type *confbridge_stop_record_type(void);
596
597 /*!
598  * \since 12.0
599  * \brief get the confbridge mute stasis message type
600  *
601  * \retval stasis message type for confbridge mute messages if it's available
602  * \retval NULL if it isn't
603  */
604 struct stasis_message_type *confbridge_mute_type(void);
605
606 /*!
607  * \since 12.0
608  * \brief get the confbridge unmute stasis message type
609  *
610  * \retval stasis message type for confbridge unmute messages if it's available
611  * \retval NULL if it isn't
612  */
613 struct stasis_message_type *confbridge_unmute_type(void);
614
615 /*!
616  * \since 12.0
617  * \brief get the confbridge talking stasis message type
618  *
619  * \retval stasis message type for confbridge talking messages if it's available
620  * \retval NULL if it isn't
621  */
622 struct stasis_message_type *confbridge_talking_type(void);
623
624 /*!
625  * \since 12.0
626  * \brief register stasis message routers to handle manager events for confbridge messages
627  *
628  * \retval 0 success
629  * \retval non-zero failure
630  */
631 int manager_confbridge_init(void);
632
633 /*!
634  * \since 12.0
635  * \brief unregister stasis message routers to handle manager events for confbridge messages
636  */
637 void manager_confbridge_shutdown(void);
638
639 /*!
640  * \brief Get ConfBridge record channel technology struct.
641  * \since 12.0.0
642  *
643  * \return ConfBridge record channel technology.
644  */
645 struct ast_channel_tech *conf_record_get_tech(void);
646
647 /*!
648  * \brief Get ConfBridge announce channel technology struct.
649  * \since 12.0.0
650  *
651  * \return ConfBridge announce channel technology.
652  */
653 struct ast_channel_tech *conf_announce_get_tech(void);
654
655 /*!
656  * \brief Push the announcer channel into the conference.
657  * \since 12.0.0
658  *
659  * \param ast Either channel in the announcer channel pair.
660  *
661  * \retval 0 on success.
662  * \retval -1 on error.
663  */
664 int conf_announce_channel_push(struct ast_channel *ast);
665 #endif