AudioManager  7.6.6
Native Application Runtime Environment
Public Member Functions | List of all members
am::IAmControlReceive Class Referenceabstract

This interface gives access to all important functions of the audiomanager that are used by the AudioManagerController to control the system. More...

#include <IAmControl.h>

Inheritance diagram for am::IAmControlReceive:
am::CAmControlReceiver

Public Member Functions

 IAmControlReceive ()
 
virtual ~IAmControlReceive ()
 
virtual void getInterfaceVersion (std::string &version) const =0
 This function returns the version of the interface. More...
 
virtual am_Error_e getRoute (const bool onlyfree, const am_sourceID_t sourceID, const am_sinkID_t sinkID, std::vector< am_Route_s > &returnList)=0
 calculates a route from source to sink. More...
 
virtual am_Error_e connect (am_Handle_s &handle, am_connectionID_t &connectionID, const am_CustomConnectionFormat_t format, const am_sourceID_t sourceID, const am_sinkID_t sinkID)=0
 With this function, elementary connects can be triggered by the controller. More...
 
virtual am_Error_e disconnect (am_Handle_s &handle, const am_connectionID_t connectionID)=0
 is used to disconnect a connection More...
 
virtual am_Error_e crossfade (am_Handle_s &handle, const am_HotSink_e hotSource, const am_crossfaderID_t crossfaderID, const am_CustomRampType_t rampType, const am_time_t rampTime)=0
 triggers a cross fade. More...
 
virtual am_Error_e abortAction (const am_Handle_s handle)=0
 with this method, all actions that have a handle assigned can be stopped. More...
 
virtual am_Error_e setSourceState (am_Handle_s &handle, const am_sourceID_t sourceID, const am_SourceState_e state)=0
 this method sets a source state for a source. More...
 
virtual am_Error_e setSinkVolume (am_Handle_s &handle, const am_sinkID_t sinkID, const am_volume_t volume, const am_CustomRampType_t ramp, const am_time_t time)=0
 with this function, setting of sinks volumes is done. More...
 
virtual am_Error_e setSourceVolume (am_Handle_s &handle, const am_sourceID_t sourceID, const am_volume_t volume, const am_CustomRampType_t rampType, const am_time_t time)=0
 with this function, setting of source volumes is done. More...
 
virtual am_Error_e setSinkSoundProperties (am_Handle_s &handle, const am_sinkID_t sinkID, const std::vector< am_SoundProperty_s > &soundProperty)=0
 is used to set several sinkSoundProperties at a time More...
 
virtual am_Error_e setSinkSoundProperty (am_Handle_s &handle, const am_sinkID_t sinkID, const am_SoundProperty_s &soundProperty)=0
 is used to set sinkSoundProperties More...
 
virtual am_Error_e setSourceSoundProperties (am_Handle_s &handle, const am_sourceID_t sourceID, const std::vector< am_SoundProperty_s > &soundProperty)=0
 is used to set several SourceSoundProperties at a time More...
 
virtual am_Error_e setSourceSoundProperty (am_Handle_s &handle, const am_sourceID_t sourceID, const am_SoundProperty_s &soundProperty)=0
 is used to set sourceSoundProperties More...
 
virtual am_Error_e setDomainState (const am_domainID_t domainID, const am_DomainState_e domainState)=0
 sets the domain state of a domain More...
 
virtual am_Error_e enterDomainDB (const am_Domain_s &domainData, am_domainID_t &domainID)=0
 enters a domain in the database, creates and ID More...
 
virtual am_Error_e enterMainConnectionDB (const am_MainConnection_s &mainConnectionData, am_mainConnectionID_t &connectionID)=0
 enters a mainconnection in the database, creates and ID More...
 
virtual am_Error_e enterSinkDB (const am_Sink_s &sinkData, am_sinkID_t &sinkID)=0
 enters a sink in the database. More...
 
virtual am_Error_e enterCrossfaderDB (const am_Crossfader_s &crossfaderData, am_crossfaderID_t &crossfaderID)=0
 enters a crossfader in the database. More...
 
virtual am_Error_e enterGatewayDB (const am_Gateway_s &gatewayData, am_gatewayID_t &gatewayID)=0
 enters a gateway in the database. More...
 
virtual am_Error_e enterConverterDB (const am_Converter_s &converterData, am_converterID_t &converterID)=0
 enters a converter in the database. More...
 
virtual am_Error_e enterSourceDB (const am_Source_s &sourceData, am_sourceID_t &sourceID)=0
 enters a source in the database. More...
 
virtual am_Error_e enterSinkClassDB (const am_SinkClass_s &sinkClass, am_sinkClass_t &sinkClassID)=0
 Enters a sourceClass into the database. More...
 
virtual am_Error_e enterSourceClassDB (am_sourceClass_t &sourceClassID, const am_SourceClass_s &sourceClass)=0
 Enters a sourceClass into the database. More...
 
virtual am_Error_e changeSinkClassInfoDB (const am_SinkClass_s &sinkClass)=0
 changes class information of a sinkclass. More...
 
virtual am_Error_e changeSourceClassInfoDB (const am_SourceClass_s &sourceClass)=0
 changes class information of a sourceClass. More...
 
virtual am_Error_e enterSystemPropertiesListDB (const std::vector< am_SystemProperty_s > &listSystemProperties)=0
 This function is used to enter the system Properties into the database. More...
 
virtual am_Error_e changeMainConnectionRouteDB (const am_mainConnectionID_t mainconnectionID, const std::vector< am_connectionID_t > &listConnectionID)=0
 changes the mainConnectionState of MainConnection More...
 
virtual am_Error_e changeMainConnectionStateDB (const am_mainConnectionID_t mainconnectionID, const am_ConnectionState_e connectionState)=0
 changes the mainConnectionState of MainConnection More...
 
virtual am_Error_e changeSinkMainVolumeDB (const am_mainVolume_t mainVolume, const am_sinkID_t sinkID)=0
 changes the sink volume of a sink More...
 
virtual am_Error_e changeSinkAvailabilityDB (const am_Availability_s &availability, const am_sinkID_t sinkID)=0
 changes the availablility of a sink More...
 
virtual am_Error_e changDomainStateDB (const am_DomainState_e domainState, const am_domainID_t domainID)=0
 changes the domainstate of a domain More...
 
virtual am_Error_e changeSinkMuteStateDB (const am_MuteState_e muteState, const am_sinkID_t sinkID)=0
 changes the mute state of a sink More...
 
virtual am_Error_e changeMainSinkSoundPropertyDB (const am_MainSoundProperty_s &soundProperty, const am_sinkID_t sinkID)=0
 changes the mainsinksoundproperty of a sink More...
 
virtual am_Error_e changeMainSourceSoundPropertyDB (const am_MainSoundProperty_s &soundProperty, const am_sourceID_t sourceID)=0
 changes the mainsourcesoundproperty of a sink More...
 
virtual am_Error_e changeSourceAvailabilityDB (const am_Availability_s &availability, const am_sourceID_t sourceID)=0
 changes the availablility of a source More...
 
virtual am_Error_e changeSystemPropertyDB (const am_SystemProperty_s &property)=0
 changes a systemProperty More...
 
virtual am_Error_e removeMainConnectionDB (const am_mainConnectionID_t mainConnectionID)=0
 removes a mainconnection from the DB More...
 
virtual am_Error_e removeSinkDB (const am_sinkID_t sinkID)=0
 removes a sink from the DB More...
 
virtual am_Error_e removeSourceDB (const am_sourceID_t sourceID)=0
 removes a source from the DB More...
 
virtual am_Error_e removeGatewayDB (const am_gatewayID_t gatewayID)=0
 removes a gateway from the DB More...
 
virtual am_Error_e removeConverterDB (const am_converterID_t converterID)=0
 removes a converter from the DB More...
 
virtual am_Error_e removeCrossfaderDB (const am_crossfaderID_t crossfaderID)=0
 removes a crossfader from the DB More...
 
virtual am_Error_e removeDomainDB (const am_domainID_t domainID)=0
 removes a domain from the DB More...
 
virtual am_Error_e removeSinkClassDB (const am_sinkClass_t sinkClassID)=0
 removes a domain from the DB More...
 
virtual am_Error_e removeSourceClassDB (const am_sourceClass_t sourceClassID)=0
 removes a domain from the DB More...
 
virtual am_Error_e getSourceClassInfoDB (const am_sourceID_t sourceID, am_SourceClass_s &classInfo) const =0
 returns the ClassInformation of a source More...
 
virtual am_Error_e getSinkClassInfoDB (const am_sinkID_t sinkID, am_SinkClass_s &sinkClass) const =0
 returns the ClassInformation of a sink More...
 
virtual am_Error_e getSinkInfoDB (const am_sinkID_t sinkID, am_Sink_s &sinkData) const =0
 returns the sinkData of a sink More...
 
virtual am_Error_e getSourceInfoDB (const am_sourceID_t sourceID, am_Source_s &sourceData) const =0
 returns the sourcekData of a source More...
 
virtual am_Error_e getConverterInfoDB (const am_converterID_t converterID, am_Converter_s &converterData) const =0
 return source and sink of a converter More...
 
virtual am_Error_e getGatewayInfoDB (const am_gatewayID_t gatewayID, am_Gateway_s &gatewayData) const =0
 return source and sink of a gateway More...
 
virtual am_Error_e getCrossfaderInfoDB (const am_crossfaderID_t crossfaderID, am_Crossfader_s &crossfaderData) const =0
 returns sources and the sink of a crossfader More...
 
virtual am_Error_e getMainConnectionInfoDB (const am_mainConnectionID_t mainConnectionID, am_MainConnection_s &mainConnectionData) const =0
 returns sources and the sink of a crossfader More...
 
virtual am_Error_e getListSinksOfDomain (const am_domainID_t domainID, std::vector< am_sinkID_t > &listSinkID) const =0
 returns all sinks of a domain More...
 
virtual am_Error_e getListSourcesOfDomain (const am_domainID_t domainID, std::vector< am_sourceID_t > &listSourceID) const =0
 returns all source of a domain More...
 
virtual am_Error_e getListCrossfadersOfDomain (const am_domainID_t domainID, std::vector< am_crossfaderID_t > &listCrossfadersID) const =0
 returns all crossfaders of a domain More...
 
virtual am_Error_e getListConvertersOfDomain (const am_domainID_t domainID, std::vector< am_converterID_t > &listConverterID) const =0
 returns all converters of a domain More...
 
virtual am_Error_e getListGatewaysOfDomain (const am_domainID_t domainID, std::vector< am_gatewayID_t > &listGatewaysID) const =0
 returns all gateways of a domain More...
 
virtual am_Error_e getListMainConnections (std::vector< am_MainConnection_s > &listMainConnections) const =0
 returns a complete list of all MainConnections More...
 
