unreal.LiveLinkBlueprintLibrary
¶
-
class
unreal.
LiveLinkBlueprintLibrary
(outer=None, name='None')¶ Bases:
unreal.BlueprintFunctionLibrary
Live Link Blueprint Library
C++ Source:
Plugin: LiveLink
Module: LiveLink
File: LiveLinkBlueprintLibrary.h
-
classmethod
child_count
(live_link_transform) -> (int32, live_link_transform=LiveLinkTransform)¶ Returns the number of Children for a given LiveLink Transform
- Parameters
live_link_transform (LiveLinkTransform) –
- Returns
live_link_transform (LiveLinkTransform):
- Return type
-
classmethod
component_space_transform
(live_link_transform) -> (live_link_transform=LiveLinkTransform, transform=Transform)¶ Returns the Transform value in Root Space for a given LiveLink Transform
- Parameters
live_link_transform (LiveLinkTransform) –
- Returns
live_link_transform (LiveLinkTransform):
transform (Transform):
- Return type
tuple
-
classmethod
get_basic_data
(subject_frame_handle) -> (subject_frame_handle=SubjectFrameHandle, basic_blueprint_data=LiveLinkBasicBlueprintData)¶ Returns the Subject base structure stored in the Subject Frame
- Parameters
subject_frame_handle (SubjectFrameHandle) –
- Returns
subject_frame_handle (SubjectFrameHandle):
basic_blueprint_data (LiveLinkBasicBlueprintData):
- Return type
tuple
-
classmethod
get_children
(live_link_transform) -> (live_link_transform=LiveLinkTransform, children=Array(LiveLinkTransform))¶ Returns an array of Child LiveLink Transforms for a given LiveLink Transform
- Parameters
live_link_transform (LiveLinkTransform) –
- Returns
live_link_transform (LiveLinkTransform):
children (Array(LiveLinkTransform)):
- Return type
tuple
-
classmethod
get_curves
(subject_frame_handle) -> (subject_frame_handle=SubjectFrameHandle, curves=Map(Name, float))¶ Returns the float curves stored in the Subject Frame as a map
- Parameters
subject_frame_handle (SubjectFrameHandle) –
- Returns
subject_frame_handle (SubjectFrameHandle):
curves (Map(Name, float)):
- Return type
tuple
-
classmethod
get_live_link_enabled_subject_names
(include_virtual_subject)¶ Get a list of all enabled subject names
- Parameters
include_virtual_subject (bool) –
- Returns
- Return type
-
classmethod
get_live_link_subject_role
(subject_name)¶ Get the role of the subject with this name
- Parameters
subject_name (LiveLinkSubjectName) –
- Returns
- Return type
-
classmethod
get_live_link_subjects
(include_disabled_subject, include_virtual_subject)¶ Get a list of all subjects
- Parameters
- Returns
- Return type
-
classmethod
get_metadata
(subject_frame_handle) -> (subject_frame_handle=SubjectFrameHandle, metadata=SubjectMetadata)¶ Returns the Subject Metadata structure stored in the Subject Frame
- Parameters
subject_frame_handle (SubjectFrameHandle) –
- Returns
subject_frame_handle (SubjectFrameHandle):
metadata (SubjectMetadata):
- Return type
tuple
-
classmethod
get_parent
(live_link_transform) -> (live_link_transform=LiveLinkTransform, parent=LiveLinkTransform)¶ Returns the Parent LiveLink Transform if one exists or an Identity transform if no parent exists
- Parameters
live_link_transform (LiveLinkTransform) –
- Returns
live_link_transform (LiveLinkTransform):
parent (LiveLinkTransform):
- Return type
tuple
-
classmethod
get_property_value
(basic_data, property_name) → (basic_data=LiveLinkBasicBlueprintData, value=float) or None¶ Returns the value of a property stored in the Subject Frame
- Parameters
basic_data (LiveLinkBasicBlueprintData) –
property_name (Name) –
- Returns
basic_data (LiveLinkBasicBlueprintData):
value (float):
- Return type
tuple or None
-
classmethod
get_root_transform
(subject_frame_handle) -> (subject_frame_handle=SubjectFrameHandle, live_link_transform=LiveLinkTransform)¶ Returns the Root Transform for the Subject Frame as a LiveLink Transform or the Identity if there are no transforms.
- Parameters
subject_frame_handle (SubjectFrameHandle) –
- Returns
subject_frame_handle (SubjectFrameHandle):
live_link_transform (LiveLinkTransform):
- Return type
tuple
-
classmethod
get_source_machine_name
(source_handle) -> (Text, source_handle=LiveLinkSourceHandle)¶ Get the machine name of a LiveLink Source via its handle
- Parameters
source_handle (LiveLinkSourceHandle) –
- Returns
source_handle (LiveLinkSourceHandle):
- Return type
-
classmethod
get_source_status
(source_handle) -> (Text, source_handle=LiveLinkSourceHandle)¶ Get the text status of a LiveLink Source via its handle
- Parameters
source_handle (LiveLinkSourceHandle) –
- Returns
source_handle (LiveLinkSourceHandle):
- Return type
-
classmethod
get_source_type
(source_handle) -> (Text, source_handle=LiveLinkSourceHandle)¶ Get the type of a LiveLink Source via its handle
- Parameters
source_handle (LiveLinkSourceHandle) –
- Returns
source_handle (LiveLinkSourceHandle):
- Return type
-
classmethod
get_specific_live_link_subject_role
(subject_key)¶ Get the role of a subject from a specific source
- Parameters
subject_key (LiveLinkSubjectKey) –
- Returns
- Return type
-
classmethod
get_transform_by_index
(subject_frame_handle, transform_index) -> (subject_frame_handle=SubjectFrameHandle, live_link_transform=LiveLinkTransform)¶ Returns the LiveLink Transform stored in a Subject Frame at a given index. Returns an Identity transform if Transform Index is invalid.
- Parameters
subject_frame_handle (SubjectFrameHandle) –
transform_index (int32) –
- Returns
subject_frame_handle (SubjectFrameHandle):
live_link_transform (LiveLinkTransform):
- Return type
tuple
-
classmethod
get_transform_by_name
(subject_frame_handle, transform_name) -> (subject_frame_handle=SubjectFrameHandle, live_link_transform=LiveLinkTransform)¶ Returns the LiveLink Transform stored in a Subject Frame with a given name. Returns an Identity transform if Transform Name is invalid.
- Parameters
subject_frame_handle (SubjectFrameHandle) –
transform_name (Name) –
- Returns
subject_frame_handle (SubjectFrameHandle):
live_link_transform (LiveLinkTransform):
- Return type
tuple
-
classmethod
has_parent
(live_link_transform) → LiveLinkTransform or None¶ Returns whether a given LiveLink Transform has a parent transform
- Parameters
live_link_transform (LiveLinkTransform) –
- Returns
live_link_transform (LiveLinkTransform):
- Return type
-
classmethod
is_live_link_subject_enabled
(subject_name) → bool¶ Whether or not the client has a subject with this name enabled Only 1 subject with the same name can be enabled. At the start of the frame, a snapshot of the enabled subjects will be made. That snapshot dictate which subject will be used for the duration of that frame.
- Parameters
subject_name (LiveLinkSubjectName) –
- Returns
- Return type
-
classmethod
is_source_still_valid
(source_handle) → LiveLinkSourceHandle or None¶ Checks whether the LiveLink Source is valid via its handle
- Parameters
source_handle (LiveLinkSourceHandle) –
- Returns
source_handle (LiveLinkSourceHandle):
- Return type
-
classmethod
is_specific_live_link_subject_enabled
(subject_key, for_this_frame) → bool¶ Whether or not a subject from the specific source is the enabled subject. Only 1 subject with the same name can be enabled. At the start of the frame, a snapshot of the enabled subjects will be made. That snapshot dictate which subject will be used for the duration of that frame.
- Parameters
subject_key (LiveLinkSubjectKey) –
for_this_frame (bool) –
- Returns
- Return type
-
classmethod
number_of_transforms
(subject_frame_handle) -> (int32, subject_frame_handle=SubjectFrameHandle)¶ Returns the number of Transforms stored in the Subject Frame
- Parameters
subject_frame_handle (SubjectFrameHandle) –
- Returns
subject_frame_handle (SubjectFrameHandle):
- Return type
-
classmethod
parent_bone_space_transform
(live_link_transform) -> (live_link_transform=LiveLinkTransform, transform=Transform)¶ Returns the Transform value in Parent Space for a given LiveLink Transform
- Parameters
live_link_transform (LiveLinkTransform) –
- Returns
live_link_transform (LiveLinkTransform):
transform (Transform):
- Return type
tuple
-
classmethod
remove_source
(source_handle) → LiveLinkSourceHandle or None¶ Requests the given LiveLink Source to shut down via its handle
- Parameters
source_handle (LiveLinkSourceHandle) –
- Returns
source_handle (LiveLinkSourceHandle):
- Return type
-
classmethod
request_shutdown
(source_handle)¶ deprecated: ‘request_shutdown’ was renamed to ‘remove_source’.
-
classmethod
set_live_link_subject_enabled
(subject_key, enabled) → None¶ Set the subject’s from a specific source to enabled, disabling the other in the process. Only 1 subject with the same name can be enabled. At the start of the frame, a snapshot of the enabled subjects will be made. That snapshot dictate which subject will be used for the duration of that frame. SetSubjectEnabled will take effect on the next frame.
- Parameters
subject_key (LiveLinkSubjectKey) –
enabled (bool) –
-
classmethod
transform_name
(live_link_transform) -> (live_link_transform=LiveLinkTransform, name=Name)¶ Returns the Name of a given LiveLink Transform
- Parameters
live_link_transform (LiveLinkTransform) –
- Returns
live_link_transform (LiveLinkTransform):
name (Name):
- Return type
tuple
-
classmethod
transform_names
(subject_frame_handle) -> (subject_frame_handle=SubjectFrameHandle, transform_names=Array(Name))¶ Returns an array of Transform Names stored in the Subject Frame
- Parameters
subject_frame_handle (SubjectFrameHandle) –
- Returns
subject_frame_handle (SubjectFrameHandle):
transform_names (Array(Name)):
- Return type
tuple