音视频通话

API参考

基础组件(RTCSDK)

RTCSDK 是基础控件,负责整个SDK的初始化和反初始化操作。整个程序的生命过程中只能有一个实例


getRTCSDKVer

+ (NSString *)getRTCSDKVer

  • 功能: 获取sdk的版本信息

  • 返回值: 返回SDK版本号

initSDK:

- (CRVIDEOSDK_ERR_DEF)initSDK:(SdkInitDat *)dat

  • 功能: SDK初始化

  • 返回值: CRVIDEOSDK_NOERR为成功操作,其他详见定义CRVIDEOSDK_ERR_DEF

参数 类型 含义
dat SdkInitDat dat SDK配置、临时文件存放位置,不可为空,详见说明SdkInitDat

uninit

- (void)uninit

  • 功能: SDK反初始化

  • 返回值: 无

serverAddr

- (NSString *)serverAddr

  • 功能: 获取服务器地址

  • 返回值: 服务器地址

setServerAddr:

- (void)setServerAddr:(NSString *)serverList

  • 功能: 设置服务器地址

  • 返回值: 无

参数 类型 含义
serverList NSString 服务器地址,如10.8.8.122:2726

isInitSuccess

- (BOOL)isInitSuccess

  • 功能: 初始化是否成功

  • 返回值: 初始化是否成功

writeLog:message:

- (void)writeLog:(SDK_LOG_LEVEL)level message:(NSString *)log

  • 功能: 写日志

  • 返回值: 无

参数 类型 含义
level SDK_LOG_LEVEL 日志等级
log NSString 日志内容(长度超过2K时,将被截断)

房间组件(RTCMgr)

房间组件(RTCMgr)

RTCMgr 是房间组件,实现登录、呼叫、房间创建销毁、透明通道传输等功能。 整个程序的生命过程中只能有一个实例。


setMgrCallback:

- (void)setMgrCallback:(id<RTCMgrCallBack>)callBack

  • 功能: 注册监听回调

  • 返回值: 无

参数 类型 含义
callBack id 回调对象

removeMgrCallback:

- (void)removeMgrCallback:(id<RTCMgrCallBack>)callBack

  • 功能: 反注册监听回调

  • 返回值: 无

参数 类型 含义
callBack id 回调对象

login:

- (void)login:(LoginDat *)loginDat

  • 功能: 登陆服务器

  • 返回值: 无

登录成功则触发回调loginSuccess , 登录失败则触发回调loginFail

参数 类型 含义
loginDat LoginDat 登录数据对象,详见定义LoginDat

login:cookie:

- (void)login:(LoginDat *)loginDat cookie:(NSString *)cookie

  • 功能: 密码登陆服务器

  • 返回值: 无

登录成功则触发回调loginSuccess , 登录失败则触发回调loginFail

参数 类型 含义
loginDat LoginDat 登录数据对象,详见定义LoginDat
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

loginByToken:userID:userAuthCode:cookie:

- (void)loginByToken:(NSString*)token userID:(NSString*)userID userAuthCode:(NSString*)userAuthCode cookie:(NSString *)cookie

  • 功能: token登陆服务器

  • 返回值: 无

成功则触发回调loginSuccess , 登录失败则触发回调loginFail

参数 类型 含义
token NSString token鉴权码
userID NSString 用户ID,业务方自由填写,保证唯一性即可(同一app下,具有唯一性即可)
userAuthCode NSString 默认填空,只有开启第三方认证才需要填写,(开启第三方认证时,SDK服务器将连接提前配好的业务方服务器进行实时验证)
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

updateToken:

- (void)updateToken:(NSString*)token

  • 功能: 更新Token

  • 返回值: 无

参数 类型 含义
token NSString token鉴权码

logout

- (void)logout

  • 功能: 反注册本次登陆

  • 返回值: 无

setDNDStatus:cookie:

- (void)setDNDStatus:(int)DNDStatus cookie:(NSString *)cookie

  • 功能: 设置免打扰状态, 如果使用到了SDK的队列功能,则进入房间后需调用此接口,设置自己的为免打扰状态,防止系统再次推送自己

  • 返回值: 无

设置免打扰状态成功则触发回调setDNDStatusSuccess , 设置免打扰状态失败则触发回调setDNDStatusFail

参数 类型 含义
DNDStatus int 0代表关闭免打扰, 其它值代表开启免打扰,含义自由定义
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

getUserStatus:cookie:

- (void)getUserStatus:(NSString *)userID cookie:(NSString *)cookie

  • 功能: 获取企业下指定用户的在线状态

  • 返回值: 无

回调函数getUserStatusRsp

参数 类型 含义
userID NSString 具体用户的账户ID
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

getUserStatus:

- (void)getUserStatus:(NSString *)cookie

  • 功能: 将获取企业下所有用户在线状态(包括呼叫房间状态、免打扰状态)

  • 返回值: 无

回调函数getUserStatusRsp

参数 类型 含义
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

startUserStatusNotify:

- (void)startUserStatusNotify:(NSString *)cookie

  • 功能: 开启用户的状态推送 。开启后,企业下所有用户状态有变化时(包括呼叫房间状态、免打扰状态),都会收到通知。开启后,用户量越大消息量越大,所以请按需开启。

  • 返回值: 无

回调函数startStatusPushRsp

参数 类型 含义
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

stopUserStatusNotify:

- (void)stopUserStatusNotify:(NSString *)cookie

  • 功能: 关闭用户的状态推送

  • 返回值: 无

回调函数stopStatusPushRsp

参数 类型 含义
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

createMeeting:

- (void)createMeeting:(NSString *)cookie

  • 功能: 创建视频房间

  • 返回值: 无

创建房间成功则触发回调createMeetingSuccess,创建房间失败则触发createMeetingFail

参数 类型 含义
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

destroyMeeting:cookie:

- (void)destroyMeeting:(int)meetID cookie:(NSString *)cookie

  • 功能: 销毁视频房间

  • 返回值: 无

回调函数destroyMeetingRslt

参数 类型 含义
meetID int 房间号
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

call:meetInfo:param:cookie:

- (NSString *)call:(NSString *)calledUserID meetInfo:(MeetInfo *)meetInfo param:(NSString *)param cookie:(NSString *)cookie

  • 功能: 发起呼叫,邀请用户参加视频会话, 呼叫时,对方迟迟不响应,30秒后系统自动结束呼叫

  • 返回值: 本次呼叫标识码(呼叫ID)

发起呼叫成功则触发回调callSuccess,发起呼叫失败则触发callFail

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

acceptCall:meetInfo:usrExtDat:cookie:

- (void)acceptCall:(NSString *)callID meetInfo:(MeetInfo *)meetInfo usrExtDat:(NSString *)usrExtDat cookie:(NSString *)cookie

  • 功能: 接受对方发起的视频请求,开始进入视频会话

  • 返回值: 无

接受对方发起的视频请求成功则触发回调acceptCallSuccess,接受对方发起的视频请求失败则触发acceptCallFail

参数 类型 含义
callID NSString 呼叫标识码
meetInfo MeetInfo 房间信息,详见定义MeetInfo
usrExtDat NSString 自定义扩展参数
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

rejectCall:usrExtDat:cookie:

- (void)rejectCall:(NSString *)callID usrExtDat:(NSString *)usrExtDat cookie:(NSString *)cookie

  • 功能: 拒绝对方的视频请求

  • 返回值: 无

拒绝对方发起的视频请求成功则触发回调rejectCallSuccess,拒绝对方发起的视频请求失败则触发rejectCallFail

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

hangupCall:usrExtDat:cookie:

- (void)hangupCall:(NSString *)callID usrExtDat:(NSString *)usrExtDat cookie:(NSString *)cookie

  • 功能: 挂断正在进行的视频呼叫或视频通话

  • 返回值: 无

挂断视频成功则触发回调hangupCallSuccess,挂断视频失败则触发hangupCallFail

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

callMoreParty:meetInfo:usrExtDat:cookie:

- (NSString *)callMoreParty:(NSString *)calledID meetInfo:(MeetInfo *)meetInfo usrExtDat:(NSString *)usrExtDat cookie:(NSString *)cookie

  • 功能: 呼叫其他人进入房间

  • 返回值: 呼叫邀请ID

回调函数callMorePartyRslt

参数 类型 含义
calledUserID NSString 被呼叫的用户ID
meetInfo MeetInfo 房间信息,详见定义MeetInfo
usrExtDat NSString 自定义扩展参数
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

cancelCallMoreParty:usrExtDat:cookie:

- (void)cancelCallMoreParty:(NSString *)inviteID usrExtDat:(NSString *)usrExtDat cookie:(NSString *)cookie

  • 功能: 取消呼叫他人进入房间

  • 返回值: 无

回调函数cancelCallMorePartyRslt

参数 类型 含义
inviteID NSString 呼叫邀请ID
usrExtDat NSString 自定义扩展参数
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

sendCmd:data:cookie:

- (NSString *)sendCmd:(NSString *)targetUserId data:(NSString *)data cookie:(NSString *)cookie

  • 功能: 发送小块数据(50K以内),此接口不能被cancelSend, 一次性发送,不会有进度通知

  • 返回值: 分配的任务ID

回调函数sendCmdRlst

参数 类型 含义
targetUserId NSString 目标用户ID
data NSString 发送的数据
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

sendBuffer:data:cookie:

- (NSString *)sendBuffer:(NSString *)targetUserId data:(NSString *)data cookie:(NSString *)cookie

  • 功能: 发送大块数据 ,分块发送,进度通知事件sendProgress, 调用cancelSend 取消发送

  • 返回值: 分配的任务ID

回调函数sendBufferRlst

参数 类型 含义
targetUserId NSString 目标用户ID
data NSString 发送的数据,base64编码
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

sendFile:fileName:cookie:

- (NSString *)sendFile:(NSString *)targetUserId fileName:(NSString *)fileName cookie:(NSString *)cookie

  • 功能: 发送文件 ,分块发送,进度通知事件sendProgress,调用cancelSend取消发送

  • 返回值: 分配的任务ID

回调函数sendFileRlst

参数 类型 含义
targetUserId NSString 目标用户ID
fileName NSString 需要发送的文件名
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

cancelSend:

- (void)cancelSend:(NSString *)sendId

  • 功能: 取消数据发送

  • 返回值: 无

回调函数cancelSendRlst

参数 类型 含义
taskID NSString 任务ID

setMarkText:timestamp:markText:

- (void)setMarkText:(NSString*)videoFilePathName timestamp:(int)timestamp markText:(NSString*)markText

  • 功能: 添加视频打点信息

  • 返回值: 无

参数 类型 含义
videoFilePathName NSString 视频文件全路径
timestamp NSString 时间戳
markText NSString 打点信息

removeMarkText:timestamp:

- (void)removeMarkText:(NSString*)videoFilePathName timestamp:(int)timestamp

  • 功能: 移除视频打点信息

  • 返回值: 无

参数 类型 含义
videoFilePathName NSString 视频文件全路径
timestamp NSString 时间戳

getAllMarks:

- (NSString*)getAllMarks:(NSString*)videoFilePathName

  • 功能: 获取所有打点信息

  • 返回值: 打点信息

参数 类型 含义
videoFilePathName NSString 视频文件全路径

getMarkFile:

- (NSString*)getMarkFile:(NSString*)videoFilePathName

  • 功能: 获取打点文件的绝对文件路径名

  • 返回值: 打点文件的绝对文件路径名

参数 类型 含义
videoFilePathName NSString 视频文件全路径

invite:usrExtDat:cookie:

- (NSString*)invite:(NSString*)invitedUserID usrExtDat:(NSString*)usrExtDat cookie:(NSString*)cookie

  • 功能:发送邀请

  • 返回值:返回inviteID(每个邀请对应的唯一ID)

  • 参数:
参数 类型 含义
inviteeUserID NSString 受邀者用户ID
usrExtDat NSString 用户扩展数据
cookie NSString 详细介绍见关键词
  • 补充说明:

如果邀请监控设备进入房间, usrExtDat必须为:
{"meeting":{"ID":会议号}, "devInfo":{"userID":"会议中用户ID", "nickName":"会议中用户昵称"}};

