Init
and Poll
.AppID
and key. For more information, see Activating Services.GmeError.AV_OK
will be returned with the value being 0
.Poll
API should be called periodically for GME to trigger event callbacks.`GmeContext`: GME business implementation APIs`GmeError`: GME error code definition class
API | Description |
Init | Initializes GME |
Poll | Triggers event callback |
Uninit | Uninitializes GME |
const { GmeContext } = require('gme-electron-sdk');
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.Init(appid: string, openid: string): number;
Parameter | Type | Description |
sdkAppId | string | |
openID | string | 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. |
Returned Value | Description |
GmeError.AV_OK= 0 | Initialized the SDK successfully. |
AV_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. |
AV_ERR_SDK_NOT_FULL_UPDATE
is only a reminder but will not cause an initialization failure.number ret = m_context.Init(sdkAppId, openID);// Determine whether the initialization is successful by the returned valueif (ret != GmeError.AV_OK){console.log("Failed to initialize the SDK:");return;}
Poll
API in the timer. 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.Poll
API must be called periodically and in the main thread to avoid abnormal API callbacks.Poll();
setInterval(function () {m_context.Poll();}, 50);
openid
, switching game account requires uninitializing GME and then using the new openid
to initialize again.Uninit() : number
SetMaxMessageLength
API to set it after initialization.API | Description |
GenAuthBuffer | Gets the authentication information |
SetMaxMessageLength | Specifies the maximum length of voice message |
AuthBuffer
for encryption and authentication of relevant features. For release in the production environment, use the backend deployment key as detailed in Authentication Key. GenAuthBuffer(appId: string,roomId: string, openId:string, appKey: string) :string
Parameter | Type | Description |
appId | string | AppId from the Tencent Cloud console. |
roomId | string | Enter null or an empty string |
openId | string | User ID, which is the same as OpenId during initialization. |
key | string |
ApplyPTTAuthbuffer(authBuffer: string) :number
Parameter | Type | Description |
authBuffer | string | Authentication information |
var authBuffer = m_context.GetAuthBuffer(UserConfig.GetAppID(), UserConfig.GetUserID(), null,UserConfig.GetAuthKey());m_context.ApplyPTTAuthbuffer(authBuffer);
PttSetMaxMessageLength(msTime: number) :number
Parameter | Type | Description |
msTime | number | Audio duration in ms. Value range: 1000 < msTime <= 58000 |
m_context.PttSetMaxMessageLength(58000);
API | Description |
PttStartRecordingWithStreamingRecognition | Starts streaming recording |
PttStopRecording | Stops recording |
PttStartRecordingWithStreamingRecognition(filePath: string, speechLanguage: string, translateLanguage: string) :number
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, see Language Parameter Reference List. |
translateLanguage | string | The language in which the audio file is to be translated to text. For parameters, see Language Parameter Reference List. |
string filePath = "xx/xxx/xxx.silk"var ret = m_context.StartRecordingWithStreamingRecognition(filePath,"cmn-Hans-CN","cmn-Hans-CN");if (ret == 0) {this.currentStatus = "Start streaming recording";} else {this.currentStatus = "Failed to start streaming recording";}
OnEvent
notification, which is as detailed below: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.Message Name | Description |
result | Return code indicating whether 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 |
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. |
32787 | Speech-to-text conversion succeeded, but the text translation service was not activated. | Activate the text translation service in the console. |
32788 | Speech-to-text conversion succeeded, but the language parameter of the text translation service was invalid. | Check the parameter passed in. |
m_context.setTMGDelegate(function(eventId, msg){switch (eventType) {case ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_COMPLETE:{HandleSTREAM2TEXTComplete(data,true);break;}...case ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_IS_RUNNING:{HandleSTREAM2TEXTComplete(data, false);break;}}});
API | Description |
PttStartRecording | Starts recording |
PttPauseRecording | Pauses recording |
PttResumeRecording | Resumes recording |
PttStopRecording | Stops recording |
PttCancelRecording | Cancels recording |
PttStartRecording(filePath: string) : number;
Parameter | Type | Description |
filePath | string | Path of stored audio file |
string filepath = "xxxx/xxx.silk";var ret = m_context.PttStartRecording(filepath);
PttStopRecording() :number;
m_context.PttStopRecording();
StopRecording
. The callback for recording start will be returned after the recording is stopped.Parameter | Type | Description |
code | string | 0: Recording is completed |
filepath | string | Path of stored recording file, which must be accessible and cannot be the fileid |
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, 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. |
m_context.setTMGDelegate(function(eventId, msg){switch (eventType) {case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:{// Processbreak;}...case ITMG_MAIN_EVNET_TYPE_PTT_RECORD_COMPLETE:{// Processbreak;}}});
PttResumeRecording
API.PttPauseRecording() : number
number ret = m_context.PttPauseRecording();
PttResumeRecording() : number;
number ret = m_context.PttResumeRecording();
PttCancelRecording() : number
m_context.PttCancelRecording();
API | Description |
PttUploadRecordedFile | Uploads an audio file |
PttDownloadRecordedFile | Downloads an audio file |
PttPlayRecordedFile | Plays back an audio file |
PttStopPlayFile | Stops playing back an audio file |
PttGetFileSize | Gets the audio file size |
PttGetVoiceFileDuration | Gets the audio file duration |
PttUploadRecordedFile(filePath: string) : number
Parameter | Type | Description |
filePath | String | Path of uploaded audio file, which is a local path. |
var ret = m_context.PttUploadRecordedFile(filePath);
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
.Parameter | Type | Description |
result | number | 0 : Recording is completed |
filepath | string | Path of stored recording file |
fileid | string | File URL |
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. |
m_context.setTMGDelegate(function(eventId, msg){switch (eventType) {case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:{// Processbreak;}...case ITMG_MAIN_EVNET_TYPE_PTT_UPLOAD_COMPLETE:{// Processbreak;}}});
PttDownloadRecordedFile(fileId: string, filePath: string) : number
Parameter | Type | Description |
fileId | string | File URL |
filePath | string | Local path of saved file, which must be accessible and cannot be the fileid |
var ret = m_context.PttDownloadRecordedFile(fileID,filePath);
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
.Parameter | Type | Description |
result | number | 0 : Download is completed |
filepath | string | Path of stored recording file |
fileid | string | URL of recording file, which will be retained on the server for 90 days. |
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. |
m_context.setTMGDelegate(function(eventId, msg){switch (eventType) {case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:{// Processbreak;}}});
PttPlayRecordedFile(filePath: string, voiceType: ITMG_VOICE_TYPE) : number
Parameter | Type | Description |
filePath | string | Local audio file path |
voicetype | ITMG_VOICE_TYPE |
Error Code Value | Cause | Suggested Solution |
20485 | Playback is not started. | Ensure the existence of the file and the validity of the file path. |
m_context.PlayRecordedFile(filePath);
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
.Parameter | Type | Description |
code | number | 0 : Playback is completed |
filepath | string | Path of stored recording file |
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. |
m_context.setTMGDelegate(function(eventId, msg){switch (eventType) {case ITMG_MAIN_EVNET_TYPE_PTT_PLAY_COMPLETE:{// Processbreak;}}});
PttStopPlayFile() : number
m_context.PttStopPlayFile();
PttGetFileSize(filePath: string) : number
Parameter | Type | Description |
filePath | string | Path of audio file, which is a local path |
m_context.PttGetFileSize(filePath);
PttGetVoiceFileDuration(filePath: string) : number
Parameter | Type | Description |
filePath | string | Path of audio file, which is a local path |
number fileDuration = m_context.PttGetVoiceFileDuration(filePath);
PttSpeechToText(fileID: string, speechLanguage: string, translateLanguage: string) : number
Parameter | Type | Description |
fileID | string | URL of audio file, which will be retained on the server for 90 days |
speechLanguage | string | The language in which the audio file is to be converted to text. For parameters, see Language Parameter Reference List. |
translatelanguage | string | The language in which the audio file is to be translated to text. For parameters, see Language Parameter Reference List. |
m_context.PttSpeechToText(filePath,"cmn-Hans-CN","cmn-Hans-CN");
OnEvent
function.
The passed parameters include result
, file_path
and text
(recognized text).Parameter | Type | Description |
result | number | 0 : Recording is completed |
fileid | string | URL of recording file, which will be retained on the server for 90 days |
text | string | Converted text |
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 messaging 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 messaging 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. |
32787 | Speech-to-text conversion succeeded, but the text translation service was not activated. | Activate the text translation service in the console. |
32788 | Speech-to-text conversion succeeded, but the language parameter of the text translation service was invalid. | Check the parameter passed in. |
m_context.setTMGDelegate(function(eventId, msg){switch (eventType) {case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:{// Processbreak;}...case ITMG_MAIN_EVNET_TYPE_PTT_SPEECH2TEXT_COMPLETE:{// Processbreak;}});
API | Description |
PttGetMicLevel | Gets real-time mic volume level |
PttSetMicVolume | Sets recording volume level |
PttGetMicVolume | Gets recording volume level |
PttGetSpeakerLevel | Gets real-time speaker volume level |
PttSetSpeakerVolume | Sets playback volume |
PttGetSpeakerVolume | Gets playback volume level |
PttGetMicLevel():number
m_context.PttGetMicLevel();
PttSetMicVolume(vol:number) :number
Parameter | Type | Description |
vol | number | Value range: 0–200. Default value: 100 . 0 indicates that the audio is mute, while 100 indicates that the volume level remains unchanged. |
m_context.PttSetMicVolume(vol);
PttGetMicVolume() : number
m_context.PttGetMicVolume();
PttGetSpeakerLevel() : number;
m_context.PttGetSpeakerLevel();
PttSetSpeakerVolume(vol: number) : number
m_context.PttSetSpeakerVolume(100);
PttGetSpeakerVolume() : number
m_context.PttGetSpeakerVolume();
GetSDKVersion() :string
string sdkVersion = m_context.GetSDKVersion();
SetLogLevel(level: number) : number
Parameter | Type | Description |
level | ITMG_LOG_LEVEL | Sets the log level. TMG_LOG_LEVEL_NONE indicates not to log. Default value: TMG_LOG_LEVEL_INFO . |
level
description:Value of 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 |
m_context.SetLogLevel(TMG_LOG_LEVEL_INFO);
OS | Path |
Windows | %appdata%\\GMEGLOBAL\\GME\\ProcessName |
SetLogPath(logPath: string)
Parameter | Type | Description |
logPath | string | Path |
string logDir = ""// Set a path by yourselfm_context.SetLogPath(logDir);
この記事はお役に立ちましたか?