arena-py API v0.8.0
arena .scene
Gives access to an ARENA scene. Can create and execute various user-defined functions/tasks.
Parameters
- str host: Hostname of the ARENA webserver (required).
- str realm: Reserved topic fork for future use (optional).
- str namespace: Username of authenticated user or other namespace (automatic).
- str scene: The name of the scene, without namespace (required).
Scene( host='arenaxr.org', realm='realm', network_latency_interval=10000, on_msg_callback=None, new_obj_callback=None, user_join_callback=None, user_left_callback=None, delete_obj_callback=None, end_program_callback=None, video=False, debug=False, cli_args=False, **kwargs)
def
generate_custom_event(self, evt, action='clientEvent'):
Publishes an custom event. Could be user or library defined
def
delete_attributes(self, obj, attributes=None):
Public function to delete a list of 'attributes' as a string[], updating each to null
def
get_persisted_scene_option(self):
Returns a dictionary for scene-options. [TODO] wrap the output as a BaseObject
def
get_writable_scenes(self):
Request list of scene names for logged in user account that user has publish permission for. Returns: list of scenes.
Inherited Members
- arena.arena_mqtt.ArenaMQTT
- scene
- device
- auth
- debug
- username
- remote_auth_token
- mqttc_id
- config_url
- config_data
- mqtt_host
- subscribe_topic
- latency_topic
- ignore_topic
- mqttc
- can_publish
- on_msg_callback
- end_program_callback
- event_loop
- mqtt_connect_evt
- msg_io
- msg_rate_time_start
- msg_queue
- connected_evt
- parse_cli
- generate_client_id
- network_latency_update
- msg_rate_update
- run_once
- run_after_interval
- run_async
- run_forever
- run_tasks
- stop_tasks
- sleep
- on_message
- on_disconnect
- disconnect
- on_publish
- message_callback_add
- message_callback_remove
Another name for Scene.
Inherited Members
- Scene
- Scene
- persist_host
- persist_path
- persist_url
- new_obj_callback
- delete_obj_callback
- user_join_callback
- user_left_callback
- unspecified_object_ids
- users
- on_connect
- process_message
- callback_wrapper
- generate_custom_event
- generate_click_event
- manipulate_camera
- look_at
- all_objects
- add_object
- add_objects
- update_object
- update_objects
- delete_object
- delete_attributes
- run_animations
- create_delayed_task
- get_persisted_obj
- get_persisted_objs
- get_persisted_scene_option
- get_writable_scenes
- get_user_list
- arena.arena_mqtt.ArenaMQTT
- scene
- device
- auth
- debug
- username
- remote_auth_token
- mqttc_id
- config_url
- config_data
- mqtt_host
- subscribe_topic
- latency_topic
- ignore_topic
- mqttc
- can_publish
- on_msg_callback
- end_program_callback
- event_loop
- mqtt_connect_evt
- msg_io
- msg_rate_time_start
- msg_queue
- connected_evt
- parse_cli
- generate_client_id
- network_latency_update
- msg_rate_update
- run_once
- run_after_interval
- run_async
- run_forever
- run_tasks
- stop_tasks
- sleep
- on_message
- on_disconnect
- disconnect
- on_publish
- message_callback_add
- message_callback_remove