acceptInvite:usrExtDat:cookie:

- (void)acceptInvite:(NSString*)inviteID usrExtDat:(NSString*)usrExtDat cookie:(NSString*)cookie

  • 功能:接受对方的邀请
  • 参数:
参数 类型 含义
inviteID NSString 邀请ID
usrExtDat NSString 用户扩展数据
cookie NSString 详细介绍见关键词

rejectInvite:usrExtDat:cookie:

- (void)rejectInvite:(NSString*)inviteID usrExtDat:(NSString*)usrExtDat cookie:(NSString*)cookie

  • 功能:拒绝对方的邀请
  • 参数:
参数 类型 含义
inviteID NSString 邀请ID
usrExtDat NSString 用户扩展数据
cookie NSString 详细介绍见关键词

cancelInvite:usrExtDat:cookie:

- (void)cancelInvite:(NSString*)inviteID usrExtDat:(NSString*)usrExtDat cookie:(NSString*)cookie

  • 功能:取消自己发送的邀请
  • 参数:
参数 类型 含义
inviteID NSString 邀请ID
usrExtDat NSString 用户扩展数据
cookie NSString 详细介绍见关键词

通知回调函数

RTCMgrCallback是登录、呼叫、房间创建销毁、透明传输等功能的回调接口


loginSuccess:cookie:

- (void)loginSuccess:(NSString *)usrID cookie:(NSString *)cookie

  • 功能: 登录成功响应

  • 返回值: 无

参数 类型 含义
usrID NSString 用户账户
cookie NSString 自定义用户数据

loginFail:cookie:

- (void)loginFail:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 登录失败响应

  • 返回值: 无

如果启用了第三方鉴权,并在鉴权失败时(sdkErr为CRVIDEOSDK_CUSTOMAUTH_FAILED),可以通过getUserAuthErrCode、getUserAuthErrDesc获取详细原因。

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义用户数据

getUserAuthErrCode

- (int)getUserAuthErrCode

  • 功能: 获取第三方认证错误码

  • 返回值: 错误码

getUserAuthErrDesc

- (NSString*)getUserAuthErrDesc

  • 功能: 获取第三方认证错误描述

  • 返回值: 错误描述

setDNDStatusSuccess:

- (void)setDNDStatusSuccess:(NSString *)cookie

  • 功能: 客户端设置免打扰状态操作成功响应

  • 返回值: 无

参数 类型 含义
cookie NSString 自定义用户数据

setDNDStatusFail:cookie:

- (void)setDNDStatusFail:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 客户端设置免打扰状态操作失败响应

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义用户数据

getUserStatusRsp:userStatus:cookie:

- (void)getUserStatusRsp:(CRVIDEOSDK_ERR_DEF)sdkErr userStatus:(NSArray<UserStatus *> *)userStatus cookie:(NSString *)cookie

  • 功能: 获取企业内所有用户在线状态响应

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,详见定义CRVIDEOSDK_ERR_DEF
usersStatus ArrayList 用户在线状态信息列表, 详见json结构之UserStatus
cookie NSString 自定义用户数据

startStatusPushRsp:cookie:

- (void)startStatusPushRsp:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 启动用户状态推送响应

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义用户数据

stopStatusPushRsp:cookie:

- (void)stopStatusPushRsp:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 结束用户状态推送响应

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义用户数据

notifyUserStatus:

void notifyUserStatus(UserStatus userStatus)

  • 功能: 某个用户状态变化通知

  • 返回值: 无

参数 类型 含义
userStatus UserStatus 单个用户在线状态信息,详见定义UserStatus

lineOff:

- (void)lineOff:(CRVIDEOSDK_ERR_DEF)sdkErr

  • 功能: SDK通知自己掉线

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 掉线的错误代码,详见定义CRVIDEOSDK_ERR_DEF

createMeetingSuccess:cookie:

- (void)createMeetingSuccess:(MeetInfo *)meetInfo cookie:(NSString *)cookie

  • 功能: 创建房间成功响应

  • 返回值: 无

参数 类型 含义
meetInfo MeetInfo 房间信息, 详见定义MeetInfo
cookie NSString 自定义用户数据

createMeetingFail:cookie:

- (void)createMeetingFail:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 创建房间成功响应

  • 返回值: 无

notifyTokenNearTimeout

- (void)notifyTokenNearTimeout

  • 功能: 通知Token即将失效,有效时间剩余30s左右(可调用updateToken更新Token)

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作失败代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义用户数据

destroyMeetingRslt:cookie:

- (void)destroyMeetingRslt:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 结束房间响应

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,成功为CRVIDEOSDK_NOERR,其他详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义用户数据

getMeetingListSuccess:cookie:

- (void)getMeetingListSuccess:(ArrayList< MeetInfo *> *)meetList cookie:(NSString *)cookie

  • 功能: 获取当前房间列表响应

  • 返回值: 无

参数 类型 含义
meetList MeetInfo 房间信息, 详见定义MeetInfo
cookie NSString 自定义用户数据

getMeetingListFail:cookie:

- (void)getMeetingListFail:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 获取当前房间列表失败

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作失败代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义用户数据

callSuccess:cookie:

- (void)callSuccess:(NSString *)callID cookie:(NSString *)cookie

  • 功能: 呼叫他人操作成功响应

  • 返回值: 无

参数 类型 含义
callID NSString 呼叫全局标识
cookie NSString 自定义用户数据

callFail:errCode:cookie:

- (void)callFail:(NSString *)callID errCode:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 呼叫他人操作失败响应

  • 返回值: 无

参数 类型 含义
callID NSString 呼叫全局标识
sdkErr CRVIDEOSDK_ERR_DEF 操作失败代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义用户数据

acceptCallSuccess:cookie:

- (void)acceptCallSuccess:(NSString *)callID cookie:(NSString *)cookie

  • 功能: 接受他人呼叫操作成功响应

  • 返回值: 无

参数 类型 含义
callID NSString 呼叫全局标识
cookie NSString 自定义用户数据

acceptCallFail:errCode:cookie:

- (void)acceptCallFail:(NSString *)callID errCode:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 接受他人呼叫操作失败响应

  • 返回值: 无

参数 类型 含义
callID NSString 呼叫全局标识
sdkErr CRVIDEOSDK_ERR_DEF 操作失败代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义用户数据

rejectCallSuccess:cookie:

- (void)rejectCallSuccess:(NSString *)callID cookie:(NSString *)cookie

  • 功能: 拒绝他人的呼叫成功响应

  • 返回值: 无

参数 类型 含义
callID NSString 呼叫全局标识
cookie NSString 自定义用户数据

rejectCallFail:errCode:cookie:

- (void)rejectCallFail:(NSString *)callID errCode:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 拒绝他人的呼叫失败响应

  • 返回值: 无

参数 类型 含义
callID NSString 呼叫全局标识
sdkErr CRVIDEOSDK_ERR_DEF 操作失败代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义用户数据

hangupCallSuccess:cookie:

- (void)hangupCallSuccess:(NSString *)callID cookie:(NSString *)cookie

  • 功能: 挂断呼叫操作成功响应

  • 返回值: 无

参数 类型 含义
callID NSString 呼叫全局标识
cookie NSString 自定义用户数据

hangupCallFail:errCode:cookie:

- (void)hangupCallFail:(NSString *)callID errCode:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 拒绝他人呼叫操作失败响应

  • 返回值: 无

参数 类型 含义
callID NSString 呼叫全局标识
sdkErr CRVIDEOSDK_ERR_DEF 操作失败代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义用户数据

notifyCallIn:meetInfo:callerID:usrExtDat:

- (void)notifyCallIn:(NSString *)callID meetInfo:(MeetInfo *)meetInfo callerID:(NSString *)callerID usrExtDat:(NSString *)usrExtDat

  • 功能: 服务端通知被邀请

  • 返回值: 无

参数 类型 含义
callID NSString 呼叫全局标识
meetInfo MeetInfo 房间信息,详见定义MeetInfo,空时代表无房间信息,应由被叫创建或提供房间信息
callerID NSString 呼叫人员的标识ID
usrExtDat NSString 自定义扩展参数

notifyCallAccepted:meetInfo:usrExtDat:

- (void)notifyCallAccepted:(NSString *)callID meetInfo:(MeetInfo *)meetInfo usrExtDat:(NSString *)usrExtDat

  • 功能: 服务端通知会议邀请被接受回调

  • 返回值: 无

参数 类型 含义
callID NSString 呼叫全局标识
meetInfo MeetInfo 房间信息,详见定义MeetInfo,空时代表无房间信息,应由被叫创建或提供房间信息
usrExtDat NSString 自定义扩展参数

notifyCallRejected:reason:usrExtDat:

- (void)notifyCallRejected:(NSString *)callID reason:(CRVIDEOSDK_ERR_DEF)reason usrExtDat:(NSString *)usrExtDat

  • 功能: 服务端通知邀请被拒绝回调

  • 返回值: 无

参数 类型 含义
callID NSString 呼叫全局标识
reason CRVIDEOSDK_ERR_DEF 呼叫被对方拒绝的原因代码,详见定义CRVIDEOSDK_ERR_DEF
usrExtDat NSString 自定义扩展参数

notifyCallhangup:usrExtDat:

- (void)notifyCallhangup:(NSString *)callID usrExtDat:(NSString *)usrExtDat

  • 功能: SDK通知呼叫被挂断

  • 返回值: 无

参数 类型 含义
callID NSString 呼叫全局标识
usrExtDat NSString 自定义扩展参数

callMorePartyRslt:sdkErr:cookie:

- (void)callMorePartyRslt:(NSString *)inviteID sdkErr:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 呼叫操作结果

  • 返回值: 无

参数 类型 含义
inviteID NSString 邀请标识码(邀请ID)
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

cancelCallMorePartyRslt:sdkErr:cookie:

- (void)cancelCallMorePartyRslt:(NSString *)inviteID sdkErr:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 取消呼叫操作结果

  • 返回值: 无

参数 类型 含义
inviteID NSString 邀请标识码(邀请ID)
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

notifyCallMorePartyStatus:status:

- (void)notifyCallMorePartyStatus:(NSString *)inviteID status:(CR_INVITE_STATUS)status

  • 功能: 通知呼叫状态改变

  • 返回值: 无

参数 类型 含义
inviteID NSString 邀请标识码(邀请ID)
status CR_INVITE_STATUS 状态值, 详见定义CR_INVITE_STATUS

sendCmdRlst:sdkErr:cookie:

- (void)sendCmdRlst:(NSString *)sendId sdkErr:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 发送数据时,SDK通知发送结果

  • 返回值: 无

参数 类型 含义
taskID NSString 发送任务id
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

sendBufferRlst:sdkErr:cookie:

- (void)sendBufferRlst:(NSString *)sendId sdkErr:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 发送数据时,SDK通知发送结果

  • 返回值: 无

参数 类型 含义
taskID NSString 发送任务id
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

sendFileRlst:fileName:sdkErr:cookie:

- (void)sendFileRlst:(NSString *)sendId fileName:(NSString *)fileName sdkErr:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 发送数据时,SDK通知发送结果

  • 返回值: 无

参数 类型 含义
taskID NSString 发送任务id
fileName NSString 文件名
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

sendProgress:sendedLen:totalLen:cookie:

- (void)sendProgress:(NSString *)sendId sendedLen:(int)sendedLen totalLen:(int)totalLen cookie:(NSString *)cookie

  • 功能: 发送数据时,SDK通知发送进度

  • 返回值: 无

参数 类型 含义
taskID NSString 发送任务id
sendedLen int 已发送的数据长度
totalLen int 需要发送的总长度
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

cancelSendRlst:sdkErr:cookie:

- (void)cancelSendRlst:(NSString *)sendId sdkErr:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能: 取消发送操作响应

  • 返回值: 无

参数 类型 含义
taskID NSString 发送任务id
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

notifyCmdData:data:

- (void)notifyCmdData:(NSString *)sourceUserId data:(NSString *)data

  • 功能: SDK通知收到小块数据

  • 返回值: 无

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

notifyBufferData:data:

- (void)notifyBufferData:(NSString *)sourceUserId data:(NSString *)data

  • 功能: SDK通知收到大块数据

  • 返回值: 无

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

