Interface

Recording

:

Screen recording control handle.

group Data

pause

(): void

Pause the recording.

resume

(): void

Resume the recording.

stop

(): Promise<Blob>

Stop the recording and get the video data as a Blob. This finalizes the recording, so trying to do anything else with it later will throw an error.

since v3000.0

download

(filename?: string): void

Stop the recording and downloads the file. Like stop(), this finalizes the recording, and trying to do anything else with it later will throw an error.

param filename- The suggested file name to initially present to the player (they can always change it in their browser's save dialog). If none is specified the format is 'kaplay-{current date and time}.{file extension}'.

mimeType

: string

The currently used MIME type that was selected when the recording was started.

fileExt

: string

The recommended file extension for the output file, minus the dot. For MP4 this will be "mp4", for WEBM, "webm", etc. This value is calculated using the MIME type and so it might be wrong. For example if you're in Safari and manage to get a recording started using the video/quicktime format, this property will report "quicktime", even though the correct file extension is .mov.

kaplay logo

Components

Miscalenous