unreal.MagicLeapCameraComponent
¶
-
class
unreal.
MagicLeapCameraComponent
(outer=None, name='None')¶ Bases:
unreal.ActorComponent
The MagicLeapCameraComponent provides access to and maintains state for camera capture functionality. 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 event handlers for the operation’s completion.
C++ Source:
Plugin: MagicLeapCamera
Module: MagicLeapCamera
File: MagicLeapCameraComponent.h
Editor Properties: (see get_editor_property/set_editor_property)
asset_user_data
(Array(AssetUserData)): [Read-Write] Array of user data stored with the componentauto_activate
(bool): [Read-Write] Whether the component is activated at creation or must be explicitly activated.can_ever_affect_navigation
(bool): [Read-Write] Whether this component can potentially influence navigationcomponent_tags
(Array(Name)): [Read-Write] Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.editable_when_inherited
(bool): [Read-Write] True if this component can be modified when it was inherited from a parent actor classis_editor_only
(bool): [Read-Write] If true, the component will be excluded from non-editor buildson_capture_img_to_file
(MagicLeapCameraCaptureImgToFileMulti): [Read-Write] On Capture Img to Fileon_capture_img_to_texture
(MagicLeapCameraCaptureImgToTextureMulti): [Read-Write] On Capture Img to Textureon_component_activated
(ActorComponentActivatedSignature): [Read-Write] Called when the component has been activated, with parameter indicating if it was from a reseton_component_deactivated
(ActorComponentDeactivateSignature): [Read-Write] Called when the component has been deactivatedon_log_message
(MagicLeapCameraLogMessageMulti): [Read-Write] On Log Messageon_start_recording
(MagicLeapCameraStartRecordingMulti): [Read-Write] On Start Recordingon_stop_recording
(MagicLeapCameraStopRecordingMulti): [Read-Write] On Stop Recordingprimary_component_tick
(ActorComponentTickFunction): [Read-Write] Main tick function for the Componentreplicates
(bool): [Read-Write] Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!
-
capture_image_to_file_async
() → bool¶ Initiates a capture image to file task on a separate thread. 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.:
- Returns
True if the call succeeds, false otherwise.
- Return type
-
capture_image_to_texture_async
() → bool¶ Initiates a capture image to memory task on a speparate thread. 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.: The generated texture will be garbage collected when this app is destroyed.:
- Returns
True if the call succeeds, false otherwise.
- Return type
-
is_capturing
() → bool¶ Gets the capture state of the component.
- Returns
True if the component is currently capturing, false otherwise.
- Return type
-
property
on_capture_img_to_file
¶ [Read-Write] On Capture Img to File
-
property
on_capture_img_to_texture
¶ [Read-Write] On Capture Img to Texture
-
property
on_log_message
¶ [Read-Write] On Log Message
-
property
on_start_recording
¶ [Read-Write] On Start Recording
-
property
on_stop_recording
¶ [Read-Write] On Stop Recording