音视频通话

API

接口函数详情

SDK 初始化

  • 方法: init(SdkInitDat dat)

  • 参数:

参数 类型 含义
dat SdkInitDat SDK 配置、临时文件存放位置,不可为空
  • 返回值:
类型 含义
int 错误码

SDK 反初始化

  • 方法: uninit()

获取服务器地址

  • 方法: String getServerAddr()

  • 返回值: 服务器地址

设置服务器地址

  • 方法: setServerAddr(serverAddr)
参数 类型 含义
serverAddr String 服务器地址,如 10.8.8.122:2726

登录

  • 方法: login(loginDat)
参数 类型 含义
loginDat LoginDat 登录参数
  • 返回值:
参数 类型 含义
loginResult LoginResult 登录结果

token登录

  • 方法: loginByToken(String token, String nickName, String userID, String userAuthCode, {String? cookie})
参数 类型 含义
nickname String 用户的昵称
  • 返回值:
参数 类型 含义
loginResult LoginResult 登录结果
注意:

在 token 有效期只有 30 秒时,sdk 将发出onNotifyTokenWillExpire通知,集成方应尽快通过updateToken更新新的 token 延长有限时间。

Token即将失效

  • 方法: void updateToken(String token)

  • 功能: 更新 Token(在 Token 即将失效的时候更新 Token 延长有限时间)

参数 类型 含义
token String Token 鉴权码

注销

  • 方法: logout()

设置免打扰状态

  • 方法: setDNDStatus(int status)
参数 类型 含义
status int 0 代表关闭免打扰, 其它值代表开启免打扰,含义自由定义

通知用户掉线

  • 订阅方法: onLineOff(int sdkErr)

  • 接收参数:

参数 类型 含义
sdkErr int 错误码

通知Token即将过期

  • 订阅方法: onNotifyTokenWillExpire()

获取房间所有成员的列表

  • 方法: getAllMembers()

  • 返回值:

类型 含义
MemberInfo 成员列表

获取某个用户的信息

  • 方法: getMemberInfo()

  • 返回值:

获取某个用户的昵称

  • 方法: getNickName()

  • 返回值:

类型 含义
String 用户的昵称

设置某个用户的昵称

  • 方法: setNickName(String nickname)

  • 参数:

参数 类型 含义
nickname String 用户的昵称

判断某个用户是否在房间中

  • 方法: isUserInMeeting(String userID)
参数 类型 含义
userID String 用户 ID
  • 返回值:
类型 含义
bool 用户是否在房间中

创建视频房间

  • 方法: createMeeting()

  • 返回值:

类型 含义
MeetInfo 房间信息

进入视频房间

  • 方法: enterMeeting(int meetID)
参数 类型 含义
meetID int 会议号 ID
  • 返回值:
类型 含义
int 错误码

离开房间

  • 方法: exitMeeting()

销毁视频房间

  • 方法: destroyMeeting(int meetID)
参数 类型 含义
meetID int 会议号 ID
  • 返回值:
类型 含义
int 错误码

某用户进入了房间

  • 订阅方法: onUserEnterMeeting(String userID)
参数 类型 含义
userID String 用户 ID

某用户离开了房间

  • 订阅方法: onUserLeftMeeting(String userID)
参数 类型 含义
userID String 用户 ID

通知从房间里掉线

通知从房间里掉线了,收到该通知后可以调用 enterMeeting 尝试重新进入房间

  • 订阅方法: onMeetingDropped(MEETING_DROPPED_REASON reason)
参数 类型 含义
reason MEETING_DROPPED_REASON 掉线原因

房间已被结束

  • 订阅方法: onMeetingStopped()

网络变化通知

  • 订阅方法: onNetStateChanged(int level)
参数 类型 含义
level int 网络状况等级(0~10,10 分为最佳网络)

把某个成员踢出房间

  • 方法: kickout(String userID)

  • 返回值: 无

  • 参数:

参数 类型 含义
userID String 用户 ID

房间内发送广播消息

  • 方法: sendMeetingCustomMsg(String text)

  • 返回值:

类型 含义
int 错误码
  • 参数:
参数 类型 含义
text String 用户自定义消息

通知发送房间内自定义广播消息结果

  • 订阅方法: onNotifyMeetingCustomMsg(MeetingCustomMsg msg)

  • 接收参数:

参数 类型 含义
msg MeetingCustomMsg MeetingCustomMsg

获取房间内所有可观看的摄像头

  • 方法: getWatchableVideos()

  • 返回值:

类型 含义
List 房间内可观看摄像头用户、ID

获取用户所有的摄像头信息

  • 方法: getAllVideoInfo(userID)

  • 参数:

参数 类型 含义
userID String 用户 ID
  • 返回值:
类型 含义
List 用户所有的摄像头信息

打开用户的摄像头

  • 方法: openVideo(userID)

  • 参数:

参数 类型 含义
userID String 用户 ID
  • 返回值:
