add functions for control interface to use dbus

[profile/ivi/genivi/genivi-audio-manager.git] / include / control / IAmControlReceive.h

diff --git a/include/control/IAmControlReceive.h b/include/control/IAmControlReceive.h
index 92281b9..ad9d5c9 100755 (executable)
--- a/include/control/IAmControlReceive.h
+++ b/include/control/IAmControlReceive.h
@@ -17,7 +17,7 @@
  * \file
  * For further information see http://projects.genivi.org/audio-manager
  *
- * THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. 
+ * THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL.
  * PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN.
  */
 #if !defined(EA_D35033D8_8C54_4c3b_B0E4_9C98516FDF3C__INCLUDED_)
@@ -28,12 +28,13 @@
 #include "audiomanagertypes.h"
 namespace am {
 class CAmSocketHandler;
+class CAmDbusWrapper;
 }
 
 #include "audiomanagertypes.h"
 #include "NodeStateManager.h"
 
-#define ControlReceiveVersion "3.0" 
+#define ControlReceiveVersion "3.0"
 namespace am {
 
 /**
@@ -100,7 +101,7 @@ public:
         * this method sets a source state for a source. This function will trigger the
         * callback cbAckSetSourceState
         * @return 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 
+        * E_UNKNOWN on error, E_NO_CHANGE if no change is neccessary
         */
        virtual am_Error_e setSourceState(am_Handle_s& handle, const am_sourceID_t sourceID, const am_SourceState_e state) =0;
        /**
@@ -227,7 +228,7 @@ public:
         * 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.
         * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if
-        * sinkClassID was not found. 
+        * sinkClassID was not found.
         */
        virtual am_Error_e changeSinkClassInfoDB(const am_SinkClass_s& sinkClass) =0;
        /**
@@ -280,7 +281,7 @@ public:
        /**
         * changes the mute state of a sink
         * @return E_OK on success, E_DATABASE_ERROR on error, E_NON_EXISTENT if sink was
-        * not found 
+        * not found
         */
        virtual am_Error_e changeSinkMuteStateDB(const am_MuteState_e muteState, const am_sinkID_t sinkID) =0;
        /**
@@ -477,12 +478,12 @@ public:
        virtual am_Error_e getListSystemProperties(std::vector<am_SystemProperty_s>& listSystemProperties) const =0;
        /**
         * sets the command interface to ready. Will send setCommandReady to each of the
-        * plugins. The corresponding answer is confirmCommandReady. 
+        * plugins. The corresponding answer is confirmCommandReady.
         */
        virtual void setCommandReady() =0;
        /**
         * sets the command interface into the rundown state. Will send setCommandRundown
-        * to each of the plugins. The corresponding answer is confirmCommandRundown. 
+        * to each of the plugins. The corresponding answer is confirmCommandRundown.
         */
        virtual void setCommandRundown() =0;
        /**
@@ -615,6 +616,15 @@ public:
         */
        virtual NsmErrorStatus_e sendLifecycleRequestCompleteNSM(const uint32_t RequestId, const NsmErrorStatus_e status) =0;
 
+    /**
+     * this function is used to retrieve a pointer to the dBusConnectionWrapper
+     * @return E_OK if pointer is valid, E_UKNOWN if AudioManager was compiled without DBus Support
+     *
+     * @param dbusConnectionWrapper    This is a wrapper class that is needed to keep dbus inclusions away from the interface.
+     * The DBusWrapperClass will return the pointer to the DbusConnection call (getDBusConnection)
+     */
+    virtual am_Error_e getDBusConnectionWrapper(CAmDbusWrapper*& dbusConnectionWrapper) const =0;
+
 };
 }
 #endif // !defined(EA_D35033D8_8C54_4c3b_B0E4_9C98516FDF3C__INCLUDED_)