Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Stream

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)

Hierarchy

  • Stream

Implements

Index

Properties

audioActive

audioActive: boolean

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

connection

connection: Connection

The Connection object that is publishing the stream

creationTime

creationTime: number

Time when this stream was created in OpenVidu Server (UTC milliseconds). Depending on the owner of this stream:

  • Subscriber object: property creationTime is always defined
  • Publisher object: property creationTime is only defined after successful execution of Session.publish

filter

filter: Filter

WARNING: 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.

Optional frameRate

frameRate: undefined | number

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

hasAudio

hasAudio: boolean

Whether the stream has an audio track or not

hasVideo

hasVideo: boolean

Whether the stream has a video track or not

streamId

streamId: string

Unique identifier of the stream. If the stream belongs to a...

  • Subscriber object: property streamId is always defined
  • Publisher object: property streamId is only defined after successful execution of Session.publish

streamManager

streamManager: StreamManager

StreamManager object (Publisher or Subscriber) in charge of displaying this stream in the DOM

Optional typeOfVideo

typeOfVideo: undefined | string

"CAMERA", "SCREEN" or "CUSTOM" (the latter when PublisherProperties.videoSource is a MediaStreamTrack when calling OpenVidu.initPublisher). If hasVideo is false, this property is undefined

videoActive

videoActive: boolean

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

videoDimensions

videoDimensions: 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:

  • If it is a mobile device, whenever the user rotates the device.
  • If it is screen-sharing, whenever the user changes the size of the captured window.

Whenever this happens a StreamPropertyChangedEvent will be dispatched by the Session object as well as by the affected Subscriber/Publisher object

Type declaration

  • height: number
  • width: number

Methods

applyFilter

  • applyFilter(type: string, options: Object): Promise<Filter>
  • Applies an audio/video filter to the stream.

    Parameters

    • type: string

      Type of filter applied. See Filter.type

    • options: Object

      Parameters used to initialize the filter. See Filter.options

    Returns Promise<Filter>

    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

off

on

once

removeFilter

  • removeFilter(): Promise<any>
  • Removes an audio/video filter previously applied.

    Returns Promise<any>

    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