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

Custom UI manager interface. More...

#include <customized_ui_mgr.h>

Public Member Functions

virtual SDKError HasLicense ()=0
 Determine if the user owns the license to enable the custom UI module. More...
 
virtual SDKError SetEvent (ICustomizedUIMgrEvent *pEvent)=0
 Set custom UI manager interface callback event handler. More...
 
virtual SDKError CreateVideoContainer (ICustomizedVideoContainer **ppContainer, HWND hParentWnd, RECT rc)=0
 Create the video container. More...
 
virtual SDKError DestroyVideoContainer (ICustomizedVideoContainer *pContainer)=0
 Destroy the specified video container. More...
 
virtual SDKError DestroyAllVideoContainer ()=0
 Destroy all the video containers. More...
 
virtual SDKError CreateShareRender (ICustomizedShareRender **ppRender, HWND hParentWnd, RECT rc)=0
 Create shared render. More...
 
virtual SDKError DestroyShareRender (ICustomizedShareRender *pRender)=0
 Destroy the specified shared render. More...
 
virtual SDKError DestroyAllShareRender ()=0
 Destroy all the shared renders. More...
 

Detailed Description

Custom UI manager interface.

Member Function Documentation

◆ CreateShareRender()

virtual SDKError ICustomizedUIMgr::CreateShareRender ( ICustomizedShareRender **  ppRender,
HWND  hParentWnd,
RECT  rc 
)
pure virtual

Create shared render.

Parameters
ppRenderOnce the function is called successfully, this parameter will store the pointer to the ICustomizedShareRender*.
hParentWndSpecify the parent window of the shared render.
rcSpecify the position of client area of the shared render. The client coordinates corresponds to the client area of the upper-left corner of the parent window.
Returns
If the function succeeds, the return value is SDKErr_Success, and the return value of ppRender is not NULL. Otherwise failed. To get extended error information, see SDKError enum.

◆ CreateVideoContainer()

virtual SDKError ICustomizedUIMgr::CreateVideoContainer ( ICustomizedVideoContainer **  ppContainer,
HWND  hParentWnd,
RECT  rc 
)
pure virtual

Create the video container.

Parameters
ppContainerOnce called the function successfully, this parameter will store the pointer to the ICustomizedVideoContainer*.
hParentWndSpecify the parent window of the video container.
rcSpecify the position of client area of the video render elements. The client coordinates corresponds to the client area of the upper-left corner of the parent window.
Returns
If the function succeeds, the return value is SDKErr_Success, and the return value of ppContainer is not NULL. Otherwise failed. To get extended error information, see SDKError enum.

◆ DestroyAllShareRender()

virtual SDKError ICustomizedUIMgr::DestroyAllShareRender ( )
pure virtual

Destroy all the shared renders.

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

◆ DestroyAllVideoContainer()

virtual SDKError ICustomizedUIMgr::DestroyAllVideoContainer ( )
pure virtual

Destroy all the video containers.

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

◆ DestroyShareRender()

virtual SDKError ICustomizedUIMgr::DestroyShareRender ( ICustomizedShareRender pRender)
pure virtual

Destroy the specified shared render.

Parameters
pRenderA pointer to the ICustomizedShareRender to be destroyed.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ DestroyVideoContainer()

virtual SDKError ICustomizedUIMgr::DestroyVideoContainer ( ICustomizedVideoContainer pContainer)
pure virtual

Destroy the specified video container.

Parameters
pContainerA pointer to the ICustomizedVideoContainer to be destroyed.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ HasLicense()

virtual SDKError ICustomizedUIMgr::HasLicense ( )
pure virtual

Determine if the user owns the license to enable the custom UI module.

Returns
If the user owns the license, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetEvent()

virtual SDKError ICustomizedUIMgr::SetEvent ( ICustomizedUIMgrEvent pEvent)
pure virtual

Set custom UI manager interface callback event handler.

Parameters
pEventA pointer to the ICustomizedUIMgrEvent that receives user manager custom interface event.
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: