This document describes how to access and debug the GME APIs for Cocos2d.

Note：

This document applies to GME SDK v2.7.

Key Considerations for Using GME

Note：

• Configure your project before using GME; otherwise, the SDK will not take effect.
• After a GME API is called successfully, AV_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 GME callback messages, please see the callback message list.
• Operation on devices should be performed after successful room entry.
• For detailed error codes, please see Error Codes.

Voice Chat Flowchart

Key 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 voice messaging and speech-to-text features.
If you have any questions when using the service, please see General FAQs.

Preparations

You need to import the header file tmg_sdk.h first before you can access GME. The classes in the header file inherit ITMGDelegate for message delivery and callback.

Sample code

#include "tmg_sdk.h"

class TMGTestScene : public cocos2d::Scene,public ITMGDelegate
{
public:
...
private:
...
｝

Setting a singleton

You need to get ITMGContext first before you can call the EnterRoom function, because all calls begin with ITMGContext and callbacks are passed to the application through ITMGDelegate.

Sample code

ITMGContext* context = ITMGContextGetInstance();
context->SetTMGDelegate(this);

Message delivery

The API class uses the Delegate method to send callback notifications to the application. ITMG_MAIN_EVENT_TYPE indicates the message type. The data on Windows is in json string format. For the key-value pairs, please see the relevant documentation.

Sample code

// Function implementation:
//TMGTestScene.h:
class TMGTestScene : public cocos2d::Scene,public ITMGDelegate
{
public:
    void OnEvent(ITMG_MAIN_EVENT_TYPE eventType, const char* data);
｝

//TMGTestScene.cpp:
void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){
    // Identify and manipulate `eventType` here
}

Initializing the SDK

For more information on how to get parameters, please see Access Guide.
This API requires the AppID from the Tencent Cloud Console and the openID as parameters. The openID uniquely identifies a user with the rules stipulated by the application developer and must be unique in the application (currently, only INT64 is supported).

Note：

The SDK must be initialized before a client can enter a room.

Function prototype

ITMGContext virtual int Init(const char* sdkAppId, const char* 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

#define SDKAPPID3RD "1400089356"
cosnt char* openId="10001";
ITMGContext* context = ITMGContextGetInstance();
context->Init(SDKAPPID3RD, openId);

Triggering event callback

Event callbacks can be triggered by periodically calling the Poll API in update.

Function prototype

class ITMGContext {
protected:
    virtual ~ITMGContext() {}
    
public:        
    virtual void Poll()= 0;
}

Sample code

// Declaration in the header file
class TMGTestScene : public cocos2d::Scene,public ITMGDelegate
{
void update(float delta); 
}

// Code implementation
void TMGTestScene::update(float delta)
{
    ITMGContextGetInstance()->Poll();
}

Pausing system

When a Pause event occurs in the system, the engine should also be notified for pause.

Function prototype

ITMGContext int Pause()

Resuming system

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

Function prototype

ITMGContext int Resume()

Uninitializing the SDK

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

Function prototype

ITMGContext int Uninit()

Sample code

ITMGContext* context = ITMGContextGetInstance();
context->Uninit();

Voice Chat Room Call Flowchart

Voice Chat Room APIs

You should initialize and call the SDK to enter a room before voice chat can start.
If you have any questions when using the service, please see FAQs About Voice Chat.

Authentication information

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

Function prototype

int  QAVSDK_AuthBuffer_GenAuthBuffer(unsigned int dwSdkAppID, const char* strRoomID, const char* strOpenID,
    const char* strKey, unsigned char* strAuthBuffer, unsigned int bufferLength);

Sample code

unsigned int bufferLen = 512;
unsigned char retAuthBuff[512] = {0};
QAVSDK_AuthBuffer_GenAuthBuffer(atoi(SDKAPPID3RD), roomId, "10001", AUTHKEY,retAuthBuff,bufferLen);

Entering room

When a client enters a room with the generated authentication information, the ITMG_MAIN_EVENT_TYPE_ENTER_ROOM message will be received as a callback. Mic and speaker are not enabled by default after room entry. The returned value of AV_OK indicates a success.
For entering a common voice chat room that does not involve range voice, use the common room entry API. For more information, please see Range Voice.

Function prototype

ITMGContext virtual int EnterRoom(const char*  roomID, ITMG_ROOM_TYPE roomType, const char* authBuff, int buffLen)

For more information on how to choose a room audio type, please see Sound Quality Selection.

Sample code

ITMGContext* context = ITMGContextGetInstance();
context->EnterRoom(roomID, ITMG_ROOM_TYPE_STANDARD, (char*)retAuthBuff,bufferLen);

Callback for room entry

After the client enters the room, the message ITMG_MAIN_EVENT_TYPE_ENTER_ROOM will be sent and identified in the OnEvent function.

Sample code

void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){
    switch (eventType) {
            case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:
        {
        // Process
        break;
        }
    }
}

Data details

Error codes

Determining whether client has entered room

This API is used to determine whether the client has entered a room. A bool-type value will be returned.

Function prototype

ITMGContext virtual bool IsRoomEntered()

Sample code

ITMGContext* context = ITMGContextGetInstance();
context->IsRoomEntered();

Exiting room

This API is called to exit the current room. It is an async API. The returned value of AV_OK indicates a successful async delivery.

Note：

If there is a scenario in the application where room entry is performed immediately after room exit, you don't need to wait for the RoomExitComplete callback notification from the ExitRoom API during API call; instead, you can directly call the API.

Function prototype

ITMGContext virtual int ExitRoom()

Sample code

ITMGContext* context = ITMGContextGetInstance();
context->ExitRoom();

Callback for room exit

After the client exits a room, a callback will be returned with the message being ITMG_MAIN_EVENT_TYPE_EXIT_ROOM.

Sample code

void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){
    switch (eventType) {
            case ITMG_MAIN_EVENT_TYPE_EXIT_ROOM:
        {
        // Process
        break;
        }
    }
}

