summaryrefslogtreecommitdiff
path: root/PluginCommandInterfaceCAPI/src-gen/org/genivi/am
diff options
context:
space:
mode:
authorChristian Linke <christian.linke@bmw.de>2013-09-25 15:42:47 +0200
committerChristian Linke <christian.linke@bmw.de>2013-09-25 15:42:47 +0200
commit32caf7f1db12965712a1f74016e7b55e258cab73 (patch)
tree3e281e0fcb945b9f2158bf34cc6911f245b56e2b /PluginCommandInterfaceCAPI/src-gen/org/genivi/am
parent4f90cec2d3cb8f19f03144297e2ce5fd62d80757 (diff)
downloadaudiomanager-32caf7f1db12965712a1f74016e7b55e258cab73.tar.gz
* made sure that CommonAPI stuff compiles with release 2.1
Signed-off-by: Christian Linke <christian.linke@bmw.de>
Diffstat (limited to 'PluginCommandInterfaceCAPI/src-gen/org/genivi/am')
-rw-r--r--PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControl.h48
-rw-r--r--PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusProxy.cpp219
-rw-r--r--PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusProxy.h187
-rw-r--r--PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusStubAdapter.cpp585
-rw-r--r--PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusStubAdapter.h128
-rw-r--r--PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlProxy.h613
-rw-r--r--PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlProxyBase.h524
-rw-r--r--PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlStub.h280
-rw-r--r--PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlStubDefault.cpp303
-rw-r--r--PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlStubDefault.h258
10 files changed, 2516 insertions, 629 deletions
diff --git a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControl.h b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControl.h
index f631c92..f9adc0b 100644
--- a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControl.h
+++ b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControl.h
@@ -1,34 +1,39 @@
/*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* 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/.
-*
+* This file was generated by the CommonAPI Generators.
+* Used org.genivi.commonapi.core 2.1.1.201309251246.
+* Used org.franca.core 0.8.9.201308271211.
*
+* Copyright (c) 2012 BMW
+*
* \author Aleksandar Donchev, aleksander.donchev@partner.bmw.de BMW 2013
-* \author Christian Linke christian.linke@bmw.de BMW 2013
-*
+*
+* \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.
+*
* For further information see http://www.genivi.org/.
*/
+/**
+ * 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
+ */
#ifndef ORG_GENIVI_AM_Command_Control_H_
#define ORG_GENIVI_AM_Command_Control_H_
+#if !defined (COMMONAPI_INTERNAL_COMPILATION)
#define COMMONAPI_INTERNAL_COMPILATION
+#endif
#include <CommonAPI/types.h>
@@ -47,7 +52,8 @@ class CommandControl {
};
const char* CommandControl::getInterfaceId() {
- return "org.genivi.am.CommandControl";
+ static const char* interfaceId = "org.genivi.am.CommandControl";
+ return interfaceId;
}
CommonAPI::Version CommandControl::getInterfaceVersion() {
diff --git a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusProxy.cpp b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusProxy.cpp
index cf6f32b..b64c94c 100644
--- a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusProxy.cpp
+++ b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusProxy.cpp
@@ -1,28 +1,31 @@
/*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* 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/.
-*
+* This file was generated by the CommonAPI Generators.
+* Used org.genivi.commonapi.core 2.1.1.201309251246.
+* Used org.franca.core 0.8.9.201308271211.
*
+* Copyright (c) 2012 BMW
+*
* \author Aleksandar Donchev, aleksander.donchev@partner.bmw.de BMW 2013
-* \author Christian Linke christian.linke@bmw.de BMW 2013
-*
+*
+* \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.
+*
* For further information see http://www.genivi.org/.
*/
+/**
+ * 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
+ */
#include "CommandControlDBusProxy.h"
namespace org {
@@ -30,12 +33,13 @@ namespace genivi {
namespace am {
std::shared_ptr<CommonAPI::DBus::DBusProxy> createCommandControlDBusProxy(
+ const std::shared_ptr<CommonAPI::DBus::DBusFactory>& factory,
const std::string& commonApiAddress,
const std::string& interfaceName,
const std::string& busName,
const std::string& objectPath,
const std::shared_ptr<CommonAPI::DBus::DBusProxyConnection>& dbusProxyConnection) {
- return std::make_shared<CommandControlDBusProxy>(commonApiAddress, interfaceName, busName, objectPath, dbusProxyConnection);
+ return std::make_shared<CommandControlDBusProxy>(factory, commonApiAddress, interfaceName, busName, objectPath, dbusProxyConnection);
}
__attribute__((constructor)) void registerCommandControlDBusProxy(void) {
@@ -44,37 +48,38 @@ __attribute__((constructor)) void registerCommandControlDBusProxy(void) {
}
CommandControlDBusProxy::CommandControlDBusProxy(
+ const std::shared_ptr<CommonAPI::DBus::DBusFactory>& factory,
const std::string& commonApiAddress,
const std::string& interfaceName,
const std::string& busName,
const std::string& objectPath,
const std::shared_ptr<CommonAPI::DBus::DBusProxyConnection>& dbusProxyconnection):
- CommonAPI::DBus::DBusProxy(commonApiAddress, interfaceName, busName, objectPath, dbusProxyconnection)
+ CommonAPI::DBus::DBusProxy(factory, commonApiAddress, interfaceName, busName, objectPath, dbusProxyconnection)
, newMainConnection_(*this, "newMainConnection", "(qqqni)"),
- removedMainConnection_(*this, "removedMainConnection", "q"),
- newSink_(*this, "newSink", "(qs(iq)niq)"),
- removedSink_(*this, "removedSink", "q"),
- newSource_(*this, "newSource", "(qs(iq)q)"),
- removedSource_(*this, "removedSource", "q"),
- numberOfSinkClassesChanged_(*this, "numberOfSinkClassesChanged", ""),
- numberOfSourceClassesChanged_(*this, "numberOfSourceClassesChanged", ""),
- mainConnectionStateChanged_(*this, "mainConnectionStateChanged", "qi"),
- mainSinkSoundPropertyChanged_(*this, "mainSinkSoundPropertyChanged", "q(qn)"),
- mainSourceSoundPropertyChanged_(*this, "mainSourceSoundPropertyChanged", "q(qn)"),
- sinkAvailabilityChanged_(*this, "sinkAvailabilityChanged", "q(iq)"),
- sourceAvailabilityChanged_(*this, "sourceAvailabilityChanged", "q(iq)"),
- volumeChanged_(*this, "volumeChanged", "qn"),
- sinkMuteStateChanged_(*this, "sinkMuteStateChanged", "qi"),
- systemPropertyChanged_(*this, "systemPropertyChanged", "(qn)"),
- timingInformationChanged_(*this, "timingInformationChanged", "qn"),
- sinkUpdated_(*this, "sinkUpdated", "qqa(qn)"),
- sourceUpdated_(*this, "sourceUpdated", "qqa(qn)"),
- sinkNotification_(*this, "sinkNotification", "q(qn)"),
- sourceNotification_(*this, "sourceNotification", "q(qn)"),
- mainSinkNotificationConfigurationChanged_(*this, "mainSinkNotificationConfigurationChanged", "q(qin)"),
- mainSourceNotificationConfigurationChanged_(*this, "mainSourceNotificationConfigurationChanged", "q(qin)")
- {
-}
+ removedMainConnection_(*this, "removedMainConnection", "q"),
+ newSink_(*this, "newSink", "(qs(iq)niq)"),
+ removedSink_(*this, "removedSink", "q"),
+ newSource_(*this, "newSource", "(qs(iq)q)"),
+ removedSource_(*this, "removedSource", "q"),
+ numberOfSinkClassesChanged_(*this, "numberOfSinkClassesChanged", ""),
+ numberOfSourceClassesChanged_(*this, "numberOfSourceClassesChanged", ""),
+ mainConnectionStateChanged_(*this, "mainConnectionStateChanged", "qi"),
+ mainSinkSoundPropertyChanged_(*this, "mainSinkSoundPropertyChanged", "q(qn)"),
+ mainSourceSoundPropertyChanged_(*this, "mainSourceSoundPropertyChanged", "q(qn)"),
+ sinkAvailabilityChanged_(*this, "sinkAvailabilityChanged", "q(iq)"),
+ sourceAvailabilityChanged_(*this, "sourceAvailabilityChanged", "q(iq)"),
+ volumeChanged_(*this, "volumeChanged", "qn"),
+ sinkMuteStateChanged_(*this, "sinkMuteStateChanged", "qi"),
+ systemPropertyChanged_(*this, "systemPropertyChanged", "(qn)"),
+ timingInformationChanged_(*this, "timingInformationChanged", "qn"),
+ sinkUpdated_(*this, "sinkUpdated", "qqa(qn)"),
+ sourceUpdated_(*this, "sourceUpdated", "qqa(qn)"),
+ sinkNotification_(*this, "sinkNotification", "q(qn)"),
+ sourceNotification_(*this, "sourceNotification", "q(qn)"),
+ mainSinkNotificationConfigurationChanged_(*this, "mainSinkNotificationConfigurationChanged", "q(qin)"),
+ mainSourceNotificationConfigurationChanged_(*this, "mainSourceNotificationConfigurationChanged", "q(qin)")
+ {
+ }
CommandControlDBusProxy::NewMainConnectionEvent& CommandControlDBusProxy::getNewMainConnectionEvent() {
@@ -147,6 +152,11 @@ CommandControlDBusProxy::MainSourceNotificationConfigurationChangedEvent& Comman
return mainSourceNotificationConfigurationChanged_;
}
+/**
+ * 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
+ */
void CommandControlDBusProxy::connect(const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_mainConnectionID_t& mainConnectionID, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t, am_sinkID_t>,
CommonAPI::DBus::DBusSerializableArguments<am_mainConnectionID_t, am_Error_e> >::callMethodWithReply(
@@ -166,6 +176,11 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::connectAsync(const a
sourceID, sinkID,
std::move(callback));
}
+/**
+ * disconnects a mainConnection
+(at)return E_OK on successes, E_NON_EXISTENT if
+ * the connection does not exist, E_NOT_POSSIBLE on error.
+ */
void CommandControlDBusProxy::disconnect(const am_mainConnectionID_t& mainConnectionID, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_mainConnectionID_t>,
CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply(
@@ -185,6 +200,11 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::disconnectAsync(cons
mainConnectionID,
std::move(callback));
}
+/**
+ * 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
+ */
void CommandControlDBusProxy::setVolume(const am_sinkID_t& sinkID, const am_mainVolume_t& volume, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_mainVolume_t>,
CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply(
@@ -204,25 +224,36 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::setVolumeAsync(const
sinkID, volume,
std::move(callback));
}
-void CommandControlDBusProxy::volumeStep(const am_sinkID_t& sinkID, const int16_t& volumeStep, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
+/**
+ * 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.
+ */
+void CommandControlDBusProxy::volumeStep(const am_sinkID_t& sinkID, const int16_t& volumeStep_, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, int16_t>,
CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply(
*this,
"volumeStep",
"qn",
- sinkID, volumeStep,
+ sinkID, volumeStep_,
callStatus
, error);
}
-std::future<CommonAPI::CallStatus> CommandControlDBusProxy::volumeStepAsync(const am_sinkID_t& sinkID, const int16_t& volumeStep, VolumeStepAsyncCallback callback) {
+std::future<CommonAPI::CallStatus> CommandControlDBusProxy::volumeStepAsync(const am_sinkID_t& sinkID, const int16_t& volumeStep_, VolumeStepAsyncCallback callback) {
return CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, int16_t>,
CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodAsync(
*this,
"volumeStep",
"qn",
- sinkID, volumeStep,
+ sinkID, volumeStep_,
std::move(callback));
}
+/**
+ * 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.
+ */
void CommandControlDBusProxy::setSinkMuteState(const am_sinkID_t& sinkID, const am_MuteState_e& muteState, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_MuteState_e>,
CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply(
@@ -242,6 +273,13 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::setSinkMuteStateAsyn
sinkID, muteState,
std::move(callback));
}
+/**
+ * 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
+ */
void CommandControlDBusProxy::setMainSinkSoundProperty(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_MainSoundProperty_s>,
CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply(
@@ -261,6 +299,13 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::setMainSinkSoundProp
sinkID, soundProperty,
std::move(callback));
}
+/**
+ * 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
+ */
void CommandControlDBusProxy::setMainSourceSoundProperty(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t, am_MainSoundProperty_s>,
CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply(
@@ -280,6 +325,11 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::setMainSourceSoundPr
sourceID, soundProperty,
std::move(callback));
}
+/**
+ * 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
+ */
void CommandControlDBusProxy::setSystemProperty(const am_SystemProperty_s& property, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_SystemProperty_s>,
CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply(
@@ -299,6 +349,11 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::setSystemPropertyAsy
property,
std::move(callback));
}
+/**
+ * returns the actual list of MainConnections
+(at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
void CommandControlDBusProxy::getListMainConnections(CommonAPI::CallStatus& callStatus, am_MainConnection_L& listConnections, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<>,
CommonAPI::DBus::DBusSerializableArguments<am_MainConnection_L, am_Error_e> >::callMethodWithReply(
@@ -316,6 +371,11 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::getListMainConnectio
"",
std::move(callback));
}
+/**
+ * returns the actual list of Sinks
+(at)return E_OK on success, E_DATABASE_ERROR
+ * on error
+ */
void CommandControlDBusProxy::getListMainSinks(CommonAPI::CallStatus& callStatus, am_SinkType_L& listMainSinks, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<>,
CommonAPI::DBus::DBusSerializableArguments<am_SinkType_L, am_Error_e> >::callMethodWithReply(
@@ -333,6 +393,11 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::getListMainSinksAsyn
"",
std::move(callback));
}
+/**
+ * returns the actual list of Sources
+(at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
void CommandControlDBusProxy::getListMainSources(CommonAPI::CallStatus& callStatus, am_SourceType_L& listMainSources, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<>,
CommonAPI::DBus::DBusSerializableArguments<am_SourceType_L, am_Error_e> >::callMethodWithReply(
@@ -350,6 +415,12 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::getListMainSourcesAs
"",
std::move(callback));
}
+/**
+ * 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
+ */
void CommandControlDBusProxy::getListMainSinkSoundProperties(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_MainSoundProperty_L& listSoundProperties, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t>,
CommonAPI::DBus::DBusSerializableArguments<am_MainSoundProperty_L, am_Error_e> >::callMethodWithReply(
@@ -369,6 +440,11 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::getListMainSinkSound
sinkID,
std::move(callback));
}
+/**
+ * This is used to retrieve all source sound properties related to a
+ * source.
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ */
void CommandControlDBusProxy::getListMainSourceSoundProperties(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_MainSoundProperty_L& listSourceProperties, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t>,
CommonAPI::DBus::DBusSerializableArguments<am_MainSoundProperty_L, am_Error_e> >::callMethodWithReply(
@@ -388,6 +464,11 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::getListMainSourceSou
sourceID,
std::move(callback));
}
+/**
+ * This is used to retrieve SourceClass Information of all source classes
+ *
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ */
void CommandControlDBusProxy::getListSourceClasses(CommonAPI::CallStatus& callStatus, am_SourceClass_L& listSourceClasses, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<>,
CommonAPI::DBus::DBusSerializableArguments<am_SourceClass_L, am_Error_e> >::callMethodWithReply(
@@ -405,6 +486,11 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::getListSourceClasses
"",
std::move(callback));
}
+/**
+ * This is used to retrieve SinkClass Information of all sink classes
+(at)return
+ * E_OK on success, E_DATABASE_ERROR on error
+ */
void CommandControlDBusProxy::getListSinkClasses(CommonAPI::CallStatus& callStatus, am_SinkClass_L& listSinkClasses, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<>,
CommonAPI::DBus::DBusSerializableArguments<am_SinkClass_L, am_Error_e> >::callMethodWithReply(
@@ -422,6 +508,11 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::getListSinkClassesAs
"",
std::move(callback));
}
+/**
+ * Retrieves a complete list of all systemProperties.
+(at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
void CommandControlDBusProxy::getListSystemProperties(CommonAPI::CallStatus& callStatus, am_SystemProperty_L& listSystemProperties, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<>,
CommonAPI::DBus::DBusSerializableArguments<am_SystemProperty_L, am_Error_e> >::callMethodWithReply(
@@ -439,6 +530,12 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::getListSystemPropert
"",
std::move(callback));
}
+/**
+ * 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
+ */
void CommandControlDBusProxy::getTimingInformation(const am_mainConnectionID_t& mainConnectionID, CommonAPI::CallStatus& callStatus, am_timeSync_t& delay, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_mainConnectionID_t>,
CommonAPI::DBus::DBusSerializableArguments<am_timeSync_t, am_Error_e> >::callMethodWithReply(
@@ -458,6 +555,10 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::getTimingInformation
mainConnectionID,
std::move(callback));
}
+/**
+ * Retrieves the list of MainNotifications for a sink. Does not return the
+ * possible ones.
+ */
void CommandControlDBusProxy::getListMainSinkNotificationConfigurations(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t>,
CommonAPI::DBus::DBusSerializableArguments<am_NotificationConfiguration_L, am_Error_e> >::callMethodWithReply(
@@ -477,6 +578,10 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::getListMainSinkNotif
sinkID,
std::move(callback));
}
+/**
+ * Retrieves the list of MainNotifications for a source. Does not return the
+ * possible ones.
+ */
void CommandControlDBusProxy::getListMainSourceNotificationConfigurations(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t>,
CommonAPI::DBus::DBusSerializableArguments<am_NotificationConfiguration_L, am_Error_e> >::callMethodWithReply(
@@ -496,6 +601,12 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::getListMainSourceNot
sourceID,
std::move(callback));
}
+/**
+ * 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
+ */
void CommandControlDBusProxy::setMainSinkNotificationConfiguration(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_NotificationConfiguration_s>,
CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply(
@@ -515,6 +626,12 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::setMainSinkNotificat
sinkID, mainNotificationConfiguration,
std::move(callback));
}
+/**
+ * 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
+ */
void CommandControlDBusProxy::setMainSourceNotificationConfiguration(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t, am_NotificationConfiguration_s>,
CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply(
@@ -535,6 +652,8 @@ std::future<CommonAPI::CallStatus> CommandControlDBusProxy::setMainSourceNotific
std::move(callback));
}
+
+
void CommandControlDBusProxy::getOwnVersion(uint16_t& ownVersionMajor, uint16_t& ownVersionMinor) const {
ownVersionMajor = 1;
ownVersionMinor = 0;
diff --git a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusProxy.h b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusProxy.h
index 3f146b7..aad93f7 100644
--- a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusProxy.h
+++ b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusProxy.h
@@ -1,34 +1,39 @@
/*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* 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/.
-*
+* This file was generated by the CommonAPI Generators.
+* Used org.genivi.commonapi.core 2.1.1.201309251246.
+* Used org.franca.core 0.8.9.201308271211.
*
+* Copyright (c) 2012 BMW
+*
* \author Aleksandar Donchev, aleksander.donchev@partner.bmw.de BMW 2013
-* \author Christian Linke christian.linke@bmw.de BMW 2013
-*
+*
+* \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.
+*
* For further information see http://www.genivi.org/.
*/
+/**
+ * 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
+ */
#ifndef ORG_GENIVI_AM_Command_Control_DBUS_PROXY_H_
#define ORG_GENIVI_AM_Command_Control_DBUS_PROXY_H_
#include <org/genivi/am/CommandControlProxyBase.h>
+#if !defined (COMMONAPI_INTERNAL_COMPILATION)
#define COMMONAPI_INTERNAL_COMPILATION
+#endif
#include <CommonAPI/DBus/DBusFactory.h>
#include <CommonAPI/DBus/DBusProxy.h>
@@ -45,6 +50,7 @@ namespace am {
class CommandControlDBusProxy: virtual public CommandControlProxyBase, virtual public CommonAPI::DBus::DBusProxy {
public:
CommandControlDBusProxy(
+ const std::shared_ptr<CommonAPI::DBus::DBusFactory>& factory,
const std::string& commonApiAddress,
const std::string& interfaceName,
const std::string& busName,
@@ -78,70 +84,162 @@ class CommandControlDBusProxy: virtual public CommandControlProxyBase, virtual p
virtual MainSinkNotificationConfigurationChangedEvent& getMainSinkNotificationConfigurationChangedEvent();
virtual MainSourceNotificationConfigurationChangedEvent& getMainSourceNotificationConfigurationChangedEvent();
-
+ /**
+ * 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
+ */
virtual void connect(const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_mainConnectionID_t& mainConnectionID, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> connectAsync(const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, ConnectAsyncCallback callback);
-
+ /**
+ * disconnects a mainConnection
+ (at)return E_OK on successes, E_NON_EXISTENT if
+ * the connection does not exist, E_NOT_POSSIBLE on error.
+ */
virtual void disconnect(const am_mainConnectionID_t& mainConnectionID, CommonAPI::CallStatus& callStatus, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> disconnectAsync(const am_mainConnectionID_t& mainConnectionID, DisconnectAsyncCallback callback);
-
+ /**
+ * 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
+ */
virtual void setVolume(const am_sinkID_t& sinkID, const am_mainVolume_t& volume, CommonAPI::CallStatus& callStatus, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> setVolumeAsync(const am_sinkID_t& sinkID, const am_mainVolume_t& volume, SetVolumeAsyncCallback callback);
-
- virtual void volumeStep(const am_sinkID_t& sinkID, const int16_t& volumeStep, CommonAPI::CallStatus& callStatus, am_Error_e& error);
- virtual std::future<CommonAPI::CallStatus> volumeStepAsync(const am_sinkID_t& sinkID, const int16_t& volumeStep, VolumeStepAsyncCallback callback);
-
+ /**
+ * 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.
+ */
+ virtual void volumeStep(const am_sinkID_t& sinkID, const int16_t& volumeStep_, CommonAPI::CallStatus& callStatus, am_Error_e& error);
+ virtual std::future<CommonAPI::CallStatus> volumeStepAsync(const am_sinkID_t& sinkID, const int16_t& volumeStep_, VolumeStepAsyncCallback callback);
+ /**
+ * 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.
+ */
virtual void setSinkMuteState(const am_sinkID_t& sinkID, const am_MuteState_e& muteState, CommonAPI::CallStatus& callStatus, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> setSinkMuteStateAsync(const am_sinkID_t& sinkID, const am_MuteState_e& muteState, SetSinkMuteStateAsyncCallback callback);
-
+ /**
+ * 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
+ */
virtual void setMainSinkSoundProperty(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> setMainSinkSoundPropertyAsync(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty, SetMainSinkSoundPropertyAsyncCallback callback);
-
+ /**
+ * 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
+ */
virtual void setMainSourceSoundProperty(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> setMainSourceSoundPropertyAsync(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty, SetMainSourceSoundPropertyAsyncCallback callback);
-
+ /**
+ * 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
+ */
virtual void setSystemProperty(const am_SystemProperty_s& property, CommonAPI::CallStatus& callStatus, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> setSystemPropertyAsync(const am_SystemProperty_s& property, SetSystemPropertyAsyncCallback callback);
-
+ /**
+ * returns the actual list of MainConnections
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
virtual void getListMainConnections(CommonAPI::CallStatus& callStatus, am_MainConnection_L& listConnections, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> getListMainConnectionsAsync(GetListMainConnectionsAsyncCallback callback);
-
+ /**
+ * returns the actual list of Sinks
+ (at)return E_OK on success, E_DATABASE_ERROR
+ * on error
+ */
virtual void getListMainSinks(CommonAPI::CallStatus& callStatus, am_SinkType_L& listMainSinks, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> getListMainSinksAsync(GetListMainSinksAsyncCallback callback);
-
+ /**
+ * returns the actual list of Sources
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
virtual void getListMainSources(CommonAPI::CallStatus& callStatus, am_SourceType_L& listMainSources, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> getListMainSourcesAsync(GetListMainSourcesAsyncCallback callback);
-
+ /**
+ * 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
+ */
virtual void getListMainSinkSoundProperties(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_MainSoundProperty_L& listSoundProperties, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> getListMainSinkSoundPropertiesAsync(const am_sinkID_t& sinkID, GetListMainSinkSoundPropertiesAsyncCallback callback);
-
+ /**
+ * This is used to retrieve all source sound properties related to a
+ * source.
+ (at)return E_OK on success, E_DATABASE_ERROR on error
+ */
virtual void getListMainSourceSoundProperties(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_MainSoundProperty_L& listSourceProperties, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> getListMainSourceSoundPropertiesAsync(const am_sourceID_t& sourceID, GetListMainSourceSoundPropertiesAsyncCallback callback);
-
+ /**
+ * This is used to retrieve SourceClass Information of all source classes
+ *
+ (at)return E_OK on success, E_DATABASE_ERROR on error
+ */
virtual void getListSourceClasses(CommonAPI::CallStatus& callStatus, am_SourceClass_L& listSourceClasses, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> getListSourceClassesAsync(GetListSourceClassesAsyncCallback callback);
-
+ /**
+ * This is used to retrieve SinkClass Information of all sink classes
+ (at)return
+ * E_OK on success, E_DATABASE_ERROR on error
+ */
virtual void getListSinkClasses(CommonAPI::CallStatus& callStatus, am_SinkClass_L& listSinkClasses, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> getListSinkClassesAsync(GetListSinkClassesAsyncCallback callback);
-
+ /**
+ * Retrieves a complete list of all systemProperties.
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
virtual void getListSystemProperties(CommonAPI::CallStatus& callStatus, am_SystemProperty_L& listSystemProperties, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> getListSystemPropertiesAsync(GetListSystemPropertiesAsyncCallback callback);
-
+ /**
+ * 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
+ */
virtual void getTimingInformation(const am_mainConnectionID_t& mainConnectionID, CommonAPI::CallStatus& callStatus, am_timeSync_t& delay, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> getTimingInformationAsync(const am_mainConnectionID_t& mainConnectionID, GetTimingInformationAsyncCallback callback);
-
+ /**
+ * Retrieves the list of MainNotifications for a sink. Does not return the
+ * possible ones.
+ */
virtual void getListMainSinkNotificationConfigurations(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> getListMainSinkNotificationConfigurationsAsync(const am_sinkID_t& sinkID, GetListMainSinkNotificationConfigurationsAsyncCallback callback);
-
+ /**
+ * Retrieves the list of MainNotifications for a source. Does not return the
+ * possible ones.
+ */
virtual void getListMainSourceNotificationConfigurations(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> getListMainSourceNotificationConfigurationsAsync(const am_sourceID_t& sourceID, GetListMainSourceNotificationConfigurationsAsyncCallback callback);
-
+ /**
+ * 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
+ */
virtual void setMainSinkNotificationConfiguration(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration, CommonAPI::CallStatus& callStatus, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> setMainSinkNotificationConfigurationAsync(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration, SetMainSinkNotificationConfigurationAsyncCallback callback);
-
+ /**
+ * 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
+ */
virtual void setMainSourceNotificationConfiguration(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration, CommonAPI::CallStatus& callStatus, am_Error_e& error);
virtual std::future<CommonAPI::CallStatus> setMainSourceNotificationConfigurationAsync(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration, SetMainSourceNotificationConfigurationAsyncCallback callback);
+
virtual void getOwnVersion(uint16_t& ownVersionMajor, uint16_t& ownVersionMinor) const;
private:
@@ -169,8 +267,11 @@ class CommandControlDBusProxy: virtual public CommandControlProxyBase, virtual p
CommonAPI::DBus::DBusEvent<SourceNotificationEvent> sourceNotification_;
CommonAPI::DBus::DBusEvent<MainSinkNotificationConfigurationChangedEvent> mainSinkNotificationConfigurationChanged_;
CommonAPI::DBus::DBusEvent<MainSourceNotificationConfigurationChangedEvent> mainSourceNotificationConfigurationChanged_;
+
};
+
+
} // namespace am
} // namespace genivi
} // namespace org
diff --git a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusStubAdapter.cpp b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusStubAdapter.cpp
index 4715cdb..751695f 100644
--- a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusStubAdapter.cpp
+++ b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusStubAdapter.cpp
@@ -1,26 +1,21 @@
/*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* 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/.
-*
+* This file was generated by the CommonAPI Generators.
+* Used org.genivi.commonapi.core 2.1.1.201309251246.
+* Used org.franca.core 0.8.9.201308271211.
*
+* Copyright (c) 2012 BMW
+*
* \author Aleksandar Donchev, aleksander.donchev@partner.bmw.de BMW 2013
-* \author Christian Linke christian.linke@bmw.de BMW 2013
-*
+*
+* \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.
+*
* For further information see http://www.genivi.org/.
*/
#include "CommandControlDBusStubAdapter.h"
@@ -31,13 +26,14 @@ namespace genivi {
namespace am {
std::shared_ptr<CommonAPI::DBus::DBusStubAdapter> createCommandControlDBusStubAdapter(
+ const std::shared_ptr<CommonAPI::DBus::DBusFactory>& factory,
const std::string& commonApiAddress,
const std::string& interfaceName,
const std::string& busName,
const std::string& objectPath,
const std::shared_ptr<CommonAPI::DBus::DBusProxyConnection>& dbusProxyConnection,
const std::shared_ptr<CommonAPI::StubBase>& stubBase) {
- return std::make_shared<CommandControlDBusStubAdapter>(commonApiAddress, interfaceName, busName, objectPath, dbusProxyConnection, stubBase);
+ return std::make_shared<CommandControlDBusStubAdapter>(factory, commonApiAddress, interfaceName, busName, objectPath, dbusProxyConnection, stubBase);
}
__attribute__((constructor)) void registerCommandControlDBusStubAdapter(void) {
@@ -46,303 +42,610 @@ __attribute__((constructor)) void registerCommandControlDBusStubAdapter(void) {
}
CommandControlDBusStubAdapter::CommandControlDBusStubAdapter(
+ const std::shared_ptr<CommonAPI::DBus::DBusFactory>& factory,
const std::string& commonApiAddress,
const std::string& dbusInterfaceName,
const std::string& dbusBusName,
const std::string& dbusObjectPath,
const std::shared_ptr<CommonAPI::DBus::DBusProxyConnection>& dbusConnection,
const std::shared_ptr<CommonAPI::StubBase>& stub):
- CommandControlDBusStubAdapterHelper(commonApiAddress, dbusInterfaceName, dbusBusName, dbusObjectPath, dbusConnection, std::dynamic_pointer_cast<CommandControlStub>(stub)) {
+ CommandControlDBusStubAdapterHelper(factory, commonApiAddress, dbusInterfaceName, dbusBusName, dbusObjectPath,
+ dbusConnection, std::dynamic_pointer_cast<CommandControlStub>(stub),
+ NULL)
+ {
+}
+
+CommandControlDBusStubAdapter::~CommandControlDBusStubAdapter() {
+ deactivateManagedInstances();
+ deinit();
+ stub_.reset();
+}
+
+void CommandControlDBusStubAdapter::deactivateManagedInstances() {
}
const char* CommandControlDBusStubAdapter::getMethodsDBusIntrospectionXmlData() const {
- return
+ static const char* introspectionData =
+ /**
+ * Callback that is called when the number of connections change
+ */
"<signal name=\"newMainConnection\">\n"
"<arg name=\"mainConnection\" type=\"(qqqni)\" />\n"
"</signal>\n"
+ /**
+ * Callback that is called when the number of connections change
+ */
"<signal name=\"removedMainConnection\">\n"
"<arg name=\"mainConnection\" type=\"q\" />\n"
"</signal>\n"
+ /**
+ * Callback that is called when the number of sinks change
+ */
"<signal name=\"newSink\">\n"
"<arg name=\"sink\" type=\"(qs(iq)niq)\" />\n"
"</signal>\n"
+ /**
+ * Callback that is called when the number of sinks change
+ */
"<signal name=\"removedSink\">\n"
"<arg name=\"sinkID\" type=\"q\" />\n"
"</signal>\n"
+ /**
+ * Callback that is called when the number of sources change
+ */
"<signal name=\"newSource\">\n"
"<arg name=\"source\" type=\"(qs(iq)q)\" />\n"
"</signal>\n"
+ /**
+ * Callback that is called when the number of sources change
+ */
"<signal name=\"removedSource\">\n"
"<arg name=\"source\" type=\"q\" />\n"
"</signal>\n"
+ /**
+ * this callback is fired if the number of sink classes changed
+ */
"<signal name=\"numberOfSinkClassesChanged\">\n"
"</signal>\n"
+ /**
+ * this callback is fired if the number of source classes changed
+ */
"<signal name=\"numberOfSourceClassesChanged\">\n"
"</signal>\n"
+ /**
+ * This callback is called when the ConnectionState of a connection changed.
+ */
"<signal name=\"mainConnectionStateChanged\">\n"
"<arg name=\"connectionID\" type=\"q\" />\n"
"<arg name=\"connectionState\" type=\"i\" />\n"
"</signal>\n"
+ /**
+ * this callback indicates that a sinkSoundProperty has changed.
+ */
"<signal name=\"mainSinkSoundPropertyChanged\">\n"
"<arg name=\"sinkID\" type=\"q\" />\n"
"<arg name=\"soundProperty\" type=\"(qn)\" />\n"
"</signal>\n"
+ /**
+ * this callback indicates that a sourceSoundProperty has changed.
+ */
"<signal name=\"mainSourceSoundPropertyChanged\">\n"
"<arg name=\"sourceID\" type=\"q\" />\n"
"<arg name=\"soundProperty\" type=\"(qn)\" />\n"
"</signal>\n"
+ /**
+ * this callback is called when the availability of a sink has changed
+ */
"<signal name=\"sinkAvailabilityChanged\">\n"
"<arg name=\"sinkID\" type=\"q\" />\n"
"<arg name=\"availability\" type=\"(iq)\" />\n"
"</signal>\n"
+ /**
+ * this callback is called when the availability of source has changed.
+ */
"<signal name=\"sourceAvailabilityChanged\">\n"
"<arg name=\"sourceID\" type=\"q\" />\n"
"<arg name=\"availability\" type=\"(iq)\" />\n"
"</signal>\n"
+ /**
+ * this callback indicates a volume change on the indicated sink
+ */
"<signal name=\"volumeChanged\">\n"
"<arg name=\"sinkID\" type=\"q\" />\n"
"<arg name=\"volume\" type=\"n\" />\n"
"</signal>\n"
+ /**
+ * this callback indicates a mute state change on a sink.
+ */
"<signal name=\"sinkMuteStateChanged\">\n"
"<arg name=\"sinkID\" type=\"q\" />\n"
"<arg name=\"muteState\" type=\"i\" />\n"
"</signal>\n"
+ /**
+ * is fired if a systemProperty changed
+ */
"<signal name=\"systemPropertyChanged\">\n"
"<arg name=\"systemProperty\" type=\"(qn)\" />\n"
"</signal>\n"
+ /**
+ * This callback is fired if the timinginformation for a mainConnectionID changed
+ */
"<signal name=\"timingInformationChanged\">\n"
"<arg name=\"mainConnectionID\" type=\"q\" />\n"
"<arg name=\"time\" type=\"n\" />\n"
"</signal>\n"
+ /**
+ * This callback is called when a sink is updated.
+ */
"<signal name=\"sinkUpdated\">\n"
"<arg name=\"sinkID\" type=\"q\" />\n"
"<arg name=\"sinkClassID\" type=\"q\" />\n"
"<arg name=\"listMainSoundProperties\" type=\"a(qn)\" />\n"
"</signal>\n"
+ /**
+ * This callback is called when a source is updated.
+ */
"<signal name=\"sourceUpdated\">\n"
"<arg name=\"sourceID\" type=\"q\" />\n"
"<arg name=\"sourceClassID\" type=\"q\" />\n"
"<arg name=\"listMainSoundProperties\" type=\"a(qn)\" />\n"
"</signal>\n"
+ /**
+ * This callback is called when a notificated value of a sink changes.
+ */
"<signal name=\"sinkNotification\">\n"
"<arg name=\"sinkID\" type=\"q\" />\n"
"<arg name=\"notification\" type=\"(qn)\" />\n"
"</signal>\n"
+ /**
+ * This callback is called when a notifcated value of a source changes.
+ */
"<signal name=\"sourceNotification\">\n"
"<arg name=\"sourceID\" type=\"q\" />\n"
"<arg name=\"notification\" type=\"(qn)\" />\n"
"</signal>\n"
+ /**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
"<signal name=\"mainSinkNotificationConfigurationChanged\">\n"
"<arg name=\"sinkID\" type=\"q\" />\n"
"<arg name=\"mainNotificationConfiguration\" type=\"(qin)\" />\n"
"</signal>\n"
+ /**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
"<signal name=\"mainSourceNotificationConfigurationChanged\">\n"
"<arg name=\"sourceID\" type=\"q\" />\n"
"<arg name=\"mainNotificationConfiguration\" type=\"(qin)\" />\n"
"</signal>\n"
+ /**
+ * 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 name=\"connect\">\n"
"<arg name=\"sourceID\" type=\"q\" direction=\"in\" />\n"
"<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n"
"<arg name=\"mainConnectionID\" type=\"q\" direction=\"out\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * disconnects a mainConnection
+ (at)return E_OK on successes, E_NON_EXISTENT if
+ * the connection does not exist, E_NOT_POSSIBLE on error.
+ */
"<method name=\"disconnect\">\n"
"<arg name=\"mainConnectionID\" type=\"q\" direction=\"in\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * 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 name=\"setVolume\">\n"
"<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n"
"<arg name=\"volume\" type=\"n\" direction=\"in\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * 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 name=\"volumeStep\">\n"
"<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n"
- "<arg name=\"volumeStep\" type=\"n\" direction=\"in\" />\n"
+ "<arg name=\"volumeStep_\" type=\"n\" direction=\"in\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * 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 name=\"setSinkMuteState\">\n"
"<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n"
"<arg name=\"muteState\" type=\"i\" direction=\"in\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * 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 name=\"setMainSinkSoundProperty\">\n"
"<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n"
"<arg name=\"soundProperty\" type=\"(qn)\" direction=\"in\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * 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 name=\"setMainSourceSoundProperty\">\n"
"<arg name=\"sourceID\" type=\"q\" direction=\"in\" />\n"
"<arg name=\"soundProperty\" type=\"(qn)\" direction=\"in\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * 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 name=\"setSystemProperty\">\n"
"<arg name=\"property\" type=\"(qn)\" direction=\"in\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * returns the actual list of MainConnections
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
"<method name=\"getListMainConnections\">\n"
"<arg name=\"listConnections\" type=\"a(qqqni)\" direction=\"out\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * returns the actual list of Sinks
+ (at)return E_OK on success, E_DATABASE_ERROR
+ * on error
+ */
"<method name=\"getListMainSinks\">\n"
"<arg name=\"listMainSinks\" type=\"a(qs(iq)niq)\" direction=\"out\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * returns the actual list of Sources
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
"<method name=\"getListMainSources\">\n"
"<arg name=\"listMainSources\" type=\"a(qs(iq)q)\" direction=\"out\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * 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 name=\"getListMainSinkSoundProperties\">\n"
"<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n"
"<arg name=\"listSoundProperties\" type=\"a(qn)\" direction=\"out\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * 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 name=\"getListMainSourceSoundProperties\">\n"
"<arg name=\"sourceID\" type=\"q\" direction=\"in\" />\n"
"<arg name=\"listSourceProperties\" type=\"a(qn)\" direction=\"out\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * This is used to retrieve SourceClass Information of all source classes
+ *
+ (at)return E_OK on success, E_DATABASE_ERROR on error
+ */
"<method name=\"getListSourceClasses\">\n"
"<arg name=\"listSourceClasses\" type=\"a(qsa(qn))\" direction=\"out\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * This is used to retrieve SinkClass Information of all sink classes
+ (at)return
+ * E_OK on success, E_DATABASE_ERROR on error
+ */
"<method name=\"getListSinkClasses\">\n"
"<arg name=\"listSinkClasses\" type=\"a(qsa(qn))\" direction=\"out\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * Retrieves a complete list of all systemProperties.
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
"<method name=\"getListSystemProperties\">\n"
"<arg name=\"listSystemProperties\" type=\"a(qn)\" direction=\"out\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * 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 name=\"getTimingInformation\">\n"
"<arg name=\"mainConnectionID\" type=\"q\" direction=\"in\" />\n"
"<arg name=\"delay\" type=\"n\" direction=\"out\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * Retrieves the list of MainNotifications for a sink. Does not return the
+ * possible ones.
+ */
"<method name=\"getListMainSinkNotificationConfigurations\">\n"
"<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n"
"<arg name=\"listMainNotificationConfigurations\" type=\"a(qin)\" direction=\"out\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * Retrieves the list of MainNotifications for a source. Does not return the
+ * possible ones.
+ */
"<method name=\"getListMainSourceNotificationConfigurations\">\n"
"<arg name=\"sourceID\" type=\"q\" direction=\"in\" />\n"
"<arg name=\"listMainNotificationConfigurations\" type=\"a(qin)\" direction=\"out\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * 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 name=\"setMainSinkNotificationConfiguration\">\n"
"<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n"
"<arg name=\"mainNotificationConfiguration\" type=\"(qin)\" direction=\"in\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
+ /**
+ * 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 name=\"setMainSourceNotificationConfiguration\">\n"
"<arg name=\"sourceID\" type=\"q\" direction=\"in\" />\n"
"<arg name=\"mainNotificationConfiguration\" type=\"(qin)\" direction=\"in\" />\n"
"<arg name=\"error\" type=\"i\" direction=\"out\" />\n"
"</method>\n"
;
+ return introspectionData;
}
+/**
+ * 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
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<am_sourceID_t, am_sinkID_t>,
std::tuple<am_mainConnectionID_t, am_Error_e>
> connectStubDispatcher(&CommandControlStub::connect, "qi");
+/**
+ * disconnects a mainConnection
+(at)return E_OK on successes, E_NON_EXISTENT if
+ * the connection does not exist, E_NOT_POSSIBLE on error.
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<am_mainConnectionID_t>,
std::tuple<am_Error_e>
> disconnectStubDispatcher(&CommandControlStub::disconnect, "i");
+/**
+ * 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
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<am_sinkID_t, am_mainVolume_t>,
std::tuple<am_Error_e>
> setVolumeStubDispatcher(&CommandControlStub::setVolume, "i");
+/**
+ * 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.
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<am_sinkID_t, int16_t>,
std::tuple<am_Error_e>
> volumeStepStubDispatcher(&CommandControlStub::volumeStep, "i");
+/**
+ * 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.
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<am_sinkID_t, am_MuteState_e>,
std::tuple<am_Error_e>
> setSinkMuteStateStubDispatcher(&CommandControlStub::setSinkMuteState, "i");
+/**
+ * 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
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<am_sinkID_t, am_MainSoundProperty_s>,
std::tuple<am_Error_e>
> setMainSinkSoundPropertyStubDispatcher(&CommandControlStub::setMainSinkSoundProperty, "i");
+/**
+ * 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
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<am_sourceID_t, am_MainSoundProperty_s>,
std::tuple<am_Error_e>
> setMainSourceSoundPropertyStubDispatcher(&CommandControlStub::setMainSourceSoundProperty, "i");
+/**
+ * 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
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<am_SystemProperty_s>,
std::tuple<am_Error_e>
> setSystemPropertyStubDispatcher(&CommandControlStub::setSystemProperty, "i");
+/**
+ * returns the actual list of MainConnections
+(at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<>,
std::tuple<am_MainConnection_L, am_Error_e>
> getListMainConnectionsStubDispatcher(&CommandControlStub::getListMainConnections, "a(qqqni)i");
+/**
+ * returns the actual list of Sinks
+(at)return E_OK on success, E_DATABASE_ERROR
+ * on error
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<>,
std::tuple<am_SinkType_L, am_Error_e>
> getListMainSinksStubDispatcher(&CommandControlStub::getListMainSinks, "a(qs(iq)niq)i");
+/**
+ * returns the actual list of Sources
+(at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<>,
std::tuple<am_SourceType_L, am_Error_e>
> getListMainSourcesStubDispatcher(&CommandControlStub::getListMainSources, "a(qs(iq)q)i");
+/**
+ * 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
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<am_sinkID_t>,
std::tuple<am_MainSoundProperty_L, am_Error_e>
> getListMainSinkSoundPropertiesStubDispatcher(&CommandControlStub::getListMainSinkSoundProperties, "a(qn)i");
+/**
+ * This is used to retrieve all source sound properties related to a
+ * source.
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<am_sourceID_t>,
std::tuple<am_MainSoundProperty_L, am_Error_e>
> getListMainSourceSoundPropertiesStubDispatcher(&CommandControlStub::getListMainSourceSoundProperties, "a(qn)i");
+/**
+ * This is used to retrieve SourceClass Information of all source classes
+ *
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<>,
std::tuple<am_SourceClass_L, am_Error_e>
> getListSourceClassesStubDispatcher(&CommandControlStub::getListSourceClasses, "a(qsa(qn))i");
+/**
+ * This is used to retrieve SinkClass Information of all sink classes
+(at)return
+ * E_OK on success, E_DATABASE_ERROR on error
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<>,
std::tuple<am_SinkClass_L, am_Error_e>
> getListSinkClassesStubDispatcher(&CommandControlStub::getListSinkClasses, "a(qsa(qn))i");
+/**
+ * Retrieves a complete list of all systemProperties.
+(at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<>,
std::tuple<am_SystemProperty_L, am_Error_e>
> getListSystemPropertiesStubDispatcher(&CommandControlStub::getListSystemProperties, "a(qn)i");
+/**
+ * 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
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<am_mainConnectionID_t>,
std::tuple<am_timeSync_t, am_Error_e>
> getTimingInformationStubDispatcher(&CommandControlStub::getTimingInformation, "ni");
+/**
+ * Retrieves the list of MainNotifications for a sink. Does not return the
+ * possible ones.
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<am_sinkID_t>,
std::tuple<am_NotificationConfiguration_L, am_Error_e>
> getListMainSinkNotificationConfigurationsStubDispatcher(&CommandControlStub::getListMainSinkNotificationConfigurations, "a(qin)i");
+/**
+ * Retrieves the list of MainNotifications for a source. Does not return the
+ * possible ones.
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<am_sourceID_t>,
std::tuple<am_NotificationConfiguration_L, am_Error_e>
> getListMainSourceNotificationConfigurationsStubDispatcher(&CommandControlStub::getListMainSourceNotificationConfigurations, "a(qin)i");
+/**
+ * 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
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<am_sinkID_t, am_NotificationConfiguration_s>,
std::tuple<am_Error_e>
> setMainSinkNotificationConfigurationStubDispatcher(&CommandControlStub::setMainSinkNotificationConfiguration, "i");
+/**
+ * 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
+ */
static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
CommandControlStub,
std::tuple<am_sourceID_t, am_NotificationConfiguration_s>,
@@ -350,6 +653,9 @@ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher<
> setMainSourceNotificationConfigurationStubDispatcher(&CommandControlStub::setMainSourceNotificationConfiguration, "i");
+/**
+ * Callback that is called when the number of connections change
+ */
void CommandControlDBusStubAdapter::fireNewMainConnectionEvent(const am_MainConnectionType_s& mainConnection) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_MainConnectionType_s>>
::sendSignal(
@@ -359,6 +665,9 @@ void CommandControlDBusStubAdapter::fireNewMainConnectionEvent(const am_MainConn
mainConnection
);
}
+/**
+ * Callback that is called when the number of connections change
+ */
void CommandControlDBusStubAdapter::fireRemovedMainConnectionEvent(const am_mainConnectionID_t& mainConnection) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_mainConnectionID_t>>
::sendSignal(
@@ -368,6 +677,9 @@ void CommandControlDBusStubAdapter::fireRemovedMainConnectionEvent(const am_main
mainConnection
);
}
+/**
+ * Callback that is called when the number of sinks change
+ */
void CommandControlDBusStubAdapter::fireNewSinkEvent(const am_SinkType_s& sink) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_SinkType_s>>
::sendSignal(
@@ -377,6 +689,9 @@ void CommandControlDBusStubAdapter::fireNewSinkEvent(const am_SinkType_s& sink)
sink
);
}
+/**
+ * Callback that is called when the number of sinks change
+ */
void CommandControlDBusStubAdapter::fireRemovedSinkEvent(const am_sinkID_t& sinkID) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t>>
::sendSignal(
@@ -386,6 +701,9 @@ void CommandControlDBusStubAdapter::fireRemovedSinkEvent(const am_sinkID_t& sink
sinkID
);
}
+/**
+ * Callback that is called when the number of sources change
+ */
void CommandControlDBusStubAdapter::fireNewSourceEvent(const am_SourceType_s& source) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_SourceType_s>>
::sendSignal(
@@ -395,6 +713,9 @@ void CommandControlDBusStubAdapter::fireNewSourceEvent(const am_SourceType_s& so
source
);
}
+/**
+ * Callback that is called when the number of sources change
+ */
void CommandControlDBusStubAdapter::fireRemovedSourceEvent(const am_sourceID_t& source) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t>>
::sendSignal(
@@ -404,6 +725,9 @@ void CommandControlDBusStubAdapter::fireRemovedSourceEvent(const am_sourceID_t&
source
);
}
+/**
+ * this callback is fired if the number of sink classes changed
+ */
void CommandControlDBusStubAdapter::fireNumberOfSinkClassesChangedEvent() {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<>>
::sendSignal(
@@ -412,6 +736,9 @@ void CommandControlDBusStubAdapter::fireNumberOfSinkClassesChangedEvent() {
""
);
}
+/**
+ * this callback is fired if the number of source classes changed
+ */
void CommandControlDBusStubAdapter::fireNumberOfSourceClassesChangedEvent() {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<>>
::sendSignal(
@@ -420,6 +747,9 @@ void CommandControlDBusStubAdapter::fireNumberOfSourceClassesChangedEvent() {
""
);
}
+/**
+ * This callback is called when the ConnectionState of a connection changed.
+ */
void CommandControlDBusStubAdapter::fireMainConnectionStateChangedEvent(const am_mainConnectionID_t& connectionID, const am_ConnectionState_e& connectionState) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_mainConnectionID_t, am_ConnectionState_e>>
::sendSignal(
@@ -429,6 +759,9 @@ void CommandControlDBusStubAdapter::fireMainConnectionStateChangedEvent(const am
connectionID, connectionState
);
}
+/**
+ * this callback indicates that a sinkSoundProperty has changed.
+ */
void CommandControlDBusStubAdapter::fireMainSinkSoundPropertyChangedEvent(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_MainSoundProperty_s>>
::sendSignal(
@@ -438,6 +771,9 @@ void CommandControlDBusStubAdapter::fireMainSinkSoundPropertyChangedEvent(const
sinkID, soundProperty
);
}
+/**
+ * this callback indicates that a sourceSoundProperty has changed.
+ */
void CommandControlDBusStubAdapter::fireMainSourceSoundPropertyChangedEvent(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t, am_MainSoundProperty_s>>
::sendSignal(
@@ -447,6 +783,9 @@ void CommandControlDBusStubAdapter::fireMainSourceSoundPropertyChangedEvent(cons
sourceID, soundProperty
);
}
+/**
+ * this callback is called when the availability of a sink has changed
+ */
void CommandControlDBusStubAdapter::fireSinkAvailabilityChangedEvent(const am_sinkID_t& sinkID, const am_Availability_s& availability) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_Availability_s>>
::sendSignal(
@@ -456,6 +795,9 @@ void CommandControlDBusStubAdapter::fireSinkAvailabilityChangedEvent(const am_si
sinkID, availability
);
}
+/**
+ * this callback is called when the availability of source has changed.
+ */
void CommandControlDBusStubAdapter::fireSourceAvailabilityChangedEvent(const am_sourceID_t& sourceID, const am_Availability_s& availability) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t, am_Availability_s>>
::sendSignal(
@@ -465,6 +807,9 @@ void CommandControlDBusStubAdapter::fireSourceAvailabilityChangedEvent(const am_
sourceID, availability
);
}
+/**
+ * this callback indicates a volume change on the indicated sink
+ */
void CommandControlDBusStubAdapter::fireVolumeChangedEvent(const am_sinkID_t& sinkID, const am_mainVolume_t& volume) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_mainVolume_t>>
::sendSignal(
@@ -474,6 +819,9 @@ void CommandControlDBusStubAdapter::fireVolumeChangedEvent(const am_sinkID_t& si
sinkID, volume
);
}
+/**
+ * this callback indicates a mute state change on a sink.
+ */
void CommandControlDBusStubAdapter::fireSinkMuteStateChangedEvent(const am_sinkID_t& sinkID, const am_MuteState_e& muteState) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_MuteState_e>>
::sendSignal(
@@ -483,6 +831,9 @@ void CommandControlDBusStubAdapter::fireSinkMuteStateChangedEvent(const am_sinkI
sinkID, muteState
);
}
+/**
+ * is fired if a systemProperty changed
+ */
void CommandControlDBusStubAdapter::fireSystemPropertyChangedEvent(const am_SystemProperty_s& systemProperty) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_SystemProperty_s>>
::sendSignal(
@@ -492,6 +843,9 @@ void CommandControlDBusStubAdapter::fireSystemPropertyChangedEvent(const am_Syst
systemProperty
);
}
+/**
+ * This callback is fired if the timinginformation for a mainConnectionID changed
+ */
void CommandControlDBusStubAdapter::fireTimingInformationChangedEvent(const am_mainConnectionID_t& mainConnectionID, const am_timeSync_t& time) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_mainConnectionID_t, am_timeSync_t>>
::sendSignal(
@@ -501,6 +855,9 @@ void CommandControlDBusStubAdapter::fireTimingInformationChangedEvent(const am_m
mainConnectionID, time
);
}
+/**
+ * This callback is called when a sink is updated.
+ */
void CommandControlDBusStubAdapter::fireSinkUpdatedEvent(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_MainSoundProperty_L& listMainSoundProperties) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_sinkClass_t, am_MainSoundProperty_L>>
::sendSignal(
@@ -510,6 +867,9 @@ void CommandControlDBusStubAdapter::fireSinkUpdatedEvent(const am_sinkID_t& sink
sinkID, sinkClassID, listMainSoundProperties
);
}
+/**
+ * This callback is called when a source is updated.
+ */
void CommandControlDBusStubAdapter::fireSourceUpdatedEvent(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_MainSoundProperty_L& listMainSoundProperties) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t, am_sourceClass_t, am_MainSoundProperty_L>>
::sendSignal(
@@ -519,6 +879,9 @@ void CommandControlDBusStubAdapter::fireSourceUpdatedEvent(const am_sourceID_t&
sourceID, sourceClassID, listMainSoundProperties
);
}
+/**
+ * This callback is called when a notificated value of a sink changes.
+ */
void CommandControlDBusStubAdapter::fireSinkNotificationEvent(const am_sinkID_t& sinkID, const am_NotificationPayload_s& notification) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_NotificationPayload_s>>
::sendSignal(
@@ -528,6 +891,9 @@ void CommandControlDBusStubAdapter::fireSinkNotificationEvent(const am_sinkID_t&
sinkID, notification
);
}
+/**
+ * This callback is called when a notifcated value of a source changes.
+ */
void CommandControlDBusStubAdapter::fireSourceNotificationEvent(const am_sourceID_t& sourceID, const am_NotificationPayload_s& notification) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t, am_NotificationPayload_s>>
::sendSignal(
@@ -537,6 +903,9 @@ void CommandControlDBusStubAdapter::fireSourceNotificationEvent(const am_sourceI
sourceID, notification
);
}
+/**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
void CommandControlDBusStubAdapter::fireMainSinkNotificationConfigurationChangedEvent(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_NotificationConfiguration_s>>
::sendSignal(
@@ -546,6 +915,9 @@ void CommandControlDBusStubAdapter::fireMainSinkNotificationConfigurationChanged
sinkID, mainNotificationConfiguration
);
}
+/**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
void CommandControlDBusStubAdapter::fireMainSourceNotificationConfigurationChangedEvent(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration) {
CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t, am_NotificationConfiguration_s>>
::sendSignal(
@@ -556,31 +928,146 @@ void CommandControlDBusStubAdapter::fireMainSourceNotificationConfigurationChang
);
}
+const CommandControlDBusStubAdapter::StubDispatcherTable& CommandControlDBusStubAdapter::getStubDispatcherTable() {
+ static const CommandControlDBusStubAdapter::StubDispatcherTable stubDispatcherTable = {
+ /**
+ * 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
+ */
+ { { "connect", "qq" }, &org::genivi::am::connectStubDispatcher },
+ /**
+ * disconnects a mainConnection
+ (at)return E_OK on successes, E_NON_EXISTENT if
+ * the connection does not exist, E_NOT_POSSIBLE on error.
+ */
+ { { "disconnect", "q" }, &org::genivi::am::disconnectStubDispatcher },
+ /**
+ * 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
+ */
+ { { "setVolume", "qn" }, &org::genivi::am::setVolumeStubDispatcher },
+ /**
+ * 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.
+ */
+ { { "volumeStep", "qn" }, &org::genivi::am::volumeStepStubDispatcher },
+ /**
+ * 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.
+ */
+ { { "setSinkMuteState", "qi" }, &org::genivi::am::setSinkMuteStateStubDispatcher },
+ /**
+ * 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
+ */
+ { { "setMainSinkSoundProperty", "q(qn)" }, &org::genivi::am::setMainSinkSoundPropertyStubDispatcher },
+ /**
+ * 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
+ */
+ { { "setMainSourceSoundProperty", "q(qn)" }, &org::genivi::am::setMainSourceSoundPropertyStubDispatcher },
+ /**
+ * 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
+ */
+ { { "setSystemProperty", "(qn)" }, &org::genivi::am::setSystemPropertyStubDispatcher },
+ /**
+ * returns the actual list of MainConnections
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
+ { { "getListMainConnections", "" }, &org::genivi::am::getListMainConnectionsStubDispatcher },
+ /**
+ * returns the actual list of Sinks
+ (at)return E_OK on success, E_DATABASE_ERROR
+ * on error
+ */
+ { { "getListMainSinks", "" }, &org::genivi::am::getListMainSinksStubDispatcher },
+ /**
+ * returns the actual list of Sources
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
+ { { "getListMainSources", "" }, &org::genivi::am::getListMainSourcesStubDispatcher },
+ /**
+ * 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
+ */
+ { { "getListMainSinkSoundProperties", "q" }, &org::genivi::am::getListMainSinkSoundPropertiesStubDispatcher },
+ /**
+ * This is used to retrieve all source sound properties related to a
+ * source.
+ (at)return E_OK on success, E_DATABASE_ERROR on error
+ */
+ { { "getListMainSourceSoundProperties", "q" }, &org::genivi::am::getListMainSourceSoundPropertiesStubDispatcher },
+ /**
+ * This is used to retrieve SourceClass Information of all source classes
+ *
+ (at)return E_OK on success, E_DATABASE_ERROR on error
+ */
+ { { "getListSourceClasses", "" }, &org::genivi::am::getListSourceClassesStubDispatcher },
+ /**
+ * This is used to retrieve SinkClass Information of all sink classes
+ (at)return
+ * E_OK on success, E_DATABASE_ERROR on error
+ */
+ { { "getListSinkClasses", "" }, &org::genivi::am::getListSinkClassesStubDispatcher },
+ /**
+ * Retrieves a complete list of all systemProperties.
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
+ { { "getListSystemProperties", "" }, &org::genivi::am::getListSystemPropertiesStubDispatcher },
+ /**
+ * 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
+ */
+ { { "getTimingInformation", "q" }, &org::genivi::am::getTimingInformationStubDispatcher },
+ /**
+ * Retrieves the list of MainNotifications for a sink. Does not return the
+ * possible ones.
+ */
+ { { "getListMainSinkNotificationConfigurations", "q" }, &org::genivi::am::getListMainSinkNotificationConfigurationsStubDispatcher },
+ /**
+ * Retrieves the list of MainNotifications for a source. Does not return the
+ * possible ones.
+ */
+ { { "getListMainSourceNotificationConfigurations", "q" }, &org::genivi::am::getListMainSourceNotificationConfigurationsStubDispatcher },
+ /**
+ * 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
+ */
+ { { "setMainSinkNotificationConfiguration", "q(qin)" }, &org::genivi::am::setMainSinkNotificationConfigurationStubDispatcher },
+ /**
+ * 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
+ */
+ { { "setMainSourceNotificationConfiguration", "q(qin)" }, &org::genivi::am::setMainSourceNotificationConfigurationStubDispatcher }
+ };
+ return stubDispatcherTable;
+}
+
+
} // namespace am
} // namespace genivi
} // namespace org
-
-template<>
-const org::genivi::am::CommandControlDBusStubAdapterHelper::StubDispatcherTable org::genivi::am::CommandControlDBusStubAdapterHelper::stubDispatcherTable_ = {
- { { "connect", "qq" }, &org::genivi::am::connectStubDispatcher },
- { { "disconnect", "q" }, &org::genivi::am::disconnectStubDispatcher },
- { { "setVolume", "qn" }, &org::genivi::am::setVolumeStubDispatcher },
- { { "volumeStep", "qn" }, &org::genivi::am::volumeStepStubDispatcher },
- { { "setSinkMuteState", "qi" }, &org::genivi::am::setSinkMuteStateStubDispatcher },
- { { "setMainSinkSoundProperty", "q(qn)" }, &org::genivi::am::setMainSinkSoundPropertyStubDispatcher },
- { { "setMainSourceSoundProperty", "q(qn)" }, &org::genivi::am::setMainSourceSoundPropertyStubDispatcher },
- { { "setSystemProperty", "(qn)" }, &org::genivi::am::setSystemPropertyStubDispatcher },
- { { "getListMainConnections", "" }, &org::genivi::am::getListMainConnectionsStubDispatcher },
- { { "getListMainSinks", "" }, &org::genivi::am::getListMainSinksStubDispatcher },
- { { "getListMainSources", "" }, &org::genivi::am::getListMainSourcesStubDispatcher },
- { { "getListMainSinkSoundProperties", "q" }, &org::genivi::am::getListMainSinkSoundPropertiesStubDispatcher },
- { { "getListMainSourceSoundProperties", "q" }, &org::genivi::am::getListMainSourceSoundPropertiesStubDispatcher },
- { { "getListSourceClasses", "" }, &org::genivi::am::getListSourceClassesStubDispatcher },
- { { "getListSinkClasses", "" }, &org::genivi::am::getListSinkClassesStubDispatcher },
- { { "getListSystemProperties", "" }, &org::genivi::am::getListSystemPropertiesStubDispatcher },
- { { "getTimingInformation", "q" }, &org::genivi::am::getTimingInformationStubDispatcher },
- { { "getListMainSinkNotificationConfigurations", "q" }, &org::genivi::am::getListMainSinkNotificationConfigurationsStubDispatcher },
- { { "getListMainSourceNotificationConfigurations", "q" }, &org::genivi::am::getListMainSourceNotificationConfigurationsStubDispatcher },
- { { "setMainSinkNotificationConfiguration", "q(qin)" }, &org::genivi::am::setMainSinkNotificationConfigurationStubDispatcher },
- { { "setMainSourceNotificationConfiguration", "q(qin)" }, &org::genivi::am::setMainSourceNotificationConfigurationStubDispatcher }
-};
diff --git a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusStubAdapter.h b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusStubAdapter.h
index d51fdd7..851f12b 100644
--- a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusStubAdapter.h
+++ b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlDBusStubAdapter.h
@@ -1,37 +1,44 @@
/*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* 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/.
-*
+* This file was generated by the CommonAPI Generators.
+* Used org.genivi.commonapi.core 2.1.1.201309251246.
+* Used org.franca.core 0.8.9.201308271211.
*
+* Copyright (c) 2012 BMW
+*
* \author Aleksandar Donchev, aleksander.donchev@partner.bmw.de BMW 2013
-* \author Christian Linke christian.linke@bmw.de BMW 2013
-*
+*
+* \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.
+*
* For further information see http://www.genivi.org/.
*/
+/**
+ * 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
+ */
#ifndef ORG_GENIVI_AM_Command_Control_DBUS_STUB_ADAPTER_H_
#define ORG_GENIVI_AM_Command_Control_DBUS_STUB_ADAPTER_H_
#include <org/genivi/am/CommandControlStub.h>
+#if !defined (COMMONAPI_INTERNAL_COMPILATION)
#define COMMONAPI_INTERNAL_COMPILATION
+#endif
#include <CommonAPI/DBus/DBusStubAdapterHelper.h>
+#include <CommonAPI/DBus/DBusStubAdapter.h>
#include <CommonAPI/DBus/DBusFactory.h>
+#include <CommonAPI/DBus/DBusServicePublisher.h>
#undef COMMONAPI_INTERNAL_COMPILATION
@@ -44,40 +51,119 @@ typedef CommonAPI::DBus::DBusStubAdapterHelper<CommandControlStub> CommandContro
class CommandControlDBusStubAdapter: public CommandControlStubAdapter, public CommandControlDBusStubAdapterHelper {
public:
CommandControlDBusStubAdapter(
+ const std::shared_ptr<CommonAPI::DBus::DBusFactory>& factory,
const std::string& commonApiAddress,
const std::string& dbusInterfaceName,
const std::string& dbusBusName,
const std::string& dbusObjectPath,
const std::shared_ptr<CommonAPI::DBus::DBusProxyConnection>& dbusConnection,
const std::shared_ptr<CommonAPI::StubBase>& stub);
-
+ ~CommandControlDBusStubAdapter();
+
+
+ /**
+ * Callback that is called when the number of connections change
+ */
void fireNewMainConnectionEvent(const am_MainConnectionType_s& mainConnection);
+ /**
+ * Callback that is called when the number of connections change
+ */
void fireRemovedMainConnectionEvent(const am_mainConnectionID_t& mainConnection);
+ /**
+ * Callback that is called when the number of sinks change
+ */
void fireNewSinkEvent(const am_SinkType_s& sink);
+ /**
+ * Callback that is called when the number of sinks change
+ */
void fireRemovedSinkEvent(const am_sinkID_t& sinkID);
+ /**
+ * Callback that is called when the number of sources change
+ */
void fireNewSourceEvent(const am_SourceType_s& source);
+ /**
+ * Callback that is called when the number of sources change
+ */
void fireRemovedSourceEvent(const am_sourceID_t& source);
+ /**
+ * this callback is fired if the number of sink classes changed
+ */
void fireNumberOfSinkClassesChangedEvent();
+ /**
+ * this callback is fired if the number of source classes changed
+ */
void fireNumberOfSourceClassesChangedEvent();
+ /**
+ * This callback is called when the ConnectionState of a connection changed.
+ */
void fireMainConnectionStateChangedEvent(const am_mainConnectionID_t& connectionID, const am_ConnectionState_e& connectionState);
+ /**
+ * this callback indicates that a sinkSoundProperty has changed.
+ */
void fireMainSinkSoundPropertyChangedEvent(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty);
+ /**
+ * this callback indicates that a sourceSoundProperty has changed.
+ */
void fireMainSourceSoundPropertyChangedEvent(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty);
+ /**
+ * this callback is called when the availability of a sink has changed
+ */
void fireSinkAvailabilityChangedEvent(const am_sinkID_t& sinkID, const am_Availability_s& availability);
+ /**
+ * this callback is called when the availability of source has changed.
+ */
void fireSourceAvailabilityChangedEvent(const am_sourceID_t& sourceID, const am_Availability_s& availability);
+ /**
+ * this callback indicates a volume change on the indicated sink
+ */
void fireVolumeChangedEvent(const am_sinkID_t& sinkID, const am_mainVolume_t& volume);
+ /**
+ * this callback indicates a mute state change on a sink.
+ */
void fireSinkMuteStateChangedEvent(const am_sinkID_t& sinkID, const am_MuteState_e& muteState);
+ /**
+ * is fired if a systemProperty changed
+ */
void fireSystemPropertyChangedEvent(const am_SystemProperty_s& systemProperty);
+ /**
+ * This callback is fired if the timinginformation for a mainConnectionID changed
+ */
void fireTimingInformationChangedEvent(const am_mainConnectionID_t& mainConnectionID, const am_timeSync_t& time);
+ /**
+ * This callback is called when a sink is updated.
+ */
void fireSinkUpdatedEvent(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_MainSoundProperty_L& listMainSoundProperties);
+ /**
+ * This callback is called when a source is updated.
+ */
void fireSourceUpdatedEvent(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_MainSoundProperty_L& listMainSoundProperties);
+ /**
+ * This callback is called when a notificated value of a sink changes.
+ */
void fireSinkNotificationEvent(const am_sinkID_t& sinkID, const am_NotificationPayload_s& notification);
+ /**
+ * This callback is called when a notifcated value of a source changes.
+ */
void fireSourceNotificationEvent(const am_sourceID_t& sourceID, const am_NotificationPayload_s& notification);
+ /**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
void fireMainSinkNotificationConfigurationChangedEvent(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration);
+ /**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
void fireMainSourceNotificationConfigurationChangedEvent(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration);
+
+
+ const StubDispatcherTable& getStubDispatcherTable();
+
+ void deactivateManagedInstances();
protected:
virtual const char* getMethodsDBusIntrospectionXmlData() const;
+
+ private:
};
} // namespace am
diff --git a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlProxy.h b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlProxy.h
index 8bcb7fe..9ad4d49 100644
--- a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlProxy.h
+++ b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlProxy.h
@@ -1,34 +1,39 @@
/*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* 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/.
-*
+* This file was generated by the CommonAPI Generators.
+* Used org.genivi.commonapi.core 2.1.1.201309251246.
+* Used org.franca.core 0.8.9.201308271211.
*
+* Copyright (c) 2012 BMW
+*
* \author Aleksandar Donchev, aleksander.donchev@partner.bmw.de BMW 2013
-* \author Christian Linke christian.linke@bmw.de BMW 2013
-*
+*
+* \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.
+*
* For further information see http://www.genivi.org/.
*/
+/**
+ * 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
+ */
#ifndef ORG_GENIVI_AM_Command_Control_PROXY_H_
#define ORG_GENIVI_AM_Command_Control_PROXY_H_
#include "CommandControlProxyBase.h"
+#if !defined (COMMONAPI_INTERNAL_COMPILATION)
#define COMMONAPI_INTERNAL_COMPILATION
+#endif
#undef COMMONAPI_INTERNAL_COMPILATION
@@ -44,132 +49,226 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
~CommandControlProxy();
- /// Returns the wrapper class that provides access to the broadcast newMainConnection.
+ /**
+ * Callback that is called when the number of connections change
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast newMainConnection.
+ */
virtual NewMainConnectionEvent& getNewMainConnectionEvent() {
return delegate_->getNewMainConnectionEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast removedMainConnection.
+ /**
+ * Callback that is called when the number of connections change
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast removedMainConnection.
+ */
virtual RemovedMainConnectionEvent& getRemovedMainConnectionEvent() {
return delegate_->getRemovedMainConnectionEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast newSink.
+ /**
+ * Callback that is called when the number of sinks change
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast newSink.
+ */
virtual NewSinkEvent& getNewSinkEvent() {
return delegate_->getNewSinkEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast removedSink.
+ /**
+ * Callback that is called when the number of sinks change
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast removedSink.
+ */
virtual RemovedSinkEvent& getRemovedSinkEvent() {
return delegate_->getRemovedSinkEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast newSource.
+ /**
+ * Callback that is called when the number of sources change
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast newSource.
+ */
virtual NewSourceEvent& getNewSourceEvent() {
return delegate_->getNewSourceEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast removedSource.
+ /**
+ * Callback that is called when the number of sources change
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast removedSource.
+ */
virtual RemovedSourceEvent& getRemovedSourceEvent() {
return delegate_->getRemovedSourceEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast numberOfSinkClassesChanged.
+ /**
+ * this callback is fired if the number of sink classes changed
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast numberOfSinkClassesChanged.
+ */
virtual NumberOfSinkClassesChangedEvent& getNumberOfSinkClassesChangedEvent() {
return delegate_->getNumberOfSinkClassesChangedEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast numberOfSourceClassesChanged.
+ /**
+ * this callback is fired if the number of source classes changed
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast numberOfSourceClassesChanged.
+ */
virtual NumberOfSourceClassesChangedEvent& getNumberOfSourceClassesChangedEvent() {
return delegate_->getNumberOfSourceClassesChangedEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast mainConnectionStateChanged.
+ /**
+ * This callback is called when the ConnectionState of a connection changed.
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast mainConnectionStateChanged.
+ */
virtual MainConnectionStateChangedEvent& getMainConnectionStateChangedEvent() {
return delegate_->getMainConnectionStateChangedEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast mainSinkSoundPropertyChanged.
+ /**
+ * this callback indicates that a sinkSoundProperty has changed.
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast mainSinkSoundPropertyChanged.
+ */
virtual MainSinkSoundPropertyChangedEvent& getMainSinkSoundPropertyChangedEvent() {
return delegate_->getMainSinkSoundPropertyChangedEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast mainSourceSoundPropertyChanged.
+ /**
+ * this callback indicates that a sourceSoundProperty has changed.
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast mainSourceSoundPropertyChanged.
+ */
virtual MainSourceSoundPropertyChangedEvent& getMainSourceSoundPropertyChangedEvent() {
return delegate_->getMainSourceSoundPropertyChangedEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast sinkAvailabilityChanged.
+ /**
+ * this callback is called when the availability of a sink has changed
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast sinkAvailabilityChanged.
+ */
virtual SinkAvailabilityChangedEvent& getSinkAvailabilityChangedEvent() {
return delegate_->getSinkAvailabilityChangedEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast sourceAvailabilityChanged.
+ /**
+ * this callback is called when the availability of source has changed.
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast sourceAvailabilityChanged.
+ */
virtual SourceAvailabilityChangedEvent& getSourceAvailabilityChangedEvent() {
return delegate_->getSourceAvailabilityChangedEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast volumeChanged.
+ /**
+ * this callback indicates a volume change on the indicated sink
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast volumeChanged.
+ */
virtual VolumeChangedEvent& getVolumeChangedEvent() {
return delegate_->getVolumeChangedEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast sinkMuteStateChanged.
+ /**
+ * this callback indicates a mute state change on a sink.
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast sinkMuteStateChanged.
+ */
virtual SinkMuteStateChangedEvent& getSinkMuteStateChangedEvent() {
return delegate_->getSinkMuteStateChangedEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast systemPropertyChanged.
+ /**
+ * is fired if a systemProperty changed
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast systemPropertyChanged.
+ */
virtual SystemPropertyChangedEvent& getSystemPropertyChangedEvent() {
return delegate_->getSystemPropertyChangedEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast timingInformationChanged.
+ /**
+ * This callback is fired if the timinginformation for a mainConnectionID changed
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast timingInformationChanged.
+ */
virtual TimingInformationChangedEvent& getTimingInformationChangedEvent() {
return delegate_->getTimingInformationChangedEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast sinkUpdated.
+ /**
+ * This callback is called when a sink is updated.
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast sinkUpdated.
+ */
virtual SinkUpdatedEvent& getSinkUpdatedEvent() {
return delegate_->getSinkUpdatedEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast sourceUpdated.
+ /**
+ * This callback is called when a source is updated.
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast sourceUpdated.
+ */
virtual SourceUpdatedEvent& getSourceUpdatedEvent() {
return delegate_->getSourceUpdatedEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast sinkNotification.
+ /**
+ * This callback is called when a notificated value of a sink changes.
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast sinkNotification.
+ */
virtual SinkNotificationEvent& getSinkNotificationEvent() {
return delegate_->getSinkNotificationEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast sourceNotification.
+ /**
+ * This callback is called when a notifcated value of a source changes.
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast sourceNotification.
+ */
virtual SourceNotificationEvent& getSourceNotificationEvent() {
return delegate_->getSourceNotificationEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast mainSinkNotificationConfigurationChanged.
+ /**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast mainSinkNotificationConfigurationChanged.
+ */
virtual MainSinkNotificationConfigurationChangedEvent& getMainSinkNotificationConfigurationChangedEvent() {
return delegate_->getMainSinkNotificationConfigurationChangedEvent();
}
-
- /// Returns the wrapper class that provides access to the broadcast mainSourceNotificationConfigurationChanged.
+ /**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
+ /**
+ * Returns the wrapper class that provides access to the broadcast mainSourceNotificationConfigurationChanged.
+ */
virtual MainSourceNotificationConfigurationChangedEvent& getMainSourceNotificationConfigurationChangedEvent() {
return delegate_->getMainSourceNotificationConfigurationChangedEvent();
}
-
-
/**
+ * 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
+ *
* Calls connect with synchronous semantics.
*
- * All const parameters are input parameters to this method.
- * All non-const parameters will be filled with the returned values.
+ * All const parameters are input parameters to this method.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void connect(const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_mainConnectionID_t& mainConnectionID, am_Error_e& error);
/**
@@ -183,16 +282,18 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> connectAsync(const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, ConnectAsyncCallback callback);
-
/**
+ * disconnects a mainConnection
+ (at)return E_OK on successes, E_NON_EXISTENT if
+ * the connection does not exist, E_NOT_POSSIBLE on error.
+ *
* Calls disconnect with synchronous semantics.
*
- * All const parameters are input parameters to this method.
- * All non-const parameters will be filled with the returned values.
+ * All const parameters are input parameters to this method.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void disconnect(const am_mainConnectionID_t& mainConnectionID, CommonAPI::CallStatus& callStatus, am_Error_e& error);
/**
@@ -206,16 +307,18 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> disconnectAsync(const am_mainConnectionID_t& mainConnectionID, DisconnectAsyncCallback callback);
-
/**
+ * 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
+ *
* Calls setVolume with synchronous semantics.
*
- * All const parameters are input parameters to this method.
- * All non-const parameters will be filled with the returned values.
+ * All const parameters are input parameters to this method.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void setVolume(const am_sinkID_t& sinkID, const am_mainVolume_t& volume, CommonAPI::CallStatus& callStatus, am_Error_e& error);
/**
@@ -229,18 +332,21 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> setVolumeAsync(const am_sinkID_t& sinkID, const am_mainVolume_t& volume, SetVolumeAsyncCallback callback);
-
/**
+ * 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.
+ *
* Calls volumeStep with synchronous semantics.
*
- * All const parameters are input parameters to this method.
- * All non-const parameters will be filled with the returned values.
+ * All const parameters are input parameters to this method.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
- virtual void volumeStep(const am_sinkID_t& sinkID, const int16_t& volumeStep, CommonAPI::CallStatus& callStatus, am_Error_e& error);
+ virtual void volumeStep(const am_sinkID_t& sinkID, const int16_t& volumeStep_, CommonAPI::CallStatus& callStatus, am_Error_e& error);
/**
* Calls volumeStep with asynchronous semantics.
*
@@ -251,17 +357,19 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* The std::future returned by this method will be fulfilled at arrival of the reply.
* It will provide the same value for CallStatus as will be handed to the callback.
*/
- virtual std::future<CommonAPI::CallStatus> volumeStepAsync(const am_sinkID_t& sinkID, const int16_t& volumeStep, VolumeStepAsyncCallback callback);
-
+ virtual std::future<CommonAPI::CallStatus> volumeStepAsync(const am_sinkID_t& sinkID, const int16_t& volumeStep_, VolumeStepAsyncCallback callback);
/**
+ * 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.
+ *
* Calls setSinkMuteState with synchronous semantics.
*
- * All const parameters are input parameters to this method.
- * All non-const parameters will be filled with the returned values.
+ * All const parameters are input parameters to this method.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void setSinkMuteState(const am_sinkID_t& sinkID, const am_MuteState_e& muteState, CommonAPI::CallStatus& callStatus, am_Error_e& error);
/**
@@ -275,16 +383,20 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> setSinkMuteStateAsync(const am_sinkID_t& sinkID, const am_MuteState_e& muteState, SetSinkMuteStateAsyncCallback callback);
-
/**
+ * 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
+ *
* Calls setMainSinkSoundProperty with synchronous semantics.
*
- * All const parameters are input parameters to this method.
- * All non-const parameters will be filled with the returned values.
+ * All const parameters are input parameters to this method.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void setMainSinkSoundProperty(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus, am_Error_e& error);
/**
@@ -298,16 +410,20 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> setMainSinkSoundPropertyAsync(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty, SetMainSinkSoundPropertyAsyncCallback callback);
-
/**
+ * 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
+ *
* Calls setMainSourceSoundProperty with synchronous semantics.
*
- * All const parameters are input parameters to this method.
- * All non-const parameters will be filled with the returned values.
+ * All const parameters are input parameters to this method.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void setMainSourceSoundProperty(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus, am_Error_e& error);
/**
@@ -321,16 +437,18 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> setMainSourceSoundPropertyAsync(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty, SetMainSourceSoundPropertyAsyncCallback callback);
-
/**
+ * 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
+ *
* Calls setSystemProperty with synchronous semantics.
*
- * All const parameters are input parameters to this method.
- * All non-const parameters will be filled with the returned values.
+ * All const parameters are input parameters to this method.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void setSystemProperty(const am_SystemProperty_s& property, CommonAPI::CallStatus& callStatus, am_Error_e& error);
/**
@@ -344,15 +462,17 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> setSystemPropertyAsync(const am_SystemProperty_s& property, SetSystemPropertyAsyncCallback callback);
-
/**
+ * returns the actual list of MainConnections
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ *
* Calls getListMainConnections with synchronous semantics.
*
- * All non-const parameters will be filled with the returned values.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void getListMainConnections(CommonAPI::CallStatus& callStatus, am_MainConnection_L& listConnections, am_Error_e& error);
/**
@@ -366,15 +486,17 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> getListMainConnectionsAsync(GetListMainConnectionsAsyncCallback callback);
-
/**
+ * returns the actual list of Sinks
+ (at)return E_OK on success, E_DATABASE_ERROR
+ * on error
+ *
* Calls getListMainSinks with synchronous semantics.
*
- * All non-const parameters will be filled with the returned values.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void getListMainSinks(CommonAPI::CallStatus& callStatus, am_SinkType_L& listMainSinks, am_Error_e& error);
/**
@@ -388,15 +510,17 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> getListMainSinksAsync(GetListMainSinksAsyncCallback callback);
-
/**
+ * returns the actual list of Sources
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ *
* Calls getListMainSources with synchronous semantics.
*
- * All non-const parameters will be filled with the returned values.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void getListMainSources(CommonAPI::CallStatus& callStatus, am_SourceType_L& listMainSources, am_Error_e& error);
/**
@@ -410,16 +534,19 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> getListMainSourcesAsync(GetListMainSourcesAsyncCallback callback);
-
/**
+ * 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
+ *
* Calls getListMainSinkSoundProperties with synchronous semantics.
*
- * All const parameters are input parameters to this method.
- * All non-const parameters will be filled with the returned values.
+ * All const parameters are input parameters to this method.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void getListMainSinkSoundProperties(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_MainSoundProperty_L& listSoundProperties, am_Error_e& error);
/**
@@ -433,16 +560,18 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> getListMainSinkSoundPropertiesAsync(const am_sinkID_t& sinkID, GetListMainSinkSoundPropertiesAsyncCallback callback);
-
/**
+ * This is used to retrieve all source sound properties related to a
+ * source.
+ (at)return E_OK on success, E_DATABASE_ERROR on error
+ *
* Calls getListMainSourceSoundProperties with synchronous semantics.
*
- * All const parameters are input parameters to this method.
- * All non-const parameters will be filled with the returned values.
+ * All const parameters are input parameters to this method.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void getListMainSourceSoundProperties(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_MainSoundProperty_L& listSourceProperties, am_Error_e& error);
/**
@@ -456,15 +585,17 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> getListMainSourceSoundPropertiesAsync(const am_sourceID_t& sourceID, GetListMainSourceSoundPropertiesAsyncCallback callback);
-
/**
+ * This is used to retrieve SourceClass Information of all source classes
+ *
+ (at)return E_OK on success, E_DATABASE_ERROR on error
+ *
* Calls getListSourceClasses with synchronous semantics.
*
- * All non-const parameters will be filled with the returned values.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void getListSourceClasses(CommonAPI::CallStatus& callStatus, am_SourceClass_L& listSourceClasses, am_Error_e& error);
/**
@@ -478,15 +609,17 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> getListSourceClassesAsync(GetListSourceClassesAsyncCallback callback);
-
/**
+ * This is used to retrieve SinkClass Information of all sink classes
+ (at)return
+ * E_OK on success, E_DATABASE_ERROR on error
+ *
* Calls getListSinkClasses with synchronous semantics.
*
- * All non-const parameters will be filled with the returned values.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void getListSinkClasses(CommonAPI::CallStatus& callStatus, am_SinkClass_L& listSinkClasses, am_Error_e& error);
/**
@@ -500,15 +633,17 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> getListSinkClassesAsync(GetListSinkClassesAsyncCallback callback);
-
/**
+ * Retrieves a complete list of all systemProperties.
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ *
* Calls getListSystemProperties with synchronous semantics.
*
- * All non-const parameters will be filled with the returned values.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void getListSystemProperties(CommonAPI::CallStatus& callStatus, am_SystemProperty_L& listSystemProperties, am_Error_e& error);
/**
@@ -522,16 +657,19 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> getListSystemPropertiesAsync(GetListSystemPropertiesAsyncCallback callback);
-
/**
+ * 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
+ *
* Calls getTimingInformation with synchronous semantics.
*
- * All const parameters are input parameters to this method.
- * All non-const parameters will be filled with the returned values.
+ * All const parameters are input parameters to this method.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void getTimingInformation(const am_mainConnectionID_t& mainConnectionID, CommonAPI::CallStatus& callStatus, am_timeSync_t& delay, am_Error_e& error);
/**
@@ -545,16 +683,17 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> getTimingInformationAsync(const am_mainConnectionID_t& mainConnectionID, GetTimingInformationAsyncCallback callback);
-
/**
+ * Retrieves the list of MainNotifications for a sink. Does not return the
+ * possible ones.
+ *
* Calls getListMainSinkNotificationConfigurations with synchronous semantics.
*
- * All const parameters are input parameters to this method.
- * All non-const parameters will be filled with the returned values.
+ * All const parameters are input parameters to this method.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void getListMainSinkNotificationConfigurations(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error);
/**
@@ -568,16 +707,17 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> getListMainSinkNotificationConfigurationsAsync(const am_sinkID_t& sinkID, GetListMainSinkNotificationConfigurationsAsyncCallback callback);
-
/**
+ * Retrieves the list of MainNotifications for a source. Does not return the
+ * possible ones.
+ *
* Calls getListMainSourceNotificationConfigurations with synchronous semantics.
*
- * All const parameters are input parameters to this method.
- * All non-const parameters will be filled with the returned values.
+ * All const parameters are input parameters to this method.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void getListMainSourceNotificationConfigurations(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error);
/**
@@ -591,16 +731,19 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> getListMainSourceNotificationConfigurationsAsync(const am_sourceID_t& sourceID, GetListMainSourceNotificationConfigurationsAsyncCallback callback);
-
/**
+ * 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
+ *
* Calls setMainSinkNotificationConfiguration with synchronous semantics.
*
- * All const parameters are input parameters to this method.
- * All non-const parameters will be filled with the returned values.
+ * All const parameters are input parameters to this method.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void setMainSinkNotificationConfiguration(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration, CommonAPI::CallStatus& callStatus, am_Error_e& error);
/**
@@ -614,16 +757,19 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> setMainSinkNotificationConfigurationAsync(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration, SetMainSinkNotificationConfigurationAsyncCallback callback);
-
/**
+ * 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
+ *
* Calls setMainSourceNotificationConfiguration with synchronous semantics.
*
- * All const parameters are input parameters to this method.
- * All non-const parameters will be filled with the returned values.
+ * All const parameters are input parameters to this method.
+ * All non-const parameters will be filled with the returned values.
* The CallStatus will be filled when the method returns and indicate either
* "SUCCESS" or which type of error has occurred. In case of an error, ONLY the CallStatus
* will be set.
- * Synchronous calls are not supported (will block indefinitely) when mainloop integration is used.
*/
virtual void setMainSourceNotificationConfiguration(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration, CommonAPI::CallStatus& callStatus, am_Error_e& error);
/**
@@ -637,23 +783,39 @@ class CommandControlProxy: virtual public CommandControl, virtual public Command
* It will provide the same value for CallStatus as will be handed to the callback.
*/
virtual std::future<CommonAPI::CallStatus> setMainSourceNotificationConfigurationAsync(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration, SetMainSourceNotificationConfigurationAsyncCallback callback);
+
- /// Returns the CommonAPI address of the remote partner this proxy communicates with.
+ /**
+ * Returns the CommonAPI address of the remote partner this proxy communicates with.
+ */
virtual std::string getAddress() const;
- /// Returns the domain of the remote partner this proxy communicates with.
+ /**
+ * Returns the domain of the remote partner this proxy communicates with.
+ */
virtual const std::string& getDomain() const;
- /// Returns the service ID of the remote partner this proxy communicates with.
+ /**
+ * Returns the service ID of the remote partner this proxy communicates with.
+ */
virtual const std::string& getServiceId() const;
- /// Returns the instance ID of the remote partner this proxy communicates with.
+ /**
+ * Returns the instance ID of the remote partner this proxy communicates with.
+ */
virtual const std::string& getInstanceId() const;
- /// Returns true if the remote partner for this proxy is available.
+ /**
+ * Returns true if the remote partner for this proxy is currently known to be available.
+ */
virtual bool isAvailable() const;
/**
+ * Returns true if the remote partner for this proxy is available.
+ */
+ virtual bool isAvailableBlocking() const;
+
+ /**
* Returns the wrapper class that is used to (de-)register for notifications about
* the availability of the remote partner of this proxy.
*/
@@ -683,6 +845,11 @@ template <typename ... _AttributeExtensions>
CommandControlProxy<_AttributeExtensions...>::~CommandControlProxy() {
}
+/**
+ * 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
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::connect(const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_mainConnectionID_t& mainConnectionID, am_Error_e& error) {
delegate_->connect(sourceID, sinkID, callStatus, mainConnectionID, error);
@@ -692,7 +859,11 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::connectAsync(const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, ConnectAsyncCallback callback) {
return delegate_->connectAsync(sourceID, sinkID, callback);
}
-
+/**
+ * disconnects a mainConnection
+(at)return E_OK on successes, E_NON_EXISTENT if
+ * the connection does not exist, E_NOT_POSSIBLE on error.
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::disconnect(const am_mainConnectionID_t& mainConnectionID, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
delegate_->disconnect(mainConnectionID, callStatus, error);
@@ -702,7 +873,11 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::disconnectAsync(const am_mainConnectionID_t& mainConnectionID, DisconnectAsyncCallback callback) {
return delegate_->disconnectAsync(mainConnectionID, callback);
}
-
+/**
+ * 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
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::setVolume(const am_sinkID_t& sinkID, const am_mainVolume_t& volume, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
delegate_->setVolume(sinkID, volume, callStatus, error);
@@ -712,17 +887,26 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::setVolumeAsync(const am_sinkID_t& sinkID, const am_mainVolume_t& volume, SetVolumeAsyncCallback callback) {
return delegate_->setVolumeAsync(sinkID, volume, callback);
}
-
+/**
+ * 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.
+ */
template <typename ... _AttributeExtensions>
-void CommandControlProxy<_AttributeExtensions...>::volumeStep(const am_sinkID_t& sinkID, const int16_t& volumeStep, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
- delegate_->volumeStep(sinkID, volumeStep, callStatus, error);
+void CommandControlProxy<_AttributeExtensions...>::volumeStep(const am_sinkID_t& sinkID, const int16_t& volumeStep_, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
+ delegate_->volumeStep(sinkID, volumeStep_, callStatus, error);
}
template <typename ... _AttributeExtensions>
-std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::volumeStepAsync(const am_sinkID_t& sinkID, const int16_t& volumeStep, VolumeStepAsyncCallback callback) {
- return delegate_->volumeStepAsync(sinkID, volumeStep, callback);
+std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::volumeStepAsync(const am_sinkID_t& sinkID, const int16_t& volumeStep_, VolumeStepAsyncCallback callback) {
+ return delegate_->volumeStepAsync(sinkID, volumeStep_, callback);
}
-
+/**
+ * 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.
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::setSinkMuteState(const am_sinkID_t& sinkID, const am_MuteState_e& muteState, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
delegate_->setSinkMuteState(sinkID, muteState, callStatus, error);
@@ -732,7 +916,13 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::setSinkMuteStateAsync(const am_sinkID_t& sinkID, const am_MuteState_e& muteState, SetSinkMuteStateAsyncCallback callback) {
return delegate_->setSinkMuteStateAsync(sinkID, muteState, callback);
}
-
+/**
+ * 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
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::setMainSinkSoundProperty(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
delegate_->setMainSinkSoundProperty(sinkID, soundProperty, callStatus, error);
@@ -742,7 +932,13 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::setMainSinkSoundPropertyAsync(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty, SetMainSinkSoundPropertyAsyncCallback callback) {
return delegate_->setMainSinkSoundPropertyAsync(sinkID, soundProperty, callback);
}
-
+/**
+ * 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
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::setMainSourceSoundProperty(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
delegate_->setMainSourceSoundProperty(sourceID, soundProperty, callStatus, error);
@@ -752,7 +948,11 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::setMainSourceSoundPropertyAsync(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty, SetMainSourceSoundPropertyAsyncCallback callback) {
return delegate_->setMainSourceSoundPropertyAsync(sourceID, soundProperty, callback);
}
-
+/**
+ * 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
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::setSystemProperty(const am_SystemProperty_s& property, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
delegate_->setSystemProperty(property, callStatus, error);
@@ -762,7 +962,11 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::setSystemPropertyAsync(const am_SystemProperty_s& property, SetSystemPropertyAsyncCallback callback) {
return delegate_->setSystemPropertyAsync(property, callback);
}
-
+/**
+ * returns the actual list of MainConnections
+(at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::getListMainConnections(CommonAPI::CallStatus& callStatus, am_MainConnection_L& listConnections, am_Error_e& error) {
delegate_->getListMainConnections(callStatus, listConnections, error);
@@ -772,7 +976,11 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::getListMainConnectionsAsync(GetListMainConnectionsAsyncCallback callback) {
return delegate_->getListMainConnectionsAsync(callback);
}
-
+/**
+ * returns the actual list of Sinks
+(at)return E_OK on success, E_DATABASE_ERROR
+ * on error
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::getListMainSinks(CommonAPI::CallStatus& callStatus, am_SinkType_L& listMainSinks, am_Error_e& error) {
delegate_->getListMainSinks(callStatus, listMainSinks, error);
@@ -782,7 +990,11 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::getListMainSinksAsync(GetListMainSinksAsyncCallback callback) {
return delegate_->getListMainSinksAsync(callback);
}
-
+/**
+ * returns the actual list of Sources
+(at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::getListMainSources(CommonAPI::CallStatus& callStatus, am_SourceType_L& listMainSources, am_Error_e& error) {
delegate_->getListMainSources(callStatus, listMainSources, error);
@@ -792,7 +1004,12 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::getListMainSourcesAsync(GetListMainSourcesAsyncCallback callback) {
return delegate_->getListMainSourcesAsync(callback);
}
-
+/**
+ * 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
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::getListMainSinkSoundProperties(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_MainSoundProperty_L& listSoundProperties, am_Error_e& error) {
delegate_->getListMainSinkSoundProperties(sinkID, callStatus, listSoundProperties, error);
@@ -802,7 +1019,11 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::getListMainSinkSoundPropertiesAsync(const am_sinkID_t& sinkID, GetListMainSinkSoundPropertiesAsyncCallback callback) {
return delegate_->getListMainSinkSoundPropertiesAsync(sinkID, callback);
}
-
+/**
+ * This is used to retrieve all source sound properties related to a
+ * source.
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::getListMainSourceSoundProperties(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_MainSoundProperty_L& listSourceProperties, am_Error_e& error) {
delegate_->getListMainSourceSoundProperties(sourceID, callStatus, listSourceProperties, error);
@@ -812,7 +1033,11 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::getListMainSourceSoundPropertiesAsync(const am_sourceID_t& sourceID, GetListMainSourceSoundPropertiesAsyncCallback callback) {
return delegate_->getListMainSourceSoundPropertiesAsync(sourceID, callback);
}
-
+/**
+ * This is used to retrieve SourceClass Information of all source classes
+ *
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::getListSourceClasses(CommonAPI::CallStatus& callStatus, am_SourceClass_L& listSourceClasses, am_Error_e& error) {
delegate_->getListSourceClasses(callStatus, listSourceClasses, error);
@@ -822,7 +1047,11 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::getListSourceClassesAsync(GetListSourceClassesAsyncCallback callback) {
return delegate_->getListSourceClassesAsync(callback);
}
-
+/**
+ * This is used to retrieve SinkClass Information of all sink classes
+(at)return
+ * E_OK on success, E_DATABASE_ERROR on error
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::getListSinkClasses(CommonAPI::CallStatus& callStatus, am_SinkClass_L& listSinkClasses, am_Error_e& error) {
delegate_->getListSinkClasses(callStatus, listSinkClasses, error);
@@ -832,7 +1061,11 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::getListSinkClassesAsync(GetListSinkClassesAsyncCallback callback) {
return delegate_->getListSinkClassesAsync(callback);
}
-
+/**
+ * Retrieves a complete list of all systemProperties.
+(at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::getListSystemProperties(CommonAPI::CallStatus& callStatus, am_SystemProperty_L& listSystemProperties, am_Error_e& error) {
delegate_->getListSystemProperties(callStatus, listSystemProperties, error);
@@ -842,7 +1075,12 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::getListSystemPropertiesAsync(GetListSystemPropertiesAsyncCallback callback) {
return delegate_->getListSystemPropertiesAsync(callback);
}
-
+/**
+ * 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
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::getTimingInformation(const am_mainConnectionID_t& mainConnectionID, CommonAPI::CallStatus& callStatus, am_timeSync_t& delay, am_Error_e& error) {
delegate_->getTimingInformation(mainConnectionID, callStatus, delay, error);
@@ -852,7 +1090,10 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::getTimingInformationAsync(const am_mainConnectionID_t& mainConnectionID, GetTimingInformationAsyncCallback callback) {
return delegate_->getTimingInformationAsync(mainConnectionID, callback);
}
-
+/**
+ * Retrieves the list of MainNotifications for a sink. Does not return the
+ * possible ones.
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::getListMainSinkNotificationConfigurations(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) {
delegate_->getListMainSinkNotificationConfigurations(sinkID, callStatus, listMainNotificationConfigurations, error);
@@ -862,7 +1103,10 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::getListMainSinkNotificationConfigurationsAsync(const am_sinkID_t& sinkID, GetListMainSinkNotificationConfigurationsAsyncCallback callback) {
return delegate_->getListMainSinkNotificationConfigurationsAsync(sinkID, callback);
}
-
+/**
+ * Retrieves the list of MainNotifications for a source. Does not return the
+ * possible ones.
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::getListMainSourceNotificationConfigurations(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) {
delegate_->getListMainSourceNotificationConfigurations(sourceID, callStatus, listMainNotificationConfigurations, error);
@@ -872,7 +1116,12 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::getListMainSourceNotificationConfigurationsAsync(const am_sourceID_t& sourceID, GetListMainSourceNotificationConfigurationsAsyncCallback callback) {
return delegate_->getListMainSourceNotificationConfigurationsAsync(sourceID, callback);
}
-
+/**
+ * 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
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::setMainSinkNotificationConfiguration(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
delegate_->setMainSinkNotificationConfiguration(sinkID, mainNotificationConfiguration, callStatus, error);
@@ -882,7 +1131,12 @@ template <typename ... _AttributeExtensions>
std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>::setMainSinkNotificationConfigurationAsync(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration, SetMainSinkNotificationConfigurationAsyncCallback callback) {
return delegate_->setMainSinkNotificationConfigurationAsync(sinkID, mainNotificationConfiguration, callback);
}
-
+/**
+ * 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
+ */
template <typename ... _AttributeExtensions>
void CommandControlProxy<_AttributeExtensions...>::setMainSourceNotificationConfiguration(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration, CommonAPI::CallStatus& callStatus, am_Error_e& error) {
delegate_->setMainSourceNotificationConfiguration(sourceID, mainNotificationConfiguration, callStatus, error);
@@ -893,7 +1147,6 @@ std::future<CommonAPI::CallStatus> CommandControlProxy<_AttributeExtensions...>:
return delegate_->setMainSourceNotificationConfigurationAsync(sourceID, mainNotificationConfiguration, callback);
}
-
template <typename ... _AttributeExtensions>
std::string CommandControlProxy<_AttributeExtensions...>::getAddress() const {
return delegate_->getAddress();
@@ -920,6 +1173,11 @@ bool CommandControlProxy<_AttributeExtensions...>::isAvailable() const {
}
template <typename ... _AttributeExtensions>
+bool CommandControlProxy<_AttributeExtensions...>::isAvailableBlocking() const {
+ return delegate_->isAvailableBlocking();
+}
+
+template <typename ... _AttributeExtensions>
CommonAPI::ProxyStatusEvent& CommandControlProxy<_AttributeExtensions...>::getProxyStatusEvent() {
return delegate_->getProxyStatusEvent();
}
@@ -929,10 +1187,11 @@ CommonAPI::InterfaceVersionAttribute& CommandControlProxy<_AttributeExtensions..
return delegate_->getInterfaceVersionAttribute();
}
+
+
} // namespace am
} // namespace genivi
} // namespace org
-
#endif // ORG_GENIVI_AM_Command_Control_PROXY_H_
diff --git a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlProxyBase.h b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlProxyBase.h
index 588e2a7..8bc83e5 100644
--- a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlProxyBase.h
+++ b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlProxyBase.h
@@ -1,195 +1,361 @@
- /*
- * This file was generated by the CommonAPI Generators.
- *
- * This file was generated by the CommonAPI Generators.
- *
- * This file was generated by the CommonAPI Generators.
- *
- * 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 Aleksandar Donchev, aleksander.donchev@partner.bmw.de BMW 2013
- * \author Christian Linke christian.linke@bmw.de BMW 2013
- *
- * For further information see http://www.genivi.org/.
+/*
+* This file was generated by the CommonAPI Generators.
+* Used org.genivi.commonapi.core 2.1.1.201309251246.
+* Used org.franca.core 0.8.9.201308271211.
+*
+* Copyright (c) 2012 BMW
+*
+* \author Aleksandar Donchev, aleksander.donchev@partner.bmw.de BMW 2013
+*
+* \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.
+*
+* For further information see http://www.genivi.org/.
+*/
+/**
+ * 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
*/
- #ifndef ORG_GENIVI_AM_Command_Control_PROXY_BASE_H_
- #define ORG_GENIVI_AM_Command_Control_PROXY_BASE_H_
-
- #include "CommandControl.h"
-
-
- #include <org/genivi/am.h>
-
- #define COMMONAPI_INTERNAL_COMPILATION
-
- #include <CommonAPI/InputStream.h>
- #include <CommonAPI/OutputStream.h>
- #include <CommonAPI/SerializableStruct.h>
- #include <cstdint>
- #include <string>
- #include <vector>
+#ifndef ORG_GENIVI_AM_Command_Control_PROXY_BASE_H_
+#define ORG_GENIVI_AM_Command_Control_PROXY_BASE_H_
- #include <CommonAPI/Event.h>
- #include <CommonAPI/Proxy.h>
- #include <functional>
- #include <future>
-
- #undef COMMONAPI_INTERNAL_COMPILATION
+#include "CommandControl.h"
- namespace org {
- namespace genivi {
- namespace am {
- class CommandControlProxyBase: virtual public CommonAPI::Proxy {
- public:
- typedef CommonAPI::Event<am_MainConnectionType_s> NewMainConnectionEvent;
- typedef CommonAPI::Event<am_mainConnectionID_t> RemovedMainConnectionEvent;
- typedef CommonAPI::Event<am_SinkType_s> NewSinkEvent;
- typedef CommonAPI::Event<am_sinkID_t> RemovedSinkEvent;
- typedef CommonAPI::Event<am_SourceType_s> NewSourceEvent;
- typedef CommonAPI::Event<am_sourceID_t> RemovedSourceEvent;
- typedef CommonAPI::Event<> NumberOfSinkClassesChangedEvent;
- typedef CommonAPI::Event<> NumberOfSourceClassesChangedEvent;
- typedef CommonAPI::Event<am_mainConnectionID_t, am_ConnectionState_e> MainConnectionStateChangedEvent;
- typedef CommonAPI::Event<am_sinkID_t, am_MainSoundProperty_s> MainSinkSoundPropertyChangedEvent;
- typedef CommonAPI::Event<am_sourceID_t, am_MainSoundProperty_s> MainSourceSoundPropertyChangedEvent;
- typedef CommonAPI::Event<am_sinkID_t, am_Availability_s> SinkAvailabilityChangedEvent;
- typedef CommonAPI::Event<am_sourceID_t, am_Availability_s> SourceAvailabilityChangedEvent;
- typedef CommonAPI::Event<am_sinkID_t, am_mainVolume_t> VolumeChangedEvent;
- typedef CommonAPI::Event<am_sinkID_t, am_MuteState_e> SinkMuteStateChangedEvent;
- typedef CommonAPI::Event<am_SystemProperty_s> SystemPropertyChangedEvent;
- typedef CommonAPI::Event<am_mainConnectionID_t, am_timeSync_t> TimingInformationChangedEvent;
- typedef CommonAPI::Event<am_sinkID_t, am_sinkClass_t, am_MainSoundProperty_L> SinkUpdatedEvent;
- typedef CommonAPI::Event<am_sourceID_t, am_sourceClass_t, am_MainSoundProperty_L> SourceUpdatedEvent;
- typedef CommonAPI::Event<am_sinkID_t, am_NotificationPayload_s> SinkNotificationEvent;
- typedef CommonAPI::Event<am_sourceID_t, am_NotificationPayload_s> SourceNotificationEvent;
- typedef CommonAPI::Event<am_sinkID_t, am_NotificationConfiguration_s> MainSinkNotificationConfigurationChangedEvent;
- typedef CommonAPI::Event<am_sourceID_t, am_NotificationConfiguration_s> MainSourceNotificationConfigurationChangedEvent;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_mainConnectionID_t&, const am_Error_e&)> ConnectAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> DisconnectAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetVolumeAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> VolumeStepAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetSinkMuteStateAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetMainSinkSoundPropertyAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetMainSourceSoundPropertyAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetSystemPropertyAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_MainConnection_L&, const am_Error_e&)> GetListMainConnectionsAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_SinkType_L&, const am_Error_e&)> GetListMainSinksAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_SourceType_L&, const am_Error_e&)> GetListMainSourcesAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_MainSoundProperty_L&, const am_Error_e&)> GetListMainSinkSoundPropertiesAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_MainSoundProperty_L&, const am_Error_e&)> GetListMainSourceSoundPropertiesAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_SourceClass_L&, const am_Error_e&)> GetListSourceClassesAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_SinkClass_L&, const am_Error_e&)> GetListSinkClassesAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_SystemProperty_L&, const am_Error_e&)> GetListSystemPropertiesAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_timeSync_t&, const am_Error_e&)> GetTimingInformationAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_NotificationConfiguration_L&, const am_Error_e&)> GetListMainSinkNotificationConfigurationsAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_NotificationConfiguration_L&, const am_Error_e&)> GetListMainSourceNotificationConfigurationsAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetMainSinkNotificationConfigurationAsyncCallback;
- typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetMainSourceNotificationConfigurationAsyncCallback;
+#include <org/genivi/am.h>
+#if !defined (COMMONAPI_INTERNAL_COMPILATION)
+#define COMMONAPI_INTERNAL_COMPILATION
+#endif
- virtual NewMainConnectionEvent& getNewMainConnectionEvent() = 0;
- virtual RemovedMainConnectionEvent& getRemovedMainConnectionEvent() = 0;
- virtual NewSinkEvent& getNewSinkEvent() = 0;
- virtual RemovedSinkEvent& getRemovedSinkEvent() = 0;
- virtual NewSourceEvent& getNewSourceEvent() = 0;
- virtual RemovedSourceEvent& getRemovedSourceEvent() = 0;
- virtual NumberOfSinkClassesChangedEvent& getNumberOfSinkClassesChangedEvent() = 0;
- virtual NumberOfSourceClassesChangedEvent& getNumberOfSourceClassesChangedEvent() = 0;
- virtual MainConnectionStateChangedEvent& getMainConnectionStateChangedEvent() = 0;
- virtual MainSinkSoundPropertyChangedEvent& getMainSinkSoundPropertyChangedEvent() = 0;
- virtual MainSourceSoundPropertyChangedEvent& getMainSourceSoundPropertyChangedEvent() = 0;
- virtual SinkAvailabilityChangedEvent& getSinkAvailabilityChangedEvent() = 0;
- virtual SourceAvailabilityChangedEvent& getSourceAvailabilityChangedEvent() = 0;
- virtual VolumeChangedEvent& getVolumeChangedEvent() = 0;
- virtual SinkMuteStateChangedEvent& getSinkMuteStateChangedEvent() = 0;
- virtual SystemPropertyChangedEvent& getSystemPropertyChangedEvent() = 0;
- virtual TimingInformationChangedEvent& getTimingInformationChangedEvent() = 0;
- virtual SinkUpdatedEvent& getSinkUpdatedEvent() = 0;
- virtual SourceUpdatedEvent& getSourceUpdatedEvent() = 0;
- virtual SinkNotificationEvent& getSinkNotificationEvent() = 0;
- virtual SourceNotificationEvent& getSourceNotificationEvent() = 0;
- virtual MainSinkNotificationConfigurationChangedEvent& getMainSinkNotificationConfigurationChangedEvent() = 0;
- virtual MainSourceNotificationConfigurationChangedEvent& getMainSourceNotificationConfigurationChangedEvent() = 0;
+#include <CommonAPI/InputStream.h>
+#include <CommonAPI/OutputStream.h>
+#include <CommonAPI/SerializableStruct.h>
+#include <cstdint>
+#include <string>
+#include <vector>
+#include <CommonAPI/Event.h>
+#include <CommonAPI/Proxy.h>
+#include <functional>
+#include <future>
- virtual void connect(const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_mainConnectionID_t& mainConnectionID, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> connectAsync(const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, ConnectAsyncCallback callback) = 0;
+#undef COMMONAPI_INTERNAL_COMPILATION
- virtual void disconnect(const am_mainConnectionID_t& mainConnectionID, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> disconnectAsync(const am_mainConnectionID_t& mainConnectionID, DisconnectAsyncCallback callback) = 0;
+namespace org {
+namespace genivi {
+namespace am {
- virtual void setVolume(const am_sinkID_t& sinkID, const am_mainVolume_t& volume, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> setVolumeAsync(const am_sinkID_t& sinkID, const am_mainVolume_t& volume, SetVolumeAsyncCallback callback) = 0;
+class CommandControlProxyBase: virtual public CommonAPI::Proxy {
+ public:
+ typedef CommonAPI::Event<am_MainConnectionType_s> NewMainConnectionEvent;
+ typedef CommonAPI::Event<am_mainConnectionID_t> RemovedMainConnectionEvent;
+ typedef CommonAPI::Event<am_SinkType_s> NewSinkEvent;
+ typedef CommonAPI::Event<am_sinkID_t> RemovedSinkEvent;
+ typedef CommonAPI::Event<am_SourceType_s> NewSourceEvent;
+ typedef CommonAPI::Event<am_sourceID_t> RemovedSourceEvent;
+ typedef CommonAPI::Event<> NumberOfSinkClassesChangedEvent;
+ typedef CommonAPI::Event<> NumberOfSourceClassesChangedEvent;
+ typedef CommonAPI::Event<am_mainConnectionID_t, am_ConnectionState_e> MainConnectionStateChangedEvent;
+ typedef CommonAPI::Event<am_sinkID_t, am_MainSoundProperty_s> MainSinkSoundPropertyChangedEvent;
+ typedef CommonAPI::Event<am_sourceID_t, am_MainSoundProperty_s> MainSourceSoundPropertyChangedEvent;
+ typedef CommonAPI::Event<am_sinkID_t, am_Availability_s> SinkAvailabilityChangedEvent;
+ typedef CommonAPI::Event<am_sourceID_t, am_Availability_s> SourceAvailabilityChangedEvent;
+ typedef CommonAPI::Event<am_sinkID_t, am_mainVolume_t> VolumeChangedEvent;
+ typedef CommonAPI::Event<am_sinkID_t, am_MuteState_e> SinkMuteStateChangedEvent;
+ typedef CommonAPI::Event<am_SystemProperty_s> SystemPropertyChangedEvent;
+ typedef CommonAPI::Event<am_mainConnectionID_t, am_timeSync_t> TimingInformationChangedEvent;
+ typedef CommonAPI::Event<am_sinkID_t, am_sinkClass_t, am_MainSoundProperty_L> SinkUpdatedEvent;
+ typedef CommonAPI::Event<am_sourceID_t, am_sourceClass_t, am_MainSoundProperty_L> SourceUpdatedEvent;
+ typedef CommonAPI::Event<am_sinkID_t, am_NotificationPayload_s> SinkNotificationEvent;
+ typedef CommonAPI::Event<am_sourceID_t, am_NotificationPayload_s> SourceNotificationEvent;
+ typedef CommonAPI::Event<am_sinkID_t, am_NotificationConfiguration_s> MainSinkNotificationConfigurationChangedEvent;
+ typedef CommonAPI::Event<am_sourceID_t, am_NotificationConfiguration_s> MainSourceNotificationConfigurationChangedEvent;
- virtual void volumeStep(const am_sinkID_t& sinkID, const int16_t& volumeStep, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> volumeStepAsync(const am_sinkID_t& sinkID, const int16_t& volumeStep, VolumeStepAsyncCallback callback) = 0;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_mainConnectionID_t&, const am_Error_e&)> ConnectAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> DisconnectAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetVolumeAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> VolumeStepAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetSinkMuteStateAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetMainSinkSoundPropertyAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetMainSourceSoundPropertyAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetSystemPropertyAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_MainConnection_L&, const am_Error_e&)> GetListMainConnectionsAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_SinkType_L&, const am_Error_e&)> GetListMainSinksAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_SourceType_L&, const am_Error_e&)> GetListMainSourcesAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_MainSoundProperty_L&, const am_Error_e&)> GetListMainSinkSoundPropertiesAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_MainSoundProperty_L&, const am_Error_e&)> GetListMainSourceSoundPropertiesAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_SourceClass_L&, const am_Error_e&)> GetListSourceClassesAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_SinkClass_L&, const am_Error_e&)> GetListSinkClassesAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_SystemProperty_L&, const am_Error_e&)> GetListSystemPropertiesAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_timeSync_t&, const am_Error_e&)> GetTimingInformationAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_NotificationConfiguration_L&, const am_Error_e&)> GetListMainSinkNotificationConfigurationsAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_NotificationConfiguration_L&, const am_Error_e&)> GetListMainSourceNotificationConfigurationsAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetMainSinkNotificationConfigurationAsyncCallback;
+ typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetMainSourceNotificationConfigurationAsyncCallback;
- virtual void setSinkMuteState(const am_sinkID_t& sinkID, const am_MuteState_e& muteState, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> setSinkMuteStateAsync(const am_sinkID_t& sinkID, const am_MuteState_e& muteState, SetSinkMuteStateAsyncCallback callback) = 0;
- virtual void setMainSinkSoundProperty(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> setMainSinkSoundPropertyAsync(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty, SetMainSinkSoundPropertyAsyncCallback callback) = 0;
+ /**
+ * Callback that is called when the number of connections change
+ */
+ virtual NewMainConnectionEvent& getNewMainConnectionEvent() = 0;
+ /**
+ * Callback that is called when the number of connections change
+ */
+ virtual RemovedMainConnectionEvent& getRemovedMainConnectionEvent() = 0;
+ /**
+ * Callback that is called when the number of sinks change
+ */
+ virtual NewSinkEvent& getNewSinkEvent() = 0;
+ /**
+ * Callback that is called when the number of sinks change
+ */
+ virtual RemovedSinkEvent& getRemovedSinkEvent() = 0;
+ /**
+ * Callback that is called when the number of sources change
+ */
+ virtual NewSourceEvent& getNewSourceEvent() = 0;
+ /**
+ * Callback that is called when the number of sources change
+ */
+ virtual RemovedSourceEvent& getRemovedSourceEvent() = 0;
+ /**
+ * this callback is fired if the number of sink classes changed
+ */
+ virtual NumberOfSinkClassesChangedEvent& getNumberOfSinkClassesChangedEvent() = 0;
+ /**
+ * this callback is fired if the number of source classes changed
+ */
+ virtual NumberOfSourceClassesChangedEvent& getNumberOfSourceClassesChangedEvent() = 0;
+ /**
+ * This callback is called when the ConnectionState of a connection changed.
+ */
+ virtual MainConnectionStateChangedEvent& getMainConnectionStateChangedEvent() = 0;
+ /**
+ * this callback indicates that a sinkSoundProperty has changed.
+ */
+ virtual MainSinkSoundPropertyChangedEvent& getMainSinkSoundPropertyChangedEvent() = 0;
+ /**
+ * this callback indicates that a sourceSoundProperty has changed.
+ */
+ virtual MainSourceSoundPropertyChangedEvent& getMainSourceSoundPropertyChangedEvent() = 0;
+ /**
+ * this callback is called when the availability of a sink has changed
+ */
+ virtual SinkAvailabilityChangedEvent& getSinkAvailabilityChangedEvent() = 0;
+ /**
+ * this callback is called when the availability of source has changed.
+ */
+ virtual SourceAvailabilityChangedEvent& getSourceAvailabilityChangedEvent() = 0;
+ /**
+ * this callback indicates a volume change on the indicated sink
+ */
+ virtual VolumeChangedEvent& getVolumeChangedEvent() = 0;
+ /**
+ * this callback indicates a mute state change on a sink.
+ */
+ virtual SinkMuteStateChangedEvent& getSinkMuteStateChangedEvent() = 0;
+ /**
+ * is fired if a systemProperty changed
+ */
+ virtual SystemPropertyChangedEvent& getSystemPropertyChangedEvent() = 0;
+ /**
+ * This callback is fired if the timinginformation for a mainConnectionID changed
+ */
+ virtual TimingInformationChangedEvent& getTimingInformationChangedEvent() = 0;
+ /**
+ * This callback is called when a sink is updated.
+ */
+ virtual SinkUpdatedEvent& getSinkUpdatedEvent() = 0;
+ /**
+ * This callback is called when a source is updated.
+ */
+ virtual SourceUpdatedEvent& getSourceUpdatedEvent() = 0;
+ /**
+ * This callback is called when a notificated value of a sink changes.
+ */
+ virtual SinkNotificationEvent& getSinkNotificationEvent() = 0;
+ /**
+ * This callback is called when a notifcated value of a source changes.
+ */
+ virtual SourceNotificationEvent& getSourceNotificationEvent() = 0;
+ /**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
+ virtual MainSinkNotificationConfigurationChangedEvent& getMainSinkNotificationConfigurationChangedEvent() = 0;
+ /**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
+ virtual MainSourceNotificationConfigurationChangedEvent& getMainSourceNotificationConfigurationChangedEvent() = 0;
- virtual void setMainSourceSoundProperty(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> setMainSourceSoundPropertyAsync(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty, SetMainSourceSoundPropertyAsyncCallback callback) = 0;
+ /**
+ * 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
+ */
+ virtual void connect(const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_mainConnectionID_t& mainConnectionID, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> connectAsync(const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, ConnectAsyncCallback callback) = 0;
+ /**
+ * disconnects a mainConnection
+ (at)return E_OK on successes, E_NON_EXISTENT if
+ * the connection does not exist, E_NOT_POSSIBLE on error.
+ */
+ virtual void disconnect(const am_mainConnectionID_t& mainConnectionID, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> disconnectAsync(const am_mainConnectionID_t& mainConnectionID, DisconnectAsyncCallback callback) = 0;
+ /**
+ * 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
+ */
+ virtual void setVolume(const am_sinkID_t& sinkID, const am_mainVolume_t& volume, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> setVolumeAsync(const am_sinkID_t& sinkID, const am_mainVolume_t& volume, SetVolumeAsyncCallback callback) = 0;
+ /**
+ * 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.
+ */
+ virtual void volumeStep(const am_sinkID_t& sinkID, const int16_t& volumeStep_, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> volumeStepAsync(const am_sinkID_t& sinkID, const int16_t& volumeStep_, VolumeStepAsyncCallback callback) = 0;
+ /**
+ * 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.
+ */
+ virtual void setSinkMuteState(const am_sinkID_t& sinkID, const am_MuteState_e& muteState, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> setSinkMuteStateAsync(const am_sinkID_t& sinkID, const am_MuteState_e& muteState, SetSinkMuteStateAsyncCallback callback) = 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
+ (at)return E_OK on success, E_OUT_OF_RANGE if value
+ * exceeds range, E_UNKNOWN in case of an error
+ */
+ virtual void setMainSinkSoundProperty(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> setMainSinkSoundPropertyAsync(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty, SetMainSinkSoundPropertyAsyncCallback callback) = 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
+ (at)return E_OK on success, E_OUT_OF_RANGE if value
+ * exceeds range, E_UNKNOWN in case of an error
+ */
+ virtual void setMainSourceSoundProperty(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> setMainSourceSoundPropertyAsync(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty, SetMainSourceSoundPropertyAsyncCallback callback) = 0;
+ /**
+ * 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
+ */
+ virtual void setSystemProperty(const am_SystemProperty_s& property, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> setSystemPropertyAsync(const am_SystemProperty_s& property, SetSystemPropertyAsyncCallback callback) = 0;
+ /**
+ * returns the actual list of MainConnections
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
+ virtual void getListMainConnections(CommonAPI::CallStatus& callStatus, am_MainConnection_L& listConnections, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> getListMainConnectionsAsync(GetListMainConnectionsAsyncCallback callback) = 0;
+ /**
+ * returns the actual list of Sinks
+ (at)return E_OK on success, E_DATABASE_ERROR
+ * on error
+ */
+ virtual void getListMainSinks(CommonAPI::CallStatus& callStatus, am_SinkType_L& listMainSinks, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> getListMainSinksAsync(GetListMainSinksAsyncCallback callback) = 0;
+ /**
+ * returns the actual list of Sources
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
+ virtual void getListMainSources(CommonAPI::CallStatus& callStatus, am_SourceType_L& listMainSources, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> getListMainSourcesAsync(GetListMainSourcesAsyncCallback callback) = 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
+ (at)return E_OK
+ * on success, E_DATABASE_ERROR on error
+ */
+ virtual void getListMainSinkSoundProperties(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_MainSoundProperty_L& listSoundProperties, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> getListMainSinkSoundPropertiesAsync(const am_sinkID_t& sinkID, GetListMainSinkSoundPropertiesAsyncCallback callback) = 0;
+ /**
+ * This is used to retrieve all source sound properties related to a
+ * source.
+ (at)return E_OK on success, E_DATABASE_ERROR on error
+ */
+ virtual void getListMainSourceSoundProperties(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_MainSoundProperty_L& listSourceProperties, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> getListMainSourceSoundPropertiesAsync(const am_sourceID_t& sourceID, GetListMainSourceSoundPropertiesAsyncCallback callback) = 0;
+ /**
+ * This is used to retrieve SourceClass Information of all source classes
+ *
+ (at)return E_OK on success, E_DATABASE_ERROR on error
+ */
+ virtual void getListSourceClasses(CommonAPI::CallStatus& callStatus, am_SourceClass_L& listSourceClasses, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> getListSourceClassesAsync(GetListSourceClassesAsyncCallback callback) = 0;
+ /**
+ * This is used to retrieve SinkClass Information of all sink classes
+ (at)return
+ * E_OK on success, E_DATABASE_ERROR on error
+ */
+ virtual void getListSinkClasses(CommonAPI::CallStatus& callStatus, am_SinkClass_L& listSinkClasses, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> getListSinkClassesAsync(GetListSinkClassesAsyncCallback callback) = 0;
+ /**
+ * Retrieves a complete list of all systemProperties.
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
+ virtual void getListSystemProperties(CommonAPI::CallStatus& callStatus, am_SystemProperty_L& listSystemProperties, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> getListSystemPropertiesAsync(GetListSystemPropertiesAsyncCallback callback) = 0;
+ /**
+ * 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
+ */
+ virtual void getTimingInformation(const am_mainConnectionID_t& mainConnectionID, CommonAPI::CallStatus& callStatus, am_timeSync_t& delay, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> getTimingInformationAsync(const am_mainConnectionID_t& mainConnectionID, GetTimingInformationAsyncCallback callback) = 0;
+ /**
+ * Retrieves the list of MainNotifications for a sink. Does not return the
+ * possible ones.
+ */
+ virtual void getListMainSinkNotificationConfigurations(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> getListMainSinkNotificationConfigurationsAsync(const am_sinkID_t& sinkID, GetListMainSinkNotificationConfigurationsAsyncCallback callback) = 0;
+ /**
+ * Retrieves the list of MainNotifications for a source. Does not return the
+ * possible ones.
+ */
+ virtual void getListMainSourceNotificationConfigurations(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> getListMainSourceNotificationConfigurationsAsync(const am_sourceID_t& sourceID, GetListMainSourceNotificationConfigurationsAsyncCallback callback) = 0;
+ /**
+ * 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
+ */
+ virtual void setMainSinkNotificationConfiguration(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> setMainSinkNotificationConfigurationAsync(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration, SetMainSinkNotificationConfigurationAsyncCallback callback) = 0;
+ /**
+ * 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
+ */
+ virtual void setMainSourceNotificationConfiguration(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
+ virtual std::future<CommonAPI::CallStatus> setMainSourceNotificationConfigurationAsync(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration, SetMainSourceNotificationConfigurationAsyncCallback callback) = 0;
+};
- virtual void setSystemProperty(const am_SystemProperty_s& property, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> setSystemPropertyAsync(const am_SystemProperty_s& property, SetSystemPropertyAsyncCallback callback) = 0;
+} // namespace am
+} // namespace genivi
+} // namespace org
- virtual void getListMainConnections(CommonAPI::CallStatus& callStatus, am_MainConnection_L& listConnections, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> getListMainConnectionsAsync(GetListMainConnectionsAsyncCallback callback) = 0;
-
- virtual void getListMainSinks(CommonAPI::CallStatus& callStatus, am_SinkType_L& listMainSinks, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> getListMainSinksAsync(GetListMainSinksAsyncCallback callback) = 0;
-
- virtual void getListMainSources(CommonAPI::CallStatus& callStatus, am_SourceType_L& listMainSources, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> getListMainSourcesAsync(GetListMainSourcesAsyncCallback callback) = 0;
-
- virtual void getListMainSinkSoundProperties(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_MainSoundProperty_L& listSoundProperties, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> getListMainSinkSoundPropertiesAsync(const am_sinkID_t& sinkID, GetListMainSinkSoundPropertiesAsyncCallback callback) = 0;
-
- virtual void getListMainSourceSoundProperties(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_MainSoundProperty_L& listSourceProperties, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> getListMainSourceSoundPropertiesAsync(const am_sourceID_t& sourceID, GetListMainSourceSoundPropertiesAsyncCallback callback) = 0;
-
- virtual void getListSourceClasses(CommonAPI::CallStatus& callStatus, am_SourceClass_L& listSourceClasses, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> getListSourceClassesAsync(GetListSourceClassesAsyncCallback callback) = 0;
-
- virtual void getListSinkClasses(CommonAPI::CallStatus& callStatus, am_SinkClass_L& listSinkClasses, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> getListSinkClassesAsync(GetListSinkClassesAsyncCallback callback) = 0;
-
- virtual void getListSystemProperties(CommonAPI::CallStatus& callStatus, am_SystemProperty_L& listSystemProperties, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> getListSystemPropertiesAsync(GetListSystemPropertiesAsyncCallback callback) = 0;
-
- virtual void getTimingInformation(const am_mainConnectionID_t& mainConnectionID, CommonAPI::CallStatus& callStatus, am_timeSync_t& delay, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> getTimingInformationAsync(const am_mainConnectionID_t& mainConnectionID, GetTimingInformationAsyncCallback callback) = 0;
-
- virtual void getListMainSinkNotificationConfigurations(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> getListMainSinkNotificationConfigurationsAsync(const am_sinkID_t& sinkID, GetListMainSinkNotificationConfigurationsAsyncCallback callback) = 0;
-
- virtual void getListMainSourceNotificationConfigurations(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> getListMainSourceNotificationConfigurationsAsync(const am_sourceID_t& sourceID, GetListMainSourceNotificationConfigurationsAsyncCallback callback) = 0;
-
- virtual void setMainSinkNotificationConfiguration(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> setMainSinkNotificationConfigurationAsync(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration, SetMainSinkNotificationConfigurationAsyncCallback callback) = 0;
-
- virtual void setMainSourceNotificationConfiguration(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0;
- virtual std::future<CommonAPI::CallStatus> setMainSourceNotificationConfigurationAsync(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration, SetMainSourceNotificationConfigurationAsyncCallback callback) = 0;
- };
-
- } // namespace am
- } // namespace genivi
- } // namespace org
-
- #endif // ORG_GENIVI_AM_Command_Control_PROXY_BASE_H_
+#endif // ORG_GENIVI_AM_Command_Control_PROXY_BASE_H_
diff --git a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlStub.h b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlStub.h
index 838a7e6..d7819a3 100644
--- a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlStub.h
+++ b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlStub.h
@@ -1,28 +1,31 @@
/*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* 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/.
-*
+* This file was generated by the CommonAPI Generators.
+* Used org.genivi.commonapi.core 2.1.1.201309251246.
+* Used org.franca.core 0.8.9.201308271211.
*
+* Copyright (c) 2012 BMW
+*
* \author Aleksandar Donchev, aleksander.donchev@partner.bmw.de BMW 2013
-* \author Christian Linke christian.linke@bmw.de BMW 2013
-*
+*
+* \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.
+*
* For further information see http://www.genivi.org/.
*/
+/**
+ * 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
+ */
#ifndef ORG_GENIVI_AM_Command_Control_STUB_H_
#define ORG_GENIVI_AM_Command_Control_STUB_H_
@@ -32,13 +35,16 @@
#include "CommandControl.h"
+#if !defined (COMMONAPI_INTERNAL_COMPILATION)
#define COMMONAPI_INTERNAL_COMPILATION
+#endif
#include <CommonAPI/InputStream.h>
#include <CommonAPI/OutputStream.h>
#include <CommonAPI/SerializableStruct.h>
#include <cstdint>
#include <string>
+#include <unordered_set>
#include <vector>
#include <CommonAPI/Stub.h>
@@ -173,6 +179,15 @@ class CommandControlStubAdapter: virtual public CommonAPI::StubAdapter, public C
* Instead, the "fire<broadcastName>Event" methods of the stub should be used.
*/
virtual void fireMainSourceNotificationConfigurationChangedEvent(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration) = 0;
+
+
+ virtual void deactivateManagedInstances() = 0;
+
+protected:
+ /**
+ * Defines properties for storing the ClientIds of clients / proxies that have
+ * subscribed to the selective broadcasts
+ */
};
@@ -206,95 +221,276 @@ class CommandControlStub : public CommonAPI::Stub<CommandControlStubAdapter , Co
virtual ~CommandControlStub() { }
+ /**
+ * 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
+ */
/// This is the method that will be called on remote calls on the method connect.
- virtual void connect(am_sourceID_t sourceID, am_sinkID_t sinkID, am_mainConnectionID_t& mainConnectionID, am_Error_e& error) = 0;
+ virtual void connect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_sinkID_t sinkID, am_mainConnectionID_t& mainConnectionID, am_Error_e& error) = 0;
+ /**
+ * disconnects a mainConnection
+ (at)return E_OK on successes, E_NON_EXISTENT if
+ * the connection does not exist, E_NOT_POSSIBLE on error.
+ */
/// This is the method that will be called on remote calls on the method disconnect.
- virtual void disconnect(am_mainConnectionID_t mainConnectionID, am_Error_e& error) = 0;
+ virtual void disconnect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_mainConnectionID_t mainConnectionID, am_Error_e& error) = 0;
+ /**
+ * 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
+ */
/// This is the method that will be called on remote calls on the method setVolume.
- virtual void setVolume(am_sinkID_t sinkID, am_mainVolume_t volume, am_Error_e& error) = 0;
+ virtual void setVolume(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_mainVolume_t volume, am_Error_e& error) = 0;
+ /**
+ * 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.
+ */
/// This is the method that will be called on remote calls on the method volumeStep.
- virtual void volumeStep(am_sinkID_t sinkID, int16_t volumeStep, am_Error_e& error) = 0;
+ virtual void volumeStep(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, int16_t volumeStep_, am_Error_e& error) = 0;
+ /**
+ * 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.
+ */
/// This is the method that will be called on remote calls on the method setSinkMuteState.
- virtual void setSinkMuteState(am_sinkID_t sinkID, am_MuteState_e muteState, am_Error_e& error) = 0;
+ virtual void setSinkMuteState(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_MuteState_e muteState, am_Error_e& error) = 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
+ (at)return E_OK on success, E_OUT_OF_RANGE if value
+ * exceeds range, E_UNKNOWN in case of an error
+ */
/// This is the method that will be called on remote calls on the method setMainSinkSoundProperty.
- virtual void setMainSinkSoundProperty(am_sinkID_t sinkID, am_MainSoundProperty_s soundProperty, am_Error_e& error) = 0;
+ virtual void setMainSinkSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_MainSoundProperty_s soundProperty, am_Error_e& error) = 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
+ (at)return E_OK on success, E_OUT_OF_RANGE if value
+ * exceeds range, E_UNKNOWN in case of an error
+ */
/// This is the method that will be called on remote calls on the method setMainSourceSoundProperty.
- virtual void setMainSourceSoundProperty(am_sourceID_t sourceID, am_MainSoundProperty_s soundProperty, am_Error_e& error) = 0;
+ virtual void setMainSourceSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_MainSoundProperty_s soundProperty, am_Error_e& error) = 0;
+ /**
+ * 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
+ */
/// This is the method that will be called on remote calls on the method setSystemProperty.
- virtual void setSystemProperty(am_SystemProperty_s property, am_Error_e& error) = 0;
+ virtual void setSystemProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SystemProperty_s property, am_Error_e& error) = 0;
+ /**
+ * returns the actual list of MainConnections
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
/// This is the method that will be called on remote calls on the method getListMainConnections.
- virtual void getListMainConnections(am_MainConnection_L& listConnections, am_Error_e& error) = 0;
+ virtual void getListMainConnections(const std::shared_ptr<CommonAPI::ClientId> clientId, am_MainConnection_L& listConnections, am_Error_e& error) = 0;
+ /**
+ * returns the actual list of Sinks
+ (at)return E_OK on success, E_DATABASE_ERROR
+ * on error
+ */
/// This is the method that will be called on remote calls on the method getListMainSinks.
- virtual void getListMainSinks(am_SinkType_L& listMainSinks, am_Error_e& error) = 0;
+ virtual void getListMainSinks(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SinkType_L& listMainSinks, am_Error_e& error) = 0;
+ /**
+ * returns the actual list of Sources
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
/// This is the method that will be called on remote calls on the method getListMainSources.
- virtual void getListMainSources(am_SourceType_L& listMainSources, am_Error_e& error) = 0;
+ virtual void getListMainSources(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SourceType_L& listMainSources, am_Error_e& error) = 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
+ (at)return E_OK
+ * on success, E_DATABASE_ERROR on error
+ */
/// This is the method that will be called on remote calls on the method getListMainSinkSoundProperties.
- virtual void getListMainSinkSoundProperties(am_sinkID_t sinkID, am_MainSoundProperty_L& listSoundProperties, am_Error_e& error) = 0;
+ virtual void getListMainSinkSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_MainSoundProperty_L& listSoundProperties, am_Error_e& error) = 0;
+ /**
+ * This is used to retrieve all source sound properties related to a
+ * source.
+ (at)return E_OK on success, E_DATABASE_ERROR on error
+ */
/// This is the method that will be called on remote calls on the method getListMainSourceSoundProperties.
- virtual void getListMainSourceSoundProperties(am_sourceID_t sourceID, am_MainSoundProperty_L& listSourceProperties, am_Error_e& error) = 0;
+ virtual void getListMainSourceSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_MainSoundProperty_L& listSourceProperties, am_Error_e& error) = 0;
+ /**
+ * This is used to retrieve SourceClass Information of all source classes
+ *
+ (at)return E_OK on success, E_DATABASE_ERROR on error
+ */
/// This is the method that will be called on remote calls on the method getListSourceClasses.
- virtual void getListSourceClasses(am_SourceClass_L& listSourceClasses, am_Error_e& error) = 0;
+ virtual void getListSourceClasses(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SourceClass_L& listSourceClasses, am_Error_e& error) = 0;
+ /**
+ * This is used to retrieve SinkClass Information of all sink classes
+ (at)return
+ * E_OK on success, E_DATABASE_ERROR on error
+ */
/// This is the method that will be called on remote calls on the method getListSinkClasses.
- virtual void getListSinkClasses(am_SinkClass_L& listSinkClasses, am_Error_e& error) = 0;
+ virtual void getListSinkClasses(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SinkClass_L& listSinkClasses, am_Error_e& error) = 0;
+ /**
+ * Retrieves a complete list of all systemProperties.
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
/// This is the method that will be called on remote calls on the method getListSystemProperties.
- virtual void getListSystemProperties(am_SystemProperty_L& listSystemProperties, am_Error_e& error) = 0;
+ virtual void getListSystemProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SystemProperty_L& listSystemProperties, am_Error_e& error) = 0;
+ /**
+ * 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
+ */
/// This is the method that will be called on remote calls on the method getTimingInformation.
- virtual void getTimingInformation(am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay, am_Error_e& error) = 0;
+ virtual void getTimingInformation(const std::shared_ptr<CommonAPI::ClientId> clientId, am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay, am_Error_e& error) = 0;
+ /**
+ * Retrieves the list of MainNotifications for a sink. Does not return the
+ * possible ones.
+ */
/// This is the method that will be called on remote calls on the method getListMainSinkNotificationConfigurations.
- virtual void getListMainSinkNotificationConfigurations(am_sinkID_t sinkID, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) = 0;
+ virtual void getListMainSinkNotificationConfigurations(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) = 0;
+ /**
+ * Retrieves the list of MainNotifications for a source. Does not return the
+ * possible ones.
+ */
/// This is the method that will be called on remote calls on the method getListMainSourceNotificationConfigurations.
- virtual void getListMainSourceNotificationConfigurations(am_sourceID_t sourceID, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) = 0;
+ virtual void getListMainSourceNotificationConfigurations(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) = 0;
+ /**
+ * 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
+ */
/// This is the method that will be called on remote calls on the method setMainSinkNotificationConfiguration.
- virtual void setMainSinkNotificationConfiguration(am_sinkID_t sinkID, am_NotificationConfiguration_s mainNotificationConfiguration, am_Error_e& error) = 0;
+ virtual void setMainSinkNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_NotificationConfiguration_s mainNotificationConfiguration, am_Error_e& error) = 0;
+ /**
+ * 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
+ */
/// This is the method that will be called on remote calls on the method setMainSourceNotificationConfiguration.
- virtual void setMainSourceNotificationConfiguration(am_sourceID_t sourceID, am_NotificationConfiguration_s mainNotificationConfiguration, am_Error_e& error) = 0;
-
+ virtual void setMainSourceNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_NotificationConfiguration_s mainNotificationConfiguration, am_Error_e& error) = 0;
+ /**
+ * Callback that is called when the number of connections change
+ */
/// Sends a broadcast event for newMainConnection.
virtual void fireNewMainConnectionEvent(const am_MainConnectionType_s& mainConnection) = 0;
+ /**
+ * Callback that is called when the number of connections change
+ */
/// Sends a broadcast event for removedMainConnection.
virtual void fireRemovedMainConnectionEvent(const am_mainConnectionID_t& mainConnection) = 0;
+ /**
+ * Callback that is called when the number of sinks change
+ */
/// Sends a broadcast event for newSink.
virtual void fireNewSinkEvent(const am_SinkType_s& sink) = 0;
+ /**
+ * Callback that is called when the number of sinks change
+ */
/// Sends a broadcast event for removedSink.
virtual void fireRemovedSinkEvent(const am_sinkID_t& sinkID) = 0;
+ /**
+ * Callback that is called when the number of sources change
+ */
/// Sends a broadcast event for newSource.
virtual void fireNewSourceEvent(const am_SourceType_s& source) = 0;
+ /**
+ * Callback that is called when the number of sources change
+ */
/// Sends a broadcast event for removedSource.
virtual void fireRemovedSourceEvent(const am_sourceID_t& source) = 0;
+ /**
+ * this callback is fired if the number of sink classes changed
+ */
/// Sends a broadcast event for numberOfSinkClassesChanged.
virtual void fireNumberOfSinkClassesChangedEvent() = 0;
+ /**
+ * this callback is fired if the number of source classes changed
+ */
/// Sends a broadcast event for numberOfSourceClassesChanged.
virtual void fireNumberOfSourceClassesChangedEvent() = 0;
+ /**
+ * This callback is called when the ConnectionState of a connection changed.
+ */
/// Sends a broadcast event for mainConnectionStateChanged.
virtual void fireMainConnectionStateChangedEvent(const am_mainConnectionID_t& connectionID, const am_ConnectionState_e& connectionState) = 0;
+ /**
+ * this callback indicates that a sinkSoundProperty has changed.
+ */
/// Sends a broadcast event for mainSinkSoundPropertyChanged.
virtual void fireMainSinkSoundPropertyChangedEvent(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty) = 0;
+ /**
+ * this callback indicates that a sourceSoundProperty has changed.
+ */
/// Sends a broadcast event for mainSourceSoundPropertyChanged.
virtual void fireMainSourceSoundPropertyChangedEvent(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty) = 0;
+ /**
+ * this callback is called when the availability of a sink has changed
+ */
/// Sends a broadcast event for sinkAvailabilityChanged.
virtual void fireSinkAvailabilityChangedEvent(const am_sinkID_t& sinkID, const am_Availability_s& availability) = 0;
+ /**
+ * this callback is called when the availability of source has changed.
+ */
/// Sends a broadcast event for sourceAvailabilityChanged.
virtual void fireSourceAvailabilityChangedEvent(const am_sourceID_t& sourceID, const am_Availability_s& availability) = 0;
+ /**
+ * this callback indicates a volume change on the indicated sink
+ */
/// Sends a broadcast event for volumeChanged.
virtual void fireVolumeChangedEvent(const am_sinkID_t& sinkID, const am_mainVolume_t& volume) = 0;
+ /**
+ * this callback indicates a mute state change on a sink.
+ */
/// Sends a broadcast event for sinkMuteStateChanged.
virtual void fireSinkMuteStateChangedEvent(const am_sinkID_t& sinkID, const am_MuteState_e& muteState) = 0;
+ /**
+ * is fired if a systemProperty changed
+ */
/// Sends a broadcast event for systemPropertyChanged.
virtual void fireSystemPropertyChangedEvent(const am_SystemProperty_s& systemProperty) = 0;
+ /**
+ * This callback is fired if the timinginformation for a mainConnectionID changed
+ */
/// Sends a broadcast event for timingInformationChanged.
virtual void fireTimingInformationChangedEvent(const am_mainConnectionID_t& mainConnectionID, const am_timeSync_t& time) = 0;
+ /**
+ * This callback is called when a sink is updated.
+ */
/// Sends a broadcast event for sinkUpdated.
virtual void fireSinkUpdatedEvent(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_MainSoundProperty_L& listMainSoundProperties) = 0;
+ /**
+ * This callback is called when a source is updated.
+ */
/// Sends a broadcast event for sourceUpdated.
virtual void fireSourceUpdatedEvent(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_MainSoundProperty_L& listMainSoundProperties) = 0;
+ /**
+ * This callback is called when a notificated value of a sink changes.
+ */
/// Sends a broadcast event for sinkNotification.
virtual void fireSinkNotificationEvent(const am_sinkID_t& sinkID, const am_NotificationPayload_s& notification) = 0;
+ /**
+ * This callback is called when a notifcated value of a source changes.
+ */
/// Sends a broadcast event for sourceNotification.
virtual void fireSourceNotificationEvent(const am_sourceID_t& sourceID, const am_NotificationPayload_s& notification) = 0;
+ /**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
/// Sends a broadcast event for mainSinkNotificationConfigurationChanged.
virtual void fireMainSinkNotificationConfigurationChangedEvent(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration) = 0;
+ /**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
/// Sends a broadcast event for mainSourceNotificationConfigurationChanged.
virtual void fireMainSourceNotificationConfigurationChangedEvent(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration) = 0;
+
};
} // namespace am
diff --git a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlStubDefault.cpp b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlStubDefault.cpp
index 9e8e39b..9040c71 100644
--- a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlStubDefault.cpp
+++ b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlStubDefault.cpp
@@ -1,26 +1,21 @@
/*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* 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/.
-*
+* This file was generated by the CommonAPI Generators.
+* Used org.genivi.commonapi.core 2.1.1.201309251246.
+* Used org.franca.core 0.8.9.201308271211.
*
+* Copyright (c) 2012 BMW
+*
* \author Aleksandar Donchev, aleksander.donchev@partner.bmw.de BMW 2013
-* \author Christian Linke christian.linke@bmw.de BMW 2013
-*
+*
+* \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.
+*
* For further information see http://www.genivi.org/.
*/
#include <org/genivi/am/CommandControlStubDefault.h>
@@ -39,161 +34,427 @@ CommandControlStubRemoteEvent* CommandControlStubDefault::initStubAdapter(const
}
+/**
+ * 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
+ */
+void CommandControlStubDefault::connect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_sinkID_t sinkID, am_mainConnectionID_t& mainConnectionID, am_Error_e& error) {
+ // Call old style methods in default
+ connect(sourceID, sinkID, mainConnectionID, error);
+}
void CommandControlStubDefault::connect(am_sourceID_t sourceID, am_sinkID_t sinkID, am_mainConnectionID_t& mainConnectionID, am_Error_e& error) {
// No operation in default
}
+/**
+ * disconnects a mainConnection
+(at)return E_OK on successes, E_NON_EXISTENT if
+ * the connection does not exist, E_NOT_POSSIBLE on error.
+ */
+void CommandControlStubDefault::disconnect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_mainConnectionID_t mainConnectionID, am_Error_e& error) {
+ // Call old style methods in default
+ disconnect(mainConnectionID, error);
+}
void CommandControlStubDefault::disconnect(am_mainConnectionID_t mainConnectionID, am_Error_e& error) {
// No operation in default
}
+/**
+ * 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
+ */
+void CommandControlStubDefault::setVolume(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_mainVolume_t volume, am_Error_e& error) {
+ // Call old style methods in default
+ setVolume(sinkID, volume, error);
+}
void CommandControlStubDefault::setVolume(am_sinkID_t sinkID, am_mainVolume_t volume, am_Error_e& error) {
// No operation in default
}
-void CommandControlStubDefault::volumeStep(am_sinkID_t sinkID, int16_t volumeStep, am_Error_e& error) {
+/**
+ * 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.
+ */
+void CommandControlStubDefault::volumeStep(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, int16_t volumeStep_, am_Error_e& error) {
+ // Call old style methods in default
+ volumeStep(sinkID, volumeStep_, error);
+}
+void CommandControlStubDefault::volumeStep(am_sinkID_t sinkID, int16_t volumeStep_, am_Error_e& error) {
// No operation in default
}
+/**
+ * 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.
+ */
+void CommandControlStubDefault::setSinkMuteState(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_MuteState_e muteState, am_Error_e& error) {
+ // Call old style methods in default
+ setSinkMuteState(sinkID, muteState, error);
+}
void CommandControlStubDefault::setSinkMuteState(am_sinkID_t sinkID, am_MuteState_e muteState, am_Error_e& error) {
// No operation in default
}
+/**
+ * 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
+ */
+void CommandControlStubDefault::setMainSinkSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_MainSoundProperty_s soundProperty, am_Error_e& error) {
+ // Call old style methods in default
+ setMainSinkSoundProperty(sinkID, soundProperty, error);
+}
void CommandControlStubDefault::setMainSinkSoundProperty(am_sinkID_t sinkID, am_MainSoundProperty_s soundProperty, am_Error_e& error) {
// No operation in default
}
+/**
+ * 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
+ */
+void CommandControlStubDefault::setMainSourceSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_MainSoundProperty_s soundProperty, am_Error_e& error) {
+ // Call old style methods in default
+ setMainSourceSoundProperty(sourceID, soundProperty, error);
+}
void CommandControlStubDefault::setMainSourceSoundProperty(am_sourceID_t sourceID, am_MainSoundProperty_s soundProperty, am_Error_e& error) {
// No operation in default
}
+/**
+ * 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
+ */
+void CommandControlStubDefault::setSystemProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SystemProperty_s property, am_Error_e& error) {
+ // Call old style methods in default
+ setSystemProperty(property, error);
+}
void CommandControlStubDefault::setSystemProperty(am_SystemProperty_s property, am_Error_e& error) {
// No operation in default
}
+/**
+ * returns the actual list of MainConnections
+(at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
+void CommandControlStubDefault::getListMainConnections(const std::shared_ptr<CommonAPI::ClientId> clientId, am_MainConnection_L& listConnections, am_Error_e& error) {
+ // Call old style methods in default
+ getListMainConnections(listConnections, error);
+}
void CommandControlStubDefault::getListMainConnections(am_MainConnection_L& listConnections, am_Error_e& error) {
// No operation in default
}
+/**
+ * returns the actual list of Sinks
+(at)return E_OK on success, E_DATABASE_ERROR
+ * on error
+ */
+void CommandControlStubDefault::getListMainSinks(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SinkType_L& listMainSinks, am_Error_e& error) {
+ // Call old style methods in default
+ getListMainSinks(listMainSinks, error);
+}
void CommandControlStubDefault::getListMainSinks(am_SinkType_L& listMainSinks, am_Error_e& error) {
// No operation in default
}
+/**
+ * returns the actual list of Sources
+(at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
+void CommandControlStubDefault::getListMainSources(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SourceType_L& listMainSources, am_Error_e& error) {
+ // Call old style methods in default
+ getListMainSources(listMainSources, error);
+}
void CommandControlStubDefault::getListMainSources(am_SourceType_L& listMainSources, am_Error_e& error) {
// No operation in default
}
+/**
+ * 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
+ */
+void CommandControlStubDefault::getListMainSinkSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_MainSoundProperty_L& listSoundProperties, am_Error_e& error) {
+ // Call old style methods in default
+ getListMainSinkSoundProperties(sinkID, listSoundProperties, error);
+}
void CommandControlStubDefault::getListMainSinkSoundProperties(am_sinkID_t sinkID, am_MainSoundProperty_L& listSoundProperties, am_Error_e& error) {
// No operation in default
}
+/**
+ * This is used to retrieve all source sound properties related to a
+ * source.
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ */
+void CommandControlStubDefault::getListMainSourceSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_MainSoundProperty_L& listSourceProperties, am_Error_e& error) {
+ // Call old style methods in default
+ getListMainSourceSoundProperties(sourceID, listSourceProperties, error);
+}
void CommandControlStubDefault::getListMainSourceSoundProperties(am_sourceID_t sourceID, am_MainSoundProperty_L& listSourceProperties, am_Error_e& error) {
// No operation in default
}
+/**
+ * This is used to retrieve SourceClass Information of all source classes
+ *
+(at)return E_OK on success, E_DATABASE_ERROR on error
+ */
+void CommandControlStubDefault::getListSourceClasses(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SourceClass_L& listSourceClasses, am_Error_e& error) {
+ // Call old style methods in default
+ getListSourceClasses(listSourceClasses, error);
+}
void CommandControlStubDefault::getListSourceClasses(am_SourceClass_L& listSourceClasses, am_Error_e& error) {
// No operation in default
}
+/**
+ * This is used to retrieve SinkClass Information of all sink classes
+(at)return
+ * E_OK on success, E_DATABASE_ERROR on error
+ */
+void CommandControlStubDefault::getListSinkClasses(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SinkClass_L& listSinkClasses, am_Error_e& error) {
+ // Call old style methods in default
+ getListSinkClasses(listSinkClasses, error);
+}
void CommandControlStubDefault::getListSinkClasses(am_SinkClass_L& listSinkClasses, am_Error_e& error) {
// No operation in default
}
+/**
+ * Retrieves a complete list of all systemProperties.
+(at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
+void CommandControlStubDefault::getListSystemProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SystemProperty_L& listSystemProperties, am_Error_e& error) {
+ // Call old style methods in default
+ getListSystemProperties(listSystemProperties, error);
+}
void CommandControlStubDefault::getListSystemProperties(am_SystemProperty_L& listSystemProperties, am_Error_e& error) {
// No operation in default
}
+/**
+ * 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
+ */
+void CommandControlStubDefault::getTimingInformation(const std::shared_ptr<CommonAPI::ClientId> clientId, am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay, am_Error_e& error) {
+ // Call old style methods in default
+ getTimingInformation(mainConnectionID, delay, error);
+}
void CommandControlStubDefault::getTimingInformation(am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay, am_Error_e& error) {
// No operation in default
}
+/**
+ * Retrieves the list of MainNotifications for a sink. Does not return the
+ * possible ones.
+ */
+void CommandControlStubDefault::getListMainSinkNotificationConfigurations(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) {
+ // Call old style methods in default
+ getListMainSinkNotificationConfigurations(sinkID, listMainNotificationConfigurations, error);
+}
void CommandControlStubDefault::getListMainSinkNotificationConfigurations(am_sinkID_t sinkID, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) {
// No operation in default
}
+/**
+ * Retrieves the list of MainNotifications for a source. Does not return the
+ * possible ones.
+ */
+void CommandControlStubDefault::getListMainSourceNotificationConfigurations(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) {
+ // Call old style methods in default
+ getListMainSourceNotificationConfigurations(sourceID, listMainNotificationConfigurations, error);
+}
void CommandControlStubDefault::getListMainSourceNotificationConfigurations(am_sourceID_t sourceID, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error) {
// No operation in default
}
+/**
+ * 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
+ */
+void CommandControlStubDefault::setMainSinkNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_NotificationConfiguration_s mainNotificationConfiguration, am_Error_e& error) {
+ // Call old style methods in default
+ setMainSinkNotificationConfiguration(sinkID, mainNotificationConfiguration, error);
+}
void CommandControlStubDefault::setMainSinkNotificationConfiguration(am_sinkID_t sinkID, am_NotificationConfiguration_s mainNotificationConfiguration, am_Error_e& error) {
// No operation in default
}
+/**
+ * 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
+ */
+void CommandControlStubDefault::setMainSourceNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_NotificationConfiguration_s mainNotificationConfiguration, am_Error_e& error) {
+ // Call old style methods in default
+ setMainSourceNotificationConfiguration(sourceID, mainNotificationConfiguration, error);
+}
void CommandControlStubDefault::setMainSourceNotificationConfiguration(am_sourceID_t sourceID, am_NotificationConfiguration_s mainNotificationConfiguration, am_Error_e& error) {
// No operation in default
}
+/**
+ * Callback that is called when the number of connections change
+ */
void CommandControlStubDefault::fireNewMainConnectionEvent(const am_MainConnectionType_s& mainConnection) {
stubAdapter_->fireNewMainConnectionEvent(mainConnection);
}
+/**
+ * Callback that is called when the number of connections change
+ */
void CommandControlStubDefault::fireRemovedMainConnectionEvent(const am_mainConnectionID_t& mainConnection) {
stubAdapter_->fireRemovedMainConnectionEvent(mainConnection);
}
+/**
+ * Callback that is called when the number of sinks change
+ */
void CommandControlStubDefault::fireNewSinkEvent(const am_SinkType_s& sink) {
stubAdapter_->fireNewSinkEvent(sink);
}
+/**
+ * Callback that is called when the number of sinks change
+ */
void CommandControlStubDefault::fireRemovedSinkEvent(const am_sinkID_t& sinkID) {
stubAdapter_->fireRemovedSinkEvent(sinkID);
}
+/**
+ * Callback that is called when the number of sources change
+ */
void CommandControlStubDefault::fireNewSourceEvent(const am_SourceType_s& source) {
stubAdapter_->fireNewSourceEvent(source);
}
+/**
+ * Callback that is called when the number of sources change
+ */
void CommandControlStubDefault::fireRemovedSourceEvent(const am_sourceID_t& source) {
stubAdapter_->fireRemovedSourceEvent(source);
}
+/**
+ * this callback is fired if the number of sink classes changed
+ */
void CommandControlStubDefault::fireNumberOfSinkClassesChangedEvent() {
stubAdapter_->fireNumberOfSinkClassesChangedEvent();
}
+/**
+ * this callback is fired if the number of source classes changed
+ */
void CommandControlStubDefault::fireNumberOfSourceClassesChangedEvent() {
stubAdapter_->fireNumberOfSourceClassesChangedEvent();
}
+/**
+ * This callback is called when the ConnectionState of a connection changed.
+ */
void CommandControlStubDefault::fireMainConnectionStateChangedEvent(const am_mainConnectionID_t& connectionID, const am_ConnectionState_e& connectionState) {
stubAdapter_->fireMainConnectionStateChangedEvent(connectionID, connectionState);
}
+/**
+ * this callback indicates that a sinkSoundProperty has changed.
+ */
void CommandControlStubDefault::fireMainSinkSoundPropertyChangedEvent(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty) {
stubAdapter_->fireMainSinkSoundPropertyChangedEvent(sinkID, soundProperty);
}
+/**
+ * this callback indicates that a sourceSoundProperty has changed.
+ */
void CommandControlStubDefault::fireMainSourceSoundPropertyChangedEvent(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty) {
stubAdapter_->fireMainSourceSoundPropertyChangedEvent(sourceID, soundProperty);
}
+/**
+ * this callback is called when the availability of a sink has changed
+ */
void CommandControlStubDefault::fireSinkAvailabilityChangedEvent(const am_sinkID_t& sinkID, const am_Availability_s& availability) {
stubAdapter_->fireSinkAvailabilityChangedEvent(sinkID, availability);
}
+/**
+ * this callback is called when the availability of source has changed.
+ */
void CommandControlStubDefault::fireSourceAvailabilityChangedEvent(const am_sourceID_t& sourceID, const am_Availability_s& availability) {
stubAdapter_->fireSourceAvailabilityChangedEvent(sourceID, availability);
}
+/**
+ * this callback indicates a volume change on the indicated sink
+ */
void CommandControlStubDefault::fireVolumeChangedEvent(const am_sinkID_t& sinkID, const am_mainVolume_t& volume) {
stubAdapter_->fireVolumeChangedEvent(sinkID, volume);
}
+/**
+ * this callback indicates a mute state change on a sink.
+ */
void CommandControlStubDefault::fireSinkMuteStateChangedEvent(const am_sinkID_t& sinkID, const am_MuteState_e& muteState) {
stubAdapter_->fireSinkMuteStateChangedEvent(sinkID, muteState);
}
+/**
+ * is fired if a systemProperty changed
+ */
void CommandControlStubDefault::fireSystemPropertyChangedEvent(const am_SystemProperty_s& systemProperty) {
stubAdapter_->fireSystemPropertyChangedEvent(systemProperty);
}
+/**
+ * This callback is fired if the timinginformation for a mainConnectionID changed
+ */
void CommandControlStubDefault::fireTimingInformationChangedEvent(const am_mainConnectionID_t& mainConnectionID, const am_timeSync_t& time) {
stubAdapter_->fireTimingInformationChangedEvent(mainConnectionID, time);
}
+/**
+ * This callback is called when a sink is updated.
+ */
void CommandControlStubDefault::fireSinkUpdatedEvent(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_MainSoundProperty_L& listMainSoundProperties) {
stubAdapter_->fireSinkUpdatedEvent(sinkID, sinkClassID, listMainSoundProperties);
}
+/**
+ * This callback is called when a source is updated.
+ */
void CommandControlStubDefault::fireSourceUpdatedEvent(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_MainSoundProperty_L& listMainSoundProperties) {
stubAdapter_->fireSourceUpdatedEvent(sourceID, sourceClassID, listMainSoundProperties);
}
+/**
+ * This callback is called when a notificated value of a sink changes.
+ */
void CommandControlStubDefault::fireSinkNotificationEvent(const am_sinkID_t& sinkID, const am_NotificationPayload_s& notification) {
stubAdapter_->fireSinkNotificationEvent(sinkID, notification);
}
+/**
+ * This callback is called when a notifcated value of a source changes.
+ */
void CommandControlStubDefault::fireSourceNotificationEvent(const am_sourceID_t& sourceID, const am_NotificationPayload_s& notification) {
stubAdapter_->fireSourceNotificationEvent(sourceID, notification);
}
+/**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
void CommandControlStubDefault::fireMainSinkNotificationConfigurationChangedEvent(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration) {
stubAdapter_->fireMainSinkNotificationConfigurationChangedEvent(sinkID, mainNotificationConfiguration);
}
+/**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
void CommandControlStubDefault::fireMainSourceNotificationConfigurationChangedEvent(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration) {
stubAdapter_->fireMainSourceNotificationConfigurationChangedEvent(sourceID, mainNotificationConfiguration);
}
+
CommandControlStubDefault::RemoteEventHandler::RemoteEventHandler(CommandControlStubDefault* defaultStub):
defaultStub_(defaultStub) {
}
diff --git a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlStubDefault.h b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlStubDefault.h
index 5b30746..a18c079 100644
--- a/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlStubDefault.h
+++ b/PluginCommandInterfaceCAPI/src-gen/org/genivi/am/CommandControlStubDefault.h
@@ -1,32 +1,36 @@
/*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* This file was generated by the CommonAPI Generators.
-*
-* 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/.
-*
+* This file was generated by the CommonAPI Generators.
+* Used org.genivi.commonapi.core 2.1.1.201309251246.
+* Used org.franca.core 0.8.9.201308271211.
*
+* Copyright (c) 2012 BMW
+*
* \author Aleksandar Donchev, aleksander.donchev@partner.bmw.de BMW 2013
-* \author Christian Linke christian.linke@bmw.de BMW 2013
-*
+*
+* \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.
+*
* For further information see http://www.genivi.org/.
*/
+/**
+ * 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
+ */
#ifndef ORG_GENIVI_AM_Command_Control_STUB_DEFAULT_H_
#define ORG_GENIVI_AM_Command_Control_STUB_DEFAULT_H_
#include <org/genivi/am/CommandControlStub.h>
+#include <sstream>
namespace org {
namespace genivi {
@@ -37,7 +41,7 @@ namespace am {
* CommandControlStub. Method callbacks have an empty implementation,
* remote set calls on attributes will always change the value of the attribute
* to the one received.
- *
+ *
* Override this stub if you only want to provide a subset of the functionality
* that would be defined for this service, and/or if you do not need any non-default
* behaviour.
@@ -49,75 +53,278 @@ class CommandControlStubDefault : public CommandControlStub {
CommandControlStubRemoteEvent* initStubAdapter(const std::shared_ptr<CommandControlStubAdapter>& stubAdapter);
+ /**
+ * 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
+ */
+ virtual void connect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_sinkID_t sinkID, am_mainConnectionID_t& mainConnectionID, am_Error_e& error);
virtual void connect(am_sourceID_t sourceID, am_sinkID_t sinkID, am_mainConnectionID_t& mainConnectionID, am_Error_e& error);
+ /**
+ * disconnects a mainConnection
+ (at)return E_OK on successes, E_NON_EXISTENT if
+ * the connection does not exist, E_NOT_POSSIBLE on error.
+ */
+ virtual void disconnect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_mainConnectionID_t mainConnectionID, am_Error_e& error);
virtual void disconnect(am_mainConnectionID_t mainConnectionID, am_Error_e& error);
+ /**
+ * 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
+ */
+ virtual void setVolume(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_mainVolume_t volume, am_Error_e& error);
virtual void setVolume(am_sinkID_t sinkID, am_mainVolume_t volume, am_Error_e& error);
- virtual void volumeStep(am_sinkID_t sinkID, int16_t volumeStep, am_Error_e& error);
-
+ /**
+ * 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.
+ */
+ virtual void volumeStep(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, int16_t volumeStep_, am_Error_e& error);
+ virtual void volumeStep(am_sinkID_t sinkID, int16_t volumeStep_, am_Error_e& error);
+
+ /**
+ * 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.
+ */
+ virtual void setSinkMuteState(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_MuteState_e muteState, am_Error_e& error);
virtual void setSinkMuteState(am_sinkID_t sinkID, am_MuteState_e muteState, am_Error_e& error);
+ /**
+ * 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
+ */
+ virtual void setMainSinkSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_MainSoundProperty_s soundProperty, am_Error_e& error);
virtual void setMainSinkSoundProperty(am_sinkID_t sinkID, am_MainSoundProperty_s soundProperty, am_Error_e& error);
+ /**
+ * 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
+ */
+ virtual void setMainSourceSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_MainSoundProperty_s soundProperty, am_Error_e& error);
virtual void setMainSourceSoundProperty(am_sourceID_t sourceID, am_MainSoundProperty_s soundProperty, am_Error_e& error);
+ /**
+ * 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
+ */
+ virtual void setSystemProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SystemProperty_s property, am_Error_e& error);
virtual void setSystemProperty(am_SystemProperty_s property, am_Error_e& error);
+ /**
+ * returns the actual list of MainConnections
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
+ virtual void getListMainConnections(const std::shared_ptr<CommonAPI::ClientId> clientId, am_MainConnection_L& listConnections, am_Error_e& error);
virtual void getListMainConnections(am_MainConnection_L& listConnections, am_Error_e& error);
+ /**
+ * returns the actual list of Sinks
+ (at)return E_OK on success, E_DATABASE_ERROR
+ * on error
+ */
+ virtual void getListMainSinks(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SinkType_L& listMainSinks, am_Error_e& error);
virtual void getListMainSinks(am_SinkType_L& listMainSinks, am_Error_e& error);
+ /**
+ * returns the actual list of Sources
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
+ virtual void getListMainSources(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SourceType_L& listMainSources, am_Error_e& error);
virtual void getListMainSources(am_SourceType_L& listMainSources, am_Error_e& error);
+ /**
+ * 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
+ */
+ virtual void getListMainSinkSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_MainSoundProperty_L& listSoundProperties, am_Error_e& error);
virtual void getListMainSinkSoundProperties(am_sinkID_t sinkID, am_MainSoundProperty_L& listSoundProperties, am_Error_e& error);
+ /**
+ * This is used to retrieve all source sound properties related to a
+ * source.
+ (at)return E_OK on success, E_DATABASE_ERROR on error
+ */
+ virtual void getListMainSourceSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_MainSoundProperty_L& listSourceProperties, am_Error_e& error);
virtual void getListMainSourceSoundProperties(am_sourceID_t sourceID, am_MainSoundProperty_L& listSourceProperties, am_Error_e& error);
+ /**
+ * This is used to retrieve SourceClass Information of all source classes
+ *
+ (at)return E_OK on success, E_DATABASE_ERROR on error
+ */
+ virtual void getListSourceClasses(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SourceClass_L& listSourceClasses, am_Error_e& error);
virtual void getListSourceClasses(am_SourceClass_L& listSourceClasses, am_Error_e& error);
+ /**
+ * This is used to retrieve SinkClass Information of all sink classes
+ (at)return
+ * E_OK on success, E_DATABASE_ERROR on error
+ */
+ virtual void getListSinkClasses(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SinkClass_L& listSinkClasses, am_Error_e& error);
virtual void getListSinkClasses(am_SinkClass_L& listSinkClasses, am_Error_e& error);
+ /**
+ * Retrieves a complete list of all systemProperties.
+ (at)return E_OK on success,
+ * E_DATABASE_ERROR on error
+ */
+ virtual void getListSystemProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_SystemProperty_L& listSystemProperties, am_Error_e& error);
virtual void getListSystemProperties(am_SystemProperty_L& listSystemProperties, am_Error_e& error);
+ /**
+ * 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
+ */
+ virtual void getTimingInformation(const std::shared_ptr<CommonAPI::ClientId> clientId, am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay, am_Error_e& error);
virtual void getTimingInformation(am_mainConnectionID_t mainConnectionID, am_timeSync_t& delay, am_Error_e& error);
+ /**
+ * Retrieves the list of MainNotifications for a sink. Does not return the
+ * possible ones.
+ */
+ virtual void getListMainSinkNotificationConfigurations(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error);
virtual void getListMainSinkNotificationConfigurations(am_sinkID_t sinkID, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error);
+ /**
+ * Retrieves the list of MainNotifications for a source. Does not return the
+ * possible ones.
+ */
+ virtual void getListMainSourceNotificationConfigurations(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error);
virtual void getListMainSourceNotificationConfigurations(am_sourceID_t sourceID, am_NotificationConfiguration_L& listMainNotificationConfigurations, am_Error_e& error);
+ /**
+ * 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
+ */
+ virtual void setMainSinkNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_NotificationConfiguration_s mainNotificationConfiguration, am_Error_e& error);
virtual void setMainSinkNotificationConfiguration(am_sinkID_t sinkID, am_NotificationConfiguration_s mainNotificationConfiguration, am_Error_e& error);
+ /**
+ * 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
+ */
+ virtual void setMainSourceNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_NotificationConfiguration_s mainNotificationConfiguration, am_Error_e& error);
virtual void setMainSourceNotificationConfiguration(am_sourceID_t sourceID, am_NotificationConfiguration_s mainNotificationConfiguration, am_Error_e& error);
-
+
+ /**
+ * Callback that is called when the number of connections change
+ */
virtual void fireNewMainConnectionEvent(const am_MainConnectionType_s& mainConnection);
+ /**
+ * Callback that is called when the number of connections change
+ */
virtual void fireRemovedMainConnectionEvent(const am_mainConnectionID_t& mainConnection);
+ /**
+ * Callback that is called when the number of sinks change
+ */
virtual void fireNewSinkEvent(const am_SinkType_s& sink);
+ /**
+ * Callback that is called when the number of sinks change
+ */
virtual void fireRemovedSinkEvent(const am_sinkID_t& sinkID);
+ /**
+ * Callback that is called when the number of sources change
+ */
virtual void fireNewSourceEvent(const am_SourceType_s& source);
+ /**
+ * Callback that is called when the number of sources change
+ */
virtual void fireRemovedSourceEvent(const am_sourceID_t& source);
+ /**
+ * this callback is fired if the number of sink classes changed
+ */
virtual void fireNumberOfSinkClassesChangedEvent();
+ /**
+ * this callback is fired if the number of source classes changed
+ */
virtual void fireNumberOfSourceClassesChangedEvent();
+ /**
+ * This callback is called when the ConnectionState of a connection changed.
+ */
virtual void fireMainConnectionStateChangedEvent(const am_mainConnectionID_t& connectionID, const am_ConnectionState_e& connectionState);
+ /**
+ * this callback indicates that a sinkSoundProperty has changed.
+ */
virtual void fireMainSinkSoundPropertyChangedEvent(const am_sinkID_t& sinkID, const am_MainSoundProperty_s& soundProperty);
+ /**
+ * this callback indicates that a sourceSoundProperty has changed.
+ */
virtual void fireMainSourceSoundPropertyChangedEvent(const am_sourceID_t& sourceID, const am_MainSoundProperty_s& soundProperty);
+ /**
+ * this callback is called when the availability of a sink has changed
+ */
virtual void fireSinkAvailabilityChangedEvent(const am_sinkID_t& sinkID, const am_Availability_s& availability);
+ /**
+ * this callback is called when the availability of source has changed.
+ */
virtual void fireSourceAvailabilityChangedEvent(const am_sourceID_t& sourceID, const am_Availability_s& availability);
+ /**
+ * this callback indicates a volume change on the indicated sink
+ */
virtual void fireVolumeChangedEvent(const am_sinkID_t& sinkID, const am_mainVolume_t& volume);
+ /**
+ * this callback indicates a mute state change on a sink.
+ */
virtual void fireSinkMuteStateChangedEvent(const am_sinkID_t& sinkID, const am_MuteState_e& muteState);
+ /**
+ * is fired if a systemProperty changed
+ */
virtual void fireSystemPropertyChangedEvent(const am_SystemProperty_s& systemProperty);
+ /**
+ * This callback is fired if the timinginformation for a mainConnectionID changed
+ */
virtual void fireTimingInformationChangedEvent(const am_mainConnectionID_t& mainConnectionID, const am_timeSync_t& time);
+ /**
+ * This callback is called when a sink is updated.
+ */
virtual void fireSinkUpdatedEvent(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_MainSoundProperty_L& listMainSoundProperties);
+ /**
+ * This callback is called when a source is updated.
+ */
virtual void fireSourceUpdatedEvent(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_MainSoundProperty_L& listMainSoundProperties);
+ /**
+ * This callback is called when a notificated value of a sink changes.
+ */
virtual void fireSinkNotificationEvent(const am_sinkID_t& sinkID, const am_NotificationPayload_s& notification);
+ /**
+ * This callback is called when a notifcated value of a source changes.
+ */
virtual void fireSourceNotificationEvent(const am_sourceID_t& sourceID, const am_NotificationPayload_s& notification);
+ /**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
virtual void fireMainSinkNotificationConfigurationChangedEvent(const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& mainNotificationConfiguration);
+ /**
+ * This callback is triggered when a mainNotificationConfiguration is changed.
+ */
virtual void fireMainSourceNotificationConfigurationChangedEvent(const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& mainNotificationConfiguration);
+
protected:
-
+ std::shared_ptr<CommandControlStubAdapter> stubAdapter_;
private:
class RemoteEventHandler: public CommandControlStubRemoteEvent {
public:
@@ -129,7 +336,6 @@ class CommandControlStubDefault : public CommandControlStub {
};
RemoteEventHandler remoteEventHandler_;
- std::shared_ptr<CommandControlStubAdapter> stubAdapter_;
};