A class encapsulating the DAL Instance.
More...
#include <Instance.hpp>
A class encapsulating the DAL Instance.
◆ clearConfiguration()
| virtual void Audinate::DAL::Instance::clearConfiguration |
( |
| ) |
|
|
pure virtual |
Delete the configuration files of the child processes.
This function is only valid when the instance is stopped.
◆ clearDomainCredentials()
| virtual void Audinate::DAL::Instance::clearDomainCredentials |
( |
| ) |
|
|
pure virtual |
Delete the domain information.
This function is only valid when the instance is stopped.
◆ getAudio()
| virtual std::shared_ptr<Audio> Audinate::DAL::Instance::getAudio |
( |
| ) |
|
|
pure virtual |
Get the audio component object associated with this instance object.
- Returns
- shared ptr to the Audio object
◆ getComponentStatus()
| virtual ComponentStatus Audinate::DAL::Instance::getComponentStatus |
( |
Component |
component | ) |
|
|
pure virtual |
Get the current status for the given component.
- Parameters
-
| component | the component whose status is to be obtained |
◆ getDomainInfo()
| virtual DomainInfo Audinate::DAL::Instance::getDomainInfo |
( |
| ) |
const |
|
pure virtual |
Get the domain info.
- Returns
- domain info.
◆ getInstanceState()
| virtual InstanceState Audinate::DAL::Instance::getInstanceState |
( |
| ) |
const |
|
pure virtual |
Get the current instance state.
- Returns
- current instance state.
◆ getProtocolSocketDescriptor()
| virtual SocketDescriptor Audinate::DAL::Instance::getProtocolSocketDescriptor |
( |
Protocol |
protocol | ) |
|
|
pure virtual |
Get the socket descriptor number for a protocol server socket.
For protocols with application-specified descriptors, this is the value specified in the configuration. For protocols with ephemeral descriptors, the value is only meaningful while the instance is running
- Parameters
-
| protocol | the protocol whose descriptor is to be obtained. |
◆ isDeviceActivated()
| virtual bool Audinate::DAL::Instance::isDeviceActivated |
( |
| ) |
const |
|
pure virtual |
Get the device activation status.
- Returns
- device activated status.
◆ setEventFn()
| virtual void Audinate::DAL::Instance::setEventFn |
( |
InstanceEventFn |
fn | ) |
|
|
pure virtual |
Set the instance event function for this instance object.
This function can be called at any time
- Parameters
-
| fn | the new event handler function. Set to nullptr to disable event handling. |
◆ setMonitoringFn()
| virtual void Audinate::DAL::Instance::setMonitoringFn |
( |
MonitoringEventFn |
fn | ) |
|
|
pure virtual |
Set monitoring events callback function.
- Parameters
-
| fn | a MonitoringEventFn callback function |
◆ start()
| virtual void Audinate::DAL::Instance::start |
( |
| ) |
|
|
pure virtual |
Start the instance.
The instance will start asynchronously after this function returns. Use the eventFn to track current instance state
◆ stop()
| virtual void Audinate::DAL::Instance::stop |
( |
| ) |
|
|
pure virtual |
Stop the instance.
The instance will stop synchronously.
The documentation for this class was generated from the following file: