Merge pull request #49 from GENIVI/PluralProperties

Add plural form of set/get ..SoundProperty() and ..SystemProperty() to allow for simultaneous handling of multible, possibly interrelated attributes.

1 files changed, 31 insertions, 2 deletions

diff --git a/include/IAmCommand.h b/include/IAmCommand.h
index 9d59e8a..72a4373 100644
--- a/include/IAmCommand.h
+++ b/include/IAmCommand.h
@@ -25,7 +25,6 @@
 

 #include <vector>

 #include <string>

-#include "audiomanagertypes.h"

 namespace am {

 class CAmDbusWrapper;

 class CAmSocketHandler;

@@ -34,7 +33,7 @@ class CAmSocketHandler;
 

 #include "audiomanagertypes.h"

 

-#define CommandVersion "4.0" 
+#define CommandVersion "4.1" 
 namespace am {

 

 /**

@@ -108,6 +107,12 @@ public:
 	 */

 	virtual am_Error_e setMainSinkSoundProperty(const am_MainSoundProperty_s& soundProperty, const am_sinkID_t sinkID) =0;

 	/**

+	 * This method is used to set the list of sound properties

+	 * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in

+	 * case of an error

+	 */

+	virtual am_Error_e setMainSinkSoundProperties(const std::vector<am_MainSoundProperty_s> &/*listSoundProperties*/, const am_sinkID_t /*sinkID*/) { return E_OK; };

+	/**

 	 * 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

@@ -116,12 +121,24 @@ public:
 	 */

 	virtual am_Error_e setMainSourceSoundProperty(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID) =0;

 	/**

+	 * This method is used to set the list of sound properties

+	 * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in

+	 * case of an error

+	 */

+	virtual am_Error_e setMainSourceSoundProperties(const std::vector<am_MainSoundProperty_s> &/*listSoundProperties*/, const am_sourceID_t /*sourceID*/) { return E_OK; };

+	/**

 	 * is used to set a specific system property.

 	 * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in

 	 * case of an error

 	 */

 	virtual am_Error_e setSystemProperty(const am_SystemProperty_s& property) =0;

 	/**

+	 * is used to set a specific system properties.

+	 * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in

+	 * case of an error

+	 */

+	virtual am_Error_e setSystemProperties(const std::vector<am_SystemProperty_s>&/*listSystemProperties*/ ) { return E_OK; };

+	/**

 	 * returns the actual list of MainConnections

 	 * @return E_OK on success, E_DATABASE_ERROR on error 

 	 */

@@ -322,10 +339,18 @@ public:
 	 */

 	virtual void cbMainSinkSoundPropertyChanged(const am_sinkID_t sinkID, const am_MainSoundProperty_s& soundProperty) =0;

 	/**

+	 * this callback indicates that sourceSoundProperties have changed.

+	 */

+	virtual void cbMainSinkSoundPropertiesChanged(const am_sinkID_t /*sinkID*/, const std::vector<am_MainSoundProperty_s> &/*listSoundProperties*/) { return; };

+	/**

 	 * this callback indicates that a sourceSoundProperty has changed.

 	 */

 	virtual void cbMainSourceSoundPropertyChanged(const am_sourceID_t sourceID, const am_MainSoundProperty_s& soundProperty) =0;

 	/**

+	 * this callback indicates that sourceSoundProperties have changed.

+	 */

+	virtual void cbMainSourceSoundPropertiesChanged(const am_sourceID_t /*sourceID*/, const std::vector<am_MainSoundProperty_s> &/*listSoundProperties*/) { return; };

+	/**

 	 * this callback is called when the availability of a sink has changed

 	 */

 	virtual void cbSinkAvailabilityChanged(const am_sinkID_t sinkID, const am_Availability_s& availability) =0;

@@ -346,6 +371,10 @@ public:
 	 */

 	virtual void cbSystemPropertyChanged(const am_SystemProperty_s& systemProperty) =0;

 	/**

+	 * is fired if a systemProperties changed

+	 */

+	virtual void cbSystemPropertiesChanged(const std::vector<am_SystemProperty_s>&/*listSystemProperties*/) { return; };

+	/**

 	 * This callback is fired if the timinginformation for a mainConnectionID changed

 	 */

 	virtual void cbTimingInformationChanged(const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time) =0;