类型 含义
OpenVideoResult OpenVideoResult

关闭用户的摄像头

  • 方法: closeVideo(userID)

  • 参数:

参数 类型 含义
userID String 用户 ID
  • 返回值:无

获取摄像头参数

  • 方法: getVideoCfg()

  • 返回值:

类型 含义
VideoCfg VideoCfg

设置摄像头参数

  • 方法: setVideoCfg(cfg)

  • 参数:

参数 类型 含义
cfg VideoCfg VideoCfg
  • 返回值:无

获取指定用户的默认摄像头

  • 方法: getDefaultVideo(userID)

  • 参数:

参数 类型 含义
userID String 用户 ID
  • 返回值:
参数 类型 含义
deviceId int 默认摄像头 ID

设置默认的摄像头

  • 方法: setDefaultVideo(userID, deviceId)

  • 参数:

参数 类型 含义
userID String 用户 ID
deviceId int 默认摄像头 ID
  • 返回值:无

获取当前显示的用户

  • 方法: getUsrVideoId();

  • 参数:无

  • 返回值:

类型 含义
UsrVideoId 用户摄像头

设置观看的摄像头

  • 方法: setUsrVideoId(viewId, usrVideoId);

  • 参数:

参数 类型 含义
viewId int createView返回的容器 ID
usrVideoId UsrVideoId 用户摄像头
  • 返回值:无

获取视频效果配置

  • 方法: getVideoEffects();

  • 参数:无

  • 返回值:

类型 含义
VideoEffects VideoEffects

设置视频效果配置

  • 方法: setVideoEffects(VideoEffects videoEffects);

  • 参数:

参数 类型 含义
videoEffects VideoEffects 视频效果配置
  • 返回值: 无

创建自定义摄像头

  • 创建自定义摄像头(sdk 最大支持 5 个), 添加成功后与本地摄像头处理一致;getAllVideoInfo 接口可以识别摄像头类型

  • 方法: createCustomVideoDev();

  • 参数:

参数 类型 含义
camName String 摄像头名称
pixFmt VIDEO_FORMAT 图像格式
width int 图像宽度
height int 图像高度
extParams String 扩展参数,没有为空
  • 返回值:
类型 含义
int 返回值小于 0, 则代表创建失败, 返回值大于等于 0, 则代表摄像头 id

删除自定义摄像头

  • 方法: destroyCustomVideoDev(int videoID);

  • 参数:

参数 类型 含义
videoID int 摄像头 id (createCustomVideoDev 返回值)
  • 返回值: 无

输入摄像头图像数据

  • 方法: inputCustomVideoDat(int videoID, List data);

  • 参数:

参数 类型 含义
videoID int 摄像头 id (createCustomVideoDev 返回值)
data List 图像数据(请保证格式、和尺寸与摄像头匹配)
  • 返回值: 无

获取用户的摄像头状态

  • 方法: getVideoStatus(int userID);

  • 参数:

参数 类型 含义
userID int 用户 id
  • 返回值: 无
类型 含义
VSTATUS 摄像头状态

获取是否启用多摄像头

  • 方法: getEnableMutiVideo(int userID);

  • 参数:

参数 类型 含义
userID int 用户 id
  • 返回值:
类型 含义
bool 获取是否启用多摄像头

设置用户是否启用多摄像头

  • 方法: setEnableMutiVideo(String userID, bool isEnabled);

  • 参数:

参数 类型 含义
userID int 用户 id
isEnabled bool 是否启用多摄像头
  • 返回值:无

摄像头图像数据

  • 方法: getVideoImg(UsrVideoId usrVideoId, { VSize? size, VIDEO_FORMAT? fmt });

  • 参数:

参数 类型 含义
usrVideoId UsrVideoId 用户摄像头
size VSize 视频尺寸
pixFmt VIDEO_FORMAT 图像格式
  • 返回值:
类型 含义
VideoFrame 用户摄像头的最新图像

获取某个摄像头私有参数

  • 方法: getLocVideoAttributes(String videoID);

  • 参数:

参数 类型 含义
videoID String 摄像头 id
  • 返回值:
类型 含义
VideoAttributes 视频设备私有属性

设置某个摄像头私有参数

  • 方法: setLocVideoAttributes(String videoID, VideoAttributes videoAttributes);

  • 参数:

参数 类型 含义
videoID String 摄像头 id
videoAttributes VideoAttributes 视频设备私有属性
  • 返回值:无

通知摄像头状态变化

  • 订阅方法: onVideoStatusChanged(String userId, VSTATUS newStatus, VSTATUS oldStatus)

  • 接收参数:

参数 类型 含义
userId String 视频设备有变化的用户 ID
newStatus VSTATUS 摄像头状态
oldStatus VSTATUS 旧的摄像头状态

通知用户的视频设备有变化

  • 订阅方法: onVideoDevChanged(String userID)

  • 接收参数:

参数 类型 含义
userID String 视频设备有变化的用户 ID

