tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Game Multimedia Engine
    Documentation
    Download PDF

    Speech-to-Text Service

    Last updated: 2024-01-18 15:11:45
    Download PDF
      This document describes how to integrate with and debug the GME APIs for iOS.
      Note:
      This document applies to GME SDK version 2.9.

      Key Considerations for Using GME

      GME provides two services: Voice chat service and voice messaging and speech-to-text service, both of which rely on key APIs such as Init and Poll.
      Note:
      There is a default call rate limit for speech-to-text APIs. For more information on how calls are billed within the limit, see Purchase Guide. If you want to increase the limit or learn more about how excessive calls are billed, submit a ticket.
      Non-streaming speech-to-text API SpeechToText(): There can be up to 10 concurrent requests per account.
      Streaming speech-to-text API StartRecordingWithStreamingRecognition(): There can be up to 50 concurrent requests per account.
      Real-time streaming speech-to-text API StartRealTimeASR(): There can be up to 50 concurrent requests per account.
      Note on Init API
      If you need to use voice chat and voice message services at the same time, you only need to call Init API once. The billing will not start after initialization. Receiving or sending a voice message in speech-to-text service is counted as a voice message DAU.
      
      image
      
      

      Directions

      1. Initializing GMEAPI: Init
      2. Calling Poll periodically to trigger event callbacksAPI: Poll
      3. Initializing authenticationAPI: ApplyPTTAuthbuffer
      4. Starting streaming speech recognitionAPI: StartRecordingWithStreamingRecognition
      5. Stop recordingAPI: StopRecording
      6. Uninitializing GMEAPI: UnInit

      Important notes

      Configure your project before using GME; otherwise, the SDK will not take effect.
      After a GME API is called successfully, QAVError.OK will be returned with the value being 0.
      GME APIs should be called in the same thread.
      The Poll API should be called periodically for GME to trigger event callbacks.
      For detailed error code, see Error Codes.

      Core APIs

      Before the initialization, the SDK is in the uninitialized status, and you need to initialize it through the Init API before you can use the voice chat and speech-to-text services.
      Call the Init API before calling any APIs of GME.
      If you have any questions when using the service, see General.
      API
      Description
      InitEngine
      Initializes GME
      Poll
      Triggers event callback
      Pause
      Pauses the system
      Resume
      Resumes the system
      Uninit
      Uninitializes GME
      SetDefaultAudienceAudioCategory
      Sets audio playback in background on device

      Imported header files

      #import "GMESDK/TMGEngine.h"
      #import "GMESDK/QAVAuthBuffer.h"

      Getting singleton

      To use the voice feature, get the ITMGContext object first.
      + (ITMGContext*) GetInstance;

      Sample code

      //TMGSampleViewController.m
      ITMGContext* _context = [ITMGContext GetInstance];

      Setting callbacks

      The API class uses the Delegate method to send callback notifications to the application. Register the callback function to the SDK for receiving callback messages.

      Sample code

      ITMGDelegate is used for declaration.
      @interface TMGDemoViewController ()<ITMGDelegate>{}
      ITMGDelegate < NSObject >
      
      //TMGSampleViewController.m
      ITMGContext* _context = [ITMGContext GetInstance];
      _context.TMGDelegate = [DispatchCenter getInstance];
      The API callback messages is processed in OnEvent. For the message type, see ITMG_MAIN_EVENT_TYPE. The message content is a dictionary for parsing the API callback contents.

      Function prototype

      - (void)OnEvent:(ITMG_MAIN_EVENT_TYPE)eventType data:(NSDictionary*)data;

      Sample code

      //TMGRealTimeViewController.m
      TMGRealTimeViewController ()< ITMGDelegate >
      
      
      - (void)OnEvent:(ITMG_MAIN_EVENT_TYPE)eventType data:(NSDictionary *)data {
          NSString *log = [NSString stringWithFormat:@"OnEvent:%d,data:%@", (int)eventType, data];
          [self showLog:log];
          NSLog(@"====%@====", log);
          switch (eventType) {
              // Step 6/11 : Perform the enter room event
              case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM: {
                  int result = ((NSNumber *)[data objectForKey:@"result"]).intValue;
                  NSString *error_info = [data objectForKey:@"error_info"];
      
                  [self showLog:[NSString stringWithFormat:@"OnEnterRoomComplete:%d msg:(%@)", result, error_info]];
      
                  if (result == 0) {
                      [self updateStatusEnterRoom:YES];
                  }
              }
              break;
          }
      }
      
      // Refer to DispatchCenter.h and DispatchCenter.m

      Initializing SDK

      This API is used to initialize the GME service. It is recommended to call it when initializing the application. No fee is incurred for calling this API.
      For more information on how to get the sdkAppID parameter, see Activating Services.
      The openID uniquely identifies a user with the rules stipulated by the application developer and unique in the application (currently, only INT64 is supported).
      Note:
      The Init API must be called in the same thread with other APIs. It is recommended to call all APIs in the main thread.

      Function prototype

      -(int)InitEngine:(NSString*)sdkAppID openID:(NSString*)openID;
      Parameter
      Type
      Description
      sdkAppId
      String
      AppId provided by the GME service from the Tencent Cloud console
      OpenId
      String
      OpenId can only be in Int64 type, which is passed after being converted to a string.
      Returned Value
      Description
      QAV_OK= 0
      Initialized SDK successfully.
      QAV_ERR_SDK_NOT_FULL_UPDATE= 7015
      Checks whether the SDK file is complete. It is recommended to delete it and then import the SDK again.
      The returned value AV_ERR_SDK_NOT_FULL_UPDATE is only a reminder but will not cause an initialization failure.
      If this error is reported during integration, please check the integrity and version of the SDK file as prompted.
      If this error is returned after executable file export, please ignore it and try to avoid displaying it in the UI.

      Sample code

      _openId = _userIdText.text;
      _appId = _appIdText.text;
      [[ITMGContext GetInstance] InitEngine:SDKAPPID openID:_openId];

      Triggering event callback

      Event callbacks can be triggered by periodically calling the Poll API in update. The Poll API should be called periodically for GME to trigger event callbacks; otherwise, the entire SDK service will run exceptionally. Refer to the EnginePollHelper.m file in Demo.
      Note:
      The Poll API must be called periodically and in the main thread to avoid abnormal API callbacks.

      Function prototype

      -(void)Poll;
      

      Sample code

      [[ITMGContext GetInstance] Poll];
      

      Pausing the system

      When a Pause event occurs in the system, the engine should also be notified for pause. If you need to pause the audio when switching to the background, you can call the Pause API in the listening code used to switch to the background, and call the Resume API in the listening event used to resume the foreground.

      Function prototype

      -(QAVResult)Pause;
      

      Resuming the system

      When a Resume event occurs in the system, the engine should also be notified for resumption. The Resume API only supports resuming voice chat.

      Function prototype

      -(QAVResult)Resume;
      

      Uninitializing SDK

      This API is used to uninitialize the SDK to make it uninitialized. Switching accounts requires uninitialization.

      Function prototype

      -(int)Uninit;
      

      Sample code

      [[ITMGContext GetInstance] Uninit];
      

      Audio settings for iOS device

      This API is used to set the audio playback in the background, and the GME audio not to be affected by the mute switch or lock screen. For example, when the notification center or control center is opened, you can still receive and play back the GME audio. You need to call this API before room entry. Meanwhile, you should pay attention to the following two points in the application:
      Audio engine capture and playback are not paused when the application is switched to the background (i.e., PauseAudio).
      You need to add at least key:Required background modes and string:App plays audio or streams audio/video using AirPlay to the Info.plist of the application.
      Note:
      It is recommended that developers call this API to set the audio.

      Function prototype

      -(QAVResult)SetDefaultAudienceAudioCategory:(ITMG_AUDIO_CATEGORY)audioCategory;
      
      Type
      Parameter
      Description
      ITMG_CATEGORY_AMBIENT
      0
      Audio is not played back in the background (default value)
      ITMG_CATEGORY_PLAYBACK
      1
      Audio is played back in the background
      This can be achieved by modifying kAudioSessionProperty_AudioCategory. For more information, see Apple official documentation.

      Sample code

      [[ITMGContext GetInstance]SetDefaultAudienceAudioCategory:ITMG_CATEGORY_AMBIENT];
      

      Speech-to-Text

      Voice messaging refers to recording and sending a voice message. At the same time, the voice message can be converted to text and translated, as shown below:
      
      
      
      Note:
      It is recommended to use the streaming speech-to-text service.
      You do not need to enter a voice chat room when using the voice messaging service.

      Voice message and speech-to-text conversion flowchart

      
      
      

      Integrating Voice Messaging and Speech-to-Text Service

      Voice messaging and speech-to-text APIs

      API
      Description
      ApplyPTTAuthbuffer
      Initializes authentication
      SetMaxMessageLength
      Specifies the maximum length of voice message
      StartRecording
      Starts recording
      StartRecordingWithStreamingRecognition
      Starts streaming recording
      PauseRecording
      Pauses recording
      ResumeRecording
      Resumes recording
      StopRecording
      Stops recording
      CancelRecording
      Cancels recording
      GetMicLevel
      Gets the real-time mic volume
      SetMicVolume
      Sets the recording volume
      GetMicVolume
      Gets the recording volume
      GetSpeakerLevel
      Gets the real-time speaker volume
      SetSpeakerVolume
      Sets the playback volume
      GetSpeakerVolume
      Gets the playback volume
      UploadRecordedFile
      Uploads the audio file
      DownloadRecordedFile
      Downloads the audio file
      PlayRecordedFile
      Plays back audio
      StopPlayFile
      Stops playing back audio
      GetFileSize
      Gets the audio file size
      GetVoiceFileDuration
      Gets the audio file duration
      SpeechToText
      Converts speech to text
      Maximum recording duration
      The maximum recording duration of a voice message is 58 seconds by default, and the minimum recording duration cannot be less than 1 second. If you want to customize the recording duration, for example, to modify the maximum recording duration to 10 seconds, please call the SetMaxMessageLength API to set it after initialization.

      Initializing the SDK

      Before the initialization, the SDK is in the uninitialized status, and you need to initialize it through the Init API before you can use the voice chat and voice message services.
      If you have any questions when using the service, see Speech-to-text Conversion.

      Authentication information

      Generate AuthBuffer for encryption and authentication of relevant features. For release in the production environment, use the backend deployment key as detailed in Authentication Key.
      To get authentication for voice message and speech-to-text, the room ID parameter must be set to null.

      Function prototype

      @interface QAVAuthBuffer : NSObject
      + (NSData*) GenAuthBuffer:(unsigned int)appId roomId:(NSString*)roomId openID:(NSString*)openID key:(NSString*)key;
      + @end
      
      Parameter
      Type
      Description
      appId
      int
      AppId from the Tencent Cloud console.
      roomId
      NSString
      Enter null.
      openID
      NSString
      User ID, which is the same as openID during initialization.
      key
      NSString
      Permission key from the Tencent Cloud console.

      Sample code

      #import "GMESDK/QAVAuthBuffer.h"
      NSData* authBuffer = [QAVAuthBuffer GenAuthBuffer:SDKAPPID3RD.intValue roomId:_roomId openID:_openId key:AUTHKEY];
      

      Initializing authentication

      Call authentication initialization after initializing the SDK. For more information on how to get the authBuffer, please see genAuthBuffer (the voice chat authentication information API).

      Function prototype

      public abstract int ApplyPTTAuthbuffer(byte[] authBuffer);
      
      Parameter
      Type
      Description
      authBuffer
      NSData*
      Authentication

      Sample code

      [[[ITMGContext GetInstance]GetPTT]ApplyPTTAuthbuffer:(NSData *)authBuffer];
      

      Streaming Speech Recognition

      Starting streaming speech recognition

      This API is used to start streaming speech recognition. Text obtained from speech-to-text conversion will be returned in real time in its callback. It can specify a language for recognition or translate the information recognized in speech into a specified language and return the translation. To stop recording, call StopRecording. The callback will be returned after the recording is stopped.

      Function prototype

      -(int)StartRecordingWithStreamingRecognition:(NSString *)filePath;
      -(int)StartRecordingWithStreamingRecognition:(NSString *)filePath language:(NSString*)speechLanguage translatelanguage:(NSString*)translateLanguage;
      
      Parameter
      Type
      Description
      filePath
      String
      Path of stored audio file
      speechLanguage
      String
      The language in which the audio file is to be converted to text. For parameters, please see Language Parameter Reference List
      translateLanguage
      String
      The language into which the audio file will be translated. For parameters, please see Language Parameter Reference List (This parameter is currently unavailable. Enter the same value as that of speechLanguage)

      Sample code

      recordfilePath = [docDir stringByAppendingFormat:@"/test_%d.ptt",index++];
      [[[ITMGContext GetInstance] GetPTT] StartRecordingWithStreamingRecognition:recordfilePath language:@"cmn-Hans-CN"];
      

      Callback for streaming speech recognition

      After streaming speech recognition is started, you need to listen for callback messages in the callback function onEvent. Event messages are divided into:
      ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_COMPLETE returns text after the recording is stopped and the recognition is completed, which is equivalent to returning the recognized text after a paragraph of speech.
      ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_IS_RUNNING returns the recognized text in real-time during the recording, which is equivalent to returning the recognized text while speaking.
      The event message will be identified in the OnEvent function based on the actual needs. The passed parameters include the following four messages.
      Message Name
      Description
      result
      A return code for judging whether the streaming speech recognition is successful.
      text
      Text converted from speech
      file_path
      Local path of stored recording file
      file_id
      Backend URL address of recording file, which will be retained for 90 days. fileid is fixed at http://gme-v2-
      Note:
      The file_id is empty when the 'ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRecognition_IS_RUNNING' message is listened.

      Error codes

      Error Code
      Description
      Suggested Solution
      32775
      Streaming speech-to-text conversion failed, but recording succeeded.
      Call the UploadRecordedFile API to upload the recording file and then call the SpeechToText API to perform speech-to-text conversion.
      32777
      Streaming speech-to-text conversion failed, but recording and upload succeeded.
      The message returned contains a backend URL after successful upload. Call the SpeechToText API to perform speech-to-text conversion.
      32786
      Streaming speech-to-text conversion failed.
      During streaming recording, wait for the execution result of the streaming recording API to return.

      Sample code

      - (void)OnEvent:(ITMG_MAIN_EVENT_TYPE)eventType data:(NSDictionary*)data
      {
          NSNumber *number = [data objectForKey:@"result"];
          switch (eventType)
          {
              case ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_COMPLETE:
              {
                  if (data != NULL &&[[data objectForKey:@"result"] intValue]== 0)
                  {
                      donwLoadUrlPath = data[@"file_id"];
      
                      recordfilePath = [data objectForKey:@"file_path"];
                      _localFileField.text = recordfilePath;
      
                      _donwloadUrlField.text = [data objectForKey:@"file_id"] ;
      
                      UITextField *_audiotoTextField =(UITextField*)objc_getAssociatedObject(self, [PTT_AUDIO_TO_TEXT UTF8String]);
                      _audiotoTextField.text = [data objectForKey:@"text"] ;
                  }
      
              }
                  break;
          }    
      }	
      

      Voice Message Recording

      The recording process is as follows: start recording -> stop recording -> return recording callback -> start the next recording.

      Specifying the maximum duration of voice message

      This API is used to specify the maximum duration of a voice message, which can be up to 58 seconds.

      Function prototype

      -(QAVResult)SetMaxMessageLength:(int)msTime
      
      Parameter
      Type
      Description
      msTime
      int
      Audio duration in ms. Value range: 1000 < msTime <= 58000

      Sample code

      [[[ITMGContext GetInstance]GetPTT]SetMaxMessageLength:(int)msTime];
      

      Starting recording

      This API is used to start recording. The recording file must be uploaded first before you can perform operations such as speech-to-text conversion. To stop recording, call StopRecording.

      Function prototype

      -(int)StartRecording:(NSString*)filePath;
      
      Parameter
      Type
      Description
      filePath
      NSString
      Path of stored audio file

      Sample code

      recordfilePath =[docDir stringByAppendingFormat:@"/test_%d.ptt",index++];
      [[[ITMGContext GetInstance]GetPTT]StartRecording:recordfilePath];
      

      Stopping recording

      This API is used to stop recording. It is async, and a callback for recording completion will be returned after recording stops. A recording file will be available only after recording succeeds.

      Function prototype

      -(QAVResult)StopRecording;
      

      Sample code

      [[[ITMGContext GetInstance]GetPTT]StopRecording];
      

      Callback for recording start

      A callback will be executed through a delegate function to pass a message when recording is completed.
      To stop recording, call StopRecording. The callback for recording start will be returned after the recording is stopped.
      The callback function OnEvent will be called after recording is started. The event message ITMG_MAIN_EVNET_TYPE_PTT_RECORD_COMPLETE will be returned, which will be identified in the OnEvent function. The passed parameter includes result and file_path.

      Error codes

      Error Code Value
      Cause
      Suggested Solution
      4097
      Parameter is empty.
      Check whether the API parameters in the code are correct.
      4098
      Initialization error.
      Check whether the device is being used, whether the permissions are normal, and whether the initialization is normal.
      4099
      Recording is in progress.
      Ensure that the SDK recording feature is used at the right time.
      4100
      Audio data is not captured.
      Check whether the mic is working properly.
      4101
      An error occurred while accessing the file during recording.
      Ensure the existence of the file and the validity of the file path.
      4102
      The mic is not authorized.
      Mic permission is required for using the SDK. To add the permission, please see the SDK project configuration document for the corresponding engine or platform.
      4103
      The recording duration is too short.
      The recording duration should be in ms and longer than 1,000 ms.
      4104
      No recording operation is started.
      Check whether the recording starting API has been called.

      Sample code

      -(void)OnEvent:(ITMG_MAIN_EVENT_TYPE)eventType data:(NSDictionary *)data{
          NSLog(@"OnEvent:%lu,data:%@",(unsigned long)eventType,data);
          switch (eventType) {
              case ITMG_MAIN_EVNET_TYPE_PTT_RECORD_COMPLETE:
              {
              //Recording callback
              }
                  break;
          }
      }
      

      Pausing recording

      This API is used to pause recording. If you want to resume recording, please call the ResumeRecording API.

      Function prototype

      -(int)PauseRecording;
      

      Sample code

      [[[ITMGContext GetInstance]GetPTT]PauseRecording];
      

      Resuming recording

      This API is used to resume recording.

      Function prototype

      -(int)ResumeRecording;
      

      Sample code

      [[[ITMGContext GetInstance]GetPTT]ResumeRecording];
      

      Canceling recording

      This API is used to cancel recording. There is no callback after cancellation.

      Function prototype

      -(QAVResult)CancelRecording;
      

      Sample code

      [[[ITMGContext GetInstance]GetPTT]CancelRecording];
      

      Getting the real-time mic volume of voice message

      This API is used to get the real-time mic volume. An int-type value will be returned. Value range: 0-200.
      Note:
      This API is different from the voice chat API and is in ITMGPTT.

      Function prototype

      -(QAVResult)GetMicLevel;
      

      Sample code

      [[[ITMGContext GetInstance]GetPTT]GetMicLevel];
      

      Setting the recording volume of voice message

      This API is used to set the recording volume of voice message. Value range: 0-200.
      Note:
      This API is different from the voice chat API and is in ITMGPTT.

      Function prototype

      -(QAVResult)SetMicVolume:(int) volume;
      

      Sample code

      [[[ITMGContext GetInstance]GetPTT]SetMicVolume:100];
      

      Getting the recording volume of voice message

      This API is used to get the recording volume of voice message. An int-type value will be returned. Value range: 0-200.
      Note:
      This API is different from the voice chat API and is in ITMGPTT.

      Function prototype

      -(int)GetMicVolume;
      

      Sample code

      [[[ITMGContext GetInstance]GetPTT]GetMicVolume];
      

      Getting the real-time speaker volume of voice message

      This API is used to get the real-time speaker volume. An int-type value will be returned. Value range: 0-200.
      Note:
      This API is different from the voice chat API and is in ITMGPTT.

      Function prototype

      -(QAVResult)GetSpeakerLevel;
      

      Sample code

      [[[ITMGContext GetInstance]GetPTT]GetSpeakerLevel];
      

      Setting the playback volume of voice message

      This API is used to set the playback volume of voice messaging. Value range: 0-200.
      Note:
      This API is different from the voice chat API and is in ITMGPTT.

      Function prototype

      -(QAVResult)SetSpeakerVolume:(int)volume;
      

      Sample code

      [[[ITMGContext GetInstance]GetPTT]SetSpeakerVolume:100];
      

      Getting the playback volume of voice message

      This API is used to get the playback volume of voice messaging. An int-type value will be returned. Value range: 0-200.
      Note:
      This API is different from the voice chat API and is in ITMGPTT.

      Function prototype

      -(int)GetSpeakerVolume;
      

      Sample code

      [[[ITMGContext GetInstance]GetPTT]GetSpeakerVolume];
      

      Voice Message Playback

      Playing back audio

      This API is used to play back audio.

      Function prototype

      -(int)PlayRecordedFile:(NSString*)filePath;
      -(int)PlayRecordedFile:(NSString*)filePath VoiceType:(ITMG_VOICE_TYPE) type;
      
      Parameter
      Type
      Description
      downloadFilePath
      NSString
      Local audio file path
      type
      ITMG_VOICE_TYPE
      Voice changer type. For more information, see Voice Changing Effects.

      Error codes

      Error Code Value
      Cause
      Suggested Solution
      20485
      Playback is not started.
      Ensure the existence of the file and the validity of the file path.

      Sample code

      [[[ITMGContext GetInstance]GetPTT]PlayRecordedFile:path];
      

      Callback for audio playback

      After the audio is played back, the event message ITMG_MAIN_EVNET_TYPE_PTT_PLAY_COMPLETE will be returned, which will be identified in the OnEvent function. The passed parameter includes result and file_path.

      Error codes

      Error Code Value
      Cause
      Suggested Solution
      20481
      Initialization error.
      Check whether the device is being used, whether the permissions are normal, and whether the initialization is normal.
      20482
      During playback, the client tried to interrupt and play back the next one but failed (which should succeed normally).
      Check whether the code logic is correct.
      20483
      Parameter is empty.
      Check whether the API parameters in the code are correct.
      20484
      Internal error.
      An error occurred while initializing the player. This error code is generally caused by failure in decoding, and the error should be located with the aid of logs.

      Sample code

      -(void)OnEvent:(ITMG_MAIN_EVENT_TYPE)eventType data:(NSDictionary *)data{
          NSLog(@"OnEvent:%lu,data:%@",(unsigned long)eventType,data);
          switch (eventType) {
              case ITMG_MAIN_EVNET_TYPE_PTT_PLAY_COMPLETE:
              {
              // Callback for audio playback 
              }
                  break;
          }
      }
      

      Stopping audio playback

      This API is used to stop audio playback. There will be a callback for playback completion when the playback stops.

      Function prototype

      -(int)StopPlayFile;
      

      Sample code

      [[[ITMGContext GetInstance]GetPTT]StopPlayFile];
      

      Getting audio file size

      This API is used to get the size of an audio file.

      Function prototype

      -(int)GetFileSize:(NSString*)filePath;
      
      Parameter
      Type
      Description
      filePath
      NSString
      Path of audio file, which is a local path.

      Sample code

      [[[ITMGContext GetInstance]GetPTT]GetFileSize:path];
      

      Getting audio file duration

      This API is used to get the duration of an audio file in milliseconds.

      Function prototype

      -(int)GetVoiceFileDuration:(NSString*)filePath；
      
      Parameter
      Type
      Description
      filePath
      NSString
      Path of audio file, which is a local path.

      Sample code

      [[[ITMGContext GetInstance]GetPTT]GetVoiceFileDuration:path];
      

      Voice Message Upload and Download

      Uploading an audio file

      This API is used to upload an audio file.

      Function prototype

      -(void)UploadRecordedFile:(NSString*)filePath;
      
      Parameter
      Type
      Description
      filePath
      NSString
      Path of uploaded audio file, which is a local path.

      Sample code

      [[[ITMGContext GetInstance]GetPTT]UploadRecordedFile:path];
      

      Callback for audio file upload completion

      After the audio file is uploaded, the event message ITMG_MAIN_EVNET_TYPE_PTT_UPLOAD_COMPLETE will be returned, which will be identified in the OnEvent function. The passed parameters include result, file_path, and file_id.

      Error codes

      Error Code Value
      Cause
      Suggested Solution
      8193
      An error occurred while accessing the file during upload.
      Ensure the existence of the file and the validity of the file path.
      8194
      Signature verification failed.
      Check whether the authentication key is correct and whether the voice message and speech-to-text feature is initialized.
      8195
      A network error occurred.
      Check whether the device can access the internet.
      8196
      The network failed while getting the upload parameters.
      Check whether the authentication is correct and whether the device can access the internet.
      8197
      The packet returned during the process of getting the upload parameters is empty.
      Check whether the authentication is correct and whether the device network can normally access the internet.
      8198
      Failed to decode the packet returned during the process of getting the upload parameters.
      Check whether the authentication is correct and whether the device can access the internet.
      8200
      No appinfo is set.
      Check whether the apply API is called or whether the input parameters are empty.

      Sample code

      -(void)OnEvent:(ITMG_MAIN_EVENT_TYPE)eventType data:(NSDictionary *)data{
          NSLog(@"OnEvent:%lu,data:%@",(unsigned long)eventType,data);
          switch (eventType) {
              case ITMG_MAIN_EVNET_TYPE_PTT_UPLOAD_COMPLETE:
              {
                  if (data != NULL &&[[data objectForKey:@"result"] intValue]== 0)
                  {
                      _donwloadUrlField.text = [data objectForKey:@"file_id"] ;
                      donwLoadUrlPath = [data objectForKey:@"file_id"] ;
                  }
              }
                  break;
          }
      }
      

      Downloading the audio file

      This API is used to download an audio file.

      Function prototype

      -(void)DownloadRecordedFile:(NSString*)fileId downloadFilePath:(NSString*)downloadFilePath 
      
      Parameter
      Type
      Description
      fileID
      NSString
      File URL path
      downloadFilePath
      NSString
      Local path of saved file

      Sample code

      [[[ITMGContext GetInstance]GetPTT]DownloadRecordedFile:fileIdpath downloadFilePath:path];
      

      Callback for audio file download completion

      After the audio file is downloaded, the event message ITMG_MAIN_EVNET_TYPE_PTT_DOWNLOAD_COMPLETE will be returned, which will be identified in the OnEvent function. The passed parameters include result, file_path, and file_id.

      Error codes

      Error Code Value
      Cause
      Suggested Solution
      12289
      An error occurred while accessing the file during download.
      Check whether the file path is valid.
      12290
      Signature verification failed.
      Check whether the authentication key is correct and whether the voice message and speech-to-text feature is initialized.
      12291
      Network storage system exception
      The server failed to get the audio file. Check whether the API parameter fileid is correct, whether the network is normal, and whether the file exists in COS.
      12292
      Server file system error.
      Check whether the device can access the internet and whether the file exists on the server.
      12293
      The HTTP network failed during the process of getting the download parameters.
      Check whether the device can access the internet.
      12294
      The packet returned during the process of getting the download parameters is empty.
      Check whether the device can access the internet.
      12295
      Failed to decode the packet returned during the process of getting the download parameters.
      Check whether the device can access the internet.
      12297
      No appinfo is set.
      Check whether the authentication key is correct and whether the voice message and speech-to-text feature is initialized.

      Sample code

      -(void)OnEvent:(ITMG_MAIN_EVENT_TYPE)eventType data:(NSDictionary *)data{
          NSLog(@"OnEvent:%lu,data:%@",(unsigned long)eventType,data);
          switch (eventType) {
              case ITMG_MAIN_EVNET_TYPE_PTT_DOWNLOAD_COMPLETE:
              {
                  if (data != NULL &&[[data objectForKey:@"result"] intValue]== 0)
                  {
                      _audiofileToPlayField.text = [data objectForKey:@"file_path"] ;
                      donwLoadLocalPath = [data objectForKey:@"file_path"];
                  }
                  else
                  {
                      donwLoadLocalPath = NULL;
                  } 
              }
                  break;
          }
      }
      

      Speech-to-Text Service

      Converting audio file to text

      This API is used to convert a specified audio file to text.

      Function prototype

      -(void)SpeechToText:(NSString*)fileID;
      
      Parameter
      Type
      Description
      fileID
      NSString
      URL of audio file

      Sample code

      [[[ITMGContext GetInstance]GetPTT]SpeechToText:fileID];
      

      Translating audio file into text in specified language

      This API can specify a language for recognition or translate the information recognized in speech into a specified language and return the translation.

      Function prototype

      -(void)SpeechToText:(NSString*)fileID (NSString*)speechLanguage (NSString*)translateLanguage;
      
      Parameter
      Type
      Description
      fileID
      NSString*
      URL of audio file, which will be retained on the server for 90 days
      speechLanguage
      NSString*
      The language in which the audio file is to be converted to text. For parameters, please see Language Parameter Reference List.
      translateLanguage
      NSString*
      The language into which the audio file will be translated. For parameters, please see Language Parameter Reference List. This parameter is currently unavailable. Enter the same value as that of speechLanguage.

      Sample code

      [[[ITMGContext GetInstance]GetPTT]SpeechToText:fileID speechLanguage:"cmn-Hans-CN" translateLanguage:"cmn-Hans-CN"];
      

      Callback for recognition

      After the specified audio file is converted to text, the event message ITMG_MAIN_EVNET_TYPE_PTT_SPEECH2TEXT_COMPLETE will be returned, which will be identified in the OnEvent function. The passed parameters include result, file_path and text (recognized text).

      Error codes

      Error Code Value
      Cause
      Suggested Solution
      32769
      An internal error occurred.
      Analyze logs, get the actual error code returned from the backend to the client, and ask backend personnel for assistance.
      32770
      Network failed.
      Check whether the device can access the internet.
      32772
      Failed to decode the returned packet.
      Analyze logs, get the actual error code returned from the backend to the client, and ask backend personnel for assistance.
      32774
      No appinfo is set.
      Check whether the authentication key is correct and whether the voice message and speech-to-text feature is initialized.
      32776
      authbuffer check failed.
      Check whether authbuffer is correct.
      32784
      Incorrect speech-to-text conversion parameter.
      Check whether the API parameter fileid in the code is empty.
      32785
      Speech-to-text translation returned an error.
      Error with the backend of voice message and speech-to-text feature. Analyze logs, get the actual error code returned from the backend to the client, and ask backend personnel for assistance.

      Sample code

      -(void)OnEvent:(ITMG_MAIN_EVENT_TYPE)eventType data:(NSDictionary *)data{
          NSLog(@"OnEvent:%lu,data:%@",(unsigned long)eventType,data);
          switch (eventType) {
              case ITMG_MAIN_EVNET_TYPE_PTT_SPEECH2TEXT_COMPLETE:
              {
                  if (data != NULL &&[[data objectForKey:@"result"] intValue]== 0)
                  {
                      UITextField *_audiotoTextField =(UITextField*)objc_getAssociatedObject(self, [PTT_AUDIO_TO_TEXT UTF8String]);
                      _audiotoTextField.text = [data objectForKey:@"text"] ;
                  }
              }
                  break;   
          }
      }
      

      Advanced APIs

      Getting version number

      This API is used to get the SDK version number for analysis.

      Function prototype

      -(NSString*)GetSDKVersion;
      

      Sample code

      [[ITMGContext GetInstance] GetSDKVersion];
      

      Checking mic permission

      This API is used to return the mic permission status.

      Function prototype

      -(ITMG_RECORD_PERMISSION)CheckMicPermission;
      

      Parameter description

      Parameter
      Value
      Description
      ITMG_PERMISSION_GRANTED
      0
      Mic permission is granted.
      ITMG_PERMISSION_Denied
      1
      Mic is disabled.
      ITMG_PERMISSION_NotDetermined
      2
      No authorization box has been popped up to request the permission.
      ITMG_PERMISSION_ERROR
      3
      An error occurred while calling the API.

      Sample code

      [[ITMGContext GetInstance] CheckMicPermission];
      

      Setting log printing level

      This API is used to set the level of logs to be printed, and needs to be called before the initialization. It is recommended to keep the default level.

      Function prototype

      -(void)SetLogLevel:(ITMG_LOG_LEVEL)levelWrite (ITMG_LOG_LEVEL)levelPrint;
      

      Parameter description

      Parameter
      Type
      Description
      levelWrite
      ITMG_LOG_LEVEL
      Sets the level of logs to be written. TMG_LOG_LEVEL_NONE indicates not to write. Default value: TMG_LOG_LEVEL_INFO
      levelPrint
      ITMG_LOG_LEVEL
      Sets the level of logs to be printed. TMG_LOG_LEVEL_NONE indicates not to print. Default value: TMG_LOG_LEVEL_ERROR

      ITMG_LOG_LEVEL

      ITMG_LOG_LEVEL
      Description
      TMG_LOG_LEVEL_NONE
      Does not print logs
      TMG_LOG_LEVEL_ERROR
      Prints error logs (default)
      TMG_LOG_LEVEL_INFO
      Prints info logs
      TMG_LOG_LEVEL_DEBUG
      Prints debug logs
      TMG_LOG_LEVEL_VERBOSE
      Prints verbose logs

      Sample code

      [[ITMGContext GetInstance] SetLogLevel:TMG_LOG_LEVEL_INFO TMG_LOG_LEVEL_INFO];
      

      Setting the log printing path

      This API is used to set the log printing path, and needs to be called before initialization. The default path is Application/********-****-****-************/Documents.

      Function prototype

      -(void)SetLogPath:(NSString*)logDir;
      
      Parameter
      Type
      Description
      logDir
      NSString
      Path

      Sample code

      [[ITMGContext GetInstance] SetLogPath:Path];
      

      Callback Messages

      Message list

      Message
      Description
      ITMG_MAIN_EVNET_TYPE_PTT_RECORD_COMPLETE
      Indicates that PTT recording is completed.
      ITMG_MAIN_EVNET_TYPE_PTT_UPLOAD_COMPLETE
      Indicates that PTT upload is completed.
      ITMG_MAIN_EVNET_TYPE_PTT_DOWNLOAD_COMPLETE
      Indicates that PTT download is completed.
      ITMG_MAIN_EVNET_TYPE_PTT_PLAY_COMPLETE
      Indicates that PTT playback is completed.
      ITMG_MAIN_EVNET_TYPE_PTT_SPEECH2TEXT_COMPLETE
      Indicates that speech-to-text conversion is completed.

      Data list

      Message
      Data
      Sample
      ITMG_MAIN_EVNET_TYPE_PTT_RECORD_COMPLETE
      result; file_path
      {"file_path":"","result":0}
      ITMG_MAIN_EVNET_TYPE_PTT_UPLOAD_COMPLETE
      result; file_path;file_id
      {"file_id":"","file_path":"","result":0}
      ITMG_MAIN_EVNET_TYPE_PTT_DOWNLOAD_COMPLETE
      result; file_path;file_id
      {"file_id":"","file_path":"","result":0}
      ITMG_MAIN_EVNET_TYPE_PTT_PLAY_COMPLETE
      result; file_path
      {"file_path":"","result":0}
      ITMG_MAIN_EVNET_TYPE_PTT_SPEECH2TEXT_COMPLETE
      result; text;file_id
      {"file_id":"","text":"","result":0}
      ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_COMPLETE
      result; file_path; text;file_id
      {"file_id":"","file_path":","text":"","result":0}
      
      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy