struct ARCaptureConfig (Niantic.ARDK.Recording.ARCaptureConfig)

Overview

Configs for AR captures. More…

struct ARCaptureConfig {
    // fields

    string ArchivePath;
    bool CaptureLidarIfAvailable;
    string WorkingDirectoryPath;

    // properties

    ARCaptureConfig Default;

    // methods

    ARCaptureConfig(string workingPath = null, string archivePath = null);
};

Detailed Documentation

Configs for AR captures.

Fields

string ArchivePath

The target destination file path for the archived capture data. This is the path to the archive file that will be created by the native API as soon as the capture is stopped. The client is responsible for deleting the file at this path after it is uploaded.

string WorkingDirectoryPath

The target destination folder path for capture data. This working directory will contain individual frames as JPEG files. It will be created by the native API as soon as the capture is started. The client is responsible for deleting this folder after the capture ends.

Methods

ARCaptureConfig(string workingPath = null, string archivePath = null)

Creates an ARCaptureConfig, with helpers to provide defaults.

Note

If this struct with all default values is desired, use the Default property instead.

Parameters:

workingPath	The target destination folder path for capture data. This working directory will contain individual frames as JPEG files. It will be created by the native API as soon as the capture is started. The client is responsible for deleting this folder after the capture ends. If null, the recorder picks a working path and deletes it after archiving.
archivePath	The target destination file path for the archived capture data. This is the path to the archive file that will be created by the native API as soon as the capture is stopped. The file must end with “.tgz” and be in a valid path. The client is responsible for deleting the file at this path after it is uploaded. If not given, appends “.tgz” to the working path.