@byomakase/omakase-player
    Preparing search index...

    Interface OmakaseKeyframeConfig

    Configuration of the keyframe capability

    interface OmakaseKeyframeConfig {
        audioSrc?: string;
        callbackFn?: (keyframe: VideoKeyframe) => void;
        keyframeOptions?: VideoKeyframeOptions;
    }
    Index

    Properties

    audioSrc? callbackFn? keyframeOptions?

    Properties

    audioSrc?: string

    URL of an audio file played when a keyframe is extracted. Keyframes are extracted silently while not set

    callbackFn?: (keyframe: VideoKeyframe) => void

    Invoked with the keyframe extracted at the playhead. The capability is inactive while not set. The keyframe's src is an object URL that the callback function owns, and can release with URL.revokeObjectURL once it's no longer needed.

    keyframeOptions?: VideoKeyframeOptions

    Options of the extracted keyframes, e.g. their image format

    Settings

    Member Visibility

    On This Page

    Properties