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

The interface towards the Controlling Instance (e.g HMI). More...

#include <IAmCommand.h>

Inheritance diagram for am::IAmCommandReceive:
am::CAmCommandReceiver

Public Member Functions

 IAmCommandReceive ()
 
virtual ~IAmCommandReceive ()
 
virtual void getInterfaceVersion (std::string &version) const =0
 This function returns the version of the interface. More...
 
virtual am_Error_e connect (const am_sourceID_t sourceID, const am_sinkID_t sinkID, am_mainConnectionID_t &mainConnectionID)=0
 connects a source to sink More...
 
virtual am_Error_e disconnect (const am_mainConnectionID_t mainConnectionID)=0
 disconnects a mainConnection More...
 
virtual am_Error_e setVolume (const am_sinkID_t sinkID, const am_mainVolume_t volume)=0
 sets the volume for a sink More...
 
virtual am_Error_e volumeStep (const am_sinkID_t sinkID, const int16_t volumeStep)=0
 This function is used to increment or decrement the current volume for a sink. More...
 
virtual am_Error_e setSinkMuteState (const am_sinkID_t sinkID, const am_MuteState_e muteState)=0
 sets the mute state of a sink More...
 
virtual am_Error_e setMainSinkSoundProperty (const am_MainSoundProperty_s &soundProperty, const am_sinkID_t sinkID)=0
 This method is used to set sound properties, e.g. More...
 
virtual am_Error_e setMainSourceSoundProperty (const am_MainSoundProperty_s &soundProperty, const am_sourceID_t sourceID)=0
 This method is used to set sound properties, e.g. More...
 
virtual am_Error_e setSystemProperty (const am_SystemProperty_s &property)=0
 is used to set a specific system property. More...
 
virtual am_Error_e getListMainConnections (std::vector< am_MainConnectionType_s > &listConnections) const =0
 returns the actual list of MainConnections More...
 
virtual am_Error_e getListMainSinks (std::vector< am_SinkType_s > &listMainSinks) const =0
 returns the actual list of Sinks More...
 
virtual am_Error_e getListMainSources (std::vector< am_SourceType_s > &listMainSources) const =0
 returns the actual list of Sources More...
 
virtual am_Error_e getListMainSinkSoundProperties (const am_sinkID_t sinkID, std::vector< am_MainSoundProperty_s > &listSoundProperties) const =0
 This is used to retrieve all source sound properties related to a source. More...
 
virtual am_Error_e getListMainSourceSoundProperties (const am_sourceID_t sourceID, std::vector< am_MainSoundProperty_s > &listSourceProperties) const =0
 This is used to retrieve all source sound properties related to a source. More...
 
virtual am_Error_e getListSourceClasses (std::vector< am_SourceClass_s > &listSourceClasses) const =0
 This is used to retrieve SourceClass Information of all source classes. More...
 
virtual am_Error_e getListSinkClasses (std::vector< am_SinkClass_s > &listSinkClasses) const =0
 This is used to retrieve SinkClass Information of all sink classes. More...
 
virtual am_Error_e getListSystemProperties (std::vector< am_SystemProperty_s > &listSystemProperties) const =0
 Retrieves a complete list of all systemProperties. More...
 
virtual am_Error_e getTimingInformation (const am_mainConnectionID_t mainConnectionID, am_timeSync_t &delay) const =0
 returns the delay in ms that the audiopath for the given mainConnection has More...
 
virtual am_Error_e getDBusConnectionWrapper (CAmDbusWrapper *&dbusConnectionWrapper) const =0
 this function is used to retrieve a pointer to the dBusConnectionWrapper More...
 
virtual am_Error_e getSocketHandler (CAmSocketHandler *&socketHandler) const =0
 This function returns the pointer to the socketHandler. More...
 
virtual void confirmCommandReady (const uint16_t handle, const am_Error_e error)=0
 asynchronous confirmation of setCommandReady. More...
 
virtual void confirmCommandRundown (const uint16_t handle, const am_Error_e error)=0
 asynchronous confirmation of setCommandRundown More...
 
virtual am_Error_e getListMainSinkNotificationConfigurations (const am_sinkID_t sinkID, std::vector< am_NotificationConfiguration_s > &listMainNotificationConfigurations) const =0
 Retrieves the list of MainNotifications for a sink. More...
 
virtual am_Error_e getListMainSourceNotificationConfigurations (const am_sourceID_t sourceID, std::vector< am_NotificationConfiguration_s > &listMainNotificationConfigurations) const =0
 Retrieves the list of MainNotifications for a source. More...
 
virtual am_Error_e setMainSinkNotificationConfiguration (const am_sinkID_t sinkID, const am_NotificationConfiguration_s &mainNotificationConfiguration)=0
 sets a MainNotificationConfiuration. More...
 
virtual am_Error_e setMainSourceNotificationConfiguration (const am_sourceID_t sourceID, const am_NotificationConfiguration_s &mainNotificationConfiguration)=0
 sets a MainNotificationConfiuration. More...
 
virtual am_Error_e getVolume (const am_sinkID_t sinkID, am_mainVolume_t &mainVolume) const =0
 Returns the current volume for the sink directly out of the database. More...
 

Detailed Description

The interface towards the Controlling Instance (e.g HMI).

It handles the communication towards the HMI and other system components who need to interact with the audiomanagement. 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

Definition at line 56 of file IAmCommand.h.

Constructor & Destructor Documentation

am::IAmCommandReceive::IAmCommandReceive ( )
inline

Definition at line 60 of file IAmCommand.h.

virtual am::IAmCommandReceive::~IAmCommandReceive ( )
inlinevirtual

Definition at line 64 of file IAmCommand.h.

Member Function Documentation

virtual void am::IAmCommandReceive::confirmCommandReady ( const uint16_t  handle,
const am_Error_e  error 
)
pure virtual

asynchronous confirmation of setCommandReady.

Implemented in am::CAmCommandReceiver.

virtual void am::IAmCommandReceive::confirmCommandRundown ( const uint16_t  handle,
const am_Error_e  error 
)
pure virtual

asynchronous confirmation of setCommandRundown

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::connect ( const am_sourceID_t  sourceID,
const am_sinkID_t  sinkID,
am_mainConnectionID_t &  mainConnectionID 
)
pure virtual

connects a source to sink

Returns
E_OK on success, E_NOT_POSSIBLE on failure, E_ALREADY_EXISTS if the connection does already exists

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::disconnect ( const am_mainConnectionID_t  mainConnectionID)
pure virtual

disconnects a mainConnection

Returns
E_OK on successes, E_NON_EXISTENT if the connection does not exist, E_NOT_POSSIBLE on error.

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::getDBusConnectionWrapper ( CAmDbusWrapper *&  dbusConnectionWrapper) const
pure virtual

this function is used to retrieve a pointer to the dBusConnectionWrapper

Returns
E_OK if pointer is valid, E_UKNOWN if AudioManager was compiled without DBus Support

Implemented in am::CAmCommandReceiver.

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

This function returns the version of the interface.

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::getListMainConnections ( std::vector< am_MainConnectionType_s > &  listConnections) const
pure virtual

returns the actual list of MainConnections

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::getListMainSinkNotificationConfigurations ( const am_sinkID_t  sinkID,
std::vector< am_NotificationConfiguration_s > &  listMainNotificationConfigurations 
) const
pure virtual

Retrieves the list of MainNotifications for a sink.

Does not return the possible ones.

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::getListMainSinks ( std::vector< am_SinkType_s > &  listMainSinks) const
pure virtual

returns the actual list of Sinks

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmCommandReceiver.

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

This is used to retrieve all source sound properties related to a source.

