IPreviewVideoRenderElement Class Reference

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
	Starts previewing.
virtual SDKError	Stop ()=0
	Stops previewing.
virtual	~IPreviewVideoRenderElement ()
Public Member Functions inherited from IVideoRenderElement
virtual VideoRenderElementType	GetType ()=0
	Gets the type of the video render element.
virtual RECT	GetPos ()=0
	Gets 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
	Gets the user ID corresponding to the current render element.
virtual VideoRenderDataType	GetCurrentRenderDataType ()=0
	Gets the data type of the current render element.
virtual SDKError	EnableShowScreenNameOnVideo (bool enable_show)=0
	Sets the visibility of the screen name on the current render element.
virtual SDKError	SetResolution (VideoRenderResolution resolution)=0
	Sets 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 interface to preview the video render element of the participant who joins the meeting before the host.

Definition at line 128 of file customized_video_container.h.

Constructor & Destructor Documentation

~IPreviewVideoRenderElement()

virtual IPreviewVideoRenderElement::~IPreviewVideoRenderElement ( )

inlinevirtual

Definition at line 143 of file customized_video_container.h.

{}

Member Function Documentation

Start()

virtual SDKError IPreviewVideoRenderElement::Start ( )

pure virtual

Starts previewing.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.

Stop()

virtual SDKError IPreviewVideoRenderElement::Stop ( )

pure virtual

Stops previewing.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise, this function returns an error.