Dante output helper event callback. More...

#include <IDanteOutputHelper.h>

Public Member Functions
virtual	~IDanteOutputHelperSink ()

virtual void	OnCreateLocalNetworkAudioDevice (int32_t result, const LocalNetworkAudioDeviceInfo &info)=0
	Create local network audio device notification.

virtual void	OnDestroyLocalNetworkAudioDevice (int32_t result)=0
	Destroy local network audio device notification.

virtual void	OnLocalNetworkAudioDeviceError (const NetworkAudioError &error)=0
	Local network audio error notification.

virtual void	OnLocalNetworkAudioDeviceInfoNotification (const LocalNetworkAudioDeviceInfo &info)=0
	Local network audio info notification.

virtual void	OnBindUserAudioConnectionSuccess (const std::vector< NetworkAudioBroadcastConnectionInfo > &connections)=0
	Bind user audio connection success notification.

virtual void	OnBindUserAudioConnectionError (const NetworkAudioError &result, int32_t userID, const LocalNetworkAudioChannelInfo &channel, AudioSignalType signalType)=0
	Bind user audio connection error notification.

virtual void	OnUnbindUserAudioConnectionSuccess (const std::vector< NetworkAudioBroadcastConnectionInfo > &connections)=0
	Unbind user audio connection success notification.

virtual void	OnUnbindUserAudioConnectionError (const NetworkAudioError &result, int32_t userID, AudioSignalType signalType)=0
	Unbind user audio connection error notification.

virtual void	OnBindMixedAudioConnectionSuccess (const std::vector< NetworkAudioBroadcastConnectionInfo > &connections)=0
	Bind mixed audio connection success notification.

virtual void	OnBindMixedAudioConnectionError (const NetworkAudioError &result, const LocalNetworkAudioChannelInfo &channel, AudioSignalType signalType)=0
	Bind mixed audio connection error notification.

virtual void	OnUnbindMixedAudioConnectionSuccess (const std::vector< NetworkAudioBroadcastConnectionInfo > &connections)=0
	Unbind mixed audio connection success notification.

virtual void	OnUnbindMixedAudioConnectionError (const NetworkAudioError &result, AudioSignalType signalType)=0
	Unbind mixed audio connection error notification.

virtual void	OnUnbindAllAudioConnection (const NetworkAudioError &result, const std::vector< NetworkAudioBroadcastConnectionInfo > &connections)=0
	Unbind all audio connection notification.

virtual void	OnListAllAudioConnection (const NetworkAudioError &result, const std::vector< NetworkAudioBroadcastConnectionInfo > &connections)=0
	List all audio connection notification.

virtual void	OnUpdateAudioConnection (const std::vector< NetworkAudioBroadcastConnectionInfo > &connections)=0
	Update audio connection notification.

virtual void	OnUnbindChannelAudioConnectionSuccess (const std::vector< NetworkAudioBroadcastConnectionInfo > &connections)=0
	Unbind the audio in the specified channel success notification.

virtual void	OnUnbindChannelAudioConnectionError (const NetworkAudioError &result, const LocalNetworkAudioChannelInfo &channel)=0
	Unbind the audio in the specified channel error notification.

virtual void	OnListAllUnbindChannel (const NetworkAudioError &result, const std::vector< LocalNetworkAudioChannelInfo > &txChannels)=0
	List all unbind channel notification.

virtual void	OnBindShareContentAudioConnectionSuccess (const std::vector< NetworkAudioBroadcastConnectionInfo > &connections)=0
	Bind share content connection success notification.

virtual void	OnBindShareContentAudioConnectionError (const NetworkAudioError &result, const LocalNetworkAudioChannelInfo &channel, AudioSignalType signalType)=0
	Bind share content connection error notification.

virtual void	OnUnbindShareContentAudioConnectionSuccess (const std::vector< NetworkAudioBroadcastConnectionInfo > &connections)=0
	Unbind share content audio connection success notification.

virtual void	OnUnbindShareContentAudioConnectionError (const NetworkAudioError &result, AudioSignalType signalType)=0
	Unbind share content audio connection error notification.

virtual void	OnBindGalleryMixedAudioConnectionSuccess (const std::vector< NetworkAudioBroadcastConnectionInfo > &connections)=0
	Bind gallery mixed audio connection success notification.

virtual void	OnBindGalleryMixedAudioConnectionError (const NetworkAudioError &result, const NetworkAudioBroadcastGalleryBindInfo &galleryBindInfo, const LocalNetworkAudioChannelInfo &channel)=0
	Bind gallery mixed audio connection error notification.

virtual void	OnUnbindGalleryMixedAudioConnectionSuccess (const std::vector< NetworkAudioBroadcastConnectionInfo > &connections)=0
	Unbind gallery mixed audio connection success notification.

virtual void	OnUnbindGalleryMixedAudioConnectionError (const NetworkAudioError &result, const NetworkAudioBroadcastGalleryBindInfo &galleryBindInfo)=0
	Unbind gallery mixed audio connection error notification.

virtual void	OnBindInterpretationAudioConnectionSuccess (const std::vector< NetworkAudioBroadcastConnectionInfo > &connections)=0
	Bind interpretation audio connection success notification.

virtual void	OnBindInterpretationAudioConnectionError (const NetworkAudioError &result, int32_t languageID, const LocalNetworkAudioChannelInfo &channel)=0
	Bind interpretation audio connection error notification.

virtual void	OnUnbindInterpretationAudioConnectionSuccess (const std::vector< NetworkAudioBroadcastConnectionInfo > &connections)=0
	Unbind interpretation audio connection success notification.

virtual void	OnUnbindInterpretationAudioConnectionError (const NetworkAudioError &result, int32_t languageID)=0
	Unbind interpretation audio connection error notification.

Detailed Description

Dante output helper event callback.

Definition at line 122 of file IDanteOutputHelper.h.

Constructor & Destructor Documentation

◆ ~IDanteOutputHelperSink()

virtual IDanteOutputHelperSink::~IDanteOutputHelperSink ( )

inlinevirtual

Definition at line 125 of file IDanteOutputHelper.h.

125{}

Member Function Documentation

◆ OnBindGalleryMixedAudioConnectionError()

virtual void IDanteOutputHelperSink::OnBindGalleryMixedAudioConnectionError	(	const NetworkAudioError &	result,
		const NetworkAudioBroadcastGalleryBindInfo &	galleryBindInfo,
		const LocalNetworkAudioChannelInfo &	channel
	)

pure virtual

Bind gallery mixed audio connection error notification.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

result	Fail code and the description of fail code.
galleryBindInfo	The info of the gallery mixed audio.
channel	The channel which the gallery mixed audio is bound to.

◆ OnBindGalleryMixedAudioConnectionSuccess()

virtual void IDanteOutputHelperSink::OnBindGalleryMixedAudioConnectionSuccess ( const std::vector< NetworkAudioBroadcastConnectionInfo > & connections )

pure virtual

Bind gallery mixed audio connection success notification.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

connections The connection between the gallery mixed audio and network audio device channel.

◆ OnBindInterpretationAudioConnectionError()

virtual void IDanteOutputHelperSink::OnBindInterpretationAudioConnectionError	(	const NetworkAudioError &	result,
		int32_t	languageID,
		const LocalNetworkAudioChannelInfo &	channel
	)

pure virtual

Bind interpretation audio connection error notification.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

result	Fail code and the description of fail code.
languageID	The interpretation language ID.
channel	The channel which the interpretation audio is bound to.

◆ OnBindInterpretationAudioConnectionSuccess()

virtual void IDanteOutputHelperSink::OnBindInterpretationAudioConnectionSuccess ( const std::vector< NetworkAudioBroadcastConnectionInfo > & connections )

pure virtual

Bind interpretation audio connection success notification.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

connections The connection between interpretation audio and network audio device channel.

◆ OnBindMixedAudioConnectionError()

virtual void IDanteOutputHelperSink::OnBindMixedAudioConnectionError	(	const NetworkAudioError &	result,
		const LocalNetworkAudioChannelInfo &	channel,
		AudioSignalType	signalType
	)

pure virtual

Bind mixed audio connection error notification.

Since: 6.3.0

Zoom Rooms minimum version: 6.3.0

Parameters

result	Fail code and the description of fail code.
channel	The channel which the mixed audio is bound to.
signalType	The signal type of the mixed audio.

Changelog

6.6.0: Change result type from int32_t to NetworkAudioError which include errorCode and errorName.

◆ OnBindMixedAudioConnectionSuccess()

