ICustomizedVideoContainer Class Reference

Video container interface. More...

#include <customized_video_container.h>

Public Member Functions
virtual SDKError	SetEvent (ICustomizedVideoContainerEvent *pEvent)=0
	Sets video container callback event handler.
virtual SDKError	CreateVideoElement (IVideoRenderElement **ppElement, VideoRenderElementType type_)=0
	Create a video render element.
virtual SDKError	DestroyVideoElement (IVideoRenderElement *ppElement)=0
	Destroy a video render element.
virtual SDKError	DestroyAllVideoElement ()=0
	Destroy all the video render element.
virtual SDKError	Show ()=0
	Show the video container.
virtual SDKError	Hide ()=0
	Hide the video container.
virtual SDKError	Resize (RECT rc)=0
	Resize the video container in the specified area.
virtual SDKError	SetBkColor (unsigned long color)=0
	Sets the video container background color.
virtual IList< IVideoRenderElement * > *	GetVideoElementList ()=0
	Gets the list of video render elements in the current container.
virtual	~ICustomizedVideoContainer ()

Detailed Description

Video container interface.

Definition at line 258 of file customized_video_container.h.

Constructor & Destructor Documentation

~ICustomizedVideoContainer()

virtual ICustomizedVideoContainer::~ICustomizedVideoContainer ( )

inlinevirtual

Definition at line 321 of file customized_video_container.h.

{}

Member Function Documentation

CreateVideoElement()

virtual SDKError ICustomizedVideoContainer::CreateVideoElement ( IVideoRenderElement ** ppElement, VideoRenderElementType type_ )

pure virtual

Create a video render element.

Parameters

[out]	ppElement	Once the function succeeds, the parameter will store the pointer to the video render element.
	type_	Specify the type of the video render element to be created.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS, the return value of ppElement is not nullptr. Otherwise, this function returns an error.

DestroyAllVideoElement()

virtual SDKError ICustomizedVideoContainer::DestroyAllVideoElement ( )

pure virtual

Destroy all the video render element.

Returns

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

DestroyVideoElement()

virtual SDKError ICustomizedVideoContainer::DestroyVideoElement ( IVideoRenderElement * ppElement )

pure virtual

Destroy a video render element.

Parameters

ppElement

Specify the video render element to be destroyed.

Returns

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

GetVideoElementList()

virtual IList< IVideoRenderElement * > * ICustomizedVideoContainer::GetVideoElementList ( )

pure virtual

Gets the list of video render elements in the current container.

Returns

If the function succeeds, the return value is the list that stores the video render element. Otherwise, this function fails and the return list is blank.

Hide()

virtual SDKError ICustomizedVideoContainer::Hide ( )

pure virtual

Hide the video container.

Returns

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

Resize()

virtual SDKError ICustomizedVideoContainer::Resize ( RECT rc )

pure virtual

Resize the video container in the specified area.

Parameters

rc	Specify a new display area. The coordinate value of the structure is that of the parent window of video container.

Returns

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

SetBkColor()

virtual SDKError ICustomizedVideoContainer::SetBkColor ( unsigned long color )

pure virtual

Sets the video container background color.

Parameters

color

Specify the color of the video container background in RGB format.

Returns

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

SetEvent()

virtual SDKError ICustomizedVideoContainer::SetEvent ( ICustomizedVideoContainerEvent * pEvent )

pure virtual

Sets video container callback event handler.

Parameters

pEvent

A pointer to the ICustomizedVideoContainerEvent that receives video container callback event.

Returns

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

Show()

virtual SDKError ICustomizedVideoContainer::Show ( )

pure virtual

Show the video container.

Returns

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