D-ID Client SDK - v3.0.0-0
    Preparing search index...

    Interface StreamOptions

    Transport settings applied when the stream is created.

    Talks (V2) and Clips (V3) agents only. Expressive (V4) agents manage transport settings automatically and ignore these options. Pass the object as AgentManagerOptions.streamOptions; every field is optional.

    interface StreamOptions {
        compatibilityMode?: CompatibilityMode;
        fluent?: boolean;
        sessionTimeout?: number;
        streamWarmup?: boolean;
    }
    Index
    compatibilityMode?: CompatibilityMode

    Which video codec the stream negotiates.

    See CompatibilityMode.

    auto
    
    fluent?: boolean

    Whether to request a fluent stream.

    true streams one video for both the idle and talking states; false uses the legacy mode, where the application swaps between two video elements. Clips (V3) agents built on a Pro avatar; always on for Expressive (V4). A fluent stream is also what makes interrupt() available.

    false
    
    sessionTimeout?: number

    How long the session may sit idle between messages before the server ends it, in seconds.

    Up to 300, and only for accounts whose plan allows it. When the session does time out, onConnectionStateChange reports 'disconnected' with the reason 'inactivity'. Leave it out and the server decides.

    streamWarmup?: boolean

    Whether the stream plays a warmup video while the connection settles.

    With it on the server plays a short warmup video as soon as the connection is up, and the SDK holds back 'connected' — and so the resolution of connect() — until that video has played out. Without it, 'connected' is reported as soon as the data channel opens. The application sees nothing of the warmup video itself beyond the delay; it is not distinguishable from any other. A fluent stream ignores the option — the warmup only runs on legacy streams (see fluent).

    false