Class DefaultVideoStreamIndex

[[DefaultVideoStreamIndex]] implements [[VideoStreamIndex]] to facilitate video stream subscription and includes query functions for stream id and attendee id.

Hierarchy (View Summary)

Implements

Constructors

Properties

currentIndex: SdkIndexFrame
currentSubscribeAck: SdkSubscribeAckFrame
groupIdToAttendeeMap: Map<number, string>
indexForLastRemoteVideoUpdate: SdkIndexFrame
indexForSubscribe: SdkIndexFrame
logger: Logger
streamToAttendeeMap: Map<number, string>
streamToExternalUserIdMap: Map<number, string>
subscribeSsrcToGroupMap: Map<number, number>
subscribeSsrcToStreamMap: Map<number, number>
subscribeStreamToAttendeeMap: Map<number, string>
subscribeStreamToExternalUserIdMap: Map<number, string>
subscribeTrackToStreamMap: Map<string, number>

Methods

  • Returns attendee id for a group id

    Parameters

    • groupId: number

    Returns string

  • Returns attendee id for a stream id

    Parameters

    • streamId: number

    Returns string

  • Returns attendee id for a track id

    Parameters

    • trackId: string

    Returns string

  • Parameters

    • avgBitrateBps: number

    Returns number

  • Returns external user id for a track id

    Parameters

    • trackId: string

    Returns string

  • Returns a group id for an SSRC

    Parameters

    • ssrcId: number

    Returns number

  • Returns group id for a stream id

    Parameters

    • streamId: number

    Returns number

  • Saves [[SdkBitrateFrame]] in [[VideoStreamIndex]]

    Parameters

    • bitrates: ISdkBitrateFrame

    Returns void

  • Saves [[SdkIndexFrame]] in [[VideoStreamIndex]]

    Parameters

    • indexFrame: SdkIndexFrame

    Returns void

  • Saves [[SdkSubscribeAckFrame]] in [[VideoStreamIndex]]

    Parameters

    • subscribeAck: SdkSubscribeAckFrame

    Returns void

  • Updates cached local stream description array via uplink decisions, an array of [[RTCRtpEncodingParameters]]

    Parameters

    • param: RTCRtpEncodingParameters[]

    Returns void

  • Returns the number of video participants

    Returns number

  • Returns the number of participants who are publishing videos excluding self

    Parameters

    • selfAttendeeId: string

    Returns number

  • Override mappings using stream ID (i.e. for streamIdForTrack, and streamIdForSSRC) locally (i.e. without the need for a subscribe ACK message)

    Parameters

    • previous: number
    • current: number

    Returns void

  • This function caches the currently ingested index frame specifically as a backup for map functions like groupIdForStreamIdso that we can maintain information about previous senders simulcast streams to enable stream switching, e.g. if a sender is transmitting low/hi and switches to just low, receivers need the previously used index to be able to know what group ID the high stream corresponds to.

    Returns void

  • Returns send video stream ID that correspond to the Rid

    Parameters

    • _rid: string

    Returns number

  • Returns a stream id for an SSRC Id

    Parameters

    • ssrcId: number

    Returns number

  • Returns a stream id for a track id

    Parameters

    • trackId: string

    Returns number

  • Determines if the stream ID's are from the same group (client)

    Parameters

    • streamId1: number
    • streamId2: number

    Returns boolean

  • Return a selection set of streams for subscription based on self attendee id, size information of tiles, bandwidth limitation

    Parameters

    • selfAttendeeId: string
    • largeTileAttendeeIds: Set<string>
    • smallTileAttendeeIds: Set<string>
    • bandwidthKbps: number

    Returns DefaultVideoStreamIdSet

  • This function caches the currently ingested index frame for subscribe related activities (e.g. mapping tracks).

    The index will also use the stored index as a backup for map functions like groupIdForStreamIdso that we can maintain information about previous senders simulcast streams to enable stream switching, e.g. if a sender is transmitting low/hi and switches to just low, receivers need the previous index to be able to know what group ID the high stream corresponds to.

    Returns void