Class LocalTrack

A Track is used to interact with participant tracks.

Hierarchy

Properties

attachedElements deviceId? height kind muted name source tid track width

Methods

attach detach getKind getSource hasMedia isMuted mute stop unMute

Properties

attachedElements

attachedElements: HTMLMediaElement[] = []

An array of all HTMLMediaElements that this track is currently attached to.

Optional deviceId

deviceId?: string

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

Note deviceId is not supported for screen shares in Firefox and will be undefined

height

height: number

The height of the track if this is a video track

kind

kind: TrackKind

The kind of track. Can be TrackKind.Video or TrackKind.Audio

muted

muted: boolean

The mute status of this track

name

name: string

A name for this track

source

source: TrackSource = TrackSource.Unknown

The source of this track set when the track is created

tid

tid: string

A unique id for this track.

track

track: MediaStreamTrack

The MediaStreamTrack that contains the media for this track

width

width: number

The width of the track if this is a video track

Methods

attach

  • Attach this track to an existing HTMLMediaElement

    Returns

    The existing HTMLMediaElement with the track attached

    Parameters

    • element: HTMLMediaElement

      A HTMLMediaElement to attach the track to.

    Returns HTMLMediaElement

  • Attach this track to a new HTMLMediaElement

    Returns

    A new HTMLMediaElement with the track attached.

    Returns HTMLMediaElement

detach

  • Detach this track from an existing HTMLMediaElement

    Returns

    The existing HTMLMediaElement with the track detached

    Parameters

    • element: HTMLMediaElement

      A HTMLMediaElement to detach the track from.

    Returns HTMLMediaElement[]

  • Detach this track from all attached elements

    Returns

    all elements with the track detached

    Returns HTMLMediaElement[]

getKind

getSource

hasMedia

  • Checks whether this track has a MediaStreamTrack

    Returns

    True if the Track has a MediaStreamTrack.

    Returns boolean

isMuted

  • Get the mute status of this track

    Returns

    True if the track is muted.

    Returns boolean

mute

stop

unMute

Settings

Member Visibility

Theme

Generated using TypeDoc