JRTCSDK-iOS v2401.0
视频客服 API 文档
载入中...
搜索中...
未找到
构造函数 | 所有成员列表
<JRTCClientCallback>协议 参考
基础模块

构造函数

(void) - onLogin:reason:
 
(void) - onLogout:
 
(void) - onClientStateChanged:oldState:
 
(void) - onOnlineMessageSendResult:operatorId:
 
(void) - onOnlineMessageReceived:userId:
 
(void) - onSDKEvent:
 
(void) - onP2PSessionCreate:result:
 
(void) - onP2PSessionConnect:result:
 
(void) - onP2PSessionClose:
 
(void) - onP2PMessageReceived:receiveMsg:
 
(void) - onGetUploadUrlResponse:token:url:fileId:offset:
 
(void) - onRequestFileUploadInfoResponse:result:url:token:requestTimestamp:extraInfo:fileSize:offset:fileType:serverOid:reason:
 
(void) - onCompleteFileUploadResponse:result:fileName:extraInfo:fileType:reason:
 
(void) - onGetUploadFileInfoResponse:result:uploadFileInfoArray:extraInfo:reason:
 
(void) - onFileUploadPlatformNotify:serialId:uploadFileInfo:
 

函数文档

◆ onClientStateChanged:oldState:

- (void) onClientStateChanged: (JRTCClientState)  state
oldState: (JRTCClientState)  oldState 

登录状态变化通知

参数
state当前状态值
oldState之前状态值

◆ onCompleteFileUploadResponse:result:fileName:extraInfo:fileType:reason:

- (void) onCompleteFileUploadResponse: (int)  operatorId
result: (BOOL)  result
fileName: (NSString *)  fileName
extraInfo: (NSString *)  extraInfo
fileType: (NSString *)  fileType
reason: (NSString *)  reason 

文件上传完成确认响应

参数
operatorId操作id，对应 completeFileUpload 的返回值
result请求是否成功
  • true： 请求成功
  • false：请求失败
fileName服务器合并后的文件名
extraInfo随路参数
fileType文件类型
reason请求失败原因描述，当 result 为 false 时有效

◆ onFileUploadPlatformNotify:serialId:uploadFileInfo:

- (void) onFileUploadPlatformNotify: (bool)  result
serialId: (NSString *)  serialId
uploadFileInfo: (JRTCUploadFileInfo *)  uploadFileInfo 

文件上传到影像平台结果通知

注解
服务端录制文件或者本地录制文件上传到影像平台后，都会通过该接口回调通知
参数
result上传是否成功
  • true：上传成功
  • false：上传失败
serialId业务id，如果是通话业务相关文件，对应的是 callId
uploadFileInfo文件信息对象

◆ onGetUploadFileInfoResponse:result:uploadFileInfoArray:extraInfo:reason:

- (void) onGetUploadFileInfoResponse: (int)  operatorId
result: (bool)  result
uploadFileInfoArray: (NSArray< JRTCUploadFileInfo * > *)  uploadFileInfoArray
extraInfo: (NSString *)  extraInfo
reason: (NSString *)  reason 

获取上传文件信息列表响应

参数
operatorId操作id，对应 getUploadFileInfo 的返回值
result请求是否成功
  • true：请求成功
  • false：请求失败
uploadFileInfoList文件信息对象列表，当 result 为 true 时有效
extraInfo随路参数，当 result 为 true 时有效
reason请求失败原因描述，当 result 为 false 时有效

◆ onGetUploadUrlResponse:token:url:fileId:offset:

- (void) onGetUploadUrlResponse: (bool)  result
token: (NSString *)  token
url: (NSString *)  url
fileId: (NSString *)  fileId
offset: (long)  offset 

获取文件上传地址等信息回调

通话中访客可调用 getUploadUrl 接口获取文件上传的地址等信息，具体信息通过此回调获取。

注解
一般上传本地文件到服务器时，需要先调用 getUploadUrl 接口，然后通过此回调的信息再上传至服务器。
参数
result获取结果，true 表示获取成功，false 表示获取失败
token校验用的token
url文件上传地址
fileId文件ID
offset文件续传位置

◆ onLogin:reason:

- (void) onLogin: (bool)  result
reason: (ReasonCode)  reason 

登录结果回调

参数
resulttrue 表示登录成功，false 表示登录失败
reason当 result 为 false 时该值有效

◆ onLogout:

- (void) onLogout: (ReasonCode)  reason

登出回调

参数
reason登出原因

◆ onOnlineMessageReceived:userId:

- (void) onOnlineMessageReceived: (NSString *)  message
userId: (NSString *)  userId 

收到在线消息回调

参数
message消息内容
userId对方userId

◆ onOnlineMessageSendResult:operatorId:

- (void) onOnlineMessageSendResult: (bool)  result
operatorId: (int)  operatorId 

在线消息发送结果回调

参数
result发送结果是否成功
  • true：发送成功
  • false：发送失败
operatorId操作ID，对应 sendOnlineMessage 的返回值

◆ onP2PMessageReceived:receiveMsg:

- (void) onP2PMessageReceived: (JRTCP2PSession *)  session
receiveMsg: (NSString *)  receiveMsg 

P2P通道收到消息回调

参数
sessionP2P通道对象
receiveMsg消息内容

◆ onP2PSessionClose:

- (void) onP2PSessionClose: (JRTCP2PSession *)  session

P2P通道关闭回调

参数
sessionP2P通道对象

◆ onP2PSessionConnect:result:

- (void) onP2PSessionConnect: (JRTCP2PSession *)  session
result: (bool)  result 

P2P通道连接结果回调

参数
sessionP2P通道对象
resultP2P通道连接结果
  • true：连接成功
  • false：连接失败

◆ onP2PSessionCreate:result:

- (void) onP2PSessionCreate: (JRTCP2PSession *)  session
result: (bool)  result 

P2P通道创建实例回调

参数
sessionP2P通道对象
result创建P2P通道结果
  • true：创建成功
  • false：创建失败

◆ onRequestFileUploadInfoResponse:result:url:token:requestTimestamp:extraInfo:fileSize:offset:fileType:serverOid:reason:

- (void) onRequestFileUploadInfoResponse: (int)  operatorId
result: (bool)  result
url: (NSString *)  url
token: (NSString *)  token
requestTimestamp: (long)  requestTimestamp
extraInfo: (NSString *)  extraInfo
fileSize: (long)  fileSize
offset: (int)  offset
fileType: (NSString *)  fileType
serverOid: (NSString *)  serverOid
reason: (NSString *)  reason 

获取文件上传或断点续传信息响应

参数
operatorId操作id，对应 requestFileUploadInfo 的返回值
result请求是否成功
  • true： 请求成功
  • false：请求失败
url上传地址，分片录制文件上传场景，首次请求分片上传信息时有效
token文件上传所需token，用于校验上传合法性，需要在上传文件的时候携带
requestTimestamp本次请求发起时间戳，用于控制上传地址有效期，需要在上传文件的时候携带
extraInfo随路参数
fileSize文件大小
offset偏移量
fileType文件类型
serverOid上传目标服务Oid
reason请求失败原因描述，当 result 为 false 时有效

◆ onSDKEvent:

- (void) onSDKEvent: (JRTCSDKEvent *)  event

上报事件回调

参数
event事件对象
制作者 doxygen 1.9.6