NRSDKApiForUnity
Classes
XRXREALXREALAudioCapture

Classes

struct  AudioCaptureResult
 

Public Types

enum  CaptureResultType { Success = 0 , UnknownError = 1 }
 

Public Member Functions

 XREALAudioCapture ()
 
void Dispose ()
 
void StartRecordingAsync (string filename, OnStartedRecordingAudioCallback onStartedRecordingAudioCallback)
 
void StartRecordingAsync (string filename, OnStartedRecordingAudioCallback onStartedRecordingAudioCallback, float volumeFactorMic, float volumeFactorApp)
 
void StartAudioModeAsync (CameraParameters setupParams, OnAudioModeStartedCallback onAudioModeStartedCallback)
 
void StopRecordingAsync (OnStoppedRecordingAudioCallback onStoppedRecordingAudioCallback)
 
void StopAudioModeAsync (OnAudioModeStoppedCallback onAudioModeStoppedCallback)
 
delegate void OnStartedRecordingAudioCallback (AudioCaptureResult result)
 
delegate void OnAudioModeStartedCallback (AudioCaptureResult result)
 
delegate void OnAudioModeStoppedCallback (AudioCaptureResult result)
 
delegate void OnStoppedRecordingAudioCallback (AudioCaptureResult result)
 

Static Public Member Functions

static XREALAudioCapture Create ()
 

Properties

bool IsRecording [get]
 

Detailed Description

Records a audio from the MR images directly to disk. MR images comes from rgb camera or rgb camera image and virtual image blending. The final audio recording will be stored on the file system in the MP4 format.

Member Enumeration Documentation

◆ CaptureResultType

Contains the result of the capture request.

Enumerator
Success 

Specifies that the desired operation was successful.

UnknownError 

Specifies that an unknown error occurred.

Member Function Documentation

◆ OnAudioModeStartedCallback()

delegate void Unity.XR.XREAL.XREALAudioCapture.OnAudioModeStartedCallback ( AudioCaptureResult result)

Called when audio mode has been started.

Parameters
resultIndicates whether or not audio mode was successfully activated.

◆ OnAudioModeStoppedCallback()

delegate void Unity.XR.XREAL.XREALAudioCapture.OnAudioModeStoppedCallback ( AudioCaptureResult result)

Called when audio mode has been stopped.

Parameters
resultIndicates whether or not audio mode was successfully deactivated.

◆ OnStartedRecordingAudioCallback()

delegate void Unity.XR.XREAL.XREALAudioCapture.OnStartedRecordingAudioCallback ( AudioCaptureResult result)

Called when the web camera begins recording the audio.

Parameters
resultIndicates whether or not audio recording started successfully.

◆ OnStoppedRecordingAudioCallback()

delegate void Unity.XR.XREAL.XREALAudioCapture.OnStoppedRecordingAudioCallback ( AudioCaptureResult result)

Called when the audio recording has been saved to the file system.

Parameters
resultIndicates whether or not audio recording was saved successfully to the file system.

◆ StartAudioModeAsync()

void Unity.XR.XREAL.XREALAudioCapture.StartAudioModeAsync ( CameraParameters setupParams,
OnAudioModeStartedCallback onAudioModeStartedCallback )

Starts audio mode asynchronous.

Parameters
setupParamsOptions for controlling the setup.
onAudioModeStartedCallbackThe on audio mode started callback.
autoAdaptBlendModeAuto adaption for BlendMode based on supported feature on current device.

◆ StartRecordingAsync() [1/2]

void Unity.XR.XREAL.XREALAudioCapture.StartRecordingAsync ( string filename,
OnStartedRecordingAudioCallback onStartedRecordingAudioCallback )

Starts recording asynchronous.

Parameters
filenameFilename of the file.
onStartedRecordingVideoCallbackThe on started recording video callback.

◆ StartRecordingAsync() [2/2]

void Unity.XR.XREAL.XREALAudioCapture.StartRecordingAsync ( string filename,
OnStartedRecordingAudioCallback onStartedRecordingAudioCallback,
float volumeFactorMic,
float volumeFactorApp )

Starts recording asynchronous.

Parameters
filenameFilename of the file.
onStartedRecordingAudioCallbackThe on started recording audio callback.

◆ StopAudioModeAsync()

void Unity.XR.XREAL.XREALAudioCapture.StopAudioModeAsync ( OnAudioModeStoppedCallback onAudioModeStoppedCallback)

Stops video mode asynchronous.

Parameters
onAudioModeStoppedCallbackThe on video mode stopped callback.

◆ StopRecordingAsync()

void Unity.XR.XREAL.XREALAudioCapture.StopRecordingAsync ( OnStoppedRecordingAudioCallback onStoppedRecordingAudioCallback)

Stops recording asynchronous.

Parameters
onStoppedRecordingAudioCallbackThe on stopped recording audio callback.

Property Documentation

◆ IsRecording

bool Unity.XR.XREAL.XREALAudioCapture.IsRecording
get

Indicates whether or not the AudioCapture instance is currently recording audio.

True if this object is recording, false if not.