unreal.PCapSessionTemplate

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

Bases: PCapDataAsset

Data asset for defining all the folders that will be created for a session Can be duplicated and locked to ensure all tokenized strings become serialized static data.

C++ Source:

• Plugin: PerformanceCaptureWorkflow

• Module: PerformanceCaptureWorkflow

• File: PCapSessionTemplate.h

Editor Properties: (see get_editor_property/set_editor_property)

• additional_folders (Map[Name, PCapTokenisedFolderPath]): [Read-Write] Use the additional folders for any extra data you want contain in your session - eg audio and facial capture data

• animation_asset_name (PCapTokenisedString): [Read-Write] Animation Asset name token.

• animation_sub_directory (PCapTokenisedString): [Read-Write] Animation subdirectory token.

• animation_track_name (PCapTokenisedString): [Read-Write] Animation track name token.

• asset_uid (Guid): [Read-Write] Guid for disambiguating actors spawned by the data assets. Only editable from BP.

• audio_asset_name (PCapTokenisedString): [Read-Write] Audio asset name token.

• audio_source_name (PCapTokenisedString): [Read-Write] Audio source name token.

• audio_sub_directory (PCapTokenisedString): [Read-Write] Audio subdirectory token.

• audio_track_name (PCapTokenisedString): [Read-Write] Audio track name token.

• character_folder (PCapTokenisedFolderPath): [Read-Write] Character folder template

• common_folder (PCapTokenisedFolderPath): [Read-Write] Common folder template*

• global_tokens (str): [Read-Only] Use these tokens in your template strings.

• is_editable (bool): [Read-Only] Bool to control edit condition on the members of this asset. Prevents user from editing after a session has been created.

• p_cap_tokens (str): [Read-Only] Use these tokens in your template strings. The namespace for these tokens is ‘pcap.’

• performer_folder (PCapTokenisedFolderPath): [Read-Write] Performer folder template

• production_name (str): [Read-Write] String for production name. Will be sanitized for illegal filesystem characters

• prop_folder (PCapTokenisedFolderPath): [Read-Write] Prop folder template

• record_possessable (bool): [Read-Write] Bool to control if all actors should be recorded to possessable or spawnable.

• record_subscenes (bool): [Read-Write] Bool to control if each recording source is placed into a subscene at the start of recording.

• record_timecode (bool): [Read-Write] Bool to control if timecode is recorded or not.

• scene_folder (PCapTokenisedFolderPath): [Read-Write] Scene data folder template

• session_folder (PCapTokenisedFolderPath): [Read-Write] Session folder template

• session_name (str): [Read-Write] String for session name. Will be sanitized for illegal filesystem character

• session_token (PCapTokenisedString): [Read-Write] The final name of our session, including any tokens you include in it’s construction. You can use tokens to build this string, including the Session Name above

• start_at_current_timecode (bool): [Read-Write] Bool to control if recorded sequences should start at the current timecode value.

• subsequence_directory (PCapTokenisedString): [Read-Write] This affects the directory created for subsequences. It cannot be set per actor, only globally across the whole recording.

• take_folder (PCapTokenisedFolderPath): [Read-Write] Take Recorder folder template

• take_recorder_tokens (str): [Read-Only] Use these tokens in your template strings. The namespace for these tokens is ‘pcap.’

• take_save_name (PCapTokenisedString): [Read-Write] This be used by take recorder as the name of the recorded level sequence and the folder for any sub-scenes and assets

• template_root_folder (DirectoryPath): [Read-Write] * Core session fields

property additional_folders: None

[Read-Only] Use the additional folders for any extra data you want contain in your session - eg audio and facial capture data

Type:

(Map[Name, PCapTokenisedFolderPath])

property animation_asset_name: PCapTokenisedString

[Read-Only] Animation Asset name token.

Type:

(PCapTokenisedString)

property animation_sub_directory: PCapTokenisedString

[Read-Only] Animation subdirectory token.

Type:

(PCapTokenisedString)

property animation_track_name: PCapTokenisedString

[Read-Only] Animation track name token.

Type:

(PCapTokenisedString)

property audio_asset_name: PCapTokenisedString

[Read-Only] Audio asset name token.

Type:

(PCapTokenisedString)

property audio_source_name: PCapTokenisedString

[Read-Only] Audio source name token.

Type:

(PCapTokenisedString)

property audio_sub_directory: PCapTokenisedString

[Read-Only] Audio subdirectory token.

Type:

(PCapTokenisedString)

property audio_track_name: PCapTokenisedString

[Read-Only] Audio track name token.

Type:

(PCapTokenisedString)

property character_folder: PCapTokenisedFolderPath

[Read-Only] Character folder template

Type:

(PCapTokenisedFolderPath)

property common_folder: PCapTokenisedFolderPath

[Read-Only] Common folder template*

Type:

(PCapTokenisedFolderPath)

property is_editable: bool

[Read-Only] Bool to control edit condition on the members of this asset. Prevents user from editing after a session has been created.

Type:

(bool)

property performer_folder: PCapTokenisedFolderPath

[Read-Only] Performer folder template

Type:

(PCapTokenisedFolderPath)

property production_name: str

[Read-Write] String for production name. Will be sanitized for illegal filesystem characters

Type:

(str)

property prop_folder: PCapTokenisedFolderPath

[Read-Only] Prop folder template

Type:

(PCapTokenisedFolderPath)

property record_possessable: bool

[Read-Only] Bool to control if all actors should be recorded to possessable or spawnable.

Type:

(bool)

property record_subscenes: bool

[Read-Only] Bool to control if each recording source is placed into a subscene at the start of recording.

Type:

(bool)

property record_timecode: bool

[Read-Only] Bool to control if timecode is recorded or not.

Type:

(bool)

property scene_folder: PCapTokenisedFolderPath

[Read-Only] Scene data folder template

Type:

(PCapTokenisedFolderPath)

property session_folder: PCapTokenisedFolderPath

[Read-Only] Session folder template

Type:

(PCapTokenisedFolderPath)

property session_name: str

[Read-Write] String for session name. Will be sanitized for illegal filesystem character

Type:

(str)

property session_token: PCapTokenisedString

[Read-Only] The final name of our session, including any tokens you include in it’s construction. You can use tokens to build this string, including the Session Name above

Type:

(PCapTokenisedString)

property start_at_current_timecode: bool

[Read-Only] Bool to control if recorded sequences should start at the current timecode value.

Type:

(bool)

property subsequence_directory: PCapTokenisedString

[Read-Only] This affects the directory created for subsequences. It cannot be set per actor, only globally across the whole recording.

Type:

(PCapTokenisedString)

property take_folder: PCapTokenisedFolderPath

[Read-Only] Take Recorder folder template

Type:

(PCapTokenisedFolderPath)

property take_save_name: PCapTokenisedString

[Read-Only] This be used by take recorder as the name of the recorded level sequence and the folder for any sub-scenes and assets

Type:

(PCapTokenisedString)

property template_root_folder: DirectoryPath

[Read-Write] * Core session fields

Type:

(DirectoryPath)

update_all_fields() → None

Update all members and ensure illegal characters are removed.