Deepsy Audio namespace that includes the different enums, structs or method signatures that should be used.

Classes
class	AudioConfig
	Struct defining audio configuration. More...

struct	AudioTaskInformation
	Structure containing Task information. More...

struct	Connection
	Struct defining a connection between two ports. More...

struct	Port
	Struct defining a port. More...

struct	PortGpio
	Struct defining an assignment between a port and a gpio. More...

struct	PortMicBias
	Struct defining an assignment between a port and a MIC Bias. More...

class	ServiceAvailabilityObserver
	Service Availability observer class. More...

Typedefs
typedef boost::function< void(boost::system::error_code &, std::list< dpyAudio::Port > portList)>	port_list_handler_function
	Handler for get port list method. More...

typedef boost::function< void(boost::system::error_code &, std::list< dpyAudio::AudioConfig > configurations)>	audio_configuration_handler_function
	Prototype of the handler function for getting the audio configuration. More...

typedef boost::function< void(boost::system::error_code &, std::list< dpyAudio::Connection > ConnectionList)>	connection_list_handler_function
	Handler for get connection list method. More...

typedef boost::function< void(boost::system::error_code &, dpyAudio::Port &port)>	port_handler_function
	Handler for create/remove port. More...

typedef boost::function< void(boost::system::error_code &, dpyAudio::Connection connection)>	connection_handler_function
	Handler for create/remove connection method. More...

typedef boost::function< void(const boost::system::error_code &)>	result_handler_function
	Handler for a method which needs a result. More...

typedef boost::function< void(boost::system::error_code error_code, ConnectionListEventType type, Connection con)>	connection_list_event_handler_function
	Handler for connection list event function callback This type of function is called when an event happens. More...

typedef boost::function< void(boost::system::error_code error_code, ConnectionStatusEventType type, Connection con)>	connection_status_event_handler_function
	Handler for connection status event function callback This type of function is called when an event happens. More...

typedef boost::function< void(boost::system::error_code error_code, PortEventType type, dpyAudio::Port port)>	port_event_handler_function
	Handler for port event callback This type of function is called when an event happens. More...

typedef boost::function< void(boost::system::error_code error_code, int taskId, dpyAudio::TaskType type, dpyAudio::AudioTaskStatus status)>	task_event_handler_function
	Handler for audio track event callback This type of function is called when an event happens. More...

typedef boost::function< void(boost::system::error_code error_code, PortGpioEventType type, dpyAudio::PortGpio port_gpio)>	port_gpio_event_handler_function
	Handler for PortGpio event callback This type of function is called when an event happens. More...

typedef boost::function< void(boost::system::error_code, int ID)>	audio_task_handler_function
	Prototype of the handler function for playing or recording audio. More...

typedef boost::function< void(boost::system::error_code, int ID)>	stop_task_handler
	Prototype of the handler function for stopping an audio recording. More...

typedef boost::function< void(boost::system::error_code ec, int taskId, dpyAudio::TaskType taskType, dpyAudio::AudioTaskStatus taskStatus)>	audio_task_status_handler_function
	Prototype of the handler function for getting the status of the task. More...

typedef boost::function< void(boost::system::error_code ec, std::list< std::pair< int, dpyAudio::AudioTaskInformation >> taskinfolist)>	all_audio_task_info_handler_function
	Prototype of the handler function for getting the status of all tasks. More...

typedef boost::function< void(boost::system::error_code &)>	audio_set_configuration_handler_function
	Prototype of the handler function for getting the audio configuration. More...

typedef boost::function< void(boost::system::error_code &, dpyAudio::Connection connection, unsigned int volume)>	set_connection_volume_handler_function
	Handler for set connection volume method. More...

typedef boost::function< void(boost::system::error_code &, dpyAudio::Connection connection, unsigned int gain)>	set_connection_gain_handler_function
	Handler for set connection gain method. More...

typedef boost::function< void(boost::system::error_code &ec, std::list< dpyAudio::PortGpio > portgpiolist)>	get_port_gpio_handler_function
	Prototype of the handler function for getting all gpios assigned to ports. More...

