JRTCSDK-iOS v2301.0
多方通话 API 文档
|
#import <JRTCRoomCallback.h>
构造函数 | |
(void) | - onRoomStateChanged:oldState:room: |
(void) | - onRoomPropertyChanged:room: |
(void) | - onJoin:reason:roomId:room: |
(void) | - onLeave:roomId:room: |
(void) | - onQuery:result:reason:queryInfo:room: |
(void) | - onParticipantJoin:room: |
(void) | - onParticipantLeft:reason:room: |
(void) | - onParticipantUpdate:changeParam:room: |
(void) | - onMessageReceived:content:fromUserId:room: |
(void) | - onInviteSipUserResult:result:reason:room: |
(void) | - onDeliveryAbort:deliveryUserId:reason:room: |
(void) | - onFileAudioInputFinish: |
房间相关事件回调
- (void) onDeliveryAbort: | (bool) | isShutDown | |
deliveryUserId: | (NSString *) | deliveryUserId | |
reason: | (NSString *) | reason | |
room: | (JRTCRoom *) | room | |
录制异常回调
远程录制异常退出时会上报此回调。
isShutDown | 录制异常时服务器是否自动结束通话
|
deliveryUserId | 录制异常的用户ID |
reason | 录制异常的原因 |
room | 当前 JRTCRoom 对象 |
- (void) onFileAudioInputFinish: | (JRTCRoom *) | room |
本地文件音频源输入完成回调
- (void) onInviteSipUserResult: | (int) | operationId | |
result: | (bool) | result | |
reason: | (ReasonCode) | reason | |
room: | (JRTCRoom *) | room | |
邀请Sip用户结果回调
调用 inviteSipUser
接口邀请落地用户时,会收到此回调。
operationId | 操作ID,对应 inviteSipUser 接口返回值 |
result | 邀请用户是否成功
|
reason | 失败原因,当 result 为 false 时该值有效。参见:失败原因 |
room | 当前 JRTCRoom 对象 |
- (void) onJoin: | (bool) | result | |
reason: | (ReasonCode) | reason | |
roomId: | (NSString *) | roomId | |
room: | (JRTCRoom *) | room | |
- (void) onLeave: | (ReasonCode) | reason | |
roomId: | (NSString *) | roomId | |
room: | (JRTCRoom *) | room | |
- (void) onMessageReceived: | (NSString *) | type | |
content: | (NSString *) | content | |
fromUserId: | (NSString *) | fromUserId | |
room: | (JRTCRoom *) | room | |
接收房间消息的回调
当房间中有成员调用 sendMessage
接口发送消息时,接收消息的成员会收到此回调。
type | 消息类型,对应 sendMessage 方法中的 type 参数 |
content | 消息内容,对应 sendMessage 方法中的 content 参数 |
fromUserId | 消息发送成员的用户ID |
room | 当前 JRTCRoom 对象 |
- (void) onParticipantJoin: | (JRTCRoomParticipant *) | participant | |
room: | (JRTCRoom *) | room | |
新成员加入回调
当有用户调用 join
接口加入房间成功时,已在房间中的成员会收到此回调。
participant | JRTCRoomParticipant 成员对象 |
room | 当前 JRTCRoom 对象 |
- (void) onParticipantLeft: | (JRTCRoomParticipant *) | participant | |
reason: | (ReasonCode) | reason | |
room: | (JRTCRoom *) | room | |
成员离开回调
当房间中有成员调用 leave
接口离开房间后,房间中的其他成员会收到此回调。
participant | JRTCRoomParticipant 成员对象 |
reason | 离开原因 |
room | 当前 JRTCRoom 对象 |
- (void) onParticipantUpdate: | (JRTCRoomParticipant *) | participant | |
changeParam: | (JRTCRoomParticipantChangeParam *) | changeParam | |
room: | (JRTCRoom *) | room | |
成员属性更新回调
当房间中有成员的属性发生变化时,房间中的其他成员会收到此回调,例如音频上传状态、视频上传状态、网络状态等发生变化。
participant | JRTCRoomParticipant 成员对象 |
changeParam | JRTCRoomParticipantChangeParam 更新标识类对象 |
room | 当前 JRTCRoom 对象 |
- (void) onQuery: | (int) | operationId | |
result: | (bool) | result | |
reason: | (ReasonCode) | reason | |
queryInfo: | (JRTCRoomQueryInfo *) | queryInfo | |
room: | (JRTCRoom *) | room | |
- (void) onRoomPropertyChanged: | (JRTCRoomPropChangeParam *) | changeParam | |
room: | (JRTCRoom *) | room | |
房间属性变化回调
当房间的属性发生变化时,会收到此回调,例如房间中有成员发起屏幕共享、录制状态发生变化等。
changeParam | JRTCRoomPropChangeParam 变化标识集合 |
room | 当前 JRTCRoom 对象 |
- (void) onRoomStateChanged: | (RoomState) | state | |
oldState: | (RoomState) | oldState | |
room: | (JRTCRoom *) | room | |
自身在房间中的状态变化回调
当自身在房间中的状态发生变化时,会收到此回调,例如加入房间、加入房间成功、离开回调等。
状态:
state | 当前状态 |
oldState | 变化前状态 |
room | 当前 JRTCRoom 对象 |