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_sub_directory (PCapTokenisedString): [Read-Write]

  • animation_track_name (PCapTokenisedString): [Read-Write]

  • asset_uid (Guid): [Read-Write] Guid for disambiguating actors spawned by the data assets

  • audio_asset_name (PCapTokenisedString): [Read-Write]

  • audio_source_name (PCapTokenisedString): [Read-Write]

  • audio_sub_directory (PCapTokenisedString): [Read-Write]

  • audio_track_name (PCapTokenisedString): [Read-Write]

  • 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] * Use this to effectively “lock” the asset and prevent any dynamic tokens from being * Behind the scenes, this prevents PostEditUpdates from modifying data such that makes all * the strings and folder paths become static

  • 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]

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

  • record_possessable (bool): [Read-Write]

  • record_subscenes (bool): [Read-Write]

  • record_timecode (bool): [Read-Write] * Take Record related fields

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

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

  • session_name (str): [Read-Write]

  • 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]

  • 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]

Type:

(PCapTokenisedString)

property animation_sub_directory: PCapTokenisedString

[Read-Only]

Type:

(PCapTokenisedString)

property animation_track_name: PCapTokenisedString

[Read-Only]

Type:

(PCapTokenisedString)

property audio_asset_name: PCapTokenisedString

[Read-Only]

Type:

(PCapTokenisedString)

property audio_source_name: PCapTokenisedString

[Read-Only]

Type:

(PCapTokenisedString)

property audio_sub_directory: PCapTokenisedString

[Read-Only]

Type:

(PCapTokenisedString)

property audio_track_name: PCapTokenisedString

[Read-Only]

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] * Use this to effectively “lock” the asset and prevent any dynamic tokens from being * Behind the scenes, this prevents PostEditUpdates from modifying data such that makes all * the strings and folder paths become static

Type:

(bool)

property performer_folder: PCapTokenisedFolderPath

[Read-Only] Performer folder template

Type:

(PCapTokenisedFolderPath)

property production_name: str

[Read-Write]

Type:

(str)

property prop_folder: PCapTokenisedFolderPath

[Read-Only] Prop folder template

Type:

(PCapTokenisedFolderPath)

property record_possessable: bool

[Read-Only]

Type:

(bool)

property record_subscenes: bool

[Read-Only]

Type:

(bool)

property record_timecode: bool

[Read-Only] * Take Record related fields

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]

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]

Type:

(bool)

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-Only] * Core session fields

Type:

(DirectoryPath)

update_all_fields() → None

Update All Fields