Documentation

​
​

Development

User Acquisition

Monetization

Industry

Vivox Core SDK

Vivox Core SDK

Vivox
​
​
Vivox Core SDK
  • Overview
  • Before you begin
  • Get started
  • Release notes
  • Developer Guide
  • Reference
    • Access Token Developer Guide
    • Server to Server Web API Reference Guide
    • Core API Reference Manual
      • Modules
      • Data Structures
        • vx_account
        • vx_auto_accept_rule
        • vx_before_recv_audio_mixed_participant_data_t
        • vx_block_rule
        • vx_buddy
        • vx_call_stats
        • vx_channel
        • vx_connectivity_test_result
        • vx_device
        • vx_evt_account_archive_message
        • vx_evt_account_archive_query_end
        • vx_evt_account_chat_history_message
        • vx_evt_account_chat_history_query_end
        • vx_evt_account_delete_message
        • vx_evt_account_edit_message
        • vx_evt_account_login_state_change
        • vx_evt_account_send_message_failed
        • vx_evt_audio_device_hot_swap
        • vx_evt_aux_audio_properties
        • vx_evt_base
        • vx_evt_buddy_and_group_list_changed
        • vx_evt_buddy_changed
        • vx_evt_buddy_group_changed
        • vx_evt_buddy_presence
        • vx_evt_connection_state_changed
        • vx_evt_idle_state_changed
        • vx_evt_keyboard_mouse
        • vx_evt_media_completion
        • vx_evt_media_stream_updated
        • vx_evt_message
        • vx_evt_network_message
        • vx_evt_participant_added
        • vx_evt_participant_removed
        • vx_evt_participant_updated
        • vx_evt_publication_state_changed
        • vx_evt_server_app_data
        • vx_evt_session_added
        • vx_evt_session_archive_message
        • vx_evt_session_archive_query_end
        • vx_evt_session_chat_history_message
        • vx_evt_session_chat_history_query_end
        • vx_evt_session_delete_message
        • vx_evt_session_edit_message
        • vx_evt_session_notification
        • vx_evt_session_removed
        • vx_evt_session_updated
        • vx_evt_sessiongroup_added
        • vx_evt_sessiongroup_playback_frame_played
        • vx_evt_sessiongroup_removed
        • vx_evt_sessiongroup_updated
        • vx_evt_stt_failed
        • vx_evt_subscription
        • vx_evt_text_stream_updated
        • vx_evt_transcribed_message
        • vx_evt_tts_injection_ended
        • vx_evt_tts_injection_failed
        • vx_evt_tts_injection_started
        • vx_evt_user_app_data
        • vx_evt_user_to_user_message
        • vx_evt_voice_service_connection_state_changed
        • vx_generic_credentials
        • vx_group
        • vx_message_base
        • vx_name_value_pair
        • vx_participant
        • vx_req_account_anonymous_login
        • vx_req_account_archive_query
        • vx_req_account_authtoken_login
        • vx_req_account_buddy_delete
        • vx_req_account_buddy_set
        • vx_req_account_channel_add_acl
        • vx_req_account_channel_change_owner
        • vx_req_account_channel_get_acl
        • vx_req_account_channel_remove_acl
        • vx_req_account_chat_history_get_last_read
        • vx_req_account_chat_history_query
        • vx_req_account_control_communications
        • vx_req_account_create_auto_accept_rule
        • vx_req_account_create_block_rule
        • vx_req_account_delete_auto_accept_rule
        • vx_req_account_delete_block_rule
        • vx_req_account_delete_message Struct Reference
        • vx_req_account_edit_message Struct Reference
        • vx_req_account_get_account
        • vx_req_account_get_session_fonts
        • vx_req_account_get_template_fonts
        • vx_req_account_list_auto_accept_rules
        • vx_req_account_list_block_rules
        • vx_req_account_list_buddies_and_groups
        • vx_req_account_login
        • vx_req_account_logout
        • vx_req_account_post_crash_dump
        • vx_req_account_send_message
        • vx_req_account_send_sms
        • vx_req_account_send_subscription_reply
        • vx_req_account_send_user_app_data
        • vx_req_account_set_login_properties
        • vx_req_account_set_presence
        • vx_req_account_update_account
        • vx_req_account_web_call
        • vx_req_aux_capture_audio_start
        • vx_req_aux_capture_audio_stop
        • vx_req_aux_connectivity_info
        • vx_req_aux_create_account
        • vx_req_aux_deactivate_account
        • vx_req_aux_diagnostic_state_dump
        • vx_req_aux_get_capture_devices
        • vx_req_aux_get_derumbler_properties
        • vx_req_aux_get_mic_level
        • vx_req_aux_get_render_devices
        • vx_req_aux_get_speaker_level
        • vx_req_aux_get_vad_properties
        • vx_req_aux_global_monitor_keyboard_mouse
        • vx_req_aux_notify_application_state_change
        • vx_req_aux_play_audio_buffer
        • vx_req_aux_reactivate_account
        • vx_req_aux_render_audio_modify
        • vx_req_aux_render_audio_start
        • vx_req_aux_render_audio_stop
        • vx_req_aux_reset_password
        • vx_req_aux_set_capture_device
        • vx_req_aux_set_derumbler_properties
        • vx_req_aux_set_idle_timeout
        • vx_req_aux_set_mic_level
        • vx_req_aux_set_render_device
        • vx_req_aux_set_speaker_level
        • vx_req_aux_set_vad_properties
        • vx_req_aux_start_buffer_capture
        • vx_req_base
        • vx_req_channel_ban_user
        • vx_req_channel_get_banned_users
        • vx_req_channel_kick_user
        • vx_req_channel_mute_all_users
        • vx_req_channel_mute_user
        • vx_req_channel_set_lock_mode
        • vx_req_connector_create
        • vx_req_connector_get_local_audio_info
        • vx_req_connector_initiate_shutdown
        • vx_req_connector_mute_local_mic
        • vx_req_connector_mute_local_speaker
        • vx_req_connector_set_local_mic_volume
        • vx_req_connector_set_local_speaker_volume
        • vx_req_session_archive_query
        • vx_req_session_channel_invite_user
        • vx_req_session_chat_history_query
        • vx_req_session_create
        • vx_req_session_delete_message
        • vx_req_session_edit_message
        • vx_req_session_media_connect
        • vx_req_session_media_disconnect
        • vx_req_session_mute_local_speaker
        • vx_req_session_send_dtmf
        • vx_req_session_send_message
        • vx_req_session_send_notification
        • vx_req_session_set_3d_position
        • vx_req_session_set_local_render_volume
        • vx_req_session_set_local_speaker_volume
        • vx_req_session_set_participant_mute_for_me
        • vx_req_session_set_participant_volume_for_me
        • vx_req_session_set_voice_font
        • vx_req_session_terminate
        • vx_req_session_text_connect
        • vx_req_session_text_disconnect
        • vx_req_session_transcription_control
        • vx_req_sessiongroup_add_session
        • vx_req_sessiongroup_control_audio_injection
        • vx_req_sessiongroup_create
        • vx_req_sessiongroup_get_stats
        • vx_req_sessiongroup_remove_session
        • vx_req_sessiongroup_reset_focus
        • vx_req_sessiongroup_set_focus
        • vx_req_sessiongroup_set_session_3d_position
        • vx_req_sessiongroup_set_tx_all_sessions
        • vx_req_sessiongroup_set_tx_no_session
        • vx_req_sessiongroup_set_tx_session
        • vx_req_sessiongroup_terminate
        • vx_req_sessiongroup_unset_focus
        • vx_resp_account_anonymous_login
        • vx_resp_account_archive_query
        • vx_resp_account_authtoken_login
        • vx_resp_account_buddy_delete
        • vx_resp_account_buddy_set
        • vx_resp_account_channel_add_acl
        • vx_resp_account_channel_change_owner
        • vx_resp_account_chat_history_get_last_read
        • vx_resp_account_channel_get_acl
        • vx_resp_account_channel_remove_acl
        • vx_resp_account_chat_history_query
        • vx_resp_account_control_communications
        • vx_resp_account_create_auto_accept_rule
        • vx_resp_account_create_block_rule
        • vx_resp_account_delete_auto_accept_rule
        • vx_resp_account_delete_block_rule
        • vx_resp_account_get_account
        • vx_resp_account_get_session_fonts
        • vx_resp_account_get_template_fonts
        • vx_resp_account_list_auto_accept_rules
        • vx_resp_account_list_block_rules
        • vx_resp_account_list_buddies_and_groups
        • vx_resp_account_login
        • vx_resp_account_logout
        • vx_resp_account_post_crash_dump
        • vx_resp_account_send_message
        • vx_resp_account_send_sms
        • vx_resp_account_send_subscription_reply
        • vx_resp_account_send_user_app_data
        • vx_resp_account_set_login_properties
        • vx_resp_account_set_presence
        • vx_resp_account_update_account
        • vx_resp_account_web_call
        • vx_resp_aux_capture_audio_start
        • vx_resp_aux_capture_audio_stop
        • vx_resp_aux_connectivity_info
        • vx_resp_aux_create_account
        • vx_resp_aux_deactivate_account
        • vx_resp_aux_diagnostic_state_dump
        • vx_resp_aux_get_capture_devices
        • vx_resp_aux_get_derumbler_properties
        • vx_resp_aux_get_mic_level
        • vx_resp_aux_get_render_devices
        • vx_resp_aux_get_speaker_level
        • vx_resp_aux_get_vad_properties
        • vx_resp_aux_global_monitor_keyboard_mouse
        • vx_resp_aux_notify_application_state_change
        • vx_resp_aux_play_audio_buffer
        • vx_resp_aux_reactivate_account
        • vx_resp_aux_render_audio_modify
        • vx_resp_aux_render_audio_start
        • vx_resp_aux_render_audio_stop
        • vx_resp_aux_reset_password
        • vx_resp_aux_set_capture_device
        • vx_resp_aux_set_derumbler_properties
        • vx_resp_aux_set_idle_timeout
        • vx_resp_aux_set_mic_level
        • vx_resp_aux_set_render_device
        • vx_resp_aux_set_speaker_level
        • vx_resp_aux_set_vad_properties
        • vx_resp_aux_start_buffer_capture
        • vx_resp_base
        • vx_resp_channel_ban_user
        • vx_resp_channel_get_banned_users
        • vx_resp_channel_kick_user
        • vx_resp_channel_mute_all_users
        • vx_resp_channel_mute_user
        • vx_resp_channel_set_lock_mode
        • vx_resp_connector_create
        • vx_resp_connector_get_local_audio_info
        • vx_resp_connector_initiate_shutdown
        • vx_resp_connector_mute_local_mic
        • vx_resp_connector_mute_local_speaker
        • vx_resp_connector_set_local_mic_volume
        • vx_resp_connector_set_local_speaker_volume
        • vx_resp_session_archive_query
        • vx_resp_session_channel_invite_user
        • vx_resp_session_chat_history_query
        • vx_resp_session_create
        • vx_resp_session_media_connect
        • vx_resp_session_media_disconnect
        • vx_resp_session_mute_local_speaker
        • vx_resp_session_send_dtmf
        • vx_resp_session_send_message
        • vx_resp_session_send_notification
        • vx_resp_session_set_3d_position
        • vx_resp_session_set_local_render_volume
        • vx_resp_session_set_local_speaker_volume
        • vx_resp_session_set_participant_mute_for_me
        • vx_resp_session_set_participant_volume_for_me
        • vx_resp_session_set_voice_font
        • vx_resp_session_terminate
        • vx_resp_session_text_connect
        • vx_resp_session_text_disconnect
        • vx_resp_session_transcription_control
        • vx_resp_sessiongroup_add_session
        • vx_resp_sessiongroup_control_audio_injection
        • vx_resp_sessiongroup_create
        • vx_resp_sessiongroup_get_stats
        • vx_resp_sessiongroup_remove_session
        • vx_resp_sessiongroup_reset_focus
        • vx_resp_sessiongroup_set_focus
        • vx_resp_sessiongroup_set_session_3d_position
        • vx_resp_sessiongroup_set_tx_all_sessions
        • vx_resp_sessiongroup_set_tx_no_session
        • vx_resp_sessiongroup_set_tx_session
        • vx_resp_sessiongroup_terminate
        • vx_resp_sessiongroup_unset_focus
        • vx_sdk_config
        • vx_stat_sample
        • vx_stat_thread
        • vx_state_account
        • vx_state_buddy
        • vx_state_buddy_contact
        • vx_state_buddy_group
        • vx_state_connector
        • vx_state_participant
        • vx_state_session
        • vx_state_sessiongroup
        • vx_system_stats
        • vx_tts_utterance
        • vx_tts_voice
        • vx_user_channel
        • vx_voice_font
        • vx_vxd
        • vxa_capture_device_stats_t
        • vxa_render_device_stats_t
      • Deprecated List
    • Third-party license information
  • Privacy overview
  1. Vivox Core SDK documentation

