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

Overview

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

class PInvoke {
public:
    // methods

    static unsafe IntPtr Ctor(void* uuidPtr);
    static void Dtor(HandleRef nativeHandle);
    static ARCaptureConfig GetPaths(HandleRef nativeHandle);
    static bool IsRecording(HandleRef nativeHandle);

    static void SetMetadata(
        HandleRef nativeHandle,
        ARCaptureSetMetadataConfig config
    );

    static void Start(HandleRef nativeHandle, ARCaptureConfig captureConfig);
    static void Stop(HandleRef nativeHandle);
};

Detailed Documentation

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

Methods

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 ARCaptureConfig GetPaths(HandleRef nativeHandle)

Returns the capture's recording paths. The recorder must be started before calling this method.

Parameters:

nativeHandle

The native recorder to call.

Returns:

The paths used by the capture session.

static bool IsRecording(HandleRef nativeHandle)

Returns the capture's recording status.

Parameters:

nativeHandle

The native recorder to call.

Returns:

true if a recording session is active for the provided handle.

static void SetMetadata(
    HandleRef nativeHandle,
    ARCaptureSetMetadataConfig config
)

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

Parameters:

nativeHandle	The native recorder to set metadata on.
config	The native recorder to stop recording on.

static void Start(HandleRef nativeHandle, ARCaptureConfig captureConfig)

Starts recording on the given recorder.

Parameters:

nativeHandle	The native handle to the recorder.
captureConfig	The config object containing paths to working directory and archive file.

static void Stop(HandleRef nativeHandle)

Stops recording on the native side code.

Parameters:

nativeHandle

The native recorder to stop recording on.