get_actor_states#

TcpOslServer.get_actor_states(uid: str, include_state_info: bool = False) Dict#

Get available actor states for a certain actor.

These can be used in conjunction with “get_actor_status_info” to obtain actor status info for a specific state ID.

Parameters:
uidstr

Actor uid.

include_state_info: bool

Include additional info for each state. Otherwise, only state IDs are returned.

Returns
——-
Dict

Info about actor defined by uid.

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.