IProAVService Class Reference

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	SetProAVVideoNameStrapPosition (ProAVVideoNameStrapPosition position)=0
	Set pro AV video name strap position.
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.

Detailed Description

Pro AV service interface.

Definition at line 103 of file IProAVService.h.

Constructor & Destructor Documentation

~IProAVService()

virtual IProAVService::~IProAVService ( )

inlinevirtual

Definition at line 106 of file IProAVService.h.

{}

Member Function Documentation

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 premeeting service callback.

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.

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.

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 premeeting service callback.

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.

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.