通知用户的视频默认设备有变化

  • 订阅方法: onDefVideoChanged(String userID, int videoID)

  • 接收参数:

参数 类型 含义
userID String 视频设备有变化的用户 ID
videoID int 设备 id

获取麦克风音频参数

  • 方法: getAudioCfg()

  • 返回值:

类型 含义
AudioCfg AudioCfg

设置麦克风音频参数

  • 方法: setAudioCfg(cfg)

  • 参数:

参数 类型 含义
cfg AudioCfg AudioCfg
  • 返回值:无

获取用户的麦状态

  • 方法: getAudioStatus(userID)

  • 参数:

参数 类型 含义
userID String 用户 ID
  • 返回值:
类型 含义
ASTATUS ASTATUS

打开用户的麦克风

  • 方法: openMic(userID)

  • 参数:

参数 类型 含义
userID String 用户 ID
  • 返回值:无

关闭用户的麦克风

  • 方法: closeMic(userID)

  • 参数:

参数 类型 含义
userID String 用户 ID
  • 返回值:无

获取用户说话声音大小

  • 方法: getMicEnergy(userID)

  • 参数:

参数 类型 含义
userID String 用户 ID
  • 返回值:无

获取麦克风外放状态

  • 方法: getSpeakerOut()

  • 返回值:

类型 含义
bool 麦克风是否外放

设置麦克风外放状态

  • 方法: setSpeakerOut(isSpeakerOut)

  • 参数:

参数 类型 含义
isSpeakerOut bool 是否外放
  • 返回值:
类型 含义
bool 设置是否成功

获取本地扬声器音量

  • 方法: getSpeakerVolume()

  • 返回值:

类型 含义
int 本地扬声器音量 0 -255

设置本地扬声器音量

  • 方法: setSpeakerVolume(speakerVolume)

  • 参数:

参数 类型 含义
speakerVolume int 扬声器音量 0 - 255
  • 返回值:
类型 含义
bool 设置是否成功

获取播放是否静音

  • 方法: getSpeakerMute()

  • 返回值:

类型 含义
bool 播放是否静音

设置播放是否静音

  • 方法: setSpeakerMute()

  • 返回值:无

关闭所有人麦克风

  • 方法: setAllAudioClose()

  • 参数:无

  • 返回值:无

开始获取语音 pcm 数据

  • 方法: startGetAudioPCM(A_SIDE aSide, GET_PCM_TYPE type, GetAudioPCMParam param)

  • 参数:

参数 类型 含义
aSide A_SIDE 声道类型
type GET_PCM_TYPE 获取语音 pcm 类型
param GetAudioPCMParam 配置
  • 返回值:无

停止获取语音 pcm 数据

  • 方法: stopGetAudioPCM(A_SIDE aSide)

  • 参数:

参数 类型 含义
aSide A_SIDE 声道类型
  • 返回值:无

通知音频状态变化

  • 订阅方法: onAudioStatusChanged(String userId, ASTATUS newStatus, ASTATUS oldStatus)

  • 接收参数:

参数 类型 含义
userId String 用户 id
newStatus ASTATUS 音频状态
oldStatus ASTATUS 旧的音频状态

通知本地音频设备有变化

  • 订阅方法: onAudioDevChanged()

  • 接收参数:无

通知用户的说话声音强度更新

  • 订阅方法: onMicEnergyUpdate(MicEnergy micEnergy)

  • 接收参数:

参数 类型 含义
micEnergy MicEnergy MicEnergy

获取屏幕共享是否已开启

  • 方法: isScreenShareStarted()

  • 返回值:

类型 含义
bool 屏幕共享是否已开启

获取屏幕共享配置

  • 方法: getScreenShareCfg()

  • 返回值:

类型 含义
ScreenShareCfg 屏幕共享配置

设置屏幕共享配置

  • 方法: setScreenShareCfg(cfg)

  • 参数:

参数 类型 含义
cfg ScreenShareCfg 屏幕共享配置
  • 返回值:无

开始屏幕共享

  • 方法: startScreenShare()

  • 返回值:

类型 含义
int 错误码

停止屏幕共享

  • 方法: stopScreenShare()

  • 返回值:

类型 含义
int 错误码

通知开启屏幕共享

  • 订阅方法: notifyScreenShareStarted()

  • 参数:无

通知停止屏幕共享

  • 订阅方法: notifyScreenShareStopped()

  • 参数:无

通知开启屏幕共享标注

  • 订阅方法: notifyScreenMarkStarted()

  • 参数:无

通知停止屏幕共享标注

  • 订阅方法: notifyScreenMarkStopped()

  • 参数:无

创建视频、影音观看、共享组件 UIView容器

  • 方法: createView((viewId) {});

  • 参数:

参数 类型 含义
Function(viewId) Function 回调函数,返回容器 ID
  • 返回值:
类型 含义
Widget 影音组件容器

销毁UIView容器

  • 方法: destroyView(viewId);

  • 参数:

参数 类型 含义
viewId int createView返回的容器 ID

获取视频比例

  • 方法: getScaleType(viewId)

  • 参数:

参数 类型 含义
viewId int createView返回的容器 ID
  • 返回值
类型 含义
int 0:等比缩放留空居中显示;1:等比缩放裁剪铺满显示;2:不等比缩放铺满显示(可能导致图像拉伸)

设置视频比例

  • 方法: setScaleType(viewId, effect)

  • 参数:

参数 类型 含义
viewId int createView返回的容器 ID
effect int 0:等比缩放留空居中显示;1:等比缩放裁剪铺满显示;2:不等比缩放铺满显示(可能导致图像拉伸)

注:iOS 只支持 0 和 2,传 1 也是显示 2

  • 返回值 无

获取当前是否有图像

  • 方法: isPicEmpty(viewId)

  • 参数:

参数 类型 含义
viewId int createView返回的容器 ID
  • 返回值
类型 含义
bool 当前 UIView 是否有图像

获取当前显示图像

  • 方法: getShowPic(viewId)

  • 参数:

参数 类型 含义
viewId int createView返回的容器 ID
  • 返回值
类型 含义
Uint8List 当前 UIView 图像

获取当前图像帧的显示时间戳

  • 方法: getPicFrameTime(viewId)

  • 参数:

参数 类型 含义
viewId int createView返回的容器 ID
  • 返回值
类型 含义
int 当前 UIView 图像帧的显示时间戳

获取图片宽度

  • 方法: getPicWidth(viewId)

  • 参数:

参数 类型 含义
viewId int createView返回的容器 ID
  • 返回值
类型 含义
int 当前 UIView 图片宽

获取图片高度

  • 方法: getPicHeight(viewId)

  • 参数:

参数 类型 含义
viewId int createView返回的容器 ID
  • 返回值
类型 含义
int 当前 UIView 图片高

清空显示

  • 方法: clear(viewId)

  • 参数:

参数 类型 含义
viewId int createView返回的容器 ID
  • 返回值 无

创建本地混图器

  • 方法: createLocMixer(mixerID, mixerCfg, mixerCotentRects)

  • 参数:

参数 类型 含义
mixerID String 混图器 ID
mixerCfg MixerCfg 混图器规格配置
mixerCotentRects List 本地录制混图器内容配置
  • 返回值:
类型 含义
int 错误码

更新本地混图器内容

  • 方法: updateLocMixerContent(mixerID, mixerCotentRects)

  • 参数:

参数 类型 含义
mixerID String 混图器 ID
mixerCotentRects List 本地录制混图器内容配置
  • 返回值:
类型 含义
int 错误码

销毁本地混图器

  • 方法: destroyLocMixer(mixerID)

  • 参数:

参数 类型 含义
mixerID String 混图器 ID
  • 返回值:无

获取本地混图器状态

  • 方法: getLocMixerState(mixerID)

  • 参数:

参数 类型 含义
mixerID String 混图器 ID
  • 返回值:
类型 含义
MIXER_STATE MIXER_STATE

开启本地录制、开启直播推流

  • 方法: addLocMixerOutput(mixerID, mixerOutPutCfgs)

  • 参数:

参数 类型 含义
mixerID String 混图器 ID
mixerOutPutCfgs List 输出配置
  • 返回值:
类型 含义
int 错误码

本地录制文件、本地直播信息通知

  • 订阅方法: onLocMixerOutputInfo(String mixerID, String nameOrUrl, MixerOutputInfo mixerOutputInfo)

  • 接收参数:

参数 类型 含义
locMixerOutputInfo MixerOutputInfo MixerOutputInfo

本地混图器状态变化通知

  • 订阅方法:onLocMixerStateChanged(LocMixerState locMixerState)

  • 接收参数:

参数 类型 含义
locMixerState LocMixerState LocMixerState

通知录制文件状态更改

  • 订阅方法:onNotifyRecordFileStateChanged(String fileName, int state)

  • 接收参数

参数 类型 含义
fileName String 本地文件路径
state RECORD_FILE_STATE 状态

通知录制文件上传成功

  • 订阅方法:uploadRecordFileSuccess(String fileName, String fileUrl)

  • 接收参数:

参数 类型 含义
fileName String 本地文件路径
fileUrl String 服务端录制文件地址

开始云端录制、云端直播

  • 方法: createCloudMixer(cloudMixerCfg)

  • 参数:

参数 类型 含义
cloudMixerCfg List 混图器配置
  • 返回值:
类型 含义
String 混图器 ID

更新云端录制、云端直播内容

  • 方法: updateCloudMixerContent(mixerID, cloudMixerCfg)

  • 参数:

参数 类型 含义
mixerID String 混图器 ID
cloudMixerCfg List 混图器配置
  • 返回值:
类型 含义
int 错误码

停止云端录制、云端直播

  • 方法: destroyCloudMixer()

  • 参数:

参数 类型 含义
mixerID String 混图器 ID
  • 返回值:无

获取云端录制、云端直播状态

  • 方法: getCloudMixerInfo(mixerID)

  • 参数:

参数 类型 含义
mixerID String 混图器 ID
  • 返回值:
类型 含义
CloudMixerInfo CloudMixerInfo

获取所有云端录制、云端直播状态

  • 方法: getAllCloudMixerInfo()

  • 参数:无

  • 返回值:

类型 含义
List CloudMixerInfo

启动云端录制、云端直播失败通知

  • 订阅方法: onCreateCloudMixerFailed(String mixerID, int sdkErr)

  • 接收参数:

参数 类型 含义
mixerID String 混图器 ID
sdkErr int 错误码

云端录制、云端直播状态变化通知

  • 订阅方法: onCloudMixerStateChanged(String mixerID, String operatorID, MIXER_STATE state, String exParam)

  • 接收参数:

参数 类型 含义
mixerID String 混图器 ID
operatorID String 操作人 id
state MIXER_STATE 混图器状态
exParam String 拓展参数

云端录制、云端直播配置变化通知

  • 订阅方法: onCloudMixerInfoChanged(MString mixerID)

  • 接收参数:

参数 类型 含义
mixerID String 混图器 ID

云端录制文件、云端直播信息变化通知

  • 订阅方法: onCloudMixerOutputInfoChanged(String mixerID, CloudMixerOutputInfo cloudMixerOutputInfo)

  • 接收参数:

参数 类型 含义
mixerID String 混图器 ID
cloudMixerOutputInfo MixerOutputInfo MixerOutputInfo

获取影音共享图像质量参数

  • 方法: getMediaCfg()

  • 参数:无

  • 返回值:

类型 含义
VideoCfg VideoCfg

配置远程影音共享时,图像质量参数

  • 方法: setMediaCfg(cfg)

  • 参数:

参数 类型 含义
cfg VideoCfg VideoCfg
  • 返回值:无

播放影音文件

  • 方法: startPlayMedia(src, bLocPlay)

  • 参数:

参数 类型 含义
src String 资源地址
bLocPlay bool 如果不需要远端需要观看配合 bLocPlay 为 true(选填,默认 false)
  • 返回值:无

暂停播放影音

  • 方法: pausePlayMedia(pause)

  • 参数:

参数 类型 含义
pause bool 是否暂停播放
  • 返回值:

停止影音播放

  • 方法: stopPlayMedia()

  • 参数:无

  • 返回值:无

设置播放进度

  • 方法: setMediaPlayPos(pos)

  • 参数:

参数 类型 含义
pos int 设置播放位置,单位:毫秒
  • 返回值:

取得影音文件信息

  • 方法: getMediaInfo()

  • 参数:无

  • 返回值:

类型 含义
MediaInfo MediaInfo

通知影音文件打开

  • 订阅方法: onNotifyMediaOpened(MediaFileInfo mediaFileInfo)

  • 订阅参数:

参数 类型 含义
mediaFileInfo MediaFileInfo MediaFileInfo

通知影音开始播放

  • 订阅方法: onNotifyMediaStart(String userID)

  • 订阅参数:

参数 类型 含义
userID String 操作者的用户 id

通知影音是否暂停播放

  • 订阅方法: onNotifyMediaPause(String userID, bool pause)

  • 订阅参数:

参数 类型 含义
userID String 操作者的用户 id
pause bool 是否暂停播放

通知影音播放停止

  • 订阅方法: onNotifyMediaStop(String userID, MEDIA_STOP_REASON reason)

  • 订阅参数:

参数 类型 含义
userID String 操作者的用户 id
reason MEDIA_STOP_REASON 影音结束原因

发起呼叫

  • 方法: call(
    String calledUserID,
    MeetInfo meetInfo, {
    String? usrExtDat,
    String? cookie,
    })

  • 参数:

参数 类型 含义
calledUserID String 被叫用户的账户 ID
meetInfo MeetInfo 房间信息,空时代表无房间信息,应由被叫创建或提供房间信息
usrExtDat String 自定义扩展参数
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
CallResult 呼叫结果

接受对方发起的呼叫

  • 方法: acceptCall()

  • 参数:

参数 类型 含义
callID String 呼叫标识码
meetInfo MeetInfo 房间信息,空时代表无房间信息,应由被叫创建或提供房间信息
usrExtDat String 自定义扩展参数
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
CallResult 呼叫结果

拒绝对方发起的呼叫

  • 方法: rejectCall()

  • 参数:

参数 类型 含义
callID String 呼叫标识码
usrExtDat String 自定义扩展参数
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
CallResult 呼叫结果

挂断正在进行的视频呼叫或视频通话

  • 方法: hangupCall()

  • 参数:

参数 类型 含义
callID String 呼叫标识码
usrExtDat String 自定义扩展参数
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
    类型 含义
    CallResult 呼叫结果