notifyFileData:tmpFile:orgFileName:

- (void)notifyFileData:(NSString *)sourceUserId tmpFile:(NSString *)tmpFile orgFileName:(NSString *)orgFileName

  • 功能: SDK通知收到文件数据

  • 返回值: 无

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

notifyCancelSend:

- (void)notifyCancelSend:(NSString *)sendId

  • 功能: 通知发来的数据/文件被取消

  • 返回值: 无

参数 类型 含义
taskID NSString 发送的任务ID 数据来源

视频房间组件(RTCMeeting)

视频房间组件(RTCMeeting)

RTCMeeting 是房间核心控件,实现通话建立、音频采集播入、视频采集编解码、屏幕共享、录制、影音播放等功能,整个程序的生命过程中只能有一个实例


setMeetingCallBack:

- (void)setMeetingCallBack:(id)callBack

  • 功能: 注册监听回调

  • 返回值: 无

参数 类型 含义
callBack id 回调对象

registerMeetingCallback:

- (void)registerMeetingCallback:(id)callBack

  • 功能: 注册监听回调

  • 返回值: 无

参数 类型 含义
callBack id 回调对象

removeMeetingCallBack:

- (void)removeMeetingCallBack:(id)callBack

  • 功能: 反注册监听回调

  • 返回值: 无

参数 类型 含义
callBack id 反注册的回调对象

enterMeeting:nickname:

- (void)enterMeeting:(int)meetID nickname:(NSString *)nickname

  • 功能: 使用房间ID进入指定的视频房间

  • 返回值: 无

回调函数enterMeetingRslt

参数 类型 含义
meetID int 视频房间ID
nickname NSString 用户昵称

exitMeeting

- (void)exitMeeting

  • 功能: 离开房间 ,调用此接口离开会话时,其他会话用户会收到userLeftMeeting的消息通知

  • 返回值: 无

回调函数userLeftMeeting

getAllMembers

- (NSMutableArray *)getAllMembers

  • 功能: 获取所有用户的信息

  • 返回值: NSMutableArray *;-所有用户的信息,详见定义MemberInfo

getMemberInfo:

- (MemberInfo *) getMemberInfo:(NSString *)userId

  • 功能: 获取某个用户的信息

  • 返回值: MemberInfo - 用户的信息,详见定义MemberInfo说明

参数 类型 含义
userId NSString 用户ID

getMyUserID

- (NSString *)getMyUserID

  • 功能: 获取自身的userID

  • 返回值: 自身的userID

getNickName:

- (NSString *)getNickName:(NSString *)userID

  • 功能: 获取某个用户的昵称

  • 返回值: 用户的昵称

参数 类型 含义
userId NSString 用户ID

setNickName:nickName:

- (void)setNickName:(NSString*)userID nickName:(NSString*)nickName

  • 功能: 设置某个用户的昵称, 调用此接口如果设置成功,其他会话用户会收到 notifyNickNameChanged

  • 返回值: 无

回调函数setNickNameRsp

参数 类型 含义
userId NSString 用户ID
nickname NSString 新的用户昵称

isUserInMeeting:

- (BOOL)isUserInMeeting:(NSString *)userID

  • 功能: 判断某个用户是否在房间中

  • 返回值: 用户是否在房间中

参数 类型 含义
userId NSString 用户ID

kickout:

- (void)kickout:(NSString *)userid

  • 功能: 将用户请出房间

  • 返回值: 无

参数 类型 含义
userid NSString 用户ID

setAudioCfg:

- (void)setAudioCfg:(AudioCfg*)cfg

  • 功能: 设置音频参数

  • 返回值: 无

参数 类型 含义
cfg AudioCfg 音频参数,详见定义AudioCfg

getAudioCfg

- (AudioCfg*) getAudioCfg

  • 功能: 获取音频参数

  • 返回值: 音频参数,详见定义AudioCfg

setMicVolumeScaling:

- (bool)setMicVolumeScaling:(int)scale

  • 功能: 设置麦克风音量增益

  • 返回值: 是否成功

参数 类型 含义
scale int 麦克风音量增益(范围:1-20)

getMicEnergy:

- (int)getMicEnergy:(NSString *)userID

  • 功能: 获取用户说话声音大小

  • 返回值: 音量大小(0~10)

参数 类型 含义
userID NSString 用户的ID

openMic:

- (void)openMic:(NSString *)userId

  • 功能: 打开用户的麦克风, 打开麦克风会触发音频状态变化的回调函数audioStatusChanged 新状态参数先会进入到AOPENING状态,
    等服务器处理后才会进入AOPEN状态,此时说话才能被采集到

  • 返回值: 无

回调函数audioStatusChanged

参数 类型 含义
userID NSString 用户的ID

closeMic:

- (void)closeMic:(NSString *)userId

  • 功能: 关闭用户的麦克风 ,关麦克风会触发音频状态变化的回调函数audioStatusChanged 新状态参数会变为ACLOSE 关麦操作是立即生效的,会立即停止采集

  • 返回值: 无

回调函数audioStatusChanged

参数 类型 含义
userID NSString 用户的ID

getAudioStatus:

- (AUDIO_STATUS)getAudioStatus:(NSString *)userID

  • 功能: 获取用户的麦状态

  • 返回值: 麦克风设备状态,详见定义AUDIO_STATUS

参数 类型 含义
userID NSString 用户的ID

setMicVolume:

- (bool)setMicVolume:(int)level

  • 功能: 设置麦克风音量大小,音量范围类型 0-255

  • 返回值: 是否成功

参数 类型 含义
level int 麦克风音量,取值:0-255

getMicVolume

- (int)getMicVolume

  • 功能: 获取麦克风音量大小 ,音量范围类型 0-255

  • 返回值: 麦克风音量大小

setSpeakerVolume:

- (bool)setSpeakerVolume:(int)level

  • 功能: 设置本地扬声器音量

  • 返回值: 是否成功

参数 类型 含义
level int 本地扬声器音量,取值:0-255

getSpeakerVolume

- (int)getSpeakerVolume

  • 功能: 获取本地扬声器音量 ,读写属性,音量等级类型 0-255

  • 返回值: 本地扬声器音量

setSpeakerMute:

- (void)setSpeakerMute:(BOOL)bMute

  • 功能: 设置播放是否静音

  • 返回值: 是否静音

参数 类型 含义
bMute BOOL 播放是否静音

getSpeakerMute

- (BOOL)getSpeakerMute

  • 功能: 获取播放是否静音

  • 返回值: 是否静音

setSpeakerOut:

- (BOOL)setSpeakerOut:(BOOL)speakerOut

  • 功能: 设置外放状态(外放时走扬声器, 不外放时走听筒)

  • 返回值: 是否成功

参数 类型 含义
speakerOut BOOL 是否外放

getSpeakerOut

- (BOOL)getSpeakerOut

  • 功能: 获取外放状态

  • 返回值: 是否外放

setAllAudioClose

void setAllAudioClose()

  • 功能: 关闭所有用户的麦克风 , 调用此接口后会话内其他人的麦克风会关闭,同时收到消息audioStatusChanged
  • 返回值: 无

回调函数audioStatusChanged

getAllVideoInfo:

- (NSMutableArray <UsrVideoInfo *> *)getAllVideoInfo:(NSString *)userId

  • 功能: 获取用户所有的摄像头信息

  • 返回值: 用户所有的摄像头信息,详见UsrVideoInfo说明

参数 类型 含义
userID NSString 用户ID

createCustomVideoDev:pixFmt:width:height:extParams:

- (int) createCustomVideoDev:(NSString*)camName pixFmt:(VIDEO_FORMAT)pixFmt width:(int)width height:(int)height extParams:(NSString*)extParams

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

  • 返回值: 返回值小于0, 则代表创建失败, 返回值大于等于0, 则代表摄像头编号

参数 类型 含义
camName NSString 摄像头名称
pixFmt VIDEO_FORMAT 详见定义VIDEO_FORMAT
width int 图像宽度
height int 图像高度
extParams NSString 扩展参数,没有为空

destroyCustomVideoDev:

- (void)destroyCustomVideoDev:(int)devID

  • 功能: 销毁自定义摄像头

  • 返回值: 无

参数 类型 含义
devID int 摄像头id (createCustomVideoDev返回值)

inputCustomVideoDat:data:timeStamp:

- (void)inputCustomVideoDat:(int)devID data:(NSData*)data timeStamp:(int)timeStamp

  • 功能: 输入摄像头图像数据

  • 返回值: 无

参数 类型 含义
devID int 摄像头id (createCustomVideoDev返回值)
data NSData 图像数据(请保证格式、和尺寸与摄像头匹配)
timeStamp int 保留字段,请填0

startBeauty:

- (CRVIDEOSDK_ERR_DEF)startBeauty:(NSString *)params

  • 功能:开启美颜功能

开启美颜成功后,将带来不少gpu开销,且视频分辨率越高开销将越大;
支持多种美颜滤镜叠加,但叠加的越多,gpu开销越大;(当滤镜强度为0时,对应滤镜将不再带来开销)
当前美颜功能,只对默认摄像头生效,切换默认摄像头时内部自动对新的默认摄像头进行美颜处理;

参数 类型 含义
params NSString* 美颜参数,参见CRBeautyCfg

stopBeauty

- (void)stopBeauty

  • 功能:停止美颜功能

  • 返回值:无

isBeautyStarted

- (BOOL)isBeautyStarted

  • 功能:获取美颜功能是否开启

  • 返回值: bool

updateBeautyParams:

- (CRVIDEOSDK_ERR_DEF)updateBeautyParams:(NSString *)params

  • 功能:更新美颜参数

  • 返回值: CRVSDK_ERR_DEF,CRVIDEOSDK_NOERR代表调用成功

  • 参数:

参数 类型 含义
params NSString* 美颜参数,参见CRBeautyCfg

getBeautyParams

- (NSString *)getBeautyParams

  • 功能:获取当前美颜参数

  • 返回值:美颜配置,json格式,请参见CRBeautyCfg

startVirtualBackground:

- (CRVIDEOSDK_ERR_DEF)startVirtualBackground:(NSString *)params

  • 功能:开启虚拟背景

切换模式时,需要先停止再开启
只对默认摄像头生效,切换默认摄像头时内部自动对新的默认摄像头进行虚拟背景处理

参数 类型 含义
params NSString* 美颜参数,参见CRVirtualBkCfg

stopVirtualBackground

- (void)stopVirtualBackground

  • 功能:停止虚拟背景

  • 返回值:无

isVirtualBackgroundStarted

- (BOOL)isVirtualBackgroundStarted

  • 功能:获取虚拟背景是否开启

  • 返回值: BOOL

updateVirtualBackgroundParams:

- (CRVIDEOSDK_ERR_DEF)updateVirtualBackgroundParams:(NSString *)params

  • 功能:更新虚拟背景参数

更新时,模式参数不能变化

参数 类型 含义
params NSString* 美颜参数,参见CRVirtualBkCfg

getVirtualBackgroundParams

- (NSString *)getVirtualBackgroundParams

  • 功能:获取当前虚拟背景参数

  • 返回值:美颜配置,json格式,请参见CRVirtualBkCfg

setVideoCfg:

- (BOOL) setVideoCfg:(VideoCfg*)cfg

  • 功能: 设置摄像头参数

  • 返回值: 无

参数 类型 含义
cfg VideoCfg 摄像头参数,详见定义VideoCfg

getVideoCfg

- (VideoCfg*) getVideoCfg

  • 功能: 获取设置的摄像头参数

  • 返回值: 摄像头参数, 详见定义VideoCfg

setVideoEffects:

- (BOOL) setVideoEffects:(VideoEffects*)effects

  • 功能: 设置视频特效参数

  • 返回值: BOOL类型,设置成功返回YES,失败返回NO

参数 类型 含义
effects VideoEffects 视频特效参数,详见定义VideoEffects

getVideoEffects

- (VideoEffects*) getVideoEffects

  • 功能: 获取当前设置的视频特效参数

  • 返回值: 当前视频特效参数,详见定义VideoEffects|若无特效设置或获取失败则返回nil