virtual void IDanteOutputHelperSink::OnBindMixedAudioConnectionSuccess ( const std::vector< NetworkAudioBroadcastConnectionInfo > & connections )

pure virtual

Bind mixed audio connection success notification.

Since: 6.3.0

Zoom Rooms minimum version: 6.1.0

Parameters

connections The connection between mixed audio and network audio device channel.

◆ OnBindShareContentAudioConnectionError()

virtual void IDanteOutputHelperSink::OnBindShareContentAudioConnectionError	(	const NetworkAudioError &	result,
		const LocalNetworkAudioChannelInfo &	channel,
		AudioSignalType	signalType
	)

pure virtual

Bind share content connection error notification.

Since: 6.3.0

Zoom Rooms minimum version: 6.3.0

Parameters

result	Fail code and the description of fail code.
channel	The channel which the share content audio is bound to.
signalType	The signal type of the share content audio.

Changelog

6.6.0: Change result type from int32_t to NetworkAudioError which include errorCode and errorName.

◆ OnBindShareContentAudioConnectionSuccess()

virtual void IDanteOutputHelperSink::OnBindShareContentAudioConnectionSuccess ( const std::vector< NetworkAudioBroadcastConnectionInfo > & connections )

pure virtual

Bind share content connection success notification.

Since: 6.3.0

Zoom Rooms minimum version: 6.1.0

Parameters

connections The connection between the share content audio and network audio device channel.

◆ OnBindUserAudioConnectionError()

virtual void IDanteOutputHelperSink::OnBindUserAudioConnectionError	(	const NetworkAudioError &	result,
		int32_t	userID,
		const LocalNetworkAudioChannelInfo &	channel,
		AudioSignalType	signalType
	)

pure virtual

Bind user audio connection error notification.

Since: 6.3.0

Zoom Rooms minimum version: 6.3.0

Parameters

result	Fail code and the description of fail code.
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.

Changelog

6.6.0: Change result type from int32_t to NetworkAudioError which include errorCode and errorName.

◆ OnBindUserAudioConnectionSuccess()

virtual void IDanteOutputHelperSink::OnBindUserAudioConnectionSuccess ( const std::vector< NetworkAudioBroadcastConnectionInfo > & connections )

pure virtual

Bind user audio connection success notification.

Since: 6.3.0

Zoom Rooms minimum version: 6.1.0

Parameters

connections The connection between user audio and network audio device channel.

◆ OnCreateLocalNetworkAudioDevice()

virtual void IDanteOutputHelperSink::OnCreateLocalNetworkAudioDevice	(	int32_t	result,
		const LocalNetworkAudioDeviceInfo &	info
	)

pure virtual

Create local network audio device notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

result	[0] Success. Otherwise Fail.
info	The local network audio device info, details LocalNetworkAudioDeviceInfo.

◆ OnDestroyLocalNetworkAudioDevice()

virtual void IDanteOutputHelperSink::OnDestroyLocalNetworkAudioDevice ( int32_t result )

pure virtual

Destroy local network audio device notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

result [0] Success. Otherwise Fail.

◆ OnListAllAudioConnection()

virtual void IDanteOutputHelperSink::OnListAllAudioConnection	(	const NetworkAudioError &	result,
		const std::vector< NetworkAudioBroadcastConnectionInfo > &	connections
	)

pure virtual

List all audio connection notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

result	Fail code and the description of fail code.
connections	The all audio connections.

Changelog

6.6.0: Change result type from int32_t to NetworkAudioError which include errorCode and errorName.

◆ OnListAllUnbindChannel()

virtual void IDanteOutputHelperSink::OnListAllUnbindChannel	(	const NetworkAudioError &	result,
		const std::vector< LocalNetworkAudioChannelInfo > &	txChannels
	)

pure virtual

List all unbind channel notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

result	Fail code and the description of fail code.
txChannels	The channels which are unbound.

Changelog

6.6.0: Change result type from int32_t to NetworkAudioError which include errorCode and errorName.

◆ OnLocalNetworkAudioDeviceError()

virtual void IDanteOutputHelperSink::OnLocalNetworkAudioDeviceError ( const NetworkAudioError & error )

pure virtual

Local network audio error notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

error Local network audio error, details NetworkAudioError.

◆ OnLocalNetworkAudioDeviceInfoNotification()

