mirror of https://github.com/OpenVidu/openvidu.git
openvidu-browser: TypeDoc files update 2.3.0
pabloFuente
parent
07cea06db6
commit
0f8cae9289
File diff suppressed because one or more lines are too long
|
|
@ -230,12 +230,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -129,7 +129,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the event has a default behaviour that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
<p>Whether the event has a default behavior that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -154,7 +154,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">reason<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/ConnectionEvent.ts#L42">OpenViduInternal/Events/ConnectionEvent.ts:42</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/ConnectionEvent.ts#L45">OpenViduInternal/Events/ConnectionEvent.ts:45</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -162,6 +162,9 @@
|
|||
<p>For 'connectionDestroyed' event:</p>
|
||||
<ul>
|
||||
<li>"disconnect": the remote user has called <code>Session.disconnect()</code></li>
|
||||
<li>"forceDisconnectByUser": the remote user has been evicted from the Session by other user calling <code>Session.forceDisconnect()</code></li>
|
||||
<li>"forceDisconnectByServer": the remote user has been evicted from the Session by the application</li>
|
||||
<li>"sessionClosedByServer": the Session has been closed by the application</li>
|
||||
<li>"networkDisconnect": the remote user network connection has dropped</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
@ -242,7 +245,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Prevents the default behaviour of the event. The following events have a default behaviour:</p>
|
||||
<p>Prevents the default behavior of the event. The following events have a default behavior:</p>
|
||||
</div>
|
||||
<ul>
|
||||
<li><p><code>sessionDisconnected</code>: dispatched by <a href="session.html">Session</a> object, automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
|
|
@ -360,12 +363,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -82,6 +82,9 @@
|
|||
<li>
|
||||
<a href="streamevent.html" class="tsd-signature-type">StreamEvent</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="streampropertychangedevent.html" class="tsd-signature-type">StreamPropertyChangedEvent</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="connectionevent.html" class="tsd-signature-type">ConnectionEvent</a>
|
||||
</li>
|
||||
|
|
@ -116,7 +119,7 @@
|
|||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="event.html#calldefaultbehaviour" class="tsd-kind-icon">call<wbr>Default<wbr>Behaviour</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><a href="event.html#calldefaultbehavior" class="tsd-kind-icon">call<wbr>Default<wbr>Behavior</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="event.html#isdefaultprevented" class="tsd-kind-icon">is<wbr>Default<wbr>Prevented</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="event.html#preventdefault" class="tsd-kind-icon">prevent<wbr>Default</a></li>
|
||||
</ul>
|
||||
|
|
@ -137,7 +140,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the event has a default behaviour that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
<p>Whether the event has a default behavior that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -175,10 +178,10 @@
|
|||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
||||
<a name="calldefaultbehaviour" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagAbstract">Abstract</span> call<wbr>Default<wbr>Behaviour</h3>
|
||||
<a name="calldefaultbehavior" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagProtected">Protected</span> <span class="tsd-flag ts-flagAbstract">Abstract</span> call<wbr>Default<wbr>Behavior</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
||||
<li class="tsd-signature tsd-kind-icon">call<wbr>Default<wbr>Behaviour<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
<li class="tsd-signature tsd-kind-icon">call<wbr>Default<wbr>Behavior<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
|
|
@ -228,7 +231,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Prevents the default behaviour of the event. The following events have a default behaviour:</p>
|
||||
<p>Prevents the default behavior of the event. The following events have a default behavior:</p>
|
||||
</div>
|
||||
<ul>
|
||||
<li><p><code>sessionDisconnected</code>: dispatched by <a href="session.html">Session</a> object, automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
|
|
@ -292,7 +295,7 @@
|
|||
<a href="event.html#type" class="tsd-kind-icon">type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-protected">
|
||||
<a href="event.html#calldefaultbehaviour" class="tsd-kind-icon">call<wbr>Default<wbr>Behaviour</a>
|
||||
<a href="event.html#calldefaultbehavior" class="tsd-kind-icon">call<wbr>Default<wbr>Behavior</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="event.html#isdefaultprevented" class="tsd-kind-icon">is<wbr>Default<wbr>Prevented</a>
|
||||
|
|
@ -343,12 +346,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -496,12 +496,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -122,7 +122,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L70">OpenVidu/OpenVidu.ts:70</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L75">OpenVidu/OpenVidu.ts:75</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <a href="openvidu.html" class="tsd-signature-type">OpenVidu</a></h4>
|
||||
|
|
@ -142,7 +142,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L213">OpenVidu/OpenVidu.ts:213</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L276">OpenVidu/OpenVidu.ts:276</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -165,7 +165,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L330">OpenVidu/OpenVidu.ts:330</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L393">OpenVidu/OpenVidu.ts:393</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -187,7 +187,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L231">OpenVidu/OpenVidu.ts:231</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L294">OpenVidu/OpenVidu.ts:294</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -209,7 +209,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L300">OpenVidu/OpenVidu.ts:300</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L363">OpenVidu/OpenVidu.ts:363</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -278,7 +278,7 @@ OV.getUserMedia({
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L204">OpenVidu/OpenVidu.ts:204</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L267">OpenVidu/OpenVidu.ts:267</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -312,7 +312,7 @@ OV.getUserMedia({
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L86">OpenVidu/OpenVidu.ts:86</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L148">OpenVidu/OpenVidu.ts:148</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -344,7 +344,7 @@ OV.getUserMedia({
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L87">OpenVidu/OpenVidu.ts:87</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L149">OpenVidu/OpenVidu.ts:149</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -379,7 +379,7 @@ OV.getUserMedia({
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L88">OpenVidu/OpenVidu.ts:88</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L150">OpenVidu/OpenVidu.ts:150</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -438,7 +438,7 @@ OV.getUserMedia({
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L89">OpenVidu/OpenVidu.ts:89</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L151">OpenVidu/OpenVidu.ts:151</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -510,7 +510,7 @@ OV.getUserMedia({
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L175">OpenVidu/OpenVidu.ts:175</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L238">OpenVidu/OpenVidu.ts:238</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -532,7 +532,7 @@ OV.getUserMedia({
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L176">OpenVidu/OpenVidu.ts:176</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L239">OpenVidu/OpenVidu.ts:239</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -558,7 +558,7 @@ OV.getUserMedia({
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L80">OpenVidu/OpenVidu.ts:80</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L142">OpenVidu/OpenVidu.ts:142</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -580,7 +580,7 @@ OV.getUserMedia({
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L345">OpenVidu/OpenVidu.ts:345</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/OpenVidu.ts#L408">OpenVidu/OpenVidu.ts:408</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -708,12 +708,18 @@ OV.getUserMedia({
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -104,7 +104,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L106">OpenViduInternal/Enums/OpenViduError.ts:106</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L107">OpenViduInternal/Enums/OpenViduError.ts:107</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -114,7 +114,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <a href="../enums/openviduerrorname.html" class="tsd-signature-type">OpenViduErrorName</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L105">OpenViduInternal/Enums/OpenViduError.ts:105</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L106">OpenViduInternal/Enums/OpenViduError.ts:106</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -199,12 +199,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -103,6 +103,7 @@
|
|||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="publisher.html#accessallowed" class="tsd-kind-icon">access<wbr>Allowed</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="publisher.html#id" class="tsd-kind-icon">id</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="publisher.html#issubscribedtoremote" class="tsd-kind-icon">is<wbr>Subscribed<wbr>ToRemote</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="publisher.html#openvidu" class="tsd-kind-icon">openvidu</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="publisher.html#remote" class="tsd-kind-icon">remote</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="publisher.html#session" class="tsd-kind-icon">session</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="publisher.html#stream" class="tsd-kind-icon">stream</a></li>
|
||||
|
|
@ -134,7 +135,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">access<wbr>Allowed<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L39">OpenVidu/Publisher.ts:39</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L42">OpenVidu/Publisher.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -169,7 +170,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">is<wbr>Subscribed<wbr>ToRemote<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = false</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L44">OpenVidu/Publisher.ts:44</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L47">OpenVidu/Publisher.ts:47</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -178,6 +179,21 @@
|
|||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="openvidu" class="tsd-anchor"></a>
|
||||
<h3>openvidu</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">openvidu<span class="tsd-signature-symbol">:</span> <a href="openvidu.html" class="tsd-signature-type">OpenVidu</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L61">OpenVidu/Publisher.ts:61</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>hidden</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="remote" class="tsd-anchor"></a>
|
||||
<h3>remote</h3>
|
||||
|
|
@ -204,7 +220,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">session<span class="tsd-signature-symbol">:</span> <a href="session.html" class="tsd-signature-type">Session</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L49">OpenVidu/Publisher.ts:49</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L52">OpenVidu/Publisher.ts:52</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -314,7 +330,7 @@
|
|||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="streammanager.html">StreamManager</a>.<a href="streammanager.html#createvideoelement">createVideoElement</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L266">OpenVidu/StreamManager.ts:266</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L264">OpenVidu/StreamManager.ts:264</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -404,7 +420,7 @@
|
|||
<aside class="tsd-sources">
|
||||
<p>Overrides <a href="streammanager.html">StreamManager</a>.<a href="streammanager.html#on">on</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L107">OpenVidu/Publisher.ts:107</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L185">OpenVidu/Publisher.ts:185</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -454,7 +470,7 @@
|
|||
<aside class="tsd-sources">
|
||||
<p>Overrides <a href="streammanager.html">StreamManager</a>.<a href="streammanager.html#once">once</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L144">OpenVidu/Publisher.ts:144</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L222">OpenVidu/Publisher.ts:222</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -503,13 +519,19 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L74">OpenVidu/Publisher.ts:74</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L103">OpenVidu/Publisher.ts:103</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Publish or unpublish the audio stream (if available). Calling this method twice in a row passing same value will have no effect</p>
|
||||
</div>
|
||||
<h4 id="events-dispatched">Events dispatched</h4>
|
||||
<p>The <a href="session.html">Session</a> object of the local participant will dispatch a <code>streamPropertyChanged</code> event with <code>changedProperty</code> set to <code>"audioActive"</code> and <code>reason</code> set to <code>"publishAudio"</code>
|
||||
The <a href="publisher.html">Publisher</a> object of the local participant will also dispatch the exact same event</p>
|
||||
<p>The <a href="session.html">Session</a> object of every other participant connected to the session will dispatch a <code>streamPropertyChanged</code> event with <code>changedProperty</code> set to <code>"audioActive"</code> and <code>reason</code> set to <code>"publishAudio"</code>
|
||||
The respective <a href="subscriber.html">Subscriber</a> object of every other participant receiving this Publisher's stream will also dispatch the exact same event</p>
|
||||
<p>See <a href="streampropertychangedevent.html">StreamPropertyChangedEvent</a> to learn more.</p>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
|
|
@ -534,13 +556,19 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L86">OpenVidu/Publisher.ts:86</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L145">OpenVidu/Publisher.ts:145</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Publish or unpublish the video stream (if available). Calling this method twice in a row passing same value will have no effect</p>
|
||||
</div>
|
||||
<h4 id="events-dispatched">Events dispatched</h4>
|
||||
<p>The <a href="session.html">Session</a> object of the local participant will dispatch a <code>streamPropertyChanged</code> event with <code>changedProperty</code> set to <code>"videoActive"</code> and <code>reason</code> set to <code>"publishVideo"</code>
|
||||
The <a href="publisher.html">Publisher</a> object of the local participant will also dispatch the exact same event</p>
|
||||
<p>The <a href="session.html">Session</a> object of every other participant connected to the session will dispatch a <code>streamPropertyChanged</code> event with <code>changedProperty</code> set to <code>"videoActive"</code> and <code>reason</code> set to <code>"publishVideo"</code>
|
||||
The respective <a href="subscriber.html">Subscriber</a> object of every other participant receiving this Publisher's stream will also dispatch the exact same event</p>
|
||||
<p>See <a href="streampropertychangedevent.html">StreamPropertyChangedEvent</a> to learn more.</p>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
|
|
@ -565,12 +593,12 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L97">OpenVidu/Publisher.ts:97</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Publisher.ts#L175">OpenVidu/Publisher.ts:175</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Call this method before <a href="session.html#publish">Session.publish</a> to subscribe to your Publisher's remote stream instead of using the local stream, as any other user would do.</p>
|
||||
<p>Call this method before <a href="session.html#publish">Session.publish</a> if you prefer to subscribe to your Publisher's remote stream instead of using the local stream, as any other user would do.</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -636,6 +664,9 @@
|
|||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="publisher.html#issubscribedtoremote" class="tsd-kind-icon">is<wbr>Subscribed<wbr>ToRemote</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="publisher.html#openvidu" class="tsd-kind-icon">openvidu</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="publisher.html#remote" class="tsd-kind-icon">remote</a>
|
||||
</li>
|
||||
|
|
@ -706,12 +737,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -136,7 +136,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the event has a default behaviour that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
<p>Whether the event has a default behavior that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -244,7 +244,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Prevents the default behaviour of the event. The following events have a default behaviour:</p>
|
||||
<p>Prevents the default behavior of the event. The following events have a default behavior:</p>
|
||||
</div>
|
||||
<ul>
|
||||
<li><p><code>sessionDisconnected</code>: dispatched by <a href="session.html">Session</a> object, automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
|
|
@ -362,12 +362,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -129,7 +129,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the event has a default behaviour that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
<p>Whether the event has a default behavior that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -162,8 +162,8 @@
|
|||
<p>The recording name you supplied to openvidu-server. For example, to name your recording file MY_RECORDING:</p>
|
||||
<ul>
|
||||
<li>With <strong>API REST</strong>: POST to <code>/api/recordings/start</code> passing JSON body <code>{"session":"sessionId","name":"MY_RECORDING"}</code></li>
|
||||
<li>With <strong>openvidu-java-client</strong>: <code>OpenVidu.startRecording(sessionId, MY_RECORDING)</code> or <code>OpenVidu.startRecording(sessionId, new RecordingProperties.Builder().name(MY_RECORDING).build())</code></li>
|
||||
<li>With <strong>openvidu-node-client</strong>: <code>OpenVidu.startRecording(sessionId, MY_RECORDING)</code> or <code>OpenVidu.startRecording(sessionId, new RecordingProperties.Builder().name(MY_RECORDING).build())</code></li>
|
||||
<li>With <strong>openvidu-java-client</strong>: <code>OpenVidu.startRecording(sessionId, "MY_RECORDING")</code> or <code>OpenVidu.startRecording(sessionId, new RecordingProperties.Builder().name("MY_RECORDING").build())</code></li>
|
||||
<li>With <strong>openvidu-node-client</strong>: <code>OpenVidu.startRecording(sessionId, "MY_RECORDING")</code> or <code>OpenVidu.startRecording(sessionId, {name: "MY_RECORDING"})</code></li>
|
||||
</ul>
|
||||
</div>
|
||||
<p>If no name is supplied, this property will be undefined and the recorded file will be named after property <a href="recordingevent.html#id">id</a></p>
|
||||
|
|
@ -243,7 +243,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Prevents the default behaviour of the event. The following events have a default behaviour:</p>
|
||||
<p>Prevents the default behavior of the event. The following events have a default behavior:</p>
|
||||
</div>
|
||||
<ul>
|
||||
<li><p><code>sessionDisconnected</code>: dispatched by <a href="session.html">Session</a> object, automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
|
|
@ -361,12 +361,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -97,6 +97,7 @@
|
|||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="session.html#capabilities" class="tsd-kind-icon">capabilities</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="session.html#connection" class="tsd-kind-icon">connection</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="session.html#sessionid" class="tsd-kind-icon">session<wbr>Id</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="session.html#streammanagers" class="tsd-kind-icon">stream<wbr>Managers</a></li>
|
||||
|
|
@ -107,6 +108,8 @@
|
|||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="session.html#connect" class="tsd-kind-icon">connect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="session.html#disconnect" class="tsd-kind-icon">disconnect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="session.html#forcedisconnect" class="tsd-kind-icon">force<wbr>Disconnect</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="session.html#forceunpublish" class="tsd-kind-icon">force<wbr>Unpublish</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="session.html#off" class="tsd-kind-icon">off</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="session.html#on" class="tsd-kind-icon">on</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="session.html#once" class="tsd-kind-icon">once</a></li>
|
||||
|
|
@ -123,13 +126,29 @@
|
|||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="capabilities" class="tsd-anchor"></a>
|
||||
<h3>capabilities</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">capabilities<span class="tsd-signature-symbol">:</span> <a href="../interfaces/capabilities.html" class="tsd-signature-type">Capabilities</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L71">OpenVidu/Session.ts:71</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Object defining the methods that the client is able to call. These are defined by the role of the token used to connect to the Session.
|
||||
This object is only defined after <a href="session.html#connect">Session.connect</a> has been successfully resolved</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="connection" class="tsd-anchor"></a>
|
||||
<h3>connection</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">connection<span class="tsd-signature-symbol">:</span> <a href="connection.html" class="tsd-signature-type">Connection</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L53">OpenVidu/Session.ts:53</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L55">OpenVidu/Session.ts:55</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -144,7 +163,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">session<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L58">OpenVidu/Session.ts:58</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L60">OpenVidu/Session.ts:60</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -159,7 +178,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">stream<wbr>Managers<span class="tsd-signature-symbol">:</span> <a href="streammanager.html" class="tsd-signature-type">StreamManager</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol"> = []</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L63">OpenVidu/Session.ts:63</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L65">OpenVidu/Session.ts:65</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -182,7 +201,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L97">OpenVidu/Session.ts:97</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L105">OpenVidu/Session.ts:105</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -218,7 +237,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L98">OpenVidu/Session.ts:98</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L106">OpenVidu/Session.ts:106</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -266,7 +285,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L177">OpenVidu/Session.ts:177</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L185">OpenVidu/Session.ts:185</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -278,18 +297,18 @@
|
|||
This event will automatically unsubscribe the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
and also deletes any HTML video element associated to each Subscriber (only those <a href="/docs/how-do-i/manage-videos/#let-openvidu-take-care-of-the-video-players">created by OpenVidu Browser</a>).
|
||||
For every video removed, each Subscriber object will dispatch a <code>videoElementDestroyed</code> event.
|
||||
Call <code>event.preventDefault()</code> uppon event <code>sessionDisconnected</code> to avoid this behaviour and take care of disposing and cleaning all the Subscriber objects yourself.
|
||||
Call <code>event.preventDefault()</code> upon event <code>sessionDisconnected</code> to avoid this behavior and take care of disposing and cleaning all the Subscriber objects yourself.
|
||||
See <a href="sessiondisconnectedevent.html">SessionDisconnectedEvent</a> and <a href="videoelementevent.html">VideoElementEvent</a> to learn more to learn more.</p>
|
||||
<p>The <a href="publisher.html">Publisher</a> object of the local participant will dispatch a <code>streamDestroyed</code> event if there is a <a href="publisher.html">Publisher</a> object publishing to the session.
|
||||
This event will automatically stop all media tracks and delete any HTML video element associated to it (only those <a href="/docs/how-do-i/manage-videos/#let-openvidu-take-care-of-the-video-players">created by OpenVidu Browser</a>).
|
||||
For every video removed, the Publisher object will dispatch a <code>videoElementDestroyed</code> event.
|
||||
Call <code>event.preventDefault()</code> uppon event <code>streamDestroyed</code> if you want to clean the Publisher object on your own or re-publish it in a different Session (to do so it is a mandatory requirement to call <code>Session.unpublish()</code>
|
||||
Call <code>event.preventDefault()</code> upon event <code>streamDestroyed</code> if you want to clean the Publisher object on your own or re-publish it in a different Session (to do so it is a mandatory requirement to call <code>Session.unpublish()</code>
|
||||
or/and <code>Session.disconnect()</code> in the previous session). See <a href="streamevent.html">StreamEvent</a> and <a href="videoelementevent.html">VideoElementEvent</a> to learn more.</p>
|
||||
<p>The <a href="session.html">Session</a> object of every other participant connected to the session will dispatch a <code>streamDestroyed</code> event if the disconnected participant was publishing.
|
||||
This event will automatically unsubscribe the Subscriber object from the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
and also deletes any HTML video element associated to that Subscriber (only those <a href="/docs/how-do-i/manage-videos/#let-openvidu-take-care-of-the-video-players">created by OpenVidu Browser</a>).
|
||||
For every video removed, the Subscriber object will dispatch a <code>videoElementDestroyed</code> event.
|
||||
Call <code>event.preventDefault()</code> uppon event <code>streamDestroyed</code> to avoid this default behaviour and take care of disposing and cleaning the Subscriber object yourself.
|
||||
Call <code>event.preventDefault()</code> upon event <code>streamDestroyed</code> to avoid this default behavior and take care of disposing and cleaning the Subscriber object yourself.
|
||||
See <a href="streamevent.html">StreamEvent</a> and <a href="videoelementevent.html">VideoElementEvent</a> to learn more.</p>
|
||||
<p>The <a href="session.html">Session</a> object of every other participant connected to the session will dispatch a <code>connectionDestroyed</code> event in any case. See <a href="connectionevent.html">ConnectionEvent</a> to learn more.</p>
|
||||
</div>
|
||||
|
|
@ -297,6 +316,76 @@
|
|||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="forcedisconnect" class="tsd-anchor"></a>
|
||||
<h3>force<wbr>Disconnect</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">force<wbr>Disconnect<span class="tsd-signature-symbol">(</span>connection<span class="tsd-signature-symbol">: </span><a href="connection.html" class="tsd-signature-type">Connection</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L433">OpenVidu/Session.ts:433</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Forces some user to leave the session</p>
|
||||
</div>
|
||||
<h4 id="events-dispatched">Events dispatched</h4>
|
||||
<p>The behavior is the same as when some user calls <a href="session.html#disconnect">Session.disconnect</a>, but <code>reason</code> property in all events will be <code>"forceDisconnectByUser"</code>.</p>
|
||||
<p>The <a href="session.html">Session</a> object of every participant will dispatch a <code>streamDestroyed</code> event if the evicted user was publishing a stream, with property <code>reason</code> set to <code>"forceDisconnectByUser"</code>.
|
||||
The <a href="session.html">Session</a> object of every participant except the evicted one will dispatch a <code>connectionDestroyed</code> event for the evicted user, with property <code>reason</code> set to <code>"forceDisconnectByUser"</code>.</p>
|
||||
<p>If any, the <a href="publisher.html">Publisher</a> object of the evicted participant will also dispatch a <code>streamDestroyed</code> event with property <code>reason</code> set to <code>"forceDisconnectByUser"</code>.
|
||||
The <a href="session.html">Session</a> object of the evicted participant will dispatch a <code>sessionDisconnected</code> event with property <code>reason</code> set to <code>"forceDisconnectByUser"</code>.</p>
|
||||
<p>See <a href="streamevent.html">StreamEvent</a>, <a href="connectionevent.html">ConnectionEvent</a> and <a href="sessiondisconnectedevent.html">SessionDisconnectedEvent</a> to learn more.</p>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>connection: <a href="connection.html" class="tsd-signature-type">Connection</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise (to which you can optionally subscribe to) that is resolved only after the participant has been successfully evicted from the session and rejected with an Error object if not</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="forceunpublish" class="tsd-anchor"></a>
|
||||
<h3>force<wbr>Unpublish</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">force<wbr>Unpublish<span class="tsd-signature-symbol">(</span>stream<span class="tsd-signature-symbol">: </span><a href="stream.html" class="tsd-signature-type">Stream</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L472">OpenVidu/Session.ts:472</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Forces some user to unpublish a Stream</p>
|
||||
</div>
|
||||
<h4 id="events-dispatched">Events dispatched</h4>
|
||||
<p>The behavior is the same as when some user calls <a href="session.html#unpublish">Session.unpublish</a>, but <code>reason</code> property in all events will be <code>"forceUnpublishByUser"</code></p>
|
||||
<p>The <a href="session.html">Session</a> object of every participant will dispatch a <code>streamDestroyed</code> event with property <code>reason</code> set to <code>"forceDisconnectByUser"</code></p>
|
||||
<p>The <a href="publisher.html">Publisher</a> object of the affected participant will also dispatch a <code>streamDestroyed</code> event with property <code>reason</code> set to <code>"forceDisconnectByUser"</code></p>
|
||||
<p>See <a href="streamevent.html">StreamEvent</a> to learn more.</p>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>stream: <a href="stream.html" class="tsd-signature-type">Stream</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise (to which you can optionally subscribe to) that is resolved only after the remote Stream has been successfully unpublished from the session and rejected with an Error object if not</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="off" class="tsd-anchor"></a>
|
||||
<h3>off</h3>
|
||||
|
|
@ -307,7 +396,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L514">OpenVidu/Session.ts:514</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L602">OpenVidu/Session.ts:602</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -356,7 +445,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L456">OpenVidu/Session.ts:456</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L544">OpenVidu/Session.ts:544</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -405,7 +494,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L485">OpenVidu/Session.ts:485</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L573">OpenVidu/Session.ts:573</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -454,7 +543,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L320">OpenVidu/Session.ts:320</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L328">OpenVidu/Session.ts:328</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -487,7 +576,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L420">OpenVidu/Session.ts:420</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L508">OpenVidu/Session.ts:508</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -524,7 +613,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L181">OpenVidu/Session.ts:181</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L189">OpenVidu/Session.ts:189</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -561,7 +650,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L182">OpenVidu/Session.ts:182</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L190">OpenVidu/Session.ts:190</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -601,7 +690,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L183">OpenVidu/Session.ts:183</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L191">OpenVidu/Session.ts:191</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -664,7 +753,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L184">OpenVidu/Session.ts:184</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L192">OpenVidu/Session.ts:192</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -740,7 +829,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L249">OpenVidu/Session.ts:249</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L257">OpenVidu/Session.ts:257</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -762,7 +851,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L250">OpenVidu/Session.ts:250</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L258">OpenVidu/Session.ts:258</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -791,7 +880,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L375">OpenVidu/Session.ts:375</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L383">OpenVidu/Session.ts:383</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -803,12 +892,12 @@
|
|||
This event will automatically stop all media tracks and delete any HTML video element associated to this Publisher
|
||||
(only those videos <a href="/docs/how-do-i/manage-videos/#let-openvidu-take-care-of-the-video-players">created by OpenVidu Browser</a>).
|
||||
For every video removed, the Publisher object will dispatch a <code>videoElementDestroyed</code> event.
|
||||
Call <code>event.preventDefault()</code> uppon event <code>streamDestroyed</code> if you want to clean the Publisher object on your own or re-publish it in a different Session.</p>
|
||||
Call <code>event.preventDefault()</code> upon event <code>streamDestroyed</code> if you want to clean the Publisher object on your own or re-publish it in a different Session.</p>
|
||||
<p>The <a href="session.html">Session</a> object of every other participant connected to the session will dispatch a <code>streamDestroyed</code> event.
|
||||
This event will automatically unsubscribe the Subscriber object from the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks) and
|
||||
delete any HTML video element associated to it (only those <a href="/docs/how-do-i/manage-videos/#let-openvidu-take-care-of-the-video-players">created by OpenVidu Browser</a>).
|
||||
For every video removed, the Subscriber object will dispatch a <code>videoElementDestroyed</code> event.
|
||||
Call <code>event.preventDefault()</code> uppon event <code>streamDestroyed</code> to avoid this default behaviour and take care of disposing and cleaning the Subscriber object on your own.</p>
|
||||
Call <code>event.preventDefault()</code> upon event <code>streamDestroyed</code> to avoid this default behavior and take care of disposing and cleaning the Subscriber object on your own.</p>
|
||||
<p>See <a href="streamevent.html">StreamEvent</a> and <a href="videoelementevent.html">VideoElementEvent</a> to learn more.</p>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -831,7 +920,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L285">OpenVidu/Session.ts:285</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Session.ts#L293">OpenVidu/Session.ts:293</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -906,6 +995,9 @@
|
|||
<li class="current tsd-kind-class">
|
||||
<a href="session.html" class="tsd-kind-icon">Session</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="session.html#capabilities" class="tsd-kind-icon">capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="session.html#connection" class="tsd-kind-icon">connection</a>
|
||||
</li>
|
||||
|
|
@ -921,6 +1013,12 @@
|
|||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="session.html#disconnect" class="tsd-kind-icon">disconnect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="session.html#forcedisconnect" class="tsd-kind-icon">force<wbr>Disconnect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="session.html#forceunpublish" class="tsd-kind-icon">force<wbr>Unpublish</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="session.html#off" class="tsd-kind-icon">off</a>
|
||||
</li>
|
||||
|
|
@ -970,12 +1068,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the event has a default behaviour that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
<p>Whether the event has a default behavior that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -134,13 +134,16 @@
|
|||
<div class="tsd-signature tsd-kind-icon">reason<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/SessionDisconnectedEvent.ts#L31">OpenViduInternal/Events/SessionDisconnectedEvent.ts:31</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/SessionDisconnectedEvent.ts#L34">OpenViduInternal/Events/SessionDisconnectedEvent.ts:34</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<ul>
|
||||
<li>"disconnect": you have called <code>Session.disconnect()</code></li>
|
||||
<li>"forceDisconnectByUser": you have been evicted from the Session by other user calling <code>Session.forceDisconnect()</code></li>
|
||||
<li>"forceDisconnectByServer": you have been evicted from the Session by the application</li>
|
||||
<li>"sessionClosedByServer": the Session has been closed by the application</li>
|
||||
<li>"networkDisconnect": your network connection has dropped</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
@ -220,7 +223,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Prevents the default behaviour of the event. The following events have a default behaviour:</p>
|
||||
<p>Prevents the default behavior of the event. The following events have a default behavior:</p>
|
||||
</div>
|
||||
<ul>
|
||||
<li><p><code>sessionDisconnected</code>: dispatched by <a href="session.html">Session</a> object, automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
|
|
@ -335,12 +338,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -129,7 +129,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the event has a default behaviour that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
<p>Whether the event has a default behavior that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -239,7 +239,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Prevents the default behaviour of the event. The following events have a default behaviour:</p>
|
||||
<p>Prevents the default behavior of the event. The following events have a default behavior:</p>
|
||||
</div>
|
||||
<ul>
|
||||
<li><p><code>sessionDisconnected</code>: dispatched by <a href="session.html">Session</a> object, automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
|
|
@ -357,12 +357,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -91,6 +91,7 @@
|
|||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stream.html#audioactive" class="tsd-kind-icon">audio<wbr>Active</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stream.html#connection" class="tsd-kind-icon">connection</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stream.html#framerate" class="tsd-kind-icon">frame<wbr>Rate</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stream.html#hasaudio" class="tsd-kind-icon">has<wbr>Audio</a></li>
|
||||
|
|
@ -98,6 +99,8 @@
|
|||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stream.html#streamid" class="tsd-kind-icon">stream<wbr>Id</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stream.html#streammanager" class="tsd-kind-icon">stream<wbr>Manager</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stream.html#typeofvideo" class="tsd-kind-icon">type<wbr>OfVideo</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stream.html#videoactive" class="tsd-kind-icon">video<wbr>Active</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="stream.html#videodimensions" class="tsd-kind-icon">video<wbr>Dimensions</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
|
|
@ -105,13 +108,30 @@
|
|||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="audioactive" class="tsd-anchor"></a>
|
||||
<h3>audio<wbr>Active</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">audio<wbr>Active<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L74">OpenVidu/Stream.ts:74</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the stream has the audio track muted or unmuted. If <a href="stream.html#hasaudio">hasAudio</a> is false, this property is undefined</p>
|
||||
</div>
|
||||
<p>This property may change if the Publisher publishing the stream calls <a href="publisher.html#publishaudio">Publisher.publishAudio</a>. Whenever this happens a <a href="streampropertychangedevent.html">StreamPropertyChangedEvent</a> will be dispatched
|
||||
by the Session object as well as by the affected Subscriber/Publisher object</p>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="connection" class="tsd-anchor"></a>
|
||||
<h3>connection</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">connection<span class="tsd-signature-symbol">:</span> <a href="connection.html" class="tsd-signature-type">Connection</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L41">OpenVidu/Stream.ts:41</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L42">OpenVidu/Stream.ts:42</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -126,7 +146,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">frame<wbr>Rate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L47">OpenVidu/Stream.ts:47</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L48">OpenVidu/Stream.ts:48</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -142,7 +162,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">has<wbr>Audio<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L57">OpenVidu/Stream.ts:57</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L58">OpenVidu/Stream.ts:58</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -157,7 +177,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">has<wbr>Video<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L52">OpenVidu/Stream.ts:52</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L53">OpenVidu/Stream.ts:53</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -172,7 +192,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">stream<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L62">OpenVidu/Stream.ts:62</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L79">OpenVidu/Stream.ts:79</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -187,7 +207,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">stream<wbr>Manager<span class="tsd-signature-symbol">:</span> <a href="streammanager.html" class="tsd-signature-type">StreamManager</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L72">OpenVidu/Stream.ts:72</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L90">OpenVidu/Stream.ts:90</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -202,15 +222,65 @@
|
|||
<div class="tsd-signature tsd-kind-icon">type<wbr>OfVideo<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L67">OpenVidu/Stream.ts:67</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L85">OpenVidu/Stream.ts:85</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p><code>"CAMERA"</code> or <code>"SCREEN"</code>. <em>undefined</em> if stream is audio-only</p>
|
||||
<p><code>"CAMERA"</code>, <code>"SCREEN"</code> or <code>"CUSTOM"</code> (the latter when <a href="../interfaces/publisherproperties.html#videosource">PublisherProperties.videoSource</a> is a MediaStreamTrack when calling <a href="openvidu.html#initpublisher">OpenVidu.initPublisher</a>).
|
||||
If <a href="stream.html#hasvideo">hasVideo</a> is false, this property is undefined</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="videoactive" class="tsd-anchor"></a>
|
||||
<h3>video<wbr>Active</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">video<wbr>Active<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L66">OpenVidu/Stream.ts:66</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the stream has the video track muted or unmuted. If <a href="stream.html#hasvideo">hasVideo</a> is false, this property is undefined.</p>
|
||||
</div>
|
||||
<p>This property may change if the Publisher publishing the stream calls <a href="publisher.html#publishvideo">Publisher.publishVideo</a>. Whenever this happens a <a href="streampropertychangedevent.html">StreamPropertyChangedEvent</a> will be dispatched
|
||||
by the Session object as well as by the affected Subscriber/Publisher object</p>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="videodimensions" class="tsd-anchor"></a>
|
||||
<h3>video<wbr>Dimensions</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">video<wbr>Dimensions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/Stream.ts#L101">OpenVidu/Stream.ts:101</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Width and height in pixels of the encoded video stream. If <a href="stream.html#hasvideo">hasVideo</a> is false, this property is undefined</p>
|
||||
</div>
|
||||
<p>This property may change if the Publisher that is publishing:</p>
|
||||
<ul>
|
||||
<li>If it is a mobile device, whenever the user rotates the device.</li>
|
||||
<li>If it is screen-sharing, whenever the user changes the size of the captured window.</li>
|
||||
</ul>
|
||||
<p>Whenever this happens a <a href="streampropertychangedevent.html">StreamPropertyChangedEvent</a> will be dispatched by the Session object as well as by the affected Subscriber/Publisher object</p>
|
||||
</div>
|
||||
<div class="tsd-type-declaration">
|
||||
<h4>Type declaration</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li class="tsd-parameter">
|
||||
<h5>height<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
<li class="tsd-parameter">
|
||||
<h5>width<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span></h5>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
|
|
@ -273,6 +343,9 @@
|
|||
<li class="current tsd-kind-class">
|
||||
<a href="stream.html" class="tsd-kind-icon">Stream</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="stream.html#audioactive" class="tsd-kind-icon">audio<wbr>Active</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="stream.html#connection" class="tsd-kind-icon">connection</a>
|
||||
</li>
|
||||
|
|
@ -294,6 +367,12 @@
|
|||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="stream.html#typeofvideo" class="tsd-kind-icon">type<wbr>OfVideo</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="stream.html#videoactive" class="tsd-kind-icon">video<wbr>Active</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="stream.html#videodimensions" class="tsd-kind-icon">video<wbr>Dimensions</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -307,12 +386,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -129,7 +129,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the event has a default behaviour that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
<p>Whether the event has a default behavior that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -139,7 +139,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">reason<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/StreamEvent.ts#L44">OpenViduInternal/Events/StreamEvent.ts:44</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/StreamEvent.ts#L49">OpenViduInternal/Events/StreamEvent.ts:49</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -148,6 +148,11 @@
|
|||
<ul>
|
||||
<li>"unpublish": method <code>Session.unpublish()</code> has been called</li>
|
||||
<li>"disconnect": method <code>Session.disconnect()</code> has been called</li>
|
||||
<li>"forceUnpublishByUser": some user has called <code>Session.forceUnpublish()</code> over the Stream</li>
|
||||
<li>"forceDisconnectByUser": some user has called <code>Session.forceDisconnect()</code> over the Stream</li>
|
||||
<li>"forceUnpublishByServer": the user's stream has been unpublished from the Session by the application</li>
|
||||
<li>"forceDisconnectByServer": the user has been evicted from the Session by the application</li>
|
||||
<li>"sessionClosedByServer": the Session has been closed by the application</li>
|
||||
<li>"networkDisconnect": the user's network connection has dropped</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
|
@ -243,7 +248,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Prevents the default behaviour of the event. The following events have a default behaviour:</p>
|
||||
<p>Prevents the default behavior of the event. The following events have a default behavior:</p>
|
||||
</div>
|
||||
<ul>
|
||||
<li><p><code>sessionDisconnected</code>: dispatched by <a href="session.html">Session</a> object, automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
|
|
@ -361,12 +366,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -264,7 +264,7 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L266">OpenVidu/StreamManager.ts:266</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L264">OpenVidu/StreamManager.ts:264</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -545,12 +545,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -126,7 +126,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the event has a default behaviour that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
<p>Whether the event has a default behavior that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -204,7 +204,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Prevents the default behaviour of the event. The following events have a default behaviour:</p>
|
||||
<p>Prevents the default behavior of the event. The following events have a default behavior:</p>
|
||||
</div>
|
||||
<ul>
|
||||
<li><p><code>sessionDisconnected</code>: dispatched by <a href="session.html">Session</a> object, automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
|
|
@ -316,12 +316,18 @@
|
|||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,523 @@
|
|||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>StreamPropertyChangedEvent | OpenVidu Browser</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link rel="shortcut icon" href="/img/favicon.ico" type="image/x-icon">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a style="position: absolute" href="/docs/reference-docs/openvidu-browser/" class="title">
|
||||
<img class="logo-small" style="height: 26px; margin-top: 7px" src="/img/logos/openvidu_vert_grey_bg_transp_cropped.png">
|
||||
</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="streampropertychangedevent.html">StreamPropertyChangedEvent</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Class StreamPropertyChangedEvent</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Defines event <code>streamPropertyChanged</code> dispatched by <a href="session.html">Session</a> as well as by <a href="streammanager.html">StreamManager</a> (<a href="publisher.html">Publisher</a> and <a href="subscriber.html">Subscriber</a>).
|
||||
This event is fired when any remote stream (owned by a Subscriber) or local stream (owned by a Publisher) undergoes
|
||||
any change in any of its mutable properties (see <a href="streampropertychangedevent.html#changedproperty">changedProperty</a>).</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<a href="event.html" class="tsd-signature-type">Event</a>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">StreamPropertyChangedEvent</span>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="streampropertychangedevent.html#cancelable" class="tsd-kind-icon">cancelable</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streampropertychangedevent.html#changedproperty" class="tsd-kind-icon">changed<wbr>Property</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streampropertychangedevent.html#newvalue" class="tsd-kind-icon">new<wbr>Value</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streampropertychangedevent.html#oldvalue" class="tsd-kind-icon">old<wbr>Value</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streampropertychangedevent.html#reason" class="tsd-kind-icon">reason</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="streampropertychangedevent.html#stream" class="tsd-kind-icon">stream</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="streampropertychangedevent.html#target" class="tsd-kind-icon">target</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="streampropertychangedevent.html#type" class="tsd-kind-icon">type</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-inherited">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="streampropertychangedevent.html#isdefaultprevented" class="tsd-kind-icon">is<wbr>Default<wbr>Prevented</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="streampropertychangedevent.html#preventdefault" class="tsd-kind-icon">prevent<wbr>Default</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="cancelable" class="tsd-anchor"></a>
|
||||
<h3>cancelable</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">cancelable<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="event.html">Event</a>.<a href="event.html#cancelable">cancelable</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L26">OpenViduInternal/Events/Event.ts:26</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the event has a default behavior that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="changedproperty" class="tsd-anchor"></a>
|
||||
<h3>changed<wbr>Property</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">changed<wbr>Property<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/StreamPropertyChangedEvent.ts#L38">OpenViduInternal/Events/StreamPropertyChangedEvent.ts:38</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The property of the stream that changed. This value is either <code>"videoActive"</code>, <code>"audioActive"</code> or <code>"videoDimensions"</code></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="newvalue" class="tsd-anchor"></a>
|
||||
<h3>new<wbr>Value</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">new<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Object</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/StreamPropertyChangedEvent.ts#L51">OpenViduInternal/Events/StreamPropertyChangedEvent.ts:51</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>New value of the property (after change, current value)</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="oldvalue" class="tsd-anchor"></a>
|
||||
<h3>old<wbr>Value</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">old<wbr>Value<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Object</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/StreamPropertyChangedEvent.ts#L56">OpenViduInternal/Events/StreamPropertyChangedEvent.ts:56</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Previous value of the property (before change)</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="reason" class="tsd-anchor"></a>
|
||||
<h3>reason</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">reason<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/StreamPropertyChangedEvent.ts#L46">OpenViduInternal/Events/StreamPropertyChangedEvent.ts:46</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Cause of the change on the stream's property:</p>
|
||||
<ul>
|
||||
<li>For <code>videoActive</code>: <code>"publishVideo"</code></li>
|
||||
<li>For <code>audioActive</code>: <code>"publishAudio"</code></li>
|
||||
<li>For <code>videoDimensions</code>: <code>"deviceRotated"</code> or <code>"screenResized"</code></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="stream" class="tsd-anchor"></a>
|
||||
<h3>stream</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">stream<span class="tsd-signature-symbol">:</span> <a href="stream.html" class="tsd-signature-type">Stream</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/StreamPropertyChangedEvent.ts#L33">OpenViduInternal/Events/StreamPropertyChangedEvent.ts:33</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The Stream whose property has changed. You can always identify the user publishing the changed stream by consulting property <a href="stream.html#connection">Stream.connection</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="target" class="tsd-anchor"></a>
|
||||
<h3>target</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">target<span class="tsd-signature-symbol">:</span> <a href="session.html" class="tsd-signature-type">Session</a><span class="tsd-signature-symbol"> | </span><a href="streammanager.html" class="tsd-signature-type">StreamManager</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="event.html">Event</a>.<a href="event.html#target">target</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L31">OpenViduInternal/Events/Event.ts:31</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The object that dispatched the event</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="type" class="tsd-anchor"></a>
|
||||
<h3>type</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="event.html">Event</a>.<a href="event.html#type">type</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L36">OpenViduInternal/Events/Event.ts:36</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The type of event. This is the same string you pass as first parameter when calling method <code>on()</code> of any object implementing <a href="../interfaces/eventdispatcher.html">EventDispatcher</a> interface</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="isdefaultprevented" class="tsd-anchor"></a>
|
||||
<h3>is<wbr>Default<wbr>Prevented</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">is<wbr>Default<wbr>Prevented<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">boolean</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="event.html">Event</a>.<a href="event.html#isdefaultprevented">isDefaultPrevented</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L52">OpenViduInternal/Events/Event.ts:52</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the default beahivour of the event has been prevented or not. Call <a href="event.html#preventdefault">Event.preventDefault</a> to prevent it</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a name="preventdefault" class="tsd-anchor"></a>
|
||||
<h3>prevent<wbr>Default</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<li class="tsd-signature tsd-kind-icon">prevent<wbr>Default<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-descriptions">
|
||||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="event.html">Event</a>.<a href="event.html#preventdefault">preventDefault</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Events/Event.ts#L70">OpenViduInternal/Events/Event.ts:70</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Prevents the default behavior of the event. The following events have a default behavior:</p>
|
||||
</div>
|
||||
<ul>
|
||||
<li><p><code>sessionDisconnected</code>: dispatched by <a href="session.html">Session</a> object, automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
and also deletes any HTML video element associated to each Subscriber (only those created by OpenVidu Browser, either by passing a valid parameter as <code>targetElement</code> in method <a href="session.html#subscribe">Session.subscribe</a> or
|
||||
by calling <a href="subscriber.html#createvideoelement">Subscriber.createVideoElement</a>). For every video removed, each Subscriber object will also dispatch a <code>videoElementDestroyed</code> event.</p>
|
||||
</li>
|
||||
<li><p><code>streamDestroyed</code>:</p>
|
||||
<ul>
|
||||
<li>If dispatched by a <a href="publisher.html">Publisher</a> (<em>you</em> have unpublished): automatically stops all media tracks and deletes any HTML video element associated to it (only those created by OpenVidu Browser, either by passing a valid parameter as <code>targetElement</code>
|
||||
in method <a href="openvidu.html#initpublisher">OpenVidu.initPublisher</a> or by calling <a href="publisher.html#createvideoelement">Publisher.createVideoElement</a>). For every video removed, the Publisher object will also dispatch a <code>videoElementDestroyed</code> event.</li>
|
||||
<li>If dispatched by <a href="session.html">Session</a> (<em>other user</em> has unpublished): automatically unsubscribes the proper Subscriber object from the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
and also deletes any HTML video element associated to that Subscriber (only those created by OpenVidu Browser, either by passing a valid parameter as <code>targetElement</code> in method <a href="session.html#subscribe">Session.subscribe</a> or
|
||||
by calling <a href="subscriber.html#createvideoelement">Subscriber.createVideoElement</a>). For every video removed, the Subscriber object will also dispatch a <code>videoElementDestroyed</code> event.</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/localrecorderstate.html" class="tsd-kind-icon">Local<wbr>Recorder<wbr>State</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/openviduerrorname.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/videoinsertmode.html" class="tsd-kind-icon">Video<wbr>Insert<wbr>Mode</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connection.html" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="connectionevent.html" class="tsd-kind-icon">Connection<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="event.html" class="tsd-kind-icon">Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="localrecorder.html" class="tsd-kind-icon">Local<wbr>Recorder</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openvidu.html" class="tsd-kind-icon">Open<wbr>Vidu</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="openviduerror.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisher.html" class="tsd-kind-icon">Publisher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="publisherspeakingevent.html" class="tsd-kind-icon">Publisher<wbr>Speaking<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="recordingevent.html" class="tsd-kind-icon">Recording<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="session.html" class="tsd-kind-icon">Session</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="sessiondisconnectedevent.html" class="tsd-kind-icon">Session<wbr>Disconnected<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="signalevent.html" class="tsd-kind-icon">Signal<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="stream.html" class="tsd-kind-icon">Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streamevent.html" class="tsd-kind-icon">Stream<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streammanager.html" class="tsd-kind-icon">Stream<wbr>Manager</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="streampropertychangedevent.html#cancelable" class="tsd-kind-icon">cancelable</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="streampropertychangedevent.html#changedproperty" class="tsd-kind-icon">changed<wbr>Property</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="streampropertychangedevent.html#newvalue" class="tsd-kind-icon">new<wbr>Value</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="streampropertychangedevent.html#oldvalue" class="tsd-kind-icon">old<wbr>Value</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="streampropertychangedevent.html#reason" class="tsd-kind-icon">reason</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="streampropertychangedevent.html#stream" class="tsd-kind-icon">stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="streampropertychangedevent.html#target" class="tsd-kind-icon">target</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="streampropertychangedevent.html#type" class="tsd-kind-icon">type</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="streampropertychangedevent.html#isdefaultprevented" class="tsd-kind-icon">is<wbr>Default<wbr>Prevented</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
|
||||
<a href="streampropertychangedevent.html#preventdefault" class="tsd-kind-icon">prevent<wbr>Default</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/openviduadvancedconfiguration.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Advanced<wbr>Configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/publisherproperties.html" class="tsd-kind-icon">Publisher<wbr>Properties</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/signaloptions.html" class="tsd-kind-icon">Signal<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/streammanagervideo.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Video</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/subscriberproperties.html" class="tsd-kind-icon">Subscriber<wbr>Properties</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
||||
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
||||
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -265,7 +265,7 @@
|
|||
<aside class="tsd-sources">
|
||||
<p>Inherited from <a href="streammanager.html">StreamManager</a>.<a href="streammanager.html#createvideoelement">createVideoElement</a></p>
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L266">OpenVidu/StreamManager.ts:266</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu/StreamManager.ts#L264">OpenVidu/StreamManager.ts:264</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -575,6 +575,9 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-class">
|
||||
|
|
@ -623,6 +626,9 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -129,7 +129,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Whether the event has a default behaviour that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
<p>Whether the event has a default behavior that may be prevented by calling <a href="event.html#preventdefault">Event.preventDefault</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -222,7 +222,7 @@
|
|||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Prevents the default behaviour of the event. The following events have a default behaviour:</p>
|
||||
<p>Prevents the default behavior of the event. The following events have a default behavior:</p>
|
||||
</div>
|
||||
<ul>
|
||||
<li><p><code>sessionDisconnected</code>: dispatched by <a href="session.html">Session</a> object, automatically unsubscribes the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
|
||||
|
|
@ -313,6 +313,9 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
|
|
@ -343,6 +346,9 @@
|
|||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -212,12 +212,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -113,7 +113,7 @@
|
|||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Browser is not supported by OpenVidu.
|
||||
Returned uppon unsuccessful <a href="../classes/session.html#connect">Session.connect</a></p>
|
||||
Returned upon unsuccessful <a href="../classes/session.html#connect">Session.connect</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -129,7 +129,7 @@
|
|||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The user hasn't granted permissions to the required input device when the browser asked for them.
|
||||
Returned uppon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a> or <a href="../classes/openvidu.html#getusermedia">OpenVidu.getUserMedia</a></p>
|
||||
Returned upon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a> or <a href="../classes/openvidu.html#getusermedia">OpenVidu.getUserMedia</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -139,7 +139,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">GENERIC_<wbr>ERROR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "GENERIC_ERROR"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L97">OpenViduInternal/Enums/OpenViduError.ts:97</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L98">OpenViduInternal/Enums/OpenViduError.ts:98</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -160,7 +160,7 @@
|
|||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>No audio input device found with the provided deviceId (property <a href="../interfaces/publisherproperties.html#audiosource">PublisherProperties.audioSource</a>)
|
||||
Returned uppon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a></p>
|
||||
Returned upon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -176,7 +176,7 @@
|
|||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>No video input device found with the provided deviceId (property <a href="../interfaces/publisherproperties.html#videosource">PublisherProperties.videoSource</a>)
|
||||
Returned uppon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a></p>
|
||||
Returned upon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -202,7 +202,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">OPENVIDU_<wbr>NOT_<wbr>CONNECTED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "OPENVIDU_NOT_CONNECTED"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L92">OpenViduInternal/Enums/OpenViduError.ts:92</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L93">OpenViduInternal/Enums/OpenViduError.ts:93</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -217,12 +217,13 @@
|
|||
<div class="tsd-signature tsd-kind-icon">OPENVIDU_<wbr>PERMISSION_<wbr>DENIED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "OPENVIDU_PERMISSION_DENIED"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L87">OpenViduInternal/Enums/OpenViduError.ts:87</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Enums/OpenViduError.ts#L88">OpenViduInternal/Enums/OpenViduError.ts:88</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p><em>Not in use yet</em></p>
|
||||
<p>The client tried to call a method without the required permissions. This can occur for methods <a href="../classes/session.html#publish">Session.publish</a>,
|
||||
<a href="../classes/session.html#forceunpublish">Session.forceUnpublish</a> and <a href="../classes/session.html#forcedisconnect">Session.forceDisconnect</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -239,7 +240,7 @@
|
|||
<div class="lead">
|
||||
<p>Some media property of <a href="../interfaces/publisherproperties.html">PublisherProperties</a> such as <code>frameRate</code> or <code>resolution</code> is not supported
|
||||
by the input devices (whenever it is possible they are automatically adjusted to the most similar value).
|
||||
Returned uppon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a></p>
|
||||
Returned upon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -255,7 +256,7 @@
|
|||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The user hasn't granted permissions to capture some desktop screen when the browser asked for them.
|
||||
Returned uppon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a> or <a href="../classes/openvidu.html#getusermedia">OpenVidu.getUserMedia</a></p>
|
||||
Returned upon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a> or <a href="../classes/openvidu.html#getusermedia">OpenVidu.getUserMedia</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -271,7 +272,7 @@
|
|||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Only for Chrome, the screen sharing extension is installed but is disabled
|
||||
Returned uppon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a></p>
|
||||
Returned upon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -287,7 +288,7 @@
|
|||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Only for Chrome, there's no screen sharing extension installed
|
||||
Returned uppon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a></p>
|
||||
Returned upon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -303,7 +304,7 @@
|
|||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Browser does not support screen sharing.
|
||||
Returned uppon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a></p>
|
||||
Returned upon unsuccessful <a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -421,12 +422,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -258,12 +258,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="../interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -95,6 +95,7 @@
|
|||
<li class="tsd-kind-class"><a href="classes/streamevent.html" class="tsd-kind-icon">Stream<wbr>Event</a></li>
|
||||
<li class="tsd-kind-class"><a href="classes/streammanager.html" class="tsd-kind-icon">Stream<wbr>Manager</a></li>
|
||||
<li class="tsd-kind-class"><a href="classes/streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a></li>
|
||||
<li class="tsd-kind-class"><a href="classes/streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a></li>
|
||||
<li class="tsd-kind-class"><a href="classes/subscriber.html" class="tsd-kind-icon">Subscriber</a></li>
|
||||
<li class="tsd-kind-class"><a href="classes/videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a></li>
|
||||
</ul>
|
||||
|
|
@ -102,6 +103,7 @@
|
|||
<section class="tsd-index-section ">
|
||||
<h3>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-interface"><a href="interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/device.html" class="tsd-kind-icon">Device</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/openviduadvancedconfiguration.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Advanced<wbr>Configuration</a></li>
|
||||
|
|
@ -182,12 +184,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="classes/streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="classes/streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="classes/subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="classes/videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -0,0 +1,355 @@
|
|||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Capabilities | OpenVidu Browser</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
<link rel="shortcut icon" href="/img/favicon.ico" type="image/x-icon">
|
||||
</head>
|
||||
<body>
|
||||
<header>
|
||||
<div class="tsd-page-toolbar">
|
||||
<div class="container">
|
||||
<div class="table-wrap">
|
||||
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
|
||||
<div class="field">
|
||||
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
||||
<input id="tsd-search-field" type="text" />
|
||||
</div>
|
||||
<ul class="results">
|
||||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a style="position: absolute" href="/docs/reference-docs/openvidu-browser/" class="title">
|
||||
<img class="logo-small" style="height: 26px; margin-top: 7px" src="/img/logos/openvidu_vert_grey_bg_transp_cropped.png">
|
||||
</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
||||
<div class="tsd-filter-group">
|
||||
<div class="tsd-select" id="tsd-filter-visibility">
|
||||
<span class="tsd-select-label">All</span>
|
||||
<ul class="tsd-select-list">
|
||||
<li data-value="public">Public</li>
|
||||
<li data-value="protected">Public/Protected</li>
|
||||
<li data-value="private" class="selected">All</li>
|
||||
</ul>
|
||||
</div>
|
||||
<input type="checkbox" id="tsd-filter-inherited" checked />
|
||||
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
||||
<input type="checkbox" id="tsd-filter-only-exported" />
|
||||
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
|
||||
</div>
|
||||
</div>
|
||||
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div class="tsd-page-title">
|
||||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="capabilities.html">Capabilities</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1>Interface Capabilities</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<section class="tsd-panel tsd-comment">
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>See <a href="../classes/session.html#capabilities">Session.capabilities</a></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-hierarchy">
|
||||
<h3>Hierarchy</h3>
|
||||
<ul class="tsd-hierarchy">
|
||||
<li>
|
||||
<span class="target">Capabilities</span>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-index-group">
|
||||
<h2>Index</h2>
|
||||
<section class="tsd-panel tsd-index-panel">
|
||||
<div class="tsd-index-content">
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="capabilities.html#forcedisconnect" class="tsd-kind-icon">force<wbr>Disconnect</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="capabilities.html#forceunpublish" class="tsd-kind-icon">force<wbr>Unpublish</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="capabilities.html#publish" class="tsd-kind-icon">publish</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="capabilities.html#subscribe" class="tsd-kind-icon">subscribe</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="forcedisconnect" class="tsd-anchor"></a>
|
||||
<h3>force<wbr>Disconnect</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">force<wbr>Disconnect<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/Capabilities.ts#L26">OpenViduInternal/Interfaces/Public/Capabilities.ts:26</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p><code>true</code> if the client can call <a href="../classes/session.html#forcedisconnect">Session.forceDisconnect</a>, <code>false</code> if not</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="forceunpublish" class="tsd-anchor"></a>
|
||||
<h3>force<wbr>Unpublish</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">force<wbr>Unpublish<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/Capabilities.ts#L31">OpenViduInternal/Interfaces/Public/Capabilities.ts:31</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p><code>true</code> if the client can call <a href="../classes/session.html#forceunpublish">Session.forceUnpublish</a>, <code>false</code> if not</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="publish" class="tsd-anchor"></a>
|
||||
<h3>publish</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">publish<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/Capabilities.ts#L36">OpenViduInternal/Interfaces/Public/Capabilities.ts:36</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p><code>true</code> if the client can call <a href="../classes/session.html#publish">Session.publish</a>, <code>false</code> if not</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="subscribe" class="tsd-anchor"></a>
|
||||
<h3>subscribe</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">subscribe<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/Capabilities.ts#L41">OpenViduInternal/Interfaces/Public/Capabilities.ts:41</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p><code>true</code> if the client can call <a href="../classes/session.html#subscribe">Session.subscribe</a>, <code>false</code> if not (true for every user for now)</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
<nav class="tsd-navigation secondary menu-sticky">
|
||||
<ul class="before-current">
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/localrecorderstate.html" class="tsd-kind-icon">Local<wbr>Recorder<wbr>State</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/openviduerrorname.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="../enums/videoinsertmode.html" class="tsd-kind-icon">Video<wbr>Insert<wbr>Mode</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/connection.html" class="tsd-kind-icon">Connection</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/connectionevent.html" class="tsd-kind-icon">Connection<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/event.html" class="tsd-kind-icon">Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/localrecorder.html" class="tsd-kind-icon">Local<wbr>Recorder</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/openvidu.html" class="tsd-kind-icon">Open<wbr>Vidu</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/openviduerror.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Error</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/publisher.html" class="tsd-kind-icon">Publisher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/publisherspeakingevent.html" class="tsd-kind-icon">Publisher<wbr>Speaking<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/recordingevent.html" class="tsd-kind-icon">Recording<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/session.html" class="tsd-kind-icon">Session</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/sessiondisconnectedevent.html" class="tsd-kind-icon">Session<wbr>Disconnected<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/signalevent.html" class="tsd-kind-icon">Signal<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/stream.html" class="tsd-kind-icon">Stream</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streamevent.html" class="tsd-kind-icon">Stream<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streammanager.html" class="tsd-kind-icon">Stream<wbr>Manager</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface">
|
||||
<a href="capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
<ul>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="capabilities.html#forcedisconnect" class="tsd-kind-icon">force<wbr>Disconnect</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="capabilities.html#forceunpublish" class="tsd-kind-icon">force<wbr>Unpublish</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="capabilities.html#publish" class="tsd-kind-icon">publish</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
||||
<a href="capabilities.html#subscribe" class="tsd-kind-icon">subscribe</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="eventdispatcher.html" class="tsd-kind-icon">Event<wbr>Dispatcher</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="openviduadvancedconfiguration.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Advanced<wbr>Configuration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="publisherproperties.html" class="tsd-kind-icon">Publisher<wbr>Properties</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="signaloptions.html" class="tsd-kind-icon">Signal<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="streammanagervideo.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Video</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="subscriberproperties.html" class="tsd-kind-icon">Subscriber<wbr>Properties</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<footer class="with-border-bottom">
|
||||
<div class="container">
|
||||
<h2>Legend</h2>
|
||||
<div class="tsd-legend-group">
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
|
||||
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
|
||||
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
|
||||
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
|
||||
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
|
||||
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
|
||||
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
|
||||
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
||||
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
||||
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
|
||||
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
|
||||
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
|
||||
</ul>
|
||||
<ul class="tsd-legend">
|
||||
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
|
||||
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
<div class="container tsd-generator">
|
||||
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
|
||||
</div>
|
||||
<div class="overlay"></div>
|
||||
<script src="../assets/js/main.js"></script>
|
||||
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -213,12 +213,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
</ul>
|
||||
<ul class="current">
|
||||
<li class="current tsd-kind-interface">
|
||||
|
|
|
|||
|
|
@ -320,12 +320,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -219,12 +219,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -135,13 +135,19 @@
|
|||
<div class="tsd-signature tsd-kind-icon">frame<wbr>Rate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L37">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:37</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L39">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:39</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Desired framerate of the video in frames per second</p>
|
||||
<p>Desired framerate of the video in frames per second.
|
||||
Limiting the framerate has always effect on browsers Chrome and Opera. Firefox requires that the input device explicitly supports the desired framerate.</p>
|
||||
</div>
|
||||
<dl class="tsd-comment-tags">
|
||||
<dt>default</dt>
|
||||
<dd><p>undefined</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
|
|
@ -150,7 +156,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">insert<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../enums/videoinsertmode.html" class="tsd-signature-type">VideoInsertMode</a><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L43">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:43</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L45">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:45</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -170,7 +176,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">mirror<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L49">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:49</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L51">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:51</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -190,7 +196,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">publish<wbr>Audio<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L55">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:55</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L57">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:57</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -210,7 +216,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">publish<wbr>Video<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L61">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:61</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L63">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:63</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -230,7 +236,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">resolution<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L67">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:67</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L69">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:69</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -250,7 +256,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">video<wbr>Source<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">MediaStreamTrack</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">boolean</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L79">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:79</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduInternal/Interfaces/Public/PublisherProperties.ts#L81">OpenViduInternal/Interfaces/Public/PublisherProperties.ts:81</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
|
|
@ -341,12 +347,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -215,12 +215,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -122,13 +122,13 @@
|
|||
<p>How the DOM video element should be inserted with respect to <code>targetElement</code>. This property is defined when:</p>
|
||||
<ul>
|
||||
<li><a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a> or <a href="../classes/session.html#subscribe">Session.subscribe</a> methods have been called passing a valid <code>targetElement</code> parameter.</li>
|
||||
<li>[[SessionManager.createVideoElement]] has been called.</li>
|
||||
<li><a href="../classes/streammanager.html#createvideoelement">StreamManager.createVideoElement</a> has been called.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<p>This property is undefined when:</p>
|
||||
<ul>
|
||||
<li><a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a> or <a href="../classes/session.html#subscribe">Session.subscribe</a> methods have been called passing <em>null</em> or <em>undefined</em> as <code>targetElement</code> parameter.</li>
|
||||
<li>[[SessionManager.addVideoElement]] has been called.</li>
|
||||
<li><a href="../classes/streammanager.html#addvideoelement">StreamManager.addVideoElement</a> has been called.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -146,13 +146,13 @@
|
|||
<p>The DOM HTMLElement assigned as target element when creating a video for the StreamManager. This property is defined when:</p>
|
||||
<ul>
|
||||
<li><a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a> or <a href="../classes/session.html#subscribe">Session.subscribe</a> methods have been called passing a valid <code>targetElement</code> parameter.</li>
|
||||
<li>[[SessionManager.createVideoElement]] has been called.</li>
|
||||
<li><a href="../classes/streammanager.html#createvideoelement">StreamManager.createVideoElement</a> has been called.</li>
|
||||
</ul>
|
||||
</div>
|
||||
<p>This property is undefined when:</p>
|
||||
<ul>
|
||||
<li><a href="../classes/openvidu.html#initpublisher">OpenVidu.initPublisher</a> or <a href="../classes/session.html#subscribe">Session.subscribe</a> methods have been called passing <em>null</em> or <em>undefined</em> as <code>targetElement</code> parameter.</li>
|
||||
<li>[[SessionManager.addVideoElement]] has been called.</li>
|
||||
<li><a href="../classes/streammanager.html#addvideoelement">StreamManager.addVideoElement</a> has been called.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
|
|
@ -240,12 +240,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
|
|
@ -228,12 +228,18 @@
|
|||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streammanagerevent.html" class="tsd-kind-icon">Stream<wbr>Manager<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/streampropertychangedevent.html" class="tsd-kind-icon">Stream<wbr>Property<wbr>Changed<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/subscriber.html" class="tsd-kind-icon">Subscriber</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="../classes/videoelementevent.html" class="tsd-kind-icon">Video<wbr>Element<wbr>Event</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="capabilities.html" class="tsd-kind-icon">Capabilities</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="device.html" class="tsd-kind-icon">Device</a>
|
||||
</li>
|
||||
|
|
|
|||
Loading…
Reference in New Issue