register_location_as_input_slot

TcpOslServer.register_location_as_input_slot(uid: str, location: Any, name: str | None = None, reference_value: Any | None = None) → str

Register a certain (input) location as a input slot.

Parameters:

uid: str

Actor uid.

location: Any

Specification of location, depends on actor type.

name: Optional[str], optional

Input slot name.

reference_value: Optional[Any], optional

Input slot reference value.

Returns:

str

Name of the actual created input slot.

Raises:

OslCommunicationError

Raised when an error occurs while communicating with server.

OslCommandError

Raised when the command or query fails.

TimeoutError

Raised when the timeout float value expires.