Returns a vector of the sound properties and values as pair

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::getListMainSourceNotificationConfigurations ( const am_sourceID_t  sourceID,
std::vector< am_NotificationConfiguration_s > &  listMainNotificationConfigurations 
) const
pure virtual

Retrieves the list of MainNotifications for a source.

Does not return the possible ones.

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::getListMainSources ( std::vector< am_SourceType_s > &  listMainSources) const
pure virtual

returns the actual list of Sources

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmCommandReceiver.

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

This is used to retrieve all source sound properties related to a source.

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmCommandReceiver.

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

This is used to retrieve SinkClass Information of all sink classes.

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmCommandReceiver.

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

This is used to retrieve SourceClass Information of all source classes.

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmCommandReceiver.

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

Retrieves a complete list of all systemProperties.

Returns
E_OK on success, E_DATABASE_ERROR on error

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::getSocketHandler ( CAmSocketHandler *&  socketHandler) const
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::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::getTimingInformation ( const am_mainConnectionID_t  mainConnectionID,
am_timeSync_t &  delay 
) const
pure virtual

returns the delay in ms that the audiopath for the given mainConnection has

Returns
E_OK on success, E_NOT_POSSIBLE if timing information is not yet retrieved, E_DATABASE_ERROR on read error on the database

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::getVolume ( const am_sinkID_t  sinkID,
am_mainVolume_t &  mainVolume 
) const
pure virtual

Returns the current volume for the sink directly out of the database.

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::setMainSinkNotificationConfiguration ( const am_sinkID_t  sinkID,
const am_NotificationConfiguration_s &  mainNotificationConfiguration 
)
pure virtual

sets a MainNotificationConfiuration.

This can be used to turn on an off notifications an to change the mode of the configuration.

Returns
E_OK on success, E_NON_EXISTENT if sinkID does not exists, E_DATABASE_ERROR on error

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::setMainSinkSoundProperty ( const am_MainSoundProperty_s &  soundProperty,
const am_sinkID_t  sinkID 
)
pure virtual

This method is used to set sound properties, e.g.

Equalizer Values. Since the capabilities of the system can differ, the exact key value pairs can be extended in each product

Returns
E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::setMainSourceNotificationConfiguration ( const am_sourceID_t  sourceID,
const am_NotificationConfiguration_s &  mainNotificationConfiguration 
)
pure virtual

sets a MainNotificationConfiuration.

This can be used to turn on an off notifications an to change the mode of the configuration.

Returns
E_OK on success, E_NON_EXISTENT if sourceID does not exists, E_DATABASE_ERROR on error

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::setMainSourceSoundProperty ( const am_MainSoundProperty_s &  soundProperty,
const am_sourceID_t  sourceID 
)
pure virtual

This method is used to set sound properties, e.g.

Equalizer Values. Since the capabilities of the system can differ, the exact key value pairs can be extended in each product

Returns
E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::setSinkMuteState ( const am_sinkID_t  sinkID,
const am_MuteState_e  muteState 
)
pure virtual

sets the mute state of a sink

Returns
E_OK on success, E_UNKNOWN on error. If the mute state is already the desired one, the Daemon will return E_OK.

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::setSystemProperty ( const am_SystemProperty_s &  property)
pure virtual

is used to set a specific system property.

Returns
E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::setVolume ( const am_sinkID_t  sinkID,
const am_mainVolume_t  volume 
)
pure virtual

sets the volume for a sink

Returns
E_OK on success, E_UNKOWN on error, E_OUT_OF_RANGE in case the value is out of range

Implemented in am::CAmCommandReceiver.

virtual am_Error_e am::IAmCommandReceive::volumeStep ( const am_sinkID_t  sinkID,
const int16_t  volumeStep 
)
pure virtual

This function is used to increment or decrement the current volume for a sink.

Returns
E_OK on success, E_UNKNOWN on error and E_OUT_OF_RANGE if the value is not in the given volume range.

Implemented in am::CAmCommandReceiver.

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