通知有人呼入

  • 订阅方法: onNotifyCallIn(String callID, String confID, String callerID, String usrExtDat)

  • 接收参数:

参数 类型 含义
callID String 呼叫标识码
confID String 房间号
callerID String 呼叫人员的标识 ID
usrExtDat String 自定义扩展参数

通知呼叫被对方接受

  • 订阅方法: onNotifyCallAccepted(String callID, String confID, String usrExtDat)

  • 接收参数:

参数 类型 含义
callID String 呼叫标识码
confID String 房间号
usrExtDat String 自定义扩展参数

通知呼叫被对方拒绝

  • 订阅方法: onNotifyCallRejected(String callID, int sdkErr, String usrExtDat)

  • 接收参数:

参数 类型 含义
callID String 呼叫标识码
sdkErr int 错误码
usrExtDat String 自定义扩展参数

通知呼叫被对方挂断

  • 订阅方法: onNotifyCallHangup(String callID, String usrExtDat)

  • 接收参数:

参数 类型 含义
callID String 呼叫标识码
usrExtDat String 自定义扩展参数

发送呼叫

  • 方法: invite(String inviteeUserID, {
    String? usrExtDat,
    String? cookie,
    })

  • 参数:

参数 类型 含义
inviteeUserID String 用户 ID
usrExtDat String 自定义扩展参数
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
InviteResult 邀请结果

接受对方发送的呼叫

  • 方法: acceptInvite(
    String inviteID, {
    String? usrExtDat,
    String? cookie,
    })

  • 参数:

参数 类型 含义
inviteID String 邀请 ID
usrExtDat String 自定义扩展参数
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
InviteResult 邀请结果

拒绝对方发送的邀请

  • 方法: rejectInvite(
    String inviteID, {
    String? usrExtDat,
    String? cookie,
    })

  • 参数:

参数 类型 含义
inviteID String 邀请 ID
usrExtDat String 自定义扩展参数
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
InviteResult 邀请结果

取消邀请

  • 方法: cancelInvite(
    String inviteID, {
    String? usrExtDat,
    String? cookie,
    })

  • 参数:

参数 类型 含义
inviteID String 邀请 ID
usrExtDat String 自定义扩展参数
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
InviteResult 邀请结果

通知有人邀请

  • 订阅方法: onNotifyInviteIn(String inviteID, String inviterUsrID, String usrExtDat)

  • 接收参数:

参数 类型 含义
inviteID String 邀请 ID
inviterUsrID String 邀请者用户 ID
usrExtDat String 自定义扩展参数

通知邀请被接受

  • 订阅方法: onNotifyInviteAccepted(String inviteID, String usrExtDat)

  • 接收参数:

参数 类型 含义
inviteID String 邀请 ID
usrExtDat String 自定义扩展参数

通知邀请被对方拒绝

  • 订阅方法: onNotifyInviteRejected(String inviteID, String usrExtDat, int sdkErr)

  • 接收参数:

参数 类型 含义
inviteID String 邀请 ID
usrExtDat String 自定义扩展参数
sdkErr int 错误码

通知邀请被取消

  • 订阅方法: onNotifyInviteCanceled(String inviteID, String usrExtDat, int sdkErr)

  • 接收参数:

参数 类型 含义
inviteID String 邀请 ID
usrExtDat String 自定义扩展参数
sdkErr int 错误码

发送小块数据

  • 方法: sendCmd(String targetUserId, String data)

  • 参数:

参数 类型 含义
targetUserId String 目标用户 ID
data String 发送的数据,base64 编码
  • 返回值:
类型 含义
SendResult 发送结果

发送大块数据

  • 方法: sendBuffer(String targetUserId, String data)

  • 参数:

参数 类型 含义
targetUserId String 目标用户 ID
data String 发送的数据,base64 编码

发送文件

  • 方法: sendFile(String targetUserId, String fileName)

  • 参数:

参数 类型 含义
targetUserId String 目标用户 ID
fileName String 需要发送的文件名
  • 返回值:
类型 含义
SendResult 发送结果

取消数据发送

  • 方法: cancelSend(String taskId)

  • 参数:

参数 类型 含义
taskId String 任务 ID (从SendResult获取)
  • 返回值:
类型 含义
SendResult 发送结果

发送数据时,通知发送进度

  • 订阅方法: onSendProgress(String taskId, int sendedLen, int totalLen, String? cookie)

  • 接收参数:

参数 类型 含义
taskId String 任务 ID

通知收到小块数据

  • 订阅方法: onNotifyCmdData(String sourceUserId, String data)

  • 接收参数:

参数 类型 含义
sourceUserId String 数据来源
data String 数组数据

通知收到大块数据

  • 订阅方法: onNotifyBufferData(String sourceUserId, String data)

  • 接收参数:

参数 类型 含义
sourceUserId String 数据来源
data String 数组数据

通知收到文件数据

  • 订阅方法: onNotifyFileData(String sourceUserId, String tmpFile, String orgFileName)

  • 接收参数:

参数 类型 含义
sourceUserId String 数据来源
tmpFile String 临时文件,不需要时,请移除或删除对应文件
orgFileName String 源文件名

通知取消发送

  • 订阅方法: onNotifyCancelSend(String taskId)

  • 接收参数:

参数 类型 含义
taskId String 任务 ID

初始化队列

  • 方法: initQueue({ String? cookie })

  • 参数:

参数 类型 含义
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
CommonResult 初始化结果
注意:

在响应回调 initQueueDatRslt 初始化成功后,才可获取队列队列相关信息

刷新所有队列状态

  • 方法: refreshAllQueueStatus({ String? cookie })

  • 参数:

参数 类型 含义
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
CommonResult 初始化结果

查询队列

  • 方法: getAllQueueInfo({ String? cookie })

  • 参数:

参数 类型 含义
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
List<QueueInfo> 排队信息

获取队列状态

  • 方法: getQueueStatus(int queID)

  • 参数:

参数 类型 含义
queID int 服务的队列
  • 返回值:
类型 含义
QueueStatus 队列状态

获取我的排队信息

  • 方法: getQueuingInfo()

  • 参数:无

  • 返回值:

类型 含义
QueuingInfo 队列信息

获取我服务的所有队列

  • 方法: getServiceQueues()

  • 参数:无

  • 返回值:

类型 含义
List 队列 ID 列表

获取我的会话信息

  • 方法: getSessionInfo()

  • 参数:无

  • 返回值:

类型 含义
VideoSessionInfo 会话信息

开始排队

  • 方法: startQueuing(
    int queID, {
    String usrExtDat,
    String cookie,
    })

  • 参数:

参数 类型 含义
queID int 队列 ID
usrExtDat String 自定义扩展参数
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
CommonResult 停止排队结果

停止排队

  • 方法: stopQueuing({
    String cookie,
    })

  • 参数:

参数 类型 含义
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
CommonResult 停止排队结果

开始服务队列

  • 方法: startService(int queID, {
    int priority = 0,
    String cookie,
    })

  • 参数:

参数 类型 含义
queID int 队列 ID
priority int 座席优先级(缺省为 0, 0 为最高优先级, 值越大优先级越低)
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
QueueResult 服务队列操作结果
注意:

如果没有开启免打扰,那么系统会自动分配客户:将收到事件 autoAssignUser

如果开启免打扰,系统就不会分配客户,如需服务客户可调用 reqAssignUser

座席优先级描述

座席优先级只在服务的队列内部有效;
客户优先分配给服务此队列优先级最高的,且空闲的座席;
优先级相同时,则分配给最先空闲的座席;
优先级高的座席变空闲时,不抢夺已分配的客户;

停止服务队列

  • 方法: stopService(int queID, {
    String cookie,
    })

  • 参数:

参数 类型 含义
queID int 队列 ID
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
QueueResult 服务队列操作结果

请求分配一个指定的客户

  • 方法: reqAssignUser({
    String cookie,
    })

  • 参数:

参数 类型 含义
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
QueueUserInfoResult 分配用户结果
注意:

当关闭免打扰时,系统将自动分配客户,无需调用此函数

当开启免打扰时,系统不再自动分配客户,座席如需服务客户可使用此函数分配

接受系统安排的客户

  • 方法: acceptAssignUser(int queID, String userID, {
    String cookie,
    })

  • 参数:

参数 类型 含义
queID int 队列 ID
userID String 用户 ID
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
CommonResult 分配用户结果

拒绝系统安排的客户

  • 方法: rejectAssignUser(int queID, String userID, {
    String cookie,
    })

  • 参数:

参数 类型 含义
queID int 队列 ID
userID String 用户 ID
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
CommonResult 分配用户结果

队列状态变化通知

  • 订阅方法: onQueueStatusChanged(QueueStatus queueStatus)

  • 接收参数:

参数 类型 含义
queueStatus QueueStatus 队列状态

排队信息变化通知

  • 订阅方法: onQueuingInfoChanged(QueuingInfo queuingInfo)

  • 接收参数:

参数 类型 含义
queuingInfo QueuingInfo 排队信息

自动分配用户通知

  • 订阅方法: onAutoAssignUser(QueueUserInfo userInfo)

  • 接收参数:

参数 类型 含义
userInfo QueueUserInfo 请求到的队列用户

分配用户被取消通知

  • 订阅方法: onCancelAssignUser(int queID, String userID)

  • 接收参数:

参数 类型 含义
queID int 服务的队列
userID String 自动分配用户被取消

获取房间所有属性

  • 方法: getMeetingAllAttrs({ String? cookie })

  • 参数:

参数 类型 含义
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
MeetingAttrResult 房间属性

获取房间部分属性

  • 方法: getMeetingAttrs(List keys,
    {String cookie = ''})

  • 参数:

