Audinate::DAL::Connections Class Reference

Public Member Functions
virtual LocalDevice	getLocalDevice ()=0
	Get information about the local device.
virtual AvailableChannels	getAvailableSources (unsigned int rxChannelId)=0
	Get the list of available sources for the given receive channel.
virtual AvailableChannels	getAvailableDestinations (unsigned int txChannelId)=0
	Get the list of available destinations for the given transmit channel.
virtual void	identify (const std::string &deviceName)=0
	Attempt to identify a given device.
virtual void	setReceiveChannelSource (unsigned int rxChannelId, const std::string &remoteChannelName, const std::string &remoteDeviceName)=0
	Specify the remote channel from which the local receive channel will receive audio To clear the configuration, set both strings to "".
virtual Connection	getReceiveChannelState (unsigned int rxChannelId)=0
	Get the connection state for the given receive channel.
virtual void	setTransmitChannelDestination (unsigned int txChannelId, const std::string &remoteChannelName, const std::string &remoteDeviceName)=0
	Specify a remote channel that will receive audio from the given local transmit channel.
virtual Connection	getTransmitChannelState (unsigned int txChannelId)=0
	Get the connection state for the given transmit channel.
virtual void	clearRemoteSubscriptionsToLocalDevice ()=0
	Remove all remote rx channels subscriptions to the local device that are not part of a currently configured destination.
virtual void	setLocalDeviceChangedFn (LocalDeviceChangedFn fn)=0
	Add a handler to be notified when the set of local device changes.
virtual void	setAvailableChannelsChangedFn (AvailableChannelsChangedFn fn)=0
	Add a handler to be notified when the set of available channels changes.
virtual void	setConnectionChangedFn (ConnectionChangedFn fn)=0
	Add a handler to be notified when connection state changes for one or more channels.

Member Function Documentation

clearRemoteSubscriptionsToLocalDevice()

virtual void Audinate::DAL::Connections::clearRemoteSubscriptionsToLocalDevice ( )

pure virtual

Remove all remote rx channels subscriptions to the local device that are not part of a currently configured destination.

It will not remove any subscriptions that are required for the current set of connections.

Remote Dante devices may have subscriptions to local device transmit channels that were configured using other Dante control software or a previous incarnation of the Connection API and are not part of the current set of connections being managed by the connection API. When too many other these connections are present, the local device may run out of transmit resources and be unable to complete connections to remote destinations.

This function will break audio connections in the network that may be required by other controllers. It is safe to call when the Connection API is the only control software expected to configure connections to / from the local Dante device.

getAvailableDestinations()

virtual AvailableChannels Audinate::DAL::Connections::getAvailableDestinations ( unsigned int txChannelId )

pure virtual

Get the list of available destinations for the given transmit channel.

Note

txChannelIds start from 1

getAvailableSources()

virtual AvailableChannels Audinate::DAL::Connections::getAvailableSources ( unsigned int rxChannelId )

pure virtual

Get the list of available sources for the given receive channel.

Note

rxChannelIds start from 1

getReceiveChannelState()

virtual Connection Audinate::DAL::Connections::getReceiveChannelState ( unsigned int rxChannelId )

pure virtual

Get the connection state for the given receive channel.

Note

rxChannelIds start from 1

getTransmitChannelState()

virtual Connection Audinate::DAL::Connections::getTransmitChannelState ( unsigned int txChannelId )

pure virtual

Get the connection state for the given transmit channel.

Note

txChannelIds start from 1

setReceiveChannelSource()

virtual void Audinate::DAL::Connections::setReceiveChannelSource ( unsigned int rxChannelId, const std::string & remoteChannelName, const std::string & remoteDeviceName )

pure virtual

Specify the remote channel from which the local receive channel will receive audio To clear the configuration, set both strings to "".

Note

rxChannelIds start from 1

setTransmitChannelDestination()

virtual void Audinate::DAL::Connections::setTransmitChannelDestination ( unsigned int txChannelId, const std::string & remoteChannelName, const std::string & remoteDeviceName )

pure virtual

Specify a remote channel that will receive audio from the given local transmit channel.

To clear this configuration, set both strings to "".

Note

txChannelIds start from 1

---

The documentation for this class was generated from the following file:

• include/audinate/dal/Connections.hpp