class PInvoke (Niantic.ARDK.Recording.NativeARRecorder.PInvoke)

Overview

The pinvokes that call down to the native side of the code. More…

class PInvoke {
public:
    // methods

    static void ArchiveWorkingDirectory(ArchiveConfig config);
    static void CancelPreview(HandleRef nativeHandle);
    static void CancelResearch(HandleRef nativeHandle);
    static void CancelUnpack(HandleRef nativeHandle);
    static unsafe IntPtr Ctor(void* uuidPtr);
    static void Dtor(HandleRef nativeHandle);
    static float PreviewProgress(HandleRef nativeHandle);
    static float ResearchProgress(HandleRef nativeHandle);

    static void SetApplicationName(
        HandleRef nativeHandle,
        ARSetApplicationInfoConfig config
    );

    static void SetPointOfInterest(
        HandleRef nativeHandle,
        ARSetPointOfInterestConfig config
    );

    static void Start(HandleRef nativeHandle, ARRecorderConfig config);

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

    static float UnpackProgress(HandleRef nativeHandle);
    unsafe IntPtr _NARRecorder_Init(void* uuidPtr);
    void _NARRecorder_Release(IntPtr nativeHandle);
    void _NARRecorder_Start(IntPtr nativeHandle, ARRecorderConfig config);
};

Detailed Documentation

The pinvokes that call down to the native side of the code.

Methods

static void ArchiveWorkingDirectory(ArchiveConfig config)

Archives temporary AR recording directories into a gzipped .tar

static void CancelPreview(HandleRef nativeHandle)

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

static void CancelResearch(HandleRef nativeHandle)

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

static void CancelUnpack(HandleRef nativeHandle)

Cancel the processing of unpacking AR frames into a directory.

static unsafe IntPtr Ctor(void* uuidPtr)

Constructs the recorder.

Parameters:

uuidPtr

Ptr to the UUID in memory.

Returns:

The native ptr to this object (or a ptr that can be used with the native side code).

static void Dtor(HandleRef nativeHandle)

Destroys the recorder.

Parameters:

nativeHandle

The handle to the native object.

static float PreviewProgress(HandleRef nativeHandle)

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

Returns:

a value between 0 and 1

static float ResearchProgress(HandleRef nativeHandle)

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

Returns:

a value between 0 and 1

static void SetApplicationName(
    HandleRef nativeHandle,
    ARSetApplicationInfoConfig config
)

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

static void SetPointOfInterest(
    HandleRef nativeHandle,
    ARSetPointOfInterestConfig config
)

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

static void Start(HandleRef nativeHandle, ARRecorderConfig config)

Starts recording on the given recorder.

Parameters:

nativeHandle

The native handle to the recorder.

config

The config to use for recording.

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

Stops recording on the native side code.

Parameters:

nativeHandle

The native recorder to stop recording on.

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.

static float UnpackProgress(HandleRef nativeHandle)

Get the progress of unpacking frames into a directory.

Returns:

a value between 0 and 1