Documentation

​
​

Development

User Acquisition

Monetization

Industry

Vivox Unreal SDK

Vivox Unreal SDK

Vivox
​
​
Vivox Unreal SDK
  • Overview
  • Get started
  • Release notes
  • Developer guide
    • Set up your project
    • Unity Authentication Service in Unreal
    • Create voice and text channels
    • Messaging
    • Audio management
    • Muting
      • Mute a user's microphone
      • Mute other users
      • Crossmute functions
    • In-game moderation
    • Android app development
    • iOS app development
    • Server-side recording
    • Speech-to-text audio transcription
    • Text-to-speech
    • Real-time recording
    • Transmission
    • Troubleshooting
  • Tutorials
  • Reference
  1. Vivox Unreal SDK documentation

Mute a user's microphone

How to mute the local player microphone.
Read time 2 minutes
Last updated 8 months 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.
Note
Unless you need to manage which channels a user can speak into, it's recommended that you use this method for consistency purposes.
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:
  • All channels
  • One channel
  • No channels
Note
If you are transmitting to a channel, then you must transmit to either all channels or to only one channel. For example, if you are joined to channels A, B, and C, you cannot transmit to A and B but not to C.

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)
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

    • AudioInputDevices

    • SetTransmissionMode()

      • Transmit to all channels

      • Transmit to one channel

      • Transmit to no channels

Report a problem with this page