Classes |
Public Types |
Public Member Functions |
Static Public Member Functions |
Properties |
List of all members
NRKernal.Record.NRPhotoCapture
Inherits IDisposable.
Classes | |
struct | PhotoCaptureResult |
Public Types | |
enum | CaptureResultType { Success = 0 , UnknownError = 1 , TimeOutError = 2 } |
Public Member Functions | |
void | Dispose () |
IntPtr | GetUnsafePointerToVideoDeviceController () |
void | StartPhotoModeAsync (CameraParameters setupParams, OnPhotoModeStartedCallback onPhotoModeStartedCallback, bool autoAdaptBlendMode=false) |
void | StopPhotoModeAsync (OnPhotoModeStoppedCallback onPhotoModeStoppedCallback) |
void | TakePhotoAsync (string filename, PhotoCaptureFileOutputFormat fileOutputFormat, OnCapturedToDiskCallback onCapturedPhotoToDiskCallback) |
void | TakePhotoAsync (OnCapturedToMemoryCallback onCapturedPhotoToMemoryCallback) |
delegate void | OnCaptureResourceCreatedCallback (NRPhotoCapture captureObject) |
delegate void | OnPhotoModeStartedCallback (PhotoCaptureResult result) |
delegate void | OnPhotoModeStoppedCallback (PhotoCaptureResult result) |
delegate void | OnCapturedToDiskCallback (PhotoCaptureResult result) |
delegate void | OnCapturedToMemoryCallback (PhotoCaptureResult result, PhotoCaptureFrame photoCaptureFrame) |
Static Public Member Functions | |
static void | CreateAsync (bool showHolograms, OnCaptureResourceCreatedCallback onCreatedCallback) |
Properties | |
static IEnumerable< Resolution > | SupportedResolutions [get] |
Texture? | PreviewTexture [get] |
Detailed Description
A nr photo capture.
Member Enumeration Documentation
◆ CaptureResultType
Member Function Documentation
◆ CreateAsync()
|
static |
Creates an asynchronous.
- Parameters
-
showHolograms True to show, false to hide the holograms. onCreatedCallback The on created callback.
◆ GetUnsafePointerToVideoDeviceController()
IntPtr NRKernal.Record.NRPhotoCapture.GetUnsafePointerToVideoDeviceController | ( | ) |
Provides a COM pointer to the native IVideoDeviceController. A native COM pointer to the IVideoDeviceController.
- Returns
- The unsafe pointer to video device controller.
◆ OnCapturedToDiskCallback()
delegate void NRKernal.Record.NRPhotoCapture.OnCapturedToDiskCallback | ( | PhotoCaptureResult | result | ) |
Called when a photo has been saved to the file system.
- Parameters
-
result Indicates whether or not the photo was successfully saved to the file system.
◆ OnCapturedToMemoryCallback()
delegate void NRKernal.Record.NRPhotoCapture.OnCapturedToMemoryCallback | ( | PhotoCaptureResult | result, |
PhotoCaptureFrame | photoCaptureFrame | ||
) |
Called when a photo has been captured to memory.
- Parameters
-
result Indicates whether or not the photo was successfully captured to memory. photoCaptureFrame Contains the target texture.If available, the spatial information will be accessible through this structure as well.
◆ OnCaptureResourceCreatedCallback()
delegate void NRKernal.Record.NRPhotoCapture.OnCaptureResourceCreatedCallback | ( | NRPhotoCapture | captureObject | ) |
Called when a PhotoCapture resource has been created.
- Parameters
-
captureObject The PhotoCapture instance.
◆ OnPhotoModeStartedCallback()
delegate void NRKernal.Record.NRPhotoCapture.OnPhotoModeStartedCallback | ( | PhotoCaptureResult | result | ) |
Called when photo mode has been started.
- Parameters
-
result Indicates whether or not photo mode was successfully activated.
◆ OnPhotoModeStoppedCallback()
delegate void NRKernal.Record.NRPhotoCapture.OnPhotoModeStoppedCallback | ( | PhotoCaptureResult | result | ) |
Called when photo mode has been stopped.
- Parameters
-
result Indicates whether or not photo mode was successfully deactivated.
◆ StartPhotoModeAsync()
void NRKernal.Record.NRPhotoCapture.StartPhotoModeAsync | ( | CameraParameters | setupParams, |
OnPhotoModeStartedCallback | onPhotoModeStartedCallback, | ||
bool | autoAdaptBlendMode = false |
||
) |
Starts photo mode asynchronous.
- Parameters
-
setupParams Options for controlling the setup. onPhotoModeStartedCallback The on photo mode started callback. autoAdaptBlendMode Auto adaption for BlendMode based on supported feature on current device.
◆ StopPhotoModeAsync()
void NRKernal.Record.NRPhotoCapture.StopPhotoModeAsync | ( | OnPhotoModeStoppedCallback | onPhotoModeStoppedCallback | ) |
Stops photo mode asynchronous.
- Parameters
-
onPhotoModeStoppedCallback The on photo mode stopped callback.
◆ TakePhotoAsync() [1/2]
void NRKernal.Record.NRPhotoCapture.TakePhotoAsync | ( | OnCapturedToMemoryCallback | onCapturedPhotoToMemoryCallback | ) |
Take photo asynchronous.
- Parameters
-
onCapturedPhotoToMemoryCallback The on captured photo memory callback.
◆ TakePhotoAsync() [2/2]
void NRKernal.Record.NRPhotoCapture.TakePhotoAsync | ( | string | filename, |
PhotoCaptureFileOutputFormat | fileOutputFormat, | ||
OnCapturedToDiskCallback | onCapturedPhotoToDiskCallback | ||
) |
Take photo asynchronous.
- Parameters
-
filename Filename of the file. fileOutputFormat The file output format. onCapturedPhotoToDiskCallback The on captured photo disk callback.
Property Documentation
◆ PreviewTexture
|
get |
Gets the preview texture.
The preview texture.
◆ SupportedResolutions
|
staticget |
A list of all the supported device resolutions for taking pictures.
The supported resolutions.