The FFCLocalTrackPublication class represents a local track publication in the FlipFlopCloud SDK. It extends the FFCTrackPublication class and provides additional functionality specific to local tracks.

Hierarchy (View Summary)

Implements

  • IFFCLocalTrackPublication

Accessors

  • get dimensions(): undefined | Dimensions

    Gets the dimensions of the track (e.g., width and height).

    Returns undefined | Dimensions

    The dimensions as FFCTrack.Dimensions, or undefined if not available.

  • get isEnabled(): boolean

    Indicates whether the track is enabled.

    Returns boolean

    true if the track is enabled, otherwise false.

  • get isEncrypted(): boolean

    Indicates whether the track is encrypted.

    Returns boolean

    true if the track is encrypted, otherwise false.

  • get isLocal(): boolean

    Indicates whether the track is local.

    Returns boolean

    true because this is a local track publication.

  • get isMuted(): boolean

    Indicates whether the track is muted.

    Returns boolean

    true if the track is muted, otherwise false.

  • get isSubscribed(): boolean

    Indicates whether the track is subscribed.

    Returns boolean

    true if the track is subscribed, otherwise false.

  • get isUpstreamPaused(): undefined | boolean

    Indicates whether the upstream of the track is paused.

    Returns undefined | boolean

    true if the upstream is paused, otherwise false.

  • get kind(): Kind

    Gets the kind of the track (e.g., audio, video).

    Returns Kind

    The track kind as FFCTrack.Kind.

  • get mimeType(): undefined | string

    Gets the MIME type of the track.

    Returns undefined | string

    The MIME type as a string, or undefined if not available.

  • get simulcasted(): undefined | boolean

    Indicates whether the track is simulcast.

    Returns undefined | boolean

    true if the track is simulcast, otherwise false.

  • get source(): Source

    Gets the source of the track (e.g., camera, microphone).

    Returns Source

    The track source as FFCTrack.Source.

  • get trackInfo(): undefined | FFCTrackInfo

    Gets the track information.

    Returns undefined | FFCTrackInfo

    The track information as FFCTrackInfo, or undefined if not available.

  • get trackName(): string

    Gets the name of the track.

    Returns string

    The track name as a string.

  • get trackSid(): string

    Returns string

Methods

  • Gets the features of the audio track.

    Returns FFCAudioTrackFeature[]

    An array of FFCAudioTrackFeature instances representing the track features.

  • Pauses the upstream of the track.

    Returns Promise<void>

    A promise that resolves when the upstream is paused.

  • Resumes the upstream of the track.

    Returns Promise<void>

    A promise that resolves when the upstream is resumed.