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
    • In-game moderation
    • Android app development
    • iOS app development
    • Server-side recording
    • Speech-to-text audio transcription
      • Audio transcription conditions
      • Audio transcription delivery
      • Enable speech-to-text transcription
      • Disable speech-to-text transcription
      • Audio transcription language support
      • Audio transcription error codes
    • Text-to-speech
    • Real-time recording
    • Transmission
    • Troubleshooting
  • Tutorials
  • Reference
  1. Vivox Unreal SDK documentation
  3. Speech-to-text audio transcription

Enable speech-to-text transcription

Enable automatic transcription of voice communications in channels using speech-to-text technology.
Read time 1 minute
Last updated 8 months ago
Note
Speech-to-text audio transcription is in limited early release and must be enabled by Vivox. For pricing information and to enable this service for your organization, contact your sales representative.
To enable speech-to-text transcription in a channel, call IChannelSession::BeginSetChannelTranscription() from a connected channel session with a value of true and an access token that is generated with a 
trxn
vxa claim.
For more information, refer to the Access Token Developer Guide.
To determine when an Unreal channel is fully connected, bind a callback handler for 
EventChannelStateChanged
events and wait for when the channel session's overall connection State moves to the Connected state.
Note
For debugging purposes, you can obtain an insecure token by using 
IChannelSession::GetTranscriptionToken()
.
To check if speech-to-text transcription is enabled for a channel session, use 
IChannelSession::IsSessionBeingTranscribed()
.
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.

    Report a problem with this page
    ​
    ​