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

    Interface CallFlowProps

    interface CallFlowProps {
        className?: string;
        config?: SerenadaCallFlowConfig;
        onDismiss?: () => void;
        onEndCall?: () => void;
        onSnapshotCaptured?: (result: SnapshotResult) => void;
        onSnapshotError?: (error: SnapshotError) => void;
        onStatsUpdate?: (stats: CallStats | null) => void;
        serverHost?: string;
        session?: SerenadaSessionHandle;
        strings?: Partial<Record<SerenadaString, string>>;
        theme?: SerenadaCallFlowTheme;
        url?: string;
        waitingActions?: ReactNode;
    }
    Index

    Properties

    className? config? onDismiss? onEndCall? onSnapshotCaptured? onSnapshotError? onStatsUpdate? serverHost? session? strings? theme? url? waitingActions?

    Properties

    className?: string

    Optional CSS class name(s) applied to the root element for host-app style overrides.

    config?: SerenadaCallFlowConfig

    Feature toggles.

    onDismiss?: () => void

    Called when the call UI dismisses itself, such as cancel or the default end-call behavior.

    onEndCall?: () => void

    Called when the user taps the end-call button. When set, the host owns leaving and dismissal.

    onSnapshotCaptured?: (result: SnapshotResult) => void

    Called when the user taps the snapshot button (gated by SerenadaCallFlowConfig.snapshotEnabled) and a frame is successfully captured. The blob in result is the encoded image.

    onSnapshotError?: (error: SnapshotError) => void

    Called when a snapshot capture fails — for example when the underlying stream has gone inactive. The code field on the error narrows the cause; the call UI itself does not surface a user-visible error.

    onStatsUpdate?: (stats: CallStats | null) => void

    Callback fired when call stats are updated for host-owned diagnostics or bridge code.

    serverHost?: string

    Server host or origin, required when using url-first mode without an existing session.

    session?: SerenadaSessionHandle

    Provide an existing session handle — triggers session-first mode.

    strings?: Partial<Record<SerenadaString, string>>

    Localisation overrides.

    theme?: SerenadaCallFlowTheme

    Theme overrides.

    url?: string

    Full call URL — triggers URL-first mode (creates session internally).

    waitingActions?: ReactNode

    Optional host-app controls rendered in the waiting screen below default invite controls.

    Settings

    Member Visibility

    On This Page

    Properties