Peer Management
Invite a peer to the current session. More...
Typedefs Index
| typedef | void(* qar_peer_update_callback_t)(QarPeerSpec *handle, void *user_state) |
|
Callback invoked when a peer spec changes. More... | |
Functions Index
| static QarResult | qar_peer_spec_get_app_custom_peer_info (QarPeerSpec *handle, char *out_buffer, size_t buffer_size) |
|
Get custom peer info string (application-defined). More... | |
| static QarResult | qar_peer_spec_get_app_state (QarPeerSpec *handle, QarAppState *out_state) |
|
Get application state for this peer. More... | |
| static QarResult | qar_peer_spec_get_app_version (QarPeerSpec *handle, char *out_buffer, size_t buffer_size) |
|
Get application version string. More... | |
| static QarResult | qar_peer_spec_get_display_name (QarPeerSpec *handle, char *out_buffer, size_t buffer_size) |
|
Get display name string into provided buffer. More... | |
| static QarResult | qar_peer_spec_get_id (QarPeerSpec *handle, QarPeerId *out_id) |
|
Get peer id from spec. More... | |
| static QarResult | qar_peer_spec_get_room_tag (QarPeerSpec *handle, char *out_buffer, size_t buffer_size) |
|
Get current room tag string. More... | |
| static QarResult | qar_peer_spec_get_version_id (QarPeerSpec *handle, char *out_buffer, size_t buffer_size) |
|
Get internal version id string. More... | |
| static void | qar_peer_spec_handle_destroy (QarPeerSpec *handle) |
|
Destroy a peer spec handle. More... | |
| static bool | qar_peer_spec_handle_is_valid (QarPeerSpec *handle) |
|
Check if a peer spec handle is valid. More... | |
| static QarResult | qar_peer_subscribe_updates (QarSession *session, qar_peer_update_callback_t callback, void *user_state, QarCancelToken *token) |
|
Subscribe for asynchronous peer spec updates. More... | |
| static QarResult | qar_peer_update_display_name (QarSession *session, const char *name) |
|
Update current peer's display name. More... | |
| static QarResult | qar_query_peer_specs (QarSession *session, QarPeerSpec **out_handles, size_t handles_buffer_size, size_t *out_handles_written) |
|
Enumerate peer specs into user-provided array. More... | |
| static QarResult | qar_query_peer_specs_count (QarSession *session, size_t *out_count) |
|
Query number of known peer specs. More... | |
| static QarResult | qar_session_get_my_spec (const QarSession *session, QarPeerSpec **out_handle) |
|
Get spec describing the current device/peer of a session. More... | |
Description
Invite a peer to the current session.
- Parameters
-
session Active session handle.
init Invitation parameters containing connection string.
cancel Optional cancellation token for invite (can be NULL).
out_peer_id Output parameter receiving the invited peer id.
- Return Values
-
QAR_STATUS_ARGUMENT_NOT_SUPPORTED the connection string names an unsupported device — rebuild it with a qar_session_invite_connection_string_* helper.
Typedefs
qar_peer_update_callback_t
|
Callback invoked when a peer spec changes.
Definition at line 1697 of file qar_streaming.h.
Functions
qar_peer_spec_get_app_custom_peer_info()
| inline static |
Get custom peer info string (application-defined).
Definition at line 1666 of file qar_streaming.h.
qar_peer_spec_get_app_state()
| inline static |
Get application state for this peer.
Definition at line 1671 of file qar_streaming.h.
qar_peer_spec_get_app_version()
| inline static |
Get application version string.
Definition at line 1662 of file qar_streaming.h.
qar_peer_spec_get_display_name()
| inline static |
Get display name string into provided buffer.
Definition at line 1657 of file qar_streaming.h.
qar_peer_spec_get_id()
| inline static |
Get peer id from spec.
Definition at line 1654 of file qar_streaming.h.
qar_peer_spec_get_room_tag()
| inline static |
Get current room tag string.
Definition at line 1677 of file qar_streaming.h.
qar_peer_spec_get_version_id()
| inline static |
Get internal version id string.
Definition at line 1673 of file qar_streaming.h.
qar_peer_spec_handle_destroy()
| inline static |
Destroy a peer spec handle.
Definition at line 1651 of file qar_streaming.h.
qar_peer_spec_handle_is_valid()
| inline static |
Check if a peer spec handle is valid.
Definition at line 1649 of file qar_streaming.h.
qar_peer_subscribe_updates()
| inline static |
Subscribe for asynchronous peer spec updates.
Definition at line 1701 of file qar_streaming.h.
qar_peer_update_display_name()
| inline static |
Update current peer's display name.
Definition at line 1695 of file qar_streaming.h.
qar_query_peer_specs()
| inline static |
Enumerate peer specs into user-provided array.
Definition at line 1687 of file qar_streaming.h.
qar_query_peer_specs_count()
| inline static |
Query number of known peer specs.
Definition at line 1685 of file qar_streaming.h.
qar_session_get_my_spec()
| inline static |
Get spec describing the current device/peer of a session.
Definition at line 1682 of file qar_streaming.h.
Generated via doxygen2docusaurus 2.2.1 by Doxygen 1.9.8.