Data details

Modifying user's room audio type

This API is used to modify a user's room audio type. For the result, please see the callback event. The event type is ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE.

Function prototype

IITMGContext TMGRoom public void ChangeRoomType((ITMG_ROOM_TYPE roomType)

Sample code

ITMGContext* context = ITMGContextGetInstance();
ITMGContextGetInstance()->GetRoom()->ChangeRoomType(ITMG_ROOM_TYPE_FLUENCY);

Getting user's room audio type

This API is used to get a user's room audio type. The returned value is the room audio type. Value 0 indicates that an error occurred while getting the user's room audio type. For room audio types, please see the EnterRoom API.

Function prototype

IITMGContext TMGRoom public  int GetRoomType()

Sample code

ITMGContext* context = ITMGContextGetInstance();
ITMGContextGetInstance()->GetRoom()->GetRoomType();

Callback for room type setting completion

After the room type is set, the event message ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE will be returned in the callback. The returned parameters include result, error_info, and new_room_type. The new_room_type represents the following information. The event message will be identified in the OnEvent function.

Sample code

void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data) {
    if (ITMGContext.ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE == type)
        {
        // Process room type events
     }
}

Data details

Member status change

Notification for this event will be sent only when the status changes. To get member status in real time, cache the notification when it is received at a higher layer. The event message is ITMG_MAIN_EVNET_TYPE_USER_UPDATE, where the data contains event_id and user_list. The event message will be identified in the OnEvent function.
Notifications for audio events are subject to a threshold, and a notification will be sent only when this threshold is exceeded. The notification "A member has stopped sending audio packets" will be sent if no audio packets are received in more than two seconds.

Room member maintenance flowchart

Sample code

