Local connection to the Session. This object is defined only after Session.connect has been successfully executed, and can be retrieved subscribing to connectionCreated event
Unique identifier of the Session. This is the same value you pass when calling OpenVidu.initSession
Connects to the session using token. Parameter metadata allows you to pass extra data to share with other users when
they receive streamCreated event. The structure of metadata string is up to you (maybe some standarized format
as JSON or XML is a good idea), the only restriction is a maximum length of 10000 chars.
This metadata is not considered secure, as it is generated in the client side. To pass securized data, add it as a parameter in the token generation operation (through the API REST, openvidu-java-client or openvidu-node-client).
Only after the returned Promise is successfully resolved Session.connection object will be available and properly defined.
The Session object of the local participant will first dispatch one or more connectionCreated events upon successful termination of this method:
connectionCreated event when they do so.The Session object of the local participant will also dispatch a streamCreated event for each remote active Publisher after dispatching all remote
connectionCreated events.
The Session object of every other participant connected to the session will dispatch a connectionCreated event.
See ConnectionEvent and StreamEvent to learn more.
A Promise to which you must subscribe that is resolved if the recording successfully started and rejected with an Error object if not
Connects to the session using token. Parameter metadata allows you to pass extra data to share with other users when
they receive streamCreated event. The structure of metadata string is up to you (maybe some standarized format
as JSON or XML is a good idea), the only restriction is a maximum length of 10000 chars.
This metadata is not considered secure, as it is generated in the client side. To pass securized data, add it as a parameter in the token generation operation (through the API REST, openvidu-java-client or openvidu-node-client).
Only after the returned Promise is successfully resolved Session.connection object will be available and properly defined.
The Session object of the local participant will first dispatch one or more connectionCreated events upon successful termination of this method:
connectionCreated event when they do so.The Session object of the local participant will also dispatch a streamCreated event for each remote active Publisher after dispatching all remote
connectionCreated events.
The Session object of every other participant connected to the session will dispatch a connectionCreated event.
See ConnectionEvent and StreamEvent to learn more.
A Promise to which you must subscribe that is resolved if the recording successfully started and rejected with an Error object if not
Leaves the session, destroying all streams and deleting the user as a participant.
The Session object of the local participant will dispatch a sessionDisconnected event.
This event will automatically unsubscribe the leaving participant from every Subscriber object of the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
and also delete the HTML video element associated to it.
Call event.preventDefault() to avoid this beahviour and take care of disposing and cleaning all the Subscriber objects yourself. See SessionDisconnectedEvent to learn more.
The Publisher object of the local participant will dispatch a streamDestroyed event if there is a Publisher object publishing to the session.
This event will automatically stop all media tracks and delete the HTML video element associated to it.
Call event.preventDefault() if you want clean the Publisher object yourself or re-publish it in a different Session (to do so it is a mandatory
requirement to call Session.unpublish() or/and Session.disconnect() in the previous session). See StreamEvent to learn more.
The Session object of every other participant connected to the session will dispatch a streamDestroyed event if the disconnected participant was publishing.
This event will automatically unsubscribe the Subscriber object from the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks)
and delete the HTML video element associated to it.
Call event.preventDefault() to avoid this default behaviour and take care of disposing and cleaning the Subscriber object yourself. See StreamEvent to learn more.
The Session object of every other participant connected to the session will dispatch a connectionDestroyed event in any case. See ConnectionEvent to learn more.
Publishes the participant's audio-video stream contained in publisher object to the session
The local Publisher object will dispatch a streamCreated event upon successful termination of this method. See StreamEvent to learn more.
The local Publisher object will dispatch a remoteVideoPlaying event only if Publisher.subscribeToRemote was called before this method, once the remote video starts playing.
See VideoElementEvent to learn more.
The Session object of every other participant connected to the session will dispatch a streamCreated event so they can subscribe to it. See StreamEvent to learn more.
A Promise (to which you can optionally subscribe to) that is resolved if the publisher was successfully published and rejected with an Error object if not
Sends one signal. signal object has the following optional properties:
{data:string, to:Connection[], type:string}
All users subscribed to that signal (session.on('signal:type', ...) or session.on('signal', ...) for all signals) and whose Connection objects are in to array will receive it. Their local
Session objects will dispatch a signal or signal:type event. See SignalEvent to learn more.
A Promise (to which you can optionally subscribe to) that is resolved if the message successfully reached openvidu-server and rejected with an Error object if not. This doesn't mean that openvidu-server could resend the message to all the listed receivers.
Subscribes to a stream, adding a new HTML video element to DOM with subscriberProperties settings. This method is usually called in the callback of streamCreated event.
The Subscriber object will dispatch a videoElementCreated event once the HTML video element has been added to DOM (if targetElement not null or undefined)
The Subscriber object will dispatch a videoPlaying event once the remote video starts playing (only if videoElementCreated event has been previously dispatched)
See VideoElementEvent to learn more.
Stream object to subscribe to
HTML DOM element (or its id attribute) in which the video element of the Subscriber will be inserted (see SubscriberProperties.insertMode). If null or undefined no default video will be created for this Subscriber
(you can always access the native MediaStream object by calling Subscriber.stream.getMediaStream() and use it as srcObject of any HTML video element)
Subscribes to a stream, adding a new HTML video element to DOM with subscriberProperties settings. This method is usually called in the callback of streamCreated event.
The Subscriber object will dispatch a videoElementCreated event once the HTML video element has been added to DOM (if targetElement not null or undefined)
The Subscriber object will dispatch a videoPlaying event once the remote video starts playing (only if videoElementCreated event has been previously dispatched)
See VideoElementEvent to learn more.
Stream object to subscribe to
HTML DOM element (or its id attribute) in which the video element of the Subscriber will be inserted (see SubscriberProperties.insertMode). If null or undefined no default video will be created for this Subscriber
(you can always access the native MediaStream object by calling Subscriber.stream.getMediaStream() and use it as srcObject of any HTML video element)
Subscribes to a stream, adding a new HTML video element to DOM with subscriberProperties settings. This method is usually called in the callback of streamCreated event.
The Subscriber object will dispatch a videoElementCreated event once the HTML video element has been added to DOM (if targetElement not null or undefined)
The Subscriber object will dispatch a videoPlaying event once the remote video starts playing (only if videoElementCreated event has been previously dispatched)
See VideoElementEvent to learn more.
Stream object to subscribe to
HTML DOM element (or its id attribute) in which the video element of the Subscriber will be inserted (see SubscriberProperties.insertMode). If null or undefined no default video will be created for this Subscriber
(you can always access the native MediaStream object by calling Subscriber.stream.getMediaStream() and use it as srcObject of any HTML video element)
error parameter is null if subscribe succeeds, and is defined if it fails.
Subscribes to a stream, adding a new HTML video element to DOM with subscriberProperties settings. This method is usually called in the callback of streamCreated event.
The Subscriber object will dispatch a videoElementCreated event once the HTML video element has been added to DOM (if targetElement not null or undefined)
The Subscriber object will dispatch a videoPlaying event once the remote video starts playing (only if videoElementCreated event has been previously dispatched)
See VideoElementEvent to learn more.
Stream object to subscribe to
HTML DOM element (or its id attribute) in which the video element of the Subscriber will be inserted (see SubscriberProperties.insertMode). If null or undefined no default video will be created for this Subscriber
(you can always access the native MediaStream object by calling Subscriber.stream.getMediaStream() and use it as srcObject of any HTML video element)
error parameter is null if subscribe succeeds, and is defined if it fails.
Promisified version of Session.subscribe
Unpublishes the participant's audio-video stream contained in publisher object.
The Publisher object of the local participant will dispatch a streamDestroyed event.
This event will automatically stop all media tracks and delete the HTML video element associated to it.
Call event.preventDefault() if you want clean the Publisher object yourself or re-publish it in a different Session.
The Session object of every other participant connected to the session will dispatch a streamDestroyed event.
This event will automatically unsubscribe the Subscriber object from the session (this includes closing the WebRTCPeer connection and disposing all MediaStreamTracks) and delete the HTML video element associated to it.
Call event.preventDefault() to avoid this default behaviour and take care of disposing and cleaning the Subscriber object yourself.
See StreamEvent to learn more.
Unsubscribes from subscriber, automatically removing its HTML video element.
The Subscriber object will dispatch a videoElementDestroyed event (only if it previously dispatched a videoElementCreated event). See VideoElementEvent to learn more
Generated using TypeDoc
Represents a video call. It can also be seen as a videoconference room where multiple users can connect. Participants who publish their videos to a session will be seen by the rest of users connected to that specific session. Initialized with OpenVidu.initSession method