Class LocalVideoTrack

Hierarchy

LocalTrack
- LocalVideoTrack

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new LocalVideoTrack(mediaTrack: MediaStreamTrack, constraints?: MediaTrackConstraints): LocalVideoTrack

Overrides LocalTrack.constructor
- Defined in room/track/LocalVideoTrack.ts:18
Parameters
- mediaTrack: MediaStreamTrack
- Optional constraints: MediaTrackConstraints
Returns LocalVideoTrack

Properties

attachedElements

attachedElements: HTMLMediaElement[] = []

isMuted

isMuted: boolean = false

kind

kind: Kind

Optional mediaStream

mediaStream: MediaStream

mediaStreamTrack

mediaStreamTrack: MediaStreamTrack

Optional sid

sid: string

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

Optional signalClient

signalClient: SignalClient

source

source: Source

Accessors

currentBitrate

get currentBitrate(): number

- Defined in room/track/Track.ts:48
current receive bits per second

Returns number

dimensions

get dimensions(): undefined | Dimensions

- Defined in room/track/LocalTrack.ts:32
Returns undefined | Dimensions

id

get id(): string

- Defined in room/track/LocalTrack.ts:28
Returns string

isSimulcast

get isSimulcast(): boolean

- Defined in room/track/LocalVideoTrack.ts:27
Returns boolean

Methods

appVisibilityChangedListener

appVisibilityChangedListener(): void

Inherited from LocalTrack.appVisibilityChangedListener
- Defined in room/track/Track.ts:171
Returns void

attach

attach(): HTMLMediaElement
attach(element: HTMLMediaElement): HTMLMediaElement

Inherited from LocalTrack.attach
- Defined in room/track/Track.ts:55
creates a new HTMLAudioElement or HTMLVideoElement, attaches to it, and returns it

Returns HTMLMediaElement
Inherited from LocalTrack.attach
- Defined in room/track/Track.ts:60
attaches track to an existing HTMLAudioElement or HTMLVideoElement

Parameters
- element: HTMLMediaElement
Returns HTMLMediaElement

detach

detach(): HTMLMediaElement[]
detach(element: HTMLMediaElement): HTMLMediaElement

Inherited from LocalTrack.detach
- Defined in room/track/Track.ts:109
Detaches from all attached elements

Returns HTMLMediaElement[]
Inherited from LocalTrack.detach
- Defined in room/track/Track.ts:115
Detach from a single element

Parameters
- element: HTMLMediaElement
Returns HTMLMediaElement

getDeviceId

getDeviceId(): Promise<undefined | string>

Inherited from LocalTrack.getDeviceId
- Defined in room/track/LocalTrack.ts:50
Returns Promise<undefined | string>

DeviceID of the device that is currently being used for this track

getSenderStats

getSenderStats(): Promise<VideoSenderStats[]>

- Defined in room/track/LocalVideoTrack.ts:73
Returns Promise<VideoSenderStats[]>

mute

mute(): Promise<LocalVideoTrack>

Overrides LocalTrack.mute
- Defined in room/track/LocalVideoTrack.ts:54
Returns Promise<LocalVideoTrack>

restartTrack

restartTrack(options?: VideoCaptureOptions): Promise<void>

- Defined in room/track/LocalVideoTrack.ts:141
Parameters
- Optional options: VideoCaptureOptions
Returns Promise<void>

setDeviceId

setDeviceId(deviceId: string): Promise<void>

- Defined in room/track/LocalVideoTrack.ts:129
Parameters
- deviceId: string
Returns Promise<void>

setPublishingQuality

setPublishingQuality(maxQuality: VideoQuality): void

- Defined in room/track/LocalVideoTrack.ts:117
Parameters
- maxQuality: VideoQuality
Returns void

startMonitor

startMonitor(signalClient: SignalClient): void

- Defined in room/track/LocalVideoTrack.ts:35
Parameters
- signalClient: SignalClient
Returns void

stop

stop(): void

Overrides LocalTrack.stop
- Defined in room/track/LocalVideoTrack.ts:48
Returns void

unmute

unmute(): Promise<LocalVideoTrack>

Overrides LocalTrack.unmute
- Defined in room/track/LocalVideoTrack.ts:64
Returns Promise<LocalVideoTrack>

Generated using TypeDoc