virtual am_Error_e getListDomains (std::vector< am_Domain_s > &listDomains) const =0
 returns a complete list of all domains More...
 
virtual am_Error_e getListConnections (std::vector< am_Connection_s > &listConnections) const =0
 returns a complete list of all Connections More...
 
virtual am_Error_e getListSinks (std::vector< am_Sink_s > &listSinks) const =0
 returns a list of all sinks More...
 
virtual am_Error_e getListSources (std::vector< am_Source_s > &listSources) const =0
 returns a list of all sources More...
 
virtual am_Error_e getListSourceClasses (std::vector< am_SourceClass_s > &listSourceClasses) const =0
 returns a list of all source classes More...
 
virtual am_Error_e getListHandles (std::vector< am_Handle_s > &listHandles) const =0
 returns a list of all handles More...
 
virtual am_Error_e getListCrossfaders (std::vector< am_Crossfader_s > &listCrossfaders) const =0
 returns a list of all crossfaders More...
 
virtual am_Error_e getListConverters (std::vector< am_Converter_s > &listConverters) const =0
 returns a list of converters More...
 
virtual am_Error_e getListGateways (std::vector< am_Gateway_s > &listGateways) const =0
 returns a list of gateways More...
 
virtual am_Error_e getListSinkClasses (std::vector< am_SinkClass_s > &listSinkClasses) const =0
 returns a list of all sink classes More...
 
virtual am_Error_e getListSystemProperties (std::vector< am_SystemProperty_s > &listSystemProperties) const =0
 returns the list of SystemProperties More...
 
virtual void setCommandReady ()=0
 sets the command interface to ready. More...
 
virtual void setCommandRundown ()=0
 sets the command interface into the rundown state. More...
 
virtual void setRoutingReady ()=0
 sets the routinginterface to ready. More...
 
virtual void setRoutingRundown ()=0
 sets the routinginterface to the rundown state. More...
 
virtual void confirmControllerReady (const am_Error_e error)=0
 acknowledges the setControllerReady call. More...
 
virtual void confirmControllerRundown (const am_Error_e error)=0
 Acknowledges the setControllerRundown call. More...
 
virtual am_Error_e getSocketHandler (CAmSocketHandler *&socketHandler)=0
 This function returns the pointer to the socketHandler. More...
 
virtual am_Error_e changeSourceDB (const am_sourceID_t sourceID, const am_sourceClass_t sourceClassID, const std::vector< am_SoundProperty_s > &listSoundProperties, const std::vector< am_CustomConnectionFormat_t > &listConnectionFormats, const std::vector< am_MainSoundProperty_s > &listMainSoundProperties)=0
 Change the data of the source. More...
 
virtual am_Error_e changeSinkDB (const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector< am_SoundProperty_s > &listSoundProperties, const std::vector< am_CustomConnectionFormat_t > &listConnectionFormats, const std::vector< am_MainSoundProperty_s > &listMainSoundProperties)=0
 Change the data of the sink. More...
 
virtual am_Error_e changeConverterDB (const am_converterID_t converterID, const std::vector< am_CustomConnectionFormat_t > &listSourceConnectionFormats, const std::vector< am_CustomConnectionFormat_t > &listSinkConnectionFormats, const std::vector< bool > &convertionMatrix)=0
 changes converter Data More...
 
virtual am_Error_e changeGatewayDB (const am_gatewayID_t gatewayID, const std::vector< am_CustomConnectionFormat_t > &listSourceConnectionFormats, const std::vector< am_CustomConnectionFormat_t > &listSinkConnectionFormats, const std::vector< bool > &convertionMatrix)=0
 changes Gateway Data More...
 
virtual am_Error_e setVolumes (am_Handle_s &handle, const std::vector< am_Volumes_s > &listVolumes)=0
 with this function, setting of multiple volumes at a time is done. More...
 
virtual am_Error_e setSinkNotificationConfiguration (am_Handle_s &handle, const am_sinkID_t sinkID, const am_NotificationConfiguration_s &notificationConfiguration)=0
 set a sink notification configuration More...
 
virtual am_Error_e setSourceNotificationConfiguration (am_Handle_s &handle, const am_sourceID_t sourceID, const am_NotificationConfiguration_s &notificationConfiguration)=0
 set a source notification configuration More...
 
virtual void sendMainSinkNotificationPayload (const am_sinkID_t sinkID, const am_NotificationPayload_s &notificationPayload)=0
 Sends out the main notificiation of a sink. More...
 
virtual void sendMainSourceNotificationPayload (const am_sourceID_t sourceID, const am_NotificationPayload_s &notificationPayload)=0
 Sends out the main notificiation of a source. More...
 
virtual am_Error_e changeMainSinkNotificationConfigurationDB (const am_sinkID_t sinkID, const am_NotificationConfiguration_s &mainNotificationConfiguration)=0
 change the mainNotificationConfiguration of a sink More...
 
virtual am_Error_e changeMainSourceNotificationConfigurationDB (const am_sourceID_t sourceID, const am_NotificationConfiguration_s &mainNotificationConfiguration)=0
 change the mainNotificationConfiguration of a source More...
 
virtual am_Error_e getListMainSinkSoundProperties (const am_sinkID_t sinkID, std::vector< am_MainSoundProperty_s > &listSoundproperties) const =0
 This function retrieves a list of all sink mainsoundproperties with its values. More...
 
virtual am_Error_e getListMainSourceSoundProperties (const am_sourceID_t sourceID, std::vector< am_MainSoundProperty_s > &listSoundproperties) const =0
 This function retrieves a list of all source mainsoundproperties with its values. More...
 
