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
|
/**
* Copyright (C) 2011, BMW AG
*
* GeniviAudioMananger
*
* \file
*
* \date 20-Oct-2011 3:42:04 PM
* \author Christian Mueller (christian.ei.mueller@bmw.de)
*
* \section License
* GNU Lesser General Public License, version 2.1, with special exception (GENIVI clause)
* Copyright (C) 2011, BMW AG Christian Mueller Christian.ei.mueller@bmw.de
*
* 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.
* 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.
* 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>.
* 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.
* 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.
* 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.
* 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.
*
* THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL. PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN
*/
#if !defined(EA_A230EB7E_1719_4470_BCC6_12B0606A80E6__INCLUDED_)
#define EA_A230EB7E_1719_4470_BCC6_12B0606A80E6__INCLUDED_
#include <vector>
#include <string>
#include "audiomanagertypes.h"
namespace am {
class CommandReceiveInterface;
}
#include "CommandReceiveInterface.h"
#define CommandSendVersion 1.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:
* 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!!
* 2. YOU MAY NOT THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.
* 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.
* @author Christian Mueller
* @created 21-Feb-2012 4:58:36 PM
*/
class CommandSendInterface
{
public:
CommandSendInterface() {
}
virtual ~CommandSendInterface() {
}
/**
* 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...
* @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(CommandReceiveInterface* commandreceiveinterface) =0;
/**
* This command stops the interface before the plugin is unloaded.
* @return E_OK on success, E_UNKNOWN on error
*/
virtual am_Error_e stopInterface() =0;
/**
* This callback is fired when the Interface is ready to be used. Before this command, all communication will be ignored by the Audiomanager
*/
virtual am_Error_e cbCommunicationReady() =0;
/**
* This callback is fired when the AudioManager is about to rundown. After this command no more action will be carried out by the AudioManager.
*/
virtual am_Error_e cbCommunicationRundown() =0;
/**
* Callback that is called when the number of connections change
*/
virtual void cbNumberOfMainConnectionsChanged() =0;
/**
* Callback that is called when the number of sinks change
*/
virtual void cbNumberOfSinksChanged() =0;
/**
* Callback that is called when the number of sources change
*/
virtual void cbNumberOfSourcesChanged() =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;
/**
* CommandReceiveVer_0.0.9.
*
* @param mainConnectionID
* @param time
*/
virtual void cbTimingInformationChanged(const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time) =0;
/**
* This function returns the version of the interface
* returns E_OK, E_UNKOWN if version is unknown.
*/
virtual uint16_t getInterfaceVersion() const =0;
};
}
#endif // !defined(EA_A230EB7E_1719_4470_BCC6_12B0606A80E6__INCLUDED_)
|
