summaryrefslogtreecommitdiff
path: root/include/command/IAmCommandReceive.h
diff options
context:
space:
mode:
authorChristian Linke <christian.linke@bmw.de>2015-03-24 18:22:13 +0100
committerChristian Linke <christian.linke@bmw.de>2015-03-24 19:01:59 +0100
commit1c6b81831f28eeb9a1f2775c76f32eeb59c30007 (patch)
tree7b71396e3312b9cddb4e3809dcb5f0a10d63814d /include/command/IAmCommandReceive.h
parent05e5f00118fc835c3aba20f54919f72801eb45cf (diff)
downloadaudiomanager-1c6b81831f28eeb9a1f2775c76f32eeb59c30007.tar.gz
* now only 3 header files are generated. Send and Receive interface s in one. TimingInformation for a single connections is now reported to the controller plugin
Signed-off-by: Christian Linke <christian.linke@bmw.de>
Diffstat (limited to 'include/command/IAmCommandReceive.h')
-rwxr-xr-xinclude/command/IAmCommandReceive.h220
1 files changed, 0 insertions, 220 deletions
diff --git a/include/command/IAmCommandReceive.h b/include/command/IAmCommandReceive.h
deleted file mode 100755
index 83ab577..0000000
--- a/include/command/IAmCommandReceive.h
+++ /dev/null
@@ -1,220 +0,0 @@
-/**
- * Copyright (C) 2012 - 2014, BMW AG
- *
- * This file is part of GENIVI Project AudioManager.
- *
- * Contributions are licensed to the GENIVI Alliance under one or more
- * Contribution License Agreements.
- *
- * \copyright
- * This Source Code Form is subject to the terms of the
- * Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with
- * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
- *
- *
- * \author Christian Linke, christian.linke@bmw.de BMW 2011 - 2014
- *
- * \file
- * For further information see http://projects.genivi.org/audio-manager
- *
- * THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL.
- * PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN.
- */
-#if !defined(EA_F12AFDAB_E710_43e4_8DC1_1035427769BE__INCLUDED_)
-#define EA_F12AFDAB_E710_43e4_8DC1_1035427769BE__INCLUDED_
-
-#include <vector>
-#include <string>
-#include "audiomanagertypes.h"
-namespace am {
-class CAmDbusWrapper;
-class CAmSocketHandler;
-}
-
-
-#include "audiomanagertypes.h"
-
-#define CommandReceiveVersion "3.0"
-namespace am {
-
-/**
- * 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:\n
- * \warning
- * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
- * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS
- * CALL THAT EXPECTS A RETURN VALUE.\n
- * \details
- * 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.\n
- * For more information, please check CAmSerializer
- */
-class IAmCommandReceive
-{
-
-public:
- IAmCommandReceive() {
-
- }
-
- virtual ~IAmCommandReceive() {
-
- }
-
- /**
- * This function returns the version of the interface.
- */
- virtual void getInterfaceVersion(std::string& version) const =0;
- /**
- * connects a source to sink
- * @return E_OK on success, E_NOT_POSSIBLE on failure, E_ALREADY_EXISTS if the
- * connection does already exists
- */
- virtual am_Error_e connect(const am_sourceID_t sourceID, const am_sinkID_t sinkID, am_mainConnectionID_t& mainConnectionID) =0;
- /**
- * disconnects a mainConnection
- * @return E_OK on successes, E_NON_EXISTENT if the connection does not exist,
- * E_NOT_POSSIBLE on error.
- */
- virtual am_Error_e disconnect(const am_mainConnectionID_t mainConnectionID) =0;
- /**
- * sets the volume for a sink
- * @return E_OK on success, E_UNKOWN on error, E_OUT_OF_RANGE in case the value is
- * out of range
- */
- virtual am_Error_e setVolume(const am_sinkID_t sinkID, const am_mainVolume_t volume) =0;
- /**
- * This function is used to increment or decrement the current volume for a sink.
- * @return E_OK on success, E_UNKNOWN on error and E_OUT_OF_RANGE if the value is
- * not in the given volume range.
- */
- virtual am_Error_e volumeStep(const am_sinkID_t sinkID, const int16_t volumeStep) =0;
- /**
- * sets the mute state of a sink
- * @return E_OK on success, E_UNKNOWN on error. If the mute state is already the
- * desired one, the Daemon will return E_OK.
- */
- virtual am_Error_e setSinkMuteState(const am_sinkID_t sinkID, const am_MuteState_e muteState) =0;
- /**
- * 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
- * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in
- * case of an error
- */
- 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. Equalizer Values. Since the
- * capabilities of the system can differ, the exact key value pairs can be
- * extended in each product
- * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in
- * case of an error
- */
- virtual am_Error_e setMainSourceSoundProperty(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID) =0;
- /**
- * 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;
- /**
- * returns the actual list of MainConnections
- * @return E_OK on success, E_DATABASE_ERROR on error
- */
- virtual am_Error_e getListMainConnections(std::vector<am_MainConnectionType_s>& listConnections) const =0;
- /**
- * returns the actual list of Sinks
- * @return E_OK on success, E_DATABASE_ERROR on error
- */
- virtual am_Error_e getListMainSinks(std::vector<am_SinkType_s>& listMainSinks) const =0;
- /**
- * returns the actual list of Sources
- * @return E_OK on success, E_DATABASE_ERROR on error
- */
- virtual am_Error_e getListMainSources(std::vector<am_SourceType_s>& listMainSources) const =0;
- /**
- * This is used to retrieve all source sound properties related to a source.
- * Returns a vector of the sound properties and values as pair
- * @return E_OK on success, E_DATABASE_ERROR on error
- */
- 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.
- * @return E_OK on success, E_DATABASE_ERROR on error
- */
- virtual am_Error_e getListMainSourceSoundProperties(const am_sourceID_t sourceID, std::vector<am_MainSoundProperty_s>& listSourceProperties) const =0;
- /**
- * This is used to retrieve SourceClass Information of all source classes
- * @return E_OK on success, E_DATABASE_ERROR on error
- */
- virtual am_Error_e getListSourceClasses(std::vector<am_SourceClass_s>& listSourceClasses) const =0;
- /**
- * This is used to retrieve SinkClass Information of all sink classes
- * @return E_OK on success, E_DATABASE_ERROR on error
- */
- virtual am_Error_e getListSinkClasses(std::vector<am_SinkClass_s>& listSinkClasses) const =0;
- /**
- * Retrieves a complete list of all systemProperties.
- * @return E_OK on success, E_DATABASE_ERROR on error
- */
- virtual am_Error_e getListSystemProperties(std::vector<am_SystemProperty_s>& listSystemProperties) const =0;
- /**
- * returns the delay in ms that the audiopath for the given mainConnection has
- * @return E_OK on success, E_NOT_POSSIBLE if timing information is not yet
- * retrieved, E_DATABASE_ERROR on read error on the database
- */
- virtual am_Error_e getTimingInformation(const am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay) const =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
- */
- virtual am_Error_e getDBusConnectionWrapper(CAmDbusWrapper*& dbusConnectionWrapper) const =0;
- /**
- * 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,
- */
- virtual am_Error_e getSocketHandler(CAmSocketHandler*& socketHandler) const =0;
- /**
- * asynchronous confirmation of setCommandReady.
- */
- virtual void confirmCommandReady(const uint16_t handle, const am_Error_e error) =0;
- /**
- * asynchronous confirmation of setCommandRundown
- */
- virtual void confirmCommandRundown(const uint16_t handle, const am_Error_e error) =0;
- /**
- * Retrieves the list of MainNotifications for a sink. Does not return the
- * possible ones.
- */
- 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 source. Does not return the
- * possible ones.
- */
- virtual am_Error_e getListMainSourceNotificationConfigurations(const am_sourceID_t sourceID, std::vector<am_NotificationConfiguration_s>& listMainNotificationConfigurations) const =0;
- /**
- * sets a MainNotificationConfiuration. This can be used to turn on an off
- * notifications an to change the mode of the configuration.
- * @return E_OK on success, E_NON_EXISTENT if sinkID does not exists,
- * E_DATABASE_ERROR on error
- */
- virtual am_Error_e setMainSinkNotificationConfiguration(const am_sinkID_t sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration) =0;
- /**
- * sets a MainNotificationConfiuration. This can be used to turn on an off
- * notifications an to change the mode of the configuration.
- * @return E_OK on success, E_NON_EXISTENT if sourceID does not exists,
- * E_DATABASE_ERROR on error
- */
- virtual am_Error_e setMainSourceNotificationConfiguration(const am_sourceID_t sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration) =0;
-
-};
-}
-#endif // !defined(EA_F12AFDAB_E710_43e4_8DC1_1035427769BE__INCLUDED_)