Enable speech-to-text transcription
Enable speech-to-text transcription.
Read time 1 minuteLast updated 3 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 request with the enable field set to 1 and the field set to the handle of the already joined channel. The Vivox access token (the parameter) must be generated with a vxa claim.
vx_req_session_transcription_controlsession_handleaccess_tokentrxnFor more information, refer to the Access Token Developer Guide.
Note
Before you issue the request, the session must receive the event with a state of . This event arrives after for the local user, so it's the single sufficient condition. Calling the request before media is connected will return error 1028 ().
vx_req_session_transcription_controlvx_evt_media_stream_updatedsession_media_connectedvx_evt_participant_addedVX_E_SESSION_DOES_NOT_HAVE_AUDIOThe Vivox SDK responds to the request with a response. The return_code parameter is 0 on success, otherwise it returns a non-zero parameter.
vx_req_session_transcription_controlvx_resp_session_transcription_controlThe 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"); }}. . .