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

Video setting interface. More...

#include <setting_service_interface.h>

Public Member Functions

virtual IList< ICameraInfo *> * GetCameraList ()=0
 Get camera device list. More...
 
virtual SDKError SelectCamera (const wchar_t *deviceId)=0
 Select camera device. More...
 
virtual SDKError EnableVideoMirrorEffect (bool bEnable)=0
 Enable or disable video mirror effect. More...
 
virtual bool IsVideoMirrorEffectEnabled ()=0
 Get the flag to enable/disable the video mirror effect. More...
 
virtual SDKError EnableFaceBeautyEffect (bool bEnable)=0
 Enable or disable the video facial beauty effect. More...
 
virtual bool IsFaceBeautyEffectEnabled ()=0
 Get the flag to enable/disable the video facial beauty effect. More...
 
virtual SDKError EnableHDVideo (bool bEnable)=0
 Enable or disable HD video. More...
 
virtual bool IsHDVideoEnabled ()=0
 Get the flag to enable/disable the HD video. More...
 
virtual SDKError EnableAlwaysShowNameOnVideo (bool bEnable)=0
 Enable or disable to show the username on the video. More...
 
virtual bool IsAlwaysShowNameOnVideoEnabled ()=0
 Get the flag to enable/disable to show the username on video. More...
 
virtual SDKError EnableAutoTurnOffVideoWhenJoinMeeting (bool bEnable)=0
 Enable or disable to turn off the video when join meeting. More...
 
virtual bool IsAutoTurnOffVideoWhenJoinMeetingEnabled ()=0
 Get the flag to enable to turn off the video when join meeting. More...
 
virtual SDKError EnableAlwaysUse16v9 (bool bEnable)=0
 Enable or disable the 16V9 video mode. More...
 
virtual bool IsAlwaysUse16v9 ()=0
 Get the flag to enable/disable the 16V9 video mode. More...
 
virtual SDKError EnableSpotlightSelf (bool bEnable)=0
 Enable or disable to spotlight the video. More...
 
virtual bool IsSpotlightSelfEnabled ()=0
 Get the flag to enable/disable to spotlight video. More...
 
virtual SDKError EnableHardwareEncode (bool bEnable)=0
 Enable or disable the hardware acceleration. More...
 
virtual bool IsHardwareEncodeEnabled ()=0
 Get the flag to enable/disable the hardware acceleration. More...
 
virtual SDKError Enable49VideoesInGallaryView (bool bEnable)=0
 Enable or disable to show the participants in Gallery View up to 49 per screen. More...
 
virtual bool Is49VideoesInGallaryViewEnabled ()=0
 Get the flag to enable/disable to show the participants in Gallery View up to 49 per screen. More...
 
virtual SDKError EnableHideNoVideoUsersOnWallView (bool bEnable)=0
 Enable or disable to hide the non-video participants. More...
 
virtual bool IsHideNoVideoUsersOnWallViewEnabled ()=0
 Get the flag to enable/disable to hide non-video participants. More...
 
virtual ITestVideoDeviceHelperGetTestVideoDeviceHelper ()=0
 Get the pointer to ITestVideoDeviceHelper which is used to test camera device. More...
 
virtual SDKError SetVideoDeviceEvent (IVideoSettingContextEvent *pEvent)=0
 Video device monitor callback event. More...
 
virtual SDKError EnableVideoPreviewDialog (bool bEnable)=0
 Enable or disable to show the video preview dialog when join meeting. More...
 
virtual bool IsVideoPreviewDialogEnabled ()=0
 Get the flag to enable to show the video preview dialog when join meeting. More...
 

Detailed Description

Video setting interface.

Member Function Documentation

◆ Enable49VideoesInGallaryView()

virtual SDKError IVideoSettingContext::Enable49VideoesInGallaryView ( bool  bEnable)
pure virtual

Enable or disable to show the participants in Gallery View up to 49 per screen.

Parameters
bEnableTRUE indicates to show the participants in Gallery View up to 49 per screen.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableAlwaysShowNameOnVideo()

virtual SDKError IVideoSettingContext::EnableAlwaysShowNameOnVideo ( bool  bEnable)
pure virtual

Enable or disable to show the username on the video.

Parameters
bEnableTRUE indicates to show the username on the video.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableAlwaysUse16v9()

virtual SDKError IVideoSettingContext::EnableAlwaysUse16v9 ( bool  bEnable)
pure virtual

Enable or disable the 16V9 video mode.

Parameters
bEnableTRUE indicates to enable the 16V9 video mode.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableAutoTurnOffVideoWhenJoinMeeting()

virtual SDKError IVideoSettingContext::EnableAutoTurnOffVideoWhenJoinMeeting ( bool  bEnable)
pure virtual

Enable or disable to turn off the video when join meeting.

Parameters
bEnableTRUE indicates to enable to turn off the video when join meeting
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableFaceBeautyEffect()

virtual SDKError IVideoSettingContext::EnableFaceBeautyEffect ( bool  bEnable)
pure virtual

Enable or disable the video facial beauty effect.

Parameters
bEnableTRUE indicates to enable the video facial beauty effect.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableHardwareEncode()

virtual SDKError IVideoSettingContext::EnableHardwareEncode ( bool  bEnable)
pure virtual

Enable or disable the hardware acceleration.

Parameters
bEnableTRUE indicates to enable the hardware acceleration.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableHDVideo()