setLocVideoAttributes:attributes:

- (void)setLocVideoAttributes:(int)videoID attributes:(CamAttribute*)attributes

  • 功能: 设置某个摄像头私有参数

  • 返回值: 无

参数 类型 含义
videoID int 本地摄像头id
attributes CamAttribute 摄像头私有参数, 详见定义CamAttribute

getLocVideoAttributes:

- (CamAttribute*)getLocVideoAttributes:(int)videoID

  • 功能: 获取某个摄像头私有参数

  • 返回值: 摄像头私有参数, 详见定义CamAttribute

参数 类型 含义
videoID short 本地摄像头id

getWatchableVideos

- (NSMutableArray <UsrVideoId *>*)getWatchableVideos

  • 功能: 获取房间内所有可观看的摄像头

  • 返回值: 房间内所有可观看的摄像头,详见定义UsrVideoId

openVideo:

- (void)openVideo:(NSString *)userID

  • 功能: 打开用户的摄像头,以便本地、远端显示视频图像

  • 返回值: 无

回调函数openVideoRslt, 调用打开和关闭麦克风接口都会触发对应用户的回调videoStatusChanged

参数 类型 含义
userID NSString 用户的ID

closeVideo:

- (void)closeVideo:(NSString *)userID

  • 功能: 关闭用户的摄像头 ,

  • 返回值: 无

调用打开和关闭麦克风接口都会触发对应用户的回调videoStatusChanged

参数 类型 含义
userID NSString 用户的ID

getVideoStatus:

- (VIDEO_STATUS)getVideoStatus:(NSString *)userID

  • 功能: 获取用户的摄像头状态

  • 返回值: 麦克风摄像头状态,请参见VSTATUS定义

参数 类型 含义
userID NSString 用户的ID

getDefaultVideo:

- (short)getDefaultVideo:(NSString *)userId

  • 功能: 获取指定用户的默认摄像头 ,如果用户没有摄像头,返回0

  • 返回值: 摄像头ID

参数 类型 含义
userID NSString 用户的ID

setDefaultVideo:videoID:

- (void)setDefaultVideo:(NSString *)userId videoID:(short)videoID

  • 功能: 设置默认的摄像头 ,videoID 应该从getAllVideoInfo返回值中获取

  • 返回值: 无

参数 类型 含义
userID NSString 用户的ID
videoID short 摄像头ID

getVideoImg:

- (VideoFrame *)getVideoImg:(UsrVideoId *)userID

  • 功能: 获取指定用户摄像头的最新图像

  • 返回值: 指定用户摄像头的最新图像,详见VideoFrame

参数 类型 含义
usrVideoID UsrVideoId 详见定义UsrVideoId

getVideoImg2:fmt:width:height:

- (VideoFrame*)getVideoImg2:(UsrVideoId*)userID fmt:(VIDEO_FORMAT)fmt width:(int)width height:(int)height

  • 功能: 获取指定用户摄像头的最新图像

  • 返回值: 指定用户摄像头的最新图像,详见VideoFrame

参数 类型 含义
usrVideoID UsrVideoId 详见定义UsrVideoId
fmt VIDEO_FORMAT 图像格式 -1时原用帧原始值 详见定义VIDEO_FORMAT
width int 图像宽度 -1时原用帧原始值
height int 图像高度 -1时原用帧原始值

getLocalVideoParams:

- (NSString *)getLocalVideoParams:(short)videoID

  • 功能: 获取指定本地摄像头参数

  • 返回值: 指定本地摄像头参数,json格式,如{"摄像头参数名称":[可用参数列表]}

参数 类型 含义
videoID short 摄像头ID

setLocalVideoParam:param:value:

- (void)setLocalVideoParam:(short)videoID param:(NSString)param value:(NSString)value

  • 功能: 设置指定本地摄像头参数

  • 返回值: 指定本地摄像头参数,json格式,如{"摄像头参数名称":[可用参数列表]}

参数 类型 含义
videoID short 摄像头ID
param NSString 摄像头参数名称
value NSString 摄像头参数值

isScreenShareStarted

- (BOOL)isScreenShareStarted

  • 功能: 获取屏幕共享是否已开启

  • 返回值: 屏幕共享是否已开启

getScreenShareCfg

- (ScreenShareCfg*) getScreenShareCfg

  • 功能: 获取屏幕共享配置

  • 返回值:屏幕共享配置,参见ScreenShareCfg

setScreenShareCfg:

- (void)setScreenShareCfg:(ScreenShareCfg *)cfg

  • 功能: 设置屏幕共享配置

  • 返回值:无

参数 类型 含义
cfg ScreenShareCfg 屏幕共享配置

startScreenShare

- (void)startScreenShare

  • 功能: 开启屏幕共享

  • 返回值:无

stopScreenShare

- (void)stopScreenShare

  • 功能: 停止屏幕共享

  • 返回值:无

startScreenMark

- (void)startScreenMark

  • 功能: 开始屏幕共享标注

  • 返回值: 无

stopScreenMark

- (void)stopScreenMark

  • 功能: 停止屏幕共享标注

  • 返回值: 无

enableOtherMark:

- (void)enableOtherMark:(BOOL)enable

  • 功能:允许他人标注屏幕

  • 返回值:无

  • 参数:

参数 类型 含义
enable BOOL 是否允许他人标注

isEnableOtherMark

- (BOOL)isEnableOtherMark

  • 功能:获取是否允许他人标注屏幕

  • 返回值: 是否允许他人标注

createLocMixer:cfg:content:

- (CRVIDEOSDK_ERR_DEF)createLocMixer:(NSString*)mixerID cfg:(MixerCfg*)cfg content:(MixerContent*)content

  • 功能: 创建本地混图器(用于本地录制、本地推流),当需要多个不同内容的录制、或直播时,就要创建多个混图器 。混图器开消比较大,多个同样图像的输出应该有一个混图器加上多个输出实现

  • 返回值: CRVIDEOSDK_ERR_DEF

参数 类型 含义
mixerID NSString 混图器唯一标识
cfg MixerCfg 混图器规格配置,详见定义MixerCfg
content MixerContent 混图器内容配置,详见定义MixerContent

updateLocMixerContent:content:

- (CRVIDEOSDK_ERR_DEF)updateLocMixerContent:(NSString*)mixerID content:(MixerContent*)content

  • 功能: 更新本地混图器内容

  • 返回值: CRVIDEOSDK_ERR_DEF

参数 类型 含义
mixerID NSString 混图器唯一标识
content MixerContent 混图器内容配置,详见定义MixerContent

destroyLocMixer:

- (void)destroyLocMixer:(NSString*)mixerID

  • 功能: 销毁本地混图器 , 销毁本地混图器后, 基于此混图器的录制输出、直播推流输出将自动结束

  • 返回值: 无

参数 类型 含义
mixerID NSString 混图器唯一标识

getLocMixerState:

- (MIXER_STATE)getLocMixerState:(NSString*)mixerID

  • 功能: 获取本地混图器状态

  • 返回值: MIXER_STATE

参数 类型 含义
mixerID NSString 混图器唯一标识

addLocMixer:outputs:

- (CRVIDEOSDK_ERR_DEF)addLocMixer:(NSString*)mixerID outputs:(MixerOutput*)outputs

  • 功能: 开启本地录制、开启直播推流

  • 返回值: CRVIDEOSDK_ERR_DEF

参数 类型 含义
mixerID NSString 混图器唯一标识
outputs MixerOutput 本地输出对象,详见定义MixerOutput
  • 注意事项:

  • 可以一次添加多个输出,也可以依据业务需要稍后再添加新的输出
  • 多个输出不能同名、或同一url
  • 每个输出,有独立的信息通知,请见事件locMixerOutputInfo
  • 如果输出异常时,将自动停止, 停止本地录制、直播推流

rmLocMixerOutput:nameOrUrls:

- (void)rmLocMixerOutput:(NSString*)mixerID nameOrUrls:(NSArray<NSString*>*)nameOrUrls

  • 功能: 停止本地录制、直播推流 , 所有输出停止后并不会销毁混图器,如果混图器不再需要请手工销毁

  • 返回值: 无

参数 类型 含义
mixerID NSString 混图器唯一标识
nameOrUrls NSArray<NSString*>* 要停止的录制文件名或直播url列表

createCloudMixer:

- (NSString *)createCloudMixer:(NSString *)cfg

  • 功能: 开始云端录制、云端直播

  • 返回值: NSString

参数 类型 含义
cfg NSString 服务器混图配置,参见CloudMixerCfgObj
  • 注意事项:

  • 可以开启多个云端混图器,具体个数和企业购买的授权相关;
  • 开启云端混图器后,房间内所有人都将收到cloudMixerStateChanged通知进入MIXER_STARTING(启动中状态);
  • 云端混图器部署有少量耗时,如果在部署过程遇到异常,将收到createCloudMixerFailed回调;
  • 云端混图器启动完成并进入录制或推流状态时,将收到cloudMixerStateChanged通知,进入MIXER_RUNNING(工作中状态);
  • 开启云端混图器在进入MIXER_STARTING状态后,可以通过updateCloudMixerContent更新内容;
  • 混图器如果在工作中遇到异常而停止时,将收到cloudMixerStateChanged通知,进入MIXER_NULL并携带错误原因;

updateCloudMixerContent:cfg:

- (CRVIDEOSDK_ERR_DEF)updateCloudMixerContent:(NSString *)mixerID cfg:(NSString *)cfg

  • 功能: 更新云端录制、云端直播内容

  • 返回值: CRVIDEOSDK_ERR_DEF

  • 注意事项:

  • 更新混图器内容时,只能更新内容和布局,不能更改混图器规格、输出目标;
  • 更新混图器内容时,房间内所有人都将收到cloudMixerInfoChanged通知;
参数 类型 含义
mixerID NSString 混图器ID, 参见createCloudMixer
cfg NSString 混图器内容配置,josn格式,参见CloudMixerCfgObj

destroyCloudMixer:

- (void)destroyCloudMixer:(NSString *)mixerID

  • 功能: 停止云端录制、云端直播

  • 返回值: CRVIDEOSDK_ERR_DEF

  • 注意事项:

参数 类型 含义
mixerID NSString 混图器ID, 参见createCloudMixer

getAllCloudMixerInfo

- (NSString *)getAllCloudMixerInfo

  • 功能: 得到所有云端混图器信息

  • 返回值: NSString json格式字符串,参见CloudMixerInfoList

getCloudMixerInfo:

- (NSString *)getCloudMixerInfo:(NSString *)mixerID

  • 功能: 得到云端混图器信息

  • 返回值: NSString json格式字符串, 参见CloudMixerInfo

参数 类型 含义
mixerID NSString 混图器ID, 参见createCloudMixer

setMediaCfg:

- (BOOL)setMediaCfg:(VideoCfg *)cfg

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

  • 返回值: 无

参数 类型 含义
cfg VideoCfg 图像质量参数,详见定义VideoCfg

getMediaCfg

- (VideoCfg *)getMediaCfg

  • 功能: 获取影音共享图像质量参数

  • 返回值: 图像质量参数,详见定义VideoCfg

startPlayMedia:bLocPlay:

- (void)startPlayMedia:(NSString *)filename bLocPlay:(int)bLocPlay

  • 功能: 播放影音文件

支持本地完整路径文件,支持mp4、flv、avi、wmv、mkv、mov、3gp、wma、mp3、m4a、wav等常见文件格式;
支持网络媒体流,支持的协议有:rtmp、rtsp、http(http的媒体文件,并非网页);
一个房间同一时间只能一个影音共享(本地播放除外);

  • 返回值: 无
参数 类型 含义
filename NSString 文件名,全路径
bLocPlay int 是否仅仅本地播放(true:本地播放,false:房间内播放)

startPlayMedia:bLocPlay:bPauseWhenFinished:

- (void)startPlayMedia:(NSString *)filename bLocPlay:(int)bLocPlay bPauseWhenFinished:(int)bPauseWhenFinished

  • 功能: 播放影音文件

  • 返回值: 无

播放视频则触发回调notifyMediaOpened(监听), 停止播放则触发回调notifyMediaStop

参数 类型 含义
filename NSString 文件名,全路径
bLocPlay int 是否仅仅本地播放(1:本地播放,0:房间内播放)
bPauseWhenFinished boolean 是否停在最后一帧, 如果播放成功,其他人收到notifyMediaOpened,如果播放失败,请关注通知事件notifyMediaStop

pausePlayMedia:

- (void)pausePlayMedia:(BOOL)bPause

  • 功能: 暂停播放影音

  • 返回值: 无

参数 类型 含义
bPause BOOL 是否暂停

stopPlayMedia

- (void)stopPlayMedia

  • 功能: 停止影音播放

  • 返回值: 无

回调函数notifyMediaStop

setMediaPlayPos:

void setMediaPlayPos(int pos)

  • 功能: 设置播放进度

  • 返回值: 无

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

getAllFilesInMediaPath

- (NSArray <NSString *> *)getAllFilesInMediaPath

  • 功能: 取得影音文件夹下的所有可播放文件

  • 返回值: 文件名列表

  • 注意事项:

  • 影音文件夹位于方法init的第二个参数sdkFilePath,sdk会在此文件中建立media的子文件夹,即为影音文件夹

getMediaInfo

- (MediaInfo *)getMediaInfo

  • 功能: 取得影音文件夹下的所有可播放文件

  • 返回值: 文件名列表 , 影音文件信息,详见定义MediaInfo

setMediaVolume:

- (void)setMediaVolume:(int)level

  • 功能: 设置影音播放的音量

  • 返回值: 无

参数 类型 含义
level int 影音播放的音量,类型范围(0-255)

getMediaVolume

- (int)getMediaVolume

  • 功能: 读取影音播放的音量

  • 返回值: 影音播放的音量,类型范围(0-255)

getMediaImg:

- (MediaDataFrame *)getMediaImg:(NSString *)userId

  • 功能: 取得影音帧信息

  • 返回值: 影音帧信息,详见定义MediaDataFrame

参数 类型 含义
userID NSString 用户id

startGetAudioPCM:getType:param:

- (BOOL)startGetAudioPCM:(int)aSide getType:(int)getType param:(NSString *)param

  • 功能: 开始获取语音pcm数据

  • 返回值:返回值 BOOL值,YES:正常,NO:失败

参数 类型 含义
aSide int 声道类型 0:麦克风,1:扬声器
getType int 获取方式 0:回调方式,1:保存为文件
jsonParam NSString 当getType=0 表示回调方式,jsonParam可配置回调的数据大小(320-32000),如: {"EachSize":320};
当getType=1 表示保存为文件,jsonParam可配置文件名,如: { "FileName" : "e:\test.pcm" }
  • 补充说明:
  1. getType为0时,回调事件请参见notifyAudioPCMDat
  2. pcm数据为:16khz采样率, 16bit采样宽度

stopGetAudioPCM:

- (void)stopGetAudioPCM:(int)aSide

  • 功能: 停止获取语音pcm数据

  • 返回值:无

参数 类型 含义
aSide int 声道类型 0:麦克风,1:扬声器

setAudioSubscribeMode:

- (void)setAudioSubscribeMode:(ASUBSCRIB_MODE)mode

  • 功能:设置音频订阅模式

sdk内部默认为CRVSDK_ASM_MIXED模式,此模式进入房间成功就能听到房间内所有开麦人的声音;
配置为CRVSDK_ASM_SEPARATE模式后,默认不订阅任何人的声音,需要调用setAudioSubscribeListForSeparateMode设置要订阅的人员名单;
此接口在进入房间前可调用, 程序退出后失效;

  • 返回值: 无

  • 参数:

参数 类型 含义
mode ASUBSCRIB_MODE 订阅模式

setAudioSubscribeListForSeparateMode:userIds:

- (void)setAudioSubscribeListForSeparateMode:(ASUBSCRIB_LISTTYPE)type userIds:(NSArray<NSString *> *)userIds

  • 功能:设置独立音频订阅名单

只有在ASM_SEPARATE音频订阅模式下才能设置,可调用setAudioSubscribeMode修改模式;
切换到其它音频订阅模式时,之前设置的名单自动失效;
此接口在进入房间前可调用,程序退出后失效;
白名单和黑名单不共存,后面的数据将覆盖之前的数据;
其他人员进出房间、开关麦,不影响设置的名单;sdk内部会退订离开或关麦的流,在开麦后再次订阅;

  • 返回值: 无

  • 参数:

参数 类型 含义
type ASUBSCRIB_LISTTYPE 列表类型
userIds NSArray<NSString *> * 用户ID列表

startEchoTest

- (void)startEchoTest

  • 功能: 开始本地语音环回测试

  • 返回值: 无

stopEchoTest

- (void)stopEchoTest

  • 功能: 停止本地语音环回测试

isEchoTesting

- (bool)isEchoTesting

  • 功能: 检测是否在本地语音环回测试

  • 返回值: 是否测试中

getLocMicDevEnergy

- (int)getLocMicDevEnergy

  • 功能: 获取本地麦克风设备能量等级

  • 返回值: 能量等级0~9, (9为最大能量等级)

setVoiceChange:type:

- (void)setVoiceChange:(NSString *)userID type:(int)type

  • 功能: 设置指定人变声

  • 返回值: 无

参数 类型 含义
userID NSString 用户ID
type int 预定义变声类型,见CRVOICECHANGE_TYPE

getVoiceChangeType:

- (int)getVoiceChangeType:(NSString *)userID

  • 功能: 获取目标用户变声类型

  • 返回值: 预定义变声类型,参考CRVOICECHANGE_TYPE

参数 类型 含义
userID NSString 用户ID

setCustomAudioCapture:param:

- (CRVIDEOSDK_ERR_DEF)setCustomAudioCapture:(bool)enable param:(NSString *)param

  • 功能: 自定义音频采集

  • 返回值: 调用结果,CRVIDEOSDK_NOERR 代表调用成功,详情见CRVIDEOSDK_ERR_DEF

参数 类型 含义
enable bool 是否启用自定义音频采集
param NSString 可选扩展参数,json格式,当前支持参数:
"fromIPCam":摄像头ID,配置后将不再需要pushCustomAudioDat,sdk自动从IPCam中获取音频数据

pushCustomAudioDat:

- (CRVIDEOSDK_ERR_DEF)pushCustomAudioDat:(AudioFrame *)frm

  • 功能: 向sdk送入自定义音频采集数据

  • 返回值: 调用结果,CRVIDEOSDK_NOERR 代表调用成功,详情见CRVIDEOSDK_ERR_DEF

参数 类型 含义
frm AudioFrame 音频帧数据,sdk格式要求:48khz 16bit 单声道数据

setCustomAudioPlayback:param:

- (CRVIDEOSDK_ERR_DEF)setCustomAudioPlayback:(bool)enable param:(NSString *)param

  • 功能: 自定义音频渲染

  • 返回值: 调用结果,CRVIDEOSDK_NOERR 代表调用成功,详情见CRVIDEOSDK_ERR_DEF

参数 类型 含义
enable bool 是否开启自定义音频播放
param NSString 保留参数

pullCustomAudioDat

- (AudioFrame *)pullCustomAudioDat

  • 功能: 从sdk获取音频数据用于自渲染

  • 返回值: AudioFrame

getVideoStreamInfo:

- (StreamInfo *)getVideoStreamInfo:(UsrVideoId *)cam

  • 功能: 获取摄像头流信息

  • 返回值: 流信息StreamInfo

参数 类型 含义
cam UsrVideoId 是否开启自定义音频播放

sendIMmsg:toUserID:cookie:

- (NSString *)sendIMmsg:(NSString *)text toUserID:(NSString *)toUserID cookie:(NSString *)cookie

  • 功能: 发送IM消息

  • 返回值: taskID 发送任务id

回调函数sendIMmsgRlst

参数 类型 含义
text NSString 发送的文本消息
toUsrID NSString 目标用户,如果用户ID为空,消息发送给房间内所有用户
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串

setPicResource:mediaDataFrame:

- (void)setPicResource:(NSString *)resID mediaDataFrame:(MediaDataFrame *)frame

  • 功能: 将图片资源设置给sdk

  • 返回值: 无

参数 类型 含义
resID NSString 资源唯一标识
frame MediaDataFrame 图片对象,为空代表移除资源

setPicResource:picFile:

- (void)setPicResource:(NSString *)resID picFile:(NSString*)picFile

  • 功能: 将图片资源设置给sdk

  • 返回值: 无

参数 类型 含义
resID NSString 资源唯一标识
picFile NSString 资源文件路径,为空代表移除资源

通知回调函数

RTCMeetingCallBack 是通话建立、音频采集播入、视频采集编解码、屏幕共享、录制、影音播放等功能的回调接口


enterMeetingRslt:

- (void)enterMeetingRslt:(CRVIDEOSDK_ERR_DEF)code

  • 功能: 自己进入房间的结果

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作结果码, 详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义用户数据

stopMeetingRslt:

- (void)stopMeetingRslt:(CRVIDEOSDK_ERR_DEF)code

  • 功能: 通知结束视频房间结果

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作结果码, 详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 自定义用户数据

setNickNameRsp:userid:newName:

- (void)setNickNameRsp:(CRVIDEOSDK_ERR_DEF)sdkErr userid:(NSString*)userid newName:(NSString*)newName

  • 功能: 设置昵称的结果

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作结果码, 详见定义CRVIDEOSDK_ERR_DEF
userid NSString 用户id
newName NSString 新的昵称

notifyNickNameChanged:oldName:newName:

- (void)notifyNickNameChanged:(NSString*)userid oldName:(NSString*)oldName newName:(NSString*)newName

  • 功能: 某用户改变了昵称(改昵称的用户自身不会接收到此通知)

  • 返回值: 无

参数 类型 含义
userID NSString 改变昵称的某用户id
oldName NSString 改变昵称的某用户昵称(改变之前的昵称)
newName NSString 改变昵称的某用户昵称(改变之后的昵称)

userEnterMeeting:

- (void)userEnterMeeting:(NSString *)userID

  • 功能: 某用户进入了房间

  • 返回值: 无

参数 类型 含义
userID NSString 进入房间的用户id

userLeftMeeting:

- (void)userLeftMeeting:(NSString *)userID

  • 功能: 某用户离开了房间

  • 返回值: 无

参数 类型 含义
userID NSString 离开房间的用户id

kickoutRslt:userID:

- (void)kickoutRslt:(CRVIDEOSDK_ERR_DEF)sdkErr userID:(NSString*)userID

  • 功能: 请出房间结果

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF CRVIDEOSDK_NOERR 代表成功,其它值代表失败的具体原因
userID NSString 离开房间的用户id

meetingDropped

- (void)meetingDropped

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

  • 返回值: 无

  • 注意事项:

  • 如果用到了呼叫队列,掉线后不重新进入房间就必须调用hangupCall释放本次呼叫

meetingStopped

- (void)meetingStopped

  • 功能: 房间已被结束

  • 返回值: 无

netStateChanged:

- (void)netStateChanged:(int)level

  • 功能: 网络变化通知

  • 返回值: 无

参数 类型 含义
level int 网络状况等级(0~10,10分为最佳网络)

audioDevChanged

- (void)audioDevChanged

  • 功能: 通知本地音频设备有变化

  • 返回值: 无

audioStatusChanged:oldStatus:newStatus:

- (void)audioStatusChanged:(NSString *)userID oldStatus:(AUDIO_STATUS)oldStatus newStatus:(AUDIO_STATUS)newStatus

  • 功能: 通知音频状态变化

  • 返回值: 无

参数 类型 含义
userID NSString 房间中设备的所有者
oldStatus AUDIO_STATUS 旧状态,详见定义AUDIO_STATUS
newStatus AUDIO_STATUS 新状态,详见定义AUDIO_STATUS

micEnergyUpdate:oldLevel:newLevel:

- (void)micEnergyUpdate:(NSString *)userID oldLevel:(int)oldLevel newLevel:(int)newLevel

  • 功能: 通知用户的说话声音强度更新

  • 返回值: 无

参数 类型 含义
userID NSString 用户标识ID
oldLevel int 原来的说话声音强度(0~10)
newLevel int 现在的说话声音强度(0~10)

openVideoRslt:success:

- (void)openVideoRslt:(NSString *)devID success:(BOOL)bSuccess

  • 功能: 打开摄像头设备操作结果

  • 返回值: 无

参数 类型 含义
devID NSString 摄像头设备ID
bSuccess BOOL 是否成功

videoStatusChanged:oldStatus:newStatus:

- (void)videoStatusChanged:(NSString *)userID oldStatus:(VIDEO_STATUS)oldStatus newStatus:(VIDEO_STATUS)newStatus

  • 功能: 视频状态变化

  • 返回值: 无

参数 类型 含义
userID NSString 房间中设备的所有者
oldStatus VSTATUS 详见定义VSTATUS
newStatus VSTATUS 新状态,详见定义VSTATUS

videoDevChanged:

- (void)videoDevChanged:(NSString *)userID

  • 功能: 通知用户的视频设备有变化

  • 返回值: 无

参数 类型 含义
userID NSString 设备变化的用户ID

defVideoChanged:

- (void)defVideoChanged:(NSString *)userID videoID:(short)videoID

  • 功能: 本地默认视频设备变化回调

  • 返回值: 无

参数 类型 含义
userID NSString 设备变化的用户ID
videoID short 设备变化的摄像头设备ID

notifyVideoData:frameTime:

- (void)notifyVideoData:(UsrVideoId *)userID frameTime:(long)frameTime

  • 功能: 通知用户有新的视频数据

  • 返回值: 无

参数 类型 含义
usrVideoID UsrVideoId 用户摄像头标识ID,详见定义UsrVideoId
frmTime long 图像的创建时间,可用作时间戳
  • 注意事项:

  • 收到此通知消息后,可通过getVideoImg获取图像显示;如果之前显示的帧时间和此值一致,说明此帧已显示过,直接忽略即可 如果使用了成员视频UI显示组件,不再需要自已关注此事件并进行显示处理

videoDevChanged:videoID:

- (void)videoDevChanged:(NSString *)userID videoID:(short)videoID

  • 功能: 通知用户的视频默认设备有变化

  • 返回值: 无

参数 类型 含义
userID NSString 设备变化的用户ID
videoID short 默认设备id

locMixerStateChanged:state:

- (void)locMixerStateChanged:(NSString*)mixerID state:(MIXER_STATE)state

  • 功能: 本地混图器状态变化通知

  • 返回值: 无

参数 类型 含义
mixerID NSString 混图器唯一标识
state MIXER_STATE 状态,详见定义MIXER_STATE

locMixerOutputInfo:nameUrl:outputInfo:

- (void)locMixerOutputInfo:(NSString*)mixerID nameUrl:(NSString*)nameUrl outputInfo:(OutputInfo*)outputInfo

  • 功能: 本地录制文件、本地直播信息通知

  • 返回值: 无

参数 类型 含义
mixerID NSString 混图器唯一标识
nameOrUrl NSString 录像名称、或直播url
outputInfo NSString 详见定义OutputInfo

createCloudMixerFailed:err:

- (void)createCloudMixerFailed:(NSString *)mixerID err:(CRVIDEOSDK_ERR_DEF)err

  • 功能: 启动云端录制、云端直播失败通知

  • 返回值: 无

参数 类型 含义
mixerID NSString 混图器唯一标识
err CRVIDEOSDK_ERR_DEF 状态,详见定义CRVIDEOSDK_ERR_DEF

cloudMixerStateChanged:mixerID:state:exParam:

- (void)cloudMixerStateChanged:(NSString *)operatorID mixerID:(NSString *)mixerID state:(MIXER_STATE)state exParam:(NSString *)exParam

  • 功能: 云端录制、云端直播状态变化通知

  • 返回值: 无

参数 类型 含义
operatorID NSString 引起变化的用户id
mixerID NSString 混图器唯一标识
state MIXER_STATE 状态值,请参考MIXER_STATE
exParam NSString json格式扩展参数,state状态及参数定义:
MIXER_NULL:包含err(CRVIDEOSDK_ERR_DEF), errDesc字段;
MIXER_STARTING:包含jsonCfg字段

cloudMixerInfoChanged:

- (void)cloudMixerInfoChanged:(NSString *)mixerID

  • 功能: 通知云端录制/推流信息变化

  • 返回值: 无

可调用:getCloudMixerInfo获取相关信息

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

cloudMixerOutputInfoChanged:jsonStr:

- (void)cloudMixerOutputInfoChanged:(NSString *)mixerID jsonStr:(NSString *)jsonStr

  • 功能: 通知云端录制/推流输出信息

  • 返回值: 无

参数 类型 含义
mixerID NSString 混图器ID
jsonStr NSString 通知内容,详见定义OutputInfo

startScreenShareRslt:

- (void)startScreenShareRslt:(CRVIDEOSDK_ERR_DEF)sdkErr

  • 功能: 开启屏幕共享的响应事件
  • 参数:
参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 错误码

stopScreenShareRslt:

- (void)stopScreenShareRslt:(CRVIDEOSDK_ERR_DEF)sdkErr

  • 功能停止屏幕共享的响应事件
  • 参数:
参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 错误码

notifyScreenShareStarted:

- (void)notifyScreenShareStarted:(NSString *)shareId

  • 功能: 通知他人开启了屏幕共享

  • 返回值: 无

  • 参数:

参数 类型 含义
shareId NSString 共享者的userID

notifyScreenShareStopped:

- (void)notifyScreenShareStopped:(NSString *)oprUserID

  • 功能: 通知他人停止了屏幕共享

  • 返回值: 无

  • 参数:

参数 类型 含义
oprUserID NSString 操作者的userID

startScreenMarkRslt:

- (void)startScreenMarkRslt:(CRVIDEOSDK_ERR_DEF)sdkErr

  • 功能: 开始屏幕标注结果
  • 参数:
参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 错误码

stopScreenMarkRslt:

- (void)stopScreenMarkRslt:(CRVIDEOSDK_ERR_DEF)sdkErr

  • 功能: 停止屏幕标注结果
  • 参数:
参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 错误码

notifyScreenMarkStarted

- (void)notifyScreenMarkStarted

  • 功能: 通知屏幕标注开始

  • 返回值: 无

notifyScreenMarkStopped

- (void)notifyScreenMarkStopped

  • 功能: 通知屏幕标注停止

  • 返回值: 无

notifyIMmsg:text:sendTime:

- (void)notifyIMmsg:(NSString *)fromUserID text:(NSString *)text sendTime:(int)sendTime

  • 功能: 通知收到IM消息

  • 返回值: 无

参数 类型 含义
fromUserID NSString 消息来源
text NSString 消息内容
sendTime NSString 消息发送时间戳,从1970开始算起

notifyMediaOpened:size:

- (void)notifyMediaOpened:(long)totalTime size:(CGSize)picSZ

  • 功能: 通知影音文件打开

  • 返回值: 无

参数 类型 含义
totalTime long 影音时长(毫秒)
picSZ CGSize 宽高

notifyMediaStart:

- (void)notifyMediaStart:(NSString *)userid

  • 功能: 通知影音开始播放

  • 返回值: 无

参数 类型 含义
userid NSString 操作者的用户id

notifyMediaPause:bPause:

- (void)notifyMediaPause:(NSString *)userid bPause:(BOOL)bPause

  • 功能: 通知设置鼠标热点消息

  • 返回值: 无

参数 类型 含义
userid NSString 操作者的用户id
bPause BOOL 是否暂停,1暂停,0播放

notifyMediaStop:reason:

- (void)notifyMediaStop:(NSString *)userid reason:(MEDIA_STOP_REASON)reason

  • 功能: 通知影音播放停止

  • 返回值: 无

参数 类型 含义
userid NSString 操作者的用户id
reason MEDIA_STOP_REASON 播放停止原因,数值参考MEDIA_STOP_REASON

notifyPlayPosSetted:

- (void)notifyPlayPosSetted:(int)setPTS

  • 功能: 通知播放进度已设置完成

  • 返回值: 无

参数 类型 含义
setPTS int 播放进度

notifyMemberMediaData:curPos:

- (void)notifyMemberMediaData:(NSString *)userid curPos:(int)curPos

  • 功能: 通知影音帧数据已解码完毕

  • 返回值: 无

参数 类型 含义
userid NSString 操作者的用户id
curPos int 该影音帧的时间,毫秒为单位
  • 注意事项:

  • 收到此通知消息后,可通过getMediaImg获取图像显示;但如果之前显示的帧时戳更大,说明此通知消息已过时,直接忽略即可 如果使用了影音共享UI显示方式,不再需要自已关注此事件和进行显示处理

audioPCMData:audioDat:

- (void)audioPCMData:(int)aSide audioDat:(NSData*)audioDat

  • 功能: 通知语音PCM数据

  • 返回值: 无

参数 类型 含义
aSide int 声道类型
audioDat NSData PCM数据

队列组件(RTCQueue)

队列组件(RTCQueue)

RTCQueue 是队列组件,实现队列功能,目的是为了实现用户自动分配。,整个程序的生命过程中只能有一个实例。


setQueueCallback:

- (void)setQueueCallback:(id)callBack

  • 功能: 注册监听回调

  • 返回值: 无

参数 类型 含义
callBack id 回调对象

removeQueueCallback:

- (void)removeQueueCallback:(id)callBack

  • 功能: 反注册监听回调

  • 返回值: 无

参数 类型 含义
callBack RTCQueueCallback 指定的反注册回调对象

initQueueDat:

- (void)initQueueDat:(NSString *)cookie

  • 功能: 初始化用户队列功能数据

  • 返回值: 无

回调函数initQueueDatRslt

参数 类型 含义
cookie NSString 自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 注意事项:

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

refreshAllQueueStatus

- (void)refreshAllQueueStatus

  • 功能: 刷新所有队列状态信息

  • 返回值: 无

回调函数queueStatusChanged

  • 注意事项:

  • 当前排队的队列或服务的队列,sdk自动有状态变化回调;其它队列则需要此函数来查询

getAllQueueInfo

ArrayList<QueueInfo> getAllQueueInfo()

  • 功能: 获取队列信息

  • 返回值: 队列信息列表,详见定义QueueInfo

getQueueStatus:

- (QueueStatus *)getQueueStatus:(int)queID

  • 功能: 获取指定取队列状态

  • 返回值: 队列状态,详见定义QueueStatus

参数 类型 含义
queID int 队列ID

getQueuingInfo

- (QueuingInfo *)getQueuingInfo

  • 功能: 功能获取我的排队信息

  • 返回值: 我的排队信息,详见定义QueuingInfo

getServiceQueues

- (NSMutableArray <NSNumber *> *)getServiceQueues

  • 功能: 获取我服务的所有队列

  • 返回值: 队列ID列表

getSessionInfo

- (VideoSessionInfo *)getSessionInfo

  • 功能: 获取我的会话信息

  • 返回值: 我的会话信息,详见定义VideoSessionInfo

startQueuing:usrExtDat:cookie:

- (void)startQueuing:(int)queID usrExtDat:(NSString *)usrExtDat cookie:(NSString *)cookie

  • 功能: 客户开始排队

  • 返回值: 无

回调函数startQueuingRslt

参数 类型 含义
queID int 排队的队列ID
usrExtDat NSString 用户排队扩展数据
cookie NSString 用户自定义数据(在响应消息中回传给调用者),不需要时传空字符串

stopQueuing:

- (void)stopQueuing:(NSString *)cookie

  • 功能: 客户停止排队

  • 返回值: 无

回调函数stopQueuingRslt

参数 类型 含义
cookie NSString 用户自定义数据(在响应消息中回传给调用者),不需要时传空字符串

startService:cookie:

- (void)startService:(int)queID cookie:(NSString *)cookie

  • 功能: 开始服务某个队列(可以多次调用,开启对多个队列的服务)

  • 返回值: 无

回调函数startServiceRslt

参数 类型 含义
queID int 排队的队列ID
cookie NSString 用户自定义数据(在响应消息中回传给调用者),不需要时传空字符串

startService:priority:cookie:

- (void)startService:(int)queID priority:(int)priority cookie:(NSString *)cookie

  • 功能: 开始服务某个队列(可以多次调用,开启对多个队列的服务)

  • 返回值: 无

回调函数startServiceRslt

参数 类型 含义
queID int 排队的队列ID
priority int 座席优先级(缺省为0, 0为最高优先级, 值越大优先级越低)
cookie NSString 用户自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 注意事项:

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

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

  • 座席优先级描述

  • 座席优先级只在服务的队列内部有效;

  • 客户优先分配给服务此队列优先级最高的,且空闲的座席;

  • 优先级相同时,则分配给最先空闲的座席;

  • 优先级高的座席变空闲时,不抢夺已分配的客户;

stopService:cookie:

- (void)stopService:(int)queID cookie:(NSString *)cookie

  • 功能: 停止服务某个队列

  • 返回值: 无

回调函数stopServiceRslt

参数 类型 含义
queID int 排队的队列ID
cookie NSString 用户自定义数据(在响应消息中回传给调用者),不需要时传空字符串

reqAssignUser:

- (void)reqAssignUser:(NSString *)cookie

  • 功能: 请求分配一个客户

  • 返回值: 无

回调函数reqAssignUserRslt

参数 类型 含义
cookie NSString 用户自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 注意事项:

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

acceptAssignUser:userID:cookie:

- (void)acceptAssignUser:(int)queID userID:(NSString *)userID cookie:(NSString *)cookie

  • 功能: 接受系统安排的客户

  • 返回值: 无

回调函数reqAssignUserRslt

参数 类型 含义
queID int 排队的队列ID
userID NSString 队列中的用户ID
cookie NSString 用户自定义数据(在响应消息中回传给调用者),不需要时传空字符串

rejectAssignUser:userID:cookie:

- (void)rejectAssignUser:(int)queID userID:(NSString *)userID cookie:(NSString *)cookie

  • 功能: 拒绝系统安排的客户

  • 返回值: 无

回调函数reqAssignUserRslt

参数 类型 含义
queID int 排队的队列ID
userID NSString 队列中的用户ID
cookie NSString 用户自定义数据(在响应消息中回传给调用者),不需要时传空字符串

通知回调函数

RTCQueueCallback 是队列回调接口


initQueueDatRslt:cookie:

- (void)initQueueDatRslt:(CRVIDEOSDK_ERR_DEF)errCode cookie:(NSString *)cookie

  • 功能: 队列初始化操作结果

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,成功为CRVIDEOSDK_NOERR,其他详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 用户自定义数据(在响应消息中回传给调用者),不需要时传空字符串

queueStatusChanged:

- (void)queueStatusChanged:(QueueStatus *)queStatus

  • 功能: 队列状态变化通知

  • 返回值: 无

参数 类型 含义
queStatus QueueStatus 新的队列状态,详见定义QueueStatus
  • 注意事项:

  • 在排队的队列、或服务的队列发生变化时,将有队列状态变化通知到来
  • 在调用refreshAllQueueStatus时,查询到的队列数据有变化时,会有通知到来

queuingInfoChanged:

- (void)queuingInfoChanged:(QueuingInfo *)queuingInfo

  • 功能: 排队信息变化通知

  • 返回值: 无

参数 类型 含义
queuingInfo QueuingInfo 排队信息,详见定义QueuingInfo

startQueuingRslt:cookie:

- (void)startQueuingRslt:(CRVIDEOSDK_ERR_DEF)errCode cookie:(NSString *)cookie

  • 功能: 开始排队操作结果

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,CRVIDEOSDK_NOERR为成功操作,其他详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 用户自定义数据(在响应消息中回传给调用者),不需要时传空字符串

stopQueuingRslt:cookie:

- (void)stopQueuingRslt:(CRVIDEOSDK_ERR_DEF)errCode cookie:(NSString *)cookie

  • 功能: 停止排队操作结果

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,CRVIDEOSDK_NOERR为成功操作,其他详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 用户自定义数据(在响应消息中回传给调用者),不需要时传空字符串

startServiceRslt:errCode:cookie:

- (void)startServiceRslt:(int)queID errCode:(CRVIDEOSDK_ERR_DEF)errCode cookie:(NSString *)cookie

  • 功能: 开始服务队列操作结果

  • 返回值: 无

参数 类型 含义
queID int 排队的队列ID
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,CRVIDEOSDK_NOERR为成功操作,其他详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 用户自定义数据(在响应消息中回传给调用者),不需要时传空字符串

stopServiceRslt:errCode:cookie:

- (void)stopServiceRslt:(int)queID errCode:(CRVIDEOSDK_ERR_DEF)errCode cookie:(NSString *)cookie

  • 功能: 停止服务队列操作结果

  • 返回值: 无

参数 类型 含义
queID int 排队的队列ID
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,CRVIDEOSDK_NOERR为成功操作,其他详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 用户自定义数据(在响应消息中回传给调用者),不需要时传空字符串

reqAssignUserRslt:userInfo:cookie:

- (void)reqAssignUserRslt:(CRVIDEOSDK_ERR_DEF)errCode userInfo:(UserInfo *)usr cookie:(NSString *)cookie

  • 功能: 停止服务队列操作结果

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,CRVIDEOSDK_NOERR为成功操作,其他详见定义CRVIDEOSDK_ERR_DEF
usr UserInfo 请求到的队列用户,结构详见定义UserInfo
cookie NSString 用户自定义数据(在响应消息中回传给调用者),不需要时传空字符串

autoAssignUser:

- (void)autoAssignUser:(UserInfo *)usr

  • 功能: 队列系统自动分配客户

  • 返回值: 无

参数 类型 含义
usr UserInfo 请求到的队列用户,结构详见定义UserInfo
  • 注意事项:

  • 如果想停止系统的自动分配,请调用RTCMgr中的 setDNDStatus 设置免打扰功能。

cancelAssignUser:usrID:

- (void)cancelAssignUser:(int)queID usrID:(NSString *)usrID

  • 功能: 队列系统取消之前自动分配的的客户

  • 返回值: 无

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

responseAssignUserRslt:cookie:

- (void)responseAssignUserRslt:(CRVIDEOSDK_ERR_DEF)errCode cookie:(NSString *)cookie

  • 功能: 拒绝、接受分配的用户

  • 返回值: 无

参数 类型 含义
sdkErr CRVIDEOSDK_ERR_DEF 操作结果代码,CRVIDEOSDK_NOERR为成功操作,其他详见定义CRVIDEOSDK_ERR_DEF
cookie NSString 用户自定义数据(在响应消息中回传给调用者),不需要时传空字符串
  • 注意事项:

  • 队列系统通过接口autoAssignUser给开始队列服务的人自动推送用户,收到系统分配的用户后,
    如果队列服务者还未决定接受acceptAssignUser还是拒绝rejectAssignUser推送的用户,系统可用取消本次推送,
    并通过本接口通知队列服务者。

房间属性接口

房间属性接口

getMeetingAllAttrs:

- (void)getMeetingAllAttrs:(NSString *)cookie

  • 功能:获取房间所有属性

  • 返回值:无

getMeetingAttrs:cookie:

- (void)getMeetingAttrs:(NSArray<NSString *> *)keys cookie:(NSString *)cookie

  • 功能:获取房间部份属性

  • 返回值:无

  • 参数:

参数 类型 含义
keys NSString 需要查询的房间属性key,json格式,如:["key1", "key2"]

setMeetingAttrs:options:cookie:

- (void)setMeetingAttrs:(NSDictionary *)attrs options:(NSDictionary *)options cookie:(NSString *)cookie

  • 功能:重置房间属性集

  • 返回值:无

  • 参数:

参数 类型 含义
attrs NSString 房间属性集,json格式,如:{"key1":"value1", "key2":"value2"} (key最大长度为64B,value最大长度为8KB)
options NSString 操作选项,json格式参见MeetingAttrOptions

addOrUpdateMeetingAttrs:options:cookie:

- (void)addOrUpdateMeetingAttrs:(NSDictionary *)attrs options:(NSDictionary *)options cookie:(NSString *)cookie

  • 功能:增加或者更新房间属性

  • 返回值:无

  • 参数:

参数 类型 含义
attrs NSString 房间属性集,json格式,如:{"key1":"value1", "key2":"value2"} (key最大长度为64B,value最大长度为8KB)
options NSString 操作选项,json格式参见MeetingAttrOptions

delMeetingAttrs:options:cookie:

- (void)delMeetingAttrs:(NSArray<NSString *> *)keys options:(NSDictionary *)options cookie:(NSString *)cookie

  • 功能:删除房间属性

  • 返回值:无

  • 参数:

参数 类型 含义
keys NSString 需要删除的房间属性key,json格式,如["key1","key2"]
options NSString 操作选项,json格式参见MeetingAttrOptions

clearMeetingAttrs:options:cookie:

- (void)clearMeetingAttrs:(NSString *)options cookie:(NSString *)cookie

  • 功能:清除房间所有属性

  • 返回值:无

  • 参数:

参数 类型 含义
options NSString 操作选项,json格式参见MeetingAttrOptions

getUserAttrs:keys:cookie:

- (void)getUserAttrs:(NSArray<NSString *>*)userIDs keys:(NSArray<NSString *> *)keys cookie:(NSString *)cookie

  • 功能:获取指定用户的指定属性

  • 返回值:无

  • 参数:

参数 类型 含义
userIDs NSString 目标用户id列表,一次最多包含50个用户,json格式, 如:["userID1","userID2"]
keys NSString 将要获取的用户属性key列表(空串代表获取全部),json格式,如:["key1","key2"]

setUserAttrs:attrs:options:cookie:

- (void)setUserAttrs:(NSString*)userID attrs:(NSDictionary *)attrs options:(NSDictionary *)options cookie:(NSString *)cookie

  • 功能:重置用户属性

  • 返回值:无

  • 参数:

参数 类型 含义
userID NSString 目标用户id
attrs NSString 用户属性集, json格式,如:{"key1":"value1", "key2":"value2"} (key最大长度为64B,value最大长度为8KB)
options NSString 操作选项,json格式参见MeetingAttrOptions

addOrUpdateUserAttrs:attrs:options:cookie:

- (void)addOrUpdateUserAttrs:(NSString*)userID attrs:(NSDictionary *)attrs options:(NSDictionary *)options cookie:(NSString *)cookie

  • 功能:增加或更新用户属性

  • 返回值:无

  • 参数:

参数 类型 含义
userID NSString 目标用户id
attrs NSString 用户属性集, json格式,如:{"key1":"value1", "key2":"value2"} (key最大长度为64B,value最大长度为8KB)
options NSString 操作选项,json格式参见MeetingAttrOptions

delUserAttrs:keys:options:cookie:

- (void)delUserAttrs:(NSString*)userID keys:(NSArray<NSString *>*)keys options:(NSDictionary*)options cookie:(NSString*)cookie

  • 功能:删除用户的特定属性

  • 返回值:无

  • 参数:
参数 类型 含义
userID NSString 目标用户id
keys NSString 需要删除的用户属性key列表,json格式,如:["key1","key2"]
options NSString 操作选项,json格式参见MeetingAttrOptions

clearAllUserAttrs:options:cookie:

- (void)clearAllUserAttrs:(NSDictionary*)options cookie:(NSString*)cookie

  • 功能:清除所有用户的所有属性

  • 返回值:无

  • 参数:

参数 类型 含义
options NSString 操作选项,json格式参见MeetingAttrOptions

clearUserAttrs:options:cookie:

- (void)clearUserAttrs:(NSString*)userID options:(NSString*)options cookie:(NSString*)cookie

  • 功能:清除特定用户的所有属性

  • 返回值:无

  • 参数:

参数 类型 含义
userID NSString 目标用户id
options NSString 操作选项,json格式参见MeetingAttrOptions

sendMeetingCustomMsg:cookie:

- (void)sendMeetingCustomMsg:(NSString *)text cookie:(NSString *)cookie

  • 功能:发送房间内自定义广播消息

  • 返回值:无

  • 参数:

参数 类型 含义
msg NSString 用户自定义消息(最大8KB)

getMeetingAllAttrsSuccess:cookie:

