LiveKit JS Server SDK - v2.17.0
    Preparing search index...

    Type Alias ClientOptions

    Options common to all clients

    type ClientOptions = {
        failover?: boolean;
        requestTimeout?: number;
        token?: string;
    }
    Index

    Properties

    failover? requestTimeout? token?

    Properties

    failover?: boolean

    Whether to fail over to alternative regions on retryable errors (LiveKit Cloud hosts only). Defaults to true; set to false to disable.

    requestTimeout?: number

    Optional timeout, in seconds, for all server requests

    token?: string

    A pre-signed access token, sent verbatim as the Authorization header on every request instead of signing one per call from an API key and secret. The token must already carry the grants for the calls it's used with; since it needs no secret, the client can run client-side.

    Settings

    Member Visibility

    On This Page

    Properties