vx_req_aux_capture_audio_start

Learn about audio management.
Read time 1 minute
Last updated 8 months ago

Module: Audio Devices
Ensure that a specific selected capture device is functioning properly. More...
#include <VxcRequests.h>

Public Attributes

Name

vx_req_base_tbase
The common properties for all requests.
intduration
intloop_to_render_device
Loop audio to the selected render device.
VX_HANDLEaccount_handle
An optional parameter that specifies the account handle of the user whose capture device will be used.

Detailed Description

struct vx_req_aux_capture_audio_start;
Ensure that a specific selected capture device is functioning properly.
See: vx_resp_aux_capture_audio_start
This can only be successfully invoked if the capture device is not currently in use (such as if it is in a voice session). After the start audio capture method successfully completes, the Vivox SDK sound system starts sending VxAudioEvent_t events at one half the capture frame rate.

Public Attributes Documentation

variable base

vx_req_base_t base;
The common properties for all requests.

variable duration

int duration;
Deprecated:
This is deprecated and should not be used.

variable loop_to_render_device

int loop_to_render_device;
Loop audio to the selected render device.
The default value is 0. To loop audio to a speaker, set this to 1.

variable account_handle

VX_HANDLE account_handle;
An optional parameter that specifies the account handle of the user whose capture device will be used.
This must either be unset or the account_handle that was passed in to a vx_req_account_anonymous_login request that previously succeeded. If unset, the default account_handle is used.

Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

  • On this page
    • Public Attributes

    • Detailed Description

    • Public Attributes Documentation

      • variable base

      • variable duration

      • variable loop_to_render_device

      • variable account_handle


Report a problem with this page