参数 类型 含义
keys List 属性 Key
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
MeetingAttrResult 房间属性

设置房间信息

  • 方法: setMeetingAttrs(Map<String, String> attrs, Map<String, Object> options, { String? cookie })

  • 参数:

    参数 类型 含义
    attrs Map<String, String> 属性 Key
    options Map<String, Object> 操作选项,json 格式参见MeetingAttrOptions
    cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:

类型 含义
CommonResult 操作结果

增加或者更新房间属性

  • 方法: addOrUpdateMeetingAttrs(Map<String, String> attrs, Map<String, Object> options, { String? cookie })

  • 参数:

    参数 类型 含义
    attrs Map<String, String> 属性 Key
    options Map<String, Object> 操作选项,json 格式参见MeetingAttrOptions
    cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:

类型 含义
CommonResult 操作结果

删除特定房间属性

  • 方法: delMeetingAttrs(List keys, Map<String, Object> options,
    {String cookie = ''})

  • 参数:

参数 类型 含义
keys List 将要获取的属性 key 列表(空串代表获取全部),json 格式,如:["key1","key2"]
options Map<String, Object> 操作选项,json 格式参见MeetingAttrOptions
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
CommonResult 操作结果

清除房间属性

  • 方法: clearMeetingAttrs(Map<String, Object> options, { String? cookie })

  • 参数:

    参数 类型 含义
    options Map<String, Object> 操作选项,json 格式参见MeetingAttrOptions
    cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:

类型 含义
CommonResult 房间属性

获取用户属性

  • 方法: getUserAttrs(String userIDs, String keys, { String? cookie })

  • 参数:

参数 类型 含义
uids List 目标用户 id 列表,一次最多包含 50 个用户,json 格式, 如:["userID1","userID2"]
keys List 将要获取的属性 key 列表(空串代表获取全部),json 格式,如:["key1","key2"]
cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:
类型 含义
MeetingAttrResult 房间属性

设置用户属性

  • 方法: setUserAttrs(String uid, Map<String, String> attrs, Map<String, Object> options, { String? cookie })

  • 参数:

    参数 类型 含义
    uid String 目标用户 id
    attrs Map<String, String> 用户属性集, json 格式,如:{"key1":"value1", "key2":"value2"} (key 最大长度为 64B,value 最大长度为 8KB)
    options Map<String, Object> 操作选项,json 格式参见MeetingAttrOptions
    cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:

类型 含义
CommonResult 操作结果

增加或更新用户属性

  • 方法: addOrUpdateUserAttrs(String uid, Map<String, String> attrs, Map<String, Object> options, { String? cookie })

  • 参数:

    参数 类型 含义
    uid String 目标用户 id
    attrs Map<String, String> 用户属性集, json 格式,如:{"key1":"value1", "key2":"value2"} (key 最大长度为 64B,value 最大长度为 8KB)
    options Map<String, Object> 操作选项,json 格式参见MeetingAttrOptions
    cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:

类型 含义
CommonResult 操作结果

删除特定用户的特定属性

  • 方法: delUserAttrs(String uid, List keys, Map<String, Object> options, { String? cookie })

  • 参数:

    参数 类型 含义
    uid String 目标用户 id
    keys Map<String, String> 用户属性集, json 格式,如:{"key1":"value1", "key2":"value2"} (key 最大长度为 64B,value 最大长度为 8KB)
    options Map<String, Object> 操作选项,json 格式参见MeetingAttrOptions
    cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:

类型 含义
CommonResult 操作结果

清除特定用户的所有属性

  • 方法: clearUserAttrs(String uid, Map<String, Object> options, {String cookie = ''})

  • 参数:

    参数 类型 含义
    uid String 目标用户 id
    options Map<String, Object> 操作选项,json 格式参见MeetingAttrOptions
    cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:

类型 含义
CommonResult 操作结果

清除所有用户的属性

  • 方法: clearAllUserAttrs(Map<String, Object> options, {String cookie = ''})

  • 参数:

    参数 类型 含义
    options Map<String, Object> 操作选项,json 格式参见MeetingAttrOptions
    cookie String 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 返回值:

类型 含义
CommonResult 操作结果

房间属性发生改变

  • 订阅方法: onNotifyMeetingAttrsChanged(Map<String, dynamic> add, Map<String, dynamic> updates,
    List delKeys)

  • 接收参数:

参数 类型 含义
add Map<String, MeetingAttr> 增加房间属性集
updates Map<String, MeetingAttr> 变化的房间属性集
delKeys List 被删除的房间属性列表

用户属性发生改变

  • 订阅方法: onNotifyUserAttrsChanged(String uid, Map<String, dynamic> add, Map<String, dynamic> updates,
    List delKeys)

  • 接收参数:

参数 类型 含义
userID String 变化的用户id
add Map<String, MeetingAttr> 增加的用户属性集
updates Map<String, MeetingAttr> 变化的用户属性集
delKeys List 被删除的用户属性列表