Public Attributes
VuRecordingDataFlags	dataFlags
	Bitmask specifying data to be recorded.

VuRecordingFrameRate	frameRate
	The frame rate to record camera images at.

VuRecordingImageScale	scale
	The scale applied to the camera images when recorded.

VuRecordingFormat	format
	Recording format.

const char *	outputDirectory
	Path to the directory where the recording should be stored.

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

VuRecordingVideoEncodingQuality	videoEncodingQuality
	Video encoding quality.

Detailed Description

Configuration options for a recording session.

Member Data Documentation

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.

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.

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.

Recording format.

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.

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

Video encoding quality.