e75d8e028731526af9f58bbb5daa0c12ba4a822e
[asterisk/asterisk.git] / res / ari / resource_bridges.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2012 - 2013, Digium, Inc.
5  *
6  * David M. Lee, II <dlee@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  *
21  * \brief Generated file - declares stubs to be implemented in
22  * res/ari/resource_bridges.c
23  *
24  * Bridge resources
25  *
26  * \author David M. Lee, II <dlee@digium.com>
27  */
28
29 /*
30  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
31  * !!!!!                               DO NOT EDIT                        !!!!!
32  * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
33  * This file is generated by a mustache template. Please see the original
34  * template in rest-api-templates/ari_resource.h.mustache
35  */
36
37 #ifndef _ASTERISK_RESOURCE_BRIDGES_H
38 #define _ASTERISK_RESOURCE_BRIDGES_H
39
40 #include "asterisk/ari.h"
41
42 /*! Argument struct for ast_ari_bridges_list() */
43 struct ast_ari_bridges_list_args {
44 };
45 /*!
46  * \brief List all active bridges in Asterisk.
47  *
48  * \param headers HTTP headers
49  * \param args Swagger parameters
50  * \param[out] response HTTP response
51  */
52 void ast_ari_bridges_list(struct ast_variable *headers, struct ast_ari_bridges_list_args *args, struct ast_ari_response *response);
53 /*! Argument struct for ast_ari_bridges_create() */
54 struct ast_ari_bridges_create_args {
55         /*! Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media). */
56         const char *type;
57         /*! Unique ID to give to the bridge being created. */
58         const char *bridge_id;
59         /*! Name to give to the bridge being created. */
60         const char *name;
61 };
62 /*!
63  * \brief Body parsing function for /bridges.
64  * \param body The JSON body from which to parse parameters.
65  * \param[out] args The args structure to parse into.
66  * \retval zero on success
67  * \retval non-zero on failure
68  */
69 int ast_ari_bridges_create_parse_body(
70         struct ast_json *body,
71         struct ast_ari_bridges_create_args *args);
72
73 /*!
74  * \brief Create a new bridge.
75  *
76  * This bridge persists until it has been shut down, or Asterisk has been shut down.
77  *
78  * \param headers HTTP headers
79  * \param args Swagger parameters
80  * \param[out] response HTTP response
81  */
82 void ast_ari_bridges_create(struct ast_variable *headers, struct ast_ari_bridges_create_args *args, struct ast_ari_response *response);
83 /*! Argument struct for ast_ari_bridges_create_with_id() */
84 struct ast_ari_bridges_create_with_id_args {
85         /*! Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media) to set. */
86         const char *type;
87         /*! Unique ID to give to the bridge being created. */
88         const char *bridge_id;
89         /*! Set the name of the bridge. */
90         const char *name;
91 };
92 /*!
93  * \brief Body parsing function for /bridges/{bridgeId}.
94  * \param body The JSON body from which to parse parameters.
95  * \param[out] args The args structure to parse into.
96  * \retval zero on success
97  * \retval non-zero on failure
98  */
99 int ast_ari_bridges_create_with_id_parse_body(
100         struct ast_json *body,
101         struct ast_ari_bridges_create_with_id_args *args);
102
103 /*!
104  * \brief Create a new bridge or updates an existing one.
105  *
106  * This bridge persists until it has been shut down, or Asterisk has been shut down.
107  *
108  * \param headers HTTP headers
109  * \param args Swagger parameters
110  * \param[out] response HTTP response
111  */
112 void ast_ari_bridges_create_with_id(struct ast_variable *headers, struct ast_ari_bridges_create_with_id_args *args, struct ast_ari_response *response);
113 /*! Argument struct for ast_ari_bridges_get() */
114 struct ast_ari_bridges_get_args {
115         /*! Bridge's id */
116         const char *bridge_id;
117 };
118 /*!
119  * \brief Get bridge details.
120  *
121  * \param headers HTTP headers
122  * \param args Swagger parameters
123  * \param[out] response HTTP response
124  */
125 void ast_ari_bridges_get(struct ast_variable *headers, struct ast_ari_bridges_get_args *args, struct ast_ari_response *response);
126 /*! Argument struct for ast_ari_bridges_destroy() */
127 struct ast_ari_bridges_destroy_args {
128         /*! Bridge's id */
129         const char *bridge_id;
130 };
131 /*!
132  * \brief Shut down a bridge.
133  *
134  * If any channels are in this bridge, they will be removed and resume whatever they were doing beforehand.
135  *
136  * \param headers HTTP headers
137  * \param args Swagger parameters
138  * \param[out] response HTTP response
139  */
140 void ast_ari_bridges_destroy(struct ast_variable *headers, struct ast_ari_bridges_destroy_args *args, struct ast_ari_response *response);
141 /*! Argument struct for ast_ari_bridges_add_channel() */
142 struct ast_ari_bridges_add_channel_args {
143         /*! Bridge's id */
144         const char *bridge_id;
145         /*! Array of Ids of channels to add to bridge */
146         const char **channel;
147         /*! Length of channel array. */
148         size_t channel_count;
149         /*! Parsing context for channel. */
150         char *channel_parse;
151         /*! Channel's role in the bridge */
152         const char *role;
153 };
154 /*!
155  * \brief Body parsing function for /bridges/{bridgeId}/addChannel.
156  * \param body The JSON body from which to parse parameters.
157  * \param[out] args The args structure to parse into.
158  * \retval zero on success
159  * \retval non-zero on failure
160  */
161 int ast_ari_bridges_add_channel_parse_body(
162         struct ast_json *body,
163         struct ast_ari_bridges_add_channel_args *args);
164
165 /*!
166  * \brief Add a channel to a bridge.
167  *
168  * \param headers HTTP headers
169  * \param args Swagger parameters
170  * \param[out] response HTTP response
171  */
172 void ast_ari_bridges_add_channel(struct ast_variable *headers, struct ast_ari_bridges_add_channel_args *args, struct ast_ari_response *response);
173 /*! Argument struct for ast_ari_bridges_remove_channel() */
174 struct ast_ari_bridges_remove_channel_args {
175         /*! Bridge's id */
176         const char *bridge_id;
177         /*! Array of Ids of channels to remove from bridge */
178         const char **channel;
179         /*! Length of channel array. */
180         size_t channel_count;
181         /*! Parsing context for channel. */
182         char *channel_parse;
183 };
184 /*!
185  * \brief Body parsing function for /bridges/{bridgeId}/removeChannel.
186  * \param body The JSON body from which to parse parameters.
187  * \param[out] args The args structure to parse into.
188  * \retval zero on success
189  * \retval non-zero on failure
190  */
191 int ast_ari_bridges_remove_channel_parse_body(
192         struct ast_json *body,
193         struct ast_ari_bridges_remove_channel_args *args);
194
195 /*!
196  * \brief Remove a channel from a bridge.
197  *
198  * \param headers HTTP headers
199  * \param args Swagger parameters
200  * \param[out] response HTTP response
201  */
202 void ast_ari_bridges_remove_channel(struct ast_variable *headers, struct ast_ari_bridges_remove_channel_args *args, struct ast_ari_response *response);
203 /*! Argument struct for ast_ari_bridges_set_video_source() */
204 struct ast_ari_bridges_set_video_source_args {
205         /*! Bridge's id */
206         const char *bridge_id;
207         /*! Channel's id */
208         const char *channel_id;
209 };
210 /*!
211  * \brief Set a channel as the video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants.
212  *
213  * \param headers HTTP headers
214  * \param args Swagger parameters
215  * \param[out] response HTTP response
216  */
217 void ast_ari_bridges_set_video_source(struct ast_variable *headers, struct ast_ari_bridges_set_video_source_args *args, struct ast_ari_response *response);
218 /*! Argument struct for ast_ari_bridges_clear_video_source() */
219 struct ast_ari_bridges_clear_video_source_args {
220         /*! Bridge's id */
221         const char *bridge_id;
222 };
223 /*!
224  * \brief Removes any explicit video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants. When no explicit video source is set, talk detection will be used to determine the active video stream.
225  *
226  * \param headers HTTP headers
227  * \param args Swagger parameters
228  * \param[out] response HTTP response
229  */
230 void ast_ari_bridges_clear_video_source(struct ast_variable *headers, struct ast_ari_bridges_clear_video_source_args *args, struct ast_ari_response *response);
231 /*! Argument struct for ast_ari_bridges_start_moh() */
232 struct ast_ari_bridges_start_moh_args {
233         /*! Bridge's id */
234         const char *bridge_id;
235         /*! Channel's id */
236         const char *moh_class;
237 };
238 /*!
239  * \brief Body parsing function for /bridges/{bridgeId}/moh.
240  * \param body The JSON body from which to parse parameters.
241  * \param[out] args The args structure to parse into.
242  * \retval zero on success
243  * \retval non-zero on failure
244  */
245 int ast_ari_bridges_start_moh_parse_body(
246         struct ast_json *body,
247         struct ast_ari_bridges_start_moh_args *args);
248
249 /*!
250  * \brief Play music on hold to a bridge or change the MOH class that is playing.
251  *
252  * \param headers HTTP headers
253  * \param args Swagger parameters
254  * \param[out] response HTTP response
255  */
256 void ast_ari_bridges_start_moh(struct ast_variable *headers, struct ast_ari_bridges_start_moh_args *args, struct ast_ari_response *response);
257 /*! Argument struct for ast_ari_bridges_stop_moh() */
258 struct ast_ari_bridges_stop_moh_args {
259         /*! Bridge's id */
260         const char *bridge_id;
261 };
262 /*!
263  * \brief Stop playing music on hold to a bridge.
264  *
265  * This will only stop music on hold being played via POST bridges/{bridgeId}/moh.
266  *
267  * \param headers HTTP headers
268  * \param args Swagger parameters
269  * \param[out] response HTTP response
270  */
271 void ast_ari_bridges_stop_moh(struct ast_variable *headers, struct ast_ari_bridges_stop_moh_args *args, struct ast_ari_response *response);
272 /*! Argument struct for ast_ari_bridges_play() */
273 struct ast_ari_bridges_play_args {
274         /*! Bridge's id */
275         const char *bridge_id;
276         /*! Array of Media URIs to play. */
277         const char **media;
278         /*! Length of media array. */
279         size_t media_count;
280         /*! Parsing context for media. */
281         char *media_parse;
282         /*! For sounds, selects language for sound. */
283         const char *lang;
284         /*! Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified. */
285         int offsetms;
286         /*! Number of milliseconds to skip for forward/reverse operations. */
287         int skipms;
288         /*! Playback Id. */
289         const char *playback_id;
290 };
291 /*!
292  * \brief Body parsing function for /bridges/{bridgeId}/play.
293  * \param body The JSON body from which to parse parameters.
294  * \param[out] args The args structure to parse into.
295  * \retval zero on success
296  * \retval non-zero on failure
297  */
298 int ast_ari_bridges_play_parse_body(
299         struct ast_json *body,
300         struct ast_ari_bridges_play_args *args);
301
302 /*!
303  * \brief Start playback of media on a bridge.
304  *
305  * The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)
306  *
307  * \param headers HTTP headers
308  * \param args Swagger parameters
309  * \param[out] response HTTP response
310  */
311 void ast_ari_bridges_play(struct ast_variable *headers, struct ast_ari_bridges_play_args *args, struct ast_ari_response *response);
312 /*! Argument struct for ast_ari_bridges_play_with_id() */
313 struct ast_ari_bridges_play_with_id_args {
314         /*! Bridge's id */
315         const char *bridge_id;
316         /*! Playback ID. */
317         const char *playback_id;
318         /*! Array of Media URIs to play. */
319         const char **media;
320         /*! Length of media array. */
321         size_t media_count;
322         /*! Parsing context for media. */
323         char *media_parse;
324         /*! For sounds, selects language for sound. */
325         const char *lang;
326         /*! Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified. */
327         int offsetms;
328         /*! Number of milliseconds to skip for forward/reverse operations. */
329         int skipms;
330 };
331 /*!
332  * \brief Body parsing function for /bridges/{bridgeId}/play/{playbackId}.
333  * \param body The JSON body from which to parse parameters.
334  * \param[out] args The args structure to parse into.
335  * \retval zero on success
336  * \retval non-zero on failure
337  */
338 int ast_ari_bridges_play_with_id_parse_body(
339         struct ast_json *body,
340         struct ast_ari_bridges_play_with_id_args *args);
341
342 /*!
343  * \brief Start playback of media on a bridge.
344  *
345  * The media URI may be any of a number of URI's. Currently sound:, recording:, number:, digits:, characters:, and tone: URI's are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)
346  *
347  * \param headers HTTP headers
348  * \param args Swagger parameters
349  * \param[out] response HTTP response
350  */
351 void ast_ari_bridges_play_with_id(struct ast_variable *headers, struct ast_ari_bridges_play_with_id_args *args, struct ast_ari_response *response);
352 /*! Argument struct for ast_ari_bridges_record() */
353 struct ast_ari_bridges_record_args {
354         /*! Bridge's id */
355         const char *bridge_id;
356         /*! Recording's filename */
357         const char *name;
358         /*! Format to encode audio in */
359         const char *format;
360         /*! Maximum duration of the recording, in seconds. 0 for no limit. */
361         int max_duration_seconds;
362         /*! Maximum duration of silence, in seconds. 0 for no limit. */
363         int max_silence_seconds;
364         /*! Action to take if a recording with the same name already exists. */
365         const char *if_exists;
366         /*! Play beep when recording begins */
367         int beep;
368         /*! DTMF input to terminate recording. */
369         const char *terminate_on;
370 };
371 /*!
372  * \brief Body parsing function for /bridges/{bridgeId}/record.
373  * \param body The JSON body from which to parse parameters.
374  * \param[out] args The args structure to parse into.
375  * \retval zero on success
376  * \retval non-zero on failure
377  */
378 int ast_ari_bridges_record_parse_body(
379         struct ast_json *body,
380         struct ast_ari_bridges_record_args *args);
381
382 /*!
383  * \brief Start a recording.
384  *
385  * This records the mixed audio from all channels participating in this bridge.
386  *
387  * \param headers HTTP headers
388  * \param args Swagger parameters
389  * \param[out] response HTTP response
390  */
391 void ast_ari_bridges_record(struct ast_variable *headers, struct ast_ari_bridges_record_args *args, struct ast_ari_response *response);
392
393 #endif /* _ASTERISK_RESOURCE_BRIDGES_H */