@netless/react-native-whiteboard

onCatchErrorWhenRender:function

• onCatchErrorWhenRender(err: Error): any

• Callback for error on rendering.

  Parameters

  • err: Error

  Returns any

onLoadFirstFrame:function

• onLoadFirstFrame(): any

• Callback for player load the first frame.

  Returns any

onPhaseChanged:function

• onPhaseChanged(phase: PlayerPhase): any

• Callback for player phase change.

  Parameters

  • phase: PlayerPhase

  Returns any

onPlayerStateChanged:function

• onPlayerStateChanged(modifyState: Partial<NativePlayerState>): any

• Callback for room change in state, will only contain the properties that actually changed.

  Parameters

  • modifyState: Partial<NativePlayerState>

  Returns any

onProgressTimeChanged:function

• onProgressTimeChanged(scheduleTime: number): any

• Callbcak when player.progressTime has changed.

  Parameters

  • scheduleTime: number

  Returns any

onStoppedWithError:function

• onStoppedWithError(err: Error): any

• Callbacks where an error causes playback to pause.

  Parameters

  • err: Error

  Returns any

onAttributesUpdate:function

• onAttributesUpdate(attributes: object): any

• SyncedStoreState updated, state is the entire content of SyncedState

  Parameters

  • attributes: object

  Returns any

onCanRedoStepsUpdate:function

• onCanRedoStepsUpdate(canRedoSteps: number): any

• The number of redoable change callbacks.

  Parameters

  • canRedoSteps: number

  Returns any

onCanUndoStepsUpdate:function

• onCanUndoStepsUpdate(canUndoSteps: number): any

• The number of undoable change callbacks.

  Parameters

  • canUndoSteps: number

  Returns any

onCatchErrorWhenAppendFrame:function

• onCatchErrorWhenAppendFrame(info: { error: string; userId: number }): any

• Synchronized user behavior error callback.

  Note: This callback is usually ignored, and you can decide for yourself whether to listen to it or not depending on the business situation.

  Parameters

  • info: { error: string; userId: number }

    • error: string

    • userId: number

  Returns any

onDisconnectWithError:function

• onDisconnectWithError(error: string): any

• Callback for broken connection between Whiteboard SDK and Whiteboard server.

  Parameters

  • error: string

    error info for dicconnect.

  Returns any

onKickedWithReason:function

• onKickedWithReason(reason: string): any

• The user is moved out of the room by the server callback.

  Parameters

  • reason: string

  Returns any

onPhaseChanged:function

• onPhaseChanged(phase: RoomPhase): any

• Callback for room connection status change.

  Parameters

  • phase: RoomPhase

  Returns any

onRoomStateChanged:function

• onRoomStateChanged(modifyState: Partial<WhiteRoomState>): any

• Callback for room state change.

  Parameters

  • modifyState: Partial<WhiteRoomState>

  Returns any

onLogger:function

• onLogger(args: any): any

• Parameters

  • args: any

  Returns any

onPPTMediaPause:function

• onPPTMediaPause(info: { shapeId: string; type: MediaType }): any

• Pause playback of audio and video callbacks in dynamic PPTs.

  Parameters

  • info: { shapeId: string; type: MediaType }

    • shapeId: string

    • type: MediaType

  Returns any

onPPTMediaPlay:function

• onPPTMediaPlay(info: { shapeId: string; type: MediaType }): any

• Playback of audio and video callbacks in dynamic PPT

  Parameters

  • info: { shapeId: string; type: MediaType }

    • shapeId: string

    • type: MediaType

  Returns any

onPostMessage:function

• onPostMessage(message: string): any

• Receives the message callbacks sent by the web page.

  Message callbacks include

  • iframe data in dictionary format
  • image load failure messages
  • ppt play/pause callback messages

  This callback is triggered when the local user receives a message from a web page (e.g. iframe plug-in, dynamic PPT).

  Parameters

  • message: string

  Returns any

onSetupFail:function

• onSetupFail(e: Error): any

• SDK initialization failure callback.

  If the SDK initialization fails, the call to join a live room or playback room will remain unresponsive and the SDK will need to be reinitialized.

  SDK initialization failures can be caused by the following.

  • A network anomaly during the initialization of the SDK, resulting in a failure to obtain configuration information.
  • An illegal App Identifier was passed in.

  Parameters

  • e: Error

    error message.

  Returns any

onThrowError:function

• onThrowError(message: string): any

• SDK appears with an uncaught global error callback.

  Parameters

  • message: string

  Returns any

Optional replayCallbacks?: Partial<ReplayCallbackHandler>

replayConfig: NativeReplayParams

replayRoomCallback: ((player?: RoomPlayer, sdk?: SDK, error?: Error) => void)

• • (player?: RoomPlayer, sdk?: SDK, error?: Error): void

  • Called at the end of joining the replay room, regardless of success or failure

    Parameters

    • Optional player: RoomPlayer

    • Optional sdk: SDK

    • Optional error: Error

    Returns void

Optional sdkCallbacks?: Partial<SDKCallbackHandler>

sdkConfig: SDKConfig

style: StyleProp<ViewStyle>

joinRoomCallback: ((room?: Room, sdk?: SDK, error?: Error) => void)

• • (room?: Room, sdk?: SDK, error?: Error): void

  • Called at the end of joining the room, regardless of success or failure

    Parameters

    • Optional room: Room

    • Optional sdk: SDK

    • Optional error: Error

    Returns void

Optional roomCallbacks?: Partial<RoomCallbackHandler>

roomConfig: RoomConfig

Optional sdkCallbacks?: Partial<SDKCallbackHandler>

sdkConfig: SDKConfig

style: StyleProp<ViewStyle>

onStartShouldSetResponder?:function

• onStartShouldSetResponder(evebt: GestureResponderEvent): boolean

• Gesture life cycle for menu interaction

  Parameters

  • evebt: GestureResponderEvent

  Returns boolean