API | Description |
登录。 | |
退出登录。 | |
进行一对一通话,支持自定义房间ID、通话超时、离线推送内容等。 | |
进行群组通话,支持自定义房间ID、通话超时、离线推送内容等。 | |
加入群组通话。 | |
自定义用户的铃声。 | |
设置自己的昵称和头像。 | |
打开/关闭铃声。 | |
设置屏幕方向。 | |
监听 TUICallKit 事件 | |
取消监听 TUICallKit 事件 |
TUICallKit.login({sdkAppId: 0,userId: '',userSig: '',},(res) => {console.log('login success');},(errCode, errMsg) => {console.log('login error');});
参数 | 类型 | 含义 |
sdkAppId | Number | |
userId | String | 客户根据自己的业务自定义用户 ID,只允许包含大小写英文字母(a-z A-Z)、数字(0-9)及下划线和连词符。 |
userSig | String |
TUICallKit.login((res) => {console.log('login success', res);},(errCode, errMsg) => {console.log('login error', errCode, errMsg);});
TUICallKit.call({userId: calleeID,mediaType: MediaType.Audio,callParams: {offlinePushInfo: {title: '',desc: '',},},},() => {console.log('call success');},() => {console.log('call error');});
参数 | 类型 | 含义 |
userId | String | 目标用户的 userId |
mediaType | 通话的媒体类型,比如视频通话、语音通话。 MediaType.Audio :语音通话。 MediaType.Video :视频通话。 | |
callParams |
TUICallKit.groupCall({userIdList: userIDList,mediaType: MediaType.Audio,groupId: '',},(res) => {console.log('groupCall success', res);},(errCode, errMsg) => {console.log('groupCall error', errCode, errMsg);});
参数 | 类型 | 含义 |
groupId | String | 此次群组通话的群 ID。 |
userIdList | Array<String> | 被呼叫的用户列表。 |
mediaType | 通话的媒体类型,比如视频通话、语音通话 MediaType.Audio :语音通话。 MediaType.Video :视频通话。 | |
callParams |
TUICallKit.joinInGroupCall({roomId: '',groupId: '',mediaType: '',});
参数 | 类型 | 含义 |
roomId | RoomId | 此次通话的音视频房间 ID |
groupId | String | 此次群组通话的群 ID |
mediaType | 通话的媒体类型,比如视频通话、语音通话 |
filePath
传空即可。String filePath = '';TUICallKit.setCallingBell(filePath);
参数 | 类型 | 含义 |
filePath | String | 铃声文件地址 |
Boolean enable = trueTUICallKit.enableMuteMode(enable);
参数 | 类型 | 含义 |
enable | Boolean | 开启/关闭来电铃声。默认 false。 |
Boolean enable = trueTUICallKit.enableVirtualBackground(enable);
参数 | 类型 | 含义 |
enable | Boolean | enable = true 显示模糊背景按钮 enable = false 不显示模糊背景按钮 |
Number orientation = 0TUICallKit.setScreenOrientation(orientation);
参数 | 类型 | 含义 |
orientation | Number | orientation = 0 : 竖屏显示。 orientation = 1 : 横屏显示。 orientation = 2 : 根据当前设备的状态自动选择最佳的显示方式. |
function onListener(type: TUICallEvent, params: any) {if (type === TUICallEvent.onCallBegin) {// 在此处理事件发生的业务逻辑}}TUICallKit.on(onListener);
参数 | 类型 | 含义 |
type | String | |
params | Any |
function onListener(type: TUICallEvent, params: any) {if (type === TUICallEvent.onCallBegin) {console.log('onCallBegin');}}TUICallKit.off(onListener);
本页内容是否解决了您的问题?