interface IARRecorder (Niantic.ARDK.Recording.IARRecorder)

Overview

Used to record an AR session. More…

interface IARRecorder {
    // methods

    void ArchiveWorkingDirectory(
        String sourceDirectoryPath,
        String destinationArchivePath
    );

    void CancelPreview();
    void CancelResearch();
    void CancelUnpack();
    float PreviewProgress();
    float ResearchProgress();
    void SetApplicationName(String applicationName);
    void SetPointOfInterest(String pointOfInterest);
    void Start(ARRecorderConfig recordingConfig);

    void Stop(
        ARRecordingPreviewConfig previewConfig,
        Action<ARRecordingPreviewResults> previewCallback,
        ARRecordingResearchConfig researchConfig,
        Action<ARRecordingResearchResults> researchCallback,
        ARRecordingUnpackConfig unpackConfig,
        Action<ARRecordingUnpackResults> unpackCallback
    );

    float UnpackProgress();
};

// direct descendants

class NativeARRecorder;

Detailed Documentation

Used to record an AR session.

Methods

void ArchiveWorkingDirectory(
    String sourceDirectoryPath,
    String destinationArchivePath
)

Archives temporary AR recording directories into a gzipped .tar

Parameters:

sourceDirectoryPath

The source directory path to archive.

destinationArchivePath

Target destination archive path.

void CancelPreview()

Cancel processing the preview video for an AR recording Causes the preview callback to be called immediately

void CancelResearch()

Cancel processing the research data for an AR recording. Causes the researchs callback to be called immediately

void CancelUnpack()

Cancels progress for unpacking raw frames.

float PreviewProgress()

Get the progress for processing the preview video for an AR Recording.

Returns:

a value between 0 and 1

float ResearchProgress()

Get the progress for processing research data for an AR Recording.

Returns:

a value between 0 and 1

void SetApplicationName(String applicationName)

Stores the name of the application. Calling this method multiple times will add multiple entries to recording data The recorder must be started before calling this method

void SetPointOfInterest(String pointOfInterest)

Stores the point of interest, represented as a string. Calling this method multiple times will add multiple entries to recording data The recorder must be started before calling this method

void Start(ARRecorderConfig recordingConfig)

Starts recording an AR session.

Parameters:

recordingConfig

The configs to use for this recording.

void Stop(
    ARRecordingPreviewConfig previewConfig,
    Action<ARRecordingPreviewResults> previewCallback,
    ARRecordingResearchConfig researchConfig,
    Action<ARRecordingResearchResults> researchCallback,
    ARRecordingUnpackConfig unpackConfig,
    Action<ARRecordingUnpackResults> unpackCallback
)

Stops recording a session.

Parameters:

previewConfig

Preview config for recordings.

previewCallback

The callback to call once preview post-processing on the recording has finished.

researchConfig

Research config for recordings.

researchCallback

The callback to call once research post-processing on the recording has finished.

unpackConfig

Configs for unpacking the frames raw to a directory.

unpackCallback

The callback to call when unpacking is finished.

float UnpackProgress()

The progress of unpacking a recording into raw frames.

Returns: