Skip to main content

App Volumes

Typedefs Index

typedefvoid(* qar_app_volume_gesture_event_callback_t)(const QarAppVolumeGestureEvent *event, void *user_state)
typedefvoid(* qar_app_volume_update_callback_t)(QarAppVolume *handle, void *user_state)

Functions Index

static QarResultqar_app_volume_get_app_pose (QarAppVolume *handle, QarPose *out_pose)

Get app pose for an app volume handle. More...

static QarResultqar_app_volume_get_app_scale (QarAppVolume *handle, float *out_scale)

Get app scale for an app volume handle. More...

static QarResultqar_app_volume_get_app_world_anchor (QarAppVolume *handle, QarAppWorldAnchor *out_anchor)

Get app world anchor for an app volume handle. More...

static QarResultqar_app_volume_get_display_name (QarAppVolume *handle, char *out_buffer, size_t buffer_size)

Get the display name string for an app volume. More...

static QarResultqar_app_volume_get_editing_status (QarAppVolume *handle, QarAppVolumeEditingStatus *out_status)

Get current editing lock status and editor peer. More...

static QarResultqar_app_volume_get_gesture_configuration (QarAppVolume *handle, QarAppVolumeGestureConfiguration *out_config)

Get gesture configuration for an app volume handle. More...

static QarResultqar_app_volume_get_id (QarAppVolume *handle, QarAppVolumeId *out_id)
static QarResultqar_app_volume_get_latest_app_pose (QarSession *session, const QarAppVolumeId *volume_id, QarPose *out_pose)

Get the latest locally known fast-path app pose for this app volume. More...

static QarResultqar_app_volume_get_latest_app_scale (QarSession *session, const QarAppVolumeId *volume_id, float *out_scale)

Get the latest locally known fast-path app scale for this app volume. More...

static QarResultqar_app_volume_get_latest_pose (QarSession *session, const QarAppVolumeId *volume_id, QarPose *out_pose)

Get the latest locally known fast-path pose for this app volume. More...

static QarResultqar_app_volume_get_latest_size (QarSession *session, const QarAppVolumeId *volume_id, QarAppVolumeSize *out_size)

Get the latest locally known fast-path size for this app volume. More...

static QarResultqar_app_volume_get_lifetime_status (QarAppVolume *handle, QarAppVolumeLifetimeStatus *out_status)

Get the lifetime status (active/closed). More...

static QarResultqar_app_volume_get_pose (QarAppVolume *handle, QarPose *out_pose)

Get the pose of an app volume. More...

static QarResultqar_app_volume_get_size (QarAppVolume *handle, QarAppVolumeSize *out_size)

Get the current size of an app volume. More...

static QarResultqar_app_volume_get_used_by_peers (QarAppVolume *handle, QarPeerId *out_peers, size_t peers_buffer_size, size_t *out_peers_written)

Enumerate peers using the volume into provided buffer. More...

static QarResultqar_app_volume_get_used_by_peers_count (QarAppVolume *handle, size_t *out_peer_count)

Get number of peers currently using this volume. More...

static voidqar_app_volume_handle_destroy (QarAppVolume *handle)
static boolqar_app_volume_handle_is_valid (QarAppVolume *handle)
static QarResultqar_app_volumes_change_app_pose (QarSession *session, const QarAppVolumeId *volume_id, const QarPose *app_pose)

Update app pose for an existing app volume. More...

static QarResultqar_app_volumes_change_app_scale (QarSession *session, const QarAppVolumeId *volume_id, float scale)

Low-latency fast-path update for latest app scale. More...

static QarResultqar_app_volumes_change_app_world_anchor (QarSession *session, const QarAppVolumeId *volume_id, const QarGeoAnchorFrame *anchor)

Set app world anchor metadata. More...

static QarResultqar_app_volumes_change_display_name (QarSession *session, const QarAppVolumeId *volume_id, const char *display_name)
static QarResultqar_app_volumes_change_gesture_configuration (QarSession *session, const QarAppVolumeId *volume_id, const QarAppVolumeGestureConfiguration *config)

Update gesture configuration for an existing app volume. More...

static QarResultqar_app_volumes_change_pose (QarSession *session, const QarAppVolumeId *volume_id, const QarPose *pose)

Low-latency fast-path update for latest pose. More...

static QarResultqar_app_volumes_change_size (QarSession *session, const QarAppVolumeId *volume_id, const QarAppVolumeSize *size)

Resize an app volume. More...

static QarResultqar_app_volumes_clear_app_world_anchor (QarSession *session, const QarAppVolumeId *volume_id)

Clear app world anchor metadata. More...

static QarResultqar_app_volumes_close_volume (QarSession *session, const QarAppVolumeId *volume_id)

Close an app volume. More...

static QarResultqar_app_volumes_get_or_create (QarSession *session, const QarAppVolumeInit *init, QarAppVolumeId *out_volume)

Get the app volume identified by init->common_name, creating it (via init) if it does not exist yet. More...

static QarResultqar_app_volumes_start_editing (QarSession *session, const QarAppVolumeId *volume_id)

Request editing lock for the volume. More...

static QarResultqar_app_volumes_stop_editing (QarSession *session, const QarAppVolumeId *volume_id)

Release editing lock for the volume. More...

static QarResultqar_app_volumes_subscribe_gesture_updates (QarSession *session, const QarAppVolumeId *volume_id, QarGestureKind gesture_kind, qar_app_volume_gesture_event_callback_t callback, void *user_state, QarCancelToken *token)

Subscribe to filtered gesture updates for a specific app volume. More...

static QarResultqar_app_volumes_subscribe_updates (QarSession *session, qar_app_volume_update_callback_t callback, void *user_state, QarCancelToken *token)

Subscribe to updates for app volumes. More...

static QarResultqar_app_volumes_update_used_by_peers (QarSession *session, const QarAppVolumeId *volume_id, const QarPeerId *peer_additions, size_t additions_count, const QarPeerId *peer_removals, size_t removals_count)

Update which peers use the volume. More...

static QarResultqar_query_app_volumes (QarSession *session, QarAppVolume **out_handles, size_t handles_buffer_size, size_t *out_handles_written)

Enumerate app volumes into provided array of handles. More...

static QarResultqar_query_app_volumes_count (QarSession *session, size_t *out_count)

Query number of app volumes known to the session. More...

Typedefs

qar_app_volume_gesture_event_callback_t

typedef void(* qar_app_volume_gesture_event_callback_t)(const QarAppVolumeGestureEvent *event, void *user_state)

Definition at line 2036 of file qar_streaming.h.

qar_app_volume_update_callback_t

typedef void(* qar_app_volume_update_callback_t)(QarAppVolume *handle, void *user_state)

Definition at line 2033 of file qar_streaming.h.

Functions

qar_app_volume_get_app_pose()

QarResult qar_app_volume_get_app_pose (QarAppVolume * handle, QarPose * out_pose)
inline static

Get app pose for an app volume handle.

Definition at line 2104 of file qar_streaming.h.

qar_app_volume_get_app_scale()

QarResult qar_app_volume_get_app_scale (QarAppVolume * handle, float * out_scale)
inline static

Get app scale for an app volume handle.

Definition at line 2107 of file qar_streaming.h.

qar_app_volume_get_app_world_anchor()

QarResult qar_app_volume_get_app_world_anchor (QarAppVolume * handle, QarAppWorldAnchor * out_anchor)
inline static

Get app world anchor for an app volume handle.

Definition at line 2109 of file qar_streaming.h.

qar_app_volume_get_display_name()

QarResult qar_app_volume_get_display_name (QarAppVolume * handle, char * out_buffer, size_t buffer_size)
inline static

Get the display name string for an app volume.

Definition at line 2063 of file qar_streaming.h.

qar_app_volume_get_editing_status()

QarResult qar_app_volume_get_editing_status (QarAppVolume * handle, QarAppVolumeEditingStatus * out_status)
inline static

Get current editing lock status and editor peer.

Definition at line 2077 of file qar_streaming.h.

qar_app_volume_get_gesture_configuration()

QarResult qar_app_volume_get_gesture_configuration (QarAppVolume * handle, QarAppVolumeGestureConfiguration * out_config)
inline static

Get gesture configuration for an app volume handle.

Mapping rules are returned in priority order. Earlier entries in mapping_rules have higher priority than later entries.

Definition at line 2137 of file qar_streaming.h.

qar_app_volume_get_id()

QarResult qar_app_volume_get_id (QarAppVolume * handle, QarAppVolumeId * out_id)
inline static

Definition at line 2061 of file qar_streaming.h.

qar_app_volume_get_latest_app_pose()

QarResult qar_app_volume_get_latest_app_pose (QarSession * session, const QarAppVolumeId * volume_id, QarPose * out_pose)
inline static

Get the latest locally known fast-path app pose for this app volume.

Definition at line 2114 of file qar_streaming.h.

qar_app_volume_get_latest_app_scale()

QarResult qar_app_volume_get_latest_app_scale (QarSession * session, const QarAppVolumeId * volume_id, float * out_scale)
inline static

Get the latest locally known fast-path app scale for this app volume.

Definition at line 2119 of file qar_streaming.h.

qar_app_volume_get_latest_pose()

QarResult qar_app_volume_get_latest_pose (QarSession * session, const QarAppVolumeId * volume_id, QarPose * out_pose)
inline static

Get the latest locally known fast-path pose for this app volume.

Definition at line 2123 of file qar_streaming.h.

qar_app_volume_get_latest_size()

QarResult qar_app_volume_get_latest_size (QarSession * session, const QarAppVolumeId * volume_id, QarAppVolumeSize * out_size)
inline static

Get the latest locally known fast-path size for this app volume.

Definition at line 2127 of file qar_streaming.h.

qar_app_volume_get_lifetime_status()

QarResult qar_app_volume_get_lifetime_status (QarAppVolume * handle, QarAppVolumeLifetimeStatus * out_status)
inline static

Get the lifetime status (active/closed).

Definition at line 2073 of file qar_streaming.h.

qar_app_volume_get_pose()

QarResult qar_app_volume_get_pose (QarAppVolume * handle, QarPose * out_pose)
inline static

Get the pose of an app volume.

Definition at line 2068 of file qar_streaming.h.

qar_app_volume_get_size()

QarResult qar_app_volume_get_size (QarAppVolume * handle, QarAppVolumeSize * out_size)
inline static

Get the current size of an app volume.

Definition at line 2071 of file qar_streaming.h.

qar_app_volume_get_used_by_peers()

QarResult qar_app_volume_get_used_by_peers (QarAppVolume * handle, QarPeerId * out_peers, size_t peers_buffer_size, size_t * out_peers_written)
inline static

Enumerate peers using the volume into provided buffer.

Definition at line 2085 of file qar_streaming.h.

qar_app_volume_get_used_by_peers_count()

QarResult qar_app_volume_get_used_by_peers_count (QarAppVolume * handle, size_t * out_peer_count)
inline static

Get number of peers currently using this volume.

Definition at line 2081 of file qar_streaming.h.

qar_app_volume_handle_destroy()

void qar_app_volume_handle_destroy (QarAppVolume * handle)
inline static

Definition at line 2059 of file qar_streaming.h.

qar_app_volume_handle_is_valid()

bool qar_app_volume_handle_is_valid (QarAppVolume * handle)
inline static

Definition at line 2058 of file qar_streaming.h.

qar_app_volumes_change_app_pose()

QarResult qar_app_volumes_change_app_pose (QarSession * session, const QarAppVolumeId * volume_id, const QarPose * app_pose)
inline static

Update app pose for an existing app volume.

Definition at line 2009 of file qar_streaming.h.

qar_app_volumes_change_app_scale()

QarResult qar_app_volumes_change_app_scale (QarSession * session, const QarAppVolumeId * volume_id, float scale)
inline static

Low-latency fast-path update for latest app scale.

Definition at line 2015 of file qar_streaming.h.

qar_app_volumes_change_app_world_anchor()

QarResult qar_app_volumes_change_app_world_anchor (QarSession * session, const QarAppVolumeId * volume_id, const QarGeoAnchorFrame * anchor)
inline static

Set app world anchor metadata.

Definition at line 2019 of file qar_streaming.h.

qar_app_volumes_change_display_name()

