Whether the stream has the audio track muted or unmuted. If hasAudio is false, this property is undefined
This property may change if the Publisher publishing the stream calls Publisher.publishAudio. Whenever this happens a StreamPropertyChangedEvent will be dispatched by the Session object as well as by the affected Subscriber/Publisher object
The Connection object that is publishing the stream
Time when this stream was created in OpenVidu Server (UTC milliseconds). Depending on the owner of this stream:
creationTime is always definedcreationTime is only defined after successful execution of Session.publishWARNING: experimental option. This interface may change in the near future
Filter applied to the Stream. You can apply filters by calling Stream.applyFilter, execute methods of the applied filter with
Filter.execMethod and remove it with Stream.removeFilter. Be aware that the client calling this methods must have the
necessary permissions: the token owned by the client must have been initialized with the appropriated allowedFilters array.
Frame rate of the video in frames per second. This property is only defined if the Publisher of the stream was initialized passing a frameRate property on OpenVidu.initPublisher method
Whether the stream has an audio track or not
Whether the stream has a video track or not
Unique identifier of the stream. If the stream belongs to a...
streamId is always definedstreamId is only defined after successful execution of Session.publishStreamManager object (Publisher or Subscriber) in charge of displaying this stream in the DOM
Can be:
"CAMERA": when the video source comes from a webcam."SCREEN": when the video source comes from screen-sharing."CUSTOM": when PublisherProperties.videoSource has been initialized in the Publisher side with a custom MediaStreamTrack when calling OpenVidu.initPublisher)."IPCAM": when the video source comes from an IP camera participant instead of a regular participant (see IP cameras).If hasVideo is false, this property is undefined
Whether the stream has the video track muted or unmuted. If hasVideo is false, this property is undefined.
This property may change if the Publisher publishing the stream calls Publisher.publishVideo. Whenever this happens a StreamPropertyChangedEvent will be dispatched by the Session object as well as by the affected Subscriber/Publisher object
Width and height in pixels of the encoded video stream. If hasVideo is false, this property is undefined
This property may change if the Publisher that is publishing:
Whenever this happens a StreamPropertyChangedEvent will be dispatched by the Session object as well as by the affected Subscriber/Publisher object
Applies an audio/video filter to the stream.
Type of filter applied. See Filter.type
Parameters used to initialize the filter. See Filter.options
A Promise (to which you can optionally subscribe to) that is resolved to the applied filter if success and rejected with an Error object if not
Returns the internal MediaStream object associated to this stream (https://developer.mozilla.org/en-US/docs/Web/API/MediaStream)
Native MediaStream Web API object
Returns the internal RTCPeerConnection object associated to this stream (https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection)
Native RTCPeerConnection Web API object
Recreates the media connection with the server. This entails the disposal of the previous RTCPeerConnection and the re-negotiation of a new one, that will apply the same properties.
This method can be useful in those situations were there the media connection breaks and OpenVidu is not able to recover on its own for any kind of unanticipated reason (see Automatic reconnection).
A Promise (to which you can optionally subscribe to) that is resolved if the reconnection operation was successful and rejected with an Error object if not
Removes an audio/video filter previously applied.
A Promise (to which you can optionally subscribe to) that is resolved if the previously applied filter has been successfully removed and rejected with an Error object in other case
Generated using TypeDoc
Represents each one of the media streams available in OpenVidu Server for certain session. Each Publisher and Subscriber has an attribute of type Stream, as they give access to one of them (sending and receiving it, respectively)