Pro AV service interface. More...

#include <IProAVService.h>

Public Member Functions
virtual	~IProAVService ()

virtual ZRCSDKError	RegisterSink (IProAVServiceSink *pSink)=0
	Register pro AV service callback sink.

virtual ZRCSDKError	DeregisterSink (IProAVServiceSink *pSink)=0
	Deregister pro AV service callback sink.

virtual IDanteOutputHelper *	GetDanteOutputHelper ()=0
	Get the dante output helper.

virtual IHWIOHelper *	GetHWIOHelper ()=0
	Get the HWIO helper.

virtual ZRCSDKError	GetProAVVideoOverlaySettings (ProAVVideoOverlaySettings &settings)=0
	Query pro AV video overlay settings.

virtual ZRCSDKError	EnableProAVVideoActiveSpeakerGreenOutline (bool enable)=0
	Enable pro AV video active speaker green outline.

virtual ZRCSDKError	EnableProAVVideoReactionIcons (bool enable)=0
	Enable pro AV video reaction icons.

virtual ZRCSDKError	EnableProAVVideoRaiseHandIcon (bool enable)=0
	Enable pro AV video raise hand icon.

virtual ZRCSDKError	EnableProAVVideoMuteIcon (bool enable)=0
	Enable pro AV video mute icon.

virtual ZRCSDKError	EnableProAVVideoPollOverlay (bool enable)=0
	Enable pro AV video poll overlay.

virtual ZRCSDKError	EnableProAVVideoNameStrap (bool enable)=0
	Enable pro AV video name strap.

virtual ZRCSDKError	EnableProAVActiveSpeakerSelfView (bool enable)=0
	Enable show self view in Pro AV Active Speaker outputs.

virtual ZRCSDKError	SetProAVVideoNameStrapPosition (ProAVVideoNameStrapPosition position)=0
	Set pro AV video name strap position.

virtual ZRCSDKError	SetProAVGalleryDistributionMode (ProAVGalleryDistributionMode mode)=0
	Set pro AV gallery distribution mode.

virtual ZRCSDKError	SetProAVMaxGalleryPageCount (uint32_t count)=0
	Set pro AV max gallery page count.

virtual ZRCSDKError	SetProAVVideoElementScale (float scale)=0
	Set scaling factor for the video element.

virtual ZRCSDKError	SetProAVUnassignedBehavior (const ProAVUnassignedBehavior &behavior)=0
	Set pro AV video unassigned behavior.

virtual ZRCSDKError	GetProAVUnassignedBehavior (ProAVUnassignedBehavior &behavior)=0
	Query pro AV video unassigned behavior.

virtual ZRCSDKError	SetProAVVideoLossBehavior (const ProAVVideoLossBehavior &behavior)=0
	Set pro AV video loss behavior.

virtual ZRCSDKError	GetProAVVideoLossBehavior (ProAVVideoLossBehavior &behavior)=0
	Query pro AV video loss behavior.

virtual ZRCSDKError	SetProAVAssignedGallery (const ProAVAssignedGalleryInfo &assignedGallery, bool isPersistent)=0
	Set pro AV assigned gallery configuration. For non-persistent configurations, this method can only be called during a meeting. Persistent configurations can be set at any time and apply to all future meetings.

virtual ZRCSDKError	GetProAVPersistentAssignedGalleryInfos (std::vector< ProAVAssignedGalleryInfo > &infos)=0
	Query pro AV persistent assigned gallery infos.

virtual ZRCSDKError	RequestProAVAssignedGalleryStatus ()=0
	Request pro AV assigned gallery status from ZR during a meeting.

virtual ZRCSDKError	DeleteProAVAssignedGallerySeat (const std::vector< uint32_t > &deleteIndices)=0
	Delete pro AV assigned gallery seats during a meeting.

Detailed Description

Pro AV service interface.

Definition at line 237 of file IProAVService.h.

Constructor & Destructor Documentation

◆ ~IProAVService()

virtual IProAVService::~IProAVService ( )

inlinevirtual

Definition at line 240 of file IProAVService.h.

240{}

Member Function Documentation

◆ DeleteProAVAssignedGallerySeat()

virtual ZRCSDKError IProAVService::DeleteProAVAssignedGallerySeat ( const std::vector< uint32_t > & deleteIndices )

pure virtual

Delete pro AV assigned gallery seats during a meeting.

Since: 7.0.0

Zoom Rooms minimum version: 7.0.0

Parameters

deleteIndices The indices of seats to delete.

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

◆ DeregisterSink()

virtual ZRCSDKError IProAVService::DeregisterSink ( IProAVServiceSink * pSink )

pure virtual

Deregister pro AV service callback sink.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

pSink A pointer to the IProAVServiceSink that receives the pro AV service callback.

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

◆ EnableProAVActiveSpeakerSelfView()

virtual ZRCSDKError IProAVService::EnableProAVActiveSpeakerSelfView ( bool enable )

pure virtual

Enable show self view in Pro AV Active Speaker outputs.

Since: 7.0.0

Zoom Rooms minimum version: 7.0.0

Parameters

enable TRUE indicates enable self view in active speaker outputs. Otherwise disable (hide self view).

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

◆ EnableProAVVideoActiveSpeakerGreenOutline()

virtual ZRCSDKError IProAVService::EnableProAVVideoActiveSpeakerGreenOutline ( bool enable )

pure virtual

Enable pro AV video active speaker green outline.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

enable TRUE indicates enable active speaker green outline. Otherwise disable.

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

◆ EnableProAVVideoMuteIcon()

virtual ZRCSDKError IProAVService::EnableProAVVideoMuteIcon ( bool enable )

pure virtual

Enable pro AV video mute icon.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

enable TRUE indicates enable video mute icon. Otherwise disable.

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

◆ EnableProAVVideoNameStrap()

virtual ZRCSDKError IProAVService::EnableProAVVideoNameStrap ( bool enable )

pure virtual

Enable pro AV video name strap.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

enable TRUE indicates enable video name strap. Otherwise disable.

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

◆ EnableProAVVideoPollOverlay()

virtual ZRCSDKError IProAVService::EnableProAVVideoPollOverlay ( bool enable )

pure virtual

Enable pro AV video poll overlay.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

enable TRUE indicates enable video poll overlay. Otherwise disable.

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

◆ EnableProAVVideoRaiseHandIcon()

virtual ZRCSDKError IProAVService::EnableProAVVideoRaiseHandIcon ( bool enable )

pure virtual

Enable pro AV video raise hand icon.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

enable TRUE indicates enable raise hand icon. Otherwise disable.

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

◆ EnableProAVVideoReactionIcons()

virtual ZRCSDKError IProAVService::EnableProAVVideoReactionIcons ( bool enable )

pure virtual

Enable pro AV video reaction icons.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

enable TRUE indicates enable video reaction icons. Otherwise disable.

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

◆ GetDanteOutputHelper()

virtual IDanteOutputHelper * IProAVService::GetDanteOutputHelper ( )

pure virtual

Get the dante output helper.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

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

◆ GetHWIOHelper()

virtual IHWIOHelper * IProAVService::GetHWIOHelper ( )

pure virtual

Get the HWIO helper.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

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

◆ GetProAVPersistentAssignedGalleryInfos()

virtual ZRCSDKError IProAVService::GetProAVPersistentAssignedGalleryInfos ( std::vector< ProAVAssignedGalleryInfo > & infos )

pure virtual

Query pro AV persistent assigned gallery infos.

Since: 7.0.0

Zoom Rooms minimum version: 7.0.0

Parameters

[out] infos pro AV persistent assigned gallery infos, see ProAVAssignedGalleryInfo struct.

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

◆ GetProAVUnassignedBehavior()

virtual ZRCSDKError IProAVService::GetProAVUnassignedBehavior ( ProAVUnassignedBehavior & behavior )

pure virtual

Query pro AV video unassigned behavior.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

behavior pro AV video unassigned behavior, see ProAVUnassignedBehavior struct.

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

◆ GetProAVVideoLossBehavior()

virtual ZRCSDKError IProAVService::GetProAVVideoLossBehavior ( ProAVVideoLossBehavior & behavior )

pure virtual

Query pro AV video loss behavior.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

behavior pro AV video loss behavior, see ProAVVideoLossBehavior struct.

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

◆ GetProAVVideoOverlaySettings()

virtual ZRCSDKError IProAVService::GetProAVVideoOverlaySettings ( ProAVVideoOverlaySettings & settings )

pure virtual

Query pro AV video overlay settings.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

[out] settings pro AV video overlay settings, see ProAVVideoOverlaySettings struct.

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

◆ RegisterSink()

virtual ZRCSDKError IProAVService::RegisterSink ( IProAVServiceSink * pSink )

pure virtual

Register pro AV service callback sink.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

pSink A pointer to the IProAVServiceSink that receives the pro AV service callback.

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

◆ RequestProAVAssignedGalleryStatus()

virtual ZRCSDKError IProAVService::RequestProAVAssignedGalleryStatus ( )

pure virtual

Request pro AV assigned gallery status from ZR during a meeting.

Since: 7.0.0

Zoom Rooms minimum version: 7.0.0

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

◆ SetProAVAssignedGallery()

virtual ZRCSDKError IProAVService::SetProAVAssignedGallery	(	const ProAVAssignedGalleryInfo &	assignedGallery,
		bool	isPersistent
	)

pure virtual

Set pro AV assigned gallery configuration. For non-persistent configurations, this method can only be called during a meeting. Persistent configurations can be set at any time and apply to all future meetings.

Since: 7.0.0

Zoom Rooms minimum version: 7.0.0

Parameters

assignedGallery	pro AV assigned gallery info, see ProAVAssignedGalleryInfo struct.
isPersistent	TRUE indicates setting persistent configuration that applies to all meetings. FALSE indicates setting non-persistent configuration that only applies to the current meeting.

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

◆ SetProAVGalleryDistributionMode()

virtual ZRCSDKError IProAVService::SetProAVGalleryDistributionMode ( ProAVGalleryDistributionMode mode )

pure virtual

Set pro AV gallery distribution mode.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

mode	gallery distribution mode, see ProAVGalleryDistributionMode struct.

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

◆ SetProAVMaxGalleryPageCount()

virtual ZRCSDKError IProAVService::SetProAVMaxGalleryPageCount ( uint32_t count )

pure virtual

Set pro AV max gallery page count.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

count max gallery page count.

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

◆ SetProAVUnassignedBehavior()

virtual ZRCSDKError IProAVService::SetProAVUnassignedBehavior ( const ProAVUnassignedBehavior & behavior )

pure virtual

Set pro AV video unassigned behavior.

Since: 6.5.0

Zoom Rooms minimum version: 6.5.0

Parameters

behavior pro AV video unassigned behavior, see ProAVUnassignedBehavior struct.

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

◆ SetProAVVideoElementScale()

virtual ZRCSDKError IProAVService::SetProAVVideoElementScale ( float scale )

pure virtual

Set scaling factor for the video element.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

scale The scaling factor to apply. Recommended range: 0.5 to 3.0.

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

◆ SetProAVVideoLossBehavior()

virtual ZRCSDKError IProAVService::SetProAVVideoLossBehavior ( const ProAVVideoLossBehavior & behavior )

pure virtual

Set pro AV video loss behavior.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

behavior pro AV video loss behavior, see ProAVVideoLossBehavior struct.

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

◆ SetProAVVideoNameStrapPosition()

virtual ZRCSDKError IProAVService::SetProAVVideoNameStrapPosition ( ProAVVideoNameStrapPosition position )

pure virtual

Set pro AV video name strap position.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

position pro AV video name strap position, see ProAVVideoNameStrapPosition enum.

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

◆ ~IProAVService()

Member Function Documentation

◆ DeleteProAVAssignedGallerySeat()

◆ DeregisterSink()

◆ EnableProAVActiveSpeakerSelfView()

◆ EnableProAVVideoActiveSpeakerGreenOutline()

◆ EnableProAVVideoMuteIcon()

◆ EnableProAVVideoNameStrap()

◆ EnableProAVVideoPollOverlay()

◆ EnableProAVVideoRaiseHandIcon()

◆ EnableProAVVideoReactionIcons()

◆ GetDanteOutputHelper()

◆ GetHWIOHelper()

◆ GetProAVPersistentAssignedGalleryInfos()

◆ GetProAVUnassignedBehavior()

◆ GetProAVVideoLossBehavior()

◆ GetProAVVideoOverlaySettings()

◆ RegisterSink()

◆ RequestProAVAssignedGalleryStatus()

◆ SetProAVAssignedGallery()

◆ SetProAVGalleryDistributionMode()

◆ SetProAVMaxGalleryPageCount()

◆ SetProAVUnassignedBehavior()

◆ SetProAVVideoElementScale()

◆ SetProAVVideoLossBehavior()

◆ SetProAVVideoNameStrapPosition()