typedef boost::function< void(boost::system::error_code &ec, std::list< dpyAudio::PortMicBias > portmiclist)>	get_mic_bias_handler_function
	Prototype of the handler function for getting all mic bias assigned to ports. More...

typedef boost::function< void(const PortEventType &event, const Port &port)>	PortEventFunction
	Port event handler function.

Enumerations
enum	Parameter { UNKNOWN = -1, VOLUME = 0 }
	Parameter for defining audio properties. More...

enum	PortType { NA_TYPE = 0, INPUT = 1, OUTPUT = 2 }
	Enumeration defining the different kinds of ports. More...

enum	PortEventType { PORT_ADDED = 0, PORT_REMOVED = 1 }

enum	PortGpioEventType { GPIO_ASSIGNED = 0, GPIO_RELEASED = 1 }

enum	ConnectionListEventType { CONNECTION_ADDED = 0, CONNECTION_REMOVED = 1 }

enum	ConnectionStatusEventType { ENABLED = 0, DISABLED = 1, UPDATED = 2 }

enum	TaskType { PLAY = 0, RECORD = 1 }
	Enumeration defining the different type of audio tasks. More...

enum	AudioTaskStatus { UNKNOWN_STATUS = 0, QUEUED = 1, PROCESSING = 2, PROCESSED_OK = 3, ERROR_BEFORE_PROCESSING = 4, ERROR_WHILE_PROCESSING = 5, ERROR_AFTER_PROCESSING = 6, TASK_STOPPED = 7 }
	Enumeration that includes the possible status of an Audio Task within the Audio system. More...

Variables
const int	MAX_PRIORITY_VALUE = 100
	Max allowed value for connection priority.

const int	MIN_PRIORITY_VALUE = 0
	Min allowed value for connection priority.

const int	DEFAULT_PRIORITY_VALUE = 0
	Default value for connection priority if not defined.

const int	MIN_VOLUME = 0
	Min allowed value for volume.

const int	MAX_VOLUME = 100
	Max allowed value for volume.

const int	DEF_CONNECTION_VOLUME = -1
	Default value for connection volume if not defined.

const int	MIN_GAIN = 0
	Min allowed value for gain.

const int	MAX_GAIN = 100
	Max allowed value for gain.

const int	DEF_CONNECTION_GAIN = -1
	Default value for connection gain if not defined.

Typedef Documentation

typedef boost::function<void(boost::system::error_code ec, std::list<std::pair<int, dpyAudio::AudioTaskInformation>> taskinfolist)> all_audio_task_info_handler_function

Parameters

error_code	error code (if any)
taskstatuslist	list with every task ID id of the track and the audio task information

typedef boost::function<void(boost::system::error_code&, std::list<dpyAudio::AudioConfig> configurations)> audio_configuration_handler_function

Parameters

error_code	error code (if any)
configuration	list with every audio configuration

typedef boost::function<void(boost::system::error_code&)> audio_set_configuration_handler_function

Parameters

error_code	error code (if any)
configuration	list with every audio configuration

typedef boost::function<void(boost::system::error_code, int ID)> audio_task_handler_function

Parameters

error_code	error code (if any)
ID	id of the track or the record that has been queued

typedef boost::function<void(boost::system::error_code ec, int taskId, dpyAudio::TaskType taskType, dpyAudio::AudioTaskStatus taskStatus)> audio_task_status_handler_function

Parameters

error_code	error code (if any)
ID	id of the track or the record which status have been requested
taskType	which defines if the task is a record or a play task
status	of the track or the record

typedef boost::function<void(boost::system::error_code&, dpyAudio::Connection connection)> connection_handler_function

Parameters

error_code	error code (if any)
connection	copy of the created connection

typedef boost::function<void(boost::system::error_code error_code, ConnectionListEventType type, Connection con)> connection_list_event_handler_function

Parameters

error_code	error code (if any)
event	ADDED or REMOVED
connection	connection details

typedef boost::function<void(boost::system::error_code&, std::list<dpyAudio::Connection> ConnectionList)> connection_list_handler_function

Parameters

error_code	error code (if any)
ConnectionList	list of connections created by the user