virtual SDKError IVideoSettingContext::EnableHDVideo ( bool  bEnable)
pure virtual

Enable or disable HD video.

Parameters
bEnableTRUE indicates to enable the HD video.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableHideNoVideoUsersOnWallView()

virtual SDKError IVideoSettingContext::EnableHideNoVideoUsersOnWallView ( bool  bEnable)
pure virtual

Enable or disable to hide the non-video participants.

Parameters
bEnableTRUE indicates to hide the non-video Participants.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableSpotlightSelf()

virtual SDKError IVideoSettingContext::EnableSpotlightSelf ( bool  bEnable)
pure virtual

Enable or disable to spotlight the video.

Parameters
bEnableTRUE indicates to enable to spotlight the video.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableVideoMirrorEffect()

virtual SDKError IVideoSettingContext::EnableVideoMirrorEffect ( bool  bEnable)
pure virtual

Enable or disable video mirror effect.

Parameters
bEnableTRUE indicates to enable the video mirror effect.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ EnableVideoPreviewDialog()

virtual SDKError IVideoSettingContext::EnableVideoPreviewDialog ( bool  bEnable)
pure virtual

Enable or disable to show the video preview dialog when join meeting.

Parameters
bEnableTRUE indicates to enable to show the video preview dialog when join meeting
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ GetCameraList()

virtual IList<ICameraInfo* >* IVideoSettingContext::GetCameraList ( )
pure virtual

Get camera device list.

Returns
If the function succeeds, the return value the is camera device list. Otherwise failed, returns NULL.

◆ GetTestVideoDeviceHelper()

virtual ITestVideoDeviceHelper* IVideoSettingContext::GetTestVideoDeviceHelper ( )
pure virtual

Get the pointer to ITestVideoDeviceHelper which is used to test camera device.

Returns
If the function succeeds, the return value is the pointer to ITestVideoDeviceHelper. Otherwise failed, returns NULL. For more details, see ITestVideoDeviceHelper.

◆ Is49VideoesInGallaryViewEnabled()

virtual bool IVideoSettingContext::Is49VideoesInGallaryViewEnabled ( )
pure virtual

Get the flag to enable/disable to show the participants in Gallery View up to 49 per screen.

Returns
Enabled or disabled.

◆ IsAlwaysShowNameOnVideoEnabled()

virtual bool IVideoSettingContext::IsAlwaysShowNameOnVideoEnabled ( )
pure virtual

Get the flag to enable/disable to show the username on video.

Returns
Enabled or disabled.

◆ IsAlwaysUse16v9()

virtual bool IVideoSettingContext::IsAlwaysUse16v9 ( )
pure virtual

Get the flag to enable/disable the 16V9 video mode.

Returns
Enabled or disabled.

◆ IsAutoTurnOffVideoWhenJoinMeetingEnabled()

virtual bool IVideoSettingContext::IsAutoTurnOffVideoWhenJoinMeetingEnabled ( )
pure virtual

Get the flag to enable to turn off the video when join meeting.

Returns
Enabled or disabled.

◆ IsFaceBeautyEffectEnabled()

virtual bool IVideoSettingContext::IsFaceBeautyEffectEnabled ( )
pure virtual

Get the flag to enable/disable the video facial beauty effect.

Returns
Enabled or disabled.

◆ IsHardwareEncodeEnabled()

virtual bool IVideoSettingContext::IsHardwareEncodeEnabled ( )
pure virtual

Get the flag to enable/disable the hardware acceleration.

Returns
Enabled or disabled.

◆ IsHDVideoEnabled()

virtual bool IVideoSettingContext::IsHDVideoEnabled ( )
pure virtual

Get the flag to enable/disable the HD video.

Returns
Enabled or disabled.

◆ IsHideNoVideoUsersOnWallViewEnabled()

virtual bool IVideoSettingContext::IsHideNoVideoUsersOnWallViewEnabled ( )
pure virtual

Get the flag to enable/disable to hide non-video participants.

Returns
Enabled or disabled.

◆ IsSpotlightSelfEnabled()

virtual bool IVideoSettingContext::IsSpotlightSelfEnabled ( )
pure virtual

Get the flag to enable/disable to spotlight video.

Returns
Enabled or disabled.

◆ IsVideoMirrorEffectEnabled()

virtual bool IVideoSettingContext::IsVideoMirrorEffectEnabled ( )
pure virtual

Get the flag to enable/disable the video mirror effect.

Returns
Enabled or disabled.

◆ IsVideoPreviewDialogEnabled()

virtual bool IVideoSettingContext::IsVideoPreviewDialogEnabled ( )
pure virtual

Get the flag to enable to show the video preview dialog when join meeting.

Returns
Enabled or disabled.

◆ SelectCamera()

virtual SDKError IVideoSettingContext::SelectCamera ( const wchar_t *  deviceId)
pure virtual

Select camera device.

Parameters
deviceIdSpecify a device to be selected.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.

◆ SetVideoDeviceEvent()

virtual SDKError IVideoSettingContext::SetVideoDeviceEvent ( IVideoSettingContextEvent pEvent)
pure virtual

Video device monitor callback event.

Parameters
pEventA pointer to the IVideoSettingContextEvent.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum. For more details, see IVideoSettingContextEvent.
Remarks
You must call the function if you want to monitor the video device plugged in/out.

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