res/ari/resource_bridges.h: Update from 'make ari-stubs'.
[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, video_sfu). */
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, video_sfu) 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         /*! Absorb DTMF coming from this channel, preventing it to pass through to the bridge */
154         int absorb_dtmf;
155         /*! Mute audio from this channel, preventing it to pass through to the bridge */
156         int mute;
157 };
158 /*!
159  * \brief Body parsing function for /bridges/{bridgeId}/addChannel.
160  * \param body The JSON body from which to parse parameters.
161  * \param[out] args The args structure to parse into.
162  * \retval zero on success
163  * \retval non-zero on failure
164  */
165 int ast_ari_bridges_add_channel_parse_body(
166         struct ast_json *body,
167         struct ast_ari_bridges_add_channel_args *args);
168
169 /*!
170  * \brief Add a channel to a bridge.
171  *
172  * \param headers HTTP headers
173  * \param args Swagger parameters
174  * \param[out] response HTTP response
175  */
176 void ast_ari_bridges_add_channel(struct ast_variable *headers, struct ast_ari_bridges_add_channel_args *args, struct ast_ari_response *response);
177 /*! Argument struct for ast_ari_bridges_remove_channel() */
178 struct ast_ari_bridges_remove_channel_args {
179         /*! Bridge's id */
180         const char *bridge_id;
181         /*! Array of Ids of channels to remove from bridge */
182         const char **channel;
183         /*! Length of channel array. */
184         size_t channel_count;
185         /*! Parsing context for channel. */
186         char *channel_parse;
187 };
188 /*!
189  * \brief Body parsing function for /bridges/{bridgeId}/removeChannel.
190  * \param body The JSON body from which to parse parameters.
191  * \param[out] args The args structure to parse into.
192  * \retval zero on success
193  * \retval non-zero on failure
194  */
195 int ast_ari_bridges_remove_channel_parse_body(
196         struct ast_json *body,
197         struct ast_ari_bridges_remove_channel_args *args);
198
199 /*!
200  * \brief Remove a channel from a bridge.
201  *
202  * \param headers HTTP headers
203  * \param args Swagger parameters
204  * \param[out] response HTTP response
205  */
206 void ast_ari_bridges_remove_channel(struct ast_variable *headers, struct ast_ari_bridges_remove_channel_args *args, struct ast_ari_response *response);
207 /*! Argument struct for ast_ari_bridges_set_video_source() */
208 struct ast_ari_bridges_set_video_source_args {
209         /*! Bridge's id */
210         const char *bridge_id;
211         /*! Channel's id */
212         const char *channel_id;
213 };
214 /*!
215  * \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.
216  *
217  * \param headers HTTP headers
218  * \param args Swagger parameters
219  * \param[out] response HTTP response
220  */
221 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);
222 /*! Argument struct for ast_ari_bridges_clear_video_source() */
223 struct ast_ari_bridges_clear_video_source_args {
224         /*! Bridge's id */
225         const char *bridge_id;
226 };
227 /*!
228  * \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.
229  *
230  * \param headers HTTP headers
231  * \param args Swagger parameters
232  * \param[out] response HTTP response
233  */
234 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);
235 /*! Argument struct for ast_ari_bridges_start_moh() */
236 struct ast_ari_bridges_start_moh_args {
237         /*! Bridge's id */
238         const char *bridge_id;
239         /*! Channel's id */
240         const char *moh_class;
241 };
242 /*!
243  * \brief Body parsing function for /bridges/{bridgeId}/moh.
244  * \param body The JSON body from which to parse parameters.
245  * \param[out] args The args structure to parse into.
246  * \retval zero on success
247  * \retval non-zero on failure
248  */
249 int ast_ari_bridges_start_moh_parse_body(
250         struct ast_json *body,
251         struct ast_ari_bridges_start_moh_args *args);
252
253 /*!
254  * \brief Play music on hold to a bridge or change the MOH class that is playing.
255  *
256  * \param headers HTTP headers
257  * \param args Swagger parameters
258  * \param[out] response HTTP response
259  */
260 void ast_ari_bridges_start_moh(struct ast_variable *headers, struct ast_ari_bridges_start_moh_args *args, struct ast_ari_response *response);
261 /*! Argument struct for ast_ari_bridges_stop_moh() */
262 struct ast_ari_bridges_stop_moh_args {
263         /*! Bridge's id */
264         const char *bridge_id;
265 };
266 /*!
267  * \brief Stop playing music on hold to a bridge.
268  *
269  * This will only stop music on hold being played via POST bridges/{bridgeId}/moh.
270  *
271  * \param headers HTTP headers
272  * \param args Swagger parameters
273  * \param[out] response HTTP response
274  */
275 void ast_ari_bridges_stop_moh(struct ast_variable *headers, struct ast_ari_bridges_stop_moh_args *args, struct ast_ari_response *response);
276 /*! Argument struct for ast_ari_bridges_play() */
277 struct ast_ari_bridges_play_args {
278         /*! Bridge's id */
279         const char *bridge_id;
280         /*! Array of Media URIs to play. */
281         const char **media;
282         /*! Length of media array. */
283         size_t media_count;
284         /*! Parsing context for media. */
285         char *media_parse;
286         /*! For sounds, selects language for sound. */
287         const char *lang;
288         /*! Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified. */
289         int offsetms;
290         /*! Number of milliseconds to skip for forward/reverse operations. */
291         int skipms;
292         /*! Playback Id. */
293         const char *playback_id;
294 };
295 /*!
296  * \brief Body parsing function for /bridges/{bridgeId}/play.
297  * \param body The JSON body from which to parse parameters.
298  * \param[out] args The args structure to parse into.
299  * \retval zero on success
300  * \retval non-zero on failure
301  */
302 int ast_ari_bridges_play_parse_body(
303         struct ast_json *body,
304         struct ast_ari_bridges_play_args *args);
305
306 /*!
307  * \brief Start playback of media on a bridge.
308  *
309  * 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.)
310  *
311  * \param headers HTTP headers
312  * \param args Swagger parameters
313  * \param[out] response HTTP response
314  */
315 void ast_ari_bridges_play(struct ast_variable *headers, struct ast_ari_bridges_play_args *args, struct ast_ari_response *response);
316 /*! Argument struct for ast_ari_bridges_play_with_id() */
317 struct ast_ari_bridges_play_with_id_args {
318         /*! Bridge's id */
319         const char *bridge_id;
320         /*! Playback ID. */
321         const char *playback_id;
322         /*! Array of Media URIs to play. */
323         const char **media;
324         /*! Length of media array. */
325         size_t media_count;
326         /*! Parsing context for media. */
327         char *media_parse;
328         /*! For sounds, selects language for sound. */
329         const char *lang;
330         /*! Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified. */
331         int offsetms;
332         /*! Number of milliseconds to skip for forward/reverse operations. */
333         int skipms;
334 };
335 /*!
336  * \brief Body parsing function for /bridges/{bridgeId}/play/{playbackId}.
337  * \param body The JSON body from which to parse parameters.
338  * \param[out] args The args structure to parse into.
339  * \retval zero on success
340  * \retval non-zero on failure
341  */
342 int ast_ari_bridges_play_with_id_parse_body(
343         struct ast_json *body,
344         struct ast_ari_bridges_play_with_id_args *args);
345
346 /*!
347  * \brief Start playback of media on a bridge.
348  *
349  * 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.)
350  *
351  * \param headers HTTP headers
352  * \param args Swagger parameters
353  * \param[out] response HTTP response
354  */
355 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);
356 /*! Argument struct for ast_ari_bridges_record() */
357 struct ast_ari_bridges_record_args {
358         /*! Bridge's id */
359         const char *bridge_id;
360         /*! Recording's filename */
361         const char *name;
362         /*! Format to encode audio in */
363         const char *format;
364         /*! Maximum duration of the recording, in seconds. 0 for no limit. */
365         int max_duration_seconds;
366         /*! Maximum duration of silence, in seconds. 0 for no limit. */
367         int max_silence_seconds;
368         /*! Action to take if a recording with the same name already exists. */
369         const char *if_exists;
370         /*! Play beep when recording begins */
371         int beep;
372         /*! DTMF input to terminate recording. */
373         const char *terminate_on;
374 };
375 /*!
376  * \brief Body parsing function for /bridges/{bridgeId}/record.
377  * \param body The JSON body from which to parse parameters.
378  * \param[out] args The args structure to parse into.
379  * \retval zero on success
380  * \retval non-zero on failure
381  */
382 int ast_ari_bridges_record_parse_body(
383         struct ast_json *body,
384         struct ast_ari_bridges_record_args *args);
385
386 /*!
387  * \brief Start a recording.
388  *
389  * This records the mixed audio from all channels participating in this bridge.
390  *
391  * \param headers HTTP headers
392  * \param args Swagger parameters
393  * \param[out] response HTTP response
394  */
395 void ast_ari_bridges_record(struct ast_variable *headers, struct ast_ari_bridges_record_args *args, struct ast_ari_response *response);
396
397 #endif /* _ASTERISK_RESOURCE_BRIDGES_H */