Documentation

Support

Vivox Unreal SDK

Vivox Unreal SDK

Push-to-talk

Implement push-to-talk voice transmission mode.
Read time 1 minuteLast updated 2 days ago

Many games feature push-to-talk (PTT) functionality, which allows users to control when they have a live microphone. For most users, it is sufficient to globally mute or unmute the microphone by using
IAudioDevices::SetMuted()
. However, the following scenarios detail when we recommend that you instead use transmission to selectively silence a user.
  • If a user has more than one audio source (for example, if they are both speaking into a microphone and are injecting audio), then muting only the microphone does not stop the injected audio. For example, if someone else mutes the user, then all of the user's audio is muted. To use PTT to turn on or turn off muting for both microphone audio and injected audio, we recommend that you set transmission between
    None
    and
    Single/All
    .
  • If a user is in two audio channels (for example, 2D team chat and 3D area chat), and you want separate PTT keys for each channel to allow the user to speak into only one channel (or both) at a time when enabled, and into no channels when disabled, then we recommend that you use SetTransmissionMode() between each of the different modes as appropriate. If you want a single PTT key to turn on or turn off muting for all channels at a time rather than individually, then switching transmission between
    All/None
    has no real advantage over only muting the mic, except for when you are injecting audio.