virtual void IDanteOutputHelperSink::OnLocalNetworkAudioDeviceInfoNotification ( const LocalNetworkAudioDeviceInfo & info )

pure virtual

Local network audio info notification.

Since: 6.2.0

Zoom Rooms minimum version: 6.2.0

Parameters

info	The local network audio device info, details LocalNetworkAudioDeviceInfo.

◆ OnUnbindAllAudioConnection()

virtual void IDanteOutputHelperSink::OnUnbindAllAudioConnection	(	const NetworkAudioError &	result,
		const std::vector< NetworkAudioBroadcastConnectionInfo > &	connections
	)

pure virtual

Unbind all audio connection notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

result	Fail code and the description of fail code.
connections	The unbound connections about all audio connection.

Changelog

6.6.0: Change result type from int32_t to NetworkAudioError which include errorCode and errorName.

◆ OnUnbindChannelAudioConnectionError()

virtual void IDanteOutputHelperSink::OnUnbindChannelAudioConnectionError	(	const NetworkAudioError &	result,
		const LocalNetworkAudioChannelInfo &	channel
	)

pure virtual

Unbind the audio in the specified channel error notification.

Since: 6.3.0

Zoom Rooms minimum version: 6.3.0

Parameters

result	Fail code and the description of fail code.
channel	The channel which the mixed audio is bound to.

Changelog

6.6.0: Change result type from int32_t to NetworkAudioError which include errorCode and errorName.

◆ OnUnbindChannelAudioConnectionSuccess()

virtual void IDanteOutputHelperSink::OnUnbindChannelAudioConnectionSuccess ( const std::vector< NetworkAudioBroadcastConnectionInfo > & connections )

pure virtual

Unbind the audio in the specified channel success notification.

Since: 6.3.0

Zoom Rooms minimum version: 6.1.0

Parameters

connections The unbound connection which is in the specified channel.

◆ OnUnbindGalleryMixedAudioConnectionError()

virtual void IDanteOutputHelperSink::OnUnbindGalleryMixedAudioConnectionError	(	const NetworkAudioError &	result,
		const NetworkAudioBroadcastGalleryBindInfo &	galleryBindInfo
	)

pure virtual

Unbind gallery mixed audio connection error notification.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

result	Fail code and the description of fail code.
galleryBindInfo	The origin info of the sent request.

◆ OnUnbindGalleryMixedAudioConnectionSuccess()

virtual void IDanteOutputHelperSink::OnUnbindGalleryMixedAudioConnectionSuccess ( const std::vector< NetworkAudioBroadcastConnectionInfo > & connections )

pure virtual

Unbind gallery mixed audio connection success notification.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

connections The connection between the gallery mixed audio and network audio device channel.

◆ OnUnbindInterpretationAudioConnectionError()

virtual void IDanteOutputHelperSink::OnUnbindInterpretationAudioConnectionError	(	const NetworkAudioError &	result,
		int32_t	languageID
	)

pure virtual

Unbind interpretation audio connection error notification.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

result	Fail code and the description of fail code.
languageID	The interpretation language ID.

◆ OnUnbindInterpretationAudioConnectionSuccess()

virtual void IDanteOutputHelperSink::OnUnbindInterpretationAudioConnectionSuccess ( const std::vector< NetworkAudioBroadcastConnectionInfo > & connections )

pure virtual

Unbind interpretation audio connection success notification.

Since: 6.6.0

Zoom Rooms minimum version: 6.6.0

Parameters

connections The unbound connections about the specified type of the interpretation audio.

◆ OnUnbindMixedAudioConnectionError()

virtual void IDanteOutputHelperSink::OnUnbindMixedAudioConnectionError	(	const NetworkAudioError &	result,
		AudioSignalType	signalType
	)

pure virtual

Unbind mixed audio connection error notification.

Since: 6.3.0

Zoom Rooms minimum version: 6.3.0

Parameters

result	Fail code and the description of fail code.
signalType	The signal type of the mixed audio.

Changelog

6.6.0: Change result type from int32_t to NetworkAudioError which include errorCode and errorName.

◆ OnUnbindMixedAudioConnectionSuccess()

virtual void IDanteOutputHelperSink::OnUnbindMixedAudioConnectionSuccess ( const std::vector< NetworkAudioBroadcastConnectionInfo > & connections )

pure virtual

