From 006a2ce21f277f171c8da9f4455c7299977fd87a Mon Sep 17 00:00:00 2001 From: Christian as GENIVI Maintainer Date: Fri, 30 Sep 2016 08:27:37 -0700 Subject: add actual doxygen documentation Signed-off-by: Christian as GENIVI Maintainer --- classam_1_1CAmCommandReceiver.html | 1433 ++++++++++++++++++++++++++++++++++++ 1 file changed, 1433 insertions(+) create mode 100644 classam_1_1CAmCommandReceiver.html (limited to 'classam_1_1CAmCommandReceiver.html') diff --git a/classam_1_1CAmCommandReceiver.html b/classam_1_1CAmCommandReceiver.html new file mode 100644 index 0000000..24f58b5 --- /dev/null +++ b/classam_1_1CAmCommandReceiver.html @@ -0,0 +1,1433 @@ + + + + + + +AudioManager: am::CAmCommandReceiver Class Reference + + + + + + + + + + + + + +
+
+ + + + + + +
+
AudioManager +  7.5.11 +
+
Native Application Runtime Environment
+
+
+ + + + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+Public Member Functions | +List of all members
+
+
am::CAmCommandReceiver Class Reference
+
+
+ +

This class realizes the command Interface. + More...

+ +

#include <CAmCommandReceiver.h>

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

+Public Member Functions

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

Detailed Description

+

This class realizes the command Interface.

+ +

Definition at line 40 of file CAmCommandReceiver.h.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
am::CAmCommandReceiver::CAmCommandReceiver (IAmDatabaseHandler * iDatabaseHandler,
CAmControlSender * iControlSender,
CAmSocketHandler * iSocketHandler 
)
+
+ +

Definition at line 35 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
am::CAmCommandReceiver::CAmCommandReceiver (IAmDatabaseHandler * iDatabaseHandler,
CAmControlSender * iControlSender,
CAmSocketHandler * iSocketHandler,
CAmDbusWrapper * iDBusWrapper 
)
+
+ +

Definition at line 54 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + + + +
am::CAmCommandReceiver::~CAmCommandReceiver ()
+
+ +

Definition at line 73 of file CAmCommandReceiver.cpp.

+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void am::CAmCommandReceiver::confirmCommandReady (const uint16_t handle,
const am_Error_e error 
)
+ 		+virtual
+
+ +

asynchronous confirmation of setCommandReady.

+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 198 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
void am::CAmCommandReceiver::confirmCommandRundown (const uint16_t handle,
const am_Error_e error 
)
+ 		+virtual
+
+ +

asynchronous confirmation of setCommandRundown

+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 207 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
am_Error_e am::CAmCommandReceiver::connect (const am_sourceID_t sourceID,
const am_sinkID_t sinkID,
am_mainConnectionID_t & mainConnectionID 
)
+ 		+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
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 77 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
am_Error_e am::CAmCommandReceiver::disconnect (const am_mainConnectionID_t mainConnectionID)
+ 		+virtual
+
+ +

disconnects a mainConnection

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

Implements am::IAmCommandReceive.

+ +

Definition at line 83 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
am_Error_e am::CAmCommandReceiver::getDBusConnectionWrapper (CAmDbusWrapper *& dbusConnectionWrapper) const
+ 		+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
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 176 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
void am::CAmCommandReceiver::getInterfaceVersion (std::string & version) const
+ 		+virtual
+
+ +

This function returns the version of the interface.

+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 193 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
am_Error_e am::CAmCommandReceiver::getListMainConnections (std::vector< am_MainConnectionType_s > & listConnections) const
+ 		+virtual
+
+ +

returns the actual list of MainConnections

+
Returns
E_OK on success, E_DATABASE_ERROR on error
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 130 of file CAmCommandReceiver.cpp.

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

Retrieves the list of MainNotifications for a sink.

+

Does not return the possible ones.

+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 236 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
am_Error_e am::CAmCommandReceiver::getListMainSinks (std::vector< am_SinkType_s > & listMainSinks) const
+ 		+virtual
+
+ +

returns the actual list of Sinks

+
Returns
E_OK on success, E_DATABASE_ERROR on error
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 136 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
am_Error_e am::CAmCommandReceiver::getListMainSinkSoundProperties (const am_sinkID_t sinkID,
std::vector< am_MainSoundProperty_s > & listSoundProperties 
) const
+ 		+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
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 146 of file CAmCommandReceiver.cpp.

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

