Skip to main content

VideoRecorder.Options

Class

Configuration options for VideoRecorder.

  • Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.

Platform details

  • Snapchat — Fully supported.

  • SPECS — Fully supported.

  • Camera Kit Web — Fully supported.

  • Camera Kit Mobile — Fully supported.

Since Lens Scripting v320

Index

Constructors

Constructor

new Options(sourceTexture): Options

Parameters

ParameterType
sourceTextureTexture

Returns

Options

Properties

saveThumbnail

saveThumbnail: boolean

Whether to also save the first recorded frame as a still image to use as a placeholder when the VideoTextureProvider is not playing.

Since

Lens Scripting Version 320

Default Value

true

sourceTexture

readonly sourceTexture: Texture

Read back the Texture used to construct the Options.

Since

Lens Scripting Version 320


textureScale

textureScale: number

A scalar on the resolution of the input Texture to the video. Can be used to scale down a large Texture during recording to avoid extra overhead.

Since

Lens Scripting Version 320

Default Value

1

Methods

getTypeName()

static getTypeName(): TypeName<Options>

Returns the fully-qualified JavaScript type name for this class (for example, "Component.Camera"). This is a static accessor (no instance required) and returns the same value as the instance getTypeName().

Returns

TypeName<Options>

Since

Lens Scripting Version 320