This document describes how to get started with the GME APIs for Unreal.

This document only describes the most important APIs to help you get started with GME. For more information on APIs, please see the API documentation.

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

Directions for Quick Access

1. Get a singleton

To use the voice feature, get the ITMGContext object first.

Sample code

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

2. Initialize 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).

The SDK must be initialized so that a room can be entered.

Function prototype

ITMGContext virtual int Init(const char* sdkAppId, const char* openId)

Sample code

std::string appid = TCHAR_TO_UTF8(CurrentWidget->editAppID->GetText().ToString().operator*());
std::string userId = TCHAR_TO_UTF8(CurrentWidget->editUserID->GetText().ToString().operator*());
ITMGContextGetInstance()->Init(appid.c_str(), userId.c_str());

3. Trigger event callback

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

Function prototype

class ITMGContext {
protected:
    virtual ~ITMGContext() {}

public:        
    virtual void Poll()= 0;
}

Sample code

// Declaration in the header file
virtual void Tick(float DeltaSeconds);

// Code implementation
void AUEDemoLevelScriptActor::Tick(float DeltaSeconds) 
{
    ITMGContextGetInstance()->Poll();
}

4. Authenticate

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

5. Enter a 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.

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

6. Receive 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;
        }
    }
}

7. Enable/Disable the mic

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

Function prototype

ITMGAudioCtrl virtual int EnableMic(bool bEnabled)

Sample code

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

8. Enable/Disable the speaker

This API is used to enable/disable the speaker.

Function prototype

ITMGAudioCtrl virtual int EnableSpeaker(bool enabled)

Sample code

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