+ +

This struct describes the attributes of a gateway. + More...

+ +

#include <audiomanagertypes.h>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes
am_gatewayID_t	gatewayID
	This is the ID of the gateway, it is unique in the system. More...

std::string	name
	The name of the gateway. More...

am_sinkID_t	sinkID
	The sinkID of the gateway sink-end. More...

am_sourceID_t	sourceID
	The sourceID of the gateway sink-end. More...

am_domainID_t	domainSinkID
	The ID of the sink. More...

am_domainID_t	domainSourceID
	The ID of the source. More...

am_domainID_t	controlDomainID
	This is the ID of the domain that registers the gateway. More...

std::vector +< am_CustomConnectionFormat_t >	listSourceFormats
	This is the list of available formats on the source side of the gateway. More...

std::vector +< am_CustomConnectionFormat_t >	listSinkFormats
	This is the list of available formats on the sink side of the gateway. More...

std::vector< bool >	convertionMatrix
	This is matrix holding information about the conversion capability of the gateway, it's length is defined by the length(listSinkFormats) x length(listSourceFormats). More...

+

Detailed Description

+

This struct describes the attributes of a gateway.

+ +

Definition at line 689 of file audiomanagertypes.h.

+

Member Data Documentation

+ +

+

+ + + + +

am_domainID_t am::am_Gateway_s::controlDomainID

+

+ +

This is the ID of the domain that registers the gateway.

+ +

Definition at line 739 of file audiomanagertypes.h.

+ +

+

+ +

+

+ + + + +

std::vector<bool> am::am_Gateway_s::convertionMatrix

+

+ +

This is matrix holding information about the conversion capability of the gateway, it's length is defined by the length(listSinkFormats) x length(listSourceFormats).

+

If a SinkFormat can be converted into a SourceFormat, the vector will hold a 1, if no conversion is possible, a 0. The data is stored row orientated, where the rows are related to the sinksFormats and the columns to the sourceFormats. The first value will hold the conversion information from the first sourceFormat to the first sinkFormat for example and the seventh value the information about the 3rd sinkFormat to the 1st sourceFormat in case we would have 3 sourceFormats.

+

This matrix 110 011 000 111 001

+

reads as this: Source ** 1 2 3

+

S 1* 1 1 0 i 2* 0 1 1 n 3* 0 0 0 k 4* 1 1 1 5* 0 0 1

+ +

Definition at line 777 of file audiomanagertypes.h.

+ +

+

+ +

+

+ + + + +

am_domainID_t am::am_Gateway_s::domainSinkID

+

+ +

The ID of the sink.

+

If the domain is the same like the controlling domain, the ID is known due to registration. If the domain is different, the ID needs to be retrieved via peeking.

+ +

Definition at line 729 of file audiomanagertypes.h.

+ +

+

+ +

+

+ + + + +

am_domainID_t am::am_Gateway_s::domainSourceID

+

+ +

The ID of the source.

+

If the domain is the same like the controlling domain, the ID is known due to registration. If the domain is different, the ID needs to be retrieved via peeking.

+ +

Definition at line 735 of file audiomanagertypes.h.

+ +

+

+ +

+

+ + + + +

am_gatewayID_t am::am_Gateway_s::gatewayID

+

+ +

This is the ID of the gateway, it is unique in the system.

+

There are 2 ways, ID can be created: either it is assigned during the registration process (in a dynamic context, uniqueness will be ensured by the AudioManagerDaemon), or it is a fixed (the project has to ensure the uniqueness of the ID).

+ +

Definition at line 699 of file audiomanagertypes.h.

+ +

+

+ +

+

+ + + + +

std::vector<am_CustomConnectionFormat_t> am::am_Gateway_s::listSinkFormats

+

+ +

This is the list of available formats on the sink side of the gateway.

+

It is not defined during the gateway registration but copied from the sink registration.

+ +

Definition at line 751 of file audiomanagertypes.h.

+ +

+

+ +

+

+ + + + +

std::vector<am_CustomConnectionFormat_t> am::am_Gateway_s::listSourceFormats

+

+ +

This is the list of available formats on the source side of the gateway.

+

It is not defined during the gateway registration but copied from the source registration.

+ +

Definition at line 745 of file audiomanagertypes.h.

+ +

+

+ +

+

+ + + + +

std::string am::am_Gateway_s::name

+

+ +

The name of the gateway.

+

Must be unique in the whole system.

+ +

Definition at line 703 of file audiomanagertypes.h.

+ +

+

+ +

+

+ + + + +

am_sinkID_t am::am_Gateway_s::sinkID

+

+ +

The sinkID of the gateway sink-end.

+

The sink is a full blown sink with connectionFormats, sinkClassIDs etc... It makes sense to register the sinks of a gateway as non-visible. Care needs to be taken that the connectionsFormats match with the ones in the conversionMatrix. If the sink is located in the controllingDomain, the ID needs to be retrieved by registering the sink before registering the gateway. In case the sink is in a different domain, the ID needs to be retrieved via peeking.

+ +

Definition at line 713 of file audiomanagertypes.h.

+ +

+

+ +

+

+ + + + +

am_sourceID_t am::am_Gateway_s::sourceID

+

+ +

The sourceID of the gateway sink-end.

+

The sink is a full blown source with connectionFormats, sinkClassIDs etc... It makes sense to register the sources of a gateway as non-visible. Care needs to be taken that the connectionsFormats match with the ones in the conversionMatrix. If the source is located in the controllingDomain, the ID needs to be retrieved by registering the source before registering the gateway. In case the source is in a different domain, the ID needs to be retrieved via peeking.

+ +

Definition at line 723 of file audiomanagertypes.h.

+ +

+

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

include/audiomanagertypes.h

+

+Public Attributes

Detailed Description

Member Data Documentation