diff options
| author | Matt Jordan <mjordan@digium.com> | 2016-11-08 10:11:41 -0600 |
|---|---|---|
| committer | Matt Jordan <mjordan@digium.com> | 2016-11-14 17:02:00 -0500 |
| commit | d23b4af4779675589c8a3ce39c0f4b80d0432d5c (patch) | |
| tree | bbec0798470850b63070cf5a6464c4f5d85de601 /doc | |
| parent | a58d3597019f8cc5a503f140671232ae3f8d9119 (diff) | |
res/ari/resource_bridges: Add the ability to manipulate the video source
In multi-party bridges, Asterisk currently supports two video modes:
* Follow the talker, in which the speaker with the most energy is shown
to all participants but the speaker, and the speaker sees the
previous video source
* Explicitly set video sources, in which all participants see a locked
video source
Prior to this patch, ARI had no ability to manipulate the video source.
This isn't important for two-party bridges, in which Asterisk merely
relays the video between the participants. However, in a multi-party
bridge, it can be advantageous to allow an external application to
manipulate the video source.
This patch provides two new routes to accomplish this:
(1) setVideoSource: POST /bridges/{bridgeId}/videoSource/{channelId}
Sets a video source to an explicit channel
(2) clearVideoSource: DELETE /bridges/{bridgeId}/videoSource
Removes any explicit video source, and sets the video mode to talk
detection
ASTERISK-26595 #close
Change-Id: I98e455d5bffc08ea5e8d6b84ccaf063c714e6621
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/appdocsxml.xslt | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/appdocsxml.xslt b/doc/appdocsxml.xslt index f067decae..511011ae8 100644 --- a/doc/appdocsxml.xslt +++ b/doc/appdocsxml.xslt @@ -145,5 +145,25 @@ </xsl:attribute> <para>Number of channels in the bridge</para> </xsl:element> + <xsl:element name="parameter"> + <xsl:attribute name="name"> + <xsl:value-of select="concat(@prefix, 'BridgeVideoSourceMode')" /> + </xsl:attribute> + <enumlist> + <enum name="none"/> + <enum name="talker"/> + <enum name="single"/> + </enumlist> + <para>The video source mode for the bridge.</para> + </xsl:element> + <xsl:element name="parameter"> + <xsl:attribute name="required"> + false + </xsl:attribute> + <xsl:attribute name="name"> + <xsl:value-of select="concat(@prefix, 'BridgeVideoSource')" /> + </xsl:attribute> + <para>If there is a video source for the bridge, the unique ID of the channel that is the video source.</para> + </xsl:element> </xsl:template> </xsl:stylesheet> |