@launchdarkly/observability + @launchdarkly/session-replay
    Preparing search index...

    Interface Record

    interface Record {
        getRecordingState: () => "NotRecording" | "Recording";
        getSession: () => null | SessionDetails;
        snapshot: (element: HTMLCanvasElement) => Promise<void>;
        start: (options?: StartOptions) => Promise<void>;
        stop: () => void;
        getHooks(metadata: LDPluginEnvironmentMetadata): Hook[];
        register(
            client: LDClientMin,
            environmentMetadata: LDPluginEnvironmentMetadata,
        ): void;
    }
    Index

    Properties

    getRecordingState getSession snapshot start stop

    Methods

    getHooks? register

    Properties

    getRecordingState: () => "NotRecording" | "Recording"
    getSession: () => null | SessionDetails
    snapshot: (element: HTMLCanvasElement) => Promise<void>

    Snapshot an HTML element in WebGL manual snapshotting mode. See https://www.highlight.io/docs/getting-started/browser/replay-configuration/canvas#manual-snapshotting for more information.

    start: (options?: StartOptions) => Promise<void>

    Start the session when running in manualStart mode. Can be used to force start a new session.

    Type declaration

      • (options?: StartOptions): Promise<void>

      • Parameters

        • Optionaloptions: StartOptions

          the session start options.

        Returns Promise<void>

    stop: () => void

    Stop the session recording.

    Methods

    • Parameters

      • metadata: LDPluginEnvironmentMetadata

      Returns Hook[]

    • Parameters

      • client: LDClientMin
      • environmentMetadata: LDPluginEnvironmentMetadata

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods