Init
and Poll
.AppID
and Key
of the SDK as instructed in Activating Services.QAVError.OK
will be returned with the value being 0.Poll
API should be called periodically for GME to trigger event callbacks.Class | Description |
ITMGContext | Key APIs |
ITMGRoom | Room APIs |
ITMGRoomManager | Room management APIs |
ITMGAudioCtrl | Audio APIs |
ITMGAudioEffectCtrl | Sound effect and accompaniment APIs |
API | Description |
Init | Initializes GME |
Poll | Triggers event callback |
Pause | Pauses the system |
Resume | Resumes the system |
Uninit | Uninitializes GME |
tmg_sdk.h
first before you can access GME. The classes in the header file inherit ITMGDelegate
for message delivery and callback.#include "tmg_sdk.h"class TMGTestScene : public cocos2d::Scene,public ITMGDelegate{public:...private:...}
ITMGContext
first before you can call the EnterRoom
function. All calls begin with ITMGContext
, which is returned to the application through the ITMGDelegate
callback and must be set first.ITMGContext* context = ITMGContextGetInstance();context->SetTMGDelegate(this);
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.// 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}
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.ITMGContext virtual int Init(const char* sdkAppId, const char* openId)
Parameter | Type | Description |
sdkAppId | const char* | |
openID | const char* | openID can only be in Int64 type, which is passed in after being converted to a const char* . 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 |
AV_OK = 0 | Initialized 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.#define SDKAPPID3RD "14000xxxxx"cosnt char* openId="10001";ITMGContext* context = ITMGContextGetInstance();context->Init(SDKAPPID3RD, openId);
Poll
API in update
. Poll
is the message pump of GME, and the Poll
API should be called periodically for GME to trigger event callbacks; otherwise, the entire SDK service will run exceptionally.
You can refer to the EnginePollHelper.cpp
file in the demo.Poll
API must be called periodically and in the main thread to avoid abnormal API callbacks.class ITMGContext {protected:virtual ~ITMGContext() {}public:virtual void Poll()= 0;}
// Declaration in the header fileclass TMGTestScene : public cocos2d::Scene,public ITMGDelegate{void update(float delta);}// Code implementationvoid TMGTestScene::update(float delta){ITMGContextGetInstance()->Poll();}
Pause
event occurs in the system, the engine should also be notified for pause. If you do not need the background to play back the audio in the room, please call Pause
API to pause the GME service.ITMGContext int Pause()
Resume
event occurs in the system, the engine should also be notified for resumption. The Resume
API only supports resuming voice chat.ITMGContext int Resume()
openid
, switching game account requires uninitializing GME and then using the new openid
to initialize again.ITMGContext int Uninit()
ITMGContext* context = ITMGContextGetInstance();context->Uninit();
API | Description |
GenAuthBuffer | Calculates the local authentication key |
EnterRoom | Enters a room |
ExitRoom | Exits the room |
IsRoomEntered | Determines whether room entry is successful |
SwitchRoom | Switches the room quickly |
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. int QAVSDK_AuthBuffer_GenAuthBuffer(unsigned int dwSdkAppID, const char* strRoomID, const char* strOpenID,const char* strKey, unsigned char* strAuthBuffer, unsigned int bufferLength);
Parameter | Type | Description |
dwSdkAppID | unsigned int | AppId from the Tencent Cloud console |
strRoomID | const char* | Room ID, which can contain up to 127 characters. |
strOpenID | const char* | User ID, which is the same as openID during initialization. |
strKey | const char* | Permission key from the Tencent Cloud console |
strAuthBuffer | const char* | Returned authbuff |
bufferLength | int | The length of the returned authbuff . 500 is recommended. |
unsigned int bufferLen = 512;unsigned char retAuthBuff[512] = {0};QAVSDK_AuthBuffer_GenAuthBuffer(atoi(SDKAPPID3RD), roomId, "10001", AUTHKEY,retAuthBuff,bufferLen);
0
, the room entry is successful. If 0
is returned from the EnterRoom
API, it doesn't necessarily mean that the room entry is successful.ChangeRoomType
API will the audio type of the room be changed.ITMGContext virtual int EnterRoom(const char* roomID, ITMG_ROOM_TYPE roomType, const char* authBuff, int buffLen)
Parameter | Type | Description |
roomID | const char* | Room ID, which can contain up to 127 characters. |
roomType | ITMG_ROOM_TYPE | Room type. We recommend you select ITMG_ROOM_TYPE_FLUENCY for games. For more information on room audio types, see Sound Quality. |
authBuffer | const char* | Authentication key |
buffLen | int | Authentication key length |
ITMGContext* context = ITMGContextGetInstance();context->EnterRoom(roomID, ITMG_ROOM_TYPE_FLUENCY, (char*)retAuthBuff,bufferLen);
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.void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){switch (eventType) {case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:{// Processbreak;}}}
Message | Data | Sample |
ITMG_MAIN_EVENT_TYPE_ENTER_ROOM | result; error_info | {"error_info":"","result":0} |
ITMG_MAIN_EVENT_TYPE_ROOM_DISCONNECT | result; error_info | {"error_info":"waiting timeout, please check your network","result":0} |
ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_ROOM_DISCONNECT
. At this time, the SDK will automatically reconnect, and the callback is ITMG_MAIN_EVENT_TYPE_RECONNECT_START
. When the reconnection is successful, there will be a callback ITMG_MAIN_EVENT_TYPE_RECONNECT_SUCCESS
.Error Code Value | Cause and Suggested Solution |
7006 | Authentication failed: The AppID does not exist or is incorrect.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 |
AV_OK
indicates a successful async delivery. 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 EnterRoom
API.ITMGContext virtual int ExitRoom()
ITMGContext* context = ITMGContextGetInstance();context->ExitRoom();
ITMG_MAIN_EVENT_TYPE_EXIT_ROOM
.void TMGTestScene::OnEvent(ITMG_MAIN_EVENT_TYPE eventType,const char* data){switch (eventType) {case ITMG_MAIN_EVENT_TYPE_EXIT_ROOM:{// Processbreak;}}}
Message | Data | Sample |
ITMG_MAIN_EVENT_TYPE_EXIT_ROOM | result; error_info | {"error_info":"","result":0} |
ITMGContext virtual bool IsRoomEntered()
ITMGContext* context = ITMGContextGetInstance();context->IsRoomEntered();
ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_SWITCH_ROOM
, and the fields are error_info
and result
.ITMGContext virtual int SwitchRoom(const char* targetRoomID, const char* authBuff, int buffLen);
Parameter | Type | Description |
targetRoomID | const char* | ID of the room to enter |
authBuffer | const char* | Generates a new authentication key with the ID of the room to enter |
buffLen | int | Authentication key length |
API/Notification | Description |
ITMG_MAIN_EVNET_TYPE_USER_UPDATE | The member status changed |
AddAudioBlackList | Mutes a member in the room |
RemoveAudioBlackList | Unmutes a user |
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.event_id | Description | Maintenance |
ITMG_EVENT_ID_USER_ENTER | Return the openid of the member entering the room. | Member list |
ITMG_EVENT_ID_USER_EXIT | Return the openid of the member exiting the room. | Member list |
ITMG_EVENT_ID_USER_HAS_AUDIO | Return the openid of the member sending audio packets in the room. This event can be used to determine whether a user is speaking and display the voiceprint effect. | Chat member list |
ITMG_EVENT_ID_USER_NO_AUDIO | Return the openid of the member stopping sending audio packets in the room. | Chat member list |
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 roombreak;case ITMG_EVENT_ID_USER_EXIT:// A member exits the roombreak;case ITMG_EVENT_ID_USER_HAS_AUDIO:// A member sends audio packetsbreak;case ITMG_EVENT_ID_USER_NO_AUDIO:// A member stops sending audio packetsbreak;default:break;}break;}}}
0
indicates that the call is successful. Assume that users A, B, and C are all speaking using their mic in a room: ITMGContext ITMGAudioCtrl int AddAudioBlackList(const char* openId)
Parameter | Type | Description |
openId | char* | openid of the user to be blocked |
ITMGContextGetInstance()->GetAudioCtrl()->AddAudioBlackList(openId);
ITMGContext ITMGAudioCtrl int RemoveAudioBlackList(const char* openId)
Parameter | Type | Description |
openId | char* | ID to be unblocked |
ITMGContextGetInstance()->GetAudioCtrl()->RemoveAudioBlackList(openId);
EnableMic
or EnableSpeaker
API.EnableAudioCaptureDevice
once during room entry and call EnableAudioSend
to enable the user to speak while pressing the button.API | Description |
EnableMic | Enables/Disables the mic |
GetMicState | Gets the mic status |
EnableAudioCaptureDevice | Enables/Disables the capturing device |
IsAudioCaptureDeviceEnabled | Gets the capturing device status |
EnableAudioSend | Enables/Disables audio upstreaming |
IsAudioSendEnabled | Gets the audio upstreaming status |
GetMicLevel | Gets the real-time mic volume level |
GetSendStreamLevel | Gets real-time audio upstreaming volume |
SetMicVolume | Sets the mic volume level |
GetMicVolume | Gets the mic volume level |
ITMGAudioCtrl virtual int EnableMic(bool bEnabled)
Parameter | Type | Description |
bEnabled | bool | To enable the mic, set this parameter to true , otherwise, set it to false . |
// Enable micITMGContextGetInstance()->GetAudioCtrl()->EnableMic(true);
ITMGAudioCtrl virtual int GetMicState()
ITMGContextGetInstance()->GetAudioCtrl()->GetMicState();
ITMGAudioCtrl virtual int EnableAudioCaptureDevice(bool enable)
Parameter | Type | Description |
enable | bool | To enable the capturing device, set this parameter to true , otherwise, set it to false . |
// Enable capturing deviceITMGContextGetInstance()->GetAudioCtrl()->EnableAudioCaptureDevice(true);
ITMGContext virtual bool IsAudioCaptureDeviceEnabled()
ITMGContextGetInstance()->GetAudioCtrl()->IsAudioCaptureDeviceEnabled();
EnableAudioCaptureDevice
API.ITMGContext virtual int EnableAudioSend(bool bEnable)
Parameter | Type | Description |
bEnable | bool | To enable audio upstreaming, set this parameter to true ; otherwise, set it to false . |
ITMGContextGetInstance()->GetAudioCtrl()->EnableAudioSend(true);
ITMGContext virtual bool IsAudioSendEnabled()
ITMGContextGetInstance()->GetAudioCtrl()->IsAudioSendEnabled();
ITMGAudioCtrl virtual int GetMicLevel()
ITMGContextGetInstance()->GetAudioCtrl()->GetMicLevel();
ITMGAudioCtrl virtual int GetSendStreamLevel()
ITMGContextGetInstance()->GetAudioCtrl()->GetSendStreamLevel();
volume
, which is equivalent to attenuating or gaining the captured sound.ITMGAudioCtrl virtual int SetMicVolume(int vol)
Parameter | Type | Description |
vol | int | Value range: 0–200. Default value: 100. 0 indicates that the audio is mute, while 100 indicates that the volume level remains unchanged. |
int micVol = (int)(value * 100);ITMGContextGetInstance()->GetAudioCtrl()->SetMicVolume(vol);
ITMGAudioCtrl virtual int GetMicVolume()
ITMGContextGetInstance()->GetAudioCtrl()->GetMicVolume();
API | Description |
EnableSpeaker | Enables/Disables the speaker |
GetSpeakerState | Gets the speaker status |
EnableAudioPlayDevice | Enables/Disables the playback device |
IsAudioPlayDeviceEnabled | Gets playback device status |
EnableAudioRecv | Enables/Disables audio downstreaming |
IsAudioRecvEnabled | Gets the audio downstreaming status |
GetSpeakerLevel | Gets the real-time speaker volume level |
GetRecvStreamLevel | Gets the real-time downstreaming audio volume levels of other members in the room |
SetSpeakerVolume | Sets the speaker volume level |
GetSpeakerVolume | Gets the speaker volume level |
ITMGAudioCtrl virtual int EnableSpeaker(bool enable)
Parameter | Type | Description |
enable | bool | To disable the speaker, set this parameter to false ; otherwise, set it to true . |
// Enable the speakerITMGContextGetInstance()->GetAudioCtrl()->EnableSpeaker(true);
ITMGAudioCtrl virtual int GetSpeakerState()
ITMGContextGetInstance()->GetAudioCtrl()->GetSpeakerState();
ITMGAudioCtrl virtual int EnableAudioPlayDevice(bool enable)
Parameter | Type | Description |
enable | bool | To disable the playback device, set this parameter to false ; otherwise, set it to true . |
ITMGContextGetInstance()->GetAudioCtrl()->EnableAudioPlayDevice(true);
ITMGAudioCtrl virtual bool IsAudioPlayDeviceEnabled()
ITMGContextGetInstance()->GetAudioCtrl()->IsAudioPlayDeviceEnabled();
EnableAudioPlayDevice
API.ITMGAudioCtrl virtual int EnableAudioRecv(bool enable)
Parameter | Type | Description |
enable | bool | To enable audio downstreaming, set this parameter to true ; otherwise, set it to false . |
ITMGContextGetInstance()->GetAudioCtrl()->EnableAudioRecv(true);
ITMGAudioCtrl virtual bool IsAudioRecvEnabled()
ITMGContextGetInstance()->GetAudioCtrl()->IsAudioRecvEnabled();
ITMGAudioCtrl virtual int GetSpeakerLevel()
ITMGContextGetInstance()->GetAudioCtrl()->GetSpeakerLevel();
ITMGAudioCtrl virtual int GetRecvStreamLevel(const char* openId)
Parameter | Type | Description |
openId | char* | openId of other members in the room |
iter->second.level = ITMGContextGetInstance()->GetAudioCtrl()->GetRecvStreamLevel(iter->second.openid.c_str());
ITMGAudioCtrl virtual int SetSpeakerVolume(int vol)
Parameter | Type | Description |
vol | int | Volume level. Value range: 0–200. Default value: 100. 0 indicates that the audio is mute, while 100 indicates that the volume level remains unchanged. |
int vol = 100;ITMGContextGetInstance()->GetAudioCtrl()->SetSpeakerVolume(vol);
SetSpeakerVolume
API has not been called.
"Level" indicates the real-time volume, and "Volume" the speaker volume. The final volume = Level * Volume%. For example, if the "Level" is 100 and "Volume" is 60, the final volume is "60".ITMGAudioCtrl virtual int GetSpeakerVolume()
ITMGContextGetInstance()->GetAudioCtrl()->GetSpeakerVolume();
API | Description |
GetMicListCount | Gets the number of mics |
GetMicList | Lists mics |
GetSpeakerListCount | Gets the number of speakers |
GetSpeakerList | Lists speakers |
SelectMic | Selects mics |
SelectSpeaker | Selects speakers |
ITMGAudioCtrl virtual int GetMicListCount()
ITMGContextGetInstance()->GetAudioCtrl()->GetMicListCount();
GetMicListCount
API to enumerate mics.ITMGAudioCtrl virtual int GetMicList(TMGAudioDeviceInfo* ppDeviceInfoList, int nCount)class TMGAudioDeviceInfo{public:const char* pDeviceID;const char* pDeviceName;};
Parameter | Type | Description |
ppDeviceInfoList | TMGAudioDeviceInfo | Device list |
nCount | int | Number of the mics |
TMGAudioDeviceInfo Parameter | Type | Description |
pDeviceID | const char* | Device ID |
pDeviceName | const char* | Device name |
ITMGContextGetInstance()->GetAudioCtrl()->GetMicList(ppDeviceInfoList,nCount);
DEVICEID_DEFAULT
is passed in, the default mic will be selected.
The 0th device id returned in the GetMicList API is the default device of the call device. If there is a selected call device, it will be maintained by service. If it is unplugged, the call device will be changed back into the default device.ITMGAudioCtrl virtual int SelectMic(const char* pMicID)
Parameter | Type | Description |
pMicID | const char* | Mic ID, which is from the list returned by GetMicList . |
const char* pMicID ="{0.0.1.00000000}.{7b0b712d-3b46-4f7a-bb83-bf9be4047f0d}";ITMGContextGetInstance()->GetAudioCtrl()->SelectMic(pMicID);
ITMGAudioCtrl virtual int GetSpeakerListCount()
ITMGContextGetInstance()->GetAudioCtrl()->GetSpeakerListCount();
GetSpeakerListCount
API to enumerate speakers.ITMGAudioCtrl virtual int GetSpeakerList(TMGAudioDeviceInfo* ppDeviceInfoList, int nCount)
Parameter | Type | Description |
ppDeviceInfoList | TMGAudioDeviceInfo | Device list |
nCount | int | Number of the speakers |
TMGAudioDeviceInfo Parameter | Type | Description |
pDeviceID | const char* | Device ID |
pDeviceName | const char* | Device name |
ITMGContextGetInstance()->GetAudioCtrl()->GetSpeakerList(ppDeviceInfoList,nCount);
DEVICEID_DEFAULT
is passed in, the default playback device will be selected.ITMGAudioCtrl virtual int SelectSpeaker(const char* pSpeakerID)
Parameter | Type | Description |
pSpeakerID | const char* | Speaker ID, which is from the list returned by GetSpeakerList . |
const char* pSpeakerID ="{0.0.1.00000000}.{7b0b712d-3b46-4f7a-bb83-bf9be4047f0d}";ITMGContextGetInstance()->GetAudioCtrl()->SelectSpeaker(pSpeakerID);
EnableLoopBack+EnableSpeaker
before you can hear your own voice.ITMGAudioCtrl virtual int EnableLoopBack(bool enable)
Parameter | Type | Description |
enable | bool | Specifies whether to enable |
ITMGContextGetInstance()->GetAudioCtrl()->EnableLoopBack(true);
EnterRoom
API.class ITMGRoom {public:virtual ~ITMGRoom() {} ;virtual int GetRoomType() = 0;};
ITMGContext* context = ITMGContextGetInstance();ITMGContextGetInstance()->GetRoom()->GetRoomType();
ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE
. The audio type of the room is determined by the first user to enter the room. After that, if a member in the room changes the room type, it will take effect for all members there.IITMGContext TMGRoom public int ChangeRoomType((ITMG_ROOM_TYPE roomType)
Parameter | Type | Description |
roomType | ITMG_ROOM_TYPE | Room type to be switched to the target type. For room audio types, please see the EnterRoom API. |
ITMGContext* context = ITMGContextGetInstance();ITMGContextGetInstance()->GetRoom()->ChangeRoomType(ITMG_ROOM_TYPE_FLUENCY);
Message | Data | Sample |
ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE | result; error_info; new_room_type | {"error_info":"","new_room_type":0,"result":0} |
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.Event Subtype | Parameter | Description |
ITMG_ROOM_CHANGE_EVENT_ENTERROOM | 1 | Indicates that the existing audio type is inconsistent with and changed to that of the entered room. |
ITMG_ROOM_CHANGE_EVENT_START | 2 | Indicates that a user is already in the room and the audio type starts changing (e.g., calling the ChangeRoomType API to change the audio type). |
ITMG_ROOM_CHANGE_EVENT_COMPLETE | 3 | Indicates that a user is already in the room and the audio type has been changed. |
ITMG_ROOM_CHANGE_EVENT_REQUEST | 4 | Indicates that a room member calls the ChangeRoomType API to request a change of room audio type. |
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}}
ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_QUALITY
. The returned parameters include weight
, loss
, and delay
, which are as detailed below:Parameter | Type | Description |
weight | int | Value range: 1-50. 50 indicates excellent sound quality, 1 indicates very poor (barely usable) sound quality, and 0 represents an initial meaningless value. Generally, if the value is below 30, the business layer will remind users that the network is poor and recommend them to switch the network. |
loss | double | Upstream packet loss rate |
delay | int | Voice chat delay in ms |
ITMGContext virtual const char* GetSDKVersion()
ITMGContextGetInstance()->GetSDKVersion();
ITMGContext int SetLogLevel(ITMG_LOG_LEVEL levelWrite, ITMG_LOG_LEVEL levelPrint)
Parameter | Type | Description |
levelWrite | ITMG_LOG_LEVEL | Sets the level of logs to be written. TMG_LOG_LEVEL_NONE indicates not to write. Default value: TMG_LOG_LEVEL_INFO |
levelPrint | ITMG_LOG_LEVEL | Sets the level of logs to be printed. TMG_LOG_LEVEL_NONE indicates not to print. Default value: TMG_LOG_LEVEL_ERROR |
ITMG_LOG_LEVEL
is as detailed below:ITMG_LOG_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 |
ITMGContextGetInstance()->SetLogLevel(TMG_LOG_LEVEL_INFO,TMG_LOG_LEVEL_INFO);
OS | Path |
Windows | %appdata%\\Tencent\\GME\\ProcessName |
iOS | Application/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Documents |
Android | /sdcard/Android/data/xxx.xxx.xxx/files |
Mac | /Users/username/Library/Containers/xxx.xxx.xxx/Data/Documents |
ITMGContext virtual int SetLogPath(const char* logDir)
Parameter | Type | Description |
logDir | const char* | Path |
cosnt char* logDir = ""// Set a path by yourselfITMGContext* context = ITMGContextGetInstance();context->SetLogPath(logDir);
ITMGRoom virtual const char* GetQualityTips()
ITMGContextGetInstance()->GetRoom()->GetQualityTips();
Message | Description | Parameter | Sample |
ITMG_MAIN_EVENT_TYPE_ENTER_ROOM | A member entered the audio room | result; error_info | {"error_info":"","result":0} |
ITMG_MAIN_EVENT_TYPE_EXIT_ROOM | A member exited the audio room | result; error_info | {"error_info":"","result":0} |
ITMG_MAIN_EVENT_TYPE_ROOM_DISCONNECT | The room was disconnected for network or other reasons | result; error_info | {"error_info":"waiting timeout, please check your network","result":0} |
ITMG_MAIN_EVNET_TYPE_USER_UPDATE | The room members were updated | user_list; event_id | {"event_id":1,"user_list":["0"]} |
ITMG_MAIN_EVENT_TYPE_RECONNECT_START | Room reconnection started | result; error_info | {"error_info":"","result":0} |
ITMG_MAIN_EVENT_TYPE_RECONNECT_SUCCESS | Room reconnection succeeded | result; error_info | {"error_info":"","result":0} |
ITMG_MAIN_EVENT_TYPE_SWITCH_ROOM | The room was quickly switched | result; error_info | {"error_info":"","result":0} |
ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE | The room status changed | result; error_info; sub_event_type; new_room_type | {"error_info":"","new_room_type":0,"result":0} |
ITMG_MAIN_EVENT_TYPE_ROOM_SHARING_START | Cross-room mic connect started | result; | {"result":0} |
ITMG_MAIN_EVENT_TYPE_ROOM_SHARING_STOP | Cross-room mic connect stopped | result; | {"result":0} |
ITMG_MAIN_EVENT_TYPE_SPEAKER_DEFAULT_DEVICE_CHANGED | The default speaker was changed | result; error_info | {"deviceID":"{0.0.0.00000000}.{a4f1e8be-49fa-43e2-b8cf-dd00542b47ae}","deviceName":"speaker (Realtek High Definition Audio)","error_info":"","isNewDevice":true,"isUsedDevice":false,"result":0} |
ITMG_MAIN_EVENT_TYPE_SPEAKER_NEW_DEVICE | A speaker was added | result; error_info | {"deviceID":"{0.0.0.00000000}.{a4f1e8be-49fa-43e2-b8cf-dd00542b47ae}","deviceName":"speaker (Realtek High Definition Audio)","error_info":"","isNewDevice":true,"isUsedDevice":false,"result":0} |
ITMG_MAIN_EVENT_TYPE_SPEAKER_LOST_DEVICE | A speaker was lost | result; error_info | {"deviceID":"{0.0.0.00000000}.{a4f1e8be-49fa-43e2-b8cf-dd00542b47ae}","deviceName":"speaker (Realtek High Definition Audio)","error_info":"","isNewDevice":false,"isUsedDevice":false,"result":0} |
ITMG_MAIN_EVENT_TYPE_MIC_NEW_DEVICE | A mic was added | result; error_info | {"deviceID":"{0.0.1.00000000}.{5fdf1a5b-f42d-4ab2-890a-7e454093f229}","deviceName":"mic (Realtek High Definition Audio)","error_info":"","isNewDevice":true,"isUsedDevice":true,"result":0} |
ITMG_MAIN_EVENT_TYPE_MIC_LOST_DEVICE | A mic was lost | result; error_info | {"deviceID":"{0.0.1.00000000}.{5fdf1a5b-f42d-4ab2-890a-7e454093f229}","deviceName":"mic (Realtek High Definition Audio)","error_info":"","isNewDevice":false,"isUsedDevice":true,"result":0} |
ITMG_MAIN_EVENT_TYPE_MIC_DEFAULT_DEVICE_CHANGED | The default mic was changed | result; error_info | {"deviceID":"{0.0.1.00000000}.{5fdf1a5b-f42d-4ab2-890a-7e454093f229}","deviceName":"mic (Realtek High Definition Audio)","error_info":"","isNewDevice":false,"isUsedDevice":true,"result":0} |
ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_QUALITY | Room quality message | weight; loss; delay | {"weight":5,"loss":0.1,"delay":1} |
ITMG_MAIN_EVNET_TYPE_PTT_RECORD_COMPLETE | Recording of a voice message was completed | result; file_path | {"file_path":"","result":0} |
ITMG_MAIN_EVNET_TYPE_PTT_UPLOAD_COMPLETE | Upload of a voice message was completed | result; file_path;file_id | {"file_id":"","file_path":"","result":0} |
ITMG_MAIN_EVNET_TYPE_PTT_DOWNLOAD_COMPLETE | Download of a voice message was completed | result; file_path;file_id | {"file_id":"","file_path":"","result":0} |
ITMG_MAIN_EVNET_TYPE_PTT_PLAY_COMPLETE | Playback of a voice message was completed | result; file_path | {"file_path":"","result":0} |
ITMG_MAIN_EVNET_TYPE_PTT_SPEECH2TEXT_COMPLETE | Fast recording-to-text conversion was completed | result; text;file_id | {"file_id":"","text":"","result":0} |
ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_COMPLETE | Streaming speech-to-text conversion was completed | result; file_path; text;file_id | {"file_id":"","file_path":","text":"","result":0} |
ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_IS_RUNNING | A voice message is being converted into text in a streaming manner | result; file_path; text;file_id | {"file_id":"","file_path":","text":"","result":0} |
ITMG_MAIN_EVNET_TYPE_PTT_TEXT2SPEECH_COMPLETE | Text-to-speech conversion was completed | result; text;file_id | {"file_id":"","text":"","result":0} |
ITMG_MAIN_EVNET_TYPE_PTT_TRANSLATE_TEXT_COMPLETE | Text translation was completed | result; text;file_id | {"file_id":"","text":"","result":0} |
Was this page helpful?