|
Dante Application Library API
|
Configuration for a DAL instance. More...
#include <InstanceConfig.hpp>
Public Member Functions | |
| void | setManufacturerName (const std::string &manufacturerName) |
| Set the manufacturer friendly name for the DAL Instance. More... | |
| std::string | getManufacturerName () const |
| Get the manufacturer friendly name for the DAL Instance. More... | |
| void | setManufacturerVersion (const Version &manufacturerVersion) |
| Set the manufacturer product version for the DAL Instance. More... | |
| Version | getManufacturerVersion () const |
| Get the manufacturer product version for the DAL Instance. More... | |
| void | setModelName (const std::string &modelName) |
| Set the model name for the DAL Instance. More... | |
| std::string | getModelName () const |
| Get the model name for the DAL Instance. More... | |
| void | setModelId (const Id64 &modelId) |
| Set the model id for the DAL Instance. More... | |
| Id64 | getModelId () const |
| Get the model id for the DAL Instance. More... | |
| void | setDefaultName (const std::string &name) |
| Set the default device name for the DAL instance. More... | |
| std::string | getDefaultName () const |
| Get the default device name for the DAL instance. More... | |
| void | setNumTxChannels (unsigned int numTxChannels) |
| Set the number of transmit channels for the DAL instance. More... | |
| unsigned int | getNumTxChannels () const |
| Get the number of transmit channels for the DAL instance. More... | |
| void | setTxChannelName (unsigned int txChannelIndex, const std::string &name) |
| Set the default name for the given transmit (tx) channel. More... | |
| std::string | getTxChannelName (unsigned int txChannelIndex) const |
| Get the default name for the given tx channel. More... | |
| void | setNumRxChannels (unsigned int numRxChannels) |
| Set the number of receive channels for the DAL instance. More... | |
| unsigned int | getNumRxChannels () const |
| Get the number of receive channels for the DAL instance. More... | |
| void | setRxChannelName (unsigned int rxChannelIndex, const std::string &name) |
| Set the default name for the given receive (rx) channel. More... | |
| std::string | getRxChannelName (unsigned int rxChannelIndex) const |
| Get the default name for the given receive (rx) channel. More... | |
| void | setNumTxFlows (unsigned int numTxFlows) |
| Override the default number of the transmit flows for the DAL instance. More... | |
| unsigned int | getNumTxFlows () const |
| Get the number of transmit (tx) flows. More... | |
| void | setNumRxFlows (unsigned int numRxFlows) |
| Override the default number of receive flows for the DAL instance. More... | |
| unsigned int | getNumRxFlows () const |
| Get the number of receive (rx) flows. More... | |
| void | setSamplerate (Samplerate samplerate) |
| Set the samplerate for the DAL instance. More... | |
| Samplerate | getSamplerate () const |
| Get the samplerate for the DAL instance. More... | |
| void | setInterfaceName (InterfaceName name) |
| Set the name of the local network interface on which DAL will run. More... | |
| InterfaceName | getInterfaceName () const |
| Get the name of the local network interface on which DAL will run. More... | |
| void | setInterfaceIndex (InterfaceIndex index) |
| Set the index of the local network interface on which DAL will run. More... | |
| InterfaceIndex | getInterfaceIndex () const |
| Get the index of the local network interface on which DAL will run. More... | |
| void | setProtocolSocketDescriptor (Protocol protocol, SocketDescriptor socketDescriptor) |
| Set the socket descriptor (port number or socket path) to be used by DAL for the given protocol. More... | |
| SocketDescriptor | getProtocolSocketDescriptor (Protocol protocol) const |
| Get the socket descriptor (port number or socket path) to be used by DAL for the given protocol. More... | |
| void | setAudioPortRange (uint16_t range) |
| Set the audio port range to be used by DAL instance. More... | |
| uint16_t | getAudioPortRange () const |
| Get the audio port range to be used by DAL instance. More... | |
| void | setTimeSource (TimeSource timeSource) |
| Set the time source for the DAL instance. More... | |
| TimeSource | getTimeSource () const |
| Get the time source for the DAL instance. More... | |
| void | setProcessPath (std::string processPath) |
| Set the local filesystem path where the DAL instance's supporting binaries can be found. More... | |
| std::string | getProcessPath () const |
| Get the local filesystem path where the DAL instance's supporting binaries can be found. More... | |
| void | setConfigurationPath (std::string configurationPath) |
| Set the configuration path used by the DAL instance (including its child processes) for storing configuration data. More... | |
| std::string | getConfigurationPath () const |
| Get the configuration path used by the child processes for storing configuration data. More... | |
| void | setLoggingPath (std::string loggingPath) |
| Set the logging path used by the child processes for storing log information. More... | |
| std::string | getLoggingPath () const |
| Get the logging path used by the child processes for storing log information. More... | |
| void | setSamplesPerPeriod (unsigned int samplesPerPeriod) |
| Set the number of samples between audio period events. More... | |
| unsigned int | getSamplesPerPeriod () const |
| Get the number of samples between audio period events. More... | |
| void | setPeriodsPerBuffer (unsigned int periodsPerBuffer) |
| Set the number of periods to be stored in each channel buffer. More... | |
| unsigned int | getPeriodsPerBuffer () const |
| Get the number of periods for each channel buffer. More... | |
| void | setEncoding (unsigned int encoding) |
| Set the encoding used by the DAL instance. More... | |
| unsigned int | getEncoding () const |
| Get the encoding used by the DAL instance. More... | |
| void | setPerChannelEncodingFile (const std::string &fileName) |
| Set per-channel encoding configuration in DAL. More... | |
| std::string | getPerChannelEncodingFile () const |
| Get the path to per-channel encoding file used by DAL instance. More... | |
| void | setLogLevel (LogLevel logLevel) |
| Set the log level for DAL instance. More... | |
| LogLevel | getLogLevel () const |
| Get the log level for DAL instance. More... | |
| void | setNetworkLatency (unsigned int networkLatency) |
| Set the DAL device network latency More... | |
| unsigned int | getNetworkLatency () const |
| Get DAL device network latency. More... | |
| void | setActivationDirectory (const std::string &path) |
| Set the activation directory path for the DAL instance. More... | |
| std::string | getActivationDirectory () const |
| Get the activation directory path for the DAL instance. More... | |
Configuration for a DAL instance.
These fields are generally fixed for the duration of a DAL instance start / stop cycle. DAL devices support the following Dante configuration. Sample rates: 44100, 48000 88200 and 96000 Up to 64x64 channels; default channel names; flow counts Encoding can be either PCM (16, 24, 32) or custom encoding (0x1300 - 0x13FF).
| std::string Audinate::DAL::InstanceConfig::getActivationDirectory | ( | ) | const |
Get the activation directory path for the DAL instance.
| uint16_t Audinate::DAL::InstanceConfig::getAudioPortRange | ( | ) | const |
Get the audio port range to be used by DAL instance.
This should be >= the number of RX flows.
| std::string Audinate::DAL::InstanceConfig::getConfigurationPath | ( | ) | const |
Get the configuration path used by the child processes for storing configuration data.
| std::string Audinate::DAL::InstanceConfig::getDefaultName | ( | ) | const |
| unsigned int Audinate::DAL::InstanceConfig::getEncoding | ( | ) | const |
| InterfaceIndex Audinate::DAL::InstanceConfig::getInterfaceIndex | ( | ) | const |
| InterfaceName Audinate::DAL::InstanceConfig::getInterfaceName | ( | ) | const |
Get the name of the local network interface on which DAL will run.
| std::string Audinate::DAL::InstanceConfig::getLoggingPath | ( | ) | const |
Get the logging path used by the child processes for storing log information.
| LogLevel Audinate::DAL::InstanceConfig::getLogLevel | ( | ) | const |
| std::string Audinate::DAL::InstanceConfig::getManufacturerName | ( | ) | const |
| Version Audinate::DAL::InstanceConfig::getManufacturerVersion | ( | ) | const |
| Id64 Audinate::DAL::InstanceConfig::getModelId | ( | ) | const |
| std::string Audinate::DAL::InstanceConfig::getModelName | ( | ) | const |
| unsigned int Audinate::DAL::InstanceConfig::getNetworkLatency | ( | ) | const |
| unsigned int Audinate::DAL::InstanceConfig::getNumRxChannels | ( | ) | const |
| unsigned int Audinate::DAL::InstanceConfig::getNumRxFlows | ( | ) | const |
Get the number of receive (rx) flows.
| unsigned int Audinate::DAL::InstanceConfig::getNumTxChannels | ( | ) | const |
| unsigned int Audinate::DAL::InstanceConfig::getNumTxFlows | ( | ) | const |
Get the number of transmit (tx) flows.
| std::string Audinate::DAL::InstanceConfig::getPerChannelEncodingFile | ( | ) | const |
| unsigned int Audinate::DAL::InstanceConfig::getPeriodsPerBuffer | ( | ) | const |
Get the number of periods for each channel buffer.
| std::string Audinate::DAL::InstanceConfig::getProcessPath | ( | ) | const |
| SocketDescriptor Audinate::DAL::InstanceConfig::getProtocolSocketDescriptor | ( | Protocol | protocol | ) | const |
Get the socket descriptor (port number or socket path) to be used by DAL for the given protocol.
| std::string Audinate::DAL::InstanceConfig::getRxChannelName | ( | unsigned int | rxChannelIndex | ) | const |
Get the default name for the given receive (rx) channel.
| rxChannelIndex | the 0-based index of the rx channel whose name we are obtaining. Must be < numRxChannels() |
| Samplerate Audinate::DAL::InstanceConfig::getSamplerate | ( | ) | const |
| unsigned int Audinate::DAL::InstanceConfig::getSamplesPerPeriod | ( | ) | const |
Get the number of samples between audio period events.
| TimeSource Audinate::DAL::InstanceConfig::getTimeSource | ( | ) | const |
| std::string Audinate::DAL::InstanceConfig::getTxChannelName | ( | unsigned int | txChannelIndex | ) | const |
Get the default name for the given tx channel.
| txChannelIndex | the 0-based index of the tx channel whose name we are obtaining. Must be < numTxChannels() |
| void Audinate::DAL::InstanceConfig::setActivationDirectory | ( | const std::string & | path | ) |
Set the activation directory path for the DAL instance.
| path | the path where the device activation file is stored. |
| DalException | if the path does not exist or no read/write access |
| void Audinate::DAL::InstanceConfig::setAudioPortRange | ( | uint16_t | range | ) |
Set the audio port range to be used by DAL instance.
This should be >= the number of RX flows.
| range | the port range |
| void Audinate::DAL::InstanceConfig::setConfigurationPath | ( | std::string | configurationPath | ) |
| void Audinate::DAL::InstanceConfig::setDefaultName | ( | const std::string & | name | ) |
Set the default device name for the DAL instance.
| name | the default name for the DAL instance |
| DalException | if the value is not a valid dante device name |
| void Audinate::DAL::InstanceConfig::setEncoding | ( | unsigned int | encoding | ) |
| void Audinate::DAL::InstanceConfig::setInterfaceIndex | ( | InterfaceIndex | index | ) |
| void Audinate::DAL::InstanceConfig::setInterfaceName | ( | InterfaceName | name | ) |
| void Audinate::DAL::InstanceConfig::setLoggingPath | ( | std::string | loggingPath | ) |
Set the logging path used by the child processes for storing log information.
Path must exist
| loggingPath | the logging path to be used by the DAL instance. |
| void Audinate::DAL::InstanceConfig::setLogLevel | ( | LogLevel | logLevel | ) |
| void Audinate::DAL::InstanceConfig::setManufacturerName | ( | const std::string & | manufacturerName | ) |
| void Audinate::DAL::InstanceConfig::setManufacturerVersion | ( | const Version & | manufacturerVersion | ) |
| void Audinate::DAL::InstanceConfig::setModelId | ( | const Id64 & | modelId | ) |
| void Audinate::DAL::InstanceConfig::setModelName | ( | const std::string & | modelName | ) |
| void Audinate::DAL::InstanceConfig::setNetworkLatency | ( | unsigned int | networkLatency | ) |
| void Audinate::DAL::InstanceConfig::setNumRxChannels | ( | unsigned int | numRxChannels | ) |
| void Audinate::DAL::InstanceConfig::setNumRxFlows | ( | unsigned int | numRxFlows | ) |
| void Audinate::DAL::InstanceConfig::setNumTxChannels | ( | unsigned int | numTxChannels | ) |
| void Audinate::DAL::InstanceConfig::setNumTxFlows | ( | unsigned int | numTxFlows | ) |
| void Audinate::DAL::InstanceConfig::setPerChannelEncodingFile | ( | const std::string & | fileName | ) |
Set per-channel encoding configuration in DAL.
| fileName | path to file which has OEM per-channel encoding configuration. |
| void Audinate::DAL::InstanceConfig::setPeriodsPerBuffer | ( | unsigned int | periodsPerBuffer | ) |
Set the number of periods to be stored in each channel buffer.
| periodsPerBuffer | the number of periods in each channel buffer |
| void Audinate::DAL::InstanceConfig::setProcessPath | ( | std::string | processPath | ) |
| void Audinate::DAL::InstanceConfig::setProtocolSocketDescriptor | ( | Protocol | protocol, |
| SocketDescriptor | socketDescriptor | ||
| ) |
Set the socket descriptor (port number or socket path) to be used by DAL for the given protocol.
| protocol | the protocol |
| socketDescriptor | the socket descriptor, either a port number or socket path |
| void Audinate::DAL::InstanceConfig::setRxChannelName | ( | unsigned int | rxChannelIndex, |
| const std::string & | name | ||
| ) |
Set the default name for the given receive (rx) channel.
| rxChannelIndex | the 0-based index of the channel whose name is to be set. Must be < numRxChannels() |
| name | the name for the channel. |
| void Audinate::DAL::InstanceConfig::setSamplerate | ( | Samplerate | samplerate | ) |
Set the samplerate for the DAL instance.
The supported samplerates are 44100, 48000, 88200 and 96000. The default samplerate is 48000. A DalException will be thrown if the DAL instance is started with an invalid samplerate.
| samplerate | the samplerate for the DAL instance |
| void Audinate::DAL::InstanceConfig::setSamplesPerPeriod | ( | unsigned int | samplesPerPeriod | ) |
Set the number of samples between audio period events.
| samplesPerPeriod | the number of samples between audio period events |
| void Audinate::DAL::InstanceConfig::setTimeSource | ( | TimeSource | timeSource | ) |
| void Audinate::DAL::InstanceConfig::setTxChannelName | ( | unsigned int | txChannelIndex, |
| const std::string & | name | ||
| ) |
Set the default name for the given transmit (tx) channel.
| txChannelIndex | the 0-based index of the channel whose name is to be set. Must be < numTxChannels() |
| name | the name for the channel. |
1.8.17