2 * Copyright (C) 2012 - 2014, BMW AG
4 * This file is part of GENIVI Project AudioManager.
6 * Contributions are licensed to the GENIVI Alliance under one or more
7 * Contribution License Agreements.
10 * This Source Code Form is subject to the terms of the
11 * Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with
12 * this file, You can obtain one at http://mozilla.org/MPL/2.0/.
15 * \author Christian Linke, christian.linke@bmw.de BMW 2011 - 2014
18 * For further information see http://projects.genivi.org/audio-manager
20 * THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL.
21 * PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN.
23 #if !defined(EA_833F8CB5_893B_4670_B004_4A31D1707950__INCLUDED_)
24 #define EA_833F8CB5_893B_4670_B004_4A31D1707950__INCLUDED_
28 #include "audiomanagertypes.h"
31 class CAmSocketHandler;
35 #include "audiomanagertypes.h"
37 #define CommandReceiveVersion "3.0"
41 * The interface towards the Controlling Instance (e.g HMI). It handles the
42 * communication towards the HMI and other system components who need to interact
43 * with the audiomanagement.
44 * There are two rules that have to be kept in mind when implementing against this
47 * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
48 * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS
49 * CALL THAT EXPECTS A RETURN VALUE.\n
51 * Violation these rules may lead to unexpected behavior! Nevertheless you can
52 * implement thread safe by using the deferred-call pattern described on the wiki
53 * which also helps to implement calls that are forbidden.\n
54 * For more information, please check CAmSerializer
56 class IAmCommandReceive
64 virtual ~IAmCommandReceive() {
69 * This function returns the version of the interface.
71 virtual void getInterfaceVersion(std::string& version) const =0;
73 * connects a source to sink
74 * @return E_OK on success, E_NOT_POSSIBLE on failure, E_ALREADY_EXISTS if the
75 * connection does already exists
77 virtual am_Error_e connect(const am_sourceID_t sourceID, const am_sinkID_t sinkID, am_mainConnectionID_t& mainConnectionID) =0;
79 * disconnects a mainConnection
80 * @return E_OK on successes, E_NON_EXISTENT if the connection does not exist,
81 * E_NOT_POSSIBLE on error.
83 virtual am_Error_e disconnect(const am_mainConnectionID_t mainConnectionID) =0;
85 * sets the volume for a sink
86 * @return E_OK on success, E_UNKOWN on error, E_OUT_OF_RANGE in case the value is
89 virtual am_Error_e setVolume(const am_sinkID_t sinkID, const am_mainVolume_t volume) =0;
91 * This function is used to increment or decrement the current volume for a sink.
92 * @return E_OK on success, E_UNKNOWN on error and E_OUT_OF_RANGE if the value is
93 * not in the given volume range.
95 virtual am_Error_e volumeStep(const am_sinkID_t sinkID, const int16_t volumeStep) =0;
97 * sets the mute state of a sink
98 * @return E_OK on success, E_UNKNOWN on error. If the mute state is already the
99 * desired one, the Daemon will return E_OK.
101 virtual am_Error_e setSinkMuteState(const am_sinkID_t sinkID, const am_MuteState_e muteState) =0;
103 * This method is used to set sound properties, e.g. Equalizer Values. Since the
104 * capabilities of the system can differ, the exact key value pairs can be
105 * extended in each product
106 * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in
109 virtual am_Error_e setMainSinkSoundProperty(const am_MainSoundProperty_s& soundProperty, const am_sinkID_t sinkID) =0;
111 * This method is used to set sound properties, e.g. Equalizer Values. Since the
112 * capabilities of the system can differ, the exact key value pairs can be
113 * extended in each product
114 * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in
117 virtual am_Error_e setMainSourceSoundProperty(const am_MainSoundProperty_s& soundProperty, const am_sourceID_t sourceID) =0;
119 * is used to set a specific system property.
120 * @return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in
123 virtual am_Error_e setSystemProperty(const am_SystemProperty_s& property) =0;
125 * returns the actual list of MainConnections
126 * @return E_OK on success, E_DATABASE_ERROR on error
128 virtual am_Error_e getListMainConnections(std::vector<am_MainConnectionType_s>& listConnections) const =0;
130 * returns the actual list of Sinks
131 * @return E_OK on success, E_DATABASE_ERROR on error
133 virtual am_Error_e getListMainSinks(std::vector<am_SinkType_s>& listMainSinks) const =0;
135 * returns the actual list of Sources
136 * @return E_OK on success, E_DATABASE_ERROR on error
138 virtual am_Error_e getListMainSources(std::vector<am_SourceType_s>& listMainSources) const =0;
140 * This is used to retrieve all source sound properties related to a source.
141 * Returns a vector of the sound properties and values as pair
142 * @return E_OK on success, E_DATABASE_ERROR on error
144 virtual am_Error_e getListMainSinkSoundProperties(const am_sinkID_t sinkID, std::vector<am_MainSoundProperty_s>& listSoundProperties) const =0;
146 * This is used to retrieve all source sound properties related to a source.
147 * @return E_OK on success, E_DATABASE_ERROR on error
149 virtual am_Error_e getListMainSourceSoundProperties(const am_sourceID_t sourceID, std::vector<am_MainSoundProperty_s>& listSourceProperties) const =0;
151 * This is used to retrieve SourceClass Information of all source classes
152 * @return E_OK on success, E_DATABASE_ERROR on error
154 virtual am_Error_e getListSourceClasses(std::vector<am_SourceClass_s>& listSourceClasses) const =0;
156 * This is used to retrieve SinkClass Information of all sink classes
157 * @return E_OK on success, E_DATABASE_ERROR on error
159 virtual am_Error_e getListSinkClasses(std::vector<am_SinkClass_s>& listSinkClasses) const =0;
161 * Retrieves a complete list of all systemProperties.
162 * @return E_OK on success, E_DATABASE_ERROR on error
164 virtual am_Error_e getListSystemProperties(std::vector<am_SystemProperty_s>& listSystemProperties) const =0;
166 * returns the delay in ms that the audiopath for the given mainConnection has
167 * @return E_OK on success, E_NOT_POSSIBLE if timing information is not yet
168 * retrieved, E_DATABASE_ERROR on read error on the database
170 virtual am_Error_e getTimingInformation(const am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay) const =0;
172 * this function is used to retrieve a pointer to the dBusConnectionWrapper
173 * @return E_OK if pointer is valid, E_UKNOWN if AudioManager was compiled without
176 virtual am_Error_e getDBusConnectionWrapper(CAmDbusWrapper*& dbusConnectionWrapper) const =0;
178 * This function returns the pointer to the socketHandler. This can be used to
179 * integrate socket-based activites like communication with the mainloop of the
181 * returns E_OK if pointer is valid, E_UNKNOWN in case AudioManager was compiled
182 * without socketHandler support,
184 virtual am_Error_e getSocketHandler(CAmSocketHandler*& socketHandler) const =0;
186 * asynchronous confirmation of setCommandReady.
188 virtual void confirmCommandReady(const uint16_t handle, const am_Error_e error) =0;
190 * asynchronous confirmation of setCommandRundown
192 virtual void confirmCommandRundown(const uint16_t handle, const am_Error_e error) =0;
194 * Retrieves the list of MainNotifications for a sink. Does not return the
197 virtual am_Error_e getListMainSinkNotificationConfigurations(const am_sinkID_t sinkID, std::vector<am_NotificationConfiguration_s>& listMainNotificationConfigurations) const =0;
199 * Retrieves the list of MainNotifications for a source. Does not return the
202 virtual am_Error_e getListMainSourceNotificationConfigurations(const am_sourceID_t sourceID, std::vector<am_NotificationConfiguration_s>& listMainNotificationConfigurations) const =0;
204 * sets a MainNotificationConfiuration. This can be used to turn on an off
205 * notifications an to change the mode of the configuration.
206 * @return E_OK on success, E_NON_EXISTENT if sinkID does not exists,
207 * E_DATABASE_ERROR on error
209 virtual am_Error_e setMainSinkNotificationConfiguration(const am_sinkID_t sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration) =0;
211 * sets a MainNotificationConfiuration. This can be used to turn on an off
212 * notifications an to change the mode of the configuration.
213 * @return E_OK on success, E_NON_EXISTENT if sourceID does not exists,
214 * E_DATABASE_ERROR on error
216 virtual am_Error_e setMainSourceNotificationConfiguration(const am_sourceID_t sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration) =0;
220 #endif // !defined(EA_833F8CB5_893B_4670_B004_4A31D1707950__INCLUDED_)