UMagicLeapCameraFunctionLibrary

Copyright Epic Games, Inc. All Rights Reserved.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MagicLeapCamera

Header

/Engine/Plugins/Lumin/MagicLeapCamera/Source/MagicLeapCamera/Public/MagicLeapCameraFunctionLibrary.h

Include

#include "MagicLeapCameraFunctionLibrary.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(ClassGroup=MagicLeap)
class UMagicLeapCameraFunctionLibrary : public UBlueprintFunctionLibrary

Remarks

The MagicLeapCameraFunctionLibrary provides access to the camera capture functionality. Users of this library 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 event handlers for the operation's completion.

Functions

Name Description

Public function Static UFunction BlueprintCallable, Category

bool

 

CameraConnect

(
    const FMagicLeapCameraConnect& Res...
)

Establishes a connection with the device's camera.

Public function Static UFunction BlueprintCallable, Category

bool

 

CameraDisconnect

(
    const FMagicLeapCameraDisconnect& ...
)

Disconnects from the device's camera.

Public function Static UFunction BlueprintCallable, Category

bool

 

CaptureImageToFileAsync

(
    const FMagicLeapCameraCaptureImgToF...
)

The newly created jpeg file will have an automatically generated name which is guaranteed to be unique. Upon completion, a successful operation will provide the file path of the newly created jpeg to the FMagicLeapCameraCaptureImgToFile event handler.

Public function Static UFunction BlueprintCallable, Category

bool

 

CaptureImageToTextureAsync

(
    const FMagicLeapCameraCaptureImgToT...
)

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 FMagicLeapCameraCaptureImgToTextureSuccess event handler.

Public function Static UFunction BlueprintPure, Category

bool

 

IsCapturing()

Gets the capture state of the component.

Public function Static UFunction BlueprintCallable, Category

bool

 

SetLogDelegate

(
    const FMagicLeapCameraLogMessage& ...
)

Sets the delegate by which the system can pass log messages back to the calling blueprint.

Public function Static UFunction BlueprintCallable, Category

bool

 

StartRecordingAsync

(
    const FMagicLeapCameraStartRecordin...
)

Initiates the capturing of video/audio data on a separate thread.

Public function Static UFunction BlueprintCallable, Category

bool

 

StopRecordingAsync

(
    const FMagicLeapCameraStopRecording...
)

Stops the recording and saves the video/audio data to an mp4 file.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss