ZOOM Windows SDK  5.2.41727.0928
Public Member Functions | List of all members
ICustomizedVideoContainer Class Referenceabstract

Video container interface. More...

#include <customized_video_container.h>

Public Member Functions

virtual SDKError SetEvent (ICustomizedVideoContainerEvent *pEvent)=0
 Set video container callback event handler. More...
 
virtual SDKError CreateVideoElement (IVideoRenderElement **ppElement, VideoRenderElementType type_)=0
 Create a video render element. More...
 
virtual SDKError DestroyVideoElement (IVideoRenderElement *ppElement)=0
 Destroy a video render element. More...
 
virtual SDKError DestroyAllVideoElement ()=0
 Destroy all the video render element. More...
 
virtual SDKError Show ()=0
 Show the video container. More...
 
virtual SDKError Hide ()=0
 Hide the video container. More...
 
virtual SDKError Resize (RECT rc)=0
 Resize the video container in the specified area. More...
 
virtual IList< IVideoRenderElement *> * GetVideoElementList ()=0
 Get the list of video render elements in the current container. More...
 

Detailed Description

Video container interface.

Member Function Documentation

◆ CreateVideoElement()

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

Create a video render element.

Parameters
[out]ppElementOnce 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 NULL. Otherwise failed. To get extended error information, see SDKError enum.

◆ 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 failed. To get extended error information, see SDKError enum.

◆ DestroyVideoElement()

virtual SDKError ICustomizedVideoContainer::DestroyVideoElement ( IVideoRenderElement ppElement)
pure virtual

Destroy a video render element.

Parameters
ppElementSpecify the video render element to be destroyed.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ GetVideoElementList()

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

Get 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 failed, 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 failed. To get extended error information, see SDKError enum.

◆ Resize()

virtual SDKError ICustomizedVideoContainer::Resize ( RECT  rc)
pure virtual

Resize the video container in the specified area.

Parameters
rcSpecify 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 failed. To get extended error information, see SDKError enum.

◆ SetEvent()

virtual SDKError ICustomizedVideoContainer::SetEvent ( ICustomizedVideoContainerEvent pEvent)
pure virtual

Set video container callback event handler.

Parameters
pEventA pointer to the ICustomizedVideoContainerEvent that receives video container callback event.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ Show()

virtual SDKError ICustomizedVideoContainer::Show ( )
pure virtual

Show the video container.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

The documentation for this class was generated from the following file: