1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
|
/** Copyright (c) 2012 GENIVI Alliance
* Copyright (c) 2012 BMW
*
* @author Christian Mueller, BMW
*
* @copyright
* {
* Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction,
* including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
* The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
* THE USE OR OTHER DEALINGS IN THE SOFTWARE.
* }
*
*
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
#if !defined(EA_76AA566B_CDC8_4c91_A89E_BB68E32CC6D1__INCLUDED_)
#define EA_76AA566B_CDC8_4c91_A89E_BB68E32CC6D1__INCLUDED_
#include <vector>
#include <string>
#include "audiomanagertypes.h"
namespace am {
class DBusWrapper;
class SocketHandler;
}
#define CommandReceiveVersion "1.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<b>
* 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
* 2. YOU MAY NOT THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.</b>\n
* 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
* @author Christian Mueller
* @created 29-Feb-2012 12:54:29 PM
*/
class CommandReceiveInterface
{
public:
CommandReceiveInterface() {
}
virtual ~CommandReceiveInterface() {
}
/**
* connects a source to sink
* @return E_OK on success, E_NOT_POSSIBLE on failure, E_ALREADY_EXISTS if the connection does already exists
*
* @param sourceID
* @param sinkID
* @param mainConnectionID
*/
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.
*
* @param mainConnectionID
*/
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
*
* @param sinkID the sink
* @param volume the volume
*/
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.
*
* @param sinkID
* @param volumeStep indicated the number of steps that should be incremented or decremented. Positive values here inkrement, negative values decrement
*/
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.
*
* @param sinkID
* @param muteState
*/
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
*
* @param soundProperty
* @param sinkID
*/
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
*
* @param soundProperty
* @param sourceID
*/
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
*
* @param property the property that shall be set
*/
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
*
* @param listConnections returns a list of all connections
*/
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
*
* @param listMainSinks the list of the sinks
*/
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
*
* @param listMainSources the list of sources
*/
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
*
* @param sinkID
* @param listSoundProperties
*/
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
*
* @param sourceID
* @param listSourceProperties
*/
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
*
* @param listSourceClasses
*/
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
*
* @param listSinkClasses
*/
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
*
* @param listSystemProperties
*/
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
*
* @param mainConnectionID
* @param delay
*/
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
*
* @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(DBusWrapper*& 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,
*
* @param socketHandler
*/
virtual am_Error_e getSocketHandler(SocketHandler*& socketHandler) const =0;
/**
* This function returns the version of the interface.
*
* @param version
*/
virtual void getInterfaceVersion(std::string& version) const =0;
/**
* asynchronous confirmation of setCommandReady.
*
* @param handle the handle that was handed over by setCommandReady
*/
virtual void confirmCommandReady(const uint16_t handle) =0;
/**
* asynchronous confirmation of setCommandRundown
*
* @param handle the handle that was given via setCommandRundown
*/
virtual void confirmCommandRundown(const uint16_t handle) =0;
};
}
#endif // !defined(EA_76AA566B_CDC8_4c91_A89E_BB68E32CC6D1__INCLUDED_)
|
