Circle V2 API Docs
    Preparing search index...

    Type Alias SystemAudioControls

    Optional system-audio (loopback) controls. When provided, the ready state renders a toggle to also capture system audio (the far end of a call) and a permission hint when the OS hasn't granted system-audio recording yet. Kept generic (no IPC/permission-enum coupling) so the package stays app-agnostic.

    type SystemAudioControls = {
        captureUnavailable?: boolean;
        compatibilityModeEnabled?: boolean;
        enabled: boolean;
        needsPermission?: boolean;
        onEnableCompatibilityMode?: () => void;
        onOpenSettings?: () => void;
        onToggle: (enabled: boolean) => void;
    }
    Index

    Properties

    captureUnavailable? compatibilityModeEnabled? enabled needsPermission? onEnableCompatibilityMode? onOpenSettings? onToggle

    Properties

    captureUnavailable?: boolean

    True after a recording attempt where loopback was requested but produced no usable audio (e.g. a dead Core Audio Tap track). Drives the "couldn't capture" guidance, which is more reliable than a permission probe.

    compatibilityModeEnabled?: boolean

    Whether the legacy (ScreenCaptureKit) compatibility backend is already active.

    enabled: boolean
    needsPermission?: boolean

    When true, show guidance that system-audio recording isn't permitted yet.

    onEnableCompatibilityMode?: () => void

    Switch to the legacy capture backend and relaunch the app.

    onOpenSettings?: () => void
    onToggle: (enabled: boolean) => void

    Settings

    Member Visibility

    On This Page

    Properties