summaryrefslogtreecommitdiff
path: root/PluginCommandInterfaceCAPI/fidl
diff options
context:
space:
mode:
authorChristian Linke <christian.linke@bmw.de>2013-09-09 18:40:19 +0200
committerChristian Linke <christian.linke@bmw.de>2013-09-09 18:40:19 +0200
commitdb8583483517265e9d6b0fdb3add2cad2cdbcca9 (patch)
tree5bcc78fc3ab73e04e1a6d7f37914334709ea2c65 /PluginCommandInterfaceCAPI/fidl
parent67b6d070bdea90463aab419d516186f498ebc6d6 (diff)
downloadaudiomanager-db8583483517265e9d6b0fdb3add2cad2cdbcca9.tar.gz
* some naming adoptions & review for GENIVI
Signed-off-by: Christian Linke <christian.linke@bmw.de>
Diffstat (limited to 'PluginCommandInterfaceCAPI/fidl')
-rw-r--r--PluginCommandInterfaceCAPI/fidl/CommandInterface.fdepl6
-rw-r--r--[-rwxr-xr-x]PluginCommandInterfaceCAPI/fidl/CommandInterface.fidl1328
-rwxr-xr-xPluginCommandInterfaceCAPI/fidl/amTypes.fidl329
3 files changed, 605 insertions, 1058 deletions
diff --git a/PluginCommandInterfaceCAPI/fidl/CommandInterface.fdepl b/PluginCommandInterfaceCAPI/fidl/CommandInterface.fdepl
deleted file mode 100644
index b500f07..0000000
--- a/PluginCommandInterfaceCAPI/fidl/CommandInterface.fdepl
+++ /dev/null
@@ -1,6 +0,0 @@
-import "CommandInterface.fidl"
-import "platform:/plugin/org.genivi.commonapi.dbus/deployment/deployment.fdepl"
-
-define org.genivi.commonapi.dbus.deployment.deployment for interface org.genivi.am.CommandInterface {
- DefaultEnumBackingType=Int16
-} \ No newline at end of file
diff --git a/PluginCommandInterfaceCAPI/fidl/CommandInterface.fidl b/PluginCommandInterfaceCAPI/fidl/CommandInterface.fidl
index 8f1a220..0d752d6 100755..100644
--- a/PluginCommandInterfaceCAPI/fidl/CommandInterface.fidl
+++ b/PluginCommandInterfaceCAPI/fidl/CommandInterface.fidl
@@ -1,723 +1,605 @@
-package org.genivi.audiomanager
-
-import org.genivi.audiomanager.am.* from "amTypes.fidl"
-
-<**
- @author : J�rgen Gehring
-
- @description : CommandInterface AudioManager.
-
- @details : Source D-Bus specification org.genivi.audiomanager.CommandInterface
-
-**>
-
-interface CommandInterface {
- version {
- major 0
- minor 1
- }
- method Connect {
- in {
- am_sourceID_t sourceID
- am_sinkID_t sinkID
- }
- out {
- am_Error_e result
- am_mainConnectionID_t mainConnectionID
- }
- }
- method Disconnect {
- in {
- am_mainConnectionID_t mainConnectionID
- }
- out {
- am_Error_e result
- }
- }
- method SetVolume {
- in {
- am_sinkID_t sinkID
- am_mainVolume_t volume
- }
- out {
- am_Error_e result
- }
- }
- method VolumeStep {
- in {
- am_sinkID_t sinkID
- am_mainVolume_t volumeStep
- }
- out {
- am_Error_e result
- }
- }
- method SetSinkMuteState {
- in {
- am_sinkID_t sinkID
- am_MuteState_e muteState
- }
- out {
- am_Error_e result
- }
- }
- method SetMainSinkSoundProperty {
- in {
- am_sinkID_t sinkID
- am_MainSoundProperty_s soundProperty
- }
- out {
- am_Error_e result
- }
- }
- method SetMainSourceSoundProperty {
- in {
- am_sourceID_t sourceID
- am_MainSoundProperty_s soundProperty
- }
- out {
- am_Error_e result
- }
- }
- method SetSystemProperty {
- in {
- am_SystemProperty_s soundProperty
- }
- out {
- am_Error_e result
- }
- }
- method GetListMainConnections {
- out {
- am_Error_e result
- am_MainConnectionType_l listConnections
- }
- }
- method GetListMainSinks {
- out {
- am_Error_e result
- am_SinkType_l listMainSinks
- }
- }
- method GetListMainSources {
- out {
- am_Error_e result
- am_SourceType_l listMainSources
- }
- }
- method GetListMainSinkSoundProperties {
- in {
- am_sinkID_t sinkID
- }
- out {
- am_Error_e result
- am_MainSoundProperty_l listSoundProperties
- }
- }
- method GetListMainSourceSoundProperties {
- in {
- am_sourceID_t sourceID
- }
- out {
- am_Error_e result
- am_MainSoundProperty_l listSourceProperties
- }
- }
- method GetListSourceClasses {
- out {
- am_Error_e result
- am_SourceClass_l listSourceClasses
- }
- }
- method GetListSinkClasses {
- out {
- am_Error_e result
- am_SinkClass_l listSinkClasses
- }
- }
- method GetListSystemProperties {
- out {
- am_Error_e result
- am_SystemProperty_l listSystemProperties
- }
- }
- method GetTimingInformation {
- in {
- am_mainConnectionID_t mainConnectionID
- }
- out {
- am_Error_e result
- am_timeSync_t delay
- }
- }
- broadcast NumberOfMainConnectionsChanged {
- }
- broadcast MainConnectionStateChanged {
- out {
- am_mainConnectionID_t connectionID
- am_ConnectionState_e connectionState
- }
- }
- broadcast NumberOfSourceClassesChanged {
- }
- broadcast SourceAdded {
- out {
- am_SourceType_s newSource
- }
- }
- broadcast SourceRemoved {
- out {
- am_sourceID_t removedSourceID
- }
- }
- broadcast MainSourceSoundPropertyChanged {
- out {
- am_sourceID_t sourceID
- am_MainSoundProperty_s SoundProperty
- }
- }
- broadcast SourceAvailabilityChanged {
- out {
- am_sourceID_t sourceID
- am_Availability_s availability
- }
- }
- broadcast NumberOfSinkClassesChanged {
- }
- broadcast SinkAdded {
- out {
- am_SinkType_s newSink
- }
- }
- broadcast SinkRemoved {
- out {
- am_sinkID_t removedSinkID
- }
- }
- broadcast MainSinkSoundPropertyChanged {
- out {
- am_sinkID_t sinkID
- am_MainSoundProperty_s SoundProperty
- }
- }
- broadcast SinkAvailabilityChanged {
- out {
- am_sinkID_t sinkID
- am_Availability_s availability
- }
- }
- broadcast VolumeChanged {
- out {
- am_sinkID_t sinkID
- am_mainVolume_t volume
- }
- }
- broadcast SinkMuteStateChanged {
- out {
- am_sinkID_t sinkID
- am_MuteState_e muteState
- }
- }
- broadcast SystemPropertyChanged {
- out {
- am_SystemProperty_s SystemProperty
- }
- }
- broadcast TimingInformationChanged {
- out {
- am_mainConnectionID_t mainConnection
- am_timeSync_t time
- }
- }
-
- broadcast SinkUpdated{
- out{
- am_sinkID_t sinkID
- am_sinkClass_t sinkClassID
- am_MainSoundProperty_l listMainSoundProperties
- }
- }
-
- broadcast SourceUpdated{
- out{
- am_sourceID_t sourceID
- am_sourceClass_t sourceClassID
- am_MainSoundProperty_l listMainSoundProperties
- }
- }
-
- broadcast SinkNotification{
- out{
- am_sinkID_t sinkID
- am_NotificationPayload_s notification
- }
- }
-
- broadcast SourceNotification{
- out{
- am_sourceID_t sourceID
- am_NotificationPayload_s notification
- }
- }
-
- broadcast MainSinkNotificationConfigurationChanged{
- out{
- am_sinkID_t sinkID
- am_NotificationConfiguration_s mainNotificationConfiguration
- }
- }
-
- broadcast MainSourceNotificationConfigurationChanged{
- out{
- am_sourceID_t sourceID
- am_NotificationConfiguration_s mainNotificationConfiguration
- }
- }
-
- typedef am_sourceID_t is UInt16
-
- typedef am_sinkID_t is UInt16
-
- typedef am_mainConnectionID_t is UInt16
-
- typedef am_timeSync_t is Int16
-
- typedef am_mainVolume_t is Int16
-
- typedef am_sourceClass_t is UInt16
-
- typedef am_sinkClass_t is UInt16
-
- <**
- @description : The errors of the audiomanager. All possible errors are in here. This enum is used widely as return parameter.
- **>
- enumeration am_Error_e {
-
- //E_UNKNOWN = "0x00"
-
- <**
- @description : no error - positive reply
- **>
- E_OK = "0x00"
-
- <**
- @description : value out of range
- **>
- E_OUT_OF_RANGE = "0x01"
-
- <**
- @description : not used
- **>
- E_NOT_USED = "0x02"
-
- <**
- @description : a database error occurred
- **>
- E_DATABASE_ERROR = "0x03"
-
- <**
- @description : the desired object already exists
- **>
- E_ALREADY_EXISTS = "0x04"
-
- <**
- @description : there is no change
- **>
- E_NO_CHANGE = "0x05"
-
- <**
- @description : the desired action is not possible
- **>
- E_NOT_POSSIBLE = "0x06"
-
- <**
- @description : the desired object is non existent
- **>
- E_NON_EXISTENT = "0x07"
-
- <**
- @description : the asynchronous action was aborted
- **>
- E_ABORTED = "0x08"
-
- <**
- @description : This error is returned in case a connect is issued with a connectionFormat
- that cannot be selected for the connection. This could be either due to the capabilities of
- a source or a sink or gateway compatibilities for example
- **>
- E_WRONG_FORMAT = "0x09"
- E_MAX = "0xA"
- }
-
- enumeration am_MuteState_e {
-
- <**
- @description : default
- **>
- MS_UNKNOWN = "0x00"
-
- <**
- @description : the source / sink is muted
- **>
- MS_MUTED = "0x01"
-
- <**
- @description : the source / sink is unmuted
- **>
- MS_UNMUTED = "0x02"
- MS_MAX = "0x03"
- }
-
- enumeration am_MainSoundPropertyType_e {
-
- <**
- @description : default
- **>
- MSP_UNKNOWN = "0x00"
-
- <**
- @description : example value between -10 and +10
- **>
- MSP_EXAMPLE_TREBLE = "0x01"
-
- <**
- @description : example value between -10 and +10
- **>
- MSP_EXAMPLE_MID = "0x02"
-
- <**
- @description : example value between -10 and +10
- **>
- MSP_EXAMPLE_BASS = "0x03"
- MSP_SOURCE_TYPE = "0x04"
- MSP_MAX = "0x05"
- }
-
- enumeration am_SystemPropertyType_e {
-
- <**
- @description : default
- **>
- SYP_UNKNOWN = "0x00"
- SYP_MAX = "0x01"
- }
-
- enumeration am_ConnectionState_e {
- CS_UNKNOWN = "0x00"
-
- <**
- @description : This means the connection is just building up
- **>
- CS_CONNECTING = "0x01"
-
- <**
- @description : the connection is ready to be used
- **>
- CS_CONNECTED = "0x02"
-
- <**
- @description : the connection is in the course to be knocked down
- **>
- CS_DISCONNECTING = "0x03"
-
- <**
- @description : only relevant for connectionStatechanged. Is send after the connection was removed
- **>
- CS_DISCONNECTED = "0x04"
-
- <**
- @description : this means the connection is still build up but unused at the moment
- **>
- CS_SUSPENDED = "0x05"
- CS_MAX = "0x06"
- }
-
- enumeration am_Availablility_e {
-
- <**
- @description : default
- **>
- A_UNKNOWN = "0x00"
-
- <**
- @description : The source / sink is available
- **>
- A_AVAILABLE = "0x01"
-
- <**
- @description : the source / sink is not available
- **>
- A_UNAVAILABLE = "0x02"
- A_MAX = "0x03"
- }
-
- enumeration am_AvailabilityReason_e {
-
- <**
- @description : default
- **>
- AR_UNKNOWN = "0x00"
-
- <**
- @description : the availability changed because an new media was entered.
- **>
- AR_GENIVI_NEWMEDIA = "0x01"
-
- <**
- @description : the availability changed because the same media was entered.
- **>
- AR_GENIVI_SAMEMEDIA = "0x02"
-
- <**
- @description : the availability changed because there is no media.
- **>
- AR_GENIVI_NOMEDIA = "0x03"
-
- <**
- @description : the availability changed because of a temperature event.
- **>
- AR_GENIVI_TEMPERATURE = "0x04"
-
- <**
- @description : the availability changed because of a voltage event.
- **>
- AR_GENIVI_VOLTAGE = "0x05"
-
- <**
- @description : the availability changed because of fatal errors reading or accessing media.
- **>
- AR_GENIVI_ERRORMEDIA = "0x06"
- AR_MAX = "0x07"
- }
-
- enumeration am_ClassProperty_e {
-
- <**
- @description : default
- **>
- CP_UNKNOWN = "0x00"
-
- <**
- @description : defines the source type of a source. Project specific, could be for example differentiation between interrupt source and main source.
- **>
- CP_GENIVI_SOURCE_TYPE = "0x01"
- /**
- * defines the SINK_TYPE. Project specific
- */
- <**
- @description : defines the SINK_TYPE. Project specific.
- **>
- CP_GENIVI_SINK_TYPE = "0x02"
- CP_MAX = "0x03"
- }
-
- enumeration am_InterruptState_e
- {
- /**
- * default
- */
- IS_UNKNOWN = "0x00"
- /**
- * the interrupt state is off - no interrupt
- */
- IS_OFF = "0x01"
- /**
- * the interrupt state is interrupted - the interrupt is active
- */
- IS_INTERRUPTED = "0x02"
- IS_MAX = "0x03"
- }
-
- struct am_MainSoundProperty_s {
-
- <**
- @description : the type of the property
- **>
- am_MainSoundPropertyType_e type
-
- <**
- @description : the actual value
- **>
- Int16 value
- } array am_MainSoundProperty_l of am_MainSoundProperty_s
-
- struct am_SystemProperty_s {
-
- <**
- @description : the type that is set
- **>
- am_SystemPropertyType_e type
-
- <**
- @description : the actual value
- **>
- Int16 value
- }
-
- array am_SystemProperty_l of am_SystemProperty_s
-
- struct am_MainConnectionType_s {
-
- <**
- @description : the ID of the mainconnection
- **>
- am_mainConnectionID_t mainConnectionID
-
- <**
- @description : the sourceID where the connection starts
- **>
- am_sourceID_t sourceID
-
- <**
- @description : the sinkID where the connection ends
- **>
- am_sinkID_t sinkID
-
- <**
- @description : the delay of the mainconnection
- **>
- am_timeSync_t delay
-
- <**
- @description : the current connection state
- **>
- am_ConnectionState_e connectionState
- }
-
- array am_MainConnectionType_l of am_MainConnectionType_s
-
- struct am_Availability_s {
-
- <**
- @description : the current availability state.
- **>
- am_Availablility_e availability
-
- <**
- @description : the reason for the last change. This can be used to trigger events that deal with state changes.
- **>
- am_AvailabilityReason_e availabilityReason
- }
-
- struct am_SourceType_s {
-
- <**
- @description : his is the ID of the source, it is unique in the system. There are 2 ways, ID can be created: either it is assigned during the registration process (in a dynamic context, uniqueness will be ensured by the AudioManagerDaemon), or it is a fixed (the project has to ensure the uniqueness of the ID).
- **>
- am_sourceID_t sourceID
-
- <**
- @description : The name of the source. Must be unique in the whole system.
- **>
- String name
-
- <**
- @description : the availability of the source
- **>
- am_Availability_s availability
-
- <**
- @description : the sourceClassID, indicates the class the source is in. This information can be used by the Controller to implement different behaviour for different classes.
- **>
- am_sourceClass_t sourceClassID
- }
-
- array am_SourceType_l of am_SourceType_s
-
- struct am_SinkType_s {
-
- <**
- @description : This is the ID of the sink, it is unique in the system. There are 2 ways, ID can be created: either it is assigned during the registration process (in a dynamic context, uniqueness will be ensured by the AudioManagerDaemon), or it is a fixed (the project has to ensure the uniqueness of the ID).
- **>
- am_sinkID_t sinkID
-
- <**
- @description : The name of the sink. Must be unique in the whole system.
- **>
- String name
-
- <**
- @description :
- This attribute reflects the availability of the sink. There are several reasons why a sink could be not available for the moment: for example the shutdown of a sink because of overtemperature or over- & undervoltage. The availability consists of two pieces of information:
- Availablility: the status itself, can be A_AVAILABLE, A_UNAVAILABLE or A_UNKNOWN
- AvailabilityReason: this informs about the last reason for a change in availability. The reasons itself are product specific.
-
- **>
- am_Availability_s availability
-
- <**
- @description : This is the representation of the Volume for the commandInterface. It is used by the HMI to set the volume of a sink, the AudioManagerController has to transform this into real source and sink volumes.
- **>
- am_mainVolume_t volume
- am_MuteState_e muteState
-
- <**
- @description : the sinkClassID references to a sinkClass. With the help of classification, rules can be setup to define the system behaviour.
- **>
- am_sinkClass_t sinkClassID
- }
-
- array am_SinkType_l of am_SinkType_s
-
- struct am_ClassProperty_s {
-
- <**
- @description : he property as enum.
- **>
- am_ClassProperty_e classProperty
- Int16 value
- }
-
- array am_ClassProperty_l of am_ClassProperty_s
-
- struct am_SourceClass_s {
-
- <**
- @description : the source ID.
- **>
- am_sourceClass_t sourceClassID
-
- <**
- @description : the name of the sourceClass - must be unique in the system.
- **>
- String name
-
- <**
- @description : the list of the class properties. These are pairs of a project specific enum describing the type of the value and an integer holding the real value.
- **>
- am_ClassProperty_l listClassProperties
- }
-
- array am_SourceClass_l of am_SourceClass_s
-
- struct am_SinkClass_s {
-
- <**
- @description : the ID of the sinkClass.
- **>
- am_sinkClass_t sinkClassID
-
- <**
- @description : the name of the sinkClass - must be unique in the system.
- **>
- String name
-
- <**
- @description : the list of the class properties. These are pairs of a project specific enum describing the type of the value and an integer holding the real value.
- **>
- am_ClassProperty_l listClassProperties
- }
-
- array am_SinkClass_l of am_SinkClass_s
-
- struct am_NotificationPayload_s
- {
- am_NotificationType_e type
- <**
- @description : This is finally the value of the notification. It's meaning depends on the notificationType
- **>
- Int16 value
-
- }
-
-}
+package org.genivi.am
+import org.genivi.am.* from "../../AudioManagerDaemon/fidls/AudioManagerTypes.fidl"
+
+<**
+ @description : 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:
+ @author : Christian Mueller
+**>
+
+interface CommandControl {
+ version {
+ major 1
+ minor 0
+ }
+
+ <**
+ @description : connects a source to sink
+(at)return E_OK on success, E_NOT_POSSIBLE on failure, E_ALREADY_EXISTS if the connection does already exists
+ **>
+ method connect {
+ in {
+ am_sourceID_t sourceID
+ am_sinkID_t sinkID
+ }
+ out {
+ am_mainConnectionID_t mainConnectionID
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : disconnects a mainConnection
+(at)return E_OK on successes, E_NON_EXISTENT if the connection does not exist, E_NOT_POSSIBLE on error.
+ **>
+ method disconnect {
+ in {
+ am_mainConnectionID_t mainConnectionID
+ }
+ out {
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : sets the volume for a sink
+(at)return E_OK on success, E_UNKOWN on error, E_OUT_OF_RANGE in case the value is out of range
+ **>
+ method setVolume {
+ in {
+
+ <**
+ @description : the sink
+ **>
+ am_sinkID_t sinkID
+
+ <**
+ @description : the volume
+ **>
+ am_mainVolume_t volume
+ }
+ out {
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : This function is used to increment or decrement the current volume for a sink.
+(at)return E_OK on success, E_UNKNOWN on error and E_OUT_OF_RANGE if the value is not in the given volume range.
+ **>
+ method volumeStep {
+ in {
+ am_sinkID_t sinkID
+
+ <**
+ @description : indicated the number of steps that should be incremented or decremented. Positive values here inkrement, negative values decrement
+ **>
+ Int16 volumeStep
+ }
+ out {
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : sets the mute state of a sink
+(at)return E_OK on success, E_UNKNOWN on error. If the mute state is already the desired one, the Daemon will return E_OK.
+ **>
+ method setSinkMuteState {
+ in {
+ am_sinkID_t sinkID
+ am_MuteState_e muteState
+ }
+ out {
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : 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
+(at)return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error
+ **>
+ method setMainSinkSoundProperty {
+ in {
+ am_sinkID_t sinkID
+ am_MainSoundProperty_s soundProperty
+ }
+ out {
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : 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
+(at)return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error
+ **>
+ method setMainSourceSoundProperty {
+ in {
+ am_sourceID_t sourceID
+ am_MainSoundProperty_s soundProperty
+ }
+ out {
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : is used to set a specific system property.
+(at)return E_OK on success, E_OUT_OF_RANGE if value exceeds range, E_UNKNOWN in case of an error
+ **>
+ method setSystemProperty {
+ in {
+
+ <**
+ @description : the property that shall be set
+ **>
+ am_SystemProperty_s property
+ }
+ out {
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : returns the actual list of MainConnections
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ **>
+ method getListMainConnections {
+ out {
+ am_Error_e ^error
+
+ <**
+ @description : returns a list of all connections
+ **>
+ am_MainConnection_L listConnections
+ }
+ }
+
+ <**
+ @description : returns the actual list of Sinks
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ **>
+ method getListMainSinks {
+ out {
+
+ <**
+ @description : the list of the sinks
+ **>
+ am_SinkType_L listMainSinks
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : returns the actual list of Sources
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ **>
+ method getListMainSources {
+ out {
+
+ <**
+ @description : the list of sources
+ **>
+ am_SourceType_L listMainSources
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : This is used to retrieve all source sound properties related to a source. Returns a vector of the sound properties and values as pair
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ **>
+ method getListMainSinkSoundProperties {
+ in {
+ am_sinkID_t sinkID
+ }
+ out {
+ am_MainSoundProperty_L listSoundProperties
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : This is used to retrieve all source sound properties related to a source.
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ **>
+ method getListMainSourceSoundProperties {
+ in {
+ am_sourceID_t sourceID
+ }
+ out {
+ am_MainSoundProperty_L listSourceProperties
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : This is used to retrieve SourceClass Information of all source classes
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ **>
+ method getListSourceClasses {
+ out {
+ am_SourceClass_L listSourceClasses
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : This is used to retrieve SinkClass Information of all sink classes
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ **>
+ method getListSinkClasses {
+ out {
+ am_SinkClass_L listSinkClasses
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : Retrieves a complete list of all systemProperties.
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ **>
+ method getListSystemProperties {
+ out {
+ am_SystemProperty_L listSystemProperties
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : returns the delay in ms that the audiopath for the given mainConnection has
+(at)return E_OK on success, E_NOT_POSSIBLE if timing information is not yet retrieved, E_DATABASE_ERROR on read error on the database
+ **>
+ method getTimingInformation {
+ in {
+ am_mainConnectionID_t mainConnectionID
+ }
+ out {
+ am_timeSync_t delay
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : Retrieves the list of MainNotifications for a sink. Does not return the possible ones.
+ **>
+ method getListMainSinkNotificationConfigurations {
+ in {
+
+ <**
+ @description : The sinkID
+ **>
+ am_sinkID_t sinkID
+ }
+ out {
+ am_NotificationConfiguration_L listMainNotificationConfigurations
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : Retrieves the list of MainNotifications for a source. Does not return the possible ones.
+ **>
+ method getListMainSourceNotificationConfigurations {
+ in {
+
+ <**
+ @description : The sourceID
+ **>
+ am_sourceID_t sourceID
+ }
+ out {
+ am_NotificationConfiguration_L listMainNotificationConfigurations
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : sets a MainNotificationConfiuration. This can be used to turn on an off notifications an to change the mode of the configuration.
+(at)return E_OK on success, E_NON_EXISTENT if sinkID does not exists, E_DATABASE_ERROR on error
+ **>
+ method setMainSinkNotificationConfiguration {
+ in {
+
+ <**
+ @description : The sinkID of the MainNotification to be changed
+ **>
+ am_sinkID_t sinkID
+
+ <**
+ @description : The MainNotifiication that needs to be set
+ **>
+ am_NotificationConfiguration_s mainNotificationConfiguration
+ }
+ out {
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : sets a MainNotificationConfiuration. This can be used to turn on an off notifications an to change the mode of the configuration.
+(at)return E_OK on success, E_NON_EXISTENT if sourceID does not exists, E_DATABASE_ERROR on error
+ **>
+ method setMainSourceNotificationConfiguration {
+ in {
+
+ <**
+ @description : The sourceID of the MainNotification to be changed
+ **>
+ am_sourceID_t sourceID
+
+ <**
+ @description : The MainNotifiication that needs to be set
+ **>
+ am_NotificationConfiguration_s mainNotificationConfiguration
+ }
+ out {
+ am_Error_e ^error
+ }
+ }
+
+ <**
+ @description : Callback that is called when the number of connections change
+ **>
+ broadcast newMainConnection {
+ out {
+ am_MainConnectionType_s mainConnection
+ }
+ }
+
+ <**
+ @description : Callback that is called when the number of connections change
+ **>
+ broadcast removedMainConnection {
+ out {
+ am_mainConnectionID_t mainConnection
+ }
+ }
+
+ <**
+ @description : Callback that is called when the number of sinks change
+ **>
+ broadcast newSink {
+ out {
+ am_SinkType_s sink
+ }
+ }
+
+ <**
+ @description : Callback that is called when the number of sinks change
+ **>
+ broadcast removedSink {
+ out {
+ am_sinkID_t sinkID
+ }
+ }
+
+ <**
+ @description : Callback that is called when the number of sources change
+ **>
+ broadcast newSource {
+ out {
+ am_SourceType_s source
+ }
+ }
+
+ <**
+ @description : Callback that is called when the number of sources change
+ **>
+ broadcast removedSource {
+ out {
+ am_sourceID_t source
+ }
+ }
+
+ <**
+ @description : this callback is fired if the number of sink classes changed
+ **>
+ broadcast numberOfSinkClassesChanged {
+ }
+
+ <**
+ @description : this callback is fired if the number of source classes changed
+ **>
+ broadcast numberOfSourceClassesChanged {
+ }
+
+ <**
+ @description : This callback is called when the ConnectionState of a connection changed.
+ **>
+ broadcast mainConnectionStateChanged {
+ out {
+ am_mainConnectionID_t connectionID
+ am_ConnectionState_e connectionState
+ }
+ }
+
+ <**
+ @description : this callback indicates that a sinkSoundProperty has changed.
+ **>
+ broadcast mainSinkSoundPropertyChanged {
+ out {
+ am_sinkID_t sinkID
+ am_MainSoundProperty_s soundProperty
+ }
+ }
+
+ <**
+ @description : this callback indicates that a sourceSoundProperty has changed.
+ **>
+ broadcast mainSourceSoundPropertyChanged {
+ out {
+ am_sourceID_t sourceID
+ am_MainSoundProperty_s soundProperty
+ }
+ }
+
+ <**
+ @description : this callback is called when the availability of a sink has changed
+ **>
+ broadcast sinkAvailabilityChanged {
+ out {
+ am_sinkID_t sinkID
+ am_Availability_s availability
+ }
+ }
+
+ <**
+ @description : this callback is called when the availability of source has changed.
+ **>
+ broadcast sourceAvailabilityChanged {
+ out {
+ am_sourceID_t sourceID
+ am_Availability_s availability
+ }
+ }
+
+ <**
+ @description : this callback indicates a volume change on the indicated sink
+ **>
+ broadcast volumeChanged {
+ out {
+ am_sinkID_t sinkID
+ am_mainVolume_t volume
+ }
+ }
+
+ <**
+ @description : this callback indicates a mute state change on a sink.
+ **>
+ broadcast sinkMuteStateChanged {
+ out {
+ am_sinkID_t sinkID
+ am_MuteState_e muteState
+ }
+ }
+
+ <**
+ @description : is fired if a systemProperty changed
+ **>
+ broadcast systemPropertyChanged {
+ out {
+ am_SystemProperty_s systemProperty
+ }
+ }
+
+ <**
+ @description : This callback is fired if the timinginformation for a mainConnectionID changed
+ **>
+ broadcast timingInformationChanged {
+ out {
+ am_mainConnectionID_t mainConnectionID
+ am_timeSync_t time
+ }
+ }
+
+ <**
+ @description : This callback is called when a sink is updated.
+ **>
+ broadcast sinkUpdated {
+ out {
+
+ <**
+ @description : The sinkID that is updated
+ **>
+ am_sinkID_t sinkID
+
+ <**
+ @description : The sinkClassID of the updated sink. gives the current value even if not updated
+ **>
+ am_sinkClass_t sinkClassID
+
+ <**
+ @description : The list of mainSoundProperties. Gives the actual list of MainSoundProperties even if not changed
+ **>
+ am_MainSoundProperty_L listMainSoundProperties
+ }
+ }
+
+ <**
+ @description : This callback is called when a source is updated.
+ **>
+ broadcast sourceUpdated {
+ out {
+
+ <**
+ @description : The sourceID that is updated
+ **>
+ am_sourceID_t sourceID
+
+ <**
+ @description : The sourceClassID of the updated source. Gives the current value even if not updated
+ **>
+ am_sourceClass_t sourceClassID
+
+ <**
+ @description : The list of mainSoundProperties. Gives the actual list of MainSoundProperties even if not changed
+ **>
+ am_MainSoundProperty_L listMainSoundProperties
+ }
+ }
+
+ <**
+ @description : This callback is called when a notificated value of a sink changes.
+ **>
+ broadcast sinkNotification {
+ out {
+
+ <**
+ @description : The sinkID
+ **>
+ am_sinkID_t sinkID
+
+ <**
+ @description : The payload of the notification
+ **>
+ am_NotificationPayload_s notification
+ }
+ }
+
+ <**
+ @description : This callback is called when a notifcated value of a source changes.
+ **>
+ broadcast sourceNotification {
+ out {
+
+ <**
+ @description : The sourceID
+ **>
+ am_sourceID_t sourceID
+
+ <**
+ @description : The payload of the notification
+ **>
+ am_NotificationPayload_s notification
+ }
+ }
+
+ <**
+ @description : This callback is triggered when a mainNotificationConfiguration is changed.
+ **>
+ broadcast mainSinkNotificationConfigurationChanged {
+ out {
+ am_sinkID_t sinkID
+
+ <**
+ @description : The MainNotificationConfiguration that changed
+ **>
+ am_NotificationConfiguration_s mainNotificationConfiguration
+ }
+ }
+
+ <**
+ @description : This callback is triggered when a mainNotificationConfiguration is changed.
+ **>
+ broadcast mainSourceNotificationConfigurationChanged {
+ out {
+ am_sourceID_t sourceID
+
+ <**
+ @description : The MainNotificationConfiguration that changed
+ **>
+ am_NotificationConfiguration_s mainNotificationConfiguration
+ }
+ }
+} \ No newline at end of file
diff --git a/PluginCommandInterfaceCAPI/fidl/amTypes.fidl b/PluginCommandInterfaceCAPI/fidl/amTypes.fidl
deleted file mode 100755
index 6f11698..0000000
--- a/PluginCommandInterfaceCAPI/fidl/amTypes.fidl
+++ /dev/null
@@ -1,329 +0,0 @@
-package org.genivi.audiomanager
-
-typeCollection am
-{
- typedef am_sourceID_t is UInt16
- typedef am_sinkID_t is UInt16
- typedef am_gatewayID_t is UInt16
- typedef gongHandle is Int16
- typedef am_sourceClass_t is UInt16
- typedef am_sinkClass_t is UInt16
- typedef am_volume_t is Int16
- typedef am_mainVolume_t is Int16
- typedef am_handle_t is UInt16
- typedef am_time_t is UInt16
-
- enumeration gp_indicatorDirection_e
- {
- INDICATOR_RIGHT ="0x00"
- INDICATOR_LEFT="0x01"
- INDICATOR_WARNING="0x02"
- }
-
- enumeration am_RampType_e
- {
- RAMP_UNKNOWN = "0x00"
- RAMP_GENIVI_DIRECT = "0x01"
- RAMP_GENIVI_NO_PLOP = "0x02"
- RAMP_GENIVI_EXP_INV = "0x03"
- RAMP_GENIVI_LINEAR = "0x04"
- RAMP_GENIVI_EXP = "0x05"
- RAMP_MAX = "0x06"
- }
-
- enumeration am_MuteState_e
- {
- MS_UNKNOWN = "0x00"
- MS_MUTED = "0x01"
- MS_UNMUTED = "0x02"
- MS_MAX = "0x03"
- }
-
- enumeration am_SourceState_e
- {
- SS_UNKNNOWN = "0x00"
- SS_ON = "0x01"
- SS_OFF = "0x02"
- SS_PAUSED = "0x03"
- SS_MAX = "0x04"
- }
- enumeration am_Error_e
- {
- E_OK = "0x00"
- E_UNKNOWN = "0x01"
- E_OUT_OF_RANGE = "0x02"
- E_NOT_USED = "0x03"
- E_DATABASE_ERROR = "0x04"
- E_ALREADY_EXISTS = "0x05"
- E_NO_CHANGE = "0x06"
- E_NOT_POSSIBLE = "0x07"
- E_NON_EXISTENT = "0x08"
- E_ABORTED = "0x09"
- E_WRONG_FORMAT = "0xA"
- E_MAX = "0xB"
- }
-
- enumeration am_DomainState_e
- {
-
- DS_UNKNOWN = "0"
- DS_CONTROLLED = "1"
- DS_INDEPENDENT_STARTUP = "2"
- DS_INDEPENDENT_RUNDOWN = "3"
- DS_MAX = "4"
- }
-
- enumeration gongType_e
- {
- AT_NUN = "0x01"
- AT_POC = "0x02"
- AT_QUE = "0x03"
- AT_IWA = "0x04"
- AT_WA = "0x05"
- AT_ETC_F = "0x06"
- AT_ETC_F2 = "0x07"
- AT_ETC_ST = "0x08"
- AT_ETC_S = "0x09"
- AT_REV = "0x0A"
- AT_ESU = "0x0B"
- AT_ESD = "0x0C"
- AT_DG = "0x0D"
- AT_SG = "0x0E"
- AT_IDG = "0x0F"
- AT_ION = "0x10"
- AT_IOFF = "0x11"
- AT_FBS = "0x12"
- AT_VFS = "0x13"
- AT_GES = "0x14"
- AT_UEE = "0x15"
- }
-
- enumeration gp_indicatorStatus_e
- {
- IS_ON = "0x00"
- IS_OFF = "0x01"
- }
-
- enumeration gongStatus_e
- {
- NOT_PLAYING = "0x00"
- PLAYING = "0x01"
- INTERRUPTED = "0x02"
- }
-
- enumeration gongError_e
- {
- SUCCESS = "0x00"
- ERROR = "0x01"
- LOW_PRIORITY = "0x02"
- }
-
- enumeration gongClass_e
- {
- GONGCLASS_1 = "0x01"
- GONGCLASS_2 = "0x02"
- GONGCLASS_PDC = "0x03"
- GONGCLASS_TURN = "0x04"
- GONGCLASS_OBSTACLE = "0x05"
- }
-
- enumeration sampleSet_e
- {
- setBMW = "0x00"
- setMini = "0x01"
- setRR = "0x02"
- }
-
- enumeration am_Availability_e
- {
- A_UNKNOWN = "0x00"
- A_AVAILABLE = "0x01"
- A_UNAVAILABLE = "0x02"
- A_MAX = "0x03"
- }
- enumeration am_AvailabilityReason_e
- {
- AR_UNKNOWN = "0x00"
- AR_GENIVI_NEWMEDIA = "0x01"
- AR_GENIVI_SAMEMEDIA = "0x02"
- AR_GENIVI_NOMEDIA = "0x03"
- AR_GENIVI_TEMPERATURE = "0x04"
- AR_GENIVI_VOLTAGE = "0x05"
- AR_GENIVI_ERRORMEDIA = "0x06"
- AR_MAX = "0x07"
- }
-
- enumeration am_InterruptState_e
- {
- IS_UNKNOWN = "0x00"
- IS_OFF = "0x01"
- IS_INTERRUPTED = "0x02"
- IS_MAX = "0x03"
- }
-
- enumeration am_SoundPropertyType_e
- {
- SP_UNKNOWN = "0x00"
- SP_EXAMPLE_TREBLE = "0x01"
- SP_EXAMPLE_MID = "0x02"
- SP_EXAMPLE_BASS = "0x03"
- SP_ENTER_SINKID = "0x04"
- SP_INTERR_SUPERSEEDINGID = "0x05"
- SP_INTERR_OVERLAYID = "0x06"
- SP_PRIORITY = "0x07"
- SP_MAX = "0x08"
- }
-
- enumeration am_ConnectionFormat_e
- {
- CF_UNKNOWN = "0x00"
- CF_GENIVI_MONO = "0x01"
- CF_GENIVI_STEREO = "0x02"
- CF_GENIVI_ANALOG = "0x03"
- CF_GENIVI_AUTO = "0x04"
- CF_MAX = "0x05"
- }
- array am_ConnectionFormat_L of am_ConnectionFormat_e
-
- enumeration am_MainSoundPropertyType_e
- {
- MSP_UNKNOWN = "0x00"
- MSP_EXAMPLE_TREBLE = "0x01"
- MSP_EXAMPLE_MID = "0x02"
- MSP_EXAMPLE_BASS = "0x03"
- MSP_SOURCE_TYPE = "0x04"
- MSP_MAX = "0x05"
- }
-
- enumeration am_NotificationType_e
- {
- NT_UNKNOWN = "0x00"
- NT_LOUDNESS = "0x01"
- NT_MAX = "0x02"
- }
-
- enumeration am_NotificationStatus_e
- {
- NS_UNKNOWN = "0x00"
- NS_OFF = "0x01"
- NS_PERIODIC = "0x02"
- NS_MINIMUM = "0x03"
- NS_MAXIMUM = "0x04"
- NS_CHANGE = "0x05"
- NS_MAX = "0x06"
- }
-
- struct distanceInformation_s
- {
- Int32 FrontLeft
- Int32 FrontRight
- Int32 RearLeft
- Int32 RearRight
- }
-
- struct sampleNames_s
- {
- sampleSet_e sample
- String sampleName
- } array listSampleNamesL of sampleNames_s
-
- typedef am_domainID_t is UInt16
-
- struct am_Domain_s
- {
- am_domainID_t domainID
- String name
- String busname
- String nodename
- Boolean early
- Boolean complete
- am_DomainState_e ^state
- }
-
- struct notificationPayload_s
- {
- Int16 type
- Int16 payload
- }
-
- struct am_Availability_s
- {
- am_Availability_e availability
- am_AvailabilityReason_e availabilityReason
- }
-
- struct am_SoundProperty_s
- {
- am_SoundPropertyType_e type
- Int16 value
- }
- array am_SoundProperty_L of am_SoundProperty_s
-
- struct am_MainSoundProperty_s
- {
- am_MainSoundPropertyType_e type
- Int16 value
- }
- array am_MainSoundProperty_L of am_MainSoundProperty_s
-
- struct am_NotificationConfiguration_s
- {
- am_NotificationType_e type
- am_NotificationStatus_e status
- Int16 parameter
- }
- array am_NotificationConfiguration_L of am_NotificationConfiguration_s
-
-
- array bool_L of Boolean
-
- struct sourceData_s
- {
- am_sourceID_t sourceID
- am_domainID_t domainID
- String name
- am_sourceClass_t sourceClassID
- am_SourceState_e sourceState
- am_volume_t volume
- Boolean visible
- am_Availability_s available
- am_InterruptState_e interruptState
- am_SoundProperty_L listSoundProperties
- am_ConnectionFormat_L listConnectionFormats
- am_MainSoundProperty_L listMainSoundProperties
- am_NotificationConfiguration_L listMainNotificationConfigurations
- am_NotificationConfiguration_L listNotificationConfigurations
- }
-
- struct sinkData_s
- {
- am_sinkID_t sinkID
- String name
- am_domainID_t domainID
- am_sinkClass_t sinkClassID
- am_volume_t volume
- Boolean visible
- am_Availability_s available
- am_MuteState_e muteState
- am_mainVolume_t mainVolume
- am_SoundProperty_L listSoundProperties
- am_ConnectionFormat_L listConnectionFormats
- am_MainSoundProperty_L listMainSoundProperties
- am_NotificationConfiguration_L listMainNotificationConfigurations
- am_NotificationConfiguration_L listNotificationConfigurations
- }
-
- struct am_Gateway_s
- {
- am_gatewayID_t gatewayID
- String name
- am_sinkID_t sinkID
- am_sourceID_t sourceID
- am_domainID_t domainSinkID
- am_domainID_t domainSourceID
- am_domainID_t controlDomainID
- am_ConnectionFormat_L listSourceFormats
- am_ConnectionFormat_L listSinkFormats
- bool_L convertionMatrix
- }
-} \ No newline at end of file