unreal.MultiUserTakesVCamFunctionLibrary

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

Bases: BlueprintFunctionLibrary

This library wraps UMultiUserTakesFunctionLibrary: in editor builds, the calls are forwarded and cooked builds, the calls are compiled out. This is done so that Blueprints can continue to be cooked without crashing due to missing functions.

C++ Source:

  • Plugin: VirtualCamera

  • Module: VirtualCamera

  • File: MultiUserTakesVCamFunctionLibrary.h

classmethod get_record_on_client(client_endpoint_id) → bool

Gets the checkbox value in the “Record On Client” column in the settings displayed at the bottom of the “Take Recorder” tab. This function queries the state of any connected client. For the local client, you can also use GetRecordOnClientLocal.

Parameters:

client_endpoint_id (Guid) – ID of the client. You can get this by using e.g.UMultiUserSubsystem::GetRemoteClientIds or UMultiUserSubsystem::GetLocalClientId.

Return type:

bool

classmethod get_record_on_client_local() → bool

Gets the checkbox value in the “Record On Client” column in the settings displayed at the bottom of the “Take Recorder” tab. This is an utility for getting the local client’s value; GetRecordOnClient can also be used.

Return type:

bool

classmethod get_synchronize_take_recorder_transactions(client_endpoint_id) → bool

Gets the value of the “SynchronizeTakeRecorderTransactions” checkbox in the settings displayed at the bottom of the “Take Recorder” tab. This function queries the state of any connected client. For the local client, you can also use GetSynchronizeTakeRecorderTransactionsLocal.

Parameters:

client_endpoint_id (Guid) – ID of the client. You can get this by using e.g.UMultiUserSubsystem::GetRemoteClientIds or UMultiUserSubsystem::GetLocalClientId.

Return type:

bool

classmethod get_synchronize_take_recorder_transactions_local() → bool

Gets the value of the “SynchronizeTakeRecorderTransactions” checkbox in the settings displayed at the bottom of the “Take Recorder” tab. This is an utility for getting the local client’s value; GetSynchronizeTakeRecorderTransactions can also be used.

Return type:

bool

classmethod set_record_on_client(client_endpoint_id, new_value) → None

Sets the checkbox value in the “Record On Client” column in the settings displayed at the bottom of the “Take Recorder” tab. This function queries the state of any connected client. For the local client, you can also use SetRecordOnClientLocal.

Parameters:

  • client_endpoint_id (Guid) – ID of the client. You can get this by using e.g.UMultiUserSubsystem::GetRemoteClientIds or UMultiUserSubsystem::GetLocalClientId.

  • new_value (bool) – The new value to set

classmethod set_record_on_client_local(new_value) → None

Sets the checkbox value in the “Record On Client” column in the settings displayed at the bottom of the “Take Recorder” tab. This is an utility for setting the local client’s value; SetRecordOnClient can also be used.

Parameters:

new_value (bool) –

classmethod set_synchronize_take_recorder_transactions_local(new_value) → None

Sets the value of the “SynchronizeTakeRecorderTransactions” checkbox in the settings displayed at the bottom of the “Take Recorder” tab. note: Only the value of the local client can be set. Setting of remote clients is not implemented (no technical reason - there just never was a use-case).

Parameters:

new_value (bool) –