bridging: Give bridges a name and a known creator
[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 /*! \brief 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 /*! \brief Argument struct for ast_ari_bridges_create() */
54 struct ast_ari_bridges_create_args {
55         /*! \brief Type of bridge to create. */
56         const char *type;
57         /*! \brief Name to give to the bridge being created. */
58         const char *name;
59 };
60 /*!
61  * \brief Create a new bridge.
62  *
63  * This bridge persists until it has been shut down, or Asterisk has been shut down.
64  *
65  * \param headers HTTP headers
66  * \param args Swagger parameters
67  * \param[out] response HTTP response
68  */
69 void ast_ari_bridges_create(struct ast_variable *headers, struct ast_ari_bridges_create_args *args, struct ast_ari_response *response);
70 /*! \brief Argument struct for ast_ari_bridges_get() */
71 struct ast_ari_bridges_get_args {
72         /*! \brief Bridge's id */
73         const char *bridge_id;
74 };
75 /*!
76  * \brief Get bridge details.
77  *
78  * \param headers HTTP headers
79  * \param args Swagger parameters
80  * \param[out] response HTTP response
81  */
82 void ast_ari_bridges_get(struct ast_variable *headers, struct ast_ari_bridges_get_args *args, struct ast_ari_response *response);
83 /*! \brief Argument struct for ast_ari_bridges_destroy() */
84 struct ast_ari_bridges_destroy_args {
85         /*! \brief Bridge's id */
86         const char *bridge_id;
87 };
88 /*!
89  * \brief Shut down a bridge.
90  *
91  * If any channels are in this bridge, they will be removed and resume whatever they were doing beforehand.
92  *
93  * \param headers HTTP headers
94  * \param args Swagger parameters
95  * \param[out] response HTTP response
96  */
97 void ast_ari_bridges_destroy(struct ast_variable *headers, struct ast_ari_bridges_destroy_args *args, struct ast_ari_response *response);
98 /*! \brief Argument struct for ast_ari_bridges_add_channel() */
99 struct ast_ari_bridges_add_channel_args {
100         /*! \brief Bridge's id */
101         const char *bridge_id;
102         /*! \brief Array of Ids of channels to add to bridge */
103         const char **channel;
104         /*! \brief Length of channel array. */
105         size_t channel_count;
106         /*! \brief Parsing context for channel. */
107         char *channel_parse;
108         /*! \brief Channel's role in the bridge */
109         const char *role;
110 };
111 /*!
112  * \brief Add a channel to a bridge.
113  *
114  * \param headers HTTP headers
115  * \param args Swagger parameters
116  * \param[out] response HTTP response
117  */
118 void ast_ari_bridges_add_channel(struct ast_variable *headers, struct ast_ari_bridges_add_channel_args *args, struct ast_ari_response *response);
119 /*! \brief Argument struct for ast_ari_bridges_remove_channel() */
120 struct ast_ari_bridges_remove_channel_args {
121         /*! \brief Bridge's id */
122         const char *bridge_id;
123         /*! \brief Array of Ids of channels to remove from bridge */
124         const char **channel;
125         /*! \brief Length of channel array. */
126         size_t channel_count;
127         /*! \brief Parsing context for channel. */
128         char *channel_parse;
129 };
130 /*!
131  * \brief Remove a channel from a bridge.
132  *
133  * \param headers HTTP headers
134  * \param args Swagger parameters
135  * \param[out] response HTTP response
136  */
137 void ast_ari_bridges_remove_channel(struct ast_variable *headers, struct ast_ari_bridges_remove_channel_args *args, struct ast_ari_response *response);
138 /*! \brief Argument struct for ast_ari_bridges_start_moh() */
139 struct ast_ari_bridges_start_moh_args {
140         /*! \brief Bridge's id */
141         const char *bridge_id;
142         /*! \brief Channel's id */
143         const char *moh_class;
144 };
145 /*!
146  * \brief Play music on hold to a bridge or change the MOH class that is playing.
147  *
148  * \param headers HTTP headers
149  * \param args Swagger parameters
150  * \param[out] response HTTP response
151  */
152 void ast_ari_bridges_start_moh(struct ast_variable *headers, struct ast_ari_bridges_start_moh_args *args, struct ast_ari_response *response);
153 /*! \brief Argument struct for ast_ari_bridges_stop_moh() */
154 struct ast_ari_bridges_stop_moh_args {
155         /*! \brief Bridge's id */
156         const char *bridge_id;
157 };
158 /*!
159  * \brief Stop playing music on hold to a bridge.
160  *
161  * This will only stop music on hold being played via POST bridges/{bridgeId}/moh.
162  *
163  * \param headers HTTP headers
164  * \param args Swagger parameters
165  * \param[out] response HTTP response
166  */
167 void ast_ari_bridges_stop_moh(struct ast_variable *headers, struct ast_ari_bridges_stop_moh_args *args, struct ast_ari_response *response);
168 /*! \brief Argument struct for ast_ari_bridges_play() */
169 struct ast_ari_bridges_play_args {
170         /*! \brief Bridge's id */
171         const char *bridge_id;
172         /*! \brief Media's URI to play. */
173         const char *media;
174         /*! \brief For sounds, selects language for sound. */
175         const char *lang;
176         /*! \brief Number of media to skip before playing. */
177         int offsetms;
178         /*! \brief Number of milliseconds to skip for forward/reverse operations. */
179         int skipms;
180 };
181 /*!
182  * \brief Start playback of media on a bridge.
183  *
184  * The media URI may be any of a number of URI's. Currently sound: and recording: 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.)
185  *
186  * \param headers HTTP headers
187  * \param args Swagger parameters
188  * \param[out] response HTTP response
189  */
190 void ast_ari_bridges_play(struct ast_variable *headers, struct ast_ari_bridges_play_args *args, struct ast_ari_response *response);
191 /*! \brief Argument struct for ast_ari_bridges_record() */
192 struct ast_ari_bridges_record_args {
193         /*! \brief Bridge's id */
194         const char *bridge_id;
195         /*! \brief Recording's filename */
196         const char *name;
197         /*! \brief Format to encode audio in */
198         const char *format;
199         /*! \brief Maximum duration of the recording, in seconds. 0 for no limit. */
200         int max_duration_seconds;
201         /*! \brief Maximum duration of silence, in seconds. 0 for no limit. */
202         int max_silence_seconds;
203         /*! \brief Action to take if a recording with the same name already exists. */
204         const char *if_exists;
205         /*! \brief Play beep when recording begins */
206         int beep;
207         /*! \brief DTMF input to terminate recording. */
208         const char *terminate_on;
209 };
210 /*!
211  * \brief Start a recording.
212  *
213  * This records the mixed audio from all channels participating in this bridge.
214  *
215  * \param headers HTTP headers
216  * \param args Swagger parameters
217  * \param[out] response HTTP response
218  */
219 void ast_ari_bridges_record(struct ast_variable *headers, struct ast_ari_bridges_record_args *args, struct ast_ari_response *response);
220
221 #endif /* _ASTERISK_RESOURCE_BRIDGES_H */