void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){
    switch (eventType) {
            case ITMG_MAIN_EVNET_TYPE_USER_UPDATE:
        {
        // Process
        // Parse the parameter to get `eventID` and `user_list`
            switch (eventID)
             {
             case ITMG_EVENT_ID_USER_ENTER:
                  // A member enters the room
                  break;
             case ITMG_EVENT_ID_USER_EXIT:
                  // A member exits the room
                break;
            case ITMG_EVENT_ID_USER_HAS_AUDIO:
                // A member sends audio packets
                break;
            case ITMG_EVENT_ID_USER_NO_AUDIO:
                // A member stops sending audio packets
                break;
             default:
                break;
            }
        break;
        }
    }
}

Room call quality control event

The message for quality control event triggered after room entry is ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_QUALITY. The returned parameters include weight, loss, and delay, which represent the following information. The event message will be identified in the OnEvent function.

Message details

Details of data corresponding to the message

Voice Chat Audio APIs

The voice chat APIs can only be called after SDK initialization and room entry.
When Enable/Disable Mic/Speaker is clicked on the UI, the following practices are recommended:

• For most game applications, you are recommended to call the EnableMic and EnableSpeaker APIs, which is equivalent to calling the EnableAudioCaptureDevice/EnableAudioSend and EnableAudioPlayDevice/EnableAudioRecv APIs;
• For other mobile applications (such as social networking applications), enabling/disabling a capturing device will restart both capturing and playback devices. If the application is playing back background music, it will also be interrupted. Playback won't be interrupted if the mic is enabled/disabled through control of upstreaming/downstreaming. Calling method: call EnableAudioCaptureDevice(true) and EnableAudioPlayDevice(true) once after room entry, and call EnableAudioSend/Recv to send/receive audio streams when Enable/Disable Mic is clicked.
• For more information on how to release only a capturing or playback device, please see the EnableAudioCaptureDevice and EnableAudioPlayDevice.
• Call the pause API to pause the audio engine and call the resume API to resume the audio engine.

Getting the number of mics

This API is used to get the number of mics.

Function prototype

ITMGAudioCtrl virtual int GetMicListCount()

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->GetMicListCount();

Enumerating mics

This API is used together with the GetMicListCount API to enumerate mics.

Function prototype

ITMGAudioCtrl virtual int GetMicList(TMGAudioDeviceInfo* ppDeviceInfoList, int nCount)

class TMGAudioDeviceInfo
{
public:
    const char* pDeviceID;
    const char* pDeviceName;
};

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->GetMicList(ppDeviceInfoList,nCount);

Selecting a mic

This API is used to select a mic. If this API is not called or DEVICEID_DEFAULT is passed in, the default mic will be selected. The device ID is from the list returned by GetMicList.

Function prototype

ITMGAudioCtrl virtual int SelectMic(const char* pMicID)

Sample code

const char* pMicID ="{0.0.1.00000000}.{7b0b712d-3b46-4f7a-bb83-bf9be4047f0d}";
ITMGContextGetInstance()->GetAudioCtrl()->SelectMic(pMicID);

Enabling/Disabling the mic

This API is used to enable/disable the mic. Mic and speaker are not enabled by default after room entry.
EnableMic = EnableAudioCaptureDevice + EnableAudioSend.

Function prototype

ITMGAudioCtrl virtual int EnableMic(bool bEnabled)

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->EnableMic(true);

Getting mic status

This API is used to get the mic status. The returned value 0 indicates that the mic is off, while 1 on.

Function prototype

ITMGAudioCtrl virtual int GetMicState()

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->GetMicState();

Enabling/Disabling capture device

This API is used to enable/disable a capturing device. The device is not enabled by default after room entry.

• This API can only be called after room entry. The device will be disabled automatically after room exit.
• Operations such as permission application and volume type adjustment will generally be performed when a capturing device is enabled on a mobile device.

Function prototype

ITMGContext virtual int EnableAudioCaptureDevice(bool enable)

Sample code

Enable a capturing device
ITMGContextGetInstance()->GetAudioCtrl()->EnableAudioCaptureDevice(true);

Getting capturing device status

This API is used to get the status of a capturing device.

Function prototype

