@agatx/serenada-core
    Preparing search index...

    Interface SerenadaConfig

    SDK configuration passed to SerenadaCore.

    interface SerenadaConfig {
        cameraModes?: ConfigurableCameraMode[];
        defaultAudioEnabled?: boolean;
        defaultVideoEnabled?: boolean;
        deferInitialAnswer?: boolean;
        enableIndependentContentVideo?: boolean;
        enableOpusDtx?: boolean;
        enableOpusRed?: boolean;
        logger?: SerenadaLogger;
        serverHost?: string;
        signalingProvider?: SignalingProvider;
        transports?: TransportKind[];
        turnsOnly?: boolean;
        videoMediaEnabled?: boolean;
    }
    Index

    Properties

    cameraModes? defaultAudioEnabled? defaultVideoEnabled? deferInitialAnswer? enableIndependentContentVideo? enableOpusDtx? enableOpusRed? logger? serverHost? signalingProvider? transports? turnsOnly? videoMediaEnabled?

    Properties

    cameraModes?: ConfigurableCameraMode[]

    Camera modes available in the call UI, in preference order. The first entry is the initial mode. When only one mode is listed the flip-camera control is hidden; an empty array disables camera capture (the video toggle is hidden and the camera is never requested). Remote video and screen sharing remain available unless videoMediaEnabled is false. Modes unsupported on the current platform or device are silently dropped ('composite' is always dropped on web). Defaults to ['selfie', 'world', 'composite'].

    defaultAudioEnabled?: boolean

    Whether the microphone is enabled when joining. Defaults to true.

    defaultVideoEnabled?: boolean

    Whether the camera is enabled when joining. Defaults to true.

    deferInitialAnswer?: boolean

    When true, defer the initial-negotiation offer-timeout/ICE-restart while the host peer awaits its first answer. Use for app-owned calls whose answer is gated on a remote action that may take longer than the offer timeout, such as PSTN pickup. Defaults to false.

    enableIndependentContentVideo?: boolean

    Static capability gate for the independent screen-share content stream. When true, this build can negotiate a dedicated content video stream separate from the camera. Advertised to peers at join via capabilities.independentContentVideo. Immutable per session. Defaults to false. When enabled, capable peers use the independent content media path; legacy peers continue to use the single-video fallback.

    enableOpusDtx?: boolean

    Whether to request Opus discontinuous transmission (DTX) so silence uses substantially less bandwidth. Defaults to false.

    enableOpusRed?: boolean

    Whether to prefer/enable Opus RED (RFC 2198 redundancy for Opus audio codec) on audio transceivers for audio loss resilience. Defaults to false.

    logger?: SerenadaLogger

    Custom logger for SDK diagnostic output.

    serverHost?: string

    Bare host or full origin, e.g. serenada.app or http://qa-box:8080.

    signalingProvider?: SignalingProvider

    Custom signaling provider. Provide exactly one of serverHost or signalingProvider.

    transports?: TransportKind[]

    Signaling transport priority order. Defaults to ['ws', 'sse'].

    turnsOnly?: boolean

    When true, only use TURNS (TLS) relay candidates.

    videoMediaEnabled?: boolean

    Whether this call can negotiate any video media. Set to false for strict audio-only calls such as PSTN: camera capture, screen sharing, and remote video are all disabled. Defaults to true.

    Settings

    Member Visibility

    On This Page

    Properties