JRTCSDK-Java v2401.0
多方通话 API 文档
|
Public 成员函数 | |
void | onRoomStateChanged (@RoomState int state, @RoomState int oldState, JRTCRoom room) |
void | onRoomPropertyChanged (JRTCRoom.PropChangeParam propChangeParam, JRTCRoom room) |
void | onJoin (boolean result, @ReasonCode int reason, String channelId, JRTCRoom room) |
void | onLeave (@ReasonCode int reason, String roomId, JRTCRoom room) |
void | onKickUserResult (boolean result, String reason, JRTCRoom room) |
void | onStop (boolean result, @ReasonCode int reason, JRTCRoom room) |
void | onQuery (int operationId, boolean result, @ReasonCode int reason, JRTCRoomQueryInfo queryInfo, JRTCRoom room) |
void | onParticipantJoin (JRTCRoomParticipant participant, JRTCRoom room) |
void | onParticipantLeft (JRTCRoomParticipant participant, @ReasonCode int reason, JRTCRoom room) |
void | onParticipantUpdate (JRTCRoomParticipant participant, JRTCRoomParticipant.ChangeParam changeParam, JRTCRoom room) |
void | onMessageReceived (String type, String content, String fromUserId, JRTCRoom room) |
void | onInviteSipUserResult (int operationId, boolean result, @ReasonCode int reason, JRTCRoom room) |
void | onDeliveryAbort (boolean isShutDown, String deliveryUserid, String reason, JRTCRoom room) |
void | onFileAudioInputFinish (JRTCRoom room) |
void | onEnableRemoteAdvancedRecordResult (JRTCRoom room, boolean result, String error) |
房间相关事件回调
void onDeliveryAbort | ( | boolean | isShutDown, |
String | deliveryUserid, | ||
String | reason, | ||
JRTCRoom | room | ||
) |
录制异常回调
远程录制异常退出时会上报此回调。
isShutDown | 录制异常时服务器是否自动结束通话
|
deliveryUserid | 录制异常的用户ID |
reason | 录制异常的原因 |
room | 当前 JRTCRoom 对象 |
在 JRTCAgentImpl , 以及 JRTCGuestImpl 内被实现.
void onEnableRemoteAdvancedRecordResult | ( | JRTCRoom | room, |
boolean | result, | ||
String | error | ||
) |
开启远程录制(增强录制)结果回调
room | 当前 JRTCRoom 对象 |
result | 开启远程录制是否成功
|
error | 失败错误描述,当 result 为 false 时该值有效。 |
在 JRTCAgentImpl , 以及 JRTCGuestImpl 内被实现.
void onFileAudioInputFinish | ( | JRTCRoom | room | ) |
本地文件音频源输入完成回调
room | 当前 JRTCRoom 对象 |
onFileAudioInputDidFinish
替换 在 JRTCAgentImpl , 以及 JRTCGuestImpl 内被实现.
void onInviteSipUserResult | ( | int | operationId, |
boolean | result, | ||
@ReasonCode int | reason, | ||
JRTCRoom | room | ||
) |
邀请Sip用户结果回调
调用 inviteSipUser
接口邀请落地用户时,会收到此回调。
operationId | 操作id,对应 inviteSipUser 接口返回值 |
result | 邀请用户是否成功
|
reason | 失败原因,当 result 为 false 时该值有效。参见:失败原因 |
room | 当前 JRTCRoom 对象 |
void onJoin | ( | boolean | result, |
@ReasonCode int | reason, | ||
String | channelId, | ||
JRTCRoom | room | ||
) |
加入房间结果回调
调用 join
接口成功后,会收到此回调。
result | 加入房间是否成功
|
reason | 加入失败原因,当 result 为 false 时该值有效。失败原因参见:错误码 |
channelId | 房间标识 |
room | 当前 JRTCRoom 对象 |
在 JRTCAgentImpl 内被实现.
void onKickUserResult | ( | boolean | result, |
String | reason, | ||
JRTCRoom | room | ||
) |
踢出成员结果回调
调用 kickUser
接口成功后,会收到此回调。
result | 操作结果是否成功
|
reason | 失败原因描述 |
room | 当前 JRTCRoom 对象 |
在 JRTCAgentImpl , 以及 JRTCGuestImpl 内被实现.
void onLeave | ( | @ReasonCode int | reason, |
String | roomId, | ||
JRTCRoom | room | ||
) |
离开房间结果回调
调用 leave
接口成功后,会收到此回调。
reason | 离开原因,参见:离开原因 |
roomId | 房间标识 |
room | 当前 JRTCRoom 对象 |
在 JRTCAgentImpl , 以及 JRTCGuestImpl 内被实现.
void onMessageReceived | ( | String | type, |
String | content, | ||
String | fromUserId, | ||
JRTCRoom | room | ||
) |
接收房间消息的回调
当房间中有成员调用 sendMessage
接口发送消息时,接收消息的成员会收到此回调。
type | 消息类型,对应 sendMessage 方法中的 type 参数 |
content | 消息内容,对应 sendMessage 方法中的 content 参数 |
fromUserId | 消息发送成员的用户ID |
room | 当前 JRTCRoom 对象 |
在 JRTCAgentImpl , 以及 JRTCGuestImpl 内被实现.
void onParticipantJoin | ( | JRTCRoomParticipant | participant, |
JRTCRoom | room | ||
) |
新成员加入回调
当有用户调用 join
接口加入房间成功时,已在房间中的成员会收到此回调。
participant | JRTCRoomParticipant 成员对象 |
room | 当前 JRTCRoom 对象 |
在 JRTCAgentImpl , 以及 JRTCGuestImpl 内被实现.
void onParticipantLeft | ( | JRTCRoomParticipant | participant, |
@ReasonCode int | reason, | ||
JRTCRoom | room | ||
) |
void onParticipantUpdate | ( | JRTCRoomParticipant | participant, |
JRTCRoomParticipant.ChangeParam | changeParam, | ||
JRTCRoom | room | ||
) |
成员属性更新回调
当房间中有成员的属性发生变化时,房间中的其他成员会收到此回调,例如音频上传状态、视频上传状态、网络状态等发生变化。
participant | JRTCRoomParticipant 成员对象 |
changeParam | JRTCRoomParticipant.ChangeParam 更新标识类对象 |
room | 当前 JRTCRoom 对象 |
在 JRTCAgentImpl , 以及 JRTCGuestImpl 内被实现.
void onQuery | ( | int | operationId, |
boolean | result, | ||
@ReasonCode int | reason, | ||
JRTCRoomQueryInfo | queryInfo, | ||
JRTCRoom | room | ||
) |
查询房间信息结果回调
调用 query
接口成功后,会收到此回调。
operationId | 操作id,对应 query 接口返回值 |
result | 查询房间信息是否成功
|
reason | 查询失败原因,当 result 为 false 时该值有效。失败原因参见:错误码 |
queryInfo | JRTCRoomQueryInfo 对象,查询到的房间信息,当失败时只需关注 JRTCRoomQueryInfo#getRoomId() roomId} |
room | 当前 JRTCRoom 对象 |
在 JRTCAgentImpl 内被实现.
void onRoomPropertyChanged | ( | JRTCRoom.PropChangeParam | propChangeParam, |
JRTCRoom | room | ||
) |
房间属性变化回调
当房间的属性发生变化时,会收到此回调,例如房间中有成员发起屏幕共享、录制状态发生变化等。
propChangeParam | JRTCRoom.PropChangeParam 变化标识集合 |
room | 当前 JRTCRoom 对象 |
在 JRTCAgentImpl , 以及 JRTCGuestImpl 内被实现.
自身在房间中的状态变化回调
当自身在房间中的状态发生变化时,会收到此回调,例如加入房间、加入房间成功、离开回调等。 状态:
STATE_IDLE
: 空闲状态STATE_JOINING
: 加入中STATE_JOINED
: 已加入STATE_LEAVING
: 离开中 state | 当前状态 |
oldState | 变化前状态 |
room | 当前 JRTCRoom 对象 |
在 JRTCAgentImpl 内被实现.
void onStop | ( | boolean | result, |
@ReasonCode int | reason, | ||
JRTCRoom | room | ||
) |