Documentation

Development

User Acquisition

Monetization

Industry

Vivox Core SDK

Vivox Core SDK

Vivox
​
​
Vivox Core SDK
  • Overview
  • Before you begin
  • Get started
  • Release notes
  • Developer Guide
    • Client SDK basics
    • Channels
    • Presence management
    • Messaging
    • Manage audio
    • Couch co-op
    • Android app development
    • iOS app development
    • macOS app development
    • Windows app development
    • Real-time 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
    • Troubleshooting
  • Reference
  • Privacy overview
  1. Vivox Core SDK documentation
  3. Speech-to-text audio transcription

Enable speech-to-text transcription

Enable speech-to-text transcription.
Read time 1 minute
Last updated 5 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, issue a 
vx_req_session_transcription_control
request with the enable field set to 1 and the 
session_handle
field set to the handle of the already joined channel. The Vivox access token (the 
access_token
parameter) must be generated with a 
trxn
vxa claim.
For more information, refer to the Access Token Developer Guide.
Note
Before you issue the 
vx_req_session_transcription_control
request, the session must receive the 
vx_evt_media_stream_updated
event with a state of 
session_media_connected
. This event arrives after 
vx_evt_participant_added
for the local user, so it's the single sufficient condition. Calling the request before media is connected will return error 1028 (
VX_E_SESSION_DOES_NOT_HAVE_AUDIO
).
The Vivox SDK responds to the 
vx_req_session_transcription_control
request with a 
vx_resp_session_transcription_control
response. The return_code parameter is 0 on success, otherwise it returns a non-zero parameter.
The following code is an example of how to enable speech-to-text transcription.
. . .vx_req_session_transcription_control_t *req;vx_req_session_transcription_control_create(&req);req->session_handle = vx_strdup("mychannel");req->enable = 1;req->access_token = vx_strdup (access_token.c_str());vx_issue_request2(&req->base);. . .void HandleResponse(vx_resp_session_transcription_control *resp){    if (resp->base.return_code != 0)    {        printf("Failed to set transcription status (status: %s) \n", vx_get_error_string(resp->base.status_code));    }    else    {        printf("Transcription status successfully updated\n");    }}. . .
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
    ​
    ​