Skip to main content

Interface: RecordVideoOptions

Properties​

fileType​

• Optional fileType: "mov" | "mp4"

Specifies the output file type to record videos into.

Defined in​

VideoFile.ts:12

flash​

• Optional flash: "off" | "on"

Set the video flash mode. Natively, this just enables the torch while recording.

Defined in​

VideoFile.ts:8

onRecordingError​

• onRecordingError: (error: CameraCaptureError) => void

Type declaration​

▸ (error): void

Called when there was an unexpected runtime error while recording the video.

Parameters​
NameType
errorCameraCaptureError
Returns​

void

Defined in​

VideoFile.ts:16

onRecordingFinished​

• onRecordingFinished: (video: VideoFile) => void

Type declaration​

▸ (video): void

Called when the recording has been successfully saved to file.

Parameters​
NameType
videoVideoFile
Returns​

void

Defined in​

VideoFile.ts:20

videoBitRate​

• Optional videoBitRate: number | "low" | "normal" | "high"

The bit-rate for encoding the video into a file, in Mbps (Megabits per second).

Bit-rate is dependant on various factors such as resolution, FPS, pixel format (whether it's 10 bit HDR or not), and codec.

By default, it will be calculated using those factors. For example, at 1080p, 30 FPS, H.264 codec, without HDR it will result to 10 Mbps.

Default

'normal'

Defined in​

VideoFile.ts:37

videoCodec​

• Optional videoCodec: "h264" | "h265"

The Video Codec to record in.

  • h264: Widely supported, but might be less efficient, especially with larger sizes or framerates.
  • h265: The HEVC (High-Efficient-Video-Codec) for higher efficient video recordings.

Defined in​

VideoFile.ts:26