Meeting Video helper interface. More...

#include <IMeetingVideoHelper.h>

Public Member Functions
virtual	~IMeetingVideoHelper ()

virtual ZRCSDKError	RegisterSink (IMeetingVideoHelperSink *pSink)=0
	Register meeting video helper callback sink.

virtual ZRCSDKError	DeregisterSink (IMeetingVideoHelperSink *pSink)=0
	Deregister meeting video helper callback sink.

virtual ZRCSDKError	UpdateMyVideo (bool stop)=0
	Mute or unmute self video.

virtual ZRCSDKError	MuteUserVideo (int32_t userID, bool mute)=0
	Mute or unmute the assigned user video.

virtual ZRCSDKError	AnswerHostRequestUnmuteVideo (bool accepted)=0
	Answer incoming unmute video request.

virtual ZRCSDKError	AllowAttendeesStartVideo (bool allow)=0
	Allow attendees start video.

virtual ZRCSDKError	ShowPinUserInstruction (bool show)=0
	Show the screen index of each display for pin video.

virtual ZRCSDKError	AllowUserMultiPin (int32_t userID, bool allow)=0
	Allow user multi pin.

virtual ZRCSDKError	PinUserOnScreen (int32_t userID, int32_t screenIndex)=0
	Pin user video on Zoom Room's screen.

virtual ZRCSDKError	AddPinUserOnScreen (int32_t userID, int32_t screenIndex)=0
	Add pin user on Zoom Room's screen.

virtual ZRCSDKError	UnpinUserFromScreen (int32_t userID, int32_t screenIndex)=0
	Unpin user video from screen.

virtual ZRCSDKError	UnpinUserFromAllScreens (int32_t userID)=0
	Unpin use video from all screens.

virtual ZRCSDKError	RemoveAllPinUsers ()=0
	Remove all users' pinned video.

virtual ZRCSDKError	SpotlightUser (int32_t userID)=0
	Spotlight user.

virtual ZRCSDKError	AddSpotlightUser (int32_t userID)=0
	Add spotlight user.

virtual ZRCSDKError	CancelSpotlightUser (int32_t userID)=0
	Cancel spotlight user.

virtual ZRCSDKError	RemoveAllSpotlightUsers ()=0
	Remove all spotlight users.

virtual ZRCSDKError	IsSupportSetMyVideoHidden (bool &support)=0
	Query if support set my video hidden.

virtual ZRCSDKError	SetMyVideoHidden (bool hidden)=0
	Set my video hidden.

virtual ZRCSDKError	SetMyVideoTouchUp (const MyVideoTouchUpSettings &settings)=0
	Set my video touch up settings. The meeting will use the specified settings, if you preset the settings for the specific meeting. And if you want to adjust touch up settings in meeting, you also can use this API.

virtual ZRCSDKError	SetMyVideoLowLight (const MyVideoLowLightSettings &settings)=0
	Set my video low light settings. The meeting will use the specified settings, if you preset the settings for the specific meeting. And if you want to adjust low light settings in meeting, you also can use this API.

virtual ZRCSDKError	FetchMyMeetingVideoSettings (const MeetingItem &meetingItem)=0
	Fetch my video settings of the specific meeting. If you want to see the effect of the settings, you can call the ShowVideoPreview API in IMeetingVideoHelper and set PreviewVideoTypeMeetingAlert as the value of type.

virtual ZRCSDKError	SetMyMeetingVideoTouchUp (const MeetingItem &meetingItem, const MyVideoTouchUpSettings &settings)=0
	Set my video touch up settings for the specific meeting.

virtual ZRCSDKError	SetMyMeetingVideoLowLight (const MeetingItem &meetingItem, const MyVideoLowLightSettings &settings)=0
	Set my video low light settings for the specific meeting.

virtual ZRCSDKError	ShowVideoPreview (bool show, PreviewVideoType type, const MeetingItem &meeting=MeetingItem())=0
	Show video preview.

Detailed Description

Meeting Video helper interface.

Definition at line 202 of file IMeetingVideoHelper.h.

Constructor & Destructor Documentation

◆ ~IMeetingVideoHelper()

virtual IMeetingVideoHelper::~IMeetingVideoHelper ( )

inlinevirtual

Definition at line 205 of file IMeetingVideoHelper.h.

205{}

Member Function Documentation

◆ AddPinUserOnScreen()

virtual ZRCSDKError IMeetingVideoHelper::AddPinUserOnScreen	(	int32_t	userID,
		int32_t	screenIndex
	)

pure virtual

Add pin user on Zoom Room's screen.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID	Specify the user ID to add pin.
screenIndex	Specify the screen index to add pin, see MeetingScreen enum.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ AddSpotlightUser()

virtual ZRCSDKError IMeetingVideoHelper::AddSpotlightUser ( int32_t userID )

pure virtual

Add spotlight user.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID Specify the user ID to add spotlight.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ AllowAttendeesStartVideo()

virtual ZRCSDKError IMeetingVideoHelper::AllowAttendeesStartVideo ( bool allow )

pure virtual

Allow attendees start video.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

allow TRUE indicate allow attendees start video. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ AllowUserMultiPin()

virtual ZRCSDKError IMeetingVideoHelper::AllowUserMultiPin	(	int32_t	userID,
		bool	allow
	)

pure virtual

Allow user multi pin.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID	Specify the user ID to allow multi pin.
allow	TRUE indicates allow to multi pin. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ AnswerHostRequestUnmuteVideo()

virtual ZRCSDKError IMeetingVideoHelper::AnswerHostRequestUnmuteVideo ( bool accepted )

pure virtual

Answer incoming unmute video request.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

accepted TURE indicates accept unmute request. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ CancelSpotlightUser()

virtual ZRCSDKError IMeetingVideoHelper::CancelSpotlightUser ( int32_t userID )

pure virtual

Cancel spotlight user.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID Specify the user ID to spotlight.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ DeregisterSink()

virtual ZRCSDKError IMeetingVideoHelper::DeregisterSink ( IMeetingVideoHelperSink * pSink )

pure virtual

Deregister meeting video helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingVideoHelperSink that receives the meeting video helper event callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ FetchMyMeetingVideoSettings()

virtual ZRCSDKError IMeetingVideoHelper::FetchMyMeetingVideoSettings ( const MeetingItem & meetingItem )

pure virtual

Fetch my video settings of the specific meeting. If you want to see the effect of the settings, you can call the ShowVideoPreview API in IMeetingVideoHelper and set PreviewVideoTypeMeetingAlert as the value of type.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

meetingItem The specific meeting item.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ IsSupportSetMyVideoHidden()

virtual ZRCSDKError IMeetingVideoHelper::IsSupportSetMyVideoHidden ( bool & support )

pure virtual

Query if support set my video hidden.

Since: 6.5.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] support TRUE indicates support set my video hidden.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ MuteUserVideo()

virtual ZRCSDKError IMeetingVideoHelper::MuteUserVideo	(	int32_t	userID,
		bool	mute
	)

pure virtual

Mute or unmute the assigned user video.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID	Specify the user ID to unmute.
mute	TRUE indicates to mute user video. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ PinUserOnScreen()

virtual ZRCSDKError IMeetingVideoHelper::PinUserOnScreen	(	int32_t	userID,
		int32_t	screenIndex
	)

pure virtual

Pin user video on Zoom Room's screen.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID	Specify the user ID to pin video.
screenIndex	Index of the screen to pin video, see MeetingScreen enum.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RegisterSink()

virtual ZRCSDKError IMeetingVideoHelper::RegisterSink ( IMeetingVideoHelperSink * pSink )

pure virtual

Register meeting video helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the IMeetingVideoHelperSink that receives the meeting video helper event callback.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RemoveAllPinUsers()

virtual ZRCSDKError IMeetingVideoHelper::RemoveAllPinUsers ( )

pure virtual

Remove all users' pinned video.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ RemoveAllSpotlightUsers()

virtual ZRCSDKError IMeetingVideoHelper::RemoveAllSpotlightUsers ( )

pure virtual

Remove all spotlight users.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SetMyMeetingVideoLowLight()

virtual ZRCSDKError IMeetingVideoHelper::SetMyMeetingVideoLowLight	(	const MeetingItem &	meetingItem,
		const MyVideoLowLightSettings &	settings
	)

pure virtual

Set my video low light settings for the specific meeting.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

meetingItem	The specific meeting item.
settings	My video low light settings.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SetMyMeetingVideoTouchUp()

virtual ZRCSDKError IMeetingVideoHelper::SetMyMeetingVideoTouchUp	(	const MeetingItem &	meetingItem,
		const MyVideoTouchUpSettings &	settings
	)

pure virtual

Set my video touch up settings for the specific meeting.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

meetingItem	The specific meeting item.
settings	My video touch up settings.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SetMyVideoHidden()

virtual ZRCSDKError IMeetingVideoHelper::SetMyVideoHidden ( bool hidden )

pure virtual

Set my video hidden.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

hidden TRUE indicates to hidden my video. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SetMyVideoLowLight()

virtual ZRCSDKError IMeetingVideoHelper::SetMyVideoLowLight ( const MyVideoLowLightSettings & settings )

pure virtual

Set my video low light settings. The meeting will use the specified settings, if you preset the settings for the specific meeting. And if you want to adjust low light settings in meeting, you also can use this API.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

settings My video low light settings.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SetMyVideoTouchUp()

virtual ZRCSDKError IMeetingVideoHelper::SetMyVideoTouchUp ( const MyVideoTouchUpSettings & settings )

pure virtual

Set my video touch up settings. The meeting will use the specified settings, if you preset the settings for the specific meeting. And if you want to adjust touch up settings in meeting, you also can use this API.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

settings My video touch up settings.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ ShowPinUserInstruction()

virtual ZRCSDKError IMeetingVideoHelper::ShowPinUserInstruction ( bool show )

pure virtual

Show the screen index of each display for pin video.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

show	TRUE indicates to show the instruction on ZR screen. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ ShowVideoPreview()

virtual ZRCSDKError IMeetingVideoHelper::ShowVideoPreview	(	bool	show,
		PreviewVideoType	type,
		const MeetingItem &	meeting = `MeetingItem()`
	)

pure virtual

Show video preview.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

show	TRUE indicates to show video preview. Otherwise not.
type	The preview video type.
meeting	The specific meeting. This field is necessary only when type == PreviewVideoTypeMeetingAlert.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ SpotlightUser()

virtual ZRCSDKError IMeetingVideoHelper::SpotlightUser ( int32_t userID )

pure virtual

Spotlight user.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID Specify the user ID to spotlight.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ UnpinUserFromAllScreens()

virtual ZRCSDKError IMeetingVideoHelper::UnpinUserFromAllScreens ( int32_t userID )

pure virtual

Unpin use video from all screens.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID Specify the user ID to unpin from all screens.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ UnpinUserFromScreen()

virtual ZRCSDKError IMeetingVideoHelper::UnpinUserFromScreen	(	int32_t	userID,
		int32_t	screenIndex
	)

pure virtual

Unpin user video from screen.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

userID	Specify the user ID to unpin.
screenIndex	Index of the screen to unpin, see MeetingScreen enum.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

◆ UpdateMyVideo()

virtual ZRCSDKError IMeetingVideoHelper::UpdateMyVideo ( bool stop )

pure virtual

Mute or unmute self video.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

stop	TRUE indicates mute self video. Otherwise not.

Returns: If the function succeeds, the return value is ZRCSDKERR_SUCCESS. Otherwise failed. To get extended error information, see ZRCSDKError enum.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IMeetingVideoHelper()

Member Function Documentation

◆ AddPinUserOnScreen()

◆ AddSpotlightUser()

◆ AllowAttendeesStartVideo()

◆ AllowUserMultiPin()

◆ AnswerHostRequestUnmuteVideo()

◆ CancelSpotlightUser()

◆ DeregisterSink()

◆ FetchMyMeetingVideoSettings()

◆ IsSupportSetMyVideoHidden()

◆ MuteUserVideo()

◆ PinUserOnScreen()

◆ RegisterSink()

◆ RemoveAllPinUsers()

◆ RemoveAllSpotlightUsers()

◆ SetMyMeetingVideoLowLight()

◆ SetMyMeetingVideoTouchUp()

◆ SetMyVideoHidden()

◆ SetMyVideoLowLight()

◆ SetMyVideoTouchUp()

◆ ShowPinUserInstruction()

◆ ShowVideoPreview()

◆ SpotlightUser()

◆ UnpinUserFromAllScreens()

◆ UnpinUserFromScreen()

◆ UpdateMyVideo()