Whiteboard controller interface. More...

#include <meeting_whiteboard_ctrl_interface.h>

Public Member Functions
virtual SDKError	SetEvent (IMeetingWhiteboardCtrlEvent *pEvent)=0
	Configure the meeting whiteboard controller callback event handler.
virtual SDKError	SetOwnerWindow (HWND hOwner)=0
	Sets the whiteboard web view and dashboard web view owner window.
virtual bool	IsSupportWhiteBoard ()=0
	Determines whether the current meeting supports the whiteboard or not.
virtual bool	CanStartShareWhiteboard (CannotShareReasonType &reason)=0
	Determines whether the current meeting can start sharing the whiteboard.
virtual bool	CanStartShareNewWhiteboard ()=0
	Determines whether the current user can create a new whiteboard.
virtual SDKError	StartNewWhiteboardShare ()=0
	Starts sharing a new whiteboard.
virtual bool	CanStopWhiteboardShare ()=0
	Determines whether the current user can stop sharing a new whiteboard.
virtual SDKError	StopWhiteboardShare ()=0
	When self sharing whiteboard, stop self; when self not sharing, stop all others.
virtual SDKError	ShowDashboardView (int x=-1, int y=-1)=0
	Shows the dashboard web view window.
virtual SDKError	SetDashboardViewSize (int width=-1, int height=-1)=0
	Sets the dashboard web view window size.
virtual SDKError	SetWhiteboardViewPos (int x=-1, int y=-1)=0
	Sets the whiteboard web view window position.
virtual SDKError	SetWhiteboardViewSize (int width=-1, int height=-1)=0
	Sets the whiteboard web view window size.
virtual SDKError	SetWhiteboardShareOption (SDKWhiteboardShareOption option)=0
	Sets the option for who can share a whiteboard.
virtual SDKError	GetWhiteboardShareOption (SDKWhiteboardShareOption &option)=0
	Gets the option for who can share a whiteboard.
virtual SDKError	SetWhiteboardCreateOption (SDKWhiteboardCreateOption option)=0
	Sets the option for who can initiate a new whiteboard.
virtual SDKError	GetWhiteboardCreateOption (SDKWhiteboardCreateOption &option)=0
	Gets the option for who can initiate a new whiteboard.
virtual SDKError	EnableParticipantsCreateWithoutHost (bool bEnable)=0
	Enables the participants to create a new whiteboard without the host in the meeting.
virtual bool	IsParticipantsCreateWithoutHostEnabled ()=0
	Determines whether enable the participants create a new whiteboard without the host in the meeting.
virtual bool	IsOtherSharingWhiteboard ()=0
	Query if other user is sharing whiteboard.
virtual bool	IsSharingWhiteboardOut ()=0
	Query if the current user is sharing whiteboard successfully.

Detailed Description

Whiteboard controller interface.

Definition at line 76 of file meeting_whiteboard_ctrl_interface.h.

Member Function Documentation

◆ CanStartShareNewWhiteboard()

virtual bool IMeetingWhiteboardController::CanStartShareNewWhiteboard ( )

pure virtual

Determines whether the current user can create a new whiteboard.

Returns: true if the current user can create a new whiteboard. Otherwise, this function returns false.

◆ CanStartShareWhiteboard()

virtual bool IMeetingWhiteboardController::CanStartShareWhiteboard ( CannotShareReasonType & reason )

pure virtual

Determines whether the current meeting can start sharing the whiteboard.

Parameters

[out] reason The reason that no one can start sharing the whiteboard.

Returns: true indicates you can start sharing the whiteboard.

◆ CanStopWhiteboardShare()

virtual bool IMeetingWhiteboardController::CanStopWhiteboardShare ( )

pure virtual

Determines whether the current user can stop sharing a new whiteboard.

Returns: true if the current user can stop sharing the new whiteboard. Otherwise, this function returns false.

◆ EnableParticipantsCreateWithoutHost()

virtual SDKError IMeetingWhiteboardController::EnableParticipantsCreateWithoutHost ( bool bEnable )

pure virtual

Enables the participants to create a new whiteboard without the host in the meeting.

Parameters

bEnable true indicates to enable. false not.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ GetWhiteboardCreateOption()

virtual SDKError IMeetingWhiteboardController::GetWhiteboardCreateOption ( SDKWhiteboardCreateOption & option )

pure virtual

Gets the option for who can initiate a new whiteboard.

Parameters

[out] option Setting option for who can initiate a new whiteboard.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ GetWhiteboardShareOption()

virtual SDKError IMeetingWhiteboardController::GetWhiteboardShareOption ( SDKWhiteboardShareOption & option )

pure virtual

Gets the option for who can share a whiteboard.

Parameters

[out] option Setting option for who can share a whiteboard.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ IsOtherSharingWhiteboard()

virtual bool IMeetingWhiteboardController::IsOtherSharingWhiteboard ( )

pure virtual

Query if other user is sharing whiteboard.

Returns: true if other user is sharing. Otherwise, false.

◆ IsParticipantsCreateWithoutHostEnabled()

virtual bool IMeetingWhiteboardController::IsParticipantsCreateWithoutHostEnabled ( )

pure virtual

Determines whether enable the participants create a new whiteboard without the host in the meeting.

Returns: true indicates that they have these permission.

◆ IsSharingWhiteboardOut()