ITMGContext virtual bool IsAudioCaptureDeviceEnabled()

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->IsAudioCaptureDeviceEnabled();

Enabling/Disabling audio upstreaming

This API is used to enable/disable audio upstreaming. If a capturing device is already enabled, it will send captured audio data; otherwise, it will remain mute. For more information on how to enable/disable the capturing device, please see the EnableAudioCaptureDevice API.

Function prototype

ITMGContext  virtual int EnableAudioSend(bool bEnable)

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->EnableAudioSend(true);

Getting audio upstreaming status

This API is used to get the status of audio upstreaming.

Function prototype

ITMGContext virtual bool IsAudioSendEnabled()

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->IsAudioSendEnabled();

Getting real-time mic volume level

This API is used to get the real-time mic volume level. An int-type value will be returned.

Function prototype

ITMGAudioCtrl virtual int GetMicLevel()

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->GetMicLevel();

Getting real-time audio upstreaming volume level

This API is used to get the real-time audio upstreaming volume level. An int-type value will be returned. Value range: 0–100.

Function prototype

ITMGAudioCtrl virtual int GetSendStreamLevel()

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->GetSendStreamLevel();

Setting mic volume level

This API is used to set the mic volume level. The corresponding parameter is volume. 0 indicates that the audio is mute, while 100 indicates that the volume level remains unchanged. The default value is 100.

Function prototype

ITMGAudioCtrl virtual int SetMicVolume(int vol)

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->SetMicVolume(vol);

Getting mic volume level

This API is used to get the mic volume level. An int-type value will be returned. 101 indicates that the SetMicVolume API has not been called.

Function prototype

ITMGAudioCtrl virtual int GetMicVolume()

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->GetMicVolume();

Getting the number of speakers

This API is used to get the number of speakers.

Function prototype

ITMGAudioCtrl virtual int GetSpeakerListCount()

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->GetSpeakerListCount();

Enumerating speakers

This API is used together with the GetSpeakerListCount API to enumerate speakers.

Function prototype

ITMGAudioCtrl virtual int GetSpeakerList(TMGAudioDeviceInfo* ppDeviceInfoList, int nCount)

class TMGAudioDeviceInfo
{
public:
    const char* pDeviceID;
    const char* pDeviceName;
};

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->GetSpeakerList(ppDeviceInfoList,nCount);

Selecting a speaker

This API is used to select a playback device. If this API is not called or DEVICEID_DEFAULT is passed in, the default playback device will be selected. The device ID is from the list returned by GetSpeakerList.

Function prototype

ITMGAudioCtrl virtual int SelectSpeaker(const char* pSpeakerID)

Sample code

const char* pSpeakerID ="{0.0.1.00000000}.{7b0b712d-3b46-4f7a-bb83-bf9be4047f0d}";
ITMGContextGetInstance()->GetAudioCtrl()->SelectSpeaker(pSpeakerID);

Enabling/Disabling the speaker

This API is used to enable/disable the speaker.
EnableSpeaker = EnableAudioPlayDevice + EnableAudioRecv.

Function prototype

ITMGAudioCtrl virtual int EnableSpeaker(bool enabled)

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->EnableSpeaker(true);

Getting speaker status

This API is used to get the speaker status. 0 indicates that the speaker is off, 1 on, and 2 working.

Function prototype

ITMGAudioCtrl virtual int GetSpeakerState()

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->GetSpeakerState();

Enabling/Disabling playback device

This API is used to enable/disable a playback device.

Function prototype

ITMGContext virtual int EnableAudioPlayDevice(bool enable) 

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->EnableAudioPlayDevice(true);

Getting playback device status

This API is used to get the status of a playback device.

Function prototype

ITMGContext virtual bool IsAudioPlayDeviceEnabled()

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->IsAudioPlayDeviceEnabled();

Enabling/Disabling audio downstreaming

This API is used to enable/disable audio downstreaming. If a playback device is already enabled, it will play back audio data from other members in the room; otherwise, it will remain mute. For more information on how to enable/disable the playback device, please see the EnableAudioPlayDevice API.

