mirror of https://github.com/OpenVidu/openvidu.git
openvidu-node-client: TypeDoc. No getters in Recording
pabloFuente
parent
d5b8310c76
commit
20027ab19b
|
|
@ -7,7 +7,7 @@
|
|||
openvidu-node-client
|
||||
===
|
||||
|
||||
- **Description**: Library for your NODE server. It makes easier the retrieval of the necessary params from OpenVidu Server for securing your application (_sessionId_'s and _token_'s). It is a simple alternative to the REST API.
|
||||
- **Description**: Library for your NODE server. It is a fully compatible and simple alternative to the REST API exposed by OpenVidu Server.
|
||||
|
||||
- **Docs**: [openvidu-node-client API](http://openvidu.io/docs/reference-docs/openvidu-node-client/)
|
||||
|
||||
|
|
|
|||
|
|
@ -7,19 +7,15 @@ module.exports = {
|
|||
],
|
||||
mode: "file",
|
||||
module: "commonjs",
|
||||
name: "OpenVidu Browser",
|
||||
name: "OpenVidu Node Client",
|
||||
target: "es5",
|
||||
externalPattern: "node_modules",
|
||||
exclude: [
|
||||
"**/OpenViduInternal/Interfaces/Private/**",
|
||||
"**/OpenViduInternal/WebRtcStats/WebRtcStats.ts",
|
||||
"**/OpenViduInternal/VersionAdapter.ts"
|
||||
],
|
||||
excludeExternals: true,
|
||||
excludePrivate: true,
|
||||
theme: "default",
|
||||
plugin: [
|
||||
"typedoc-plugin-sourcefile-url",
|
||||
],
|
||||
'sourcefile-url-prefix': "https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/"
|
||||
'sourcefile-url-prefix': "https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/",
|
||||
readme: "none"
|
||||
}
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>OpenVidu | OpenVidu Browser</title>
|
||||
<title>OpenVidu | OpenVidu Node Client</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">OpenVidu Browser</a>
|
||||
<a href="../index.html" class="title">OpenVidu Node Client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -51,7 +51,7 @@
|
|||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="openvidu.html">OpenVidu</a>
|
||||
|
|
@ -108,16 +108,28 @@
|
|||
<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.ts#L35">OpenVidu.ts:35</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L35">OpenVidu.ts:35</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>urlOpenViduServer: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Public accessible IP where your instance of OpenVidu Server is up an running</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>secret: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Secret used on OpenVidu Server initialization</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <a href="openvidu.html" class="tsd-signature-type">OpenVidu</a></h4>
|
||||
|
|
@ -137,7 +149,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.ts#L42">OpenVidu.ts:42</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L46">OpenVidu.ts:46</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -160,16 +172,28 @@
|
|||
<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.ts#L240">OpenVidu.ts:240</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L290">OpenVidu.ts:290</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Deletes a <a href="recording.html">Recording</a>. The recording must have status <code>stopped</code> or <code>available</code></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>recordingId: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
</div>
|
||||
</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">Error</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise that is resolved if the Recording was successfully deleted and rejected with an Error object if not. This Error object has as <code>message</code> property with the following values:</p>
|
||||
<ul>
|
||||
<li><code>404</code>: no recording exists for the passed <code>recordingId</code></li>
|
||||
<li><code>409</code>: the recording has <code>started</code> status. Stop it before deletion</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
|
@ -183,16 +207,28 @@
|
|||
<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.ts#L157">OpenVidu.ts:157</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L191">OpenVidu.ts:191</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Gets an existing <a href="recording.html">Recording</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>recordingId: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The <code>id</code> property of the <a href="recording.html">Recording</a> you want to retrieve</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="recording.html" class="tsd-signature-type">Recording</a><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise that is resolved to the <a href="recording.html">Recording</a> if it successfully stopped and rejected with an Error object if not. This Error object has as <code>message</code> property with the following values:</p>
|
||||
<ul>
|
||||
<li><code>404</code>: no recording exists for the passed <code>recordingId</code></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
|
@ -206,10 +242,16 @@
|
|||
<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.ts#L196">OpenVidu.ts:196</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L236">OpenVidu.ts:236</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Lists all existing recordings</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="recording.html" class="tsd-signature-type">Recording</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise that is resolved to an array with all existing recordings</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
|
@ -225,50 +267,103 @@
|
|||
<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.ts#L46">OpenVidu.ts:46</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L50">OpenVidu.ts:50</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Starts the recording of a <a href="session.html">Session</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>sessionId: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The <code>sessionId</code> of the <a href="session.html">Session</a> you want to start recording</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="recording.html" class="tsd-signature-type">Recording</a><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise that is resolved to the <a href="recording.html">Recording</a> if it successfully started and rejected with an Error object if not. This Error object has as <code>message</code> property with the following values:</p>
|
||||
<ul>
|
||||
<li><code>404</code>: no session exists for the passed <code>sessionId</code></li>
|
||||
<li><code>400</code>: the session has no connected participants</li>
|
||||
<li><code>409</code>: the session is not configured for using <a href="../enums/mediamode.html#routed">MediaMode.ROUTED</a> or it is already being recorded</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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.ts#L47">OpenVidu.ts:47</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L51">OpenVidu.ts:51</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Starts the recording of a <a href="session.html">Session</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>sessionId: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The <code>sessionId</code> of the <a href="session.html">Session</a> you want to start recording</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>name: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The name you want to give to the video file. You can access this same value in your clients on recording events (<code>recordingStarted</code>, <code>recordingStopped</code>)</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="recording.html" class="tsd-signature-type">Recording</a><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise that is resolved to the <a href="recording.html">Recording</a> if it successfully started and rejected with an Error object if not. This Error object has as <code>message</code> property with the following values:</p>
|
||||
<ul>
|
||||
<li><code>404</code>: no session exists for the passed <code>sessionId</code></li>
|
||||
<li><code>400</code>: the session has no connected participants</li>
|
||||
<li><code>409</code>: the session is not configured for using <a href="../enums/mediamode.html#routed">MediaMode.ROUTED</a> or it is already being recorded</li>
|
||||
</ul>
|
||||
</li>
|
||||
<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.ts#L48">OpenVidu.ts:48</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L52">OpenVidu.ts:52</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Starts the recording of a <a href="session.html">Session</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>sessionId: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The <code>sessionId</code> of the <a href="session.html">Session</a> you want to start recording</p>
|
||||
</div>
|
||||
</div>
|
||||
</li>
|
||||
<li>
|
||||
<h5>properties: <a href="../interfaces/recordingproperties.html" class="tsd-signature-type">RecordingProperties</a></h5>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="recording.html" class="tsd-signature-type">Recording</a><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise that is resolved to the <a href="recording.html">Recording</a> if it successfully started and rejected with an Error object if not. This Error object has as <code>message</code> property with the following values:</p>
|
||||
<ul>
|
||||
<li><code>404</code>: no session exists for the passed <code>sessionId</code></li>
|
||||
<li><code>400</code>: the session has no connected participants</li>
|
||||
<li><code>409</code>: the session is not configured for using <a href="../enums/mediamode.html#routed">MediaMode.ROUTED</a> or it is already being recorded</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
|
@ -282,16 +377,29 @@
|
|||
<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.ts#L118">OpenVidu.ts:118</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L143">OpenVidu.ts:143</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Stops the recording of a <a href="session.html">Session</a></p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
<h5>recordingId: <span class="tsd-signature-type">string</span></h5>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<p>The <code>id</code> property of the <a href="recording.html">Recording</a> you want to stop</p>
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="recording.html" class="tsd-signature-type">Recording</a><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise that is resolved to the <a href="recording.html">Recording</a> if it successfully stopped and rejected with an Error object if not. This Error object has as <code>message</code> property with the following values:</p>
|
||||
<ul>
|
||||
<li><code>404</code>: no recording exists for the passed <code>recordingId</code></li>
|
||||
<li><code>406</code>: recording has <code>starting</code> status. Wait until <code>started</code> status before stopping the recording</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
|
@ -301,7 +409,7 @@
|
|||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
@ -365,13 +473,13 @@
|
|||
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#https" class="tsd-kind-icon">https</a>
|
||||
<a href="../index.html#https" class="tsd-kind-icon">https</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#require" class="tsd-kind-icon">require</a>
|
||||
<a href="../index.html#require" class="tsd-kind-icon">require</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Recording | OpenVidu Browser</title>
|
||||
<title>Recording | OpenVidu Node Client</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">OpenVidu Browser</a>
|
||||
<a href="../index.html" class="title">OpenVidu Node Client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -51,7 +51,7 @@
|
|||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="recording.html">Recording</a>
|
||||
|
|
@ -89,19 +89,19 @@
|
|||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<h3>Properties</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="recording.html#getcreatedat" class="tsd-kind-icon">get<wbr>Created<wbr>At</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="recording.html#getduration" class="tsd-kind-icon">get<wbr>Duration</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="recording.html#getid" class="tsd-kind-icon">get<wbr>Id</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="recording.html#getlayout" class="tsd-kind-icon">get<wbr>Layout</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="recording.html#getname" class="tsd-kind-icon">get<wbr>Name</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="recording.html#getsessionid" class="tsd-kind-icon">get<wbr>Session<wbr>Id</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="recording.html#getsize" class="tsd-kind-icon">get<wbr>Size</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="recording.html#getstatus" class="tsd-kind-icon">get<wbr>Status</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="recording.html#geturl" class="tsd-kind-icon">get<wbr>Url</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="recording.html#hasaudio" class="tsd-kind-icon">has<wbr>Audio</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="recording.html#hasvideo" class="tsd-kind-icon">has<wbr>Video</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="recording.html#createdat" class="tsd-kind-icon">created<wbr>At</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="recording.html#duration" class="tsd-kind-icon">duration</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="recording.html#hasaudio" class="tsd-kind-icon">has<wbr>Audio</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="recording.html#hasvideo" class="tsd-kind-icon">has<wbr>Video</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="recording.html#id" class="tsd-kind-icon">id</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="recording.html#name" class="tsd-kind-icon">name</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="recording.html#recordinglayout" class="tsd-kind-icon">recording<wbr>Layout</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="recording.html#sessionid" class="tsd-kind-icon">session<wbr>Id</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="recording.html#size" class="tsd-kind-icon">size</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="recording.html#status-1" class="tsd-kind-icon">status</a></li>
|
||||
<li class="tsd-kind-property tsd-parent-kind-class"><a href="recording.html#url" class="tsd-kind-icon">url</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
|
|
@ -119,7 +119,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/Recording.ts#L32">Recording.ts:32</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Recording.ts#L75">Recording.ts:75</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -134,193 +134,171 @@
|
|||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getcreatedat" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Created<wbr>At</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Created<wbr>At<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Recording.ts#L67">Recording.ts:67</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<h2>Properties</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="createdat" class="tsd-anchor"></a>
|
||||
<h3>created<wbr>At</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">created<wbr>At<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-node-client/src/Recording.ts#L35">Recording.ts:35</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Time when the recording started in UTC milliseconds</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getduration" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Duration</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Duration<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Recording.ts#L75">Recording.ts:75</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="duration" class="tsd-anchor"></a>
|
||||
<h3>duration</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Recording.ts#L45">Recording.ts:45</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Duration of the recording in seconds (0 until the recording is stopped)</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getid" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Id</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/Recording.ts#L51">Recording.ts:51</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getlayout" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Layout</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Layout<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/recordinglayout.html" class="tsd-signature-type">RecordingLayout</a></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/Recording.ts#L59">Recording.ts:59</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../enums/recordinglayout.html" class="tsd-signature-type">RecordingLayout</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getname" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Name</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/Recording.ts#L55">Recording.ts:55</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getsessionid" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Session<wbr>Id</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Session<wbr>Id<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/Recording.ts#L63">Recording.ts:63</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getsize" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Size</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Size<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</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/Recording.ts#L71">Recording.ts:71</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getstatus" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Status</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Status<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../enums/recording.status.html" class="tsd-signature-type">Status</a></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/Recording.ts#L47">Recording.ts:47</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../enums/recording.status.html" class="tsd-signature-type">Status</a></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="geturl" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Url</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Url<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</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/Recording.ts#L79">Recording.ts:79</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="hasaudio" class="tsd-anchor"></a>
|
||||
<h3>has<wbr>Audio</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">has<wbr>Audio<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">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/Recording.ts#L83">Recording.ts:83</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="tsd-signature tsd-kind-icon">has<wbr>Audio<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Recording.ts#L55">Recording.ts:55</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p><code>true</code> if the recording has an audio track, <code>false</code> otherwise (currently fixed to true)</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="hasvideo" class="tsd-anchor"></a>
|
||||
<h3>has<wbr>Video</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">has<wbr>Video<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">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/Recording.ts#L87">Recording.ts:87</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
<div class="tsd-signature tsd-kind-icon">has<wbr>Video<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol"> = true</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Recording.ts#L60">Recording.ts:60</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p><code>true</code> if the recording has a video track, <code>false</code> otherwise (currently fixed to true)</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="id" class="tsd-anchor"></a>
|
||||
<h3>id</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">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-node-client/src/Recording.ts#L25">Recording.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Recording unique identifier</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="name" class="tsd-anchor"></a>
|
||||
<h3>name</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">name<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-node-client/src/Recording.ts#L70">Recording.ts:70</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Name of the Recording. The video file will be named after this property</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="recordinglayout" class="tsd-anchor"></a>
|
||||
<h3>recording<wbr>Layout</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">recording<wbr>Layout<span class="tsd-signature-symbol">:</span> <a href="../enums/recordinglayout.html" class="tsd-signature-type">RecordingLayout</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Recording.ts#L75">Recording.ts:75</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The layout used in this Recording</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="sessionid" class="tsd-anchor"></a>
|
||||
<h3>session<wbr>Id</h3>
|
||||
<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-node-client/src/Recording.ts#L30">Recording.ts:30</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Session associated to the recording</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="size" class="tsd-anchor"></a>
|
||||
<h3>size</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">size<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> = 0</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Recording.ts#L40">Recording.ts:40</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Size of the recording in bytes (0 until the recording is stopped)</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="status-1" class="tsd-anchor"></a>
|
||||
<h3>status</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">status<span class="tsd-signature-symbol">:</span> <a href="../enums/recording.status.html" class="tsd-signature-type">Status</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Recording.ts#L65">Recording.ts:65</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Status of the recording</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="url" class="tsd-anchor"></a>
|
||||
<h3>url</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">url<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-node-client/src/Recording.ts#L50">Recording.ts:50</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>URL of the recording. You can access the file from there. It is <code>null</code> until recording is stopped or if OpenVidu Server configuration property <code>openvidu.recording.public-access</code> is false</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
|
|
@ -328,7 +306,7 @@
|
|||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
@ -360,39 +338,39 @@
|
|||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="recording.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="recording.html#getcreatedat" class="tsd-kind-icon">get<wbr>Created<wbr>At</a>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="recording.html#createdat" class="tsd-kind-icon">created<wbr>At</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="recording.html#getduration" class="tsd-kind-icon">get<wbr>Duration</a>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="recording.html#duration" class="tsd-kind-icon">duration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="recording.html#getid" class="tsd-kind-icon">get<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="recording.html#getlayout" class="tsd-kind-icon">get<wbr>Layout</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="recording.html#getname" class="tsd-kind-icon">get<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="recording.html#getsessionid" class="tsd-kind-icon">get<wbr>Session<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="recording.html#getsize" class="tsd-kind-icon">get<wbr>Size</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="recording.html#getstatus" class="tsd-kind-icon">get<wbr>Status</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="recording.html#geturl" class="tsd-kind-icon">get<wbr>Url</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="recording.html#hasaudio" class="tsd-kind-icon">has<wbr>Audio</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="recording.html#hasvideo" class="tsd-kind-icon">has<wbr>Video</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="recording.html#id" class="tsd-kind-icon">id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="recording.html#name" class="tsd-kind-icon">name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="recording.html#recordinglayout" class="tsd-kind-icon">recording<wbr>Layout</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="recording.html#sessionid" class="tsd-kind-icon">session<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="recording.html#size" class="tsd-kind-icon">size</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="recording.html#status-1" class="tsd-kind-icon">status</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="recording.html#url" class="tsd-kind-icon">url</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -410,13 +388,13 @@
|
|||
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#https" class="tsd-kind-icon">https</a>
|
||||
<a href="../index.html#https" class="tsd-kind-icon">https</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#require" class="tsd-kind-icon">require</a>
|
||||
<a href="../index.html#require" class="tsd-kind-icon">require</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Session | OpenVidu Browser</title>
|
||||
<title>Session | OpenVidu Node Client</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">OpenVidu Browser</a>
|
||||
<a href="../index.html" class="title">OpenVidu Node Client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -51,7 +51,7 @@
|
|||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="session.html">Session</a>
|
||||
|
|
@ -82,11 +82,17 @@
|
|||
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="session.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<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#properties" class="tsd-kind-icon">properties</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>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Methods</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="session.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="session.html#getproperties" class="tsd-kind-icon">get<wbr>Properties</a></li>
|
||||
<li class="tsd-kind-method tsd-parent-kind-class"><a href="session.html#getsessionid" class="tsd-kind-icon">get<wbr>Session<wbr>Id</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
|
|
@ -105,7 +111,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/Session.ts#L36">Session.ts:36</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Session.ts#L36">Session.ts:36</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
|
|
@ -128,6 +134,29 @@
|
|||
</ul>
|
||||
</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">
|
||||
<a name="properties" class="tsd-anchor"></a>
|
||||
<h3>properties</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">properties<span class="tsd-signature-symbol">:</span> <a href="../interfaces/sessionproperties.html" class="tsd-signature-type">SessionProperties</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Session.ts#L36">Session.ts:36</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
||||
<a name="sessionid" class="tsd-anchor"></a>
|
||||
<h3>session<wbr>Id</h3>
|
||||
<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-node-client/src/Session.ts#L35">Session.ts:35</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group ">
|
||||
<h2>Methods</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
|
|
@ -140,9 +169,14 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/Session.ts#L98">Session.ts:98</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Session.ts#L110">Session.ts:110</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Gets a new token associated to Session object. This translates into a new request to OpenVidu Server</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-parameters-title">Parameters</h4>
|
||||
<ul class="tsd-parameters">
|
||||
<li>
|
||||
|
|
@ -150,23 +184,7 @@
|
|||
</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">string</span><span class="tsd-signature-symbol">></span></h4>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
||||
<a name="getproperties" class="tsd-anchor"></a>
|
||||
<h3>get<wbr>Properties</h3>
|
||||
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
||||
<li class="tsd-signature tsd-kind-icon">get<wbr>Properties<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/sessionproperties.html" class="tsd-signature-type">SessionProperties</a></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/Session.ts#L144">Session.ts:144</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<h4 class="tsd-returns-title">Returns <a href="../interfaces/sessionproperties.html" class="tsd-signature-type">SessionProperties</a></h4>
|
||||
<p>A Promise that is resolved to the <em>token</em> if success and rejected with an Error object if not (due to a <code>400 (Bad Request)</code> error in OpenVidu Server)</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
|
@ -180,10 +198,17 @@
|
|||
<li class="tsd-description">
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/Session.ts#L46">Session.ts:46</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Session.ts#L52">Session.ts:52</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Gets the unique identifier of the Session. This translates into a new request to OpenVidu Server if this Session has no <code>sessionId</code> yet
|
||||
or simply returns the existing value if it has already been retrieved</p>
|
||||
</div>
|
||||
</div>
|
||||
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></h4>
|
||||
<p>A Promise that is resolved to the <em>sessionId</em> if success and rejected with an Error object if not (due to a <code>400 (Bad Request)</code> error in OpenVidu Server)</p>
|
||||
</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
|
@ -193,7 +218,7 @@
|
|||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
@ -225,11 +250,14 @@
|
|||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="session.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="session.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="session.html#properties" class="tsd-kind-icon">properties</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-method tsd-parent-kind-class">
|
||||
<a href="session.html#getproperties" class="tsd-kind-icon">get<wbr>Properties</a>
|
||||
<a href="session.html#generatetoken" class="tsd-kind-icon">generate<wbr>Token</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="session.html#getsessionid" class="tsd-kind-icon">get<wbr>Session<wbr>Id</a>
|
||||
|
|
@ -248,13 +276,13 @@
|
|||
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#https" class="tsd-kind-icon">https</a>
|
||||
<a href="../index.html#https" class="tsd-kind-icon">https</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#require" class="tsd-kind-icon">require</a>
|
||||
<a href="../index.html#require" class="tsd-kind-icon">require</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>MediaMode | OpenVidu Browser</title>
|
||||
<title>MediaMode | OpenVidu Node Client</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">OpenVidu Browser</a>
|
||||
<a href="../index.html" class="title">OpenVidu Node Client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -51,7 +51,7 @@
|
|||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="mediamode.html">MediaMode</a>
|
||||
|
|
@ -86,9 +86,14 @@
|
|||
<div class="tsd-signature tsd-kind-icon">RELAYED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "RELAYED"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/MediaMode.ts#L19">MediaMode.ts:19</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/MediaMode.ts#L23">MediaMode.ts:23</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p><em>(not available yet)</em> The session will attempt to transmit streams directly between clients</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
|
||||
<a name="routed" class="tsd-anchor"></a>
|
||||
|
|
@ -96,9 +101,14 @@
|
|||
<div class="tsd-signature tsd-kind-icon">ROUTED<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "ROUTED"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/MediaMode.ts#L20">MediaMode.ts:20</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/MediaMode.ts#L28">MediaMode.ts:28</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The session will transmit streams using OpenVidu Media Server</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
|
|
@ -106,7 +116,7 @@
|
|||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
@ -155,13 +165,13 @@
|
|||
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#https" class="tsd-kind-icon">https</a>
|
||||
<a href="../index.html#https" class="tsd-kind-icon">https</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#require" class="tsd-kind-icon">require</a>
|
||||
<a href="../index.html#require" class="tsd-kind-icon">require</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>OpenViduRole | OpenVidu Browser</title>
|
||||
<title>OpenViduRole | OpenVidu Node Client</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">OpenVidu Browser</a>
|
||||
<a href="../index.html" class="title">OpenVidu Node Client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -51,7 +51,7 @@
|
|||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="openvidurole.html">OpenViduRole</a>
|
||||
|
|
@ -87,9 +87,14 @@
|
|||
<div class="tsd-signature tsd-kind-icon">MODERATOR<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "MODERATOR"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduRole.ts#L21">OpenViduRole.ts:21</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenViduRole.ts#L33">OpenViduRole.ts:33</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p><em>(not available yet)</em> SUBSCRIBER + PUBLIHSER permissions + can force <code>unpublish()</code> and <code>disconnect()</code> over a third-party stream or user</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
|
||||
<a name="publisher" class="tsd-anchor"></a>
|
||||
|
|
@ -97,9 +102,14 @@
|
|||
<div class="tsd-signature tsd-kind-icon">PUBLISHER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "PUBLISHER"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduRole.ts#L20">OpenViduRole.ts:20</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenViduRole.ts#L28">OpenViduRole.ts:28</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>SUBSCRIBER permissions + can publish their own streams</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
|
||||
<a name="subscriber" class="tsd-anchor"></a>
|
||||
|
|
@ -107,9 +117,14 @@
|
|||
<div class="tsd-signature tsd-kind-icon">SUBSCRIBER<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "SUBSCRIBER"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenViduRole.ts#L19">OpenViduRole.ts:19</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenViduRole.ts#L23">OpenViduRole.ts:23</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Can subscribe to published streams of other users</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
|
|
@ -117,7 +132,7 @@
|
|||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
@ -169,13 +184,13 @@
|
|||
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#https" class="tsd-kind-icon">https</a>
|
||||
<a href="../index.html#https" class="tsd-kind-icon">https</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#require" class="tsd-kind-icon">require</a>
|
||||
<a href="../index.html#require" class="tsd-kind-icon">require</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>Status | OpenVidu Browser</title>
|
||||
<title>Status | OpenVidu Node Client</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">OpenVidu Browser</a>
|
||||
<a href="../index.html" class="title">OpenVidu Node Client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -51,7 +51,7 @@
|
|||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="../classes/recording.html">Recording</a>
|
||||
|
|
@ -92,7 +92,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">available<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/Recording.ts#L97">Recording.ts:97</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Recording.ts#L99">Recording.ts:99</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -102,7 +102,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">failed<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/Recording.ts#L99">Recording.ts:99</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Recording.ts#L101">Recording.ts:101</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -112,7 +112,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">started<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/Recording.ts#L95">Recording.ts:95</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Recording.ts#L97">Recording.ts:97</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -122,7 +122,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">starting<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/Recording.ts#L94">Recording.ts:94</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Recording.ts#L96">Recording.ts:96</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -132,7 +132,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">stopped<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/Recording.ts#L96">Recording.ts:96</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Recording.ts#L98">Recording.ts:98</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -142,7 +142,7 @@
|
|||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
@ -191,39 +191,39 @@
|
|||
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#constructor" class="tsd-kind-icon">constructor</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#getcreatedat" class="tsd-kind-icon">get<wbr>Created<wbr>At</a>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#createdat" class="tsd-kind-icon">created<wbr>At</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#getduration" class="tsd-kind-icon">get<wbr>Duration</a>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#duration" class="tsd-kind-icon">duration</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#getid" class="tsd-kind-icon">get<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#getlayout" class="tsd-kind-icon">get<wbr>Layout</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#getname" class="tsd-kind-icon">get<wbr>Name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#getsessionid" class="tsd-kind-icon">get<wbr>Session<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#getsize" class="tsd-kind-icon">get<wbr>Size</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#getstatus" class="tsd-kind-icon">get<wbr>Status</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#geturl" class="tsd-kind-icon">get<wbr>Url</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#hasaudio" class="tsd-kind-icon">has<wbr>Audio</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-method tsd-parent-kind-class">
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#hasvideo" class="tsd-kind-icon">has<wbr>Video</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#id" class="tsd-kind-icon">id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#name" class="tsd-kind-icon">name</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#recordinglayout" class="tsd-kind-icon">recording<wbr>Layout</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#sessionid" class="tsd-kind-icon">session<wbr>Id</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#size" class="tsd-kind-icon">size</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#status-1" class="tsd-kind-icon">status</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-property tsd-parent-kind-class">
|
||||
<a href="../classes/recording.html#url" class="tsd-kind-icon">url</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
|
@ -241,13 +241,13 @@
|
|||
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#https" class="tsd-kind-icon">https</a>
|
||||
<a href="../index.html#https" class="tsd-kind-icon">https</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#require" class="tsd-kind-icon">require</a>
|
||||
<a href="../index.html#require" class="tsd-kind-icon">require</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>RecordingLayout | OpenVidu Browser</title>
|
||||
<title>RecordingLayout | OpenVidu Node Client</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">OpenVidu Browser</a>
|
||||
<a href="../index.html" class="title">OpenVidu Node Client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -51,7 +51,7 @@
|
|||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="recordinglayout.html">RecordingLayout</a>
|
||||
|
|
@ -89,9 +89,14 @@
|
|||
<div class="tsd-signature tsd-kind-icon">BEST_<wbr>FIT<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "BEST_FIT"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/RecordingLayout.ts#L19">RecordingLayout.ts:19</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/RecordingLayout.ts#L23">RecordingLayout.ts:23</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>All the videos are evenly distributed, taking up as much space as possible</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
|
||||
<a name="custom" class="tsd-anchor"></a>
|
||||
|
|
@ -99,9 +104,14 @@
|
|||
<div class="tsd-signature tsd-kind-icon">CUSTOM<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "CUSTOM"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/RecordingLayout.ts#L23">RecordingLayout.ts:23</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/RecordingLayout.ts#L43">RecordingLayout.ts:43</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Use your own custom recording layout. See <a href="http://openvidu.io/docs/advanced-features/recording#custom-recording-layouts">Custom recording layouts</a> to learn more</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
|
||||
<a name="horizontal_presentation" class="tsd-anchor"></a>
|
||||
|
|
@ -109,9 +119,14 @@
|
|||
<div class="tsd-signature tsd-kind-icon">HORIZONTAL_<wbr>PRESENTATION<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "VERTICAL_PRESENTATION"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/RecordingLayout.ts#L22">RecordingLayout.ts:22</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/RecordingLayout.ts#L38">RecordingLayout.ts:38</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p><em>(not available yet)</em></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
|
||||
<a name="picture_in_picture" class="tsd-anchor"></a>
|
||||
|
|
@ -119,9 +134,14 @@
|
|||
<div class="tsd-signature tsd-kind-icon">PICTURE_<wbr>IN_<wbr>PICTURE<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "PICTURE_IN_PICTURE"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/RecordingLayout.ts#L20">RecordingLayout.ts:20</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/RecordingLayout.ts#L28">RecordingLayout.ts:28</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p><em>(not available yet)</em></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
|
||||
<a name="vertical_presentation" class="tsd-anchor"></a>
|
||||
|
|
@ -129,9 +149,14 @@
|
|||
<div class="tsd-signature tsd-kind-icon">VERTICAL_<wbr>PRESENTATION<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "VERTICAL_PRESENTATION"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/RecordingLayout.ts#L21">RecordingLayout.ts:21</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/RecordingLayout.ts#L33">RecordingLayout.ts:33</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p><em>(not available yet)</em></p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
|
|
@ -139,7 +164,7 @@
|
|||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
@ -197,13 +222,13 @@
|
|||
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#https" class="tsd-kind-icon">https</a>
|
||||
<a href="../index.html#https" class="tsd-kind-icon">https</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#require" class="tsd-kind-icon">require</a>
|
||||
<a href="../index.html#require" class="tsd-kind-icon">require</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>RecordingMode | OpenVidu Browser</title>
|
||||
<title>RecordingMode | OpenVidu Node Client</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">OpenVidu Browser</a>
|
||||
<a href="../index.html" class="title">OpenVidu Node Client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -51,7 +51,7 @@
|
|||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="recordingmode.html">RecordingMode</a>
|
||||
|
|
@ -86,9 +86,15 @@
|
|||
<div class="tsd-signature tsd-kind-icon">ALWAYS<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "ALWAYS"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/RecordingMode.ts#L19">RecordingMode.ts:19</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/RecordingMode.ts#L24">RecordingMode.ts:24</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The session is recorded automatically as soon as the first client publishes a stream to the session. It is automatically stopped
|
||||
after last user leaves the session (or until you call <a href="../classes/openvidu.html#stoprecording">OpenVidu.stopRecording</a>).</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
|
||||
<a name="manual" class="tsd-anchor"></a>
|
||||
|
|
@ -96,9 +102,15 @@
|
|||
<div class="tsd-signature tsd-kind-icon">MANUAL<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> = "MANUAL"</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/RecordingMode.ts#L20">RecordingMode.ts:20</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/RecordingMode.ts#L30">RecordingMode.ts:30</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The session is not recorded automatically. To record the session, you must call <a href="../classes/openvidu.html#startrecording">OpenVidu.startRecording</a> method. To stop the recording,
|
||||
you must call <a href="../classes/openvidu.html#stoprecording">OpenVidu.stopRecording</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
|
|
@ -106,7 +118,7 @@
|
|||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
@ -155,13 +167,13 @@
|
|||
<a href="../interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#https" class="tsd-kind-icon">https</a>
|
||||
<a href="../index.html#https" class="tsd-kind-icon">https</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#require" class="tsd-kind-icon">require</a>
|
||||
<a href="../index.html#require" class="tsd-kind-icon">require</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
|
|||
|
|
@ -1,260 +0,0 @@
|
|||
<!doctype html>
|
||||
<html class="default no-js">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>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">
|
||||
</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 href="index.html" class="title">OpenVidu Browser</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="globals.html">Globals</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1> OpenVidu Browser</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<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>Enumerations</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-enum"><a href="enums/mediamode.html" class="tsd-kind-icon">Media<wbr>Mode</a></li>
|
||||
<li class="tsd-kind-enum"><a href="enums/openvidurole.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Role</a></li>
|
||||
<li class="tsd-kind-enum"><a href="enums/recordinglayout.html" class="tsd-kind-icon">Recording<wbr>Layout</a></li>
|
||||
<li class="tsd-kind-enum"><a href="enums/recordingmode.html" class="tsd-kind-icon">Recording<wbr>Mode</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Classes</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<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/recording.html" class="tsd-kind-icon">Recording</a></li>
|
||||
<li class="tsd-kind-class"><a href="classes/session.html" class="tsd-kind-icon">Session</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-interface"><a href="interfaces/recordingproperties.html" class="tsd-kind-icon">Recording<wbr>Properties</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/sessionproperties.html" class="tsd-kind-icon">Session<wbr>Properties</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#buffer" class="tsd-kind-icon">Buffer</a></li>
|
||||
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#https" class="tsd-kind-icon">https</a></li>
|
||||
<li class="tsd-kind-variable tsd-is-not-exported"><a href="globals.html#require" class="tsd-kind-icon">require</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="buffer" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> Buffer</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Buffer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/Session.ts#L25">Session.ts:25</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L24">OpenVidu.ts:24</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="https" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagLet">Let</span> https</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">https<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require('https')</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/Session.ts#L28">Session.ts:28</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/OpenVidu.ts#L25">OpenVidu.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="require" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> require</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">require<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/Session.ts#L26">Session.ts:26</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
||||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals current ">
|
||||
<a href="globals.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/mediamode.html" class="tsd-kind-icon">Media<wbr>Mode</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="enums/openvidurole.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Role</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="enums/recordinglayout.html" class="tsd-kind-icon">Recording<wbr>Layout</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-enum">
|
||||
<a href="enums/recordingmode.html" class="tsd-kind-icon">Recording<wbr>Mode</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/recording.html" class="tsd-kind-icon">Recording</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-class">
|
||||
<a href="classes/session.html" class="tsd-kind-icon">Session</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/recordingproperties.html" class="tsd-kind-icon">Recording<wbr>Properties</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/sessionproperties.html" class="tsd-kind-icon">Session<wbr>Properties</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-interface">
|
||||
<a href="interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#https" class="tsd-kind-icon">https</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#require" class="tsd-kind-icon">require</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>
|
||||
</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>
|
||||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>OpenVidu Browser</title>
|
||||
<title>OpenVidu Node Client</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="assets/css/main.css">
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="index.html" class="title">OpenVidu Browser</a>
|
||||
<a href="index.html" class="title">OpenVidu Node Client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -51,37 +51,97 @@
|
|||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="globals.html">Globals</a>
|
||||
<a href="index.html">Globals</a>
|
||||
</li>
|
||||
</ul>
|
||||
<h1> OpenVidu Browser</h1>
|
||||
<h1> OpenVidu Node Client</h1>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
<div class="container container-main">
|
||||
<div class="row">
|
||||
<div class="col-8 col-content">
|
||||
<div class="tsd-panel tsd-typography">
|
||||
<p><a href="http://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/license-Apache2-orange.svg" alt="License badge"></a>
|
||||
<a href="http://openvidu.io/docs/reference-docs/openvidu-node-client/"><img src="https://readthedocs.org/projects/fiware-orion/badge/?version=latest" alt="Documentation badge"></a>
|
||||
<a href="https://groups.google.com/forum/#!forum/openvidu"><img src="https://img.shields.io/badge/support-sof-yellowgreen.svg" alt="Support badge"></a></p>
|
||||
<p><a href="http://openvidu.io"><img src="https://secure.gravatar.com/avatar/5daba1d43042f2e4e85849733c8e5702?s=120" alt=""></a></p>
|
||||
<h1 id="openvidu-node-client">openvidu-node-client</h1>
|
||||
<ul>
|
||||
<li><p><strong>Description</strong>: Library for your NODE server. It makes easier the retrieval of the necessary params from OpenVidu Server for securing your application (<em>sessionId</em>'s and <em>token</em>'s). It is a simple alternative to the REST API.</p>
|
||||
</li>
|
||||
<li><p><strong>Docs</strong>: <a href="http://openvidu.io/docs/reference-docs/openvidu-node-client/">openvidu-node-client API</a></p>
|
||||
</li>
|
||||
<li><p><strong>Release</strong>: <a href="http://openvidu.io/docs/reference-docs/openvidu-artifacts/">OpenVidu Artifacts</a></p>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
<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>Enumerations</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-enum"><a href="enums/mediamode.html" class="tsd-kind-icon">Media<wbr>Mode</a></li>
|
||||
<li class="tsd-kind-enum"><a href="enums/openvidurole.html" class="tsd-kind-icon">Open<wbr>Vidu<wbr>Role</a></li>
|
||||
<li class="tsd-kind-enum"><a href="enums/recordinglayout.html" class="tsd-kind-icon">Recording<wbr>Layout</a></li>
|
||||
<li class="tsd-kind-enum"><a href="enums/recordingmode.html" class="tsd-kind-icon">Recording<wbr>Mode</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Classes</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<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/recording.html" class="tsd-kind-icon">Recording</a></li>
|
||||
<li class="tsd-kind-class"><a href="classes/session.html" class="tsd-kind-icon">Session</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section ">
|
||||
<h3>Interfaces</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-interface"><a href="interfaces/recordingproperties.html" class="tsd-kind-icon">Recording<wbr>Properties</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/sessionproperties.html" class="tsd-kind-icon">Session<wbr>Properties</a></li>
|
||||
<li class="tsd-kind-interface"><a href="interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section class="tsd-index-section tsd-is-not-exported">
|
||||
<h3>Variables</h3>
|
||||
<ul class="tsd-index-list">
|
||||
<li class="tsd-kind-variable tsd-is-not-exported"><a href="index.html#buffer" class="tsd-kind-icon">Buffer</a></li>
|
||||
<li class="tsd-kind-variable tsd-is-not-exported"><a href="index.html#https" class="tsd-kind-icon">https</a></li>
|
||||
<li class="tsd-kind-variable tsd-is-not-exported"><a href="index.html#require" class="tsd-kind-icon">require</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
<section class="tsd-panel-group tsd-member-group tsd-is-not-exported">
|
||||
<h2>Variables</h2>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="buffer" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> Buffer</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">Buffer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Session.ts#L25">Session.ts:25</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L24">OpenVidu.ts:24</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="https" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> https</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">https<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span><span class="tsd-signature-symbol"> = require('https')</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Session.ts#L28">Session.ts:28</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/OpenVidu.ts#L25">OpenVidu.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-variable tsd-is-not-exported">
|
||||
<a name="require" class="tsd-anchor"></a>
|
||||
<h3><span class="tsd-flag ts-flagConst">Const</span> require</h3>
|
||||
<div class="tsd-signature tsd-kind-icon">require<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/Session.ts#L26">Session.ts:26</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</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="globals.html"><em>Globals</em></a>
|
||||
<li class="globals current ">
|
||||
<a href="index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
@ -118,13 +178,13 @@
|
|||
<a href="interfaces/tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
<a href="index.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#https" class="tsd-kind-icon">https</a>
|
||||
<a href="index.html#https" class="tsd-kind-icon">https</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="globals.html#require" class="tsd-kind-icon">require</a>
|
||||
<a href="index.html#require" class="tsd-kind-icon">require</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>RecordingProperties | OpenVidu Browser</title>
|
||||
<title>RecordingProperties | OpenVidu Node Client</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">OpenVidu Browser</a>
|
||||
<a href="../index.html" class="title">OpenVidu Node Client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -51,7 +51,7 @@
|
|||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="recordingproperties.html">RecordingProperties</a>
|
||||
|
|
@ -95,9 +95,15 @@
|
|||
<div class="tsd-signature tsd-kind-icon">custom<wbr>Layout<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/RecordingProperties.ts#L24">RecordingProperties.ts:24</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/RecordingProperties.ts#L36">RecordingProperties.ts:36</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>If <a href="recordingproperties.html#recordinglayout">recordingLayout</a> is <code>CUSTOM</code>, the relative path to the specific custom layout you want to use.
|
||||
See <a href="http://openvidu.io/docs/advanced-features/recording#custom-recording-layouts">Custom recording layouts</a> to learn more</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="name" class="tsd-anchor"></a>
|
||||
|
|
@ -105,9 +111,14 @@
|
|||
<div class="tsd-signature tsd-kind-icon">name<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/RecordingProperties.ts#L22">RecordingProperties.ts:22</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/RecordingProperties.ts#L25">RecordingProperties.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The name you want to give to the video file. You can access this same value in your clients on recording events (<code>recordingStarted</code>, <code>recordingStopped</code>)</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="recordinglayout" class="tsd-anchor"></a>
|
||||
|
|
@ -115,9 +126,14 @@
|
|||
<div class="tsd-signature tsd-kind-icon">recording<wbr>Layout<span class="tsd-signature-symbol">:</span> <a href="../enums/recordinglayout.html" class="tsd-signature-type">RecordingLayout</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/RecordingProperties.ts#L23">RecordingProperties.ts:23</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/RecordingProperties.ts#L30">RecordingProperties.ts:30</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>The layout to be used in the recording</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
</section>
|
||||
</div>
|
||||
|
|
@ -125,7 +141,7 @@
|
|||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
@ -177,13 +193,13 @@
|
|||
<a href="tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#https" class="tsd-kind-icon">https</a>
|
||||
<a href="../index.html#https" class="tsd-kind-icon">https</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#require" class="tsd-kind-icon">require</a>
|
||||
<a href="../index.html#require" class="tsd-kind-icon">require</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>SessionProperties | OpenVidu Browser</title>
|
||||
<title>SessionProperties | OpenVidu Node Client</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">OpenVidu Browser</a>
|
||||
<a href="../index.html" class="title">OpenVidu Node Client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -51,7 +51,7 @@
|
|||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="sessionproperties.html">SessionProperties</a>
|
||||
|
|
@ -96,9 +96,15 @@
|
|||
<div class="tsd-signature tsd-kind-icon">default<wbr>Custom<wbr>Layout<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/SessionProperties.ts#L27">SessionProperties.ts:27</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/SessionProperties.ts#L37">SessionProperties.ts:37</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Default value used to initialize property <a href="recordingproperties.html#customlayout">RecordingProperties.customLayout</a> of every recording of this session.
|
||||
You can easily override this value later by setting <a href="recordingproperties.html#customlayout">RecordingProperties.customLayout</a> to any other value</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="defaultrecordinglayout" class="tsd-anchor"></a>
|
||||
|
|
@ -106,9 +112,15 @@
|
|||
<div class="tsd-signature tsd-kind-icon">default<wbr>Recording<wbr>Layout<span class="tsd-signature-symbol">:</span> <a href="../enums/recordinglayout.html" class="tsd-signature-type">RecordingLayout</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/SessionProperties.ts#L26">SessionProperties.ts:26</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/SessionProperties.ts#L31">SessionProperties.ts:31</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Default value used to initialize property <a href="recordingproperties.html#recordinglayout">RecordingProperties.recordingLayout</a> of every recording of this session.
|
||||
You can easily override this value later by setting <a href="recordingproperties.html#recordinglayout">RecordingProperties.recordingLayout</a> to any other value</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="mediamode" class="tsd-anchor"></a>
|
||||
|
|
@ -116,7 +128,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">media<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../enums/mediamode.html" class="tsd-signature-type">MediaMode</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/SessionProperties.ts#L24">SessionProperties.ts:24</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/SessionProperties.ts#L24">SessionProperties.ts:24</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -126,7 +138,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">recording<wbr>Mode<span class="tsd-signature-symbol">:</span> <a href="../enums/recordingmode.html" class="tsd-signature-type">RecordingMode</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/SessionProperties.ts#L25">SessionProperties.ts:25</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/SessionProperties.ts#L25">SessionProperties.ts:25</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -136,7 +148,7 @@
|
|||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
@ -191,13 +203,13 @@
|
|||
<a href="tokenoptions.html" class="tsd-kind-icon">Token<wbr>Options</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#https" class="tsd-kind-icon">https</a>
|
||||
<a href="../index.html#https" class="tsd-kind-icon">https</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#require" class="tsd-kind-icon">require</a>
|
||||
<a href="../index.html#require" class="tsd-kind-icon">require</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
||||
<title>TokenOptions | OpenVidu Browser</title>
|
||||
<title>TokenOptions | OpenVidu Node Client</title>
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<link rel="stylesheet" href="../assets/css/main.css">
|
||||
|
|
@ -22,7 +22,7 @@
|
|||
<li class="state loading">Preparing search index...</li>
|
||||
<li class="state failure">The search index is not available</li>
|
||||
</ul>
|
||||
<a href="../index.html" class="title">OpenVidu Browser</a>
|
||||
<a href="../index.html" class="title">OpenVidu Node Client</a>
|
||||
</div>
|
||||
<div class="table-cell" id="tsd-widgets">
|
||||
<div id="tsd-filter">
|
||||
|
|
@ -51,7 +51,7 @@
|
|||
<div class="container">
|
||||
<ul class="tsd-breadcrumb">
|
||||
<li>
|
||||
<a href="../globals.html">Globals</a>
|
||||
<a href="../index.html">Globals</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="tokenoptions.html">TokenOptions</a>
|
||||
|
|
@ -94,9 +94,19 @@
|
|||
<div class="tsd-signature tsd-kind-icon">data<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/TokenOptions.ts#L22">TokenOptions.ts:22</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/TokenOptions.ts#L28">TokenOptions.ts:28</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
<div class="tsd-comment tsd-typography">
|
||||
<div class="lead">
|
||||
<p>Secure (server-side) data associated to this token. Every client will receive this data in property <code>Connection.data</code>. Object <code>Connection</code> can be retrieved by subscribing to event <code>connectionCreated</code> of Session object.</p>
|
||||
<ul>
|
||||
<li>If you have provided no data in your clients when calling method <code>Session.connect(TOKEN, DATA)</code> (<code>DATA</code> not defined), then <code>Connection.data</code> will only have this <a href="tokenoptions.html#data">TokenOptions.data</a> property.</li>
|
||||
<li>If you have provided some data when calling <code>Session.connect(TOKEN, DATA)</code> (<code>DATA</code> defined), then <code>Connection.data</code> will have the following structure: <code>"CLIENT_DATA%/%SERVER_DATA"</code>, being <code>CLIENT_DATA</code> the second
|
||||
parameter passed in OpenVidu Browser in method <code>Session.connect</code> and <code>SERVER_DATA</code> this <a href="tokenoptions.html#data">TokenOptions.data</a> property.</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
||||
<a name="role" class="tsd-anchor"></a>
|
||||
|
|
@ -104,7 +114,7 @@
|
|||
<div class="tsd-signature tsd-kind-icon">role<span class="tsd-signature-symbol">:</span> <a href="../enums/openvidurole.html" class="tsd-signature-type">OpenViduRole</a></div>
|
||||
<aside class="tsd-sources">
|
||||
<ul>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-browser/src/TokenOptions.ts#L23">TokenOptions.ts:23</a></li>
|
||||
<li>Defined in <a href="https://github.com/OpenVidu/openvidu/tree/master/openvidu-node-client/src/TokenOptions.ts#L30">TokenOptions.ts:30</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</section>
|
||||
|
|
@ -114,7 +124,7 @@
|
|||
<nav class="tsd-navigation primary">
|
||||
<ul>
|
||||
<li class="globals ">
|
||||
<a href="../globals.html"><em>Globals</em></a>
|
||||
<a href="../index.html"><em>Globals</em></a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
@ -163,13 +173,13 @@
|
|||
</ul>
|
||||
<ul class="after-current">
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
<a href="../index.html#buffer" class="tsd-kind-icon">Buffer</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#https" class="tsd-kind-icon">https</a>
|
||||
<a href="../index.html#https" class="tsd-kind-icon">https</a>
|
||||
</li>
|
||||
<li class=" tsd-kind-variable tsd-is-not-exported">
|
||||
<a href="../globals.html#require" class="tsd-kind-icon">require</a>
|
||||
<a href="../index.html#require" class="tsd-kind-icon">require</a>
|
||||
</li>
|
||||
</ul>
|
||||
</nav>
|
||||
|
|
|
|||
|
|
@ -10,14 +10,49 @@ export declare class OpenVidu {
|
|||
private hostname;
|
||||
private port;
|
||||
private basicAuth;
|
||||
/**
|
||||
* @param urlOpenViduServer Public accessible IP where your instance of OpenVidu Server is up an running
|
||||
* @param secret Secret used on OpenVidu Server initialization
|
||||
*/
|
||||
constructor(urlOpenViduServer: string, secret: string);
|
||||
createSession(properties?: SessionProperties): Session;
|
||||
startRecording(sessionId: string): Promise<Recording>;
|
||||
startRecording(sessionId: string, name: string): Promise<Recording>;
|
||||
startRecording(sessionId: string, properties: RecordingProperties): Promise<Recording>;
|
||||
/**
|
||||
* Stops the recording of a [[Session]]
|
||||
*
|
||||
* @param recordingId The `id` property of the [[Recording]] you want to stop
|
||||
*
|
||||
* @returns A Promise that is resolved to the [[Recording]] if it successfully stopped and rejected with an Error object if not. This Error object has as `message` property with the following values:
|
||||
* - `404`: no recording exists for the passed `recordingId`
|
||||
* - `406`: recording has `starting` status. Wait until `started` status before stopping the recording
|
||||
*/
|
||||
stopRecording(recordingId: string): Promise<Recording>;
|
||||
/**
|
||||
* Gets an existing [[Recording]]
|
||||
*
|
||||
* @param recordingId The `id` property of the [[Recording]] you want to retrieve
|
||||
*
|
||||
* @returns A Promise that is resolved to the [[Recording]] if it successfully stopped and rejected with an Error object if not. This Error object has as `message` property with the following values:
|
||||
* - `404`: no recording exists for the passed `recordingId`
|
||||
*/
|
||||
getRecording(recordingId: string): Promise<Recording>;
|
||||
/**
|
||||
* Lists all existing recordings
|
||||
*
|
||||
* @returns A Promise that is resolved to an array with all existing recordings
|
||||
*/
|
||||
listRecordings(): Promise<Recording[]>;
|
||||
/**
|
||||
* Deletes a [[Recording]]. The recording must have status `stopped` or `available`
|
||||
*
|
||||
* @param recordingId
|
||||
*
|
||||
* @returns A Promise that is resolved if the Recording was successfully deleted and rejected with an Error object if not. This Error object has as `message` property with the following values:
|
||||
* - `404`: no recording exists for the passed `recordingId`
|
||||
* - `409`: the recording has `started` status. Stop it before deletion
|
||||
*/
|
||||
deleteRecording(recordingId: string): Promise<Error>;
|
||||
private getBasicAuth(secret);
|
||||
private setHostnameAndPort();
|
||||
|
|
|
|||
|
|
@ -20,6 +20,10 @@ var Session_1 = require("./Session");
|
|||
var Recording_1 = require("./Recording");
|
||||
var https = require('https');
|
||||
var OpenVidu = /** @class */ (function () {
|
||||
/**
|
||||
* @param urlOpenViduServer Public accessible IP where your instance of OpenVidu Server is up an running
|
||||
* @param secret Secret used on OpenVidu Server initialization
|
||||
*/
|
||||
function OpenVidu(urlOpenViduServer, secret) {
|
||||
this.urlOpenViduServer = urlOpenViduServer;
|
||||
this.setHostnameAndPort();
|
||||
|
|
@ -28,6 +32,17 @@ var OpenVidu = /** @class */ (function () {
|
|||
OpenVidu.prototype.createSession = function (properties) {
|
||||
return new Session_1.Session(this.hostname, this.port, this.basicAuth, properties);
|
||||
};
|
||||
/**
|
||||
* Starts the recording of a [[Session]]
|
||||
*
|
||||
* @param sessionId The `sessionId` of the [[Session]] you want to start recording
|
||||
* @param name The name you want to give to the video file. You can access this same value in your clients on recording events (`recordingStarted`, `recordingStopped`)
|
||||
*
|
||||
* @returns A Promise that is resolved to the [[Recording]] if it successfully started and rejected with an Error object if not. This Error object has as `message` property with the following values:
|
||||
* - `404`: no session exists for the passed `sessionId`
|
||||
* - `400`: the session has no connected participants
|
||||
* - `409`: the session is not configured for using [[MediaMode.ROUTED]] or it is already being recorded
|
||||
*/
|
||||
OpenVidu.prototype.startRecording = function (sessionId, param2) {
|
||||
var _this = this;
|
||||
return new Promise(function (resolve, reject) {
|
||||
|
|
@ -94,6 +109,15 @@ var OpenVidu = /** @class */ (function () {
|
|||
req.end();
|
||||
});
|
||||
};
|
||||
/**
|
||||
* Stops the recording of a [[Session]]
|
||||
*
|
||||
* @param recordingId The `id` property of the [[Recording]] you want to stop
|
||||
*
|
||||
* @returns A Promise that is resolved to the [[Recording]] if it successfully stopped and rejected with an Error object if not. This Error object has as `message` property with the following values:
|
||||
* - `404`: no recording exists for the passed `recordingId`
|
||||
* - `406`: recording has `starting` status. Wait until `started` status before stopping the recording
|
||||
*/
|
||||
OpenVidu.prototype.stopRecording = function (recordingId) {
|
||||
var _this = this;
|
||||
return new Promise(function (resolve, reject) {
|
||||
|
|
@ -131,6 +155,14 @@ var OpenVidu = /** @class */ (function () {
|
|||
req.end();
|
||||
});
|
||||
};
|
||||
/**
|
||||
* Gets an existing [[Recording]]
|
||||
*
|
||||
* @param recordingId The `id` property of the [[Recording]] you want to retrieve
|
||||
*
|
||||
* @returns A Promise that is resolved to the [[Recording]] if it successfully stopped and rejected with an Error object if not. This Error object has as `message` property with the following values:
|
||||
* - `404`: no recording exists for the passed `recordingId`
|
||||
*/
|
||||
OpenVidu.prototype.getRecording = function (recordingId) {
|
||||
var _this = this;
|
||||
return new Promise(function (resolve, reject) {
|
||||
|
|
@ -168,6 +200,11 @@ var OpenVidu = /** @class */ (function () {
|
|||
req.end();
|
||||
});
|
||||
};
|
||||
/**
|
||||
* Lists all existing recordings
|
||||
*
|
||||
* @returns A Promise that is resolved to an array with all existing recordings
|
||||
*/
|
||||
OpenVidu.prototype.listRecordings = function () {
|
||||
var _this = this;
|
||||
return new Promise(function (resolve, reject) {
|
||||
|
|
@ -211,6 +248,15 @@ var OpenVidu = /** @class */ (function () {
|
|||
req.end();
|
||||
});
|
||||
};
|
||||
/**
|
||||
* Deletes a [[Recording]]. The recording must have status `stopped` or `available`
|
||||
*
|
||||
* @param recordingId
|
||||
*
|
||||
* @returns A Promise that is resolved if the Recording was successfully deleted and rejected with an Error object if not. This Error object has as `message` property with the following values:
|
||||
* - `404`: no recording exists for the passed `recordingId`
|
||||
* - `409`: the recording has `started` status. Stop it before deletion
|
||||
*/
|
||||
OpenVidu.prototype.deleteRecording = function (recordingId) {
|
||||
var _this = this;
|
||||
return new Promise(function (resolve, reject) {
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -1,5 +1,14 @@
|
|||
export declare enum OpenViduRole {
|
||||
/**
|
||||
* Can subscribe to published streams of other users
|
||||
*/
|
||||
SUBSCRIBER = "SUBSCRIBER",
|
||||
/**
|
||||
* SUBSCRIBER permissions + can publish their own streams
|
||||
*/
|
||||
PUBLISHER = "PUBLISHER",
|
||||
/**
|
||||
* _(not available yet)_ SUBSCRIBER + PUBLIHSER permissions + can force `unpublish()` and `disconnect()` over a third-party stream or user
|
||||
*/
|
||||
MODERATOR = "MODERATOR",
|
||||
}
|
||||
|
|
|
|||
|
|
@ -18,8 +18,17 @@
|
|||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
var OpenViduRole;
|
||||
(function (OpenViduRole) {
|
||||
/**
|
||||
* Can subscribe to published streams of other users
|
||||
*/
|
||||
OpenViduRole["SUBSCRIBER"] = "SUBSCRIBER";
|
||||
/**
|
||||
* SUBSCRIBER permissions + can publish their own streams
|
||||
*/
|
||||
OpenViduRole["PUBLISHER"] = "PUBLISHER";
|
||||
/**
|
||||
* _(not available yet)_ SUBSCRIBER + PUBLIHSER permissions + can force `unpublish()` and `disconnect()` over a third-party stream or user
|
||||
*/
|
||||
OpenViduRole["MODERATOR"] = "MODERATOR";
|
||||
})(OpenViduRole = exports.OpenViduRole || (exports.OpenViduRole = {}));
|
||||
//# sourceMappingURL=OpenViduRole.js.map
|
||||
|
|
@ -1 +1 @@
|
|||
{"version":3,"file":"OpenViduRole.js","sourceRoot":"","sources":["../src/OpenViduRole.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;AAEH,IAAY,YAIX;AAJD,WAAY,YAAY;IACvB,yCAAyB,CAAA;IACzB,uCAAuB,CAAA;IACvB,uCAAuB,CAAA;AACxB,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB"}
|
||||
{"version":3,"file":"OpenViduRole.js","sourceRoot":"","sources":["../src/OpenViduRole.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;AAEH,IAAY,YAgBX;AAhBD,WAAY,YAAY;IAEvB;;OAEG;IACH,yCAAyB,CAAA;IAEzB;;OAEG;IACH,uCAAuB,CAAA;IAEvB;;OAEG;IACH,uCAAuB,CAAA;AACxB,CAAC,EAhBW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAgBvB"}
|
||||
|
|
@ -6,10 +6,20 @@ export declare class Session {
|
|||
private basicAuth;
|
||||
private static readonly API_SESSIONS;
|
||||
private static readonly API_TOKENS;
|
||||
private sessionId;
|
||||
private properties;
|
||||
sessionId: string;
|
||||
properties: SessionProperties;
|
||||
constructor(hostname: string, port: number, basicAuth: string, properties?: SessionProperties);
|
||||
/**
|
||||
* Gets the unique identifier of the Session. This translates into a new request to OpenVidu Server if this Session has no `sessionId` yet
|
||||
* or simply returns the existing value if it has already been retrieved
|
||||
*
|
||||
* @returns A Promise that is resolved to the _sessionId_ if success and rejected with an Error object if not (due to a `400 (Bad Request)` error in OpenVidu Server)
|
||||
*/
|
||||
getSessionId(): Promise<string>;
|
||||
/**
|
||||
* Gets a new token associated to Session object. This translates into a new request to OpenVidu Server
|
||||
*
|
||||
* @returns A Promise that is resolved to the _token_ if success and rejected with an Error object if not (due to a `400 (Bad Request)` error in OpenVidu Server)
|
||||
*/
|
||||
generateToken(tokenOptions?: TokenOptions): Promise<string>;
|
||||
getProperties(): SessionProperties;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -26,18 +26,23 @@ var Session = /** @class */ (function () {
|
|||
this.hostname = hostname;
|
||||
this.port = port;
|
||||
this.basicAuth = basicAuth;
|
||||
this.sessionId = '';
|
||||
if (properties === null) {
|
||||
if (!properties) {
|
||||
this.properties = {};
|
||||
}
|
||||
else {
|
||||
this.properties = properties;
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Gets the unique identifier of the Session. This translates into a new request to OpenVidu Server if this Session has no `sessionId` yet
|
||||
* or simply returns the existing value if it has already been retrieved
|
||||
*
|
||||
* @returns A Promise that is resolved to the _sessionId_ if success and rejected with an Error object if not (due to a `400 (Bad Request)` error in OpenVidu Server)
|
||||
*/
|
||||
Session.prototype.getSessionId = function () {
|
||||
var _this = this;
|
||||
return new Promise(function (resolve, reject) {
|
||||
if (_this.sessionId) {
|
||||
if (!!_this.sessionId) {
|
||||
resolve(_this.sessionId);
|
||||
}
|
||||
var requestBody = JSON.stringify({
|
||||
|
|
@ -83,6 +88,11 @@ var Session = /** @class */ (function () {
|
|||
req.end();
|
||||
});
|
||||
};
|
||||
/**
|
||||
* Gets a new token associated to Session object. This translates into a new request to OpenVidu Server
|
||||
*
|
||||
* @returns A Promise that is resolved to the _token_ if success and rejected with an Error object if not (due to a `400 (Bad Request)` error in OpenVidu Server)
|
||||
*/
|
||||
Session.prototype.generateToken = function (tokenOptions) {
|
||||
var _this = this;
|
||||
return new Promise(function (resolve, reject) {
|
||||
|
|
@ -127,9 +137,6 @@ var Session = /** @class */ (function () {
|
|||
req.end();
|
||||
});
|
||||
};
|
||||
Session.prototype.getProperties = function () {
|
||||
return this.properties;
|
||||
};
|
||||
Session.API_SESSIONS = '/api/sessions';
|
||||
Session.API_TOKENS = '/api/tokens';
|
||||
return Session;
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
{"version":3,"file":"Session.js","sourceRoot":"","sources":["../src/Session.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;AAEH,yCAAwC;AACxC,+CAA8C;AAC9C,qDAAoD;AACpD,iDAAgD;AAOhD,IAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAE/B;IAQI,iBAAoB,QAAgB,EAAU,IAAY,EAAU,SAAiB,EAAE,UAA8B;QAAjG,aAAQ,GAAR,QAAQ,CAAQ;QAAU,SAAI,GAAJ,IAAI,CAAQ;QAAU,cAAS,GAAT,SAAS,CAAQ;QAH7E,cAAS,GAAG,EAAE,CAAC;QAInB,EAAE,CAAC,CAAC,UAAU,KAAK,IAAI,CAAC,CAAC,CAAC;YACtB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACzB,CAAC;QAAC,IAAI,CAAC,CAAC;YACJ,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QACjC,CAAC;IACL,CAAC;IAEM,8BAAY,GAAnB;QAAA,iBAmDC;QAlDG,MAAM,CAAC,IAAI,OAAO,CAAS,UAAC,OAAO,EAAE,MAAM;YAEvC,EAAE,CAAC,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC,CAAC;gBACjB,OAAO,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC;YAC5B,CAAC;YAED,IAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC;gBAC/B,SAAS,EAAE,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,qBAAS,CAAC,MAAM;gBACrF,aAAa,EAAE,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,6BAAa,CAAC,MAAM;gBACrG,sBAAsB,EAAE,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,iCAAe,CAAC,QAAQ;gBACpI,mBAAmB,EAAE,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE;aACxG,CAAC,CAAC;YAEH,IAAM,OAAO,GAAG;gBACZ,QAAQ,EAAE,KAAI,CAAC,QAAQ;gBACvB,IAAI,EAAE,KAAI,CAAC,IAAI;gBACf,IAAI,EAAE,OAAO,CAAC,YAAY;gBAC1B,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACL,eAAe,EAAE,KAAI,CAAC,SAAS;oBAC/B,cAAc,EAAE,kBAAkB;oBAClC,gBAAgB,EAAE,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC;iBACnD;aACJ,CAAC;YAEF,IAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,UAAC,GAAG;gBACnC,IAAI,IAAI,GAAG,EAAE,CAAC;gBACd,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,UAAC,CAAC;oBACb,uCAAuC;oBACvC,IAAI,IAAI,CAAC,CAAC;gBACd,CAAC,CAAC,CAAC;gBACH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE;oBACV,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,KAAK,GAAG,CAAC,CAAC,CAAC;wBACzB,2DAA2D;wBAC3D,IAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBAChC,KAAI,CAAC,SAAS,GAAG,MAAM,CAAC,EAAE,CAAC;wBAC3B,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBACvB,CAAC;oBAAC,IAAI,CAAC,CAAC;wBACJ,2DAA2D;wBAC3D,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;oBACtC,CAAC;gBACL,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YAEH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,UAAC,CAAC;gBACd,MAAM,CAAC,CAAC,CAAC,CAAC;YACd,CAAC,CAAC,CAAC;YACH,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACvB,GAAG,CAAC,GAAG,EAAE,CAAC;QACd,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,+BAAa,GAApB,UAAqB,YAA2B;QAAhD,iBA6CC;QA5CG,MAAM,CAAC,IAAI,OAAO,CAAS,UAAC,OAAO,EAAE,MAAM;YAEvC,IAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC;gBAC/B,OAAO,EAAE,KAAI,CAAC,SAAS;gBACvB,IAAI,EAAE,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,2BAAY,CAAC,SAAS;gBACtE,IAAI,EAAE,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;aACrD,CAAC,CAAC;YAEH,IAAM,OAAO,GAAG;gBACZ,QAAQ,EAAE,KAAI,CAAC,QAAQ;gBACvB,IAAI,EAAE,KAAI,CAAC,IAAI;gBACf,IAAI,EAAE,OAAO,CAAC,UAAU;gBACxB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACL,eAAe,EAAE,KAAI,CAAC,SAAS;oBAC/B,cAAc,EAAE,kBAAkB;oBAClC,gBAAgB,EAAE,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC;iBACnD;aACJ,CAAC;YAEF,IAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,UAAC,GAAG;gBACnC,IAAI,IAAI,GAAG,EAAE,CAAC;gBACd,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,UAAC,CAAC;oBACb,uCAAuC;oBACvC,IAAI,IAAI,CAAC,CAAC;gBACd,CAAC,CAAC,CAAC;gBACH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE;oBACV,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,KAAK,GAAG,CAAC,CAAC,CAAC;wBACzB,uDAAuD;wBACvD,IAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBAChC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBACvB,CAAC;oBAAC,IAAI,CAAC,CAAC;wBACJ,2DAA2D;wBAC3D,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;oBACtC,CAAC;gBACL,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YAEH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,UAAC,CAAC;gBACd,MAAM,CAAC,CAAC,CAAC,CAAC;YACd,CAAC,CAAC,CAAC;YACH,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACvB,GAAG,CAAC,GAAG,EAAE,CAAC;QACd,CAAC,CAAC,CAAC;IACP,CAAC;IAEM,+BAAa,GAApB;QACI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;IAC3B,CAAC;IApHuB,oBAAY,GAAG,eAAe,CAAC;IAC/B,kBAAU,GAAG,aAAa,CAAC;IAqHvD,cAAC;CAAA,AAxHD,IAwHC;AAxHY,0BAAO"}
|
||||
{"version":3,"file":"Session.js","sourceRoot":"","sources":["../src/Session.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;AAEH,yCAAwC;AACxC,+CAA8C;AAC9C,qDAAoD;AACpD,iDAAgD;AAOhD,IAAM,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;AAE/B;IAQI,iBAAoB,QAAgB,EAAU,IAAY,EAAU,SAAiB,EAAE,UAA8B;QAAjG,aAAQ,GAAR,QAAQ,CAAQ;QAAU,SAAI,GAAJ,IAAI,CAAQ;QAAU,cAAS,GAAT,SAAS,CAAQ;QACjF,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;YACd,IAAI,CAAC,UAAU,GAAG,EAAE,CAAC;QACzB,CAAC;QAAC,IAAI,CAAC,CAAC;YACJ,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QACjC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACI,8BAAY,GAAnB;QAAA,iBAmDC;QAlDG,MAAM,CAAC,IAAI,OAAO,CAAS,UAAC,OAAO,EAAE,MAAM;YAEvC,EAAE,CAAC,CAAC,CAAC,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC,CAAC;gBACnB,OAAO,CAAC,KAAI,CAAC,SAAS,CAAC,CAAC;YAC5B,CAAC;YAED,IAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC;gBAC/B,SAAS,EAAE,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,qBAAS,CAAC,MAAM;gBACrF,aAAa,EAAE,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,6BAAa,CAAC,MAAM;gBACrG,sBAAsB,EAAE,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC,iCAAe,CAAC,QAAQ;gBACpI,mBAAmB,EAAE,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,KAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC,CAAC,CAAC,EAAE;aACxG,CAAC,CAAC;YAEH,IAAM,OAAO,GAAG;gBACZ,QAAQ,EAAE,KAAI,CAAC,QAAQ;gBACvB,IAAI,EAAE,KAAI,CAAC,IAAI;gBACf,IAAI,EAAE,OAAO,CAAC,YAAY;gBAC1B,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACL,eAAe,EAAE,KAAI,CAAC,SAAS;oBAC/B,cAAc,EAAE,kBAAkB;oBAClC,gBAAgB,EAAE,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC;iBACnD;aACJ,CAAC;YAEF,IAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,UAAC,GAAG;gBACnC,IAAI,IAAI,GAAG,EAAE,CAAC;gBACd,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,UAAC,CAAC;oBACb,uCAAuC;oBACvC,IAAI,IAAI,CAAC,CAAC;gBACd,CAAC,CAAC,CAAC;gBACH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE;oBACV,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,KAAK,GAAG,CAAC,CAAC,CAAC;wBACzB,2DAA2D;wBAC3D,IAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBAChC,KAAI,CAAC,SAAS,GAAG,MAAM,CAAC,EAAE,CAAC;wBAC3B,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBACvB,CAAC;oBAAC,IAAI,CAAC,CAAC;wBACJ,2DAA2D;wBAC3D,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;oBACtC,CAAC;gBACL,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YAEH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,UAAC,CAAC;gBACd,MAAM,CAAC,CAAC,CAAC,CAAC;YACd,CAAC,CAAC,CAAC;YACH,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACvB,GAAG,CAAC,GAAG,EAAE,CAAC;QACd,CAAC,CAAC,CAAC;IACP,CAAC;IAED;;;;OAIG;IACI,+BAAa,GAApB,UAAqB,YAA2B;QAAhD,iBA6CC;QA5CG,MAAM,CAAC,IAAI,OAAO,CAAS,UAAC,OAAO,EAAE,MAAM;YAEvC,IAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC;gBAC/B,OAAO,EAAE,KAAI,CAAC,SAAS;gBACvB,IAAI,EAAE,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,2BAAY,CAAC,SAAS;gBACtE,IAAI,EAAE,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE;aACrD,CAAC,CAAC;YAEH,IAAM,OAAO,GAAG;gBACZ,QAAQ,EAAE,KAAI,CAAC,QAAQ;gBACvB,IAAI,EAAE,KAAI,CAAC,IAAI;gBACf,IAAI,EAAE,OAAO,CAAC,UAAU;gBACxB,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACL,eAAe,EAAE,KAAI,CAAC,SAAS;oBAC/B,cAAc,EAAE,kBAAkB;oBAClC,gBAAgB,EAAE,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC;iBACnD;aACJ,CAAC;YAEF,IAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,UAAC,GAAG;gBACnC,IAAI,IAAI,GAAG,EAAE,CAAC;gBACd,GAAG,CAAC,EAAE,CAAC,MAAM,EAAE,UAAC,CAAC;oBACb,uCAAuC;oBACvC,IAAI,IAAI,CAAC,CAAC;gBACd,CAAC,CAAC,CAAC;gBACH,GAAG,CAAC,EAAE,CAAC,KAAK,EAAE;oBACV,EAAE,CAAC,CAAC,GAAG,CAAC,UAAU,KAAK,GAAG,CAAC,CAAC,CAAC;wBACzB,uDAAuD;wBACvD,IAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;wBAChC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;oBACvB,CAAC;oBAAC,IAAI,CAAC,CAAC;wBACJ,2DAA2D;wBAC3D,MAAM,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;oBACtC,CAAC;gBACL,CAAC,CAAC,CAAC;YACP,CAAC,CAAC,CAAC;YAEH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,UAAC,CAAC;gBACd,MAAM,CAAC,CAAC,CAAC,CAAC;YACd,CAAC,CAAC,CAAC;YACH,GAAG,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;YACvB,GAAG,CAAC,GAAG,EAAE,CAAC;QACd,CAAC,CAAC,CAAC;IACP,CAAC;IA3HuB,oBAAY,GAAG,eAAe,CAAC;IAC/B,kBAAU,GAAG,aAAa,CAAC;IA4HvD,cAAC;CAAA,AA/HD,IA+HC;AA/HY,0BAAO"}
|
||||
|
|
@ -1,5 +1,11 @@
|
|||
import { OpenViduRole } from './OpenViduRole';
|
||||
export interface TokenOptions {
|
||||
/**
|
||||
* Secure (server-side) data associated to this token. Every client will receive this data in property `Connection.data`. Object `Connection` can be retrieved by subscribing to event `connectionCreated` of Session object.
|
||||
* - If you have provided no data in your clients when calling method `Session.connect(TOKEN, DATA)` (`DATA` not defined), then `Connection.data` will only have this [[TokenOptions.data]] property.
|
||||
* - If you have provided some data when calling `Session.connect(TOKEN, DATA)` (`DATA` defined), then `Connection.data` will have the following structure: `"CLIENT_DATA%/%SERVER_DATA"`, being `CLIENT_DATA` the second
|
||||
* parameter passed in OpenVidu Browser in method `Session.connect` and `SERVER_DATA` this [[TokenOptions.data]] property.
|
||||
*/
|
||||
data: string;
|
||||
role: OpenViduRole;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -16,6 +16,14 @@
|
|||
*/
|
||||
|
||||
export enum MediaMode {
|
||||
RELAYED = 'RELAYED', // The session will attempt to transmit streams directly between clients
|
||||
ROUTED = 'ROUTED' // The session will transmit streams using OpenVidu Media Server
|
||||
|
||||
/**
|
||||
* _(not available yet)_ The session will attempt to transmit streams directly between clients
|
||||
*/
|
||||
RELAYED = 'RELAYED',
|
||||
|
||||
/**
|
||||
* The session will transmit streams using OpenVidu Media Server
|
||||
*/
|
||||
ROUTED = 'ROUTED'
|
||||
}
|
||||
|
|
|
|||
|
|
@ -34,6 +34,10 @@ export class OpenVidu {
|
|||
private port: number;
|
||||
private basicAuth: string;
|
||||
|
||||
/**
|
||||
* @param urlOpenViduServer Public accessible IP where your instance of OpenVidu Server is up an running
|
||||
* @param secret Secret used on OpenVidu Server initialization
|
||||
*/
|
||||
constructor(private urlOpenViduServer: string, secret: string) {
|
||||
this.setHostnameAndPort();
|
||||
this.basicAuth = this.getBasicAuth(secret);
|
||||
|
|
@ -47,6 +51,17 @@ export class OpenVidu {
|
|||
public startRecording(sessionId: string, name: string): Promise<Recording>;
|
||||
public startRecording(sessionId: string, properties: RecordingProperties): Promise<Recording>;
|
||||
|
||||
/**
|
||||
* Starts the recording of a [[Session]]
|
||||
*
|
||||
* @param sessionId The `sessionId` of the [[Session]] you want to start recording
|
||||
* @param name The name you want to give to the video file. You can access this same value in your clients on recording events (`recordingStarted`, `recordingStopped`)
|
||||
*
|
||||
* @returns A Promise that is resolved to the [[Recording]] if it successfully started and rejected with an Error object if not. This Error object has as `message` property with the following values:
|
||||
* - `404`: no session exists for the passed `sessionId`
|
||||
* - `400`: the session has no connected participants
|
||||
* - `409`: the session is not configured for using [[MediaMode.ROUTED]] or it is already being recorded
|
||||
*/
|
||||
public startRecording(sessionId: string, param2?: string | RecordingProperties): Promise<Recording> {
|
||||
return new Promise<Recording>((resolve, reject) => {
|
||||
|
||||
|
|
@ -116,6 +131,15 @@ export class OpenVidu {
|
|||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Stops the recording of a [[Session]]
|
||||
*
|
||||
* @param recordingId The `id` property of the [[Recording]] you want to stop
|
||||
*
|
||||
* @returns A Promise that is resolved to the [[Recording]] if it successfully stopped and rejected with an Error object if not. This Error object has as `message` property with the following values:
|
||||
* - `404`: no recording exists for the passed `recordingId`
|
||||
* - `406`: recording has `starting` status. Wait until `started` status before stopping the recording
|
||||
*/
|
||||
public stopRecording(recordingId: string): Promise<Recording> {
|
||||
return new Promise<Recording>((resolve, reject) => {
|
||||
|
||||
|
|
@ -156,6 +180,14 @@ export class OpenVidu {
|
|||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets an existing [[Recording]]
|
||||
*
|
||||
* @param recordingId The `id` property of the [[Recording]] you want to retrieve
|
||||
*
|
||||
* @returns A Promise that is resolved to the [[Recording]] if it successfully stopped and rejected with an Error object if not. This Error object has as `message` property with the following values:
|
||||
* - `404`: no recording exists for the passed `recordingId`
|
||||
*/
|
||||
public getRecording(recordingId: string): Promise<Recording> {
|
||||
return new Promise<Recording>((resolve, reject) => {
|
||||
|
||||
|
|
@ -196,6 +228,11 @@ export class OpenVidu {
|
|||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Lists all existing recordings
|
||||
*
|
||||
* @returns A Promise that is resolved to an array with all existing recordings
|
||||
*/
|
||||
public listRecordings(): Promise<Recording[]> {
|
||||
return new Promise<Recording[]>((resolve, reject) => {
|
||||
|
||||
|
|
@ -241,6 +278,15 @@ export class OpenVidu {
|
|||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes a [[Recording]]. The recording must have status `stopped` or `available`
|
||||
*
|
||||
* @param recordingId
|
||||
*
|
||||
* @returns A Promise that is resolved if the Recording was successfully deleted and rejected with an Error object if not. This Error object has as `message` property with the following values:
|
||||
* - `404`: no recording exists for the passed `recordingId`
|
||||
* - `409`: the recording has `started` status. Stop it before deletion
|
||||
*/
|
||||
public deleteRecording(recordingId: string): Promise<Error> {
|
||||
return new Promise<Error>((resolve, reject) => {
|
||||
|
||||
|
|
|
|||
|
|
@ -16,7 +16,19 @@
|
|||
*/
|
||||
|
||||
export enum OpenViduRole {
|
||||
SUBSCRIBER = 'SUBSCRIBER', // Can subscribe to published streams of other users
|
||||
PUBLISHER = 'PUBLISHER', // SUBSCRIBER permissions + can subscribe to published streams of other users and publish their own streams
|
||||
MODERATOR = 'MODERATOR', // SUBSCRIBER + PUBLIHSER permissions + can force unpublish() and disconnect() over a third-party stream or user
|
||||
|
||||
/**
|
||||
* Can subscribe to published streams of other users
|
||||
*/
|
||||
SUBSCRIBER = 'SUBSCRIBER',
|
||||
|
||||
/**
|
||||
* SUBSCRIBER permissions + can publish their own streams
|
||||
*/
|
||||
PUBLISHER = 'PUBLISHER',
|
||||
|
||||
/**
|
||||
* _(not available yet)_ SUBSCRIBER + PUBLIHSER permissions + can force `unpublish()` and `disconnect()` over a third-party stream or user
|
||||
*/
|
||||
MODERATOR = 'MODERATOR'
|
||||
}
|
||||
|
|
@ -16,20 +16,63 @@
|
|||
*/
|
||||
|
||||
import { RecordingLayout } from './RecordingLayout';
|
||||
import { RecordingProperties } from './RecordingProperties';
|
||||
|
||||
export class Recording {
|
||||
|
||||
private id: string;
|
||||
private sessionId: string;
|
||||
private createdAt: number;
|
||||
private size = 0;
|
||||
private duration = 0;
|
||||
private url: string;
|
||||
private hasaudio = true;
|
||||
private hasvideo = true;
|
||||
private status: Recording.Status;
|
||||
private recordingProperties: RecordingProperties;
|
||||
/**
|
||||
* Recording unique identifier
|
||||
*/
|
||||
id: string;
|
||||
|
||||
/**
|
||||
* Session associated to the recording
|
||||
*/
|
||||
sessionId: string;
|
||||
|
||||
/**
|
||||
* Time when the recording started in UTC milliseconds
|
||||
*/
|
||||
createdAt: number;
|
||||
|
||||
/**
|
||||
* Size of the recording in bytes (0 until the recording is stopped)
|
||||
*/
|
||||
size = 0;
|
||||
|
||||
/**
|
||||
* Duration of the recording in seconds (0 until the recording is stopped)
|
||||
*/
|
||||
duration = 0;
|
||||
|
||||
/**
|
||||
* URL of the recording. You can access the file from there. It is `null` until recording is stopped or if OpenVidu Server configuration property `openvidu.recording.public-access` is false
|
||||
*/
|
||||
url: string;
|
||||
|
||||
/**
|
||||
* `true` if the recording has an audio track, `false` otherwise (currently fixed to true)
|
||||
*/
|
||||
hasAudio = true;
|
||||
|
||||
/**
|
||||
* `true` if the recording has a video track, `false` otherwise (currently fixed to true)
|
||||
*/
|
||||
hasVideo = true;
|
||||
|
||||
/**
|
||||
* Status of the recording
|
||||
*/
|
||||
status: Recording.Status;
|
||||
|
||||
/**
|
||||
* Name of the Recording. The video file will be named after this property
|
||||
*/
|
||||
name: string;
|
||||
|
||||
/**
|
||||
* The layout used in this Recording
|
||||
*/
|
||||
recordingLayout: RecordingLayout;
|
||||
|
||||
/* tslint:disable:no-string-literal */
|
||||
constructor(json: JSON) {
|
||||
|
|
@ -39,56 +82,13 @@ export class Recording {
|
|||
this.size = json['size'];
|
||||
this.duration = json['duration'];
|
||||
this.url = json['url'];
|
||||
this.hasaudio = json['hasAudio'];
|
||||
this.hasvideo = json['hasVideo'];
|
||||
this.hasAudio = json['hasAudio'];
|
||||
this.hasVideo = json['hasVideo'];
|
||||
this.status = json['status'];
|
||||
this.recordingProperties = { name: json['name'], recordingLayout: json['layout'] };
|
||||
this.name = json['name'];
|
||||
this.recordingLayout = json['recordingLayout'];
|
||||
}
|
||||
/* tslint:enable:no-string-literal */
|
||||
|
||||
public getStatus(): Recording.Status {
|
||||
return this.status;
|
||||
}
|
||||
|
||||
public getId(): string {
|
||||
return this.id;
|
||||
}
|
||||
|
||||
public getName(): string {
|
||||
return this.recordingProperties.name;
|
||||
}
|
||||
|
||||
public getLayout(): RecordingLayout {
|
||||
return this.recordingProperties.recordingLayout;
|
||||
}
|
||||
|
||||
public getSessionId(): string {
|
||||
return this.sessionId;
|
||||
}
|
||||
|
||||
public getCreatedAt(): number {
|
||||
return this.createdAt;
|
||||
}
|
||||
|
||||
public getSize(): number {
|
||||
return this.size;
|
||||
}
|
||||
|
||||
public getDuration(): number {
|
||||
return this.duration;
|
||||
}
|
||||
|
||||
public getUrl(): string {
|
||||
return this.url;
|
||||
}
|
||||
|
||||
public hasAudio(): boolean {
|
||||
return this.hasaudio;
|
||||
}
|
||||
|
||||
public hasVideo(): boolean {
|
||||
return this.hasvideo;
|
||||
}
|
||||
}
|
||||
|
||||
export namespace Recording {
|
||||
|
|
|
|||
|
|
@ -16,9 +16,29 @@
|
|||
*/
|
||||
|
||||
export enum RecordingLayout {
|
||||
BEST_FIT = 'BEST_FIT', // All the videos are evenly distributed, taking up as much space as possible
|
||||
|
||||
/**
|
||||
* All the videos are evenly distributed, taking up as much space as possible
|
||||
*/
|
||||
BEST_FIT = 'BEST_FIT',
|
||||
|
||||
/**
|
||||
* _(not available yet)_
|
||||
*/
|
||||
PICTURE_IN_PICTURE = 'PICTURE_IN_PICTURE',
|
||||
|
||||
/**
|
||||
* _(not available yet)_
|
||||
*/
|
||||
VERTICAL_PRESENTATION = 'VERTICAL_PRESENTATION',
|
||||
|
||||
/**
|
||||
* _(not available yet)_
|
||||
*/
|
||||
HORIZONTAL_PRESENTATION = 'VERTICAL_PRESENTATION',
|
||||
|
||||
/**
|
||||
* Use your own custom recording layout. See [Custom recording layouts](http://openvidu.io/docs/advanced-features/recording#custom-recording-layouts) to learn more
|
||||
*/
|
||||
CUSTOM = 'CUSTOM'
|
||||
}
|
||||
|
|
|
|||
|
|
@ -16,6 +16,16 @@
|
|||
*/
|
||||
|
||||
export enum RecordingMode {
|
||||
ALWAYS = 'ALWAYS', // The session is recorded automatically (as soon as there are clients publishing streams to the session)
|
||||
MANUAL = 'MANUAL' // The session is not recorded automatically. To record the session, you can call the OpenVidu.startRecording() method
|
||||
|
||||
/**
|
||||
* The session is recorded automatically as soon as the first client publishes a stream to the session. It is automatically stopped
|
||||
* after last user leaves the session (or until you call [[OpenVidu.stopRecording]]).
|
||||
*/
|
||||
ALWAYS = 'ALWAYS',
|
||||
|
||||
/**
|
||||
* The session is not recorded automatically. To record the session, you must call [[OpenVidu.startRecording]] method. To stop the recording,
|
||||
* you must call [[OpenVidu.stopRecording]].
|
||||
*/
|
||||
MANUAL = 'MANUAL'
|
||||
}
|
||||
|
|
|
|||
|
|
@ -18,7 +18,20 @@
|
|||
import { RecordingLayout } from './RecordingLayout';
|
||||
|
||||
export interface RecordingProperties {
|
||||
|
||||
/**
|
||||
* The name you want to give to the video file. You can access this same value in your clients on recording events (`recordingStarted`, `recordingStopped`)
|
||||
*/
|
||||
name?: string;
|
||||
|
||||
/**
|
||||
* The layout to be used in the recording
|
||||
*/
|
||||
recordingLayout?: RecordingLayout;
|
||||
|
||||
/**
|
||||
* If [[recordingLayout]] is `CUSTOM`, the relative path to the specific custom layout you want to use.
|
||||
* See [Custom recording layouts](http://openvidu.io/docs/advanced-features/recording#custom-recording-layouts) to learn more
|
||||
*/
|
||||
customLayout?: string;
|
||||
}
|
||||
|
|
@ -32,21 +32,27 @@ export class Session {
|
|||
private static readonly API_SESSIONS = '/api/sessions';
|
||||
private static readonly API_TOKENS = '/api/tokens';
|
||||
|
||||
private sessionId = '';
|
||||
private properties: SessionProperties;
|
||||
sessionId: string;
|
||||
properties: SessionProperties;
|
||||
|
||||
constructor(private hostname: string, private port: number, private basicAuth: string, properties?: SessionProperties) {
|
||||
if (properties === null) {
|
||||
if (!properties) {
|
||||
this.properties = {};
|
||||
} else {
|
||||
this.properties = properties;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets the unique identifier of the Session. This translates into a new request to OpenVidu Server if this Session has no `sessionId` yet
|
||||
* or simply returns the existing value if it has already been retrieved
|
||||
*
|
||||
* @returns A Promise that is resolved to the _sessionId_ if success and rejected with an Error object if not (due to a `400 (Bad Request)` error in OpenVidu Server)
|
||||
*/
|
||||
public getSessionId(): Promise<string> {
|
||||
return new Promise<string>((resolve, reject) => {
|
||||
|
||||
if (this.sessionId) {
|
||||
if (!!this.sessionId) {
|
||||
resolve(this.sessionId);
|
||||
}
|
||||
|
||||
|
|
@ -96,6 +102,11 @@ export class Session {
|
|||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Gets a new token associated to Session object. This translates into a new request to OpenVidu Server
|
||||
*
|
||||
* @returns A Promise that is resolved to the _token_ if success and rejected with an Error object if not (due to a `400 (Bad Request)` error in OpenVidu Server)
|
||||
*/
|
||||
public generateToken(tokenOptions?: TokenOptions): Promise<string> {
|
||||
return new Promise<string>((resolve, reject) => {
|
||||
|
||||
|
|
@ -143,8 +154,4 @@ export class Session {
|
|||
});
|
||||
}
|
||||
|
||||
public getProperties(): SessionProperties {
|
||||
return this.properties;
|
||||
}
|
||||
|
||||
}
|
||||
|
|
@ -20,8 +20,19 @@ import { RecordingLayout } from './RecordingLayout';
|
|||
import { RecordingMode } from './RecordingMode';
|
||||
|
||||
export interface SessionProperties {
|
||||
|
||||
mediaMode?: MediaMode;
|
||||
recordingMode?: RecordingMode;
|
||||
|
||||
/**
|
||||
* Default value used to initialize property [[RecordingProperties.recordingLayout]] of every recording of this session.
|
||||
* You can easily override this value later by setting [[RecordingProperties.recordingLayout]] to any other value
|
||||
*/
|
||||
defaultRecordingLayout?: RecordingLayout;
|
||||
|
||||
/**
|
||||
* Default value used to initialize property [[RecordingProperties.customLayout]] of every recording of this session.
|
||||
* You can easily override this value later by setting [[RecordingProperties.customLayout]] to any other value
|
||||
*/
|
||||
defaultCustomLayout?: string;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -18,6 +18,14 @@
|
|||
import { OpenViduRole } from './OpenViduRole';
|
||||
|
||||
export interface TokenOptions {
|
||||
|
||||
/**
|
||||
* Secure (server-side) data associated to this token. Every client will receive this data in property `Connection.data`. Object `Connection` can be retrieved by subscribing to event `connectionCreated` of Session object.
|
||||
* - If you have provided no data in your clients when calling method `Session.connect(TOKEN, DATA)` (`DATA` not defined), then `Connection.data` will only have this [[TokenOptions.data]] property.
|
||||
* - If you have provided some data when calling `Session.connect(TOKEN, DATA)` (`DATA` defined), then `Connection.data` will have the following structure: `"CLIENT_DATA%/%SERVER_DATA"`, being `CLIENT_DATA` the second
|
||||
* parameter passed in OpenVidu Browser in method `Session.connect` and `SERVER_DATA` this [[TokenOptions.data]] property.
|
||||
*/
|
||||
data: string;
|
||||
|
||||
role: OpenViduRole;
|
||||
}
|
||||
Loading…
Reference in New Issue