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

Index

Properties

connection

connection: Connection

The Connection object that is publishing the stream

Optional frameRate

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

streamManager

streamManager: StreamManager

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

Optional typeOfVideo

typeOfVideo: string

"CAMERA" or "SCREEN". undefined if stream is audio-only

Generated using TypeDoc