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

Meeting video controller interface. More...

#include <meeting_video_interface.h>

Public Member Functions

virtual SDKError SetEvent (IMeetingVideoCtrlEvent *pEvent)=0
 Set the meeting video controller callback event handler. More...
 
virtual SDKError MuteVideo ()=0
 Turn off the user's own video. More...
 
virtual SDKError UnmuteVideo ()=0
 Turn on the user's own video. More...
 
virtual SDKError PinVideo (bool bPin, bool bFirstView, unsigned int userid)=0
 Pin the video of the assigned user. More...
 
virtual SDKError SpotlightVideo (bool bSpotlight, unsigned int userid)=0
 Spotlight the video of the assigned user. More...
 
virtual SDKError HideOrShowNoVideoUserOnVideoWall (bool bHide)=0
 Display or not the user who does not turn on the video in the video all mode. More...
 
virtual SDKError CanAskAttendeeToStartVideo (unsigned int userid)=0
 Query if it is able to demand the specified user to turn on the video. More...
 
virtual SDKError AskAttendeeToStartVideo (unsigned int userid)=0
 Demand the assigned user to turn on the video. More...
 
virtual SDKError CanStopAttendeeVideo (unsigned int userid)=0
 Query if it is able to demand the specified user to turn off the video. More...
 
virtual SDKError StopAttendeeVideo (unsigned int userid)=0
 Turn off the video of the assigned user. More...
 
virtual ICameraControllerGetMyCameraController ()=0
 Get camera controller interface. More...
 

Detailed Description

Meeting video controller interface.

Member Function Documentation

◆ AskAttendeeToStartVideo()

virtual SDKError IMeetingVideoController::AskAttendeeToStartVideo ( unsigned int  userid)
pure virtual

Demand the assigned user to turn on the video.

Parameters
useridSpecifies the user ID to demand.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid for both Zoom style and customize user interface mode.

◆ CanAskAttendeeToStartVideo()

virtual SDKError IMeetingVideoController::CanAskAttendeeToStartVideo ( unsigned int  userid)
pure virtual

Query if it is able to demand the specified user to turn on the video.

Parameters
useridSpecifies the user ID to query.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid for both Zoom style and customize user interface mode.

◆ CanStopAttendeeVideo()

virtual SDKError IMeetingVideoController::CanStopAttendeeVideo ( unsigned int  userid)
pure virtual

Query if it is able to demand the specified user to turn off the video.

Parameters
useridSpecifies the user ID to query.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid for both Zoom style and customize user interface mode.

◆ GetMyCameraController()

virtual ICameraController* IMeetingVideoController::GetMyCameraController ( )
pure virtual

Get camera controller interface.

Returns
If the function succeeds, the return value is a pointer to ICameraController. Otherwise returns NULL.

◆ HideOrShowNoVideoUserOnVideoWall()

virtual SDKError IMeetingVideoController::HideOrShowNoVideoUserOnVideoWall ( bool  bHide)
pure virtual

Display or not the user who does not turn on the video in the video all mode.

Returns
TRUE indicates to hide, FALSE show. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid only for Zoom style user interface mode.

◆ MuteVideo()

virtual SDKError IMeetingVideoController::MuteVideo ( )
pure virtual

Turn off the user's own video.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid for both Zoom style and customize user interface mode.

◆ PinVideo()

virtual SDKError IMeetingVideoController::PinVideo ( bool  bPin,
bool  bFirstView,
unsigned int  userid 
)
pure virtual

Pin the video of the assigned user.

Parameters
bPinTRUE indicates to pin.
bFirstViewTRUE indicates to pin the video on the primary view. FALSE indicates to pin the video on the secondary view. The function does not work when the user chooses FALSE without dual view.
useridSpecifies the user ID to be pinned.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid only for Zoom style user interface mode.

◆ SetEvent()

virtual SDKError IMeetingVideoController::SetEvent ( IMeetingVideoCtrlEvent pEvent)
pure virtual

Set the meeting video controller callback event handler.

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

◆ SpotlightVideo()

virtual SDKError IMeetingVideoController::SpotlightVideo ( bool  bSpotlight,
unsigned int  userid 
)
pure virtual

Spotlight the video of the assigned user.

Parameters
bSpotlightTRUE indicates to spotlight.
useridSpecifies the user ID to be spotlighted.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid for both Zoom style and customize user interface mode.

◆ StopAttendeeVideo()

virtual SDKError IMeetingVideoController::StopAttendeeVideo ( unsigned int  userid)
pure virtual

Turn off the video of the assigned user.

Parameters
useridSpecifies the user ID to turn off.
Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid for both Zoom style and customize user interface mode.

◆ UnmuteVideo()

virtual SDKError IMeetingVideoController::UnmuteVideo ( )
pure virtual

Turn on the user's own video.

Returns
If the function succeeds, the return value is SDKErr_Success. Otherwise failed. To get extended error information, see SDKError enum.
Remarks
Valid for both Zoom style and customize user interface mode.

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