Retrieves the list of MainNotifications for a source.

+

Does not return the possible ones.

+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 241 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
am_Error_e am::CAmCommandReceiver::getListMainSources (std::vector< am_SourceType_s > & listMainSources) const
+ 		+virtual
+
+ +

returns the actual list of Sources

+
Returns
E_OK on success, E_DATABASE_ERROR on error
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 141 of file CAmCommandReceiver.cpp.

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

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

+
Returns
E_OK on success, E_DATABASE_ERROR on error
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 151 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
am_Error_e am::CAmCommandReceiver::getListSinkClasses (std::vector< am_SinkClass_s > & listSinkClasses) const
+ 		+virtual
+
+ +

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

+
Returns
E_OK on success, E_DATABASE_ERROR on error
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 161 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
am_Error_e am::CAmCommandReceiver::getListSourceClasses (std::vector< am_SourceClass_s > & listSourceClasses) const
+ 		+virtual
+
+ +

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

+
Returns
E_OK on success, E_DATABASE_ERROR on error
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 156 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
am_Error_e am::CAmCommandReceiver::getListSystemProperties (std::vector< am_SystemProperty_s > & listSystemProperties) const
+ 		+virtual
+
+ +

Retrieves a complete list of all systemProperties.

+
Returns
E_OK on success, E_DATABASE_ERROR on error
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 166 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + + + +
uint16_t am::CAmCommandReceiver::getRundownHandle ()
+
+ +

returns a rundown handle

+ +

Definition at line 223 of file CAmCommandReceiver.cpp.

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

+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 187 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + + + +
uint16_t am::CAmCommandReceiver::getStartupHandle ()
+
+ +

returns a startup handle

+ +

Definition at line 216 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
am_Error_e am::CAmCommandReceiver::getTimingInformation (const am_mainConnectionID_t mainConnectionID,
am_timeSync_t & delay 
) const
+ 		+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
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 171 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
am_Error_e am::CAmCommandReceiver::getVolume (const am_sinkID_t sinkID,
am_mainVolume_t & mainVolume 
) const
+ 		+virtual
+
+ +

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

+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 125 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
am_Error_e am::CAmCommandReceiver::setMainSinkNotificationConfiguration (const am_sinkID_t sinkID,
const am_NotificationConfiguration_s & mainNotificationConfiguration 
)
+ 		+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
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 246 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
am_Error_e am::CAmCommandReceiver::setMainSinkSoundProperty (const am_MainSoundProperty_s & soundProperty,
const am_sinkID_t sinkID 
)
+ 		+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
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 107 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
am_Error_e am::CAmCommandReceiver::setMainSourceNotificationConfiguration (const am_sourceID_t sourceID,
const am_NotificationConfiguration_s & mainNotificationConfiguration 
)
+ 		+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
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 252 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
am_Error_e am::CAmCommandReceiver::setMainSourceSoundProperty (const am_MainSoundProperty_s & soundProperty,
const am_sourceID_t sourceID 
)
+ 		+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
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 113 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
am_Error_e am::CAmCommandReceiver::setSinkMuteState (const am_sinkID_t sinkID,
const am_MuteState_e muteState 
)
+ 		+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.
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 101 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
am_Error_e am::CAmCommandReceiver::setSystemProperty (const am_SystemProperty_s & property)
+ 		+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
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 119 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
am_Error_e am::CAmCommandReceiver::setVolume (const am_sinkID_t sinkID,
const am_mainVolume_t volume 
)
+ 		+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
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 89 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
am_Error_e am::CAmCommandReceiver::volumeStep (const am_sinkID_t sinkID,
const int16_t volumeStep 
)
+ 		+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.
+ +

Implements am::IAmCommandReceive.

+ +

Definition at line 95 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void am::CAmCommandReceiver::waitOnRundown (bool rundown)
+
+ +

tells the ComandReceiver to start waiting for all handles to be confirmed

+ +

Definition at line 258 of file CAmCommandReceiver.cpp.

+ +
+
+ +
+
+ + + + + + + + +
void am::CAmCommandReceiver::waitOnStartup (bool startup)
+
+ +

tells the ComandReceiver to start waiting for all handles to be confirmed

+ +

Definition at line 230 of file CAmCommandReceiver.cpp.

+ +
+
+
The documentation for this class was generated from the following files: +
+
+ + + + -- cgit v1.2.1