Interface LocalVideoTrack

A local video track that the application feeds with I420 frames. Create via createLocalVideoTrack.

interface LocalVideoTrack {
    enabled: boolean;
    kind: "video";
    name: string;
    getWriteStats(): WriteStats;
    write(frame: VideoFrameInput): boolean;
}

Index

Properties

enabled kind name

Methods

getWriteStats write

Properties

enabled

enabled: boolean

Whether the track is enabled; setting false publishes black/silent media without unpublishing.

`Readonly`kind

kind: "video"

Always 'video'.

`Readonly`name

name: string

Track name, unique across the local participant's published tracks.

Methods

getWriteStats

getWriteStats(): WriteStats

Publish-side counters for this track.

Returns WriteStats

write

write(frame: VideoFrameInput): boolean
Push an I420 frame into the track.

Buffers are copied synchronously, so the caller may reuse or free them as soon as this returns.

Throws TypeError/RangeError on invalid input (bad plane shape, non-finite integers, non-numeric timestamp, invalid rotation, plane buffer smaller than stride * height). Throws Error if the track is not bound to a source.

Returns true when the frame was forwarded to the encoder sink. Returns false when the frame was dropped - most commonly because the encoder sink has not attached yet (frames written before connect() resolves), but also when libwebrtc's adapter rate-limits or rejects the frame's resolution. Every false is counted in LocalVideoTrack.getWriteStats.
Parameters
- frame: VideoFrameInput
Returns boolean