unreal.PCapSessionRecord

class unreal.PCapSessionRecord(uid: Guid = [], is_archived: bool = False, session_name: Name = 'None', session_date_time: DateTime = [], session_notes: str = '', production_name: Name = 'None', production_uid: Guid = [], session_output_name: str = '', session_path: str = '', performer_path: str = '', character_path: str = '', takes_path: str = '', prop_path: str = '', scene_path: str = '', common_path: str = '', additional_folders: None = [], takes_data_table: DataTable = Ellipsis, performers: None = [], characters: None = [], props: None = [], session_template: PCapSessionTemplate = Ellipsis, is_world_partition: bool = False, sub_level: World = Ellipsis, session_data_layer: DataLayerAsset = Ellipsis, session_slate_table: PCapDataTable = Ellipsis)

Bases: PCapRecordBase

Struct to hold a datatable record of a session.

C++ Source:

• Plugin: PerformanceCaptureWorkflow

• Module: PerformanceCaptureWorkflow

• File: PCapDatabase.h

Editor Properties: (see get_editor_property/set_editor_property)

• additional_folders (Array[str]): [Read-Only] Array of paths to folders of additional data. These folders can be defined in by the Session Template dataasset.

• character_path (str): [Read-Only] The content browser path to this session record’s character data.

• characters (Array[PCapCharacterDataAsset]): [Read-Only] Array of soft-refs to Characters spawned during this session.

• common_path (str): [Read-Only] The content browser path to this session record’s common data.

• is_archived (bool): [Read-Write] Bool to control if a record should be considered archived so the UI can hide it from view.

• is_world_partition (bool): [Read-Only] Bool to determine if this session record while in a level streaming or world partition level.

• performer_path (str): [Read-Only] The content browser path to this session record’s performer data.

• performers (Array[PCapPerformerDataAsset]): [Read-Only] Array of soft-refs to Performers spawned during this session.

• production_name (Name): [Read-Only] Name of Production this Session belongs to.

• production_uid (Guid): [Read-Only] GUID of the Production record associated with this session record.

• prop_path (str): [Read-Only] The content browser path to this session record’s prop data.

• props (Array[PCapPropDataAsset]): [Read-Only] Array of soft-refs to Props spawned during this session.

• scene_path (str): [Read-Only] The content browser path to this session record’s scene data.

• session_data_layer (DataLayerAsset): [Read-Only] Datalayer created for this session record, if using a persistent level of the World Partition type.

• session_date_time (DateTime): [Read-Only] Date and time session record was created.

• session_name (Name): [Read-Only] Name for this session

• session_notes (str): [Read-Write] Notes for this session record.

• session_output_name (str): [Read-Only] The token generated name of the session.

• session_path (str): [Read-Only] The content browser path to this session record’s data.

• session_slate_table (PCapDataTable): [Read-Write] The slates datatable to use in Mocap Recorder for this session.

• session_template (PCapSessionTemplate): [Read-Only] Reference to a locked Session Template. This will be generated on session creation.

• sub_level (World): [Read-Only] Sub-level created for this session, if using a persistent level of the Level streaming type.

• takes_data_table (DataTable): [Read-Only] Reference to the Takes datatable created for and used by this session record.

• takes_path (str): [Read-Only] The content browser path to this session record’s recorded takes data.

• uid (Guid): [Read-Only] GUID of the production record struct

property additional_folders: None

[Read-Only] Array of paths to folders of additional data. These folders can be defined in by the Session Template dataasset.

Type:

(Array[str])

property character_path: str

[Read-Only] The content browser path to this session record’s character data.

Type:

(str)

property characters: None

[Read-Only] Array of soft-refs to Characters spawned during this session.

Type:

(Array[PCapCharacterDataAsset])

property common_path: str

[Read-Only] The content browser path to this session record’s common data.

Type:

(str)

property is_world_partition: bool

[Read-Only] Bool to determine if this session record while in a level streaming or world partition level.

Type:

(bool)

property performer_path: str

[Read-Only] The content browser path to this session record’s performer data.

Type:

(str)

property performers: None

[Read-Only] Array of soft-refs to Performers spawned during this session.

Type:

(Array[PCapPerformerDataAsset])

property production_name: Name

[Read-Only] Name of Production this Session belongs to.

Type:

(Name)

property production_uid: Guid

[Read-Only] GUID of the Production record associated with this session record.

Type:

(Guid)

property prop_path: str

[Read-Only] The content browser path to this session record’s prop data.

Type:

(str)

property props: None

[Read-Only] Array of soft-refs to Props spawned during this session.

Type:

(Array[PCapPropDataAsset])

property scene_path: str

[Read-Only] The content browser path to this session record’s scene data.

Type:

(str)

property session_data_layer: DataLayerAsset

[Read-Only] Datalayer created for this session record, if using a persistent level of the World Partition type.

Type:

(DataLayerAsset)

property session_date_time: DateTime

[Read-Only] Date and time session record was created.

Type:

(DateTime)

property session_name: Name

[Read-Only] Name for this session

Type:

(Name)

property session_notes: str

[Read-Write] Notes for this session record.

Type:

(str)

property session_output_name: str

[Read-Only] The token generated name of the session.

Type:

(str)

property session_path: str

[Read-Only] The content browser path to this session record’s data.

Type:

(str)

property session_slate_table: PCapDataTable

[Read-Write] The slates datatable to use in Mocap Recorder for this session.

Type:

(PCapDataTable)

property session_template: PCapSessionTemplate

[Read-Only] Reference to a locked Session Template. This will be generated on session creation.

Type:

(PCapSessionTemplate)

property sub_level: World

[Read-Only] Sub-level created for this session, if using a persistent level of the Level streaming type.

Type:

(World)

property takes_data_table: DataTable

[Read-Only] Reference to the Takes datatable created for and used by this session record.

Type:

(DataTable)

property takes_path: str

[Read-Only] The content browser path to this session record’s recorded takes data.

Type:

(str)