Dante Output helper interface. More...

#include <IDanteOutputHelper.h>

Public Member Functions
virtual	~IDanteOutputHelper ()

virtual ZRCSDKError	RegisterSink (IDanteOutputHelperSink *pSink)=0
	Register dante output helper callback sink.

virtual ZRCSDKError	DeregisterSink (IDanteOutputHelperSink *pSink)=0
	Deregister meeting dante output callback sink.

virtual ZRCSDKError	IsSupportDanteOutput (bool &isSupport)=0
	Check if support dante output feature.

virtual ZRCSDKError	CreateLocalNetworkAudioDevice (const std::string &name, int32_t rxChannelCount=8, int32_t txChannelCount=8)=0
	Create local network audio device. You can call GetLocalNetworkAudioDeviceInfo API to check if exist local network device before you call this API.

virtual ZRCSDKError	DestroyLocalNetworkAudioDevice (const std::string &name)=0
	Destroy local network audio device.

virtual ZRCSDKError	BindUserAudioConnection (int32_t userID, const LocalNetworkAudioChannelInfo &channel, AudioSignalType signalType=AudioSignalTypeMono)=0
	Bind user audio to a channel.

virtual ZRCSDKError	UnbindUserAudioConnection (int32_t userID, AudioSignalType signalType)=0
	Unbind user audio.

virtual ZRCSDKError	BindMixedAudioConnection (const LocalNetworkAudioChannelInfo &channel, AudioSignalType signalType)=0
	Bind mixed audio to a channel. The mixed audio refers to the total audio in the meeting.

virtual ZRCSDKError	UnbindMixedAudioConnection (AudioSignalType signalType)=0
	Unbind mixed audio.

virtual ZRCSDKError	BindShareContentAudioConnection (const LocalNetworkAudioChannelInfo &channel, AudioSignalType signalType)=0
	Bind share content audio to a channel. The share content audio refers to the total audio of share content.

virtual ZRCSDKError	UnbindShareContentAudioConnection (AudioSignalType signalType)=0
	Unbind share content audio.

virtual ZRCSDKError	BindGalleryMixedAudioConnection (const NetworkAudioBroadcastGalleryBindInfo &galleryBindInfo, const LocalNetworkAudioChannelInfo &channel)=0
	Bind one page of gallery mixed audio to a channel. The gallery mixed audio refers to the total audio of the specific page.

virtual ZRCSDKError	UnbindGalleryMixedAudioConnection (const NetworkAudioBroadcastGalleryBindInfo &galleryBindInfo)=0
	Unbind one page of gallery mixed audio.

virtual ZRCSDKError	BindInterpretationAudioConnection (int32_t languageID, const LocalNetworkAudioChannelInfo &channel)=0
	Bind interpretation audio to a channel.

virtual ZRCSDKError	UnbindInterpretationAudioConnection (int32_t languageID)=0
	Unbind interpretation audio.

virtual ZRCSDKError	UnbindAllAudioConnection ()=0
	Unbind all audio connection.

virtual ZRCSDKError	ListAllAudioConnection ()=0
	List all audio connection.

virtual ZRCSDKError	UnbindChannelAudio (const LocalNetworkAudioChannelInfo &channel)=0
	Unbind the audio in the specified channel.

virtual ZRCSDKError	ListAllUnbindChannel ()=0
	List all unbind channel.

virtual ZRCSDKError	GetLocalNetworkAudioDeviceInfo (LocalNetworkAudioDeviceInfo &info)=0
	Get local network audio device info.

Detailed Description

Dante Output helper interface.

Definition at line 480 of file IDanteOutputHelper.h.

Constructor & Destructor Documentation

◆ ~IDanteOutputHelper()

virtual IDanteOutputHelper::~IDanteOutputHelper ( )

inlinevirtual

Definition at line 483 of file IDanteOutputHelper.h.

483{}

Member Function Documentation

◆ BindGalleryMixedAudioConnection()

virtual ZRCSDKError IDanteOutputHelper::BindGalleryMixedAudioConnection	(	const NetworkAudioBroadcastGalleryBindInfo &	galleryBindInfo,
		const LocalNetworkAudioChannelInfo &	channel
	)

