class ARCapture (Niantic.ARDK.Recording.ARCapture)

Overview

Native interface to the NAR POI AR Capture API (Recorder v2). More…

class ARCapture: IDisposable {
public:
    // classes

    class PInvoke;

    // methods

    ARCapture(Guid stageIdentifier);
    void Dispose();
    ARCaptureConfig GetCapturePaths();
    bool IsRecording();
    void SetApplicationName(String applicationName);
    void SetJSONMetadata(String jsonMetadata);
    void SetPointOfInterest(String pointOfInterest);
    void Start(ARCaptureConfig captureConfig);
    void Stop();
};

Detailed Documentation

Native interface to the NAR POI AR Capture API (Recorder v2).

Methods

ARCaptureConfig GetCapturePaths()

Retrieves the capture’s recording paths. The recorder must be started before calling this method.

Returns:

The recording path config used by the capture if a capture is running, empty paths otherwise

bool IsRecording()

Returns the capture’s recording status.

Returns:

true if a recording session is active.

void SetApplicationName(String applicationName)

Stores the name of the application. Calling this method multiple times will override previous calls. The recorder must be started before calling this method.

Parameters:

applicationName

The name of the application.

void SetJSONMetadata(String jsonMetadata)

Stores free-form, application-specific metadata. Calling this method multiple times will overwrite elements previously set. The recorder must be started before calling this method.

Parameters:

jsonMetadata

Well-formed JSON dictionary string.

void SetPointOfInterest(String pointOfInterest)

Stores the point of interest, represented as a string. Calling this method multiple times will override previous calls. The recorder must be started before calling this method.

Parameters:

pointOfInterest

The identifier of the point of interest.

void Start(ARCaptureConfig captureConfig)

Starts capturing an AR session.

void Stop()

Stops capturing a session.