ITestVideoDeviceHelper Class Reference

Video device test interface. More...

#include <setting_service_interface.h>

Public Member Functions
virtual SDKError	SetEvent (ITestVideoDeviceHelperEvent *pEvent)=0
	Video device test callback event handler.
virtual SDKError	SetVideoPreviewParentWnd (HWND hParentWnd, RECT rc=_SDK_TEST_VIDEO_INIT_RECT)=0
	Set the window and the rectangle to display the video preview.
virtual SDKError	TestVideoStartPreview (const zchar_t *deviceID=nullptr)=0
	Start to test the camera.
virtual SDKError	TestVideoStopPreview ()=0
	Stop testing the camera.
virtual SDKError	TestVideoRotate (PREVIEW_VIDEO_ROTATION_ACTION action)=0
	Rotate the video preview.
virtual ICameraController *	GetTestCameraController ()=0

Detailed Description

Video device test interface.

Definition at line 725 of file setting_service_interface.h.

Member Function Documentation

GetTestCameraController()

virtual ICameraController * ITestVideoDeviceHelper::GetTestCameraController ( )

pure virtual

SetEvent()

virtual SDKError ITestVideoDeviceHelper::SetEvent ( ITestVideoDeviceHelperEvent * pEvent )

pure virtual

Video device test callback event handler.

Parameters

pEvent

A pointer to the ITestVideoDeviceHelperEvent that receives video device test event.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

Note

Call the function before using any other interface of the same class.

SetVideoPreviewParentWnd()

virtual SDKError ITestVideoDeviceHelper::SetVideoPreviewParentWnd ( HWND hParentWnd, RECT rc = _SDK_TEST_VIDEO_INIT_RECT )

pure virtual

Set the window and the rectangle to display the video preview.

Parameters

hParentWnd	Specify the window to display the video preview.
rc	Specify a rectangle on the window to display the video preview. The default value is {0,0,0,0}, which means the whole client area of the window.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

Note

This function SHOULD only be called ONCE. Any redundant calling will return SDKERR_WRONG_USAGE.

TestVideoRotate()

virtual SDKError ITestVideoDeviceHelper::TestVideoRotate ( PREVIEW_VIDEO_ROTATION_ACTION action )

pure virtual

Rotate the video preview.

Parameters

action

Specify the action to rotate the video. For more details, see PREVIEW_VIDEO_ROTATION_ACTION.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

Note

The function can not work if there is no event or window handle to be set. It works also in the meeting video when you rotate the preview video. Please use it with cautions.

TestVideoStartPreview()

virtual SDKError ITestVideoDeviceHelper::TestVideoStartPreview ( const zchar_t * deviceID = nullptr )

pure virtual

Start to test the camera.

Parameters

deviceID

Specify a camera device to test. If the param is a wrong camera ID, SDK returns an error. Otherwise SDK tests the specified device and sets it to be the selected one.

Note

The SDK will test the default device if no parameter is input.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

Note

The function can not work if no event is set or no window handle is set.

TestVideoStopPreview()

virtual SDKError ITestVideoDeviceHelper::TestVideoStopPreview ( )

pure virtual

Stop testing the camera.

Returns

If the function succeeds, the return value is SDKERR_SUCCESS. Otherwise failed. For detailed error codes, see the SDKError enum.

Note

The function can not work if there is no event or window handle to be set.