virtual am_Error_e getListSinkSoundProperties (const am_sinkID_t sinkID, std::vector< am_SoundProperty_s > &listSoundproperties) const =0
 This function retrieves a list of all sink soundproperties with its values. More...
 
virtual am_Error_e getListSourceSoundProperties (const am_sourceID_t sourceID, std::vector< am_SoundProperty_s > &listSoundproperties) const =0
 This function retrieves a list of all sink soundproperties with its values. More...
 
virtual am_Error_e getMainSinkSoundPropertyValue (const am_sinkID_t sinkID, const am_CustomMainSoundPropertyType_t propertyType, int16_t &value) const =0
 This function retrieves the value of a sink Mainsoundproperty. More...
 
virtual am_Error_e getSinkSoundPropertyValue (const am_sinkID_t sinkID, const am_CustomSoundPropertyType_t propertyType, int16_t &value) const =0
 This function retrieves the value of a sink soundproperty. More...
 
virtual am_Error_e getMainSourceSoundPropertyValue (const am_sourceID_t sourceID, const am_CustomMainSoundPropertyType_t propertyType, int16_t &value) const =0
 This function retrieves the value of a source Mainsoundproperty. More...
 
virtual am_Error_e getSourceSoundPropertyValue (const am_sourceID_t sourceID, const am_CustomSoundPropertyType_t propertyType, int16_t &value) const =0
 This function retrieves the value of a source soundproperty. More...
 
virtual am_Error_e resyncConnectionState (const am_domainID_t domainID, std::vector< am_Connection_s > &listOfExistingConnections)=0
 Retrieves a list of all current active connections from a domain. More...
 
virtual am_Error_e removeHandle (const am_Handle_s handle)=0
 This function searches for a handle in the RoutingSender and removes it if found. More...
 

Detailed Description

This interface gives access to all important functions of the audiomanager that are used by the AudioManagerController to control the system.

There are two rules that have to be kept in mind when implementing against this interface:

Warning
  1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!!
  2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.

Violation these rules may lead to unexpected behavior! Nevertheless you can implement thread safe by using the deferred-call pattern described on the wiki which also helps to implement calls that are forbidden.
For more information, please check CAmSerializer

All functions that contain handles can be resend when using the same handle. Take care to initialize the handles properly to avaid unintended resending.

Definition at line 56 of file IAmControl.h.

Constructor & Destructor Documentation

am::IAmControlReceive::IAmControlReceive ( )
inline

Definition at line 60 of file IAmControl.h.

virtual am::IAmControlReceive::~IAmControlReceive ( )
inlinevirtual

Definition at line 64 of file IAmControl.h.

Member Function Documentation

virtual am_Error_e am::IAmControlReceive::abortAction ( const am_Handle_s  handle)
pure virtual

with this method, all actions that have a handle assigned can be stopped.

Returns
E_OK on success, E_UNKNOWN on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changDomainStateDB ( const am_DomainState_e  domainState,
const am_domainID_t  domainID 
)
pure virtual

changes the domainstate of a domain

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeConverterDB ( const am_converterID_t  converterID,
const std::vector< am_CustomConnectionFormat_t > &  listSourceConnectionFormats,
const std::vector< am_CustomConnectionFormat_t > &  listSinkConnectionFormats,
const std::vector< bool > &  convertionMatrix 
)
pure virtual

changes converter Data

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeGatewayDB ( const am_gatewayID_t  gatewayID,
const std::vector< am_CustomConnectionFormat_t > &  listSourceConnectionFormats,
const std::vector< am_CustomConnectionFormat_t > &  listSinkConnectionFormats,
const std::vector< bool > &  convertionMatrix 
)
pure virtual

changes Gateway Data

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeMainConnectionRouteDB ( const am_mainConnectionID_t  mainconnectionID,
const std::vector< am_connectionID_t > &  listConnectionID 
)
pure virtual

changes the mainConnectionState of MainConnection

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if mainconnection

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeMainConnectionStateDB ( const am_mainConnectionID_t  mainconnectionID,
const am_ConnectionState_e  connectionState 
)
pure virtual

changes the mainConnectionState of MainConnection

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if mainconnection

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeMainSinkNotificationConfigurationDB ( const am_sinkID_t  sinkID,
const am_NotificationConfiguration_s &  mainNotificationConfiguration 
)
pure virtual

change the mainNotificationConfiguration of a sink

Returns
E_OK when successful, E_DATABASE on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeMainSinkSoundPropertyDB ( const am_MainSoundProperty_s &  soundProperty,
const am_sinkID_t  sinkID 
)
pure virtual

changes the mainsinksoundproperty of a sink

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeMainSourceNotificationConfigurationDB ( const am_sourceID_t  sourceID,
const am_NotificationConfiguration_s &  mainNotificationConfiguration 
)
pure virtual

change the mainNotificationConfiguration of a source

Returns
E_OK when successful, E_DATABASE on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeMainSourceSoundPropertyDB ( const am_MainSoundProperty_s &  soundProperty,
const am_sourceID_t  sourceID 
)
pure virtual

changes the mainsourcesoundproperty of a sink

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeSinkAvailabilityDB ( const am_Availability_s &  availability,
const am_sinkID_t  sinkID 
)
pure virtual

changes the availablility of a sink

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeSinkClassInfoDB ( const am_SinkClass_s &  sinkClass)
pure virtual

changes class information of a sinkclass.

