Request, response, and event mapping to Vivox functionality
Explore request and response pairs and events to high-level Vivox functionality.
阅读时间6 分钟最后更新于 8 个月前
The following tables map individual request and response pairs and events to high-level Vivox functionality.
Setup and life cycle management
Message type | Voice single regular channel | Voice single positional channel | Voice multichannel | Friends and presence | Text in channels |
|---|---|---|---|---|---|
| req_connector_create | Required | Required | Required | Required | Required |
| req_connector_initiate_shutdown | Required | Required | Required | Required | Required |
| req_account_anonymous_login | Required | Required | Required | Required | Required |
| req_account_logout | Suggested | Suggested | Suggested | Suggested | Suggested |
| req_aux_notify_application_state_change | Required (Mobile only) | Required (Mobile only) | Required (Mobile only) | Required (Mobile only) | Required (Mobile only) |
Channel-based communications
Message type | Voice single regular channel | Voice single positional channel | Voice multichannel | Friends and presence | Text in channels | |
|---|---|---|---|---|---|---|
| req_sessiongroup_terminate | Optional | Optional | Optional | Optional | Optional | |
| req_sessiongroup_add_session | Required | Required | Required | Required | Required | |
| req_sessiongroup_remove_session | Suggested | Suggested | Suggested | Suggested | Suggested | |
| req_sessiongroup_set_focus | N/A | N/A | Optional | N/A | N/A | |
| req_sessiongroup_unset_focus | N/A | N/A | Optional | N/A | N/A | |
| req_sessiongroup_reset_focus | N/A | N/A | Optional | N/A | N/A | |
| req_sessiongroup_set_tx_session | N/A | N/A | Optional | N/A | N/A | |
| req_sessiongroup_set_tx_all_sessions | N/A | N/A | Optional | N/A | N/A | |
| req_sessiongroup_set_tx_no_session | N/A | N/A | Optional | N/A | N/A | |
| req_session_media_connect | Optional | Optional | Optional | Optional | Optional | |
| req_session_media_disconnect | Optional | Optional | Optional | Optional | Optional | |
| req_session_text_connect | N/A | N/A | N/A | N/A | Optional | |
| req_session_text_disconnect | N/A | N/A | N/A | N/A | Optional | |
| req_session_mute_local_speaker | Optional | Optional | Optional | N/A | N/A | |
| req_session_set_local_speaker_volume | Optional | Optional | Optional | N/A | N/A | |
| req_session_set_participant_volume_for_me | Optional | Optional | Optional | N/A | N/A | |
| req_session_set_participant_mute_for_me | Suggested | Suggested | Suggested | N/A | N/A | |
| req_session_set_3d_position | N/A | Suggested | N/A | N/A | N/A | N/A |
| req_channel_mute_user | Optional | Optional | Optional | N/A | N/A | |
| req_channel_kick_user | Optional | Optional | Optional | N/A | Optional | |
| req_channel_mute_all_users | Optional | Optional | Optional | N/A | N/A | |
| req_connector_mute_local_mic | Optional | Optional | Optional | N/A | N/A | |
| req_connector_mute_local_speaker | Optional | Optional | Optional | N/A | N/A | |
| req_sessiongroup_control_audio_injection | Optional | Optional | Optional | N/A | N/A | |
| req_sessiongroup_get_stats | Optional | Optional | Optional | N/A | Optional | |
| req_account_send_message | N/A | N/A | N/A | N/A | Optional |
Friends and presence
Message type | Voice single regular channel | Voice single positional channel | Voice multichannel | Friends and presence | Text in channels |
|---|---|---|---|---|---|
| req_account_buddy_set | N/A | N/A | N/A | Required | N/A |
| req_account_buddy_delete | N/A | N/A | N/A | Required | N/A |
| req_account_list_buddies_and_groups | N/A | N/A | N/A | Optional | N/A |
| req_session_send_message | N/A | N/A | N/A | N/A | Required |
| req_account_set_presence | N/A | N/A | N/A | Required | N/A |
| req_account_send_subscription_reply | N/A | N/A | N/A | Suggested | N/A |
| req_session_send_notification | N/A | N/A | N/A | N/A | Suggested |
| req_account_create_block_rule | N/A | N/A | N/A | Suggested | N/A |
| req_account_delete_block_rule | N/A | N/A | N/A | Suggested | N/A |
| req_account_list_block_rules | N/A | N/A | N/A | Optional | N/A |
| req_account_create_auto_accept_rule | N/A | N/A | N/A | Suggested | N/A |
| req_account_delete_auto_accept_rule | N/A | N/A | N/A | Suggested | N/A |
| req_account_list_auto_accept_rules | N/A | N/A | N/A | Optional | N/A |
Settings panel
Message type | Voice single regular channel | Voice single positional channel | Voice multichannel | Friends and presence | Text in channels |
|---|---|---|---|---|---|
| req_aux_get_render_devices | Optional | Optional | Optional | N/A | N/A |
| req_aux_get_capture_devices | Optional | Optional | Optional | N/A | N/A |
| req_aux_set_render_device | Optional | Optional | Optional | N/A | N/A |
| req_aux_set_capture_device | Optional | Optional | Optional | N/A | N/A |
| req_aux_get_mic_level | Optional | Optional | Optional | N/A | N/A |
| req_aux_get_speaker_level | Optional | Optional | Optional | N/A | N/A |
| req_aux_set_mic_level | Optional | Optional | Optional | N/A | N/A |
| req_aux_set_speaker_level | Optional | Optional | Optional | N/A | N/A |
| req_aux_render_audio_start | Optional | Optional | Optional | N/A | N/A |
| req_aux_render_audio_stop | Optional | Optional | Optional | N/A | N/A |
| req_aux_capture_audio_start | Optional | Optional | Optional | N/A | N/A |
| req_aux_capture_audio_stop | Optional | Optional | Optional | N/A | N/A |
| req_sessiongroup_set_session_3d_position | N/A | N/A | Optional | N/A | N/A |
| req_aux_start_buffer_capture | Optional | Optional | Optional | N/A | N/A |
| req_aux_play_audio_buffer | N/A | Optional | Optional | N/A | N/A |
| req_aux_set_vad_properties | Optional | Optional | Optional | N/A | N/A |
| req_aux_get_vad_properties | Optional | Optional | Optional | N/A | N/A |
User block list management
Message type | Voice single regular channel | Voice single positional channel | Voice multichannel | Friends and presence | Text in channels |
|---|---|---|---|---|---|
| req_account_control_communications | Optional | Optional | Optional | Optional | Optional |
Events
Message type | Voice single regular channel | Voice single positional channel | Voice multichannel | Friends and presence | Text in channels |
|---|---|---|---|---|---|
| evt_account_login_state_change | Required | Required | Required | Required | Required |
| evt_buddy_presence | N/A | N/A | N/A | Required | N/A |
| evt_subscription | N/A | N/A | N/A | Required | N/A |
| evt_session_notification | N/A | N/A | N/A | N/A | Suggested |
| evt_message | N/A | N/A | N/A | N/A | Required |
| evt_aux_audio_properties | Optional | Optional | Optional | N/A | N/A |
| evt_buddy_changed | N/A | N/A | N/A | Required | N/A |
| evt_media_stream_updated | Required | Required | Required | N/A | N/A |
| evt_text_stream_updated | N/A | N/A | N/A | N/A | Required |
| evt_sessiongroup_added | Required | Required | Required | N/A | Required |
| evt_sessiongroup_removed | Required | Required | Required | N/A | Required |
| evt_session_added | Required | Required | Required | N/A | Required |
| evt_session_removed | Required | Required | Required | N/A | Required |
| evt_participant_added | Suggested | Suggested | Suggested | N/A | Suggested |
| evt_participant_removed | Suggested | Suggested | Suggested | N/A | Suggested |
| evt_participant_updated | Optional | Optional | Optional | N/A | Optional |
| evt_media_completion | Optional | Optional | Optional | N/A | N/A |
| evt_audio_device_hot_swap | Suggested | Suggested | Suggested | N/A | N/A |