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

The base class for the video element interface. More...

#include <customized_video_container.h>

Inherited by IActiveVideoRenderElement, INormalVideoRenderElement, and IPreviewVideoRenderElement.

Public Member Functions

virtual VideoRenderElementType GetType ()=0
 Get the type of the video render element. More...
 
virtual RECT GetPos ()=0
 Get the area where the current render element is. More...
 
virtual SDKError SetPos (RECT pos)=0
 Specify a new display area of the current render element. More...
 
virtual SDKError Show ()=0
 Show the render element. More...
 
virtual SDKError Hide ()=0
 Hide the render element. More...
 
virtual unsigned int GetCurrentRenderUserId ()=0
 Get the user ID corresponding to the current render element. More...
 
virtual VideoRenderDataType GetCurrentRenderDataType ()=0
 Get the data type of the current render element. More...
 
virtual SDKError EnableShowScreenNameOnVideo (bool enable_show)=0
 Set the visibility of the screen name on the current render element. More...
 

Detailed Description

The base class for the video element interface.

Member Function Documentation

◆ EnableShowScreenNameOnVideo()

virtual SDKError IVideoRenderElement::EnableShowScreenNameOnVideo ( bool  enable_show)
pure virtual

Set the visibility of the screen name on the current render element.

Parameters
enable_showTRUE indicates to show the screen name. Otherwise failed. To get extended error information, see SDKError enum.

◆ GetCurrentRenderDataType()

virtual VideoRenderDataType IVideoRenderElement::GetCurrentRenderDataType ( )
pure virtual

Get the data type of the current render element.

Returns
The data type of the current render elements. For more details, see VideoRenderDataType enum.

◆ GetCurrentRenderUserId()

virtual unsigned int IVideoRenderElement::GetCurrentRenderUserId ( )
pure virtual

Get the user ID corresponding to the current render element.

Returns
The ID of the user.

◆ GetPos()

virtual RECT IVideoRenderElement::GetPos ( )
pure virtual

Get the area where the current render element is.

Returns
A RECT structure. The value in the structure corresponding to the coordinate system is the client area of the video container. The client coordinates corresponds to the client area of the upper-left corner of the parent window.

◆ GetType()

virtual VideoRenderElementType IVideoRenderElement::GetType ( )
pure virtual

Get the type of the video render element.

Returns
If the function succeeds, the return value is the type of the render element. For more details, see VideoRenderElementType enum. Otherwise failed, the return value is VideoRenderElement_None.

◆ Hide()

virtual SDKError IVideoRenderElement::Hide ( )
pure virtual

Hide the render element.

Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed,see SDKError enum.

◆ SetPos()

virtual SDKError IVideoRenderElement::SetPos ( RECT  pos)
pure virtual

Specify a new display area of the current render element.

Parameters
posSpecify a new area through RECT structure. The value in the structure corresponding to the coordinate system is that of the client area of the video main window.
Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed,see SDKError enum.

◆ Show()

virtual SDKError IVideoRenderElement::Show ( )
pure virtual

Show the render element.

Returns
If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed,see SDKError enum.

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