Class RemoteVideoTrack

Hierarchy (view full)

RemoteTrack<Video>
- RemoteVideoTrack

Index

Constructors

Properties

attachedElements isMuted kind sid? source streamState

Accessors

currentBitrate isAdaptiveStream mediaStreamTrack

Methods

attach detach getRTCStatsReport start startMonitor stop stopMonitor

Constructors

constructor

new RemoteVideoTrack(mediaTrack, sid, receiver?, adaptiveStreamSettings?, loggerOptions?): RemoteVideoTrack
Parameters
- mediaTrack: MediaStreamTrack
- sid: string
- Optional receiver: RTCRtpReceiver
- Optional adaptiveStreamSettings: AdaptiveStreamSettings
- Optional loggerOptions: LoggerOptions
Returns RemoteVideoTrack
Overrides RemoteTrack.constructor
- Defined in src/room/track/RemoteVideoTrack.ts:26

Properties

attachedElements

attachedElements: HTMLMediaElement[] = []

isMuted

isMuted: boolean = false

`Readonly` kind

kind: Video

`Optional` sid

sid?: string

sid is set after track is published to server, or if it's a remote track

source

source: Source

streamState

streamState: StreamState = Track.StreamState.Active

indicates current state of stream, it'll indicate paused if the track has been paused by congestion controller

Accessors

currentBitrate

get currentBitrate(): number
current receive bits per second

Returns number
Inherited from RemoteTrack.currentBitrate
- Defined in src/room/track/Track.ts:96

isAdaptiveStream

get isAdaptiveStream(): boolean
Returns boolean
- Defined in src/room/track/RemoteVideoTrack.ts:37

mediaStreamTrack

get mediaStreamTrack(): MediaStreamTrack
Note: When using adaptiveStream, you need to use remoteVideoTrack.attach() to add the track to a HTMLVideoElement, otherwise your video tracks might never start

Returns MediaStreamTrack
Overrides RemoteTrack.mediaStreamTrack
- Defined in src/room/track/RemoteVideoTrack.ts:44

Methods

attach

attach(): HTMLMediaElement
creates a new HTMLAudioElement or HTMLVideoElement, attaches to it, and returns it

Returns HTMLMediaElement
Overrides RemoteTrack.attach
- Defined in src/room/track/RemoteVideoTrack.ts:62
attach(element): HTMLMediaElement
attaches track to an existing HTMLAudioElement or HTMLVideoElement
Parameters
- element: HTMLMediaElement
Returns HTMLMediaElement
Overrides RemoteTrack.attach
- Defined in src/room/track/RemoteVideoTrack.ts:63

detach

detach(): HTMLMediaElement[]
Detaches from all attached elements

Returns HTMLMediaElement[]
Overrides RemoteTrack.detach
- Defined in src/room/track/RemoteVideoTrack.ts:130
detach(element): HTMLMediaElement
Detach from a single element
Parameters
- element: HTMLMediaElement
Returns HTMLMediaElement
Overrides RemoteTrack.detach
- Defined in src/room/track/RemoteVideoTrack.ts:131

getRTCStatsReport

getRTCStatsReport(): Promise<undefined | RTCStatsReport>
Gets the RTCStatsReport for the RemoteTrack's underlying RTCRtpReceiver See https://developer.mozilla.org/en-US/docs/Web/API/RTCStatsReport

Returns Promise<undefined | RTCStatsReport>
Promise | undefined
Inherited from RemoteTrack.getRTCStatsReport
- Defined in src/room/track/RemoteTrack.ts:67

start

start(): void
Returns void
Inherited from RemoteTrack.start
- Defined in src/room/track/RemoteTrack.ts:49

startMonitor

startMonitor(): void
Returns void
Inherited from RemoteTrack.startMonitor
- Defined in src/room/track/RemoteTrack.ts:76

stop

stop(): void
Returns void
Inherited from RemoteTrack.stop
- Defined in src/room/track/RemoteTrack.ts:55

stopMonitor

stopMonitor(): void
Returns void
Inherited from RemoteTrack.stopMonitor
- Defined in src/room/track/Track.ts:254

Generated using TypeDoc