register_location_as_parameter#

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

Register a certain (input) location as a parameter.

Parameters:

uid: str: Actor uid.
location: Any: Specification of location, depends on actor type.
name: Optional[str], optional: Parameter name.
reference_value: Optional[Any], optional: Parameter reference value.

Returns:

str: Name of the actual created parameter.

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.