ZOOM Windows SDK  5.2.41727.0928
Public Member Functions | List of all members
ICustomizedShareRender Class Referenceabstract

Share render interface. More...

#include <customized_share_render.h>

Public Member Functions

virtual SDKError SetEvent (ICustomizedShareRenderEvent *pEvent)=0
 Set the share render callback event handler. More...
 
virtual SDKError Show ()=0
 Show the shared content received. More...
 
virtual SDKError Hide ()=0
 Hide the shared content received. More...
 
virtual SDKError SetUserID (unsigned int userid)=0
 View the sharing content from the specified user ID. More...
 
virtual unsigned int GetUserID ()=0
 Get the ID of the user who's sending the sharing. More...
 
virtual SDKError Resize (RECT rc)=0
 Reset the dialog size to view the sharing content. More...
 
virtual SDKError SetViewMode (CustomizedViewShareMode mode)=0
 Set the view mode of watching the sharing. More...
 
virtual HWND GetOwnerWnd ()=0
 Get the window handle of showing sharing content. More...
 
virtual SDKError HandleWindowsMoveMsg ()=0
 Redraw the window of showing the sharing. More...
 

Detailed Description

Share render interface.

Member Function Documentation

◆ GetOwnerWnd()

virtual HWND ICustomizedShareRender::GetOwnerWnd ( )
pure virtual

Get the window handle of showing sharing content.

Returns
If the function succeeds, the return value is the window handle. Otherwise failed, the return value is NULL.

◆ GetUserID()

virtual unsigned int ICustomizedShareRender::GetUserID ( )
pure virtual

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

Returns
If the function succeeds, the return value is the user 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.

◆ Hide()

virtual SDKError ICustomizedShareRender::Hide ( )
pure virtual

Hide the shared content received.

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

◆ Resize()

virtual SDKError ICustomizedShareRender::Resize ( RECT  rc)
pure virtual

Reset the dialog size to view the sharing content.

Parameters
rcSpecify 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
pEventA 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.

◆ SetUserID()

virtual SDKError ICustomizedShareRender::SetUserID ( unsigned int  userid)
pure virtual

View the sharing content from the specified user ID.

Parameters
useridSpecify the user ID that is sending the sharing content.
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
modeSpecify 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.

◆ Show()

virtual SDKError ICustomizedShareRender::Show ( )
pure virtual

Show the shared content received.

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

The documentation for this class was generated from the following file: