Merge "README-SERIOUSLY.bestpractices.md: Speling correetions."
[asterisk/asterisk.git] / res / ari / resource_bridges.h
index 892a3f2..0d0286c 100644 (file)
 
 #include "asterisk/ari.h"
 
-/*! \brief Argument struct for ast_ari_get_bridges() */
-struct ast_get_bridges_args {
+/*! Argument struct for ast_ari_bridges_list() */
+struct ast_ari_bridges_list_args {
 };
 /*!
- * \brief List active bridges.
+ * \brief List all active bridges in Asterisk.
  *
  * \param headers HTTP headers
  * \param args Swagger parameters
  * \param[out] response HTTP response
  */
-void ast_ari_get_bridges(struct ast_variable *headers, struct ast_get_bridges_args *args, struct ast_ari_response *response);
-/*! \brief Argument struct for ast_ari_new_bridge() */
-struct ast_new_bridge_args {
-       /*! \brief Type of bridge to create. */
+void ast_ari_bridges_list(struct ast_variable *headers, struct ast_ari_bridges_list_args *args, struct ast_ari_response *response);
+/*! Argument struct for ast_ari_bridges_create() */
+struct ast_ari_bridges_create_args {
+       /*! Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu). */
        const char *type;
+       /*! Unique ID to give to the bridge being created. */
+       const char *bridge_id;
+       /*! Name to give to the bridge being created. */
+       const char *name;
 };
 /*!
+ * \brief Body parsing function for /bridges.
+ * \param body The JSON body from which to parse parameters.
+ * \param[out] args The args structure to parse into.
+ * \retval zero on success
+ * \retval non-zero on failure
+ */
+int ast_ari_bridges_create_parse_body(
+       struct ast_json *body,
+       struct ast_ari_bridges_create_args *args);
+
+/*!
  * \brief Create a new bridge.
  *
  * This bridge persists until it has been shut down, or Asterisk has been shut down.
@@ -64,10 +79,40 @@ struct ast_new_bridge_args {
  * \param args Swagger parameters
  * \param[out] response HTTP response
  */
-void ast_ari_new_bridge(struct ast_variable *headers, struct ast_new_bridge_args *args, struct ast_ari_response *response);
-/*! \brief Argument struct for ast_ari_get_bridge() */
-struct ast_get_bridge_args {
-       /*! \brief Bridge's id */
+void ast_ari_bridges_create(struct ast_variable *headers, struct ast_ari_bridges_create_args *args, struct ast_ari_response *response);
+/*! Argument struct for ast_ari_bridges_create_with_id() */
+struct ast_ari_bridges_create_with_id_args {
+       /*! Comma separated list of bridge type attributes (mixing, holding, dtmf_events, proxy_media, video_sfu) to set. */
+       const char *type;
+       /*! Unique ID to give to the bridge being created. */
+       const char *bridge_id;
+       /*! Set the name of the bridge. */
+       const char *name;
+};
+/*!
+ * \brief Body parsing function for /bridges/{bridgeId}.
+ * \param body The JSON body from which to parse parameters.
+ * \param[out] args The args structure to parse into.
+ * \retval zero on success
+ * \retval non-zero on failure
+ */
+int ast_ari_bridges_create_with_id_parse_body(
+       struct ast_json *body,
+       struct ast_ari_bridges_create_with_id_args *args);
+
+/*!
+ * \brief Create a new bridge or updates an existing one.
+ *
+ * This bridge persists until it has been shut down, or Asterisk has been shut down.
+ *
+ * \param headers HTTP headers
+ * \param args Swagger parameters
+ * \param[out] response HTTP response
+ */
+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);
+/*! Argument struct for ast_ari_bridges_get() */
+struct ast_ari_bridges_get_args {
+       /*! Bridge's id */
        const char *bridge_id;
 };
 /*!
@@ -77,10 +122,10 @@ struct ast_get_bridge_args {
  * \param args Swagger parameters
  * \param[out] response HTTP response
  */
-void ast_ari_get_bridge(struct ast_variable *headers, struct ast_get_bridge_args *args, struct ast_ari_response *response);
-/*! \brief Argument struct for ast_ari_delete_bridge() */
-struct ast_delete_bridge_args {
-       /*! \brief Bridge's id */
+void ast_ari_bridges_get(struct ast_variable *headers, struct ast_ari_bridges_get_args *args, struct ast_ari_response *response);
+/*! Argument struct for ast_ari_bridges_destroy() */
+struct ast_ari_bridges_destroy_args {
+       /*! Bridge's id */
        const char *bridge_id;
 };
 /*!
@@ -92,80 +137,253 @@ struct ast_delete_bridge_args {
  * \param args Swagger parameters
  * \param[out] response HTTP response
  */
-void ast_ari_delete_bridge(struct ast_variable *headers, struct ast_delete_bridge_args *args, struct ast_ari_response *response);
-/*! \brief Argument struct for ast_ari_add_channel_to_bridge() */
-struct ast_add_channel_to_bridge_args {
-       /*! \brief Bridge's id */
+void ast_ari_bridges_destroy(struct ast_variable *headers, struct ast_ari_bridges_destroy_args *args, struct ast_ari_response *response);
+/*! Argument struct for ast_ari_bridges_add_channel() */
+struct ast_ari_bridges_add_channel_args {
+       /*! Bridge's id */
        const char *bridge_id;
-       /*! \brief Channel's id */
-       const char *channel;
+       /*! Array of Ids of channels to add to bridge */
+       const char **channel;
+       /*! Length of channel array. */
+       size_t channel_count;
+       /*! Parsing context for channel. */
+       char *channel_parse;
+       /*! Channel's role in the bridge */
+       const char *role;
+       /*! Absorb DTMF coming from this channel, preventing it to pass through to the bridge */
+       int absorb_dtmf;
+       /*! Mute audio from this channel, preventing it to pass through to the bridge */
+       int mute;
 };
 /*!
+ * \brief Body parsing function for /bridges/{bridgeId}/addChannel.
+ * \param body The JSON body from which to parse parameters.
+ * \param[out] args The args structure to parse into.
+ * \retval zero on success
+ * \retval non-zero on failure
+ */
+int ast_ari_bridges_add_channel_parse_body(
+       struct ast_json *body,
+       struct ast_ari_bridges_add_channel_args *args);
+
+/*!
  * \brief Add a channel to a bridge.
  *
  * \param headers HTTP headers
  * \param args Swagger parameters
  * \param[out] response HTTP response
  */
-void ast_ari_add_channel_to_bridge(struct ast_variable *headers, struct ast_add_channel_to_bridge_args *args, struct ast_ari_response *response);
-/*! \brief Argument struct for ast_ari_remove_channel_from_bridge() */
-struct ast_remove_channel_from_bridge_args {
-       /*! \brief Bridge's id */
+void ast_ari_bridges_add_channel(struct ast_variable *headers, struct ast_ari_bridges_add_channel_args *args, struct ast_ari_response *response);
+/*! Argument struct for ast_ari_bridges_remove_channel() */
+struct ast_ari_bridges_remove_channel_args {
+       /*! Bridge's id */
        const char *bridge_id;
-       /*! \brief Channel's id */
-       const char *channel;
+       /*! Array of Ids of channels to remove from bridge */
+       const char **channel;
+       /*! Length of channel array. */
+       size_t channel_count;
+       /*! Parsing context for channel. */
+       char *channel_parse;
 };
 /*!
+ * \brief Body parsing function for /bridges/{bridgeId}/removeChannel.
+ * \param body The JSON body from which to parse parameters.
+ * \param[out] args The args structure to parse into.
+ * \retval zero on success
+ * \retval non-zero on failure
+ */
+int ast_ari_bridges_remove_channel_parse_body(
+       struct ast_json *body,
+       struct ast_ari_bridges_remove_channel_args *args);
+
+/*!
  * \brief Remove a channel from a bridge.
  *
  * \param headers HTTP headers
  * \param args Swagger parameters
  * \param[out] response HTTP response
  */
-void ast_ari_remove_channel_from_bridge(struct ast_variable *headers, struct ast_remove_channel_from_bridge_args *args, struct ast_ari_response *response);
-/*! \brief Argument struct for ast_ari_play_on_bridge() */
-struct ast_play_on_bridge_args {
-       /*! \brief Bridge's id */
+void ast_ari_bridges_remove_channel(struct ast_variable *headers, struct ast_ari_bridges_remove_channel_args *args, struct ast_ari_response *response);
+/*! Argument struct for ast_ari_bridges_set_video_source() */
+struct ast_ari_bridges_set_video_source_args {
+       /*! Bridge's id */
+       const char *bridge_id;
+       /*! Channel's id */
+       const char *channel_id;
+};
+/*!
+ * \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.
+ *
+ * \param headers HTTP headers
+ * \param args Swagger parameters
+ * \param[out] response HTTP response
+ */
+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);
+/*! Argument struct for ast_ari_bridges_clear_video_source() */
+struct ast_ari_bridges_clear_video_source_args {
+       /*! Bridge's id */
+       const char *bridge_id;
+};
+/*!
+ * \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.
+ *
+ * \param headers HTTP headers
+ * \param args Swagger parameters
+ * \param[out] response HTTP response
+ */
+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);
+/*! Argument struct for ast_ari_bridges_start_moh() */
+struct ast_ari_bridges_start_moh_args {
+       /*! Bridge's id */
        const char *bridge_id;
-       /*! \brief Media's URI to play. */
-       const char *media;
-       /*! \brief For sounds, selects language for sound. */
+       /*! Channel's id */
+       const char *moh_class;
+};
+/*!
+ * \brief Body parsing function for /bridges/{bridgeId}/moh.
+ * \param body The JSON body from which to parse parameters.
+ * \param[out] args The args structure to parse into.
+ * \retval zero on success
+ * \retval non-zero on failure
+ */
+int ast_ari_bridges_start_moh_parse_body(
+       struct ast_json *body,
+       struct ast_ari_bridges_start_moh_args *args);
+
+/*!
+ * \brief Play music on hold to a bridge or change the MOH class that is playing.
+ *
+ * \param headers HTTP headers
+ * \param args Swagger parameters
+ * \param[out] response HTTP response
+ */
+void ast_ari_bridges_start_moh(struct ast_variable *headers, struct ast_ari_bridges_start_moh_args *args, struct ast_ari_response *response);
+/*! Argument struct for ast_ari_bridges_stop_moh() */
+struct ast_ari_bridges_stop_moh_args {
+       /*! Bridge's id */
+       const char *bridge_id;
+};
+/*!
+ * \brief Stop playing music on hold to a bridge.
+ *
+ * This will only stop music on hold being played via POST bridges/{bridgeId}/moh.
+ *
+ * \param headers HTTP headers
+ * \param args Swagger parameters
+ * \param[out] response HTTP response
+ */
+void ast_ari_bridges_stop_moh(struct ast_variable *headers, struct ast_ari_bridges_stop_moh_args *args, struct ast_ari_response *response);
+/*! Argument struct for ast_ari_bridges_play() */
+struct ast_ari_bridges_play_args {
+       /*! Bridge's id */
+       const char *bridge_id;
+       /*! Array of Media URIs to play. */
+       const char **media;
+       /*! Length of media array. */
+       size_t media_count;
+       /*! Parsing context for media. */
+       char *media_parse;
+       /*! For sounds, selects language for sound. */
+       const char *lang;
+       /*! Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified. */
+       int offsetms;
+       /*! Number of milliseconds to skip for forward/reverse operations. */
+       int skipms;
+       /*! Playback Id. */
+       const char *playback_id;
+};
+/*!
+ * \brief Body parsing function for /bridges/{bridgeId}/play.
+ * \param body The JSON body from which to parse parameters.
+ * \param[out] args The args structure to parse into.
+ * \retval zero on success
+ * \retval non-zero on failure
+ */
+int ast_ari_bridges_play_parse_body(
+       struct ast_json *body,
+       struct ast_ari_bridges_play_args *args);
+
+/*!
+ * \brief Start playback of media on a bridge.
+ *
+ * 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.)
+ *
+ * \param headers HTTP headers
+ * \param args Swagger parameters
+ * \param[out] response HTTP response
+ */
+void ast_ari_bridges_play(struct ast_variable *headers, struct ast_ari_bridges_play_args *args, struct ast_ari_response *response);
+/*! Argument struct for ast_ari_bridges_play_with_id() */
+struct ast_ari_bridges_play_with_id_args {
+       /*! Bridge's id */
+       const char *bridge_id;
+       /*! Playback ID. */
+       const char *playback_id;
+       /*! Array of Media URIs to play. */
+       const char **media;
+       /*! Length of media array. */
+       size_t media_count;
+       /*! Parsing context for media. */
+       char *media_parse;
+       /*! For sounds, selects language for sound. */
        const char *lang;
-       /*! \brief Number of media to skip before playing. */
+       /*! Number of milliseconds to skip before playing. Only applies to the first URI if multiple media URIs are specified. */
        int offsetms;
-       /*! \brief Number of milliseconds to skip for forward/reverse operations. */
+       /*! Number of milliseconds to skip for forward/reverse operations. */
        int skipms;
 };
 /*!
+ * \brief Body parsing function for /bridges/{bridgeId}/play/{playbackId}.
+ * \param body The JSON body from which to parse parameters.
+ * \param[out] args The args structure to parse into.
+ * \retval zero on success
+ * \retval non-zero on failure
+ */
+int ast_ari_bridges_play_with_id_parse_body(
+       struct ast_json *body,
+       struct ast_ari_bridges_play_with_id_args *args);
+
+/*!
  * \brief Start playback of media on a bridge.
  *
- * The media URI may be any of a number of URI's. You may use http: and https: URI's, as well as sound: and recording: URI's. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.)
+ * 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.)
  *
  * \param headers HTTP headers
  * \param args Swagger parameters
  * \param[out] response HTTP response
  */
-void ast_ari_play_on_bridge(struct ast_variable *headers, struct ast_play_on_bridge_args *args, struct ast_ari_response *response);
-/*! \brief Argument struct for ast_ari_record_bridge() */
-struct ast_record_bridge_args {
-       /*! \brief Bridge's id */
+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);
+/*! Argument struct for ast_ari_bridges_record() */
+struct ast_ari_bridges_record_args {
+       /*! Bridge's id */
        const char *bridge_id;
-       /*! \brief Recording's filename */
+       /*! Recording's filename */
        const char *name;
-       /*! \brief Format to encode audio in */
+       /*! Format to encode audio in */
        const char *format;
-       /*! \brief Maximum duration of the recording, in seconds. 0 for no limit. */
+       /*! Maximum duration of the recording, in seconds. 0 for no limit. */
        int max_duration_seconds;
-       /*! \brief Maximum duration of silence, in seconds. 0 for no limit. */
+       /*! Maximum duration of silence, in seconds. 0 for no limit. */
        int max_silence_seconds;
-       /*! \brief Action to take if a recording with the same name already exists. */
+       /*! Action to take if a recording with the same name already exists. */
        const char *if_exists;
-       /*! \brief Play beep when recording begins */
+       /*! Play beep when recording begins */
        int beep;
-       /*! \brief DTMF input to terminate recording. */
+       /*! DTMF input to terminate recording. */
        const char *terminate_on;
 };
 /*!
+ * \brief Body parsing function for /bridges/{bridgeId}/record.
+ * \param body The JSON body from which to parse parameters.
+ * \param[out] args The args structure to parse into.
+ * \retval zero on success
+ * \retval non-zero on failure
+ */
+int ast_ari_bridges_record_parse_body(
+       struct ast_json *body,
+       struct ast_ari_bridges_record_args *args);
+
+/*!
  * \brief Start a recording.
  *
  * This records the mixed audio from all channels participating in this bridge.
@@ -174,6 +392,6 @@ struct ast_record_bridge_args {
  * \param args Swagger parameters
  * \param[out] response HTTP response
  */
-void ast_ari_record_bridge(struct ast_variable *headers, struct ast_record_bridge_args *args, struct ast_ari_response *response);
+void ast_ari_bridges_record(struct ast_variable *headers, struct ast_ari_bridges_record_args *args, struct ast_ari_response *response);
 
 #endif /* _ASTERISK_RESOURCE_BRIDGES_H */