typedef boost::function<void(boost::system::error_code error_code, ConnectionStatusEventType type, Connection con)> connection_status_event_handler_function

Parameters

error_code	error code (if any)
event	ENABLED, DISABLED or UPDATED
connection	connection details

typedef boost::function<void(boost::system::error_code& ec, std::list<dpyAudio::PortMicBias> portmiclist)> get_mic_bias_handler_function

Parameters

error_code	error code (if any)
portgpiolist	port-mic-bias list

typedef boost::function<void(boost::system::error_code& ec, std::list<dpyAudio::PortGpio> portgpiolist)> get_port_gpio_handler_function

Parameters

error_code	error code (if any)
portgpiolist	port-gpio list

typedef boost::function<void(boost::system::error_code error_code, PortEventType type, dpyAudio::Port port)> port_event_handler_function

Parameters

error_code	error code (if any)
event	ADDED or REMOVED
port	port details

typedef boost::function<void(boost::system::error_code error_code, PortGpioEventType type, dpyAudio::PortGpio port_gpio)> port_gpio_event_handler_function

Parameters

error_code	error code (if any)
event	ASSIGNED or RELEASED
port_gpio	PortGpio details

typedef boost::function<void(boost::system::error_code&, dpyAudio::Port& port)> port_handler_function

Parameters

error_code	error code (if any)
port	copy of the created/removed port

typedef boost::function<void(boost::system::error_code&, std::list<dpyAudio::Port> portList)> port_list_handler_function

Parameters

error_code	error code (if any)
portList	list of ports

typedef boost::function<void(const boost::system::error_code&)> result_handler_function

Parameters

error_code error code (if any)

typedef boost::function<void(boost::system::error_code&, dpyAudio::Connection connection, unsigned int gain)> set_connection_gain_handler_function

Parameters

error_code	error code (if any)
connection	copy of the created connection
gain	gain to be set

typedef boost::function<void(boost::system::error_code&, dpyAudio::Connection connection, unsigned int volume)> set_connection_volume_handler_function

Parameters

error_code	error code (if any)
connection	copy of the created connection
volume	volume to be set

typedef boost::function<void(boost::system::error_code, int ID)> stop_task_handler

Parameters

error_code	error code (if any)
ID	id of the recording that has been stopped

typedef boost::function<void(boost::system::error_code error_code, int taskId, dpyAudio::TaskType type, dpyAudio::AudioTaskStatus status)> task_event_handler_function

Parameters

error_code	error code (if any)
trackid	track id
status	new track status

Enumeration Type Documentation

enum AudioTaskStatus

Enumerator
UNKNOWN_STATUS	UNKNOWN.
QUEUED	QUEUED.
PROCESSING	PROCESSING.
PROCESSED_OK	PROCESSED OK.
ERROR_BEFORE_PROCESSING	ERROR BEFORE PROCESSING.
ERROR_WHILE_PROCESSING	ERROR WHILE PROCESSING.
ERROR_AFTER_PROCESSING	ERROR AFTER PROCESSING.
TASK_STOPPED	STOPPED.

enum ConnectionListEventType

ConnectionListEvent type

Enumerator
CONNECTION_ADDED	A connection is added.
CONNECTION_REMOVED	A connection is removed.

enum ConnectionStatusEventType

ConnectionStatusEvent type

Enumerator
ENABLED	A connection is enabled.
DISABLED	A connection is disabled.
UPDATED	A connection is updated.

enum Parameter

Enumerator
UNKNOWN	Volume.
VOLUME	Volume.

enum PortEventType

PortEvent type

Enumerator
PORT_ADDED	A port is added.
PORT_REMOVED	A port is removed.

enum PortGpioEventType

PortGpioEvent type

Enumerator
GPIO_ASSIGNED	GPIO sink is assigned.
GPIO_RELEASED	GPIO sink is released.

enum PortType

Enumerator
NA_TYPE	NA_TYPE.
INPUT	INPUT.
OUTPUT	OUTPUT.

enum TaskType

Enumerator
PLAY	PLAY.
RECORD	RECORD.

Classes

Typedefs

Enumerations

Variables

Typedef Documentation

Enumeration Type Documentation