NDI helper interface. More...

#include <INDIHelper.h>

Public Member Functions
virtual	~INDIHelper ()

virtual ZRCSDKError	RegisterSink (INDIHelperSink *pSink)=0
	Register NDI helper callback sink.

virtual ZRCSDKError	DeregisterSink (INDIHelperSink *pSink)=0
	Deregister meeting NDI callback sink.

virtual ZRCSDKError	SetNDIResolution (NDIResolution resolution)=0
	Set NDI output resolution.

virtual ZRCSDKError	SetNDIFrameRate (NDIFrameRate frameRate)=0
	Set NDI output frame rate.

virtual ZRCSDKError	SetNDIEnableInPreMeeting (bool enable)=0
	Set NDI enable in premeeting.

virtual ZRCSDKError	SetNDIOutputCount (int32_t outputCount)=0
	Set NDI output count.

virtual ZRCSDKError	GetAvailableNDISources (std::vector< NDISource > &sources)=0
	Get available NDI sources.

virtual ZRCSDKError	GetNDIPinnedSources (std::vector< NDIPinnedSource > &sources)=0
	Get NDI usage sources.

virtual ZRCSDKError	PinNDI (const NDISource &source, int32_t index)=0
	Non-persistently pin NDI source in meeting.

virtual ZRCSDKError	UnpinNDI (const NDISource &source, int32_t index)=0
	Non-persistently unpin NDI usage source in meeting.

virtual ZRCSDKError	GetNDIDeviceList (std::vector< Device > &devices)=0
	Get NDI device list.

virtual ZRCSDKError	AddPersistentNDISource (const NDISource &source, int32_t index)=0
	Add persistent NDI source.

virtual ZRCSDKError	RemovePersistentNDISource (int32_t index)=0
	Remove persistent NDI source.

virtual ZRCSDKError	ListPersistentNDISources ()=0
	List persist NDI sources.

Detailed Description

NDI helper interface.

Definition at line 171 of file INDIHelper.h.

Constructor & Destructor Documentation

◆ ~INDIHelper()

virtual INDIHelper::~INDIHelper ( )

inlinevirtual

Definition at line 174 of file INDIHelper.h.

174{}

Member Function Documentation

◆ AddPersistentNDISource()

virtual ZRCSDKError INDIHelper::AddPersistentNDISource	(	const NDISource &	source,
		int32_t	index
	)

pure virtual

Add persistent NDI source.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

source	The NDI source to persistently pinned.
index	The index where NDI source to be persistently pinned.

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

Changelog

6.4.0: Replaced the input parameters with NDISource and index.
6.4.0: Added support for configuring the gallery view grid size when pinning a gallery.

◆ DeregisterSink()

virtual ZRCSDKError INDIHelper::DeregisterSink ( INDIHelperSink * pSink )

pure virtual

Deregister meeting NDI callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the INDIHelperSink that receives the NDI helper callback.

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

◆ GetAvailableNDISources()

virtual ZRCSDKError INDIHelper::GetAvailableNDISources ( std::vector< NDISource > & sources )

pure virtual

Get available NDI sources.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] sources The available NDI sources.

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

◆ GetNDIDeviceList()

virtual ZRCSDKError INDIHelper::GetNDIDeviceList ( std::vector< Device > & devices )

pure virtual

Get NDI device list.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] devices The NDI devices.

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

◆ GetNDIPinnedSources()

virtual ZRCSDKError INDIHelper::GetNDIPinnedSources ( std::vector< NDIPinnedSource > & sources )

pure virtual

Get NDI usage sources.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

[out] sources The NDI usage sources.

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

◆ ListPersistentNDISources()

virtual ZRCSDKError INDIHelper::ListPersistentNDISources ( )

pure virtual

List persist NDI sources.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

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

◆ PinNDI()

virtual ZRCSDKError INDIHelper::PinNDI	(	const NDISource &	source,
		int32_t	index
	)

pure virtual

Non-persistently pin NDI source in meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

source	The NDI source to non-persistently pinned, you can get NDI sources from GetAvailableNDISources function.
index	The index where NDI source to be pinned, can't exceed the supportedCount in NDIUsageInfo struct.

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

Changelog

6.4.0: Added support for configuring the gallery view grid size when pinning a gallery.

◆ RegisterSink()

virtual ZRCSDKError INDIHelper::RegisterSink ( INDIHelperSink * pSink )

pure virtual

Register NDI helper callback sink.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

pSink A pointer to the INDIHelperSink that receives the NDI helper callback.

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

◆ RemovePersistentNDISource()

virtual ZRCSDKError INDIHelper::RemovePersistentNDISource ( int32_t index )

pure virtual

Remove persistent NDI source.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

index The index where persistent NDI source to be removed.

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

◆ SetNDIEnableInPreMeeting()

virtual ZRCSDKError INDIHelper::SetNDIEnableInPreMeeting ( bool enable )

pure virtual

Set NDI enable in premeeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

enable TRUE indicates enable NDI in premeeting.

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

◆ SetNDIFrameRate()

virtual ZRCSDKError INDIHelper::SetNDIFrameRate ( NDIFrameRate frameRate )

pure virtual

Set NDI output frame rate.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

frameRate The NDI output frame rate, such as NDIFrameRate enum.

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

◆ SetNDIOutputCount()

virtual ZRCSDKError INDIHelper::SetNDIOutputCount ( int32_t outputCount )

pure virtual

Set NDI output count.

Since: 6.4.0

Zoom Rooms minimum version: 6.4.0

Parameters

outputCount NDI output count.

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

◆ SetNDIResolution()

virtual ZRCSDKError INDIHelper::SetNDIResolution ( NDIResolution resolution )

pure virtual

Set NDI output resolution.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

resolution The NDI output resolution, such as NDIResolution enum.

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

◆ UnpinNDI()

virtual ZRCSDKError INDIHelper::UnpinNDI	(	const NDISource &	source,
		int32_t	index
	)

pure virtual

Non-persistently unpin NDI usage source in meeting.

Since: 6.0.0

Zoom Rooms minimum version: 6.0.0

Parameters

source	The NDI usage source to be unpinned, you can get NDI usage sources from INDIHelperSink::OnNDIUsageNotification sink or INDIHelper::GetNDIPinnedSources function.
index	The index where NDI source to be unpinned.

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

◆ ~INDIHelper()

Member Function Documentation

◆ AddPersistentNDISource()

◆ DeregisterSink()

◆ GetAvailableNDISources()

◆ GetNDIDeviceList()

◆ GetNDIPinnedSources()

◆ ListPersistentNDISources()

◆ PinNDI()

◆ RegisterSink()

◆ RemovePersistentNDISource()

◆ SetNDIEnableInPreMeeting()

◆ SetNDIFrameRate()

◆ SetNDIOutputCount()

◆ SetNDIResolution()

◆ UnpinNDI()