Windows SDK API Reference
Loading...
Searching...
No Matches
IPreviewVideoRenderElement Class Referenceabstract

The interface to preview the video render element of the participant who joins the meeting before the host. More...

#include <customized_video_container.h>

Inherits IVideoRenderElement.

Public Member Functions

virtual SDKError Start ()=0
 Start previewing. More...
 
virtual SDKError Stop ()=0
 Stop previewing. More...
 
virtual ~IPreviewVideoRenderElement ()
 
- Public Member Functions inherited from IVideoRenderElement
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...
 
virtual SDKError SetResolution (VideoRenderResolution resolution)=0
 Set the resolution for the video in the current render element. Once you specify the value, the resolution will not change even the size of the element is changed. Specify a bigger resolution may cause subscribing fail. More...
 
virtual ~IVideoRenderElement ()
 

Detailed Description

The interface to preview the video render element of the participant who joins the meeting before the host.

Definition at line 98 of file customized_video_container.h.

Constructor & Destructor Documentation

◆ ~IPreviewVideoRenderElement()

virtual IPreviewVideoRenderElement::~IPreviewVideoRenderElement ( )
inlinevirtual

Definition at line 108 of file customized_video_container.h.

108{}

Member Function Documentation

◆ Start()

virtual SDKError IPreviewVideoRenderElement::Start ( )
pure virtual

Start previewing.

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

◆ Stop()

virtual SDKError IPreviewVideoRenderElement::Stop ( )
pure virtual

Stop previewing.

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