Class Recorder

Hierarchy

  • EventEmitter
    • Recorder

Methods

prepare start pause resume stop cancel on once off emit

Methods

prepare

  • prepare(): Promise<BundleInfo>

  • Prepares the recording session for instant recording, allocating resources and validating the configuration.

    Preparing ahead of time lets start begin recording instantly; without it, starting incurs a setup delay.

    Returns Promise<BundleInfo>

    The expected BundleInfo describing the file assets that will be produced by this recording, allowing you to inspect the planned output (filenames, asset types, sizes) before recording starts.

start

  • start(): Promise<void>

  • Starts recording. If the session was not already prepared this performs setup first, incurring a short delay; call prepare ahead of time to start instantly.

    Returns Promise<void>

pause

  • pause(): Promise<void>

  • Pauses the recording. The capture hardware remains active so recording can be resumed quickly.

    Call resume to continue recording, or stop to finish.

    Returns Promise<void>

resume

  • resume(): Promise<void>

  • Resumes a recording that was previously paused with pause.

    Returns Promise<void>

stop

  • stop(): Promise<RecordingResult>

  • Stops the recording, finalizes the output files, and returns the RecordingResult describing the completed bundle. The recorder cannot be reused after stopping.

    Returns Promise<RecordingResult>

    Remarks

    Known limitation: when the recording failed, the returned promise rejects with the failure but the partial recording result is not available over the RPC bridge (the Swift API surfaces it as PartialResultError). Any partially-written files do remain on disk in the bundle inside the schema's output_directory.

cancel

  • cancel(): Promise<void>

  • Cancels the recording and releases its resources without finalizing output. Use this to discard an in-progress or prepared recording; call stop instead to keep the result.

    Returns Promise<void>

on

  • on(event, listener): this

  • Fires when the recording is aborted by an error or a system interruption.

    Parameters

    • event: "abort"
    • listener: ((reason) => void)
        • (reason): void

        • Parameters

          Returns void

    Returns this

once

  • once(event, listener): this

  • Parameters

    • event: "abort"
    • listener: ((reason) => void)
        • (reason): void

        • Parameters

          Returns void

    Returns this

    See

    Recorder.on

off

  • off(event, listener): this

  • Parameters

    • event: "abort"
    • listener: ((reason) => void)
        • (reason): void

        • Parameters

          Returns void

    Returns this

    See

    Recorder.on

emit

  • emit(event, reason): boolean

  • Parameters

    Returns boolean

    See

    Recorder.on

Settings

Member Visibility

Theme

On This Page

preparestartpauseresumestopcancelononceoffemit

Generated using TypeDoc