- (void)getMeetingAllAttrsSuccess:(MeetingAttrs*)attrSeq cookie:(NSString *)cookie

  • 功能:成功获取到房间所有属性

  • 参数:

参数 类型 含义
attrs NSString 房间属性集,json结构体请参见MeetingAttrObjs

getMeetingAllAttrsFail:cookie:

- (void)getMeetingAllAttrsFail:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能:获取房间属性失败

  • 参数:

参数 类型 含义
err int 错误码(错误码为CRVIDEOSDK_NOERR表示没有错误)

getMeetingAttrsSuccess:cookie:

- (void)getMeetingAttrsSuccess:(NSString *)attrs cookie:(NSString *)cookie

  • 功能:成功获取到房间指定属性

  • 参数:

参数 类型 含义
attrs NSString 房间属性集,json结构体请参见MeetingAttrObjs

getMeetingAttrsFail:cookie:

- (void)getMeetingAttrsFail:(int)err cookie:(NSString *)cookie

  • 功能:获取房间指定属性失败

  • 参数:

参数 类型 含义
err int 错误码(错误码为CRVIDEOSDK_NOERR表示没有错误)

resetMeetingAttrsRslt:cookie:

- (void)resetMeetingAttrsRslt:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能:设置用户属性结果

  • 参数:

参数 类型 含义
err int 错误码(错误码为CRVIDEOSDK_NOERR表示没有错误)

addOrUpdateMeetingAttrsRslt:cookie:

- (void)addOrUpdateMeetingAttrsRslt:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能:增加或更新房间属性结果

  • 参数:

参数 类型 含义
err int 错误码(错误码为CRVIDEOSDK_NOERR表示没有错误)

delMeetingAttrsRslt:cookie:

- (void)delMeetingAttrsRslt:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能:删除房间属性结果

  • 参数:

参数 类型 含义
err int 错误码(错误码为CRVIDEOSDK_NOERR表示没有错误)

clearMeetingAttrsRslt:cookie:

- (void)clearMeetingAttrsRslt:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能:清除房间属性结果

  • 参数:

参数 类型 含义
err int 错误码(错误码为CRVIDEOSDK_NOERR表示没有错误)

getUserAttrsSuccess:cookie:

- (void)getUserAttrsSuccess:(UsrMeetingAttrs*)attrMap cookie:(NSString *)cookie

  • 功能:获取房间内用户属性结果
  • 参数:
参数 类型 含义
attrsMap NSString 房间属性,json结构体请参见UsrAttrObjs

getUserAttrsFail:cookie:

- (void)getUserAttrsFail:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能:获取房间内用户属性失败

  • 参数:

参数 类型 含义
err int 错误码(错误码为CRVIDEOSDK_NOERR表示没有错误)

setUserAttrsRslt:cookie:

- (void)setUserAttrsRslt:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能:设置用户属性结果
  • 参数:
参数 类型 含义
err int 错误码(错误码为CRVIDEOSDK_NOERR表示没有错误)

addOrUpdateUserAttrsRslt:cookie:

- (void)addOrUpdateUserAttrsRslt:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能:增加或者更新用户属性结果

  • 参数:

参数 类型 含义
err int 错误码(错误码为CRVIDEOSDK_NOERR表示没有错误)

delUserAttrsRslt:cookie:

- (void)delUserAttrsRslt:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能:删除特定用户属性结果

  • 参数:

参数 类型 含义
err int 错误码(错误码为CRVIDEOSDK_NOERR表示没有错误)

clearAllUserAttrsRslt:cookie:

- (void)clearAllUserAttrsRslt:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能:清除所有用户属性结果

  • 参数:

参数 类型 含义
err int 错误码(错误码为CRVIDEOSDK_NOERR表示没有错误)

clearUserAttrsRslt:cookie:

- (void)clearUserAttrsRslt:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能:清除特定用户属性结果

  • 参数:

参数 类型 含义
err int 错误码(错误码为CRVIDEOSDK_NOERR表示没有错误)

notifyMeetingAttrsChanged:updates:delKeys:

- (void)notifyMeetingAttrsChanged:(MeetingAttrs*)adds updates:(MeetingAttrs*)updates delKeys:(NSMutableArray<NSString *>*)delKeys

  • 功能:通知房间属性发生改变

  • 参数:

参数 类型 含义
adds NSString 增加房间属性集,json结构体请参见MeetingAttrObjs
updates NSString 变化的房间属性集,json结构体请参见MeetingAttrObjs
delKeys NSString 被删除的房间属性列表,json格式,如:["key1", "key2"]

notifyUserAttrsChanged:adds:updates:delKeys:

- (void)notifyUserAttrsChanged:(NSString*)userID adds:(MeetingAttrs*)adds updates:(MeetingAttrs*)updates delKeys:(NSMutableArray<NSString *>*)delKeys

  • 功能:通知用户属性发生改变

  • 参数:

参数 类型 含义
userID NSString 变化的用户id
adds NSString 增加的用户属性集,json结构体请参见MeetingAttrObjs
updates NSString 变化的用户属性集,json结构体请参见MeetingAttrObjs
delKeys NSString 被删除的用户属性列表,json格式,如:["key1", "key2"]

sendMeetingCustomMsgRslt:cookie:

- (void)sendMeetingCustomMsgRslt:(int)err cookie:(NSString *)cookie

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

  • 参数:

参数 类型 含义
err int 错误码(错误码为CRVIDEOSDK_NOERR表示没有错误)

notifyMeetingCustomMsg:jsonDat:

- (void)notifyMeetingCustomMsg:(NSString *)userID jsonDat:(NSString *)jsonDat

  • 功能:通知收到房间内自定义广播消息

  • 参数:

参数 类型 含义
userID NSString 房间内广播消息的发送者的用户id
jsonDat NSString 广播内容

inviteSuccess:cookie:

- (void)inviteSuccess:(NSString *)inviteID cookie:(NSString *)cookie

  • 功能:发送邀请成功

  • 参数:

参数 类型 含义
inviteID NSString 邀请ID
cookie NSString 详细介绍见关键词

inviteFail:sdkErr:cookie:

- (void)inviteFail:(NSString *)inviteID sdkErr:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能:发送邀请失败

  • 参数:

参数 类型 含义
inviteID NSString 邀请ID
sdkErr int 操作失败代码,定义见ERR_DEF
cookie NSString 详细介绍见关键词

cancelInviteSuccess:cookie:

- (void)cancelInviteSuccess:(NSString *)inviteID cookie:(NSString *)cookie

  • 功能:取消自己发送的邀请成功

  • 参数:

参数 类型 含义
inviteID NSString 邀请ID
cookie NSString 详细介绍见关键词

cancelInviteFail:sdkErr:cookie:

- (void)cancelInviteFail:(NSString *)inviteID sdkErr:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能:取消自己发送的邀请失败

  • 参数:

参数 类型 含义
inviteID NSString 邀请ID
sdkErr int 操作失败代码,定义见ERR_DEF
cookie NSString 详细介绍见关键词

acceptInviteSuccess:cookie:

- (void)acceptInviteSuccess:(NSString *)inviteID cookie:(NSString *)cookie

  • 功能:接受对方的邀请成功

  • 参数:

参数 类型 含义
inviteID NSString 邀请ID
cookie NSString 详细介绍见关键词

acceptInviteFail:sdkErr:cookie:

- (void)acceptInviteFail:(NSString *)inviteID sdkErr:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能:接受对方的邀请失败

  • 参数:

参数 类型 含义
inviteID NSString 邀请ID
sdkErr int 操作失败代码,定义见ERR_DEF
cookie NSString 详细介绍见关键词

rejectInviteSuccess:cookie:

- (void)rejectInviteSuccess:(NSString *)inviteID cookie:(NSString *)cookie

  • 功能:拒绝对方的邀请成功

  • 参数:

参数 类型 含义
inviteID NSString 邀请ID
cookie NSString 详细介绍见关键词

rejectInviteFail:sdkErr:cookie:

- (void)rejectInviteFail:(NSString *)inviteID sdkErr:(CRVIDEOSDK_ERR_DEF)sdkErr cookie:(NSString *)cookie

  • 功能:拒绝对方的邀请失败

  • 参数:

参数 类型 含义
inviteID NSString 邀请ID
sdkErr int 操作失败代码,定义见ERR_DEF
cookie NSString 详细介绍见关键词

notifyInviteIn:inviterUsrID:usrExtDat:

- (void)notifyInviteIn:(NSString *)inviteID inviterUsrID:(NSString*)inviterUsrID usrExtDat:(NSString *)usrExtDat

  • 功能:通知有人邀请

  • 参数:

参数 类型 含义
inviteID NSString 邀请ID
inviterUsrID NSString 邀请者用户ID
usrExtDat NSString 用户扩展数据

notifyInviteAccepted:usrExtDat:

- (void)notifyInviteAccepted:(NSString *)inviteID usrExtDat:(NSString *)usrExtDat

  • 功能:通知邀请被接受

  • 参数:

参数 类型 含义
inviteID NSString 邀请ID
usrExtDat NSString 用户扩展数据

notifyInviteRejected:reason:usrExtDat:

- (void)notifyInviteRejected:(NSString *)inviteID reason:(CRVIDEOSDK_ERR_DEF)reason usrExtDat:(NSString *)usrExtDat

  • 功能:通知邀请被拒绝

  • 参数:

参数 类型 含义
inviteID NSString 邀请ID
reason int 邀请被拒绝原因,定义见ERR_DEF
usrExtDat NSString 用户扩展数据

notifyInviteCanceled:reason:usrExtDat:

- (void)notifyInviteCanceled:(NSString *)inviteID reason:(CRVIDEOSDK_ERR_DEF)reason usrExtDat:(NSString *)usrExtDat

  • 功能:通知邀请被取消

  • 参数:

参数 类型 含义
inviteID NSString 邀请ID
reason int 邀请被取消原因,定义见ERR_DEF
usrExtDat NSString 用户扩展数据

音频监测器回调

音频监测器回调函数

音频帧观测器对象;
不能进行耗时处理,将会影响声音的流畅性;


setAudioFrameObserver:

- (void)setAudioFrameObserver:(id<CRAudioFrameCallBack>)callback

  • 功能: 设置音频数据回调,传入nil移除回调

  • 返回值: 无

参数 类型 含义
callBack id 回调对象

onRecordAudioFrame:

- (void)onRecordAudioFrame:(AudioFrame *)frm

  • 功能:采集的原始音频数据。在子线程回调,需要注意线程安全。

  • 返回值:无

  • 参数:

参数 类型 含义
frm AudioFrame 声音数据,可被修改

onPlaybackAudioFrame:

- (void)onPlaybackAudioFrame:(AudioFrame *)frm

  • 功能:播放的原始音频数据。在子线程回调,需要注意线程安全。

  • 返回值:无

  • 参数:

参数 类型 含义
frm AudioFrame 声音数据,可被修改

onPlaybackAudioFrameBeforeMixing:frm:

onPlaybackAudioFrameBeforeMixing:(NSString *)userId frm:(AudioFrame *)frm

  • 功能:用户的混音前原始音频数据。在子线程回调,需要注意线程安全。

  • 返回值:无

  • 参数:

参数 类型 含义
userID NSString* 用户ID, 参见LoginDat的nickName字段
frm AudioFrame 声音数据,可被修改

onMixedAudioFrame:

onMixedAudioFrame:(AudioFrame *)frm

  • 功能:采集+播放混音后数据。在子线程回调,需要注意线程安全。

  • 返回值:无

  • 参数:

参数 类型 含义
frm AudioFrame 声音数据,可被修改

notifySetVoiceChange:type:oprUserID:

- (void)notifySetVoiceChange:(NSString *)userID type:(int)type oprUserID:(NSString *)oprUserID

  • 功能:通知被设置变声(type=0即不变声)

  • 返回值:无

  • 参数:

参数 类型 含义
userID NSString 用户ID
type int 变声类型,见CRVOICECHANGE_TYPE
oprUserID NSString 操作者ID

notifyEchoTestState:

- (void)notifyEchoTestState:(bool)bTesting

  • 功能:通知环回测试状态变化

  • 返回值:无

  • 参数:

参数 类型 含义
bTesting bool 是否在测试