Unbind mixed audio connection success notification.

Since: 6.3.0

Zoom Rooms minimum version: 6.1.0

Parameters

connections The unbound connections about the specified type of the mixed audio.

◆ OnUnbindShareContentAudioConnectionError()

virtual void IDanteOutputHelperSink::OnUnbindShareContentAudioConnectionError	(	const NetworkAudioError &	result,
		AudioSignalType	signalType
	)

pure virtual

Unbind share content audio connection error notification.

Since: 6.3.0

Zoom Rooms minimum version: 6.3.0

Parameters

result	Fail code and the description of fail code.
signalType	The signal type of the share content.

Changelog

6.6.0: Change result type from int32_t to NetworkAudioError which include errorCode and errorName.

◆ OnUnbindShareContentAudioConnectionSuccess()

virtual void IDanteOutputHelperSink::OnUnbindShareContentAudioConnectionSuccess ( const std::vector< NetworkAudioBroadcastConnectionInfo > & connections )

pure virtual

Unbind share content audio connection success notification.

Since: 6.3.0

Zoom Rooms minimum version: 6.1.0

Parameters

connections The unbound connections about the specified type of the share content audio.

◆ OnUnbindUserAudioConnectionError()

virtual void IDanteOutputHelperSink::OnUnbindUserAudioConnectionError	(	const NetworkAudioError &	result,
		int32_t	userID,
		AudioSignalType	signalType
	)

pure virtual

Unbind user audio connection error notification.

Since: 6.3.0

Zoom Rooms minimum version: 6.3.0

Parameters

result	Fail code and the description of fail code.
userID	The userID specifies which user's audio.
signalType	The signal type of the user audio.

Changelog

6.6.0: Change result type from int32_t to NetworkAudioError which include errorCode and errorName.

◆ OnUnbindUserAudioConnectionSuccess()

virtual void IDanteOutputHelperSink::OnUnbindUserAudioConnectionSuccess ( const std::vector< NetworkAudioBroadcastConnectionInfo > & connections )

pure virtual

Unbind user audio connection success notification.

Since: 6.3.0

Zoom Rooms minimum version: 6.1.0

Parameters

connections The unbound connections about the specified type of the user audio.

◆ OnUpdateAudioConnection()

virtual void IDanteOutputHelperSink::OnUpdateAudioConnection ( const std::vector< NetworkAudioBroadcastConnectionInfo > & connections )

pure virtual

Update audio connection notification.

Since: 6.1.0

Zoom Rooms minimum version: 6.1.0

Parameters

connections The connection which needs to update.

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IDanteOutputHelperSink()

Member Function Documentation

◆ OnBindGalleryMixedAudioConnectionError()

◆ OnBindGalleryMixedAudioConnectionSuccess()

◆ OnBindInterpretationAudioConnectionError()

◆ OnBindInterpretationAudioConnectionSuccess()

◆ OnBindMixedAudioConnectionError()

◆ OnBindMixedAudioConnectionSuccess()

◆ OnBindShareContentAudioConnectionError()

◆ OnBindShareContentAudioConnectionSuccess()

◆ OnBindUserAudioConnectionError()

◆ OnBindUserAudioConnectionSuccess()

◆ OnCreateLocalNetworkAudioDevice()

◆ OnDestroyLocalNetworkAudioDevice()

◆ OnListAllAudioConnection()

◆ OnListAllUnbindChannel()

◆ OnLocalNetworkAudioDeviceError()

◆ OnLocalNetworkAudioDeviceInfoNotification()

◆ OnUnbindAllAudioConnection()

◆ OnUnbindChannelAudioConnectionError()

◆ OnUnbindChannelAudioConnectionSuccess()

◆ OnUnbindGalleryMixedAudioConnectionError()

◆ OnUnbindGalleryMixedAudioConnectionSuccess()

◆ OnUnbindInterpretationAudioConnectionError()

◆ OnUnbindInterpretationAudioConnectionSuccess()

◆ OnUnbindMixedAudioConnectionError()

◆ OnUnbindMixedAudioConnectionSuccess()

◆ OnUnbindShareContentAudioConnectionError()

◆ OnUnbindShareContentAudioConnectionSuccess()

◆ OnUnbindUserAudioConnectionError()

◆ OnUnbindUserAudioConnectionSuccess()

◆ OnUpdateAudioConnection()