Function prototype

ITMGContext virtual int EnableAudioRecv(bool enable)

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->EnableAudioRecv(true);

Getting audio downstreaming status

This API is used to get the status of audio downstreaming.

Function prototype

ITMGContext virtual bool IsAudioRecvEnabled() 

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->IsAudioRecvEnabled();

Getting real-time speaker volume level

This API is used to get the real-time speaker volume level. An int-type value will be returned to indicate the volume level.

Function prototype

ITMGAudioCtrl virtual int GetSpeakerLevel()

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->GetSpeakerLevel();

Getting real-time downstreaming audio levels of other members in room

This API is used to get the real-time audio downstreaming volume levels of other members in the room. An int-type value will be returned. Value range: 0–100.

Function prototype

ITMGAudioCtrl virtual int GetRecvStreamLevel(const char* openId)

Sample code

iter->second.level = ITMGContextGetInstance()->GetAudioCtrl()->GetRecvStreamLevel(iter->second.openid.c_str());

Setting speaker volume level

This API is used to set the speaker volume level.
The corresponding parameter is volume. 0 indicates that the audio is mute, while 100 indicates that the volume level remains unchanged. The default value is 100.

Function prototype

ITMGAudioCtrl virtual int SetSpeakerVolume(int vol)

Sample code

int vol = 100;
ITMGContextGetInstance()->GetAudioCtrl()->SetSpeakerVolume(vol);

Getting speaker volume level

This API is used to get the speaker volume level. An int-type value will be returned to indicate the volume level. 101 indicates that the SetSpeakerVolume API has not been called.
Level indicates the real-time volume level, while Volume the speaker volume level. The final volume level equals to Level*Volume%. For example, if the value of "Level" is 100 and that of Volume is 60, then the final volume level will be 60.

Function prototype

ITMGAudioCtrl virtual int GetSpeakerVolume()

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->GetSpeakerVolume();

Enabling in-ear monitoring

This API (EnableLoopBack) is used to enable in-ear monitoring. To hear your own voice as well, call both EnableLoopBack and EnableSpeaker.

Function prototype

ITMGAudioCtrl virtual int EnableLoopBack(bool enable)

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->EnableLoopBack(true);

Speech-to-Text Conversion Flowchart

Voice Messaging and Speech-to-Text

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 messaging and speech-to-text features.
If you have any questions when using the service, please see Voice Messaging and Speech-to-Text.

Initialization APIs

Voice messaging and speech-to-text APIs

Authentication initialization

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

Function prototype

ITMGPTT virtual int ApplyPTTAuthbuffer(const char* authBuffer, int authBufferLen)

Sample code

ITMGContextGetInstance()->GetPTT()->ApplyPTTAuthbuffer(authBuffer,authBufferLen);

Specifying 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

ITMGPTT virtual int SetMaxMessageLength(int msTime)

Sample code

int msTime = 10000-;
ITMGContextGetInstance()->GetPTT()->SetMaxMessageLength(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.

Function prototype

ITMGPTT virtual int StartRecording(const char* fileDir)

Sample code

ITMGContextGetInstance()->GetPTT()->StartRecording(fileDir);

Callback for recording start

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 parameters include result and file_path.

Error codes

Sample code

void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){
    switch (eventType) {
        case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:
        {
        // Process
        break;
        }
        ...
        case ITMG_MAIN_EVNET_TYPE_PTT_RECORD_COMPLETE:
        {
        // Process
        break;
        }
    }
}

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.

Function prototype

ITMGPTT virtual int StartRecordingWithStreamingRecognition(const char* filePath) 
ITMGPTT virtual int StartRecordingWithStreamingRecognition(const char* filePath,const char* translateLanguage,const char* translateLanguage) 

Sample code

ITMGContextGetInstance()->GetPTT()->StartRecordingWithStreamingRecognition(filePath,"cmn-Hans-CN","cmn-Hans-CN");

Callback for streaming speech recognition start

