Meeting SDK for Windows API Reference
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
IActiveVideoRenderElement Class Referenceabstract

The active video render element interface in the meeting. More...

#include <customized_video_container.h>

Inherits IVideoRenderElement.

Public Member Functions

virtual SDKError Start ()=0
 Display the data of the current active user.
 
virtual SDKError Stop ()=0
 Hide the data of the current active user.
 
virtual ~IActiveVideoRenderElement ()
 
- Public Member Functions inherited from IVideoRenderElement
virtual VideoRenderElementType GetType ()=0
 Get the type of the video render element.
 
virtual RECT GetPos ()=0
 Get the area where the current render element is.
 
virtual SDKError SetPos (RECT pos)=0
 Specify a new display area of the current render element.
 
virtual SDKError Show ()=0
 Show the render element.
 
virtual SDKError Hide ()=0
 Hide the render element.
 
virtual unsigned int GetCurrentRenderUserId ()=0
 Get the user ID corresponding to the current render element.
 
virtual VideoRenderDataType GetCurrentRenderDataType ()=0
 Get the data type of the current render element.
 
virtual SDKError EnableShowScreenNameOnVideo (bool enable_show)=0
 Set the visibility of the screen name on the current render element.
 
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.
 
virtual ~IVideoRenderElement ()
 

Detailed Description

The active video render element interface in the meeting.

Definition at line 113 of file customized_video_container.h.

Constructor & Destructor Documentation

◆ ~IActiveVideoRenderElement()

virtual IActiveVideoRenderElement::~IActiveVideoRenderElement ( )
inlinevirtual

Definition at line 123 of file customized_video_container.h.

123{}

Member Function Documentation

◆ Start()

virtual SDKError IActiveVideoRenderElement::Start ( )
pure virtual

Display the data of the current active user.

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

◆ Stop()

virtual SDKError IActiveVideoRenderElement::Stop ( )
pure virtual

Hide the data of the current active user.

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