diff --git a/openvidu-node-client/docs/assets/js/search.js b/openvidu-node-client/docs/assets/js/search.js index 59079305..8344f10a 100644 --- a/openvidu-node-client/docs/assets/js/search.js +++ b/openvidu-node-client/docs/assets/js/search.js @@ -1,3 +1,3 @@ var typedoc = typedoc || {}; typedoc.search = typedoc.search || {}; - typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"MediaMode","url":"enums/mediamode.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"RELAYED","url":"enums/mediamode.html#relayed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MediaMode"},{"id":2,"kind":16,"name":"ROUTED","url":"enums/mediamode.html#routed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MediaMode"},{"id":3,"kind":4,"name":"OpenViduRole","url":"enums/openvidurole.html","classes":"tsd-kind-enum"},{"id":4,"kind":16,"name":"SUBSCRIBER","url":"enums/openvidurole.html#subscriber","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"OpenViduRole"},{"id":5,"kind":16,"name":"PUBLISHER","url":"enums/openvidurole.html#publisher","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"OpenViduRole"},{"id":6,"kind":16,"name":"MODERATOR","url":"enums/openvidurole.html#moderator","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"OpenViduRole"},{"id":7,"kind":4,"name":"RecordingLayout","url":"enums/recordinglayout.html","classes":"tsd-kind-enum"},{"id":8,"kind":16,"name":"BEST_FIT","url":"enums/recordinglayout.html#best_fit","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RecordingLayout"},{"id":9,"kind":16,"name":"PICTURE_IN_PICTURE","url":"enums/recordinglayout.html#picture_in_picture","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RecordingLayout"},{"id":10,"kind":16,"name":"VERTICAL_PRESENTATION","url":"enums/recordinglayout.html#vertical_presentation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RecordingLayout"},{"id":11,"kind":16,"name":"HORIZONTAL_PRESENTATION","url":"enums/recordinglayout.html#horizontal_presentation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RecordingLayout"},{"id":12,"kind":16,"name":"CUSTOM","url":"enums/recordinglayout.html#custom","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RecordingLayout"},{"id":13,"kind":4,"name":"RecordingMode","url":"enums/recordingmode.html","classes":"tsd-kind-enum"},{"id":14,"kind":16,"name":"ALWAYS","url":"enums/recordingmode.html#always","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RecordingMode"},{"id":15,"kind":16,"name":"MANUAL","url":"enums/recordingmode.html#manual","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RecordingMode"},{"id":16,"kind":256,"name":"SessionProperties","url":"interfaces/sessionproperties.html","classes":"tsd-kind-interface"},{"id":17,"kind":1024,"name":"mediaMode","url":"interfaces/sessionproperties.html#mediamode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SessionProperties"},{"id":18,"kind":1024,"name":"recordingMode","url":"interfaces/sessionproperties.html#recordingmode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SessionProperties"},{"id":19,"kind":1024,"name":"defaultRecordingLayout","url":"interfaces/sessionproperties.html#defaultrecordinglayout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SessionProperties"},{"id":20,"kind":1024,"name":"defaultCustomLayout","url":"interfaces/sessionproperties.html#defaultcustomlayout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SessionProperties"},{"id":21,"kind":1024,"name":"customSessionId","url":"interfaces/sessionproperties.html#customsessionid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SessionProperties"},{"id":22,"kind":256,"name":"TokenOptions","url":"interfaces/tokenoptions.html","classes":"tsd-kind-interface"},{"id":23,"kind":1024,"name":"data","url":"interfaces/tokenoptions.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TokenOptions"},{"id":24,"kind":1024,"name":"role","url":"interfaces/tokenoptions.html#role","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TokenOptions"},{"id":25,"kind":128,"name":"Session","url":"classes/session.html","classes":"tsd-kind-class"},{"id":26,"kind":1024,"name":"sessionId","url":"classes/session.html#sessionid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Session"},{"id":27,"kind":1024,"name":"properties","url":"classes/session.html#properties","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Session"},{"id":28,"kind":512,"name":"constructor","url":"classes/session.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Session"},{"id":29,"kind":2048,"name":"getSessionId","url":"classes/session.html#getsessionid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":30,"kind":2048,"name":"generateToken","url":"classes/session.html#generatetoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":31,"kind":128,"name":"Recording","url":"classes/recording.html","classes":"tsd-kind-class"},{"id":32,"kind":1024,"name":"id","url":"classes/recording.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":33,"kind":1024,"name":"sessionId","url":"classes/recording.html#sessionid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":34,"kind":1024,"name":"createdAt","url":"classes/recording.html#createdat","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":35,"kind":1024,"name":"size","url":"classes/recording.html#size","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":36,"kind":1024,"name":"duration","url":"classes/recording.html#duration","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":37,"kind":1024,"name":"url","url":"classes/recording.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":38,"kind":1024,"name":"hasAudio","url":"classes/recording.html#hasaudio","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":39,"kind":1024,"name":"hasVideo","url":"classes/recording.html#hasvideo","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":40,"kind":1024,"name":"status","url":"classes/recording.html#status-1","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":41,"kind":1024,"name":"name","url":"classes/recording.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":42,"kind":1024,"name":"recordingLayout","url":"classes/recording.html#recordinglayout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":43,"kind":512,"name":"constructor","url":"classes/recording.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Recording"},{"id":44,"kind":4,"name":"Status","url":"enums/recording.status.html","classes":"tsd-kind-enum tsd-parent-kind-class tsd-is-static","parent":"Recording"},{"id":45,"kind":16,"name":"starting","url":"enums/recording.status.html#starting","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Recording.Status"},{"id":46,"kind":16,"name":"started","url":"enums/recording.status.html#started","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Recording.Status"},{"id":47,"kind":16,"name":"stopped","url":"enums/recording.status.html#stopped","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Recording.Status"},{"id":48,"kind":16,"name":"available","url":"enums/recording.status.html#available","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Recording.Status"},{"id":49,"kind":16,"name":"failed","url":"enums/recording.status.html#failed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Recording.Status"},{"id":50,"kind":256,"name":"RecordingProperties","url":"interfaces/recordingproperties.html","classes":"tsd-kind-interface"},{"id":51,"kind":1024,"name":"name","url":"interfaces/recordingproperties.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RecordingProperties"},{"id":52,"kind":1024,"name":"recordingLayout","url":"interfaces/recordingproperties.html#recordinglayout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RecordingProperties"},{"id":53,"kind":1024,"name":"customLayout","url":"interfaces/recordingproperties.html#customlayout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RecordingProperties"},{"id":54,"kind":128,"name":"OpenVidu","url":"classes/openvidu.html","classes":"tsd-kind-class"},{"id":55,"kind":512,"name":"constructor","url":"classes/openvidu.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"OpenVidu"},{"id":56,"kind":2048,"name":"createSession","url":"classes/openvidu.html#createsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenVidu"},{"id":57,"kind":2048,"name":"startRecording","url":"classes/openvidu.html#startrecording","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenVidu"},{"id":58,"kind":2048,"name":"stopRecording","url":"classes/openvidu.html#stoprecording","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenVidu"},{"id":59,"kind":2048,"name":"getRecording","url":"classes/openvidu.html#getrecording","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenVidu"},{"id":60,"kind":2048,"name":"listRecordings","url":"classes/openvidu.html#listrecordings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenVidu"},{"id":61,"kind":2048,"name":"deleteRecording","url":"classes/openvidu.html#deleterecording","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenVidu"}]}; \ No newline at end of file + typedoc.search.data = {"kinds":{"4":"Enumeration","16":"Enumeration member","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method"},"rows":[{"id":0,"kind":4,"name":"OpenViduRole","url":"enums/openvidurole.html","classes":"tsd-kind-enum"},{"id":1,"kind":16,"name":"SUBSCRIBER","url":"enums/openvidurole.html#subscriber","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"OpenViduRole"},{"id":2,"kind":16,"name":"PUBLISHER","url":"enums/openvidurole.html#publisher","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"OpenViduRole"},{"id":3,"kind":16,"name":"MODERATOR","url":"enums/openvidurole.html#moderator","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"OpenViduRole"},{"id":4,"kind":128,"name":"Publisher","url":"classes/publisher.html","classes":"tsd-kind-class"},{"id":5,"kind":1024,"name":"streamId","url":"classes/publisher.html#streamid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Publisher"},{"id":6,"kind":1024,"name":"hasAudio","url":"classes/publisher.html#hasaudio","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Publisher"},{"id":7,"kind":1024,"name":"hasVideo","url":"classes/publisher.html#hasvideo","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Publisher"},{"id":8,"kind":1024,"name":"audioActive","url":"classes/publisher.html#audioactive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Publisher"},{"id":9,"kind":1024,"name":"videoActive","url":"classes/publisher.html#videoactive","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Publisher"},{"id":10,"kind":1024,"name":"frameRate","url":"classes/publisher.html#framerate","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Publisher"},{"id":11,"kind":1024,"name":"typeOfVideo","url":"classes/publisher.html#typeofvideo","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Publisher"},{"id":12,"kind":1024,"name":"videoDimensions","url":"classes/publisher.html#videodimensions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Publisher"},{"id":13,"kind":512,"name":"constructor","url":"classes/publisher.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"Publisher"},{"id":14,"kind":128,"name":"Connection","url":"classes/connection.html","classes":"tsd-kind-class"},{"id":15,"kind":1024,"name":"connectionId","url":"classes/connection.html#connectionid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Connection"},{"id":16,"kind":1024,"name":"role","url":"classes/connection.html#role","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Connection"},{"id":17,"kind":1024,"name":"token","url":"classes/connection.html#token","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Connection"},{"id":18,"kind":1024,"name":"serverData","url":"classes/connection.html#serverdata","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Connection"},{"id":19,"kind":1024,"name":"clientData","url":"classes/connection.html#clientdata","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Connection"},{"id":20,"kind":1024,"name":"publishers","url":"classes/connection.html#publishers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Connection"},{"id":21,"kind":1024,"name":"subscribers","url":"classes/connection.html#subscribers","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Connection"},{"id":22,"kind":4,"name":"MediaMode","url":"enums/mediamode.html","classes":"tsd-kind-enum"},{"id":23,"kind":16,"name":"RELAYED","url":"enums/mediamode.html#relayed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MediaMode"},{"id":24,"kind":16,"name":"ROUTED","url":"enums/mediamode.html#routed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"MediaMode"},{"id":25,"kind":4,"name":"RecordingLayout","url":"enums/recordinglayout.html","classes":"tsd-kind-enum"},{"id":26,"kind":16,"name":"BEST_FIT","url":"enums/recordinglayout.html#best_fit","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RecordingLayout"},{"id":27,"kind":16,"name":"PICTURE_IN_PICTURE","url":"enums/recordinglayout.html#picture_in_picture","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RecordingLayout"},{"id":28,"kind":16,"name":"VERTICAL_PRESENTATION","url":"enums/recordinglayout.html#vertical_presentation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RecordingLayout"},{"id":29,"kind":16,"name":"HORIZONTAL_PRESENTATION","url":"enums/recordinglayout.html#horizontal_presentation","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RecordingLayout"},{"id":30,"kind":16,"name":"CUSTOM","url":"enums/recordinglayout.html#custom","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RecordingLayout"},{"id":31,"kind":4,"name":"RecordingMode","url":"enums/recordingmode.html","classes":"tsd-kind-enum"},{"id":32,"kind":16,"name":"ALWAYS","url":"enums/recordingmode.html#always","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RecordingMode"},{"id":33,"kind":16,"name":"MANUAL","url":"enums/recordingmode.html#manual","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"RecordingMode"},{"id":34,"kind":256,"name":"SessionProperties","url":"interfaces/sessionproperties.html","classes":"tsd-kind-interface"},{"id":35,"kind":1024,"name":"mediaMode","url":"interfaces/sessionproperties.html#mediamode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SessionProperties"},{"id":36,"kind":1024,"name":"recordingMode","url":"interfaces/sessionproperties.html#recordingmode","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SessionProperties"},{"id":37,"kind":1024,"name":"defaultRecordingLayout","url":"interfaces/sessionproperties.html#defaultrecordinglayout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SessionProperties"},{"id":38,"kind":1024,"name":"defaultCustomLayout","url":"interfaces/sessionproperties.html#defaultcustomlayout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SessionProperties"},{"id":39,"kind":1024,"name":"customSessionId","url":"interfaces/sessionproperties.html#customsessionid","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"SessionProperties"},{"id":40,"kind":256,"name":"TokenOptions","url":"interfaces/tokenoptions.html","classes":"tsd-kind-interface"},{"id":41,"kind":1024,"name":"data","url":"interfaces/tokenoptions.html#data","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TokenOptions"},{"id":42,"kind":1024,"name":"role","url":"interfaces/tokenoptions.html#role","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"TokenOptions"},{"id":43,"kind":128,"name":"Session","url":"classes/session.html","classes":"tsd-kind-class"},{"id":44,"kind":1024,"name":"sessionId","url":"classes/session.html#sessionid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Session"},{"id":45,"kind":1024,"name":"properties","url":"classes/session.html#properties","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Session"},{"id":46,"kind":1024,"name":"activeConnections","url":"classes/session.html#activeconnections","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Session"},{"id":47,"kind":1024,"name":"recording","url":"classes/session.html#recording","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Session"},{"id":48,"kind":2048,"name":"getSessionId","url":"classes/session.html#getsessionid","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":49,"kind":2048,"name":"generateToken","url":"classes/session.html#generatetoken","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":50,"kind":2048,"name":"close","url":"classes/session.html#close","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":51,"kind":2048,"name":"fetch","url":"classes/session.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":52,"kind":2048,"name":"forceDisconnect","url":"classes/session.html#forcedisconnect","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":53,"kind":2048,"name":"forceUnpublish","url":"classes/session.html#forceunpublish","classes":"tsd-kind-method tsd-parent-kind-class","parent":"Session"},{"id":54,"kind":128,"name":"Recording","url":"classes/recording.html","classes":"tsd-kind-class"},{"id":55,"kind":1024,"name":"id","url":"classes/recording.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":56,"kind":1024,"name":"sessionId","url":"classes/recording.html#sessionid","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":57,"kind":1024,"name":"createdAt","url":"classes/recording.html#createdat","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":58,"kind":1024,"name":"size","url":"classes/recording.html#size","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":59,"kind":1024,"name":"duration","url":"classes/recording.html#duration","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":60,"kind":1024,"name":"url","url":"classes/recording.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":61,"kind":1024,"name":"hasAudio","url":"classes/recording.html#hasaudio","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":62,"kind":1024,"name":"hasVideo","url":"classes/recording.html#hasvideo","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":63,"kind":1024,"name":"status","url":"classes/recording.html#status-1","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":64,"kind":1024,"name":"name","url":"classes/recording.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":65,"kind":1024,"name":"recordingLayout","url":"classes/recording.html#recordinglayout","classes":"tsd-kind-property tsd-parent-kind-class","parent":"Recording"},{"id":66,"kind":4,"name":"Status","url":"enums/recording.status.html","classes":"tsd-kind-enum tsd-parent-kind-class tsd-is-static","parent":"Recording"},{"id":67,"kind":16,"name":"starting","url":"enums/recording.status.html#starting","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Recording.Status"},{"id":68,"kind":16,"name":"started","url":"enums/recording.status.html#started","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Recording.Status"},{"id":69,"kind":16,"name":"stopped","url":"enums/recording.status.html#stopped","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Recording.Status"},{"id":70,"kind":16,"name":"available","url":"enums/recording.status.html#available","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Recording.Status"},{"id":71,"kind":16,"name":"failed","url":"enums/recording.status.html#failed","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":"Recording.Status"},{"id":72,"kind":256,"name":"RecordingProperties","url":"interfaces/recordingproperties.html","classes":"tsd-kind-interface"},{"id":73,"kind":1024,"name":"name","url":"interfaces/recordingproperties.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RecordingProperties"},{"id":74,"kind":1024,"name":"recordingLayout","url":"interfaces/recordingproperties.html#recordinglayout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RecordingProperties"},{"id":75,"kind":1024,"name":"customLayout","url":"interfaces/recordingproperties.html#customlayout","classes":"tsd-kind-property tsd-parent-kind-interface","parent":"RecordingProperties"},{"id":76,"kind":128,"name":"OpenVidu","url":"classes/openvidu.html","classes":"tsd-kind-class"},{"id":77,"kind":1024,"name":"activeSessions","url":"classes/openvidu.html#activesessions","classes":"tsd-kind-property tsd-parent-kind-class","parent":"OpenVidu"},{"id":78,"kind":512,"name":"constructor","url":"classes/openvidu.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"OpenVidu"},{"id":79,"kind":2048,"name":"createSession","url":"classes/openvidu.html#createsession","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenVidu"},{"id":80,"kind":2048,"name":"startRecording","url":"classes/openvidu.html#startrecording","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenVidu"},{"id":81,"kind":2048,"name":"stopRecording","url":"classes/openvidu.html#stoprecording","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenVidu"},{"id":82,"kind":2048,"name":"getRecording","url":"classes/openvidu.html#getrecording","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenVidu"},{"id":83,"kind":2048,"name":"listRecordings","url":"classes/openvidu.html#listrecordings","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenVidu"},{"id":84,"kind":2048,"name":"deleteRecording","url":"classes/openvidu.html#deleterecording","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenVidu"},{"id":85,"kind":2048,"name":"fetch","url":"classes/openvidu.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":"OpenVidu"}]}; \ No newline at end of file diff --git a/openvidu-node-client/docs/classes/connection.html b/openvidu-node-client/docs/classes/connection.html new file mode 100644 index 00000000..eab79598 --- /dev/null +++ b/openvidu-node-client/docs/classes/connection.html @@ -0,0 +1,361 @@ + + +
+ + +Data associated to the connection on the client-side. This value is set with second parameter of method + Session.connect in OpenVidu Browser
+Identifier of the connection. You can call Session.forceDisconnect passing this property as parameter
+Array of Publisher objects this particular Connection is publishing to the Session (each Publisher object has one Stream, uniquely
+ identified by its streamId
). You can call Session.forceUnpublish passing any of this values as parameter
Role of the connection
+Data associated to the connection on the server-side. This value is set with property TokenOptions.data when calling Session.generateToken
+Array of streams (their streamId
properties) this particular Connection is subscribed to. Each one always corresponds to one
+ Publisher of some other Connection: each string of this array must be equal to one Publisher.streamId of other Connection
Token associated to the connection
+Generated using TypeDoc
+Array of active sessions. This value will remain unchanged since the last time method OpenVidu.fetch + was called. Exceptions to this rule are:
+To get the array of active sessions with their current actual value, you must call OpenVidu.fetch before consulting + property activeSessions
+Creates an OpenVidu session. You can call Session.getSessionId in the resolved promise to retrieve the sessionId
Creates an OpenVidu session. You can call Session.getSessionId inside the resolved promise to retrieve the sessionId
Updates every property of every active Session with the current status they have in OpenVidu Server. + After calling this method you can access the updated array of active sessions in activeSessions
+A promise resolved to true if any Session status has changed with respect to the server, or to false if not. + This applies to any property or sub-property of any of the sessions locally stored in OpenVidu Node Client
+The name you want to give to the video file. You can access this same value in your clients on recording events (recordingStarted
, recordingStopped
)
The name you want to give to the video file. You can access this same value in your clients on recording events (recordingStarted
, recordingStopped
)
+ WARNING: this parameter follows an overwriting policy. If you name two recordings the same, the newest MP4 file will overwrite the oldest one
This is a backend representation of a published media stream (see OpenVidu Browser Stream class)
+See properties of Stream object in OpenVidu Browser library to find out more
+See properties of Stream object in OpenVidu Browser library to find out more
+See properties of Stream object in OpenVidu Browser library to find out more
+See properties of Stream object in OpenVidu Browser library to find out more
+Unique identifier of the Stream associated to this Publisher.
+ Each Publisher is paired with only one Stream, so you can identify each Publisher by its
+ Stream.streamId
See properties of Stream object in OpenVidu Browser library to find out more
+See properties of Stream object in OpenVidu Browser library to find out more
+See properties of Stream object in OpenVidu Browser library to find out more
+Generated using TypeDoc
+Array of active connections to the session. This property always initialize as an empty array and + will remain unchanged since the last time method Session.fetch was called. Exceptions to this rule are:
+To get the array of active connections with their current actual value, you must call Session.fetch before consulting + property activeConnections
+Properties defining the session
+Whether the session is being recorded or not
+Unique identifier of the Session
+Gracefully closes the Session: unpublishes all streams and evicts every participant
+A Promise that is resolved if the session has been closed successfully and rejected with an Error object if not
+Updates every property of the Session with the current status it has in OpenVidu Server. This is especially useful for accessing the list of active + connections to the Session (Session.activeConnections) and use those values to call Session.forceDisconnect or Session.forceUnpublish
+A promise resolved to true if the Session status has changed with respect to the server, or to false if not. + This applies to any property or sub-property of the Session object
+Forces the user with Connection connectionId
to leave the session. OpenVidu Browser will trigger the proper events on the client-side
+ (streamDestroyed
, connectionDestroyed
, sessionDisconnected
) with reason set to "forceDisconnectByServer"
You can get connection
parameter from Session.activeConnections array (Connection.connectionId for getting each connectionId
property).
+ Remember to call Session.fetch before to fetch the current actual properties of the Session from OpenVidu Server
A Promise that is resolved if the user was successfully disconnected and rejected with an Error object if not
+Forces some user to unpublish a Stream (identified by its streamId
or the corresponding Publisher object owning it).
+ OpenVidu Browser will trigger the proper events on the client-side (streamDestroyed
) with reason set to "forceUnpublishByServer"
.
You can get publisher
parameter from Connection.publishers array (Publisher.streamId for getting each streamId
property).
+ Remember to call Session.fetch before to fetch the current actual properties of the Session from OpenVidu Server
A Promise that is resolved if the stream was successfully unpublished and rejected with an Error object if not
+See Recording.status
+The name you want to give to the video file. You can access this same value in your clients on recording events (recordingStarted
, recordingStopped
)
The name you want to give to the video file. You can access this same value in your clients on recording events (recordingStarted
, recordingStopped
).
+ WARNING: this parameter follows an overwriting policy. If you name two recordings the same, the newest MP4 file will overwrite the oldest one
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
+ This property can only be defined if SessionProperties.defaultRecordingLayout is set to RecordingLayout.CUSTOM.You can easily override this value later by setting RecordingProperties.customLayout to any other value
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
+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
See Session.activeConnections
+