The FFCRemoteParticipant class represents a remote participant in the FlipFlopCloud SDK. It extends the FFCParticipant class and provides additional functionality specific to remote participants.

Hierarchy (View Summary)

Implements

  • IFFCRemoteParticipant

Accessors

  • get attributes(): Readonly<Record<string, string>>

    Gets the participant's attributes.

    Returns Readonly<Record<string, string>>

    A read-only record of the participant's attributes.

  • get audioLevel(): number

    Gets the participant's audio level.

    Returns number

    The audio level as a number.

  • set audioLevel(level: number): void

    Sets the participant's audio level.

    Parameters

    • level: number

      The audio level to set.

    Returns void

  • get identity(): string

    Gets the participant's identity.

    Returns string

    The participant's identity as a string.

  • get isAgent(): boolean

    Indicates whether the participant is an agent.

    Returns boolean

    true if the participant is an agent, otherwise false.

  • get isCameraEnabled(): boolean

    Indicates whether the participant's camera is enabled.

    Returns boolean

    true if the camera is enabled, otherwise false.

  • get isEncrypted(): boolean

    Indicates whether the participant's media is encrypted.

    Returns boolean

    true if the participant's media is encrypted, otherwise false.

  • get isLocal(): boolean

    Indicates whether the participant is local.

    Returns boolean

    true if the participant is local, otherwise false.

  • get isMicrophoneEnabled(): boolean

    Indicates whether the participant's microphone is enabled.

    Returns boolean

    true if the microphone is enabled, otherwise false.

  • get isScreenShareEnabled(): boolean

    Indicates whether the participant's screen sharing is enabled.

    Returns boolean

    true if screen sharing is enabled, otherwise false.

  • get isSpeaking(): boolean

    Indicates whether the participant is currently speaking.

    Returns boolean

    true if the participant is speaking, otherwise false.

  • get joinedAt(): undefined | Date

    Gets the date and time when the participant joined.

    Returns undefined | Date

    A Date object representing the join time, or undefined if not available.

  • get lastSpokeAt(): undefined | Date

    Gets the date and time when the participant last spoke.

    Returns undefined | Date

    A Date object representing the last time the participant spoke, or undefined if not available.

  • get metadata(): undefined | string

    Gets the participant's metadata.

    Returns undefined | string

    The participant's metadata as a string, or undefined if not set.

  • get name(): undefined | string

    Gets the participant's name.

    Returns undefined | string

    The participant's name as a string, or undefined if not set.

  • get permissions(): undefined | FFCParticipantPermission

    Gets the participant's permissions.

    Returns undefined | FFCParticipantPermission

    The participant's permissions as an FFCParticipantPermission instance, or undefined if not set.

  • get sid(): string

    Gets the participant's unique session identifier (SID).

    Returns string

    The participant's SID as a string.

Methods

  • Gets the volume level for a specific track source.

    Parameters

    • source: Microphone | ScreenShareAudio = FFCTrack.Source.Microphone

      The source of the track (e.g., microphone, screen share audio). Defaults to FFCTrack.Source.Microphone.

    Returns undefined | number

    The volume level as a number (0.0 to 1.0), or undefined if not available.

  • Sets the volume for a specific track source.

    Parameters

    • volume: number

      The volume level to set (0.0 to 1.0).

    • source: Microphone | ScreenShareAudio = FFCTrack.Source.Microphone

      The source of the track (e.g., microphone, screen share audio). Defaults to FFCTrack.Source.Microphone.

    Returns void