virtual bool IMeetingWhiteboardController::IsSharingWhiteboardOut ( )

pure virtual

Query if the current user is sharing whiteboard successfully.

Returns: true if the current user is sharing successfully. Otherwise, false.

◆ IsSupportWhiteBoard()

virtual bool IMeetingWhiteboardController::IsSupportWhiteBoard ( )

pure virtual

Determines whether the current meeting supports the whiteboard or not.

Returns: true indicates to support.

◆ SetDashboardViewSize()

virtual SDKError IMeetingWhiteboardController::SetDashboardViewSize	(	int	width = -1,
		int	height = -1 )

pure virtual

Sets the dashboard web view window size.

Parameters

height	Specify the height of the window.
width	Specify the width of the window.

Note: If height == -1 and width == -1, the window size will be default.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: Valid only for custom user interface mode.

◆ SetEvent()

virtual SDKError IMeetingWhiteboardController::SetEvent ( IMeetingWhiteboardCtrlEvent * pEvent )

pure virtual

Configure the meeting whiteboard controller callback event handler.

Parameters

pEvent An object pointer to the IMeetingWhiteboardControllerEvent that receives the meeting whiteboard callback event.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: The SDK use pEvent to transmit the callback event to the user's application. If the function is not called or fails, the user's application is unable to retrieve the callback event.

◆ SetOwnerWindow()

virtual SDKError IMeetingWhiteboardController::SetOwnerWindow ( HWND hOwner )

pure virtual

Sets the whiteboard web view and dashboard web view owner window.

Parameters

[in] hOwner Specify the owner window. If the hOwner is nullptr, the owner window will be desktop window.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: Valid only for user custom interface mode. Call this function before calling ShowDashboardView. Call this function when receiving the meeting status MEETING_STATUS_INMEETING. Otherwise, the dashboard web view owner window will be desktop window.

◆ SetWhiteboardCreateOption()

virtual SDKError IMeetingWhiteboardController::SetWhiteboardCreateOption ( SDKWhiteboardCreateOption option )

pure virtual

Sets the option for who can initiate a new whiteboard.

Parameters

[in] option Setting option for who can initiate a new whiteboard.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ SetWhiteboardShareOption()

virtual SDKError IMeetingWhiteboardController::SetWhiteboardShareOption ( SDKWhiteboardShareOption option )

pure virtual

Sets the option for who can share a whiteboard.

Parameters

[in] option New setting for who can share a whiteboard.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

◆ SetWhiteboardViewPos()

virtual SDKError IMeetingWhiteboardController::SetWhiteboardViewPos	(	int	x = -1,
		int	y = -1 )

pure virtual

Sets the whiteboard web view window position.

Parameters

x	The horizontal coordinate value.
y	The vertical coordinate value.

Note: If x == -1 and y = -1, the window position will be in the center of the screen where the owner window is located.; If you don't call this function, the window position will be in the center of the screen where the owner window is located.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: Valid only for custom user interface mode.

◆ SetWhiteboardViewSize()

virtual SDKError IMeetingWhiteboardController::SetWhiteboardViewSize	(	int	width = -1,
		int	height = -1 )

pure virtual

Sets the whiteboard web view window size.

Parameters

height	Specify the height of the window.
width	Specify the width of the window.

Note: If height == -1 and width == -1, the window size will be default.; If you don't call this function, the window size will be default.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: Valid only for custom user interface mode.

◆ ShowDashboardView()

virtual SDKError IMeetingWhiteboardController::ShowDashboardView	(	int	x = -1,
		int	y = -1 )

pure virtual

Shows the dashboard web view window.

Parameters

x	The horizontal coordinate value.
y	The vertical coordinate value.

Note: If x == -1 and y = -1, the window position will be in the center of the screen where the owner window is located.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: Valid only for custom user interface mode.

◆ StartNewWhiteboardShare()

virtual SDKError IMeetingWhiteboardController::StartNewWhiteboardShare ( )

pure virtual

Starts sharing a new whiteboard.

Returns: If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: Valid only for custom user interface mode.

◆ StopWhiteboardShare()

virtual SDKError IMeetingWhiteboardController::StopWhiteboardShare ( )

pure virtual

When self sharing whiteboard, stop self; when self not sharing, stop all others.

Returns: If the function succeeds, it returns SDKERR_SUCCESS. Otherwise, this function returns an error.

Note: Valid only for user custom interface mode.

Public Member Functions

Detailed Description

Member Function Documentation

◆ CanStartShareNewWhiteboard()

◆ CanStartShareWhiteboard()

◆ CanStopWhiteboardShare()

◆ EnableParticipantsCreateWithoutHost()

◆ GetWhiteboardCreateOption()

◆ GetWhiteboardShareOption()

◆ IsOtherSharingWhiteboard()

◆ IsParticipantsCreateWithoutHostEnabled()

◆ IsSharingWhiteboardOut()

◆ IsSupportWhiteBoard()

◆ SetDashboardViewSize()

◆ SetEvent()

◆ SetOwnerWindow()

◆ SetWhiteboardCreateOption()

◆ SetWhiteboardShareOption()

◆ SetWhiteboardViewPos()

◆ SetWhiteboardViewSize()

◆ ShowDashboardView()

◆ StartNewWhiteboardShare()

◆ StopWhiteboardShare()