IVideoRenderElement Class Reference

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
	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 base class for the video element interface.

Definition at line 60 of file customized_video_container.h.

Constructor & Destructor Documentation

~IVideoRenderElement()

virtual IVideoRenderElement::~IVideoRenderElement ( )

inlinevirtual

Definition at line 122 of file customized_video_container.h.

{}

Member Function Documentation

EnableShowScreenNameOnVideo()

virtual SDKError IVideoRenderElement::EnableShowScreenNameOnVideo ( bool enable_show )

pure virtual

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

Parameters

enable_show

true indicates to show the screen name.

Returns

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

GetCurrentRenderDataType()

virtual VideoRenderDataType IVideoRenderElement::GetCurrentRenderDataType ( )

pure virtual

Gets the data type of the current render element.

Returns

The data type of the current render elements.

GetCurrentRenderUserId()

virtual unsigned int IVideoRenderElement::GetCurrentRenderUserId ( )

pure virtual

Gets the user ID corresponding to the current render element.

Returns

The ID of the user.

GetPos()

virtual RECT IVideoRenderElement::GetPos ( )

pure virtual

Gets 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

Gets the type of the video render element.

Returns

If the function succeeds, it returns the type of the render element. Otherwise, this function fails and returns 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, this function returns an error.

SetPos()

virtual SDKError IVideoRenderElement::SetPos ( RECT pos )

pure virtual

Specify a new display area of the current render element.

Parameters

pos	Specify 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, this function returns an error.

SetResolution()

virtual SDKError IVideoRenderElement::SetResolution ( VideoRenderResolution resolution )

pure virtual

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.

Parameters

resolution

Specify the resolution for the video in the current render element.

Returns

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

Show()

virtual SDKError IVideoRenderElement::Show ( )

pure virtual

Show the render element.

Returns

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