The properties will overwrite the values of the sinkClassID given in the sinkClass. It is the duty of the controller to check if the property is valid. If it does not exist, the daemon will not return an error.

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sinkClassID was not found.

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeSinkDB ( const am_sinkID_t  sinkID,
const am_sinkClass_t  sinkClassID,
const std::vector< am_SoundProperty_s > &  listSoundProperties,
const std::vector< am_CustomConnectionFormat_t > &  listConnectionFormats,
const std::vector< am_MainSoundProperty_s > &  listMainSoundProperties 
)
pure virtual

Change the data of the sink.

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeSinkMainVolumeDB ( const am_mainVolume_t  mainVolume,
const am_sinkID_t  sinkID 
)
pure virtual

changes the sink volume of a sink

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeSinkMuteStateDB ( const am_MuteState_e  muteState,
const am_sinkID_t  sinkID 
)
pure virtual

changes the mute state of a sink

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeSourceAvailabilityDB ( const am_Availability_s &  availability,
const am_sourceID_t  sourceID 
)
pure virtual

changes the availablility of a source

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeSourceClassInfoDB ( const am_SourceClass_s &  sourceClass)
pure virtual

changes class information of a sourceClass.

The properties will overwrite the values of the sourceClassID given in the sourceClass. It is the duty of the controller to check if the property is valid. If it does not exist, the daemon will not return an error.

Returns
E_OK on success, E_DATABASE_ERROR on error and E_NON_EXISTENT if the ClassID does not exist.

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeSourceDB ( const am_sourceID_t  sourceID,
const am_sourceClass_t  sourceClassID,
const std::vector< am_SoundProperty_s > &  listSoundProperties,
const std::vector< am_CustomConnectionFormat_t > &  listConnectionFormats,
const std::vector< am_MainSoundProperty_s > &  listMainSoundProperties 
)
pure virtual

Change the data of the source.

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::changeSystemPropertyDB ( const am_SystemProperty_s &  property)
pure virtual

changes a systemProperty

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if property was not found

Implemented in am::CAmControlReceiver.

virtual void am::IAmControlReceive::confirmControllerReady ( const am_Error_e  error)
pure virtual

acknowledges the setControllerReady call.

Implemented in am::CAmControlReceiver.

virtual void am::IAmControlReceive::confirmControllerRundown ( const am_Error_e  error)
pure virtual

Acknowledges the setControllerRundown call.

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::connect ( am_Handle_s &  handle,
am_connectionID_t &  connectionID,
const am_CustomConnectionFormat_t  format,
const am_sourceID_t  sourceID,
const am_sinkID_t  sinkID 
)
pure virtual

With this function, elementary connects can be triggered by the controller.

Returns
E_OK on success, E_UNKNOWN on error, E_WRONG_FORMAT of connectionFormats do not match, E_NO_CHANGE if the desired connection is already build up

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::crossfade ( am_Handle_s &  handle,
const am_HotSink_e  hotSource,
const am_crossfaderID_t  crossfaderID,
const am_CustomRampType_t  rampType,
const am_time_t  rampTime 
)
pure virtual

triggers a cross fade.

Returns
E_OK on success, E_UNKNOWN on error E_NO_CHANGE if no change is neccessary

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::disconnect ( am_Handle_s &  handle,
const am_connectionID_t  connectionID 
)
pure virtual

is used to disconnect a connection

Returns
E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if connection was not found, E_NO_CHANGE if no change is neccessary

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::enterConverterDB ( const am_Converter_s &  converterData,
am_converterID_t &  converterID 
)
pure virtual

enters a converter in the database.

The converterID in am_Converter_s shall be 0 in case of a dynamic added source A converterID greater than 100 will be assigned. If a specific gatewayID with a value <100 is given, the given value will be used. This is for a static setup where the ID's are predefined.

Returns
E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the database, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::enterCrossfaderDB ( const am_Crossfader_s &  crossfaderData,
am_crossfaderID_t &  crossfaderID 
)
pure virtual

enters a crossfader in the database.

The crossfaderID in am_Crossfader_s shall be 0 in case of a dynamic added source A crossfaderID greater than 100 will be assigned. If a specific crossfaderID with a value <100 is given, the given value will be used. This is for a static setup where the ID's are predefined.

Returns
E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the database, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::enterDomainDB ( const am_Domain_s &  domainData,
am_domainID_t &  domainID 
)
pure virtual

enters a domain in the database, creates and ID

Returns
E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the database, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::enterGatewayDB ( const am_Gateway_s &  gatewayData,
am_gatewayID_t &  gatewayID 
)
pure virtual

enters a gateway in the database.

The gatewayID in am_Gateway_s shall be 0 in case of a dynamic added source A gatewayID greater than 100 will be assigned. If a specific gatewayID with a value <100 is given, the given value will be used. This is for a static setup where the ID's are predefined.

Returns
E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the database, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::enterMainConnectionDB ( const am_MainConnection_s &  mainConnectionData,
am_mainConnectionID_t &  connectionID 
)
pure virtual

enters a mainconnection in the database, creates and ID

Returns
E_OK on success, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::enterSinkClassDB ( const am_SinkClass_s &  sinkClass,
am_sinkClass_t &  sinkClassID 
)
pure virtual

Enters a sourceClass into the database.

Returns
E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the database, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::enterSinkDB ( const am_Sink_s &  sinkData,
am_sinkID_t &  sinkID 
)
pure virtual

enters a sink in the database.

