WhiteRoomCallbackDelegate Protocol Reference

Conforms to NSObject
Declared in WhiteRoomCallbacks.h

Overview

房间事件回调。

– firePhaseChanged:

房间连接状态发生变化回调。

- (void)firePhaseChanged:(WhiteRoomPhase)phase

Parameters

phase

房间的连接状态,详见 WhiteRoomPhase

Declared In

WhiteRoomCallbacks.h

– fireRoomStateChanged:

房间状态属性发生变化回调。

- (void)fireRoomStateChanged:(WhiteRoomState *)modifyState

Parameters

modifyState

发生变化的房间状态属性,详见 WhiteRoomState

Discussion

该回调仅返回发生变化的房间状态属性,未发生变化的房间状态字段,均为空。

Declared In

WhiteRoomCallbacks.h

– fireDisconnectWithError:

白板 SDK 与白板服务器连接中断回调。

- (void)fireDisconnectWithError:(NSString *)error

Parameters

error

错误信息。

Declared In

WhiteRoomCallbacks.h

– fireKickedWithReason:

用户被服务器移出房间回调。

- (void)fireKickedWithReason:(NSString *)reason

Parameters

reason

用户被移除房间的原因。

Declared In

WhiteRoomCallbacks.h

– fireCatchErrorWhenAppendFrame:error:

同步用户行为发生错误回调。

- (void)fireCatchErrorWhenAppendFrame:(NSUInteger)userId error:(NSString *)error

Parameters

userId

用户 ID。

error

错误原因。

Discussion

Note:

该回调通常是可以忽略的,你可以根据业务情况自行决定是否监听。

Declared In

WhiteRoomCallbacks.h

– fireCanUndoStepsUpdate:

可撤销次数发生变化回调。

- (void)fireCanUndoStepsUpdate:(NSInteger)canUndoSteps

Parameters

canUndoSteps

剩余的可撤销次数。

Discussion

当本地用户调用 undo 撤销上一步操作时,会触发该回调,报告剩余的可撤销次数。

Declared In

WhiteRoomCallbacks.h

– fireCanRedoStepsUpdate:

可重做次数发生变化回调。

- (void)fireCanRedoStepsUpdate:(NSInteger)canRedoSteps

Parameters

canRedoSteps

剩余的可重做次数。

Discussion

当本地用户调用 redo 重做上一步操作时,会触发该回调,报告剩余的可重做次数。

Declared In

WhiteRoomCallbacks.h

– fireMagixEvent:

白板自定义事件回调。

- (void)fireMagixEvent:(WhiteEvent *)event

Parameters

event

自定义事件。详见 WhiteEvent

Declared In

WhiteRoomCallbacks.h

– fireHighFrequencyEvent:

高频自定义事件一次性回调。

- (void)fireHighFrequencyEvent:(NSArray<WhiteEvent*> *)events

Parameters

events

高频自定义事件。详见 WhiteEvent

Declared In

WhiteRoomCallbacks.h