Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Mute a user's microphone

How to mute the local player microphone.
Read time 1 minuteLast updated 2 days ago
There are two methods for muting a user’s microphone: 
AudioInputDevices
or 
SetTransmissionMode()
. Each method is beneficial for different scenarios, which are detailed in the following sections.

AudioInputDevices

Use 
AudioInputDevices
if you want a user to transmit to one channel at a time, or if you want to mute the user's microphone in all channels. This method mutes a user’s microphone across the client. The following code displays an example of how to use 
AudioInputDevices
. 
//mutedVivoxVoiceClient->AudioInputDevices().SetMuted(true)//unmutedVivoxVoiceClient->AudioInputDevices().SetMuted(false)

SetTransmissionMode()

Use 
SetTransmissionMode()
when you are managing multiple channels. You can transmit to channels by using one of the following methods:

Transmit to all channels

Use 
TransmissionMode::All
when you want to create a realistic environment. For example, if a player is talking into a two-way radio, a developer might want other players to also hear the player in the 3D space. By using 
TransmissionMode::All
, when the player speaks, both the players in the two-way radio channel and the players nearby in the world chat can hear the player. 
LoginSession.SetTransmissionMode(TransmissionMode::All)

Transmit to one channel

Use 
Transmission::Single
to determine which channel the player is talking into. For example, a player might be in two squad chats, and they can listen to both channels simultaneously. By using 
Transmission::Single
, the player can speak into one channel at a time. 
LoginSession.SetTransmissionMode(TransmissionMode::Single, ChannelId singleChannel)

Transmit to no channels

Use 
Transmission::None
to prevent a player from being heard in any channels. 
LoginSession.SetTransmissionMode(TransmissionMode::None)