JCEngineDelegate Protocol Reference
Conforms to | NSObject |
---|---|
Declared in | JCEngineManager.h |
– onConnected
已连接至服务器回调 SDK 与服务器发起业务交互前,需要与服务器建立连接。开发者可以自行调用 - (int)loginWithUserId:(NSString )userId password:(NSString )password 来与服务器建立连接。也可以仅调用功能操作,如 - (int)joinWithRoomId:(NSString )roomId displayName:(NSString )displayName,SDK 会自动与服务器建立连接。
- (void)onConnected
Declared In
JCEngineManager.h
– onDisConnected:
与服务器连接断开回调 已于服务器断开连接。开发者可以调用 - (int)logout 断开与服务器的连接。操作成功后 SDK 会触发此回调。 当相同的 userId 在另一台设备登录时,SDK 也会触发此回调。
- (void)onDisConnected:(ErrorReason)errorReason
Parameters
errorReason |
具体原因值 @ref ErrorReason |
---|
Declared In
JCEngineManager.h
– onReconnecting
重连回调 当网络发生异常或切换时,SDK 可能会与服务器连接断开,此时 SDK 会自动发起重连,并触发此回调。 开发者可以利用这个回调,在界面上显示重连提示信息。若对重连信息没有需求,则忽略此回调。
- (void)onReconnecting
Declared In
JCEngineManager.h
– onError:
错误回调 SDK 运行中发生错误时就会触发此互调。如调用 - (int)joinWithRoomId:(NSString )roomId displayName:(NSString )displayName 时操作失败等
- (void)onError:(ErrorReason)errorReason
Parameters
errorReason |
具体原因值 @ref ErrorReason |
---|
Declared In
JCEngineManager.h
– onJoinRoomSuccess
加入房间成功回调 开发者调用 - (int)joinWithRoomId:(NSString )roomId displayName:(NSString )displayName 后,若加入成功 SDK 会触发此回调。
- (void)onJoinRoomSuccess
Declared In
JCEngineManager.h
– onLeftRoom:
已离开房间回调 开发者调用 - (void)leave 后,若操作成功,SDK 会触发此回调。若终端因为掉线或被管理员移除等原因离开 房间,SDK 也会触发此回调。
- (void)onLeftRoom:(ErrorReason)eventReason
Parameters
eventReason |
原因值 @ref ErrorReason |
---|
Declared In
JCEngineManager.h
– onParticipantJoin:
成员加入到房间回调 当新成员加入到房间时,SDK 会触发此回调。
- (void)onParticipantJoin:(NSString *)userId
Parameters
userId |
对应的成员userId |
---|
Declared In
JCEngineManager.h
– onParticipantLeft:userId:
成员离开房间的回调 当其他成员离开房间时,SDK 会触发此回调。
- (void)onParticipantLeft:(ErrorReason)errorReason userId:(NSString *)userId
Parameters
errorReason |
具体事件结果和原因值 @ref errorReason |
---|---|
userId |
对应的成员userId |
Declared In
JCEngineManager.h
– onParticipantUpdated:
成员信息变更回调 当成员状态、角色或者信息发生变化时,SDK 会触发此回调。
- (void)onParticipantUpdated:(NSString *)userId
Parameters
userId |
对应的成员userId |
---|
Declared In
JCEngineManager.h
– onRoomPropertyUpdated
房间属性变更回调 开发者调用 - (int)setCustomProperty: forKey: 后,若设置成功,SDK 会触发此回调。所有成员都会受到此回调。开发者可以调用 - (NSString *)getCustomPropertyForKey: 获取对应的属性。
- (void)onRoomPropertyUpdated
Declared In
JCEngineManager.h
– onRoomTitleUpdated
房间标题变更回调 开发者调用 - (int)changeTitle: 后,若修改成功 SDK 会触发此回调。所有成员会收到此回调。
- (void)onRoomTitleUpdated
Declared In
JCEngineManager.h
– onRoomSceenShareStateChanged:
屏幕共享状态变更回调 当有成员发起或关闭屏幕共享时,SDK 会触发此回调。
- (void)onRoomSceenShareStateChanged:(ErrorReason)errorReason
Parameters
errorReason |
具体事件结果和原因值 @ref ErrorReason |
---|
Declared In
JCEngineManager.h
– onDataReceive:content:fromSender:
接收数据的回调
- (void)onDataReceive:(NSString *)key content:(NSString *)content fromSender:(NSString *)userId
Parameters
key |
发送数据的类型 |
---|---|
content |
发送数据的具体内容 |
userId |
发送者的userId |
Declared In
JCEngineManager.h