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 ITMGRoom;//Room APIs@class ITMGAudioCtrl;//Audio APIs@class ITMGAudioEffectCtrl;//Sound effect and accompaniment APIs
API | Description |
InitEngine | Initializes GME. |
Poll | Triggers an event callback. |
Pause | Pauses the system. |
Resume | Resumes the system. |
Uninit | Uninitializes GME. |
SetDefaultAudienceAudioCategory | Sets the audio of the iOS device. |
UnInit
to uninitialize the SDK. No fees are incurred for calling the InitEngine
API.#import "GMESDK/TMGEngine.h"#import "GMESDK/QAVAuthBuffer.h"
ITMGContext
object first.+ (ITMGContext*) GetInstance;
//TMGSampleViewController.mITMGContext* _context = [ITMGContext GetInstance];
Delegate
method to send callback notifications to the application. Register the callback function to the SDK for receiving callback messages.ITMGDelegate
is used for declaration.@interface TMGDemoViewController ()<ITMGDelegate>{}ITMGDelegate < NSObject >//TMGSampleViewController.mITMGContext* _context = [ITMGContext GetInstance];_context.TMGDelegate = [DispatchCenter getInstance];
OnEvent
. For the message type, see ITMG_MAIN_EVENT_TYPE
. The message content is a dictionary for parsing the API callback contents.- (void)OnEvent:(ITMG_MAIN_EVENT_TYPE)eventType data:(NSDictionary*)data;
//TMGRealTimeViewController.mTMGRealTimeViewController ()< ITMGDelegate >- (void)OnEvent:(ITMG_MAIN_EVENT_TYPE)eventType data:(NSDictionary *)data {NSString *log = [NSString stringWithFormat:@"OnEvent:%d,data:%@", (int)eventType, data];[self showLog:log];NSLog(@"====%@====", log);switch (eventType) {// Step 6/11 : Perform the enter room eventcase ITMG_MAIN_EVENT_TYPE_ENTER_ROOM: {int result = ((NSNumber *)[data objectForKey:@"result"]).intValue;NSString *error_info = [data objectForKey:@"error_info"];[self showLog:[NSString stringWithFormat:@"OnEnterRoomComplete:%d msg:(%@)", result, error_info]];if (result == 0) {[self updateStatusEnterRoom:YES];}}break;}}// Refer to DispatchCenter.h and DispatchCenter.m
InitEngine
API before you can use the voice chat, voice messaging, and speech-to-text services. The InitEngine
API must be called in the same thread as other APIs. We recommend that you call all APIs in the main thread.-(int)InitEngine:(NSString*)sdkAppID openID:(NSString*)openID;
Parameter | Type | Description |
sdkAppId | String | |
OpenId | String | 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 |
QAV_OK= 0 | The SDK was initialized successfully. |
QAV_ERR_SDK_NOT_FULL_UPDATE= 7015 | Checks whether the SDK file is complete. We recommend that you delete it and then import it again. |
AV_ERR_SDK_NOT_FULL_UPDATE
is only a reminder but will not cause an initialization failure._openId = _userIdText.text;_appId = _appIdText.text;int result = 0;// After the user consents to the application's privacy policy, initialize the SDK at an appropriate time based on the application features//result = 0: The user consents to the application's privacy policy//result = 1: The user does not consent to the application's privacy policy// If the user does not consent to the privacy policy, change `ret` to a value other than 0if (result == 0) {[[ITMGContext GetInstance] InitEngine:SDKAPPID openID:_openId];}else{log = [NSString stringWithFormat:@"The user does not consent to the application's privacy policy"];}
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.
Refer to the EnginePollHelper.m
file in SDK Download Guide.Poll
API periodicallyPoll
API must be called periodically and in the main thread to avoid abnormal API callbacks.-(void)Poll;
[[ITMGContext GetInstance] 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.-(QAVResult)Pause;
Resume
event occurs in the system, the engine should also be notified for resumption. The Resume
API only supports resuming voice chat.-(QAVResult)Resume;
openid
, switching game account requires uninitializing GME and then using the new openid
to initialize again.Uninit
API to stop using the SDK features and stop collecting and close the user data used by the features.-(int)Uninit;
[[ITMGContext GetInstance] Uninit];
PauseAudio
).key:Required background modes
and string:App plays audio or streams audio/video using AirPlay
to the Info.plist
of the application.-(QAVResult)SetDefaultAudienceAudioCategory:(ITMG_AUDIO_CATEGORY)audioCategory;
Type | Value | Description |
ITMG_CATEGORY_AMBIENT | 0 | Audio is not played back in the background (default value). |
ITMG_CATEGORY_PLAYBACK | 1 | Audio is played back in the background. |
kAudioSessionProperty_AudioCategory
. For more information, see Apple documentation.[[ITMGContext GetInstance]SetDefaultAudienceAudioCategory:ITMG_CATEGORY_AMBIENT];
API | Description |
GenAuthBuffer | Calculates the local authentication key. |
EnterRoom | Enters a room. |
ExitRoom | Exits a room. |
IsRoomEntered | Determines whether room entry is successful. |
SwitchRoom | Switches the room quickly. |
StartRoomSharing | Cross-room Co-anchoring |
AuthBuffer
for encryption and authentication of relevant features. For release in the production environment, use the backend deployment key as detailed in Authentication Key.@interface QAVAuthBuffer : NSObject+ (NSData*) GenAuthBuffer:(unsigned int)appId roomId:(NSString*)roomId openID:(NSString*)openID key:(NSString*)key;+ @end
Parameter | Type | Description |
appId | unsigned int | AppId from the Tencent Cloud console |
roomId | NSString * | Room ID, which can contain up to 127 characters. |
openID | NSString * | User ID, which is the same as openID during initialization. |
key | NSString * |
#import "GMESDK/QAVAuthBuffer.h"NSData* authBuffer = [QAVAuthBuffer GenAuthBuffer:SDKAPPID3RD.intValue roomId:_roomId openID:_openId key:AUTHKEY];
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, the audio type of the room will be changed.-(int)EnterRoom:(NSString*) roomId roomType:(int)roomType authBuffer:(NSData*)authBuffer;
Parameter | Type | Description |
roomId | NSString * | Room ID, which can contain up to 127 characters. |
roomType | int | Room type. We recommend that you enter ITMG_ROOM_TYPE_FLUENCY . For more information on room audio types, see Sound Quality. |
authBuffer | NSData * | Authentication key |
[[ITMGContext GetInstance] EnterRoom:_roomId roomType:_roomType authBuffer:authBuffer];
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)OnEvent:(ITMG_MAIN_EVENT_TYPE)eventType data:(NSDictionary *)data{NSLog(@"OnEvent:%lu,data:%@",(unsigned long)eventType,data);switch (eventType) {case ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:{int result = ((NSNumber*)[data objectForKey:@"result"]).intValue;NSString* error_info = [data objectForKey:@"error_info"];//Receive the event of successful room entry}break;}}
Message | Data | Example |
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 | Cause and Suggested Solution |
7006 | Authentication failed. Causes: AppID doesn't exist or is incorrect.An error occurred while authenticating authbuff .Authentication expired. OpenId is invalid. |
7007 | The user was already in another room. |
1001 | The user was already in the process of entering a room but repeated this operation. We recommend that you not call the room entry API until the room entry callback is returned. |
1003 | The user was already in the room and called the room entry 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; instead, you can directly call the EnterRoom
API.-(int)ExitRoom
[[ITMGContext GetInstance] ExitRoom];
ITMG_MAIN_EVENT_TYPE_EXIT_ROOM
.-(void)OnEvent:(ITMG_MAIN_EVENT_TYPE)eventType data:(NSDictionary *)data{NSLog(@"OnEvent:%lu,data:%@",(unsigned long)eventType,data);switch (eventType) {case ITMG_MAIN_EVENT_TYPE_EXIT_ROOM:{// Receive the event of successful room exit}break;}}
Message | Data | Example |
ITMG_MAIN_EVENT_TYPE_EXIT_ROOM | result; error_info | {"error_info":"","result":0} |
-(BOOL)IsRoomEntered;
[[ITMGContext GetInstance] IsRoomEntered];
ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_SWITCH_ROOM
, and the fields are error_info
and result
.-(int) SwitchRoom:(NSString *)roomID authBuffer:(NSData*)authBuffer;
Parameter | Type | Description |
targetRoomID | NSString * | ID of the room to enter |
authBuffer | NSData* | Generates a new authentication key with the ID of the room to enter |
- (IBAction)swichRoom:(id)sender {NSData* authBuffer = [QAVAuthBuffer GenAuthBuffer:_appId.intValue roomID:_roomIdText.text openID:_openId key:_key];[[[ITMGContext GetInstance]GetRoom]SwitchRoom:_roomIdText.text authBuffer:authBuffer];}-(void)OnEvent:(ITMG_MAIN_EVENT_TYPE)eventType data:(NSDictionary *)data{NSString* log =[NSString stringWithFormat:@"OnEvent:%d,data:%@", (int)eventType, data];[self showLog:log];NSLog(@"====%@====",log);switch (eventType) {case ITMG_MAIN_EVENT_TYPE_SWITCH_ROOM:{int result = ((NSNumber*)[data objectForKey:@"result"]).intValue;NSString* log = nil;if (result == QAV_OK) {log = [NSString stringWithFormat:@"switch room success."];} else {log = [NSString stringWithFormat:@"switch room failed."];}[self showLog:log];break;}}}
-(int) StartRoomSharing:(NSString *)targetRoomID targetOpenID:(NSString *)targetOpenID authBuffer:(NSData*)authBuffer;-(int) StopRoomSharing;
Parameter | Type | Description |
targetRoomID | NSString * | ID of the room to connect mic |
targetOpenID | NSString * | Target OpenID to connect mic |
authBuffer | NSData* | Reserved flag. You just need to enter NULL. |
- (IBAction)shareRoom:(id)sender {if(_shareRoomSwitch.isOn){[[[ITMGContext GetInstance]GetRoom]StartRoomSharing:_shareRoomID.text targetOpenID:_shareOpenID.text authBuffer:NULL];}else{[[[ITMGContext GetInstance]GetRoom]StopRoomSharing];}}
API/Notification | Description |
ITMG_MAIN_EVNET_TYPE_USER_UPDATE | The member status changed. |
AddAudioBlackList | Mutes a member in the room. |
RemoveAudioBlackList | Unmutes a member. |
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)OnEvent:(ITMG_MAIN_EVENT_TYPE)eventType data:(NSDictionary *)data{ITMG_EVENT_ID_USER_UPDATE event_id=((NSNumber*)[data objectForKey:@"event_id"]).intValue;NSMutableArray* uses = [NSMutableArray arrayWithArray: [data objectForKey:@"user_list"]];NSLog(@"OnEvent:%lu,data:%@",(unsigned long)eventType,data);switch (eventType) {case ITMG_MAIN_EVNET_TYPE_USER_UPDATE:{// Process//Parse the parameter to get `event_id` 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;}break;}}}
Message | Data | Example |
ITMG_MAIN_EVNET_TYPE_USER_UPDATE | event_id; user_list | {"event_id":0,"user_list":""} |
0
indicates that the call is successful. Assume that users A, B, and C are all speaking using their mic in a room:ITMGContext GetAudioCtrl -(QAVResult)AddAudioBlackList:(NSString*)openID;
Parameter | Type | Description |
openId | NSString | openid of the user to be blocked |
[[[ITMGContext GetInstance]GetAudioCtrl ] AddAudioBlackList[id]];
-(QAVResult)RemoveAudioBlackList:(NSString*)openID;
Parameter | Type | Description |
openId | NSString | User openid to be unblocked |
[[[ITMGContext GetInstance]GetAudioCtrl ] RemoveAudioBlackList[openId]];
EnableMic
or EnableSpeaker
API.EnableAudioCaptureDevice(true)
and EnableAudioPlayDevice(true)
once after room entry, and call EnableAudioSend/Recv
to send/receive audio streams when Enable/Disable Mic is clicked.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 the real-time audio upstreaming volume level. |
SetMicVolume | Sets the mic volume level. |
GetMicVolume | Gets the mic volume level. |
EnableMic
is equivalent to using EnableAudioCaptureDevice
and EnableAudioSend
together. If accompaniment is used, call this API as instructed in Accompaniment in Voice Chat.-(QAVResult)EnableMic:(BOOL)enable;
Parameter | Type | Description |
enable | boolean | To enable the mic, set this parameter to YES .To disable the mic, set this parameter to NO . |
// Turn on mic[[[ITMGContext GetInstance] GetAudioCtrl] EnableMic:YES];
-(int)GetMicState;
[[[ITMGContext GetInstance] GetAudioCtrl] GetMicState];
-(QAVResult)EnableAudioCaptureDevice:(BOOL)enabled;
Parameter | Type | Description |
enabled | BOOL | To enable the capturing device, set this parameter to YES .To disable the capturing device, set this parameter to NO . |
// Enable capturing device[[[ITMGContext GetInstance]GetAudioCtrl ]EnableAudioCaptureDevice:enabled];
-(BOOL)IsAudioCaptureDeviceEnabled;
BOOL IsAudioCaptureDevice = [[[ITMGContext GetInstance] GetAudioCtrl] IsAudioCaptureDeviceEnabled];
EnableAudioCaptureDevice
API.-(QAVResult)EnableAudioSend:(BOOL)enable;
Parameter | Type | Description |
enable | BOOL | To enable audio upstreaming, set this parameter to YES .To disable audio upstreaming, set this parameter to NO . |
[[[ITMGContext GetInstance]GetAudioCtrl ]EnableAudioSend:enabled];
-(BOOL)IsAudioSendEnabled;
BOOL IsAudioSend = [[[ITMGContext GetInstance] GetAudioCtrl] IsAudioSendEnabled];
-(int)GetMicLevel;
[[[ITMGContext GetInstance] GetAudioCtrl] GetMicLevel];
-(int)GetSendStreamLevel();
[[[ITMGContext GetInstance] GetAudioCtrl] GetSendStreamLevel];
volume
, which is equivalent to attenuating or gaining the captured sound.-(QAVResult)SetMicVolume:(int) volume;
Parameter | Type | Description |
volume | int | Value range: 0-200. Default value: 100 . 0 indicates that the audio is muted, while 100 indicates that the volume level remains unchanged. |
[[[ITMGContext GetInstance] GetAudioCtrl] SetMicVolume:100];
-(int) GetMicVolume;
[[[ITMGContext GetInstance] GetAudioCtrl] GetMicVolume];
API | Description |
EnableSpeaker | Enables/Disables the speaker. |
GetSpeakerState | Gets the speaker status. |
EnableAudioPlayDevice | Enables/Disables the playback device. |
IsAudioPlayDeviceEnabled | Gets the 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 levels of other members in the room. |
SetSpeakerVolume | Sets the speaker volume level. |
GetSpeakerVolume | Gets the speaker volume level. |
EnableSpeaker
is equivalent to using EnableAudioPlayDevice
and EnableAudioRecv
together. If accompaniment is used, call this API as instructed in Accompaniment in Voice Chat.-(void)EnableSpeaker:(BOOL)enable;
Parameter | Type | Description |
enable | boolean | To disable the speaker, set this parameter to NO .To enable the speaker, set this parameter to YES . |
// Turn on the speaker[[[ITMGContext GetInstance] GetAudioCtrl] EnableSpeaker:YES];
-(int)GetSpeakerState;
[[[ITMGContext GetInstance] GetAudioCtrl] GetSpeakerState];
-(QAVResult)EnableAudioPlayDevice:(BOOL)enabled;
Parameter | Type | Description |
enabled | BOOL | To disable the playback device, set this parameter to NO .To enable the playback device, set this parameter to YES . |
// Enable the playback device[[[ITMGContext GetInstance]GetAudioCtrl ]EnableAudioPlayDevice:enabled];
-(BOOL)IsAudioPlayDeviceEnabled;
BOOL IsAudioPlayDevice = [[[ITMGContext GetInstance] GetAudioCtrl] IsAudioPlayDeviceEnabled];
EnableAudioPlayDevice
API.-(QAVResult)EnableAudioRecv:(BOOL)enabled;
Parameter | Type | Description |
enabled | BOOL | To enable audio downstreaming, set this parameter to YES .To disable audio downstreaming, set this parameter to NO . |
[[[ITMGContext GetInstance]GetAudioCtrl ]EnableAudioRecv:enabled];
-(BOOL)IsAudioRecvEnabled;
BOOL IsAudioRecv = [[[ITMGContext GetInstance] GetAudioCtrl] IsAudioRecvEnabled];
-(int)GetSpeakerLevel;
[[[ITMGContext GetInstance] GetAudioCtrl] GetSpeakerLevel];
-(int)GetRecvStreamLevel:(NSString*) openID;
Parameter | Type | Description |
openID | NSString | openId of another member in the room |
[[[ITMGContext GetInstance] GetAudioCtrl] GetRecvStreamLevel:(NSString*) openId];
-(int) SetSpeakerVolumeByOpenID:(NSString *)openId volume:(int)volume;
Parameter | Type | Description |
openId | String * | OpenID of the target user |
volume | int | Percentage. Recommended value range: 0-200. Default value: 100 . |
-(int) GetSpeakerVolumeByOpenID:(NSString *)openId;
-(QAVResult)SetSpeakerVolume:(int)vol;
Parameter | Type | Description |
vol | int | Volume level. Value range: 0–200. |
[[[ITMGContext GetInstance] GetAudioCtrl] SetSpeakerVolume:100];
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".-(int)GetSpeakerVolume;
[[[ITMGContext GetInstance] GetAudioCtrl] GetSpeakerVolume];
EnableLoopBack+EnableSpeaker
before you can hear your own voice.-(QAVResult)EnableLoopBack:(BOOL)enable;
Parameter | Type | Description |
enable | boolean | Specifies whether to enable the in-ear monitoring. |
[[[ITMGContext GetInstance] GetAudioCtrl] EnableLoopBack:YES];
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.-(int)ChangeRoomType:(int)nRoomType;
Parameter | Type | Description |
nRoomType | int | Room type to be switched to. For room audio types, see the EnterRoom API. |
[[[ITMGContext GetInstance]GetRoom ]ChangeRoomType:_roomType];
EnterRoom
API.-(int)GetRoomType;
[[[ITMGContext GetInstance]GetRoom ]GetRoomType];
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 | The existing audio type is inconsistent with and changed to that of the entered room. |
ITMG_ROOM_CHANGE_EVENT_START | 2 | 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 | A user is already in the room, and the audio type has been changed. |
ITMG_ROOM_CHANGE_EVENT_REQUEST | 4 | A room member calls the ChangeRoomType API to request a change of the room audio type. |
-(void)OnEvent:(ITMG_MAIN_EVENT_TYPE)eventType data:(NSDictionary *)data{NSLog(@"OnEvent:%lu,data:%@",(unsigned long)eventType,data);switch (eventType) {case ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE:NSLog(@"ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE:%@ ",data);int result = ((NSNumber*)[data objectForKey:@"result"]).intValue;int newRoomType = ((NSNumber*) [data objectForKey:@"new_room_type"]).intValue;int subEventType = ((NSNumber*) [data objectForKey:@"sub_event_type"]).intValue;}}
Message | Data | Example |
ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE | result;error_info;new_room_type;subEventType | {"error_info":"","new_room_type":0,"subEventType":0,"result":0} |
ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_QUALITY
. The returned parameters include weight
, loss
, and delay
, which represent the following information.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, you can 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 |
-(NSString*)GetSDKVersion;
[[ITMGContext GetInstance] GetSDKVersion];
-(ITMG_RECORD_PERMISSION)CheckMicPermission;
Parameter | Value | Description |
ITMG_PERMISSION_GRANTED | 0 | The mic permission is granted. |
ITMG_PERMISSION_Denied | 1 | Microphone disabled. |
ITMG_PERMISSION_NotDetermined | 2 | No authorization box has been popped up to request the permission. |
ITMG_PERMISSION_ERROR | 3 | An error occurred while calling the API. |
[[ITMGContext GetInstance] CheckMicPermission];
-(void)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 log. 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 | 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 |
[[ITMGContext GetInstance] SetLogLevel:TMG_LOG_LEVEL_INFO TMG_LOG_LEVEL_INFO];
Application/********-****-****-****-************/Documents
.-(void)SetLogPath:(NSString*)logDir;
Parameter | Type | Description |
logDir | NSString | Path |
[[ITMGContext GetInstance] SetLogPath:Path];
-(NSString*)GetQualityTips;
[[[ITMGContext GetInstance]GetRoom ] GetQualityTips];
Message | Description |
ITMG_MAIN_EVENT_TYPE_ENTER_ROOM | A member entered the audio room. |
ITMG_MAIN_EVENT_TYPE_EXIT_ROOM | A member exited the audio room. |
ITMG_MAIN_EVENT_TYPE_ROOM_DISCONNECT | The room was disconnected due to a network or another issue. |
ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE | The room type changed. |
ITMG_MAIN_EVNET_TYPE_USER_UPDATE | Room members were updated. |
ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_QUALITY | The room quality changed. |
Message | Data | Example |
ITMG_MAIN_EVENT_TYPE_ENTER_ROOM | result; error_info | {"error_info":"","result":0} |
ITMG_MAIN_EVENT_TYPE_EXIT_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_CHANGE_ROOM_TYPE | result; error_info; sub_event_type; new_room_type | {"error_info":"","new_room_type":0,"result":0} |
ITMG_MAIN_EVENT_TYPE_SPEAKER_NEW_DEVICE | 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 | 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 | 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 | 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_EVNET_TYPE_USER_UPDATE | user_list; event_id | {"event_id":1,"user_list":["0"]} |
ITMG_MAIN_EVENT_TYPE_NUMBER_OF_USERS_UPDATE | AllUser; AccUser; ProxyUser | {"AllUser":3,"AccUser":2,"ProxyUser":1} |
ITMG_MAIN_EVENT_TYPE_NUMBER_OF_AUDIOSTREAMS_UPDATE | AudioStreams | {"AudioStreams":3} |
ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_QUALITY | weight; loss; delay | {"weight":5,"loss":0.1,"delay":1} |
この記事はお役に立ちましたか?