@pouchy_ai/companion-sdk - v0.78.1
    Preparing search index...

    Interface CallVideo

    A call's video avatar credentials (0.75.0; companion API 1.9.0). The server holds the Simli key and hands out a short-lived session bound to one of your project's READY faces — built with your admin key (admin-sdk createVideoFace, POST /v1/admin/video-faces).

    interface CallVideo {
        faceId: string;
        iceServers: { credential?: string; urls: string; username?: string }[];
        maxSessionLength: number;
        model: CallVideoModel;
        provider: "simli";
        sessionToken: string;
    }
    Index
    faceId iceServers maxSessionLength model provider sessionToken
    faceId: string
    iceServers: { credential?: string; urls: string; username?: string }[]

    For simli-client's P2P transport; may be empty — its LiveKit transport needs none.

    maxSessionLength: number

    Seconds Simli keeps the face open — the call window's own length.

    model: CallVideoModel

    The Simli animation model this session was minted with (0.76.0) — what you asked for in avatar.model, else fasttalk.

    provider: "simli"
    sessionToken: string

    For new SimliClient(sessionToken, videoEl, audioEl, iceServers).

    Settings
    Member Visibility

    On This Page
    Properties