ICustomizedShareRender Class Reference

Share render interface. More...

#include <customized_share_render.h>

Inherits IShareActionBase.

Public Member Functions
virtual SDKError	SetEvent (ICustomizedShareRenderEvent *pEvent)=0
	Set the share render callback event handler.
virtual SDKError	SetShareSourceID (unsigned int nShareSourceID)=0
	View the sharing content from the specified share source ID.
virtual unsigned int	GetShareSourceID ()=0
	Get the share source ID of the user who's sending the sharing.
virtual SDKError	Resize (RECT rc)=0
	Reset the dialog size to view the sharing content.
virtual SDKError	SetViewMode (CustomizedViewShareMode mode)=0
	Set the view mode of watching the sharing.
virtual SDKError	HandleWindowsMoveMsg ()=0
	Redraw the window of showing the sharing.
virtual	~ICustomizedShareRender ()
Public Member Functions inherited from IShareActionBase
virtual SDKError	Show ()=0
	Show the shared content received.
virtual SDKError	Hide ()=0
	Hide the shared content received.
virtual HWND	GetOwnerWnd ()=0
	Get the window handle of showing sharing content.
virtual	~IShareActionBase ()

Detailed Description

Share render interface.

Definition at line 71 of file customized_share_render.h.

Constructor & Destructor Documentation

~ICustomizedShareRender()

virtual ICustomizedShareRender::~ICustomizedShareRender ( )

inlinevirtual

Definition at line 111 of file customized_share_render.h.

{}

Member Function Documentation

GetShareSourceID()

virtual unsigned int ICustomizedShareRender::GetShareSourceID ( )

pure virtual

Get the share source ID of the user who's sending the sharing.

Returns

If the function succeeds, the return value is the share source ID. Otherwise failed, the return value is ZERO(0).

HandleWindowsMoveMsg()

virtual SDKError ICustomizedShareRender::HandleWindowsMoveMsg ( )

pure virtual

Redraw the window of showing the sharing.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, see SDKError enum. Call the function when the parent window gets WM_MOVE windows message.

Remarks

Call the function to complete the redraw work once received the ICustomizedShareRenderEvent::onWindowMsgNotification() callback event and dealt with WM_MOVE. Otherwise there maybe problem with the view.

Resize()

virtual SDKError ICustomizedShareRender::Resize ( RECT rc )

pure virtual

Reset the dialog size to view the sharing content.

Parameters

rc	Specify the size of the window. The coordinate of the upper left corner of the window corresponds to the client area of the parent window.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, see SDKError enum.

SetEvent()

virtual SDKError ICustomizedShareRender::SetEvent ( ICustomizedShareRenderEvent * pEvent )

pure virtual

Set the share render callback event handler.

Parameters

pEvent

A pointer to the ICustomizedShareRenderEvent that receives the share render event.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, see SDKError enum.

SetShareSourceID()

virtual SDKError ICustomizedShareRender::SetShareSourceID ( unsigned int nShareSourceID )

pure virtual

View the sharing content from the specified share source ID.

Parameters

nShareSourceID

Specify the share source ID.

Remarks

Call the IMeetingShareController::GetViewableShareSourceList to get the list of users who are sending the sharing. Handle the IMeetingShareCtrlEvent::onSharingStatus callback event to know who starts/stops the sharing.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, see SDKError enum.

SetViewMode()

virtual SDKError ICustomizedShareRender::SetViewMode ( CustomizedViewShareMode mode )

pure virtual

Set the view mode of watching the sharing.

Parameters

mode	Specify the view mode. For more details, see CustomizedViewShareMode enum.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. To get extended error information, see SDKError enum.