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:LiveLinkTransform
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_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_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_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:LiveLinkSourceHandle
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:LiveLinkSourceHandle
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:LiveLinkSourceHandle
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:
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:
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:LiveLinkTransform or None
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:LiveLinkSourceHandle or None
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:SubjectFrameHandle
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 request_shutdown(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:LiveLinkSourceHandle or None
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