2 * Copyright (C) 2011, BMW AG
\r
4 * GeniviAudioMananger
\r
8 * \date 20-Oct-2011 3:42:04 PM
\r
9 * \author Christian Mueller (christian.ei.mueller@bmw.de)
\r
12 * GNU Lesser General Public License, version 2.1, with special exception (GENIVI clause)
\r
13 * Copyright (C) 2011, BMW AG Christian M?ller Christian.ei.mueller@bmw.de
\r
15 * This program is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License, version 2.1, as published by the Free Software Foundation.
\r
16 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License, version 2.1, for more details.
\r
17 * You should have received a copy of the GNU Lesser General Public License, version 2.1, along with this program; if not, see <http://www.gnu.org/licenses/lgpl-2.1.html>.
\r
18 * Note that the copyright holders assume that the GNU Lesser General Public License, version 2.1, may also be applicable to programs even in cases in which the program is not a library in the technical sense.
\r
19 * Linking AudioManager statically or dynamically with other modules is making a combined work based on AudioManager. You may license such other modules under the GNU Lesser General Public License, version 2.1. If you do not want to license your linked modules under the GNU Lesser General Public License, version 2.1, you may use the program under the following exception.
\r
20 * As a special exception, the copyright holders of AudioManager give you permission to combine AudioManager with software programs or libraries that are released under any license unless such a combination is not permitted by the license of such a software program or library. You may copy and distribute such a system following the terms of the GNU Lesser General Public License, version 2.1, including this special exception, for AudioManager and the licenses of the other code concerned.
\r
21 * Note that people who make modified versions of AudioManager are not obligated to grant this special exception for their modified versions; it is their choice whether to do so. The GNU Lesser General Public License, version 2.1, gives permission to release a modified version without this exception; this exception also makes it possible to release a modified version which carries forward this exception.
\r
23 * THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
\r
25 #if !defined(EA_F103F724_CE43_4c5d_A6E5_859230D16B1E__INCLUDED_)
\r
26 #define EA_F103F724_CE43_4c5d_A6E5_859230D16B1E__INCLUDED_
\r
30 #include "../audiomanagertypes.h"
\r
34 class SocketHandler;
\r
38 #define RoutingReceiveVersion 1
41 * Routing Receive sendInterface description. This class implements everything from RoutingAdapter -> Audiomanager
44 * @created 11-Jan-2012 9:54:30 PM
46 class RoutingReceiveInterface
51 * acknowledges a asyncConnect
55 * @param error E_OK on success, E_ABORTED if action was aborted, E_UNKNOWN on error
57 virtual void ackConnect(const am_Handle_s handle, const am_connectionID_t connectionID, const am_Error_e error) =0;
59 * acknowledges a asyncDisconnect
63 * @param error E_OK on success, E_ABORTED if action was aborted, E_UNKNOWN on error
65 virtual void ackDisconnect(const am_Handle_s handle, const am_connectionID_t connectionID, const am_Error_e error) =0;
67 * acknowledges a asyncsetSinkVolume
70 * @param volume The current actual value that is set
71 * @param error E_OK on success, E_ABORTED if action was aborted, E_UNKNOWN on error
73 virtual void ackSetSinkVolumeChange(const am_Handle_s handle, const am_volume_t volume, const am_Error_e error) =0;
75 * acknowledges a asyncsetSourceVolume
77 * @param handle handle that belongs to the change
78 * @param volume the current volume
79 * @param error E_OK on success, E_ABORTED if action was aborted, E_UNKNOWN on error
81 virtual void ackSetSourceVolumeChange(const am_Handle_s handle, const am_volume_t volume, const am_Error_e error) =0;
83 * acknowlegde for asyncSetSourceState
86 * @param error E_OK on success, E_ABORTED if action was aborted, E_UNKNOWN on error
88 virtual void ackSetSourceState(const am_Handle_s handle, const am_Error_e error) =0;
90 * acknowledges asyncSetSinkSoundProperties
93 * @param error E_OK on success, E_ABORTED if action was aborted, E_UNKNOWN on error
95 virtual void ackSetSinkSoundProperties(const am_Handle_s handle, const am_Error_e error) =0;
97 * acknowledges asyncSetSinkSoundProperty
100 * @param error E_OK on success, E_ABORTED if action was aborted, E_UNKNOWN on error
102 virtual void ackSetSinkSoundProperty(const am_Handle_s handle, const am_Error_e error) =0;
104 * acknowledges asyncSetSourceSoundProperties
107 * @param error E_OK on success, E_ABORTED if action was aborted, E_UNKNOWN on error
109 virtual void ackSetSourceSoundProperties(const am_Handle_s handle, const am_Error_e error) =0;
111 * acknowledges asyncSetSourceSoundProperty
114 * @param error E_OK on success, E_ABORTED if action was aborted, E_UNKNOWN on error
116 virtual void ackSetSourceSoundProperty(const am_Handle_s handle, const am_Error_e error) =0;
118 * acknowledges asyncCrossFade
121 * @param hotSink this is the current hot sink, HS_INTERMEDIATE is here when a crossfading action did not reach the end
122 * @param error E_OK on success, E_ABORTED if action was aborted, E_UNKNOWN on error
124 virtual void ackCrossFading(const am_Handle_s handle, const am_HotSink_e hotSink, const am_Error_e error) =0;
126 * acknowledges a volume tick. This can be used to display volumechanges during ramps
132 virtual void ackSourceVolumeTick(const am_Handle_s handle, const am_sourceID_t sourceID, const am_volume_t volume) =0;
134 * acknowledges a volume tick. This can be used to display volumechanges during ramps
140 virtual void ackSinkVolumeTick(const am_Handle_s handle, const am_sinkID_t sinkID, const am_volume_t volume) =0;
142 * This function returns the ID to the given domainName. If already a domain is registered with this name, it will return the corresponding ID, if not it will reserve an ID but not register the domain. The other parameters of the domain will be overwritten when the domain is registered.
\r
143 * @return E_OK on success, E_UNKNOWN on error
148 virtual am_Error_e peekDomain(const std::string& name, am_domainID_t& domainID) =0;
150 * registers a domain
\r
151 * @return E_OK on succes, E_ALREADY_EXISTENT if already registered E_UNKOWN on error
153 * @param domainData domainID in am_Domain_s must be 0!
156 virtual am_Error_e registerDomain(const am_Domain_s& domainData, am_domainID_t& domainID) =0;
158 * deregisters a domain. All sources, sinks, gateways and crossfaders from that domain will be removed as well.
\r
159 * @return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error
161 * @param domainID < the nonde of the bus
163 virtual am_Error_e deregisterDomain(const am_domainID_t domainID) =0;
165 * registers a gateway. @return E_OK on succes, E_ALREADY_EXISTENT if already registered E_UNKOWN on error
167 * @param gatewayData In a fixed setup, the gatewayID must be below 100. In a dynamic setup, the gatewayID shall be 0. listSourceFormats and listSinkFormats are empty at registration time. Values are taken over when sources and sinks are registered.
\r
172 virtual am_Error_e registerGateway(const am_Gateway_s& gatewayData, am_gatewayID_t& gatewayID) =0;
174 * deregisters a gateway. Also removes all sinks and sources of the controlling domain.
\r
175 * @return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error
177 * @param gatewayID domainID of the control domain
179 virtual am_Error_e deregisterGateway(const am_gatewayID_t gatewayID) =0;
181 * This function returns the ID to the given sinkName. If already a sink is registered with this name, it will return the corresponding ID, if not it will reserve an ID but not register the sink. The other parameters of the sink will be overwritten when the sink is registered.
\r
182 * @return E_OK on success, E_UNKNOWN on error
184 * @param name ID is not valid since not created yet
187 virtual am_Error_e peekSink(const std::string& name, am_sinkID_t& sinkID) =0;
189 * Registers a sink. If the sink is part of a gateway, the listconnectionFormats is copied to the gatewayInformation
\r
190 * @return E_OK on succes, E_ALREADY_EXISTENT if already registered E_UNKOWN on error
192 * @param sinkData In a fixed setup, the sinkID within am_Sink_s must be below 100. In a dynamic setup the sinkID must be 0 in am_Sink_s.
195 virtual am_Error_e registerSink(const am_Sink_s& sinkData, am_sinkID_t& sinkID) =0;
197 * deregisters a sink.
\r
198 * @return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error
202 virtual am_Error_e deregisterSink(const am_sinkID_t sinkID) =0;
204 * This function returns the ID to the given sourceName. If already a source is registered with this name, it will return the corresponding ID, if not it will reserve an ID but not register the source. The other parameters of the source will be overwritten when the source is registered.
\r
205 * @return E_OK on success, E_UNKNOWN on error
210 virtual am_Error_e peekSource(const std::string& name, am_sourceID_t& sourceID) =0;
212 * registers a source. If the source is part of a gateway, the listconnectionFormats is copied to the gatewayInformation
\r
213 * @return E_OK on success, E_UNKNOWN on error, E_ALREADY_EXIST if either name or sourceID already exists
215 * @param sourceData In a fixed setup, the sourceID within am_Source_s must be below 100. In a dynamic setup the sourceID must be 0 in am_Source_s
218 virtual am_Error_e registerSource(const am_Source_s& sourceData, am_sourceID_t& sourceID) =0;
220 * deregisters a source
\r
221 * @return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error
225 virtual am_Error_e deregisterSource(const am_sourceID_t sourceID) =0;
227 * this function registers a crossfader.
\r
228 * @return E_OK on succes, E_ALREADY_EXISTENT if already registered E_UNKOWN on error
230 * @param crossfaderData in a fixed setup, the crossfaderID must be below 100. In a dynamic setup the crossfasderID shall be 0
231 * @param crossfaderID
233 virtual am_Error_e registerCrossfader(const am_Crossfader_s& crossfaderData, am_crossfaderID_t& crossfaderID) =0;
235 * this function deregisters a crossfader. removes all sources and sinks assiated as well.
\r
236 * @return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error
238 * @param crossfaderID
240 virtual am_Error_e deregisterCrossfader(const am_crossfaderID_t crossfaderID) =0;
242 * this function peeks a sourceclassID. It is used by the RoutingPlugins to determine the SinkClassIDs of a sinkClass.
\r
243 * @return E_OK on succes, E_DATABASE_ERROR on error
246 * @param sourceClassID
248 virtual am_Error_e peekSourceClassID(const std::string name, const am_sourceClass_t& sourceClassID) =0;
250 * this function peeks a sourceclassID. It is used by the RoutingPlugins to determine the SinkClassIDs of a sinkClass.
\r
251 * @return E_OK on succes, E_DATABASE_ERROR on error
256 virtual am_Error_e peekSinkClassID(const std::string name, const am_sinkClass_t& sinkClassID) =0;
258 * is called when a low level interrupt changes it status.
261 * @param interruptState
263 virtual void hookInterruptStatusChange(const am_sourceID_t sourceID, const am_InterruptState_e interruptState) =0;
265 * This hook is called when all elements from a domain are registered.
\r
266 * Is used by the Controller to know when all expected domains are finally registered
270 virtual void hookDomainRegistrationComplete(const am_domainID_t domainID) =0;
272 * is called when a sink changes its availability
275 * @param availability
277 virtual void hookSinkAvailablityStatusChange(const am_sinkID_t sinkID, const am_Availability_s& availability) =0;
279 * is called when a source changes its availability
282 * @param availability
284 virtual void hookSourceAvailablityStatusChange(const am_sourceID_t sourceID, const am_Availability_s& availability) =0;
286 * is called when a domain changes its status. This used for early domains only
291 virtual void hookDomainStateChange(const am_domainID_t domainID, const am_DomainState_e domainState) =0;
293 * is called when the timinginformation (delay) changed for a connection.
295 * @param connectionID
298 virtual void hookTimingInformationChanged(const am_connectionID_t connectionID, const am_timeSync_t delay) =0;
300 * this function is used to send out all data that has been changed in an early state.
\r
301 * @return E_OK on success, E_UNKNOWN on error
305 virtual am_Error_e sendChangedData(const std::vector<am_EarlyData_s>& earlyData) =0;
307 * this function is used to retrieve a pointer to the dBusConnectionWrapper
\r
308 * @return E_OK if pointer is valid, E_UKNOWN if AudioManager was compiled without DBus Support
310 * @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)
312 virtual am_Error_e getDBusConnectionWrapper(DBusWrapper*& dbusConnectionWrapper) const =0;
314 * 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.
\r
315 * returns E_OK if pointer is valid, E_UNKNOWN in case AudioManager was compiled without socketHandler support,
317 * @param socketHandler
319 virtual am_Error_e getSocketHandler(SocketHandler*& socketHandler) const =0;
321 * This function returns the version of the interface
323 virtual uint16_t getInterfaceVersion() const =0;
327 #endif // !defined(EA_F103F724_CE43_4c5d_A6E5_859230D16B1E__INCLUDED_)