The sinkID in am_Sink_s shall be 0 in case of a dynamic added source A sinkID greater than 100 will be assigned. If a specific sinkID with a value <100 is given, the given value will be used. This is for a static setup where the ID's are predefined.

Returns
E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the database, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::enterSourceClassDB ( am_sourceClass_t &  sourceClassID,
const am_SourceClass_s &  sourceClass 
)
pure virtual

Enters a sourceClass into the database.

The sourceClassID in am_sourceClass_s shall be 0 in case of a dynamic added source A sourceClassID greater than 100 will be assigned. If a specific sourceClassID with a value <100 is given, the given value will be used. This is for a static setup where the ID's are predefined.

Returns
E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the database, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::enterSourceDB ( const am_Source_s &  sourceData,
am_sourceID_t &  sourceID 
)
pure virtual

enters a source in the database.

The sourceID in am_Source_s shall be 0 in case of a dynamic added source A sourceID greater than 100 will be assigned. If a specific sourceID with a value <100 is given, the given value will be used. This is for a static setup where the ID's are predefined.

Returns
E_OK on success, E_ALREADY_EXISTENT if the ID or name is already in the database, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::enterSystemPropertiesListDB ( const std::vector< am_SystemProperty_s > &  listSystemProperties)
pure virtual

This function is used to enter the system Properties into the database.

All entries in the database will be erased before entering the new List. It should only be called once at system startup.

Returns
E_OK on success, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getConverterInfoDB ( const am_converterID_t  converterID,
am_Converter_s &  converterData 
) const
pure virtual

return source and sink of a converter

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if gateway was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getCrossfaderInfoDB ( const am_crossfaderID_t  crossfaderID,
am_Crossfader_s &  crossfaderData 
) const
pure virtual

returns sources and the sink of a crossfader

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if crossfader was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getGatewayInfoDB ( const am_gatewayID_t  gatewayID,
am_Gateway_s &  gatewayData 
) const
pure virtual

return source and sink of a gateway

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if gateway was not found

Implemented in am::CAmControlReceiver.

virtual void am::IAmControlReceive::getInterfaceVersion ( std::string &  version) const
pure virtual

This function returns the version of the interface.

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListConnections ( std::vector< am_Connection_s > &  listConnections) const
pure virtual

returns a complete list of all Connections

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListConverters ( std::vector< am_Converter_s > &  listConverters) const
pure virtual

returns a list of converters

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListConvertersOfDomain ( const am_domainID_t  domainID,
std::vector< am_converterID_t > &  listConverterID 
) const
pure virtual

returns all converters of a domain

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListCrossfaders ( std::vector< am_Crossfader_s > &  listCrossfaders) const
pure virtual

returns a list of all crossfaders

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListCrossfadersOfDomain ( const am_domainID_t  domainID,
std::vector< am_crossfaderID_t > &  listCrossfadersID 
) const
pure virtual

returns all crossfaders of a domain

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListDomains ( std::vector< am_Domain_s > &  listDomains) const
pure virtual

returns a complete list of all domains

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListGateways ( std::vector< am_Gateway_s > &  listGateways) const
pure virtual

returns a list of gateways

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListGatewaysOfDomain ( const am_domainID_t  domainID,
std::vector< am_gatewayID_t > &  listGatewaysID 
) const
pure virtual

returns all gateways of a domain

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListHandles ( std::vector< am_Handle_s > &  listHandles) const
pure virtual

returns a list of all handles

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListMainConnections ( std::vector< am_MainConnection_s > &  listMainConnections) const
pure virtual

returns a complete list of all MainConnections

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListMainSinkSoundProperties ( const am_sinkID_t  sinkID,
std::vector< am_MainSoundProperty_s > &  listSoundproperties 
) const
pure virtual

This function retrieves a list of all sink mainsoundproperties with its values.

Returns
E_OK when successful, E_DATABASE on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListMainSourceSoundProperties ( const am_sourceID_t  sourceID,
std::vector< am_MainSoundProperty_s > &  listSoundproperties 
) const
pure virtual

This function retrieves a list of all source mainsoundproperties with its values.

Returns
E_OK when successful, E_DATABASE on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListSinkClasses ( std::vector< am_SinkClass_s > &  listSinkClasses) const
pure virtual

returns a list of all sink classes

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListSinks ( std::vector< am_Sink_s > &  listSinks) const
pure virtual

returns a list of all sinks

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListSinksOfDomain ( const am_domainID_t  domainID,
std::vector< am_sinkID_t > &  listSinkID 
) const
pure virtual

returns all sinks of a domain

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListSinkSoundProperties ( const am_sinkID_t  sinkID,
std::vector< am_SoundProperty_s > &  listSoundproperties 
) const
pure virtual

This function retrieves a list of all sink soundproperties with its values.

Returns
E_OK when successful, E_DATABASE on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListSourceClasses ( std::vector< am_SourceClass_s > &  listSourceClasses) const
pure virtual

returns a list of all source classes

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListSources ( std::vector< am_Source_s > &  listSources) const
pure virtual

returns a list of all sources

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListSourcesOfDomain ( const am_domainID_t  domainID,
std::vector< am_sourceID_t > &  listSourceID 
) const
pure virtual

returns all source of a domain

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if domain was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListSourceSoundProperties ( const am_sourceID_t  sourceID,
std::vector< am_SoundProperty_s > &  listSoundproperties 
) const
pure virtual

This function retrieves a list of all sink soundproperties with its values.

Returns
E_OK when successful, E_DATABASE on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getListSystemProperties ( std::vector< am_SystemProperty_s > &  listSystemProperties) const
pure virtual

returns the list of SystemProperties

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getMainConnectionInfoDB ( const am_mainConnectionID_t  mainConnectionID,
am_MainConnection_s &  mainConnectionData 
) const
pure virtual

returns sources and the sink of a crossfader

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if crossfader was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getMainSinkSoundPropertyValue ( const am_sinkID_t  sinkID,
const am_CustomMainSoundPropertyType_t  propertyType,
int16_t &  value 
) const
pure virtual

This function retrieves the value of a sink Mainsoundproperty.

Returns
E_OK when successful, E_DATABASE on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getMainSourceSoundPropertyValue ( const am_sourceID_t  sourceID,
const am_CustomMainSoundPropertyType_t  propertyType,
int16_t &  value 
) const
pure virtual

This function retrieves the value of a source Mainsoundproperty.

Returns
E_OK when successful, E_DATABASE on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getRoute ( const bool  onlyfree,
const am_sourceID_t  sourceID,
const am_sinkID_t  sinkID,
std::vector< am_Route_s > &  returnList 
)
pure virtual

calculates a route from source to sink.

Returns
E_OK on success, E_UNKNOWN on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getSinkClassInfoDB ( const am_sinkID_t  sinkID,
am_SinkClass_s &  sinkClass 
) const
pure virtual

returns the ClassInformation of a sink

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getSinkInfoDB ( const am_sinkID_t  sinkID,
am_Sink_s &  sinkData 
) const
pure virtual

returns the sinkData of a sink

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getSinkSoundPropertyValue ( const am_sinkID_t  sinkID,
const am_CustomSoundPropertyType_t  propertyType,
int16_t &  value 
) const
pure virtual

This function retrieves the value of a sink soundproperty.

Returns
E_OK when successful, E_DATABASE on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getSocketHandler ( CAmSocketHandler *&  socketHandler)
pure virtual

This function returns the pointer to the socketHandler.

This can be used to integrate socket-based activites like communication with the mainloop of the AudioManager. returns E_OK if pointer is valid, E_UNKNOWN in case AudioManager was compiled without socketHandler support,

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getSourceClassInfoDB ( const am_sourceID_t  sourceID,
am_SourceClass_s &  classInfo 
) const
pure virtual

returns the ClassInformation of a source

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if source was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getSourceInfoDB ( const am_sourceID_t  sourceID,
am_Source_s &  sourceData 
) const
pure virtual

returns the sourcekData of a source

Returns
E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was not found

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::getSourceSoundPropertyValue ( const am_sourceID_t  sourceID,
const am_CustomSoundPropertyType_t  propertyType,
int16_t &  value 
) const
pure virtual

This function retrieves the value of a source soundproperty.

Returns
E_OK when successful, E_DATABASE on error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::removeConverterDB ( const am_converterID_t  converterID)
pure virtual

removes a converter from the DB

Returns
E_OK on success, E_NON_EXISTENT if gateway was not found, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::removeCrossfaderDB ( const am_crossfaderID_t  crossfaderID)
pure virtual

removes a crossfader from the DB

Returns
E_OK on success, E_NON_EXISTENT if crossfader was not found, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::removeDomainDB ( const am_domainID_t  domainID)
pure virtual

removes a domain from the DB

Returns
E_OK on success, E_NON_EXISTENT if domain was not found, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::removeGatewayDB ( const am_gatewayID_t  gatewayID)
pure virtual

removes a gateway from the DB

Returns
E_OK on success, E_NON_EXISTENT if gateway was not found, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::removeHandle ( const am_Handle_s  handle)
pure virtual

This function searches for a handle in the RoutingSender and removes it if found.

Returns
E_OK on success, handle removed, E_NON_EXISTENT in case the handle was not foud

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::removeMainConnectionDB ( const am_mainConnectionID_t  mainConnectionID)
pure virtual

removes a mainconnection from the DB

Returns
E_OK on success, E_NON_EXISTENT if main connection was not found, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::removeSinkClassDB ( const am_sinkClass_t  sinkClassID)
pure virtual

removes a domain from the DB

Returns
E_OK on success, E_NON_EXISTENT if domain was not found, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::removeSinkDB ( const am_sinkID_t  sinkID)
pure virtual

removes a sink from the DB

Returns
E_OK on success, E_NON_EXISTENT if sink was not found, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::removeSourceClassDB ( const am_sourceClass_t  sourceClassID)
pure virtual

removes a domain from the DB

Returns
E_OK on success, E_NON_EXISTENT if domain was not found, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::removeSourceDB ( const am_sourceID_t  sourceID)
pure virtual

removes a source from the DB

Returns
E_OK on success, E_NON_EXISTENT if source was not found, E_DATABASE_ERROR if the database had an error

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::resyncConnectionState ( const am_domainID_t  domainID,
std::vector< am_Connection_s > &  listOfExistingConnections 
)
pure virtual

Retrieves a list of all current active connections from a domain.

This method is meant to be used if the audiomanager and a remote domain are out of sync.

Implemented in am::CAmControlReceiver.

virtual void am::IAmControlReceive::sendMainSinkNotificationPayload ( const am_sinkID_t  sinkID,
const am_NotificationPayload_s &  notificationPayload 
)
pure virtual

Sends out the main notificiation of a sink.

Returns
E_OK on success, E_UNKNOWN on error

Implemented in am::CAmControlReceiver.

virtual void am::IAmControlReceive::sendMainSourceNotificationPayload ( const am_sourceID_t  sourceID,
const am_NotificationPayload_s &  notificationPayload 
)
pure virtual

Sends out the main notificiation of a source.

Returns
E_OK on success, E_UNKNOWN on error

Implemented in am::CAmControlReceiver.

virtual void am::IAmControlReceive::setCommandReady ( )
pure virtual

sets the command interface to ready.

Will send setCommandReady to each of the plugins. The corresponding answer is confirmCommandReady.

Implemented in am::CAmControlReceiver.

virtual void am::IAmControlReceive::setCommandRundown ( )
pure virtual

sets the command interface into the rundown state.

Will send setCommandRundown to each of the plugins. The corresponding answer is confirmCommandRundown.

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::setDomainState ( const am_domainID_t  domainID,
const am_DomainState_e  domainState 
)
pure virtual

sets the domain state of a domain

Returns
E_OK on success, E_UNKNOWN on error, E_NO_CHANGE if no change is neccessary

Implemented in am::CAmControlReceiver.

virtual void am::IAmControlReceive::setRoutingReady ( )
pure virtual

sets the routinginterface to ready.

Will send the command setRoutingReady to each of the plugins. The related answer is confirmRoutingReady.

Implemented in am::CAmControlReceiver.

virtual void am::IAmControlReceive::setRoutingRundown ( )
pure virtual

sets the routinginterface to the rundown state.

Will send the command setRoutingRundown to each of the plugins. The related answer is confirmRoutingRundown.

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::setSinkNotificationConfiguration ( am_Handle_s &  handle,
const am_sinkID_t  sinkID,
const am_NotificationConfiguration_s &  notificationConfiguration 
)
pure virtual

set a sink notification configuration

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::setSinkSoundProperties ( am_Handle_s &  handle,
const am_sinkID_t  sinkID,
const std::vector< am_SoundProperty_s > &  soundProperty 
)
pure virtual

is used to set several sinkSoundProperties at a time

Returns
E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if property is out of range, E_NO_CHANGE if no change is neccessary

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::setSinkSoundProperty ( am_Handle_s &  handle,
const am_sinkID_t  sinkID,
const am_SoundProperty_s &  soundProperty 
)
pure virtual

is used to set sinkSoundProperties

Returns
E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if property is out of range, E_NO_CHANGE if no change is neccessary

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::setSinkVolume ( am_Handle_s &  handle,
const am_sinkID_t  sinkID,
const am_volume_t  volume,
const am_CustomRampType_t  ramp,
const am_time_t  time 
)
pure virtual

with this function, setting of sinks volumes is done.

The behavior of the volume set is depended on the given ramp and time information. This function is not only used to ramp volume, but also to mute and direct set the level. Exact behavior is depended on the selected mute ramps.

Returns
E_OK on success, E_NO_CHANGE if the volume is already on the desired value, E_OUT_OF_RANGE is the volume is out of range, E_UNKNOWN on every other error.

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::setSourceNotificationConfiguration ( am_Handle_s &  handle,
const am_sourceID_t  sourceID,
const am_NotificationConfiguration_s &  notificationConfiguration 
)
pure virtual

set a source notification configuration

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::setSourceSoundProperties ( am_Handle_s &  handle,
const am_sourceID_t  sourceID,
const std::vector< am_SoundProperty_s > &  soundProperty 
)
pure virtual

is used to set several SourceSoundProperties at a time

Returns
E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if property is out of range. E_NO_CHANGE if no change is neccessary

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::setSourceSoundProperty ( am_Handle_s &  handle,
const am_sourceID_t  sourceID,
const am_SoundProperty_s &  soundProperty 
)
pure virtual

is used to set sourceSoundProperties

Returns
E_OK on success, E_UNKNOWN on error, E_OUT_OF_RANGE if property is out of range. E_NO_CHANGE if no change is neccessary

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::setSourceState ( am_Handle_s &  handle,
const am_sourceID_t  sourceID,
const am_SourceState_e  state 
)
pure virtual

this method sets a source state for a source.

This function will trigger the callback cbAckSetSourceState

Returns
E_OK on success, E_NO_CHANGE if the desired value is already correct, E_UNKNOWN on error, E_NO_CHANGE if no change is neccessary

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::setSourceVolume ( am_Handle_s &  handle,
const am_sourceID_t  sourceID,
const am_volume_t  volume,
const am_CustomRampType_t  rampType,
const am_time_t  time 
)
pure virtual

with this function, setting of source volumes is done.

The behavior of the volume set is depended on the given ramp and time information. This function is not only used to ramp volume, but also to mute and direct set the level. Exact behavior is depended on the selected mute ramps.

Returns
E_OK on success, E_NO_CHANGE if the volume is already on the desired value, E_OUT_OF_RANGE is the volume is out of range, E_UNKNOWN on every other error.

Implemented in am::CAmControlReceiver.

virtual am_Error_e am::IAmControlReceive::setVolumes ( am_Handle_s &  handle,
const std::vector< am_Volumes_s > &  listVolumes 
)
pure virtual

with this function, setting of multiple volumes at a time is done.

The behavior of the volume set is depended on the given ramp and time information. This function is not only used to ramp volume, but also to mute and direct set the level. Exact behavior is depended on the selected mute ramps.

Returns
E_OK on success, E_NO_CHANGE if the volume is already on the desired value, E_OUT_OF_RANGE is the volume is out of range, E_UNKNOWN on every other error.

Implemented in am::CAmControlReceiver.

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