unreal.VirtualCameraClipsMetaData

class unreal.VirtualCameraClipsMetaData(outer: Object | None = None, name: Name | str = 'None')

Bases: Object

Clips meta-data that is stored on ULevelSequence assets that are recorded through the virtual camera. Meta-data is retrieved through ULevelSequence::FindMetaData<UVirtualCameraClipsMetaData>()

C++ Source:

  • Plugin: VirtualCamera

  • Module: VirtualCamera

  • File: VirtualCameraClipsMetaData.h

Editor Properties: (see get_editor_property/set_editor_property)

  • display_rate (FrameRate): [Read-Write] The display rate of the level sequence used for AssetData calculations.

  • favorite_level (int32): [Read-Write] The asset registry tag that contains its favorite status

  • focal_length (float): [Read-Write] The focal length of the streamed camera used to record the take

  • frame_count_end (int32): [Read-Write] The last frame of the clip used for calculating duration.

  • frame_count_start (int32): [Read-Write] The initial frame of the clip used for calculating duration.

  • is_a_cine_camera_recording (bool): [Read-Write] If the LevelSequence was recorded with a CineCameraActor, rather than a VirtualCameraActor

  • is_created_from_v_cam (bool): [Read-Write] Whether the sequence was created from a VCam

  • is_flagged (bool): [Read-Write] The asset registry tag that contains whether this was flagged by a user

  • is_no_good (bool): [Read-Write] Whether this take is marked as good

  • is_selected (bool): [Read-Write] Whether or not the take was marked as ‘selected’

  • length_in_frames (int32): [Read-Write] The level sequence length in frames calculated from VirtualCameraSubsystem used for AssetData calculations

  • recorded_level_name (str): [Read-Write] The name of the level that the clip was recorded in

property display_rate: FrameRate

[Read-Write] The display rate of the level sequence used for AssetData calculations.

Type:

(FrameRate)

property favorite_level: int

[Read-Write] The asset registry tag that contains its favorite status

Type:

(int32)

property focal_length: float

[Read-Write] The focal length of the streamed camera used to record the take

Type:

(float)

property frame_count_end: int

[Read-Write] The last frame of the clip used for calculating duration.

Type:

(int32)

property frame_count_start: int

[Read-Write] The initial frame of the clip used for calculating duration.

Type:

(int32)

classmethod get_all_clips_meta_data_tags() Set[Name]

Gets all asset registry tags

Return type:

Set[Name]

classmethod get_clips_meta_data_tag_display_rate() Name

The asset registry tag that contains the FrameCountEnd out for this meta-data

Return type:

Name

classmethod get_clips_meta_data_tag_favorite_level() Name

The asset registry tag that contains its favorite status

Return type:

Name

classmethod get_clips_meta_data_tag_focal_length() Name

The asset registry tag that contains the focal length for this meta-data

Return type:

Name

classmethod get_clips_meta_data_tag_frame_count_end() Name

The asset registry tag that contains the FrameCountEnd out for this meta-data

Return type:

Name

classmethod get_clips_meta_data_tag_frame_count_start() Name

The asset registry tag that contains the FrameCountStart in for this meta-data

Return type:

Name

classmethod get_clips_meta_data_tag_is_cine_a_cine_camera_recording() Name

The asset registry tag that contains whether the clip was recorded with a CineCamera for this meta-data

Return type:

Name

classmethod get_clips_meta_data_tag_is_created_from_v_cam() Name

The asset registry tag that contains whether it was created from a VCam

Return type:

Name

classmethod get_clips_meta_data_tag_is_flagged() Name

The asset registry tag that contains whether this was flagged by a user

Return type:

Name

classmethod get_clips_meta_data_tag_is_no_good() Name

The asset registry tag that contains whether this take is good or not

Return type:

Name

classmethod get_clips_meta_data_tag_is_selected() Name

The asset registry tag that contains if the selected state for this meta-data

Return type:

Name

classmethod get_clips_meta_data_tag_length_in_frames() Name

The asset registry tag that contains the LengthInFrames out for this meta-data

Return type:

Name

classmethod get_clips_meta_data_tag_recorded_level() Name

The asset registry tag that contains the recorded level name for this meta-data

Return type:

Name

get_display_rate() FrameRate
Returns:

The display rate of the clip.

Return type:

FrameRate

get_focal_length() float
Returns:

The focal length for this clip

Return type:

float

get_frame_count_end() int32
Returns:

The final frame of the clip

Return type:

int32

get_frame_count_start() int32
Returns:

The initial frame of the clip

Return type:

int32

get_is_a_cine_camera_recording() bool
Returns:

Whether the clip was recorded by a CineCameraActor

Return type:

bool

get_length_in_frames() int32
Returns:

The length in frames of the clip.

Return type:

int32

get_recorded_level_name() str
Returns:

The name of the clip’s recorded level.

Return type:

str

get_selected() bool
Returns:

Whether or not the clip is selected.

Return type:

bool

property is_a_cine_camera_recording: bool

[Read-Write] If the LevelSequence was recorded with a CineCameraActor, rather than a VirtualCameraActor

Type:

(bool)

property is_created_from_v_cam: bool

[Read-Write] Whether the sequence was created from a VCam

Type:

(bool)

property is_flagged: bool

[Read-Write] The asset registry tag that contains whether this was flagged by a user

Type:

(bool)

property is_no_good: bool

[Read-Write] Whether this take is marked as good

Type:

(bool)

property is_selected: bool

[Read-Write] Whether or not the take was marked as ‘selected’

Type:

(bool)

property length_in_frames: int

[Read-Write] The level sequence length in frames calculated from VirtualCameraSubsystem used for AssetData calculations

Type:

(int32)

property recorded_level_name: str

[Read-Write] The name of the level that the clip was recorded in

Type:

(str)

set_display_rate(display_rate) None

Set the DisplayRate of the clip used for AssetData calculations.

Parameters:

display_rate (FrameRate) –

set_focal_length(focal_length) None

Set the focal length associated with this clip. note:: Used for tracking. Does not update the StreamedCameraComponent.

Parameters:

focal_length (float) –

set_frame_count_end(frame) None

Set the final frame of the clip used for calculating duration.

Parameters:

frame (int32) –

set_frame_count_start(frame) None

Set the initial frame of the clip used for calculating duration.

Parameters:

frame (int32) –

set_is_a_cine_camera_recording(is_a_cine_camera_recording) None

Set if the clip was recorded by a CineCameraActor

Parameters:

is_a_cine_camera_recording (bool) –

set_length_in_frames(length) None

Set the length in frames of the clip used for AssetData calculations.

Parameters:

length (int32) –

set_recorded_level_name(level_name) None

Set the name of the level that the clip was recorded in.

Parameters:

level_name (str) –

set_selected(selected) None

Set if this clip is ‘selected’

Parameters:

selected (bool) –