The callback function OnEvent will be called after the streaming speech recognition is started. The event message ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_COMPLETE will be returned, which will be identified in the OnEvent function. The passed parameters include the following four messages.

Error codes

Sample code

void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){
    switch (eventType) {
        case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:
        {
        // Process
        break;
        }
        ...
        case ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_COMPLETE:
        {
        // Process
        break;
        }
    }
}

Pausing recording

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

Function prototype

ITMGPTT virtual int PauseRecording()

Sample code

ITMGContextGetInstance()->GetPTT()->PauseRecording();

Resuming recording

This API is used to resume recording.

Function prototype

ITMGPTT virtual int ResumeRecording()

Sample code

ITMGContextGetInstance()->GetPTT()->ResumeRecording();

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

ITMGPTT virtual int StopRecording()

Sample code

ITMGContextGetInstance()->GetPTT()->StopRecording();

Canceling recording

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

Function prototype

ITMGPTT virtual int CancelRecording()

Sample code

ITMGContextGetInstance()->GetPTT()->CancelRecording();

Getting real-time mic volume level of voice messaging

This API is used to get the real-time mic volume level. An int-type value will be returned. Value range: 0–100.

Function prototype

ITMGPTT virtual int GetMicLevel()

Sample code

ITMGContextGetInstance()->GetPTT()->GetMicLevel();

Setting recording volume level of voice messaging

This API is used to set the recording volume level of voice messaging. Value range: 0–100.

Function prototype

ITMGPTT virtual int SetMicVolume(int vol)

Sample code

ITMGContextGetInstance()->GetPTT()->SetMicVolume(100);

Getting recording volume level of voice messaging

This API is used to get the recording volume level of voice messaging. An int-type value will be returned. Value range: 0–100.

Function prototype

ITMGPTT virtual int GetMicVolume()

Sample code

ITMGContextGetInstance()->GetPTT()->GetMicVolume();

Getting real-time speaker volume level

This API is used to get the real-time speaker volume level. An int-type value will be returned. Value range: 0–100.

Function prototype

ITMGPTT virtual int GetSpeakerLevel()

Sample code

ITMGContextGetInstance()->GetPTT()->GetSpeakerLevel();

Setting playback volume level of voice messaging

This API is used to set the playback volume level of voice messaging. Value range: 0–100.

Function prototype

ITMGPTT virtual int SetSpeakerVolume(int vol)

Sample code

ITMGContextGetInstance()->GetPTT()->SetSpeakerVolume(100);

Getting playback volume level of voice messaging

This API is used to get the playback volume level of voice messaging. An int-type value will be returned. Value range: 0–100.

Function prototype

ITMGPTT virtual int GetSpeakerVolume()

Sample code

ITMGContextGetInstance()->GetPTT()->GetSpeakerVolume();

Uploading audio file

This API is used to upload an audio file.

Function prototype

ITMGPTT virtual int UploadRecordedFile(const char* filePath)

Sample code

ITMGContextGetInstance()->GetPTT()->UploadRecordedFile(filePath);

Callback for audio file upload completion

After the audio file is uploaded, the event message ITMG_MAIN_EVNET_TYPE_PTT_RECORD_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 TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){
    switch (eventType) {
        case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:
        {
        // Process
        break;
        }
        ...
        case ITMG_MAIN_EVNET_TYPE_PTT_UPLOAD_COMPLETE:
        {
        // Process
        break;
        }
    }
}

Downloading audio file

This API is used to download an audio file.

Function prototype

ITMGPTT virtual int DownloadRecordedFile(const char* fileId, const char* filePath) 

Sample code

ITMGContextGetInstance()->GetPTT()->DownloadRecordedFile(fileID,filePath);

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.

Error codes

Sample code

void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){
    switch (eventType) {
        case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:
        {
        // Process
        break;
        }
        ...
        case ITMG_MAIN_EVNET_TYPE_PTT_DOWNLOAD_COMPLETE:
        {
        // Process
        break;
        }
    }
}

