Couch co-op configuration
Configure couch co-op for local multiplayer.
Read time 1 minuteLast updated 7 months ago
Many Vivox API request and event types include an additional field that identifies a particular user on a device. In those request types, this field is optional; if left unset, the first user who signs in is the default.
account_handleNote
No changes are required in the Vivox SDK initialization workflow for the or the request.
vx_initialize3()vx_req_connector_createTo begin a multi-user voice play session, simultaneously sign in multiple users by using the request, with different values specified for each of the different users.
vx_req_account_anonymous_loginaccount_handleNote
For couch co-op implementations, you receive a unique set of events for each user who is signed in. Use the attribute to differentiate the events for each user. For more information, refer to Network connection state events.
account_handleAfter multiple users are signed in, you must assign them separate render and capture devices. You can design your game to automatically select these devices, or the game can present a UI to allow users to select their specific devices.
-
To enumerate the list of valid devices, use theand
vx_req_aux_get_render_devicesrequests.vx_req_aux_get_capture_devices -
To set the capture and render devices for each user, you must calland
vx_req_aux_set_render_devicewith each user's account handle to assign specific devices to specific users.vx_req_aux_set_capture_deviceNoteThis request is required because audio devices are not automatically associated with each user.
Set other device attributes on a per-user basis, such as the mute status, volume, and voice activity detector (VAD) properties, by supplying the corresponding user's in the request type.
account_handleYou can also add users to their own independent sets of session groups and sessions, or add them to the same sessions. If you add multiple users on the same device to the same session, then use the request to locally mute those users to each other so they do not hear an in-channel echo of anyone who is speaking that is physically nearby to them.
vx_req_session_set_participant_mute_for_me