Interface VideoStreamIndex

[[VideoStreamIndex]] holds the set of video streams available on the server for subscription

interface VideoStreamIndex {
    allStreams(): VideoStreamIdSet;
    allVideoSendingSourcesExcludingSelf(selfAttendeeId: string): VideoSource[];
    attendeeIdForGroupId(groupId: number): string;
    attendeeIdForStreamId(streamId: number): string;
    attendeeIdForTrack(trackId: string): string;
    externalUserIdForTrack(trackId: string): string;
    groupIdForSSRC(ssrcId: number): number;
    groupIdForStreamId(streamId: number): number;
    highestQualityStreamFromEachGroupExcludingSelf(
        selfAttendeeId: string,
    ): VideoStreamIdSet;
    integrateBitratesFrame(bitrates: ISdkBitrateFrame): void;
    integrateIndexFrame(indexFrame: SdkIndexFrame): void;
    integrateSubscribeAckFrame(subscribeAck: SdkSubscribeAckFrame): void;
    integrateUplinkPolicyDecision(
        encodingParameters: RTCRtpEncodingParameters[],
    ): void;
    localStreamDescriptions(): VideoStreamDescription[];
    numberOfParticipants(): number;
    numberOfVideoPublishingParticipantsExcludingSelf(
        selfAttendeeId: string,
    ): number;
    overrideStreamIdMappings(previous: number, current: number): void;
    remoteStreamDescriptions(): VideoStreamDescription[];
    remoteVideoUpdateSent(): void;
    sendVideoStreamIdFromRid(rid: string): number;
    streamIdForSSRC(ssrcId: number): number;
    streamIdForTrack(trackId: string): number;
    StreamIdsInSameGroup(streamId1: number, streamId2: number): boolean;
    streamSelectionUnderBandwidthConstraint(
        selfAttendeeId: string,
        largeTileAttendeeIds: Set<string>,
        smallTileAttendeeIds: Set<string>,
        bandwidthKbps: number,
    ): VideoStreamIdSet;
    streamsPausedAtSource(): VideoStreamIdSet;
    subscribeFrameSent(): void;
}

Implemented by

Methods

allStreams allVideoSendingSourcesExcludingSelf attendeeIdForGroupId? attendeeIdForStreamId attendeeIdForTrack externalUserIdForTrack groupIdForSSRC? groupIdForStreamId highestQualityStreamFromEachGroupExcludingSelf integrateBitratesFrame integrateIndexFrame integrateSubscribeAckFrame integrateUplinkPolicyDecision localStreamDescriptions numberOfParticipants numberOfVideoPublishingParticipantsExcludingSelf overrideStreamIdMappings? remoteStreamDescriptions remoteVideoUpdateSent sendVideoStreamIdFromRid streamIdForSSRC streamIdForTrack StreamIdsInSameGroup streamSelectionUnderBandwidthConstraint streamsPausedAtSource subscribeFrameSent

Methods

allStreams

allVideoSendingSourcesExcludingSelf

OptionalattendeeIdForGroupId

attendeeIdForStreamId

attendeeIdForTrack

externalUserIdForTrack

OptionalgroupIdForSSRC

groupIdForStreamId

highestQualityStreamFromEachGroupExcludingSelf

integrateBitratesFrame

integrateIndexFrame

integrateSubscribeAckFrame

  • integrateSubscribeAckFrame(subscribeAck: SdkSubscribeAckFrame): void

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

    Parameters

    • subscribeAck: SdkSubscribeAckFrame

    Returns void

integrateUplinkPolicyDecision

  • integrateUplinkPolicyDecision(
        encodingParameters: RTCRtpEncodingParameters[],
    ): void

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

    Parameters

    • encodingParameters: RTCRtpEncodingParameters[]

    Returns void

localStreamDescriptions

numberOfParticipants

numberOfVideoPublishingParticipantsExcludingSelf

  • numberOfVideoPublishingParticipantsExcludingSelf(selfAttendeeId: string): number

    Returns the number of participants who are publishing videos excluding self

    Parameters

    • selfAttendeeId: string

    Returns number

OptionaloverrideStreamIdMappings

  • overrideStreamIdMappings(previous: number, current: number): void

    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

remoteStreamDescriptions

remoteVideoUpdateSent

  • remoteVideoUpdateSent(): 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

sendVideoStreamIdFromRid

streamIdForSSRC

streamIdForTrack

StreamIdsInSameGroup

  • StreamIdsInSameGroup(streamId1: number, streamId2: number): boolean

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

    Parameters

    • streamId1: number
    • streamId2: number

    Returns boolean

streamSelectionUnderBandwidthConstraint

  • streamSelectionUnderBandwidthConstraint(
        selfAttendeeId: string,
        largeTileAttendeeIds: Set<string>,
        smallTileAttendeeIds: Set<string>,
        bandwidthKbps: number,
    ): VideoStreamIdSet

    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 VideoStreamIdSet

streamsPausedAtSource

subscribeFrameSent

  • subscribeFrameSent(): void

    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

Settings

Member Visibility

On This Page

Methods