Playing back audio

This API is used to play back audio.

Function prototype

ITMGPTT virtual int PlayRecordedFile(const char* filePath)

Error codes

Sample code

ITMGContextGetInstance()->GetPTT()->PlayRecordedFile(filePath);

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 parameters include result and file_path.

Error codes

Sample code

void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){
    switch (eventType) {
        case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:
        {
        // Process
        break;
        }
        ...
        case ITMG_MAIN_EVNET_TYPE_PTT_PLAY_COMPLETE:
        {
        // Process
        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

ITMGPTT virtual int StopPlayFile()

Sample code

ITMGContextGetInstance()->GetPTT()->StopPlayFile();

Getting audio file size

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

Function prototype

ITMGPTT virtual int GetFileSize(const char* filePath)

Sample code

ITMGContextGetInstance()->GetPTT()->GetFileSize(filePath);

Getting audio file duration

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

Function prototype

ITMGPTT virtual int GetVoiceFileDuration(const char* filePath)

Sample code

ITMGContextGetInstance()->GetPTT()->GetVoiceFileDuration(filePath);

Converting audio file to text

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

Function prototype

ITMGPTT virtual void SpeechToText(const char* fileID)

Sample code

ITMGContextGetInstance()->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

ITMGPTT virtual int SpeechToText(const char* fileID,const char* speechLanguage,const char* translateLanguage)

Sample code

ITMGContextGetInstance()->GetPTT()->SpeechToText(filePath,"cmn-Hans-CN","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 TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){
    switch (eventType) {
        case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:
        {
        // Process
        break;
        }
        ...
        case ITMG_MAIN_EVNET_TYPE_PTT_SPEECH2TEXT_COMPLETE:
        {
        // Process
        break;
        }
    }
}

Advanced APIs

Getting diagnostic messages

This API is used to get information on the quality of real-time audio/video calls, which is mainly used to view real-time call quality and troubleshoot problems and can be ignored on the business side.

Function prototype

ITMGRoom virtual const char* GetQualityTips()

Sample code

ITMGContextGetInstance()->GetRoom()->GetQualityTips();

Getting version number

Function prototype

ITMGContext virtual const char* GetSDKVersion()

Sample code

ITMGContextGetInstance()->GetSDKVersion();

Setting log printing level

This API is used to set the level of logs to be printed. It is recommended to keep the default level.

Function prototype

ITMGContext int SetLogLevel(ITMG_LOG_LEVEL levelWrite, ITMG_LOG_LEVEL levelPrint)

Parameter description

Sample code

ITMGContext* context = ITMGContextGetInstance();
context->SetLogLevel(TMG_LOG_LEVEL_INFO,TMG_LOG_LEVEL_INFO);

Setting log printing path

This API is used to set the log printing path.
The default path is as follows:

Function prototype

ITMGContext virtual int SetLogPath(const char* logDir) 

Sample code

cosnt char* logDir = ""// Set a path by yourself

ITMGContext* context = ITMGContextGetInstance();
context->SetLogPath(logDir);

Adding to audio data blocklist

This API is used to add an ID to the audio data blocklist. This operation blocks audio from someone and only applies to the local device. A returned value of 0 indicates the call is successful. Assume that users A, B, and C are all speaking using their mic in a room:

• If A blocklists C, A can only hear B;
• If B blocklists neither A nor C, B can hear both of them;
• If C blocklists neither A nor B, C can hear both of them.

Function prototype

ITMGContext ITMGAudioCtrl int AddAudioBlackList(const char* openId)

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->AddAudioBlackList(openId);

Removing from audio data blocklist

This API is used to remove an ID from the audio data blocklist. A returned value of 0 indicates the call is successful.

Function prototype

ITMGContext ITMGAudioCtrl int RemoveAudioBlackList(const char* openId)

Sample code

ITMGContextGetInstance()->GetAudioCtrl()->RemoveAudioBlackList(openId);

Callback Messages

Message list

Data list