summaryrefslogtreecommitdiff
path: root/include/command/IAmCommandSend.h
blob: ce32131dcab4c0bbc99249eba69230a632bb848e (plain)
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
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
/**
 * Copyright (C) 2012, 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 Mueller, christian.linke@bmw.de BMW 2011,2012
 *
 * \file
 * For further information see http://www.genivi.org/.
 *
 * THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
 */
#if !defined(EA_B053C89D_3921_4e1a_836D_C3B98FAD2E36__INCLUDED_)
#define EA_B053C89D_3921_4e1a_836D_C3B98FAD2E36__INCLUDED_

#include <vector>
#include <string>
#include "audiomanagertypes.h"

namespace am {
class IAmCommandReceive;
}

#include "IAmCommandReceive.h"
#include "audiomanagertypes.h"

#define CommandSendVersion "2.0" 
namespace am {
	/**
	 * This interface handles all communication from the AudioManagerDaemon towards the system. It is designed in such a way
	 * that only callbacks with no return types are implemented. So when the CommandInterfacePlugins are designed in such a
	 * way that they broadcast signals to any node who is interested in the particular information (like signals on Dbus for
	 * example), more information can be retrieved via the CommandReceiveInterface.
	 * 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
	 * @author Christian Mueller
	 * @created 16-Dez-2012 15:58:14
	 */
	class IAmCommandSend
	{

	public:
		IAmCommandSend() {

		}

		virtual ~IAmCommandSend() {

		}

		/**
		 * returns the interface version as string.
		 * 
		 * @param version
		 */
		virtual void getInterfaceVersion(std::string& version) const =0;
		/**
		 * This command starts the interface, the plugin itself. This is not meant to start communication with the HMI itself. It
		 * is a good idea to implement here everything that sets up the basic communication like DbusCommunication etc...
		 * Be aware of side effects with systemd and socketbased communication!
		 * @return E_OK on success, E_UNKNOWN on error
		 * 
		 * @param commandreceiveinterface    pointer to the receive interface. Is used to call the audiomanagerdaemon
		 */
		virtual am_Error_e startupInterface(IAmCommandReceive* commandreceiveinterface) =0;
		/**
		 * This function will indirectly be called by the Controller and is used to start the Communication. Before this command,
		 * all communication will be ignored by the AudioManager.
		 * After the Plugin is ready, it will asynchronously answer with condfirmCommandReady, the handle that is handed over must
		 * be returned.
		 * 
		 * @param handle    the handle uniquely idenfies the request
		 */
		virtual void setCommandReady(const uint16_t handle) =0;
		/**
		 * This function will indirectly be called by the Controller and is used to stop the Communication. After this command,
		 * all communication will be ignored by the AudioManager. The plugin has to be prepared that either the power will be
		 * switched off or the Interface is started again with setCommandReady
		 * After the Plugin is ready to rundown, it will asynchronously answer with condfirmCommandRundown, the handle that is
		 * handed over must be returned.
		 * 
		 * @param handle    This handle uniquly idenfies the request
		 */
		virtual void setCommandRundown(const uint16_t handle) =0;
		/**
		 * Callback that is called when the number of connections change
		 * 
		 * @param mainConnection
		 */
		virtual void cbNewMainConnection(const am_MainConnectionType_s& mainConnection) =0;
		/**
		 * Callback that is called when the number of connections change
		 * 
		 * @param mainConnection
		 */
		virtual void cbRemovedMainConnection(const am_mainConnectionID_t mainConnection) =0;
		/**
		 * Callback that is called when the number of sinks change
		 * 
		 * @param sink
		 */
		virtual void cbNewSink(const am_SinkType_s& sink) =0;
		/**
		 * Callback that is called when the number of sinks change
		 * 
		 * @param sinkID
		 */
		virtual void cbRemovedSink(const am_sinkID_t sinkID) =0;
		/**
		 * Callback that is called when the number of sources change
		 * 
		 * @param source
		 */
		virtual void cbNewSource(const am_SourceType_s& source) =0;
		/**
		 * Callback that is called when the number of sources change
		 * 
		 * @param source
		 */
		virtual void cbRemovedSource(const am_sourceID_t source) =0;
		/**
		 * this callback is fired if the number of sink classes changed
		 */
		virtual void cbNumberOfSinkClassesChanged() =0;
		/**
		 * this callback is fired if the number of source classes changed
		 */
		virtual void cbNumberOfSourceClassesChanged() =0;
		/**
		 * This callback is called when the ConnectionState of a connection changed.
		 * 
		 * @param connectionID
		 * @param connectionState
		 */
		virtual void cbMainConnectionStateChanged(const am_mainConnectionID_t connectionID, const am_ConnectionState_e connectionState) =0;
		/**
		 * this callback indicates that a sinkSoundProperty has changed.
		 * 
		 * @param sinkID
		 * @param soundProperty
		 */
		virtual void cbMainSinkSoundPropertyChanged(const am_sinkID_t sinkID, const am_MainSoundProperty_s& soundProperty) =0;
		/**
		 * this callback indicates that a sourceSoundProperty has changed.
		 * 
		 * @param sourceID
		 * @param soundProperty
		 */
		virtual void cbMainSourceSoundPropertyChanged(const am_sourceID_t sourceID, const am_MainSoundProperty_s& soundProperty) =0;
		/**
		 * this callback is called when the availability of a sink has changed
		 * 
		 * @param sinkID
		 * @param availability
		 */
		virtual void cbSinkAvailabilityChanged(const am_sinkID_t sinkID, const am_Availability_s& availability) =0;
		/**
		 * this callback is called when the availability of source has changed.
		 * 
		 * @param sourceID
		 * @param availability
		 */
		virtual void cbSourceAvailabilityChanged(const am_sourceID_t sourceID, const am_Availability_s& availability) =0;
		/**
		 * this callback indicates a volume change on the indicated sink
		 * 
		 * @param sinkID
		 * @param volume
		 */
		virtual void cbVolumeChanged(const am_sinkID_t sinkID, const am_mainVolume_t volume) =0;
		/**
		 * this callback indicates a mute state change on a sink.
		 * 
		 * @param sinkID
		 * @param muteState
		 */
		virtual void cbSinkMuteStateChanged(const am_sinkID_t sinkID, const am_MuteState_e muteState) =0;
		/**
		 * is fired if a systemProperty changed
		 * 
		 * @param systemProperty
		 */
		virtual void cbSystemPropertyChanged(const am_SystemProperty_s& systemProperty) =0;
		/**
		 * This callback is fired if the timinginformation for a mainConnectionID changed
		 * 
		 * @param mainConnectionID
		 * @param time
		 */
		virtual void cbTimingInformationChanged(const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time) =0;
		/**
		 * This callback is called when a sink is updated.
		 * 
		 * @param sinkID    The sinkID that is updated
		 * @param sinkClassID    The sinkClassID of the updated sink. gives the current value even if not updated
		 * @param listMainSoundProperties    The list of mainSoundProperties. Gives the actual list of MainSoundProperties even if
		 * not changed
		 */
		virtual void cbSinkUpdated(const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties) =0;
		/**
		 * This callback is called when a source is updated.
		 * 
		 * @param sourceID    The sourceID that is updated
		 * @param sourceClassID    The sourceClassID of the updated source. Gives the current value even if not updated
		 * @param listMainSoundProperties    The list of mainSoundProperties. Gives the actual list of MainSoundProperties even if
		 * not changed
		 */
		virtual void cbSourceUpdated(const am_sourceID_t sourceID, const am_sourceClass_t sourceClassID, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties) =0;
		/**
		 * This callback is called when a notifcated value of a sink changes.
		 * 
		 * @param sinkID    The sinkID
		 * @param notification    The payload of the notification
		 */
		virtual void cbSinkNotification(const am_sinkID_t sinkID, const am_NotificationPayload_s notification) =0;
		/**
		 * This callback is called when a notifcated value of a source changes.
		 * 
		 * @param sourceID    The sourceID
		 * @param notification    The payload of the notification
		 */
		virtual void cbSourceNotification(const am_sourceID_t sourceID, const am_NotificationPayload_s notification) =0;
		/**
		 * This callback is triggered when a mainNotificationConfiguration is changed.
		 * 
		 * @param sinkID
		 * @param mainNotificationConfiguration    The MainNotificationConfiguration that changed
		 */
		virtual void cbSinkMainNotificationConfigurationChanged(const am_sinkID_t sinkID, const am_NotificationConfiguration_s mainNotificationConfiguration) =0;
		/**
		 * This callback is triggered when a mainNotificationConfiguration is changed.
		 * 
		 * @param sourceID
		 * @param mainNotificationConfiguration    The MainNotificationConfiguration that changed
		 */
		virtual void cbSourceMainNotificationConfigurationChanged(const am_sourceID_t sourceID, const am_NotificationConfiguration_s mainNotificationConfiguration) =0;

	};
}
#endif // !defined(EA_B053C89D_3921_4e1a_836D_C3B98FAD2E36__INCLUDED_)