C API Unity API
C API Reference (Version 10.22.5)
VuRecordingConfig Struct Reference

Detailed Description

Configuration options for a recording session.

Public Attributes

VuRecordingDataFlags dataFlags
 Bitmask specifying data to be recorded. More...
 
VuRecordingFrameRate frameRate
 The frame rate to record camera images at. More...
 
VuRecordingImageScale scale
 The scale applied to the camera images when recorded. More...
 
VuRecordingFormat format
 Recording format. More...
 
const char * outputDirectory
 Path to the directory where the recording should be stored. More...
 
VuBool start
 Flag to control whether a recording should start immediately on creation. More...
 
VuRecordingVideoEncodingQuality videoEncodingQuality
 Video encoding quality. More...
 

Member Data Documentation

◆ dataFlags

Bitmask specifying data to be recorded.

The bitmask should use the enum values from VuRecordingDataFlagBits as bit flags.

Note
vuRecordingConfigDefault() will set this flag to zero. It has to be populated explicitly with the desired data flags, otherwise starting the recording will fail.
Use vuSessionRecorderControllerGetDefaultDataFlags() to get the default data flags that are appropriate for the current device. The flags returned by that function will lead to a recording that can be used for playing back AR sessions.

◆ frameRate

The frame rate to record camera images at.

Note
vuRecordingConfigDefault() will set this to VU_RECORDING_FRAME_RATE_AUTO and the appropriate value will be determined automatically. To retrieve the actual value that is used for recordings on the current device, use vuSessionRecorderControllerGetDefaultRecordingFrameRate().
If overriding the default recording frame rate, please note that this feature is for advanced users who are sure that their devices are powerful enough to handle recording frame rates that are higher than the default.

◆ scale

The scale applied to the camera images when recorded.

Note
vuRecordingConfigDefault() will set this to VU_RECORDING_IMAGE_SCALE_AUTO and the appropriate value will be determined automatically. To retrieve the actual value that is used for recordings on the current device, use vuSessionRecorderControllerGetDefaultRecordingImageScale().
If overriding the default image scale, please note that this feature is for advanced users who are sure that their devices are powerful enough to handle recording camera images at a scale that is higher than the default.

◆ format

Recording format.

Note
The default value is VU_RECORDING_FORMAT_DEFAULT.

◆ outputDirectory

const char* outputDirectory

Path to the directory where the recording should be stored.

Note
This parameter is optional. The default value is NULL. The directory must exist and be writable throughout the lifetime of the recording. If no path is provided, Session Recorder will store the recording in an automatically determined location.
The provided string is copied, and can be freed, after the recording is created.

◆ start

VuBool start

Flag to control whether a recording should start immediately on creation.

Note
The default value is VU_FALSE.

◆ videoEncodingQuality

VuRecordingVideoEncodingQuality videoEncodingQuality

Video encoding quality.

Note
The default value is VU_RECORDING_VIDEO_ENCODING_QUALITY_HIGH.