Get all the members of the screenSync session.
If this option is omitted, return all the members of the screenSync session.
Join the screenSync session.
If true:the current user becomes the follower of the screenSync session,and the ScreenSyncEvent.MEMBER_JOINED event is fired for all members of the screenSync session.
Leave the screenSync session.
If true:leave the screenSync session successfully,and the ScreenSyncEvent.MEMBER_LEAVE event is fired for all members of the screenSync session.
If the current 'leave' user is the leader of the screenSync session,the screenSync session is stopped ,and the ScreenSyncEvent.STOPPED event is fired for all members of the screenSync session.
Set the time interval at which screen sync data is sent to the server, in milliseconds.
The default value is 200 milliseconds. It's recommend to set a value greater than 50 milliseconds.
the time interval in milliseconds.
Generated using TypeDoc
The screenSync session can be created on top of the collaboration session with one "leader" and multiple "followers". Followers will follow leader’s screen scrolling,PDFPage zooming,and PDFPage view mode.
Basically, a screenSync is retrieved by creating a new screenSync Collaboration.createScreenSync and an existing screenSync can be obtained by Collaboration.getScreenSync
The screenSync is used to join,leave and getMembers of the screenSync session.