This document provides a detailed description that makes it easy for Native project developers to debug and integrate the APIs for Game Multimedia Engine (GME).
This document only provides the main APIs to help you get started with GME to debug and integrate the APIs.
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 on Init API:
If you need to use voice chat and voice messaging services at the same time, you only need to call Init API once.
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 before room entry.
Function prototype and sample code
Register the callback function to the SDK for receiving callback messages before room entry.
You need to initialize the SDK through the Init API before you can use the real-time voice, voice message, and speech-to-text services. The Init API must be called in the same thread as other APIs. We recommend you call all APIs in the main thread.
openID can only be in Int64 type, which is passed in after being converted to a string. You can customize its rules, and it must be unique in the application. To pass in openID as a string, submit a ticket for application.
}elseif(nRet == AV_ERR_HAS_IN_THE_STATE)// SDK has been initialized. This operation is successful.
{
showToast("Init success");
}else
{
showToast("Init error errorCode:"+ nRet);
}
//TMGSampleViewController.m
QAVResult result =[_context InitEngine:self.appIDTF.text openID:self.openIDTF.text];
if(result == QAV_OK){
self.isSDKInit = YES;
}
#define SDKAPPID3RD "14000xxxxx"
cosnt char* openId="10001";
ITMGContext* context =ITMGContextGetInstance();
context->Init(SDKAPPID3RD, openId);
6. Triggering event callback
Event callbacks can be triggered by periodically calling the Poll API in update. The Poll API is GME's message pump and should be called periodically for GME to trigger event callbacks; otherwise, the entire SDK service will run abnormally. For more information, see the EnginePollHelper file in SDK Download Guide.
Sample code
Java
Object-C
C++
//MainActivity.java
[EnginePollHelper createEnginePollHelper];
//EnginePollHelper.java
privateHandler mhandler =newHandler();
privateRunnable mRunnable =newRunnable(){
@Override
publicvoidrun(){
if(s_pollEnabled){
if(ITMGContext.GetInstance(null)!=null)
ITMGContext.GetInstance(null).Poll();
}
mhandler.postDelayed(mRunnable,33);
}
};
// For the code of calling Poll periodically, see EnginePollHelper.java.
//TMGSampleViewController.m
[EnginePollHelper createEnginePollHelper];
// Refer to EnginePollHelper.m and EnginePollHelper.h
void TMGTestScene::update(float delta)
{
ITMGContextGetInstance()->Poll();
}
7. Calculating the local authentication key
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.
This API is used to enter a room with the generated authentication information. The mic and speaker are not turned on by default after room entry. The returned value of AV_OK indicates successful API call but not successful room entry.
After the user enters the room, the message ITMG_MAIN_EVENT_TYPE_ENTER_ROOM will be sent and identified in the OnEvent function for callback and processing. A successful callback means that the room entry is successful, and the billing starts.
An error occurred while authenticating the `authbuff`.
Authentication expired.
The `openId` does not meet the specification.
7007
Already in another room.
1001
The user was already in the process of entering a room but repeated this operation. It is recommended not to call the room entering API until the room entry callback is returned.
1003
The user was already in the room and called the room entering API again.
1101
Make sure that the SDK is initialized, `openId` complies with the rules, the APIs are called in the same thread, and the `Poll` API is called normally.
2. Turning on or off the microphone
This API is used to turn on or off the mic. Mic and speaker are not enabled by default after room entry.
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).
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. To stop recording, call StopRecording. The callback will be returned after the recording is stopped.
After streaming speech recognition is started, you need to listen for callback messages in the callback function onEvent. The event message is ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_COMPLETE, namely 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.
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
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 converting 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.
3. 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.
