tencent cloud

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.

Directions

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 CodesErrorCode.

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.

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;

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;

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

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

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);

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;

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.

Note

The file_id is empty when the 'ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRecognition_IS_RUNNING' message is listened.

Error codes

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

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;

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

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;

Error codes

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

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;

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；

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;

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

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 

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

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;

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;

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

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

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

ITMG_LOG_LEVEL

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;

Sample code

[[ITMGContext GetInstance] SetLogPath:Path];

Callback Messages

Message list

Data list