pure virtual

Bind one page of gallery mixed audio to a channel. The gallery mixed audio refers to the total audio of the specific page.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

galleryBindInfo	The info of the gallery mixed audio.
channel	The channel which the gallery mixed audio is bound to.

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

◆ BindInterpretationAudioConnection()

virtual ZRCSDKError IDanteOutputHelper::BindInterpretationAudioConnection	(	int32_t	languageID,
		const LocalNetworkAudioChannelInfo &	channel
	)

pure virtual

Bind interpretation audio to a channel.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

languageID	The interpretation languageID. Call IClosedCaptionHelper::GetInterpretLanguageInfoList to get supported interpretation languages.
channel	The channel which the language ID is bound to.

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

◆ BindMixedAudioConnection()

virtual ZRCSDKError IDanteOutputHelper::BindMixedAudioConnection	(	const LocalNetworkAudioChannelInfo &	channel,
		AudioSignalType	signalType
	)

pure virtual

Bind mixed audio to a channel. The mixed audio refers to the total audio in the meeting.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

channel	The channel which the mixed audio is bound to.
signalType	The signal type of the mixed audio.

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

Changelog

6.6.0: Support pre-configuration in pre-meeting.

◆ BindShareContentAudioConnection()

virtual ZRCSDKError IDanteOutputHelper::BindShareContentAudioConnection	(	const LocalNetworkAudioChannelInfo &	channel,
		AudioSignalType	signalType
	)

pure virtual

Bind share content audio to a channel. The share content audio refers to the total audio of share content.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

channel	The channel which the share content audio is bound to.
signalType	The signal type of the share content audio.

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

Changelog

6.6.0: Support pre-configuration in pre-meeting.

◆ BindUserAudioConnection()

virtual ZRCSDKError IDanteOutputHelper::BindUserAudioConnection	(	int32_t	userID,
		const LocalNetworkAudioChannelInfo &	channel,
		AudioSignalType	signalType = `AudioSignalTypeMono`
	)

pure virtual

Bind user audio to a channel.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

userID	The userID specifies which user's audio.
channel	The channel which the user audio is bound to.
signalType	The signal type of the user audio.

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

Changelog

6.6.0: Support pre-configuration in pre-meeting.

◆ CreateLocalNetworkAudioDevice()

virtual ZRCSDKError IDanteOutputHelper::CreateLocalNetworkAudioDevice	(	const std::string &	name,
		int32_t	rxChannelCount = `8`,
		int32_t	txChannelCount = `8`
	)

pure virtual

Create local network audio device. You can call GetLocalNetworkAudioDeviceInfo API to check if exist local network device before you call this API.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

name	The name of the local network audio device.
rxChannelCount	The RX channel count of the local network audio device.
txChannelCount	The TX channel count of the local network audio device.

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

◆ DeregisterSink()

virtual ZRCSDKError IDanteOutputHelper::DeregisterSink ( IDanteOutputHelperSink * pSink )

pure virtual

Deregister meeting dante output callback sink.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

pSink A pointer to the IDanteOutputHelperSink that receives the dante output helper callback.

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

◆ DestroyLocalNetworkAudioDevice()

virtual ZRCSDKError IDanteOutputHelper::DestroyLocalNetworkAudioDevice ( const std::string & name )

pure virtual

Destroy local network audio device.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

name	The name of the local network audio device which will be destroyed.

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

◆ GetLocalNetworkAudioDeviceInfo()

virtual ZRCSDKError IDanteOutputHelper::GetLocalNetworkAudioDeviceInfo ( LocalNetworkAudioDeviceInfo & info )

pure virtual

Get local network audio device info.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] info The local network audio device info.

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

Changelog

6.6.0: Support pre-configuration in pre-meeting.

◆ IsSupportDanteOutput()

virtual ZRCSDKError IDanteOutputHelper::IsSupportDanteOutput ( bool & isSupport )

pure virtual

Check if support dante output feature.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

