Class CameraCaptureComponent

The CameraCaptureComponent provides access to and maintains state for camera capture functionality.

Inheritance
System.Object
UObject
ActorComponent
CameraCaptureComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.MagicLeap
Assembly: UE4DotNet.dll
Syntax
public class CameraCaptureComponent : ActorComponent
Remarks

The connection to the device's camera is managed internally. Users of this component are able to asynchronously capture camera images and footage to file. Alternatively, a camera image can be captured directly to texture. The user need only make the relevant asynchronous call and then register the appropriate success/fail event handlers for the operation's completion.

Properties

| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static CameraCaptureComponent DefaultObject { get; }
Property Value
Type Description
CameraCaptureComponent
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class

Methods

| Improve this Doc View Source

CaptureImageToFileAsync()

Instigates a capture image to file task on a separate thread.

Declaration
public bool CaptureImageToFileAsync()
Returns
Type Description
System.Boolean
Remarks

@brief The newly created jpeg file will have an automatically generated name which is guaranteed to be unique. The user should register event handlers for both the success and fail events. Upon completion, a successful operation will provide the file path of the newly created jpeg to the FCameraCaptureImgToFileSuccess event handler.

| Improve this Doc View Source

CaptureImageToTextureAsync()

Instigates a capture image to memory task on a speparate thread.

Declaration
public bool CaptureImageToTextureAsync()
Returns
Type Description
System.Boolean
Remarks

@brief The user should register event handlers for both the success and fail events. Upon completion, a successful operation will provide a dynamically generated texture containing the captured image to the FCameraCaptureImgToTextureSuccess event handler. @note The generated texture will be garbage collected when this class is destroyed.

| Improve this Doc View Source

CaptureVideoToFileAsync(Single)

Instigates a capture video to file task on a separate thread.

Declaration
public bool CaptureVideoToFileAsync(float VideoLength)
Parameters
Type Name Description
System.Single VideoLength
Returns
Type Description
System.Boolean
Remarks

@brief The newly created mp4 file will have an automatically generated name which is guaranteed to be unique. The user should register event handlers for both the success and fail events. Upon completion, a successful operation will provide the file path of the saved mp4 file to the FCameraCaptureVidToFileSuccess event handler. @param VideoLength The length in seconds of the footage to be captured.

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static CameraCaptureComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
CameraCaptureComponent

Operators

| Improve this Doc View Source

Implicit(IntPtr to CameraCaptureComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator CameraCaptureComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
CameraCaptureComponent