@agatx/serenada-react-ui
    Preparing search index...

    Interface SerenadaCallFlowConfig

    interface SerenadaCallFlowConfig {
        autoHideControls?: boolean;
        avatarProvider?: AvatarProvider;
        debugOverlayEnabled?: boolean;
        inviteControlsEnabled?: boolean;
        requestPermissions?: (capabilities: MediaCapability[]) => Promise<boolean>;
        screenSharingEnabled?: boolean;
        snapshotEnabled?: boolean;
        videoEnabled?: boolean;
        videoMediaEnabled?: boolean;
    }
    Index

    Properties

    autoHideControls? avatarProvider? debugOverlayEnabled? inviteControlsEnabled? requestPermissions? screenSharingEnabled? snapshotEnabled? videoEnabled? videoMediaEnabled?

    Properties

    autoHideControls?: boolean

    When true (default), the call controls bar fades out after a few seconds of idle time and a tap on the stage brings it back. When false, the controls are always visible and the idle timer never runs.

    avatarProvider?: AvatarProvider

    Optional resolver that returns an avatar for a remote participant's host-supplied peerId (passed to SerenadaCore.join). When unset or when peerId is absent on the participant, the call UI shows an initials placeholder derived from their display name.

    debugOverlayEnabled?: boolean
    inviteControlsEnabled?: boolean
    requestPermissions?: (capabilities: MediaCapability[]) => Promise<boolean>

    Optional host-app permission requester. Electron/native hosts can use this to bridge OS-level media permission APIs that may disagree with browser navigator.permissions state.

    screenSharingEnabled?: boolean
    snapshotEnabled?: boolean

    When true, the call UI shows a circular "photo" button overlaid on the current large preview, anchored to its short edge (centered on the bottom for portrait sources, on the right for landscape). The button captures a snapshot of whichever stream is currently shown large. Defaults to false.

    videoEnabled?: boolean

    When true (default), the call UI shows the video on/off and camera mode (flip) controls and the SDK requests camera permission on join. When false, both controls are hidden and — for URL-first call flows — the internally-created session is configured with no camera modes so the camera is never requested. For session-first usage, host apps that want a fully audio-only call should also pass cameraModes: [] to the SerenadaConfig used to build the session.

    videoMediaEnabled?: boolean

    Whether the underlying session negotiates any video media at all. This mirrors SerenadaConfig.videoMediaEnabled and is distinct from videoEnabled: camera controls can be hidden while still receiving remote camera/content video. Defaults to true.

    Settings

    Member Visibility

    On This Page

    Properties