[out] isSupport TRUE indicates support dante output feature. Otherwise not.

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

◆ ListAllAudioConnection()

virtual ZRCSDKError IDanteOutputHelper::ListAllAudioConnection ( )

pure virtual

List all audio connection.

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.

Changelog

6.6.0: Support pre-configuration in pre-meeting.

◆ ListAllUnbindChannel()

virtual ZRCSDKError IDanteOutputHelper::ListAllUnbindChannel ( )

pure virtual

List all unbind channel.

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.

Changelog

6.6.0: Support pre-configuration in pre-meeting.

◆ RegisterSink()

virtual ZRCSDKError IDanteOutputHelper::RegisterSink ( IDanteOutputHelperSink * pSink )

pure virtual

Register dante output helper callback sink.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

pSink A pointer to the IDanteOutputHelperSink that receives the dante output helper callback.

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

◆ UnbindAllAudioConnection()

virtual ZRCSDKError IDanteOutputHelper::UnbindAllAudioConnection ( )

pure virtual

Unbind all audio connection.

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.

Changelog

6.6.0: Support pre-configuration in pre-meeting.

◆ UnbindChannelAudio()

virtual ZRCSDKError IDanteOutputHelper::UnbindChannelAudio ( const LocalNetworkAudioChannelInfo & channel )

pure virtual

Unbind the audio in the specified channel.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

channel The channel specifies which channel will unbind the audio.

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

Changelog

6.6.0: Support pre-configuration in pre-meeting.

◆ UnbindGalleryMixedAudioConnection()

virtual ZRCSDKError IDanteOutputHelper::UnbindGalleryMixedAudioConnection ( const NetworkAudioBroadcastGalleryBindInfo & galleryBindInfo )

pure virtual

Unbind one page of gallery mixed audio.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

galleryBindInfo The info of the gallery mixed audio.

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

◆ UnbindInterpretationAudioConnection()

virtual ZRCSDKError IDanteOutputHelper::UnbindInterpretationAudioConnection ( int32_t languageID )

pure virtual

Unbind interpretation audio.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

languageID The interpretation languageID.

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

◆ UnbindMixedAudioConnection()

virtual ZRCSDKError IDanteOutputHelper::UnbindMixedAudioConnection ( AudioSignalType signalType )

pure virtual

Unbind mixed audio.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

signalType The signal type of the mixed audio.

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

Changelog

6.6.0: Support pre-configuration in pre-meeting.

◆ UnbindShareContentAudioConnection()

virtual ZRCSDKError IDanteOutputHelper::UnbindShareContentAudioConnection ( AudioSignalType signalType )

pure virtual

Unbind share content audio.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

signalType The signal type of the share content.

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

Changelog

6.6.0: Support pre-configuration in pre-meeting.

◆ UnbindUserAudioConnection()

virtual ZRCSDKError IDanteOutputHelper::UnbindUserAudioConnection	(	int32_t	userID,
		AudioSignalType	signalType
	)

pure virtual

Unbind user audio.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

userID	The userID specifies which user's audio.
signalType	The signal type of the user audio.

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

Changelog

6.6.0: Support pre-configuration in pre-meeting.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IDanteOutputHelper()

Member Function Documentation

◆ BindGalleryMixedAudioConnection()

◆ BindInterpretationAudioConnection()

◆ BindMixedAudioConnection()

◆ BindShareContentAudioConnection()

◆ BindUserAudioConnection()

◆ CreateLocalNetworkAudioDevice()

◆ DeregisterSink()

◆ DestroyLocalNetworkAudioDevice()

◆ GetLocalNetworkAudioDeviceInfo()

◆ IsSupportDanteOutput()

◆ ListAllAudioConnection()

◆ ListAllUnbindChannel()

◆ RegisterSink()

◆ UnbindAllAudioConnection()

◆ UnbindChannelAudio()

◆ UnbindGalleryMixedAudioConnection()

◆ UnbindInterpretationAudioConnection()

◆ UnbindMixedAudioConnection()

◆ UnbindShareContentAudioConnection()

◆ UnbindUserAudioConnection()