QarResult qar_app_volumes_change_display_name (QarSession * session, const QarAppVolumeId * volume_id, const char * display_name)
inline static

Definition at line 1975 of file qar_streaming.h.

qar_app_volumes_change_gesture_configuration()

QarResult qar_app_volumes_change_gesture_configuration (QarSession * session, const QarAppVolumeId * volume_id, const QarAppVolumeGestureConfiguration * config)
inline static

Update gesture configuration for an existing app volume.

The order of config->mapping_rules defines runtime priority. Earlier rules have higher priority and can suppress lower-priority gestures when both are active at the same time for the same app volume and source peer.

Definition at line 2146 of file qar_streaming.h.

qar_app_volumes_change_pose()

QarResult qar_app_volumes_change_pose (QarSession * session, const QarAppVolumeId * volume_id, const QarPose * pose)
inline static

Low-latency fast-path update for latest pose.

Definition at line 2029 of file qar_streaming.h.

qar_app_volumes_change_size()

QarResult qar_app_volumes_change_size (QarSession * session, const QarAppVolumeId * volume_id, const QarAppVolumeSize * size)
inline static

Resize an app volume.

Definition at line 1981 of file qar_streaming.h.

qar_app_volumes_clear_app_world_anchor()

QarResult qar_app_volumes_clear_app_world_anchor (QarSession * session, const QarAppVolumeId * volume_id)
inline static

Clear app world anchor metadata.

Definition at line 2025 of file qar_streaming.h.

qar_app_volumes_close_volume()

QarResult qar_app_volumes_close_volume (QarSession * session, const QarAppVolumeId * volume_id)
inline static

Close an app volume.

Definition at line 1987 of file qar_streaming.h.

qar_app_volumes_get_or_create()

QarResult qar_app_volumes_get_or_create (QarSession * session, const QarAppVolumeInit * init, QarAppVolumeId * out_volume)
inline static

Get the app volume identified by init->common_name, creating it (via init) if it does not exist yet.

Definition at line 1970 of file qar_streaming.h.

qar_app_volumes_start_editing()

QarResult qar_app_volumes_start_editing (QarSession * session, const QarAppVolumeId * volume_id)
inline static

Request editing lock for the volume.

Definition at line 2000 of file qar_streaming.h.

qar_app_volumes_stop_editing()

QarResult qar_app_volumes_stop_editing (QarSession * session, const QarAppVolumeId * volume_id)
inline static

Release editing lock for the volume.

Definition at line 2004 of file qar_streaming.h.

qar_app_volumes_subscribe_gesture_updates()

QarResult qar_app_volumes_subscribe_gesture_updates (QarSession * session, const QarAppVolumeId * volume_id, QarGestureKind gesture_kind, qar_app_volume_gesture_event_callback_t callback, void * user_state, QarCancelToken * token)
inline static

Subscribe to filtered gesture updates for a specific app volume.

Definition at line 2047 of file qar_streaming.h.

qar_app_volumes_subscribe_updates()

QarResult qar_app_volumes_subscribe_updates (QarSession * session, qar_app_volume_update_callback_t callback, void * user_state, QarCancelToken * token)
inline static

Subscribe to updates for app volumes.

Definition at line 2040 of file qar_streaming.h.

qar_app_volumes_update_used_by_peers()

QarResult qar_app_volumes_update_used_by_peers (QarSession * session, const QarAppVolumeId * volume_id, const QarPeerId * peer_additions, size_t additions_count, const QarPeerId * peer_removals, size_t removals_count)
inline static

Update which peers use the volume.

Definition at line 1991 of file qar_streaming.h.

qar_query_app_volumes()

QarResult qar_query_app_volumes (QarSession * session, QarAppVolume ** out_handles, size_t handles_buffer_size, size_t * out_handles_written)
inline static

Enumerate app volumes into provided array of handles.

Definition at line 2095 of file qar_streaming.h.

qar_query_app_volumes_count()

QarResult qar_query_app_volumes_count (QarSession * session, size_t * out_count)
inline static

Query number of app volumes known to the session.

Definition at line 2093 of file qar_streaming.h.


Generated via doxygen2docusaurus 2.2.1 by Doxygen 1.9.8.