Member Junction
    Preparing search index...

    Interface IVideoFrameSink

    The slice of a realtime client the arbiter writes to. BaseRealtimeClient satisfies it structurally, and tests satisfy it with a plain object.

    interface IVideoFrameSink {
        InboundVideoRate: number;
        MaxInboundVideoStreams: number;
        IsTrackEstablished(
            modality: string,
            direction: RealtimeTrackDirection,
        ): boolean;
        SendContextNote(text: string): void;
        SendVideoFrame?(
            base64Image: string,
            mimeType?: string,
            sourceId?: string,
        ): boolean;
    }
    Index

    Properties

    InboundVideoRate MaxInboundVideoStreams

    Methods

    IsTrackEstablished SendContextNote SendVideoFrame?

    Properties

    InboundVideoRate: number

    The negotiated inbound video rate in frames per second, or undefined when none was negotiated.

    MaxInboundVideoStreams: number

    How many concurrent inbound video streams the model accepts. 0 when none is live (no video track negotiated), 1 for every model shipped so far.

    Methods

    • Streams one frame to the model, tagged with the source that produced it. Optional because most drivers have no video; a sink without it makes the arbiter inert.

      Parameters

      • base64Image: string
      • OptionalmimeType: string
      • OptionalsourceId: string

      Returns boolean

      true if the frame was sent.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods