diff options
Diffstat (limited to 'PluginRoutingInterfaceCAPI/src-gen/org/genivi/am')
20 files changed, 4159 insertions, 1233 deletions
diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControl.h b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControl.h index 04818d5..76c05a7 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControl.h +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControl.h @@ -1,34 +1,35 @@ /* -* 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/. */ +/** + * This class implements everything from Audiomanager -> RoutingAdapter + * @author Christian Mueller + */ #ifndef ORG_GENIVI_AM_Routing_Control_H_ #define ORG_GENIVI_AM_Routing_Control_H_ +#if !defined (COMMONAPI_INTERNAL_COMPILATION) #define COMMONAPI_INTERNAL_COMPILATION +#endif #include <CommonAPI/types.h> @@ -47,7 +48,8 @@ class RoutingControl { }; const char* RoutingControl::getInterfaceId() { - return "org.genivi.am.RoutingControl"; + static const char* interfaceId = "org.genivi.am.RoutingControl"; + return interfaceId; } CommonAPI::Version RoutingControl::getInterfaceVersion() { diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusProxy.cpp b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusProxy.cpp index dfb0e8c..7183537 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusProxy.cpp +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusProxy.cpp @@ -1,28 +1,27 @@ /* -* 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/. */ +/** + * This class implements everything from Audiomanager -> RoutingAdapter + * @author Christian Mueller + */ #include "RoutingControlDBusProxy.h" namespace org { @@ -30,12 +29,13 @@ namespace genivi { namespace am { std::shared_ptr<CommonAPI::DBus::DBusProxy> createRoutingControlDBusProxy( + 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<RoutingControlDBusProxy>(commonApiAddress, interfaceName, busName, objectPath, dbusProxyConnection); + return std::make_shared<RoutingControlDBusProxy>(factory, commonApiAddress, interfaceName, busName, objectPath, dbusProxyConnection); } __attribute__((constructor)) void registerRoutingControlDBusProxy(void) { @@ -44,17 +44,23 @@ __attribute__((constructor)) void registerRoutingControlDBusProxy(void) { } RoutingControlDBusProxy::RoutingControlDBusProxy( + 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) + { + } +/** + * aborts an asynchronous action. +(at)return E_OK on success, E_UNKNOWN on error, + * E_NON_EXISTENT if handle was not found + */ void RoutingControlDBusProxy::asyncAbort(const am_Handle_s& handle, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -74,6 +80,11 @@ std::future<CommonAPI::CallStatus> RoutingControlDBusProxy::asyncAbortAsync(cons handle, std::move(callback)); } +/** + * connects a source to a sink +(at)return E_OK on success, E_UNKNOWN on error, + * E_WRONG_FORMAT in case am_ConnectionFormat_e does not match + */ void RoutingControlDBusProxy::asyncConnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, const am_ConnectionFormat_pe& connectionFormat, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_connectionID_t, am_sourceID_t, am_sinkID_t, am_ConnectionFormat_pe>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -93,6 +104,11 @@ std::future<CommonAPI::CallStatus> RoutingControlDBusProxy::asyncConnectAsync(co handle, connectionID, sourceID, sinkID, connectionFormat, std::move(callback)); } +/** + * disconnect a connection with given connectionID +(at)return E_OK on success, + * E_UNKNOWN on error, E_NON_EXISTENT if connection was not found + */ void RoutingControlDBusProxy::asyncDisconnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_connectionID_t>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -112,6 +128,13 @@ std::future<CommonAPI::CallStatus> RoutingControlDBusProxy::asyncDisconnectAsync handle, connectionID, std::move(callback)); } +/** + * this method is used to set the volume of a sink. This function is used to drive + * ramps, to mute or unmute or directly set the value. The difference is made + * through the ramptype. +(at)return E_OK on success, E_UNKNOWN on error, + * E_OUT_OF_RANGE if new volume is out of range + */ void RoutingControlDBusProxy::asyncSetSinkVolume(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_sinkID_t, am_volume_t, am_RampType_pe, am_time_t>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -131,6 +154,15 @@ std::future<CommonAPI::CallStatus> RoutingControlDBusProxy::asyncSetSinkVolumeAs handle, sinkID, volume, ramp, time, std::move(callback)); } +/** + * sets the volume of a source. This method is used to set the volume of a sink. + * This function is used to drive ramps, to mute or unmute or directly set the + * value. The difference is made through the ramptype. +(at)return E_OK on + * success, E_UNKNOWN on error, E_OUT_OF_RANGE if volume is out of + * range. +triggers the acknowledge ackSourceVolumeChange + */ void RoutingControlDBusProxy::asyncSetSourceVolume(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_sourceID_t, am_volume_t, am_RampType_pe, am_time_t>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -150,6 +182,11 @@ std::future<CommonAPI::CallStatus> RoutingControlDBusProxy::asyncSetSourceVolume handle, sourceID, volume, ramp, time, std::move(callback)); } +/** + * This function is used to set the source state of a particular + * source. +(at)return E_OK on success, E_UNKNOWN on error + */ void RoutingControlDBusProxy::asyncSetSourceState(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SourceState_e& state, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_sourceID_t, am_SourceState_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -169,6 +206,11 @@ std::future<CommonAPI::CallStatus> RoutingControlDBusProxy::asyncSetSourceStateA handle, sourceID, state, std::move(callback)); } +/** + * this function sets the sinksoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ void RoutingControlDBusProxy::asyncSetSinkSoundProperties(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_L& listSoundProperties, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_sinkID_t, am_SoundProperty_L>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -188,6 +230,11 @@ std::future<CommonAPI::CallStatus> RoutingControlDBusProxy::asyncSetSinkSoundPro handle, sinkID, listSoundProperties, std::move(callback)); } +/** + * this function sets the sinksoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ void RoutingControlDBusProxy::asyncSetSinkSoundProperty(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_sinkID_t, am_SoundProperty_s>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -207,6 +254,11 @@ std::future<CommonAPI::CallStatus> RoutingControlDBusProxy::asyncSetSinkSoundPro handle, sinkID, soundProperty, std::move(callback)); } +/** + * this function sets the sourcesoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ void RoutingControlDBusProxy::asyncSetSourceSoundProperties(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_L& listSoundProperties, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_sourceID_t, am_SoundProperty_L>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -226,6 +278,11 @@ std::future<CommonAPI::CallStatus> RoutingControlDBusProxy::asyncSetSourceSoundP handle, sourceID, listSoundProperties, std::move(callback)); } +/** + * this function sets the sourcesoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ void RoutingControlDBusProxy::asyncSetSourceSoundProperty(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_sourceID_t, am_SoundProperty_s>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -245,6 +302,11 @@ std::future<CommonAPI::CallStatus> RoutingControlDBusProxy::asyncSetSourceSoundP handle, sourceID, soundProperty, std::move(callback)); } +/** + * this function triggers crossfading. +(at)return E_OK on success, E_UNKNOWN on + * error + */ void RoutingControlDBusProxy::asyncCrossFade(const am_Handle_s& handle, const am_crossfaderID_t& crossfaderID, const am_HotSink_e& hotSink, const am_RampType_pe& rampType, const am_time_t& time, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_crossfaderID_t, am_HotSink_e, am_RampType_pe, am_time_t>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -264,6 +326,11 @@ std::future<CommonAPI::CallStatus> RoutingControlDBusProxy::asyncCrossFadeAsync( handle, crossfaderID, hotSink, rampType, time, std::move(callback)); } +/** + * this function is used for early and late audio functions to set the domain + * state +(at)return E_OK on success, E_UNKNOWN on error + */ void RoutingControlDBusProxy::setDomainState(const am_domainID_t& domainID, const am_DomainState_e& domainState, CommonAPI::CallStatus& callStatus, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_domainID_t, am_DomainState_e>, CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply( @@ -341,6 +408,8 @@ std::future<CommonAPI::CallStatus> RoutingControlDBusProxy::asyncSetSourceNotifi std::move(callback)); } + + void RoutingControlDBusProxy::getOwnVersion(uint16_t& ownVersionMajor, uint16_t& ownVersionMinor) const { ownVersionMajor = 0; ownVersionMinor = 1; diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusProxy.h b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusProxy.h index 96e8f2d..4e08ecd 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusProxy.h +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusProxy.h @@ -1,34 +1,35 @@ /* -* 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/. */ +/** + * This class implements everything from Audiomanager -> RoutingAdapter + * @author Christian Mueller + */ #ifndef ORG_GENIVI_AM_Routing_Control_DBUS_PROXY_H_ #define ORG_GENIVI_AM_Routing_Control_DBUS_PROXY_H_ #include <org/genivi/am/RoutingControlProxyBase.h> +#if !defined (COMMONAPI_INTERNAL_COMPILATION) #define COMMONAPI_INTERNAL_COMPILATION +#endif #include <CommonAPI/DBus/DBusFactory.h> #include <CommonAPI/DBus/DBusProxy.h> @@ -44,6 +45,7 @@ namespace am { class RoutingControlDBusProxy: virtual public RoutingControlProxyBase, virtual public CommonAPI::DBus::DBusProxy { public: RoutingControlDBusProxy( + const std::shared_ptr<CommonAPI::DBus::DBusFactory>& factory, const std::string& commonApiAddress, const std::string& interfaceName, const std::string& busName, @@ -54,58 +56,113 @@ class RoutingControlDBusProxy: virtual public RoutingControlProxyBase, virtual p - + /** + * aborts an asynchronous action. + (at)return E_OK on success, E_UNKNOWN on error, + * E_NON_EXISTENT if handle was not found + */ virtual void asyncAbort(const am_Handle_s& handle, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> asyncAbortAsync(const am_Handle_s& handle, AsyncAbortAsyncCallback callback); - + /** + * connects a source to a sink + (at)return E_OK on success, E_UNKNOWN on error, + * E_WRONG_FORMAT in case am_ConnectionFormat_e does not match + */ virtual void asyncConnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, const am_ConnectionFormat_pe& connectionFormat, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> asyncConnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, const am_ConnectionFormat_pe& connectionFormat, AsyncConnectAsyncCallback callback); - + /** + * disconnect a connection with given connectionID + (at)return E_OK on success, + * E_UNKNOWN on error, E_NON_EXISTENT if connection was not found + */ virtual void asyncDisconnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> asyncDisconnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, AsyncDisconnectAsyncCallback callback); - + /** + * this method is used to set the volume of a sink. This function is used to drive + * ramps, to mute or unmute or directly set the value. The difference is made + * through the ramptype. + (at)return E_OK on success, E_UNKNOWN on error, + * E_OUT_OF_RANGE if new volume is out of range + */ virtual void asyncSetSinkVolume(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> asyncSetSinkVolumeAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, AsyncSetSinkVolumeAsyncCallback callback); - + /** + * sets the volume of a source. This method is used to set the volume of a sink. + * This function is used to drive ramps, to mute or unmute or directly set the + * value. The difference is made through the ramptype. + (at)return E_OK on + * success, E_UNKNOWN on error, E_OUT_OF_RANGE if volume is out of + * range. + triggers the acknowledge ackSourceVolumeChange + */ virtual void asyncSetSourceVolume(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> asyncSetSourceVolumeAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, AsyncSetSourceVolumeAsyncCallback callback); - + /** + * This function is used to set the source state of a particular + * source. + (at)return E_OK on success, E_UNKNOWN on error + */ virtual void asyncSetSourceState(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SourceState_e& state, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> asyncSetSourceStateAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SourceState_e& state, AsyncSetSourceStateAsyncCallback callback); - + /** + * this function sets the sinksoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ virtual void asyncSetSinkSoundProperties(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_L& listSoundProperties, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> asyncSetSinkSoundPropertiesAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_L& listSoundProperties, AsyncSetSinkSoundPropertiesAsyncCallback callback); - + /** + * this function sets the sinksoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ virtual void asyncSetSinkSoundProperty(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> asyncSetSinkSoundPropertyAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_s& soundProperty, AsyncSetSinkSoundPropertyAsyncCallback callback); - + /** + * this function sets the sourcesoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ virtual void asyncSetSourceSoundProperties(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_L& listSoundProperties, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> asyncSetSourceSoundPropertiesAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_L& listSoundProperties, AsyncSetSourceSoundPropertiesAsyncCallback callback); - + /** + * this function sets the sourcesoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ virtual void asyncSetSourceSoundProperty(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> asyncSetSourceSoundPropertyAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_s& soundProperty, AsyncSetSourceSoundPropertyAsyncCallback callback); - + /** + * this function triggers crossfading. + (at)return E_OK on success, E_UNKNOWN on + * error + */ virtual void asyncCrossFade(const am_Handle_s& handle, const am_crossfaderID_t& crossfaderID, const am_HotSink_e& hotSink, const am_RampType_pe& rampType, const am_time_t& time, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> asyncCrossFadeAsync(const am_Handle_s& handle, const am_crossfaderID_t& crossfaderID, const am_HotSink_e& hotSink, const am_RampType_pe& rampType, const am_time_t& time, AsyncCrossFadeAsyncCallback callback); - + /** + * this function is used for early and late audio functions to set the domain + * state + (at)return E_OK on success, E_UNKNOWN on error + */ virtual void setDomainState(const am_domainID_t& domainID, const am_DomainState_e& domainState, CommonAPI::CallStatus& callStatus, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> setDomainStateAsync(const am_domainID_t& domainID, const am_DomainState_e& domainState, SetDomainStateAsyncCallback callback); - virtual void asyncSetVolumes(const am_Handle_s& handle, const am_Volumes_L& volumes, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> asyncSetVolumesAsync(const am_Handle_s& handle, const am_Volumes_L& volumes, AsyncSetVolumesAsyncCallback callback); - virtual void asyncSetSinkNotificationConfiguration(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& notificationConfiguration, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> asyncSetSinkNotificationConfigurationAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& notificationConfiguration, AsyncSetSinkNotificationConfigurationAsyncCallback callback); - virtual void asyncSetSourceNotificationConfiguration(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& notificationConfiguration, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> asyncSetSourceNotificationConfigurationAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& notificationConfiguration, AsyncSetSourceNotificationConfigurationAsyncCallback callback); + virtual void getOwnVersion(uint16_t& ownVersionMajor, uint16_t& ownVersionMinor) const; private: + }; + + } // namespace am } // namespace genivi } // namespace org diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusStubAdapter.cpp b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusStubAdapter.cpp index 9b66f5a..a87d5f8 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusStubAdapter.cpp +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusStubAdapter.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 "RoutingControlDBusStubAdapter.h" @@ -31,13 +26,14 @@ namespace genivi { namespace am { std::shared_ptr<CommonAPI::DBus::DBusStubAdapter> createRoutingControlDBusStubAdapter( + 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<RoutingControlDBusStubAdapter>(commonApiAddress, interfaceName, busName, objectPath, dbusProxyConnection, stubBase); + return std::make_shared<RoutingControlDBusStubAdapter>(factory, commonApiAddress, interfaceName, busName, objectPath, dbusProxyConnection, stubBase); } __attribute__((constructor)) void registerRoutingControlDBusStubAdapter(void) { @@ -46,20 +42,43 @@ __attribute__((constructor)) void registerRoutingControlDBusStubAdapter(void) { } RoutingControlDBusStubAdapter::RoutingControlDBusStubAdapter( + 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): - RoutingControlDBusStubAdapterHelper(commonApiAddress, dbusInterfaceName, dbusBusName, dbusObjectPath, dbusConnection, std::dynamic_pointer_cast<RoutingControlStub>(stub)) { + RoutingControlDBusStubAdapterHelper(factory, commonApiAddress, dbusInterfaceName, dbusBusName, dbusObjectPath, + dbusConnection, std::dynamic_pointer_cast<RoutingControlStub>(stub), + NULL) + { +} + +RoutingControlDBusStubAdapter::~RoutingControlDBusStubAdapter() { + deactivateManagedInstances(); + deinit(); + stub_.reset(); +} + +void RoutingControlDBusStubAdapter::deactivateManagedInstances() { } const char* RoutingControlDBusStubAdapter::getMethodsDBusIntrospectionXmlData() const { - return + static const char* introspectionData = + /** + * aborts an asynchronous action. + (at)return E_OK on success, E_UNKNOWN on error, + * E_NON_EXISTENT if handle was not found + */ "<method name=\"asyncAbort\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "</method>\n" + /** + * connects a source to a sink + (at)return E_OK on success, E_UNKNOWN on error, + * E_WRONG_FORMAT in case am_ConnectionFormat_e does not match + */ "<method name=\"asyncConnect\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"connectionID\" type=\"q\" direction=\"in\" />\n" @@ -67,10 +86,22 @@ const char* RoutingControlDBusStubAdapter::getMethodsDBusIntrospectionXmlData() "<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"connectionFormat\" type=\"q\" direction=\"in\" />\n" "</method>\n" + /** + * disconnect a connection with given connectionID + (at)return E_OK on success, + * E_UNKNOWN on error, E_NON_EXISTENT if connection was not found + */ "<method name=\"asyncDisconnect\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"connectionID\" type=\"q\" direction=\"in\" />\n" "</method>\n" + /** + * this method is used to set the volume of a sink. This function is used to drive + * ramps, to mute or unmute or directly set the value. The difference is made + * through the ramptype. + (at)return E_OK on success, E_UNKNOWN on error, + * E_OUT_OF_RANGE if new volume is out of range + */ "<method name=\"asyncSetSinkVolume\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n" @@ -78,6 +109,15 @@ const char* RoutingControlDBusStubAdapter::getMethodsDBusIntrospectionXmlData() "<arg name=\"ramp\" type=\"q\" direction=\"in\" />\n" "<arg name=\"time\" type=\"n\" direction=\"in\" />\n" "</method>\n" + /** + * sets the volume of a source. This method is used to set the volume of a sink. + * This function is used to drive ramps, to mute or unmute or directly set the + * value. The difference is made through the ramptype. + (at)return E_OK on + * success, E_UNKNOWN on error, E_OUT_OF_RANGE if volume is out of + * range. + triggers the acknowledge ackSourceVolumeChange + */ "<method name=\"asyncSetSourceVolume\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"sourceID\" type=\"q\" direction=\"in\" />\n" @@ -85,31 +125,61 @@ const char* RoutingControlDBusStubAdapter::getMethodsDBusIntrospectionXmlData() "<arg name=\"ramp\" type=\"q\" direction=\"in\" />\n" "<arg name=\"time\" type=\"n\" direction=\"in\" />\n" "</method>\n" + /** + * This function is used to set the source state of a particular + * source. + (at)return E_OK on success, E_UNKNOWN on error + */ "<method name=\"asyncSetSourceState\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"sourceID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"state\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * this function sets the sinksoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ "<method name=\"asyncSetSinkSoundProperties\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"listSoundProperties\" type=\"a(qn)\" direction=\"in\" />\n" "</method>\n" + /** + * this function sets the sinksoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ "<method name=\"asyncSetSinkSoundProperty\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"soundProperty\" type=\"(qn)\" direction=\"in\" />\n" "</method>\n" + /** + * this function sets the sourcesoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ "<method name=\"asyncSetSourceSoundProperties\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"sourceID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"listSoundProperties\" type=\"a(qn)\" direction=\"in\" />\n" "</method>\n" + /** + * this function sets the sourcesoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ "<method name=\"asyncSetSourceSoundProperty\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"sourceID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"soundProperty\" type=\"(qn)\" direction=\"in\" />\n" "</method>\n" + /** + * this function triggers crossfading. + (at)return E_OK on success, E_UNKNOWN on + * error + */ "<method name=\"asyncCrossFade\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"crossfaderID\" type=\"q\" direction=\"in\" />\n" @@ -117,6 +187,11 @@ const char* RoutingControlDBusStubAdapter::getMethodsDBusIntrospectionXmlData() "<arg name=\"rampType\" type=\"q\" direction=\"in\" />\n" "<arg name=\"time\" type=\"n\" direction=\"in\" />\n" "</method>\n" + /** + * this function is used for early and late audio functions to set the domain + * state + (at)return E_OK on success, E_UNKNOWN on error + */ "<method name=\"setDomainState\">\n" "<arg name=\"domainID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"domainState\" type=\"i\" direction=\"in\" />\n" @@ -137,65 +212,132 @@ const char* RoutingControlDBusStubAdapter::getMethodsDBusIntrospectionXmlData() "<arg name=\"notificationConfiguration\" type=\"(qin)\" direction=\"in\" />\n" "</method>\n" ; + return introspectionData; } +/** + * aborts an asynchronous action. +(at)return E_OK on success, E_UNKNOWN on error, + * E_NON_EXISTENT if handle was not found + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlStub, std::tuple<am_Handle_s>, std::tuple<> > asyncAbortStubDispatcher(&RoutingControlStub::asyncAbort, ""); +/** + * connects a source to a sink +(at)return E_OK on success, E_UNKNOWN on error, + * E_WRONG_FORMAT in case am_ConnectionFormat_e does not match + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlStub, std::tuple<am_Handle_s, am_connectionID_t, am_sourceID_t, am_sinkID_t, am_ConnectionFormat_pe>, std::tuple<> > asyncConnectStubDispatcher(&RoutingControlStub::asyncConnect, ""); +/** + * disconnect a connection with given connectionID +(at)return E_OK on success, + * E_UNKNOWN on error, E_NON_EXISTENT if connection was not found + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlStub, std::tuple<am_Handle_s, am_connectionID_t>, std::tuple<> > asyncDisconnectStubDispatcher(&RoutingControlStub::asyncDisconnect, ""); +/** + * this method is used to set the volume of a sink. This function is used to drive + * ramps, to mute or unmute or directly set the value. The difference is made + * through the ramptype. +(at)return E_OK on success, E_UNKNOWN on error, + * E_OUT_OF_RANGE if new volume is out of range + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlStub, std::tuple<am_Handle_s, am_sinkID_t, am_volume_t, am_RampType_pe, am_time_t>, std::tuple<> > asyncSetSinkVolumeStubDispatcher(&RoutingControlStub::asyncSetSinkVolume, ""); +/** + * sets the volume of a source. This method is used to set the volume of a sink. + * This function is used to drive ramps, to mute or unmute or directly set the + * value. The difference is made through the ramptype. +(at)return E_OK on + * success, E_UNKNOWN on error, E_OUT_OF_RANGE if volume is out of + * range. +triggers the acknowledge ackSourceVolumeChange + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlStub, std::tuple<am_Handle_s, am_sourceID_t, am_volume_t, am_RampType_pe, am_time_t>, std::tuple<> > asyncSetSourceVolumeStubDispatcher(&RoutingControlStub::asyncSetSourceVolume, ""); +/** + * This function is used to set the source state of a particular + * source. +(at)return E_OK on success, E_UNKNOWN on error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlStub, std::tuple<am_Handle_s, am_sourceID_t, am_SourceState_e>, std::tuple<> > asyncSetSourceStateStubDispatcher(&RoutingControlStub::asyncSetSourceState, ""); +/** + * this function sets the sinksoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlStub, std::tuple<am_Handle_s, am_sinkID_t, am_SoundProperty_L>, std::tuple<> > asyncSetSinkSoundPropertiesStubDispatcher(&RoutingControlStub::asyncSetSinkSoundProperties, ""); +/** + * this function sets the sinksoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlStub, std::tuple<am_Handle_s, am_sinkID_t, am_SoundProperty_s>, std::tuple<> > asyncSetSinkSoundPropertyStubDispatcher(&RoutingControlStub::asyncSetSinkSoundProperty, ""); +/** + * this function sets the sourcesoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlStub, std::tuple<am_Handle_s, am_sourceID_t, am_SoundProperty_L>, std::tuple<> > asyncSetSourceSoundPropertiesStubDispatcher(&RoutingControlStub::asyncSetSourceSoundProperties, ""); +/** + * this function sets the sourcesoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlStub, std::tuple<am_Handle_s, am_sourceID_t, am_SoundProperty_s>, std::tuple<> > asyncSetSourceSoundPropertyStubDispatcher(&RoutingControlStub::asyncSetSourceSoundProperty, ""); +/** + * this function triggers crossfading. +(at)return E_OK on success, E_UNKNOWN on + * error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlStub, std::tuple<am_Handle_s, am_crossfaderID_t, am_HotSink_e, am_RampType_pe, am_time_t>, std::tuple<> > asyncCrossFadeStubDispatcher(&RoutingControlStub::asyncCrossFade, ""); +/** + * this function is used for early and late audio functions to set the domain + * state +(at)return E_OK on success, E_UNKNOWN on error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlStub, std::tuple<am_domainID_t, am_DomainState_e>, @@ -219,25 +361,94 @@ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< +const RoutingControlDBusStubAdapter::StubDispatcherTable& RoutingControlDBusStubAdapter::getStubDispatcherTable() { + static const RoutingControlDBusStubAdapter::StubDispatcherTable stubDispatcherTable = { + /** + * aborts an asynchronous action. + (at)return E_OK on success, E_UNKNOWN on error, + * E_NON_EXISTENT if handle was not found + */ + { { "asyncAbort", "(iq)" }, &org::genivi::am::asyncAbortStubDispatcher }, + /** + * connects a source to a sink + (at)return E_OK on success, E_UNKNOWN on error, + * E_WRONG_FORMAT in case am_ConnectionFormat_e does not match + */ + { { "asyncConnect", "(iq)qqqq" }, &org::genivi::am::asyncConnectStubDispatcher }, + /** + * disconnect a connection with given connectionID + (at)return E_OK on success, + * E_UNKNOWN on error, E_NON_EXISTENT if connection was not found + */ + { { "asyncDisconnect", "(iq)q" }, &org::genivi::am::asyncDisconnectStubDispatcher }, + /** + * this method is used to set the volume of a sink. This function is used to drive + * ramps, to mute or unmute or directly set the value. The difference is made + * through the ramptype. + (at)return E_OK on success, E_UNKNOWN on error, + * E_OUT_OF_RANGE if new volume is out of range + */ + { { "asyncSetSinkVolume", "(iq)qnqn" }, &org::genivi::am::asyncSetSinkVolumeStubDispatcher }, + /** + * sets the volume of a source. This method is used to set the volume of a sink. + * This function is used to drive ramps, to mute or unmute or directly set the + * value. The difference is made through the ramptype. + (at)return E_OK on + * success, E_UNKNOWN on error, E_OUT_OF_RANGE if volume is out of + * range. + triggers the acknowledge ackSourceVolumeChange + */ + { { "asyncSetSourceVolume", "(iq)qnqn" }, &org::genivi::am::asyncSetSourceVolumeStubDispatcher }, + /** + * This function is used to set the source state of a particular + * source. + (at)return E_OK on success, E_UNKNOWN on error + */ + { { "asyncSetSourceState", "(iq)qi" }, &org::genivi::am::asyncSetSourceStateStubDispatcher }, + /** + * this function sets the sinksoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ + { { "asyncSetSinkSoundProperties", "(iq)qa(qn)" }, &org::genivi::am::asyncSetSinkSoundPropertiesStubDispatcher }, + /** + * this function sets the sinksoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ + { { "asyncSetSinkSoundProperty", "(iq)q(qn)" }, &org::genivi::am::asyncSetSinkSoundPropertyStubDispatcher }, + /** + * this function sets the sourcesoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ + { { "asyncSetSourceSoundProperties", "(iq)qa(qn)" }, &org::genivi::am::asyncSetSourceSoundPropertiesStubDispatcher }, + /** + * this function sets the sourcesoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ + { { "asyncSetSourceSoundProperty", "(iq)q(qn)" }, &org::genivi::am::asyncSetSourceSoundPropertyStubDispatcher }, + /** + * this function triggers crossfading. + (at)return E_OK on success, E_UNKNOWN on + * error + */ + { { "asyncCrossFade", "(iq)qiqn" }, &org::genivi::am::asyncCrossFadeStubDispatcher }, + /** + * this function is used for early and late audio functions to set the domain + * state + (at)return E_OK on success, E_UNKNOWN on error + */ + { { "setDomainState", "qi" }, &org::genivi::am::setDomainStateStubDispatcher }, + { { "asyncSetVolumes", "(iq)a(i(yv)nqn)" }, &org::genivi::am::asyncSetVolumesStubDispatcher }, + { { "asyncSetSinkNotificationConfiguration", "(iq)q(qin)" }, &org::genivi::am::asyncSetSinkNotificationConfigurationStubDispatcher }, + { { "asyncSetSourceNotificationConfiguration", "(iq)q(qin)" }, &org::genivi::am::asyncSetSourceNotificationConfigurationStubDispatcher } + }; + return stubDispatcherTable; +} + + } // namespace am } // namespace genivi } // namespace org - -template<> -const org::genivi::am::RoutingControlDBusStubAdapterHelper::StubDispatcherTable org::genivi::am::RoutingControlDBusStubAdapterHelper::stubDispatcherTable_ = { - { { "asyncAbort", "(iq)" }, &org::genivi::am::asyncAbortStubDispatcher }, - { { "asyncConnect", "(iq)qqqq" }, &org::genivi::am::asyncConnectStubDispatcher }, - { { "asyncDisconnect", "(iq)q" }, &org::genivi::am::asyncDisconnectStubDispatcher }, - { { "asyncSetSinkVolume", "(iq)qnqn" }, &org::genivi::am::asyncSetSinkVolumeStubDispatcher }, - { { "asyncSetSourceVolume", "(iq)qnqn" }, &org::genivi::am::asyncSetSourceVolumeStubDispatcher }, - { { "asyncSetSourceState", "(iq)qi" }, &org::genivi::am::asyncSetSourceStateStubDispatcher }, - { { "asyncSetSinkSoundProperties", "(iq)qa(qn)" }, &org::genivi::am::asyncSetSinkSoundPropertiesStubDispatcher }, - { { "asyncSetSinkSoundProperty", "(iq)q(qn)" }, &org::genivi::am::asyncSetSinkSoundPropertyStubDispatcher }, - { { "asyncSetSourceSoundProperties", "(iq)qa(qn)" }, &org::genivi::am::asyncSetSourceSoundPropertiesStubDispatcher }, - { { "asyncSetSourceSoundProperty", "(iq)q(qn)" }, &org::genivi::am::asyncSetSourceSoundPropertyStubDispatcher }, - { { "asyncCrossFade", "(iq)qiqn" }, &org::genivi::am::asyncCrossFadeStubDispatcher }, - { { "setDomainState", "qi" }, &org::genivi::am::setDomainStateStubDispatcher }, - { { "asyncSetVolumes", "(iq)a(i(yv)nqn)" }, &org::genivi::am::asyncSetVolumesStubDispatcher }, - { { "asyncSetSinkNotificationConfiguration", "(iq)q(qin)" }, &org::genivi::am::asyncSetSinkNotificationConfigurationStubDispatcher }, - { { "asyncSetSourceNotificationConfiguration", "(iq)q(qin)" }, &org::genivi::am::asyncSetSourceNotificationConfigurationStubDispatcher } -}; diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusStubAdapter.h b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusStubAdapter.h index 0cd33f3..eca4dbd 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusStubAdapter.h +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlDBusStubAdapter.h @@ -1,37 +1,40 @@ /* -* 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/. */ +/** + * This class implements everything from Audiomanager -> RoutingAdapter + * @author Christian Mueller + */ #ifndef ORG_GENIVI_AM_Routing_Control_DBUS_STUB_ADAPTER_H_ #define ORG_GENIVI_AM_Routing_Control_DBUS_STUB_ADAPTER_H_ #include <org/genivi/am/RoutingControlStub.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,17 +47,27 @@ typedef CommonAPI::DBus::DBusStubAdapterHelper<RoutingControlStub> RoutingContro class RoutingControlDBusStubAdapter: public RoutingControlStubAdapter, public RoutingControlDBusStubAdapterHelper { public: RoutingControlDBusStubAdapter( + 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); + + ~RoutingControlDBusStubAdapter(); + + + const StubDispatcherTable& getStubDispatcherTable(); + + void deactivateManagedInstances(); protected: virtual const char* getMethodsDBusIntrospectionXmlData() const; + + private: }; } // namespace am diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserver.h b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserver.h index 85a2ac0..a44ab34 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserver.h +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserver.h @@ -1,34 +1,35 @@ /* -* 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/. */ +/** + * Routing Receive sendInterface description. + * @author Christian Mueller + */ #ifndef ORG_GENIVI_AM_Routing_Control_Observer_H_ #define ORG_GENIVI_AM_Routing_Control_Observer_H_ +#if !defined (COMMONAPI_INTERNAL_COMPILATION) #define COMMONAPI_INTERNAL_COMPILATION +#endif #include <CommonAPI/types.h> @@ -47,7 +48,8 @@ class RoutingControlObserver { }; const char* RoutingControlObserver::getInterfaceId() { - return "org.genivi.am.RoutingControlObserver"; + static const char* interfaceId = "org.genivi.am.RoutingControlObserver"; + return interfaceId; } CommonAPI::Version RoutingControlObserver::getInterfaceVersion() { diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusProxy.cpp b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusProxy.cpp index 637b174..203d734 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusProxy.cpp +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusProxy.cpp @@ -1,28 +1,27 @@ /* -* 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/. */ +/** + * Routing Receive sendInterface description. + * @author Christian Mueller + */ #include "RoutingControlObserverDBusProxy.h" namespace org { @@ -30,12 +29,13 @@ namespace genivi { namespace am { std::shared_ptr<CommonAPI::DBus::DBusProxy> createRoutingControlObserverDBusProxy( + 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<RoutingControlObserverDBusProxy>(commonApiAddress, interfaceName, busName, objectPath, dbusProxyConnection); + return std::make_shared<RoutingControlObserverDBusProxy>(factory, commonApiAddress, interfaceName, busName, objectPath, dbusProxyConnection); } __attribute__((constructor)) void registerRoutingControlObserverDBusProxy(void) { @@ -44,21 +44,25 @@ __attribute__((constructor)) void registerRoutingControlObserverDBusProxy(void) } RoutingControlObserverDBusProxy::RoutingControlObserverDBusProxy( + 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) -, routingReady_(*this, "onRoutingReadyAttributeChanged", "setRoutingReadyAttribute", "i", "getRoutingReadyAttribute") - { -} + CommonAPI::DBus::DBusProxy(factory, commonApiAddress, interfaceName, busName, objectPath, dbusProxyconnection) +,routingReady_(*this, "onRoutingReadyAttributeChanged", "i", "getRoutingReadyAttribute") + { + } RoutingControlObserverDBusProxy::RoutingReadyAttribute& RoutingControlObserverDBusProxy::getRoutingReadyAttribute() { return routingReady_; } +/** + * acknowledges a asyncConnect + */ void RoutingControlObserverDBusProxy::ackConnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_connectionID_t, am_Error_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -78,6 +82,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::ackConnectAs handle, connectionID, error, std::move(callback)); } +/** + * acknowledges a asyncDisconnect + */ void RoutingControlObserverDBusProxy::ackDisconnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_connectionID_t, am_Error_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -97,6 +104,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::ackDisconnec handle, connectionID, error, std::move(callback)); } +/** + * acknowledges a asyncsetSinkVolume + */ void RoutingControlObserverDBusProxy::ackSetSinkVolumeChange(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_volume_t, am_Error_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -116,6 +126,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::ackSetSinkVo handle, volume, error, std::move(callback)); } +/** + * acknowledges a asyncsetSourceVolume + */ void RoutingControlObserverDBusProxy::ackSetSourceVolumeChange(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_volume_t, am_Error_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -135,6 +148,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::ackSetSource handle, volume, error, std::move(callback)); } +/** + * acknowlegde for asyncSetSourceState + */ void RoutingControlObserverDBusProxy::ackSetSourceState(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_Error_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -154,6 +170,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::ackSetSource handle, error, std::move(callback)); } +/** + * acknowledges asyncSetSinkSoundProperties + */ void RoutingControlObserverDBusProxy::ackSetSinkSoundProperties(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_Error_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -173,6 +192,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::ackSetSinkSo handle, error, std::move(callback)); } +/** + * acknowledges asyncSetSinkSoundProperty + */ void RoutingControlObserverDBusProxy::ackSetSinkSoundProperty(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_Error_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -192,6 +214,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::ackSetSinkSo handle, error, std::move(callback)); } +/** + * acknowledges asyncSetSourceSoundProperties + */ void RoutingControlObserverDBusProxy::ackSetSourceSoundProperties(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_Error_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -211,6 +236,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::ackSetSource handle, error, std::move(callback)); } +/** + * acknowledges asyncSetSourceSoundProperty + */ void RoutingControlObserverDBusProxy::ackSetSourceSoundProperty(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_Error_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -230,6 +258,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::ackSetSource handle, error, std::move(callback)); } +/** + * acknowledges asyncCrossFade + */ void RoutingControlObserverDBusProxy::ackCrossFading(const am_Handle_s& handle, const am_HotSink_e& hotSink, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_HotSink_e, am_Error_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -249,6 +280,10 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::ackCrossFadi handle, hotSink, error, std::move(callback)); } +/** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ void RoutingControlObserverDBusProxy::ackSourceVolumeTick(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_sourceID_t, am_volume_t>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -268,6 +303,10 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::ackSourceVol handle, sourceID, volume, std::move(callback)); } +/** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ void RoutingControlObserverDBusProxy::ackSinkVolumeTick(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_sinkID_t, am_volume_t>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -287,6 +326,14 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::ackSinkVolum handle, sinkID, volume, std::move(callback)); } +/** + * This function returns the ID to the given domainName. If already a domain is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the domain. The other parameters of the domain + * will be overwritten when the domain is registered. +(at)return E_OK on + * success, E_UNKNOWN on error + */ void RoutingControlObserverDBusProxy::peekDomain(const std::string& name, CommonAPI::CallStatus& callStatus, am_domainID_t& domainID, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<std::string>, CommonAPI::DBus::DBusSerializableArguments<am_domainID_t, am_Error_e> >::callMethodWithReply( @@ -306,6 +353,11 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::peekDomainAs name, std::move(callback)); } +/** + * registers a domain +(at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ void RoutingControlObserverDBusProxy::registerDomain(const am_Domain_s& domainData, const std::string& returnBusname, const std::string& returnInterface, CommonAPI::CallStatus& callStatus, am_domainID_t& domainID, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Domain_s, std::string, std::string>, CommonAPI::DBus::DBusSerializableArguments<am_domainID_t, am_Error_e> >::callMethodWithReply( @@ -325,6 +377,12 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::registerDoma domainData, returnBusname, returnInterface, std::move(callback)); } +/** + * deregisters a domain. All sources, sinks, gateways and crossfaders from that + * domain will be removed as well. +(at)return E_OK on succes, E_NON_EXISTENT if + * not found E_UNKOWN on error + */ void RoutingControlObserverDBusProxy::deregisterDomain(const am_domainID_t& domainID, CommonAPI::CallStatus& callStatus, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_domainID_t>, CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply( @@ -344,6 +402,10 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::deregisterDo domainID, std::move(callback)); } +/** + * registers a gateway. (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ void RoutingControlObserverDBusProxy::registerGateway(const am_Gateway_s& gatewayData, CommonAPI::CallStatus& callStatus, am_gatewayID_t& gatewayID, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Gateway_s>, CommonAPI::DBus::DBusSerializableArguments<am_gatewayID_t, am_Error_e> >::callMethodWithReply( @@ -363,6 +425,12 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::registerGate gatewayData, std::move(callback)); } +/** + * deregisters a gateway. Also removes all sinks and sources of the controlling + * domain. +(at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ void RoutingControlObserverDBusProxy::deregisterGateway(const am_gatewayID_t& gatewayID, CommonAPI::CallStatus& callStatus, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_gatewayID_t>, CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply( @@ -382,6 +450,14 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::deregisterGa gatewayID, std::move(callback)); } +/** + * This function returns the ID to the given sinkName. If already a sink is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the sink. The other parameters of the sink will + * be overwritten when the sink is registered. +(at)return E_OK on success, + * E_UNKNOWN on error + */ void RoutingControlObserverDBusProxy::peekSink(const std::string& name, CommonAPI::CallStatus& callStatus, am_sinkID_t& sinkID, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<std::string>, CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_Error_e> >::callMethodWithReply( @@ -401,6 +477,12 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::peekSinkAsyn name, std::move(callback)); } +/** + * Registers a sink. If the sink is part of a gateway, the listconnectionFormats + * is copied to the gatewayInformation +(at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ void RoutingControlObserverDBusProxy::registerSink(const am_Sink_s& sinkData, CommonAPI::CallStatus& callStatus, am_sinkID_t& sinkID, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Sink_s>, CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_Error_e> >::callMethodWithReply( @@ -420,6 +502,11 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::registerSink sinkData, std::move(callback)); } +/** + * deregisters a sink. +(at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ void RoutingControlObserverDBusProxy::deregisterSink(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t>, CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply( @@ -439,6 +526,14 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::deregisterSi sinkID, std::move(callback)); } +/** + * This function returns the ID to the given sourceName. If already a source is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the source. The other parameters of the source + * will be overwritten when the source is registered. +(at)return E_OK on + * success, E_UNKNOWN on error + */ void RoutingControlObserverDBusProxy::peekSource(const std::string& name, CommonAPI::CallStatus& callStatus, am_sourceID_t& sourceID, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<std::string>, CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t, am_Error_e> >::callMethodWithReply( @@ -458,6 +553,13 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::peekSourceAs name, std::move(callback)); } +/** + * registers a source. If the source is part of a gateway, the + * listconnectionFormats is copied to the gatewayInformation +(at)return E_OK on + * success, E_UNKNOWN on error, E_ALREADY_EXIST if either name or sourceID + * already exists + */ void RoutingControlObserverDBusProxy::registerSource(const am_Source_s& sourceData, CommonAPI::CallStatus& callStatus, am_sourceID_t& sourceID, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Source_s>, CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t, am_Error_e> >::callMethodWithReply( @@ -477,6 +579,11 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::registerSour sourceData, std::move(callback)); } +/** + * deregisters a source +(at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ void RoutingControlObserverDBusProxy::deregisterSource(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t>, CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply( @@ -496,6 +603,11 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::deregisterSo sourceID, std::move(callback)); } +/** + * this function registers a crossfader. +(at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ void RoutingControlObserverDBusProxy::registerCrossfader(const am_Crossfader_s& crossfaderData, CommonAPI::CallStatus& callStatus, am_crossfaderID_t& crossfaderID, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Crossfader_s>, CommonAPI::DBus::DBusSerializableArguments<am_crossfaderID_t, am_Error_e> >::callMethodWithReply( @@ -515,6 +627,12 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::registerCros crossfaderData, std::move(callback)); } +/** + * this function deregisters a crossfader. removes all sources and sinks assiated + * as well. +(at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ void RoutingControlObserverDBusProxy::deregisterCrossfader(const am_crossfaderID_t& crossfaderID, CommonAPI::CallStatus& callStatus, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_crossfaderID_t>, CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply( @@ -534,6 +652,12 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::deregisterCr crossfaderID, std::move(callback)); } +/** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. +(at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ void RoutingControlObserverDBusProxy::peekSourceClassID(const std::string& name, CommonAPI::CallStatus& callStatus, am_sourceClass_t& sourceClassID, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<std::string>, CommonAPI::DBus::DBusSerializableArguments<am_sourceClass_t, am_Error_e> >::callMethodWithReply( @@ -553,6 +677,12 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::peekSourceCl name, std::move(callback)); } +/** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. +(at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ void RoutingControlObserverDBusProxy::peekSinkClassID(const std::string& name, CommonAPI::CallStatus& callStatus, am_sinkClass_t& sinkClassID, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<std::string>, CommonAPI::DBus::DBusSerializableArguments<am_sinkClass_t, am_Error_e> >::callMethodWithReply( @@ -572,6 +702,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::peekSinkClas name, std::move(callback)); } +/** + * is called when a low level interrupt changes it status. + */ void RoutingControlObserverDBusProxy::hookInterruptStatusChange(const am_sourceID_t& sourceID, const am_InterruptState_e& interruptState, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t, am_InterruptState_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -591,6 +724,11 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::hookInterrup sourceID, interruptState, std::move(callback)); } +/** + * This hook is called when all elements from a domain are registered. +Is used by + * the Controller to know when all expected domains are finally registered + */ void RoutingControlObserverDBusProxy::hookDomainRegistrationComplete(const am_domainID_t& domainID, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_domainID_t>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -610,6 +748,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::hookDomainRe domainID, std::move(callback)); } +/** + * is called when a sink changes its availability + */ void RoutingControlObserverDBusProxy::hookSinkAvailablityStatusChange(const am_sinkID_t& sinkID, const am_Availability_s& availability, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_Availability_s>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -629,6 +770,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::hookSinkAvai sinkID, availability, std::move(callback)); } +/** + * is called when a source changes its availability + */ void RoutingControlObserverDBusProxy::hookSourceAvailablityStatusChange(const am_sourceID_t& sourceID, const am_Availability_s& availability, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t, am_Availability_s>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -648,6 +792,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::hookSourceAv sourceID, availability, std::move(callback)); } +/** + * is called when a domain changes its status. This used for early domains only + */ void RoutingControlObserverDBusProxy::hookDomainStateChange(const am_domainID_t& domainID, const am_DomainState_e& domainState, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_domainID_t, am_DomainState_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -667,6 +814,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::hookDomainSt domainID, domainState, std::move(callback)); } +/** + * is called when the timinginformation (delay) changed for a connection. + */ void RoutingControlObserverDBusProxy::hookTimingInformationChanged(const am_connectionID_t& connectionID, const am_timeSync_t& delay, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_connectionID_t, am_timeSync_t>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -686,6 +836,11 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::hookTimingIn connectionID, delay, std::move(callback)); } +/** + * this function is used to send out all data that has been changed in an early + * state. +(at)return E_OK on success, E_UNKNOWN on error + */ void RoutingControlObserverDBusProxy::sendChangedData(const am_EarlyData_L& earlyData, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_EarlyData_L>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -705,6 +860,10 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::sendChangedD earlyData, std::move(callback)); } +/** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * gatewayID is not valid. + */ void RoutingControlObserverDBusProxy::updateGateway(const am_gatewayID_t& gatewayID, const am_ConnectionFormat_L& listSourceFormats, const am_ConnectionFormat_L& listSinkFormats, const am_Convertion_L& convertionMatrix, CommonAPI::CallStatus& callStatus, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_gatewayID_t, am_ConnectionFormat_L, am_ConnectionFormat_L, am_Convertion_L>, CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply( @@ -724,6 +883,10 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::updateGatewa gatewayID, listSourceFormats, listSinkFormats, convertionMatrix, std::move(callback)); } +/** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * sinkID is not valid. + */ void RoutingControlObserverDBusProxy::updateSink(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, CommonAPI::CallStatus& callStatus, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_sinkClass_t, am_SoundProperty_L, am_ConnectionFormat_L, am_MainSoundProperty_L>, CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply( @@ -743,6 +906,18 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::updateSinkAs sinkID, sinkClassID, listSoundProperties, listConnectionFormats, listMainSoundProperties, std::move(callback)); } +/** + * updates data of an source. (at)return E_OK on success, E_NON_EXISTENT if the + * sourceID in the struct is not valid. +Please note that only the following + * data out of am_Source_s have effect when they are + * changed: +sourceClassID, +listSoundProperties, +listConnectionFormats, + * +listMainSoundProperties + */ void RoutingControlObserverDBusProxy::updateSource(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, CommonAPI::CallStatus& callStatus, am_Error_e& error) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t, am_sourceClass_t, am_SoundProperty_L, am_ConnectionFormat_L, am_MainSoundProperty_L>, CommonAPI::DBus::DBusSerializableArguments<am_Error_e> >::callMethodWithReply( @@ -762,6 +937,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::updateSource sourceID, sourceClassID, listSoundProperties, listConnectionFormats, listMainSoundProperties, std::move(callback)); } +/** + * acknowledges a asyncSetSinkVolumes + */ void RoutingControlObserverDBusProxy::ackSetVolumes(const am_Handle_s& handle, const am_Volumes_L& listvolumes, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_Volumes_L, am_Error_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -781,6 +959,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::ackSetVolume handle, listvolumes, error, std::move(callback)); } +/** + * The acknowledge of the SinkNotificationConfiguration + */ void RoutingControlObserverDBusProxy::ackSinkNotificationConfiguration(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_Error_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -800,6 +981,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::ackSinkNotif handle, error, std::move(callback)); } +/** + * The acknowledge of the SourceNotificationConfiguration + */ void RoutingControlObserverDBusProxy::ackSourceNotificationConfiguration(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_Handle_s, am_Error_e>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -819,6 +1003,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::ackSourceNot handle, error, std::move(callback)); } +/** + * is called whenever a notified value needs to be send + */ void RoutingControlObserverDBusProxy::hookSinkNotificationDataChange(const am_sinkID_t& sinkID, const am_NotificationPayload_s& payload, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sinkID_t, am_NotificationPayload_s>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -838,6 +1025,9 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::hookSinkNoti sinkID, payload, std::move(callback)); } +/** + * is called whenever a notified value needs to be send + */ void RoutingControlObserverDBusProxy::hookSourceNotificationDataChange(const am_sourceID_t& sourceID, const am_NotificationPayload_s& payload, CommonAPI::CallStatus& callStatus) { CommonAPI::DBus::DBusProxyHelper<CommonAPI::DBus::DBusSerializableArguments<am_sourceID_t, am_NotificationPayload_s>, CommonAPI::DBus::DBusSerializableArguments<> >::callMethodWithReply( @@ -877,6 +1067,8 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverDBusProxy::confirmRouti std::move(callback)); } + + void RoutingControlObserverDBusProxy::getOwnVersion(uint16_t& ownVersionMajor, uint16_t& ownVersionMinor) const { ownVersionMajor = 0; ownVersionMinor = 1; diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusProxy.h b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusProxy.h index 35afdb9..6cb99a1 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusProxy.h +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusProxy.h @@ -1,34 +1,35 @@ /* -* 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/. */ +/** + * Routing Receive sendInterface description. + * @author Christian Mueller + */ #ifndef ORG_GENIVI_AM_Routing_Control_Observer_DBUS_PROXY_H_ #define ORG_GENIVI_AM_Routing_Control_Observer_DBUS_PROXY_H_ #include <org/genivi/am/RoutingControlObserverProxyBase.h> +#if !defined (COMMONAPI_INTERNAL_COMPILATION) #define COMMONAPI_INTERNAL_COMPILATION +#endif #include <CommonAPI/DBus/DBusFactory.h> #include <CommonAPI/DBus/DBusProxy.h> @@ -45,6 +46,7 @@ namespace am { class RoutingControlObserverDBusProxy: virtual public RoutingControlObserverProxyBase, virtual public CommonAPI::DBus::DBusProxy { public: RoutingControlObserverDBusProxy( + const std::shared_ptr<CommonAPI::DBus::DBusFactory>& factory, const std::string& commonApiAddress, const std::string& interfaceName, const std::string& busName, @@ -56,143 +58,293 @@ class RoutingControlObserverDBusProxy: virtual public RoutingControlObserverProx virtual RoutingReadyAttribute& getRoutingReadyAttribute(); - + /** + * acknowledges a asyncConnect + */ virtual void ackConnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> ackConnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, AckConnectAsyncCallback callback); - + /** + * acknowledges a asyncDisconnect + */ virtual void ackDisconnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> ackDisconnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, AckDisconnectAsyncCallback callback); - + /** + * acknowledges a asyncsetSinkVolume + */ virtual void ackSetSinkVolumeChange(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> ackSetSinkVolumeChangeAsync(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, AckSetSinkVolumeChangeAsyncCallback callback); - + /** + * acknowledges a asyncsetSourceVolume + */ virtual void ackSetSourceVolumeChange(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> ackSetSourceVolumeChangeAsync(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, AckSetSourceVolumeChangeAsyncCallback callback); - + /** + * acknowlegde for asyncSetSourceState + */ virtual void ackSetSourceState(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> ackSetSourceStateAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSourceStateAsyncCallback callback); - + /** + * acknowledges asyncSetSinkSoundProperties + */ virtual void ackSetSinkSoundProperties(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> ackSetSinkSoundPropertiesAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSinkSoundPropertiesAsyncCallback callback); - + /** + * acknowledges asyncSetSinkSoundProperty + */ virtual void ackSetSinkSoundProperty(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> ackSetSinkSoundPropertyAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSinkSoundPropertyAsyncCallback callback); - + /** + * acknowledges asyncSetSourceSoundProperties + */ virtual void ackSetSourceSoundProperties(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> ackSetSourceSoundPropertiesAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSourceSoundPropertiesAsyncCallback callback); - + /** + * acknowledges asyncSetSourceSoundProperty + */ virtual void ackSetSourceSoundProperty(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> ackSetSourceSoundPropertyAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSourceSoundPropertyAsyncCallback callback); - + /** + * acknowledges asyncCrossFade + */ virtual void ackCrossFading(const am_Handle_s& handle, const am_HotSink_e& hotSink, const am_Error_e& error, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> ackCrossFadingAsync(const am_Handle_s& handle, const am_HotSink_e& hotSink, const am_Error_e& error, AckCrossFadingAsyncCallback callback); - + /** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ virtual void ackSourceVolumeTick(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> ackSourceVolumeTickAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, AckSourceVolumeTickAsyncCallback callback); - + /** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ virtual void ackSinkVolumeTick(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> ackSinkVolumeTickAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, AckSinkVolumeTickAsyncCallback callback); - + /** + * This function returns the ID to the given domainName. If already a domain is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the domain. The other parameters of the domain + * will be overwritten when the domain is registered. + (at)return E_OK on + * success, E_UNKNOWN on error + */ virtual void peekDomain(const std::string& name, CommonAPI::CallStatus& callStatus, am_domainID_t& domainID, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> peekDomainAsync(const std::string& name, PeekDomainAsyncCallback callback); - + /** + * registers a domain + (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ virtual void registerDomain(const am_Domain_s& domainData, const std::string& returnBusname, const std::string& returnInterface, CommonAPI::CallStatus& callStatus, am_domainID_t& domainID, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> registerDomainAsync(const am_Domain_s& domainData, const std::string& returnBusname, const std::string& returnInterface, RegisterDomainAsyncCallback callback); - + /** + * deregisters a domain. All sources, sinks, gateways and crossfaders from that + * domain will be removed as well. + (at)return E_OK on succes, E_NON_EXISTENT if + * not found E_UNKOWN on error + */ virtual void deregisterDomain(const am_domainID_t& domainID, CommonAPI::CallStatus& callStatus, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> deregisterDomainAsync(const am_domainID_t& domainID, DeregisterDomainAsyncCallback callback); - + /** + * registers a gateway. (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ virtual void registerGateway(const am_Gateway_s& gatewayData, CommonAPI::CallStatus& callStatus, am_gatewayID_t& gatewayID, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> registerGatewayAsync(const am_Gateway_s& gatewayData, RegisterGatewayAsyncCallback callback); - + /** + * deregisters a gateway. Also removes all sinks and sources of the controlling + * domain. + (at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ virtual void deregisterGateway(const am_gatewayID_t& gatewayID, CommonAPI::CallStatus& callStatus, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> deregisterGatewayAsync(const am_gatewayID_t& gatewayID, DeregisterGatewayAsyncCallback callback); - + /** + * This function returns the ID to the given sinkName. If already a sink is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the sink. The other parameters of the sink will + * be overwritten when the sink is registered. + (at)return E_OK on success, + * E_UNKNOWN on error + */ virtual void peekSink(const std::string& name, CommonAPI::CallStatus& callStatus, am_sinkID_t& sinkID, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> peekSinkAsync(const std::string& name, PeekSinkAsyncCallback callback); - + /** + * Registers a sink. If the sink is part of a gateway, the listconnectionFormats + * is copied to the gatewayInformation + (at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ virtual void registerSink(const am_Sink_s& sinkData, CommonAPI::CallStatus& callStatus, am_sinkID_t& sinkID, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> registerSinkAsync(const am_Sink_s& sinkData, RegisterSinkAsyncCallback callback); - + /** + * deregisters a sink. + (at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ virtual void deregisterSink(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> deregisterSinkAsync(const am_sinkID_t& sinkID, DeregisterSinkAsyncCallback callback); - + /** + * This function returns the ID to the given sourceName. If already a source is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the source. The other parameters of the source + * will be overwritten when the source is registered. + (at)return E_OK on + * success, E_UNKNOWN on error + */ virtual void peekSource(const std::string& name, CommonAPI::CallStatus& callStatus, am_sourceID_t& sourceID, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> peekSourceAsync(const std::string& name, PeekSourceAsyncCallback callback); - + /** + * registers a source. If the source is part of a gateway, the + * listconnectionFormats is copied to the gatewayInformation + (at)return E_OK on + * success, E_UNKNOWN on error, E_ALREADY_EXIST if either name or sourceID + * already exists + */ virtual void registerSource(const am_Source_s& sourceData, CommonAPI::CallStatus& callStatus, am_sourceID_t& sourceID, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> registerSourceAsync(const am_Source_s& sourceData, RegisterSourceAsyncCallback callback); - + /** + * deregisters a source + (at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ virtual void deregisterSource(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> deregisterSourceAsync(const am_sourceID_t& sourceID, DeregisterSourceAsyncCallback callback); - + /** + * this function registers a crossfader. + (at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ virtual void registerCrossfader(const am_Crossfader_s& crossfaderData, CommonAPI::CallStatus& callStatus, am_crossfaderID_t& crossfaderID, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> registerCrossfaderAsync(const am_Crossfader_s& crossfaderData, RegisterCrossfaderAsyncCallback callback); - + /** + * this function deregisters a crossfader. removes all sources and sinks assiated + * as well. + (at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ virtual void deregisterCrossfader(const am_crossfaderID_t& crossfaderID, CommonAPI::CallStatus& callStatus, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> deregisterCrossfaderAsync(const am_crossfaderID_t& crossfaderID, DeregisterCrossfaderAsyncCallback callback); - + /** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. + (at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ virtual void peekSourceClassID(const std::string& name, CommonAPI::CallStatus& callStatus, am_sourceClass_t& sourceClassID, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> peekSourceClassIDAsync(const std::string& name, PeekSourceClassIDAsyncCallback callback); - + /** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. + (at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ virtual void peekSinkClassID(const std::string& name, CommonAPI::CallStatus& callStatus, am_sinkClass_t& sinkClassID, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> peekSinkClassIDAsync(const std::string& name, PeekSinkClassIDAsyncCallback callback); - + /** + * is called when a low level interrupt changes it status. + */ virtual void hookInterruptStatusChange(const am_sourceID_t& sourceID, const am_InterruptState_e& interruptState, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> hookInterruptStatusChangeAsync(const am_sourceID_t& sourceID, const am_InterruptState_e& interruptState, HookInterruptStatusChangeAsyncCallback callback); - + /** + * This hook is called when all elements from a domain are registered. + Is used by + * the Controller to know when all expected domains are finally registered + */ virtual void hookDomainRegistrationComplete(const am_domainID_t& domainID, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> hookDomainRegistrationCompleteAsync(const am_domainID_t& domainID, HookDomainRegistrationCompleteAsyncCallback callback); - + /** + * is called when a sink changes its availability + */ virtual void hookSinkAvailablityStatusChange(const am_sinkID_t& sinkID, const am_Availability_s& availability, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> hookSinkAvailablityStatusChangeAsync(const am_sinkID_t& sinkID, const am_Availability_s& availability, HookSinkAvailablityStatusChangeAsyncCallback callback); - + /** + * is called when a source changes its availability + */ virtual void hookSourceAvailablityStatusChange(const am_sourceID_t& sourceID, const am_Availability_s& availability, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> hookSourceAvailablityStatusChangeAsync(const am_sourceID_t& sourceID, const am_Availability_s& availability, HookSourceAvailablityStatusChangeAsyncCallback callback); - + /** + * is called when a domain changes its status. This used for early domains only + */ virtual void hookDomainStateChange(const am_domainID_t& domainID, const am_DomainState_e& domainState, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> hookDomainStateChangeAsync(const am_domainID_t& domainID, const am_DomainState_e& domainState, HookDomainStateChangeAsyncCallback callback); - + /** + * is called when the timinginformation (delay) changed for a connection. + */ virtual void hookTimingInformationChanged(const am_connectionID_t& connectionID, const am_timeSync_t& delay, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> hookTimingInformationChangedAsync(const am_connectionID_t& connectionID, const am_timeSync_t& delay, HookTimingInformationChangedAsyncCallback callback); - + /** + * this function is used to send out all data that has been changed in an early + * state. + (at)return E_OK on success, E_UNKNOWN on error + */ virtual void sendChangedData(const am_EarlyData_L& earlyData, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> sendChangedDataAsync(const am_EarlyData_L& earlyData, SendChangedDataAsyncCallback callback); - + /** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * gatewayID is not valid. + */ virtual void updateGateway(const am_gatewayID_t& gatewayID, const am_ConnectionFormat_L& listSourceFormats, const am_ConnectionFormat_L& listSinkFormats, const am_Convertion_L& convertionMatrix, CommonAPI::CallStatus& callStatus, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> updateGatewayAsync(const am_gatewayID_t& gatewayID, const am_ConnectionFormat_L& listSourceFormats, const am_ConnectionFormat_L& listSinkFormats, const am_Convertion_L& convertionMatrix, UpdateGatewayAsyncCallback callback); - + /** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * sinkID is not valid. + */ virtual void updateSink(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, CommonAPI::CallStatus& callStatus, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> updateSinkAsync(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, UpdateSinkAsyncCallback callback); - + /** + * updates data of an source. (at)return E_OK on success, E_NON_EXISTENT if the + * sourceID in the struct is not valid. + Please note that only the following + * data out of am_Source_s have effect when they are + * changed: + sourceClassID, + listSoundProperties, + listConnectionFormats, + * + listMainSoundProperties + */ virtual void updateSource(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, CommonAPI::CallStatus& callStatus, am_Error_e& error); virtual std::future<CommonAPI::CallStatus> updateSourceAsync(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, UpdateSourceAsyncCallback callback); - + /** + * acknowledges a asyncSetSinkVolumes + */ virtual void ackSetVolumes(const am_Handle_s& handle, const am_Volumes_L& listvolumes, const am_Error_e& error, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> ackSetVolumesAsync(const am_Handle_s& handle, const am_Volumes_L& listvolumes, const am_Error_e& error, AckSetVolumesAsyncCallback callback); - + /** + * The acknowledge of the SinkNotificationConfiguration + */ virtual void ackSinkNotificationConfiguration(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> ackSinkNotificationConfigurationAsync(const am_Handle_s& handle, const am_Error_e& error, AckSinkNotificationConfigurationAsyncCallback callback); - + /** + * The acknowledge of the SourceNotificationConfiguration + */ virtual void ackSourceNotificationConfiguration(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> ackSourceNotificationConfigurationAsync(const am_Handle_s& handle, const am_Error_e& error, AckSourceNotificationConfigurationAsyncCallback callback); - + /** + * is called whenever a notified value needs to be send + */ virtual void hookSinkNotificationDataChange(const am_sinkID_t& sinkID, const am_NotificationPayload_s& payload, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> hookSinkNotificationDataChangeAsync(const am_sinkID_t& sinkID, const am_NotificationPayload_s& payload, HookSinkNotificationDataChangeAsyncCallback callback); - + /** + * is called whenever a notified value needs to be send + */ virtual void hookSourceNotificationDataChange(const am_sourceID_t& sourceID, const am_NotificationPayload_s& payload, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> hookSourceNotificationDataChangeAsync(const am_sourceID_t& sourceID, const am_NotificationPayload_s& payload, HookSourceNotificationDataChangeAsyncCallback callback); - virtual void confirmRoutingRundown(const std::string& domainName, CommonAPI::CallStatus& callStatus); virtual std::future<CommonAPI::CallStatus> confirmRoutingRundownAsync(const std::string& domainName, ConfirmRoutingRundownAsyncCallback callback); + virtual void getOwnVersion(uint16_t& ownVersionMajor, uint16_t& ownVersionMinor) const; private: - CommonAPI::DBus::DBusObservableAttribute<CommonAPI::DBus::DBusAttribute<RoutingReadyAttribute>> routingReady_; + CommonAPI::DBus::DBusObservableAttribute<CommonAPI::DBus::DBusReadonlyAttribute<RoutingReadyAttribute>> routingReady_; + }; + + } // namespace am } // namespace genivi } // namespace org diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusStubAdapter.cpp b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusStubAdapter.cpp index d1cef2e..31e4b26 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusStubAdapter.cpp +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusStubAdapter.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 "RoutingControlObserverDBusStubAdapter.h" @@ -31,13 +26,14 @@ namespace genivi { namespace am { std::shared_ptr<CommonAPI::DBus::DBusStubAdapter> createRoutingControlObserverDBusStubAdapter( + 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<RoutingControlObserverDBusStubAdapter>(commonApiAddress, interfaceName, busName, objectPath, dbusProxyConnection, stubBase); + return std::make_shared<RoutingControlObserverDBusStubAdapter>(factory, commonApiAddress, interfaceName, busName, objectPath, dbusProxyConnection, stubBase); } __attribute__((constructor)) void registerRoutingControlObserverDBusStubAdapter(void) { @@ -46,87 +42,147 @@ __attribute__((constructor)) void registerRoutingControlObserverDBusStubAdapter( } RoutingControlObserverDBusStubAdapter::RoutingControlObserverDBusStubAdapter( + 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): - RoutingControlObserverDBusStubAdapterHelper(commonApiAddress, dbusInterfaceName, dbusBusName, dbusObjectPath, dbusConnection, std::dynamic_pointer_cast<RoutingControlObserverStub>(stub)) { + RoutingControlObserverDBusStubAdapterHelper(factory, commonApiAddress, dbusInterfaceName, dbusBusName, dbusObjectPath, + dbusConnection, std::dynamic_pointer_cast<RoutingControlObserverStub>(stub), + NULL) + { +} + +RoutingControlObserverDBusStubAdapter::~RoutingControlObserverDBusStubAdapter() { + deactivateManagedInstances(); + deinit(); + stub_.reset(); +} + +void RoutingControlObserverDBusStubAdapter::deactivateManagedInstances() { } const char* RoutingControlObserverDBusStubAdapter::getMethodsDBusIntrospectionXmlData() const { - return + static const char* introspectionData = "<method name=\"getRoutingReadyAttribute\">\n" - "<arg name=\"value\" type=\"i\" direction=\"out\" />" - "</method>\n" - "<method name=\"setRoutingReadyAttribute\">\n" - "<arg name=\"requestedValue\" type=\"i\" direction=\"in\" />\n" - "<arg name=\"setValue\" type=\"i\" direction=\"out\" />\n" + "<arg name=\"value\" type=\"i\" direction=\"out\" />" "</method>\n" "<signal name=\"onRoutingReadyAttributeChanged\">\n" "<arg name=\"changedValue\" type=\"i\" />\n" "</signal>\n" + /** + * acknowledges a asyncConnect + */ "<method name=\"ackConnect\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"connectionID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * acknowledges a asyncDisconnect + */ "<method name=\"ackDisconnect\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"connectionID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * acknowledges a asyncsetSinkVolume + */ "<method name=\"ackSetSinkVolumeChange\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"volume\" type=\"n\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * acknowledges a asyncsetSourceVolume + */ "<method name=\"ackSetSourceVolumeChange\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"volume\" type=\"n\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * acknowlegde for asyncSetSourceState + */ "<method name=\"ackSetSourceState\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * acknowledges asyncSetSinkSoundProperties + */ "<method name=\"ackSetSinkSoundProperties\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * acknowledges asyncSetSinkSoundProperty + */ "<method name=\"ackSetSinkSoundProperty\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * acknowledges asyncSetSourceSoundProperties + */ "<method name=\"ackSetSourceSoundProperties\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * acknowledges asyncSetSourceSoundProperty + */ "<method name=\"ackSetSourceSoundProperty\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * acknowledges asyncCrossFade + */ "<method name=\"ackCrossFading\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"hotSink\" type=\"i\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ "<method name=\"ackSourceVolumeTick\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"sourceID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"volume\" type=\"n\" direction=\"in\" />\n" "</method>\n" + /** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ "<method name=\"ackSinkVolumeTick\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"volume\" type=\"n\" direction=\"in\" />\n" "</method>\n" + /** + * This function returns the ID to the given domainName. If already a domain is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the domain. The other parameters of the domain + * will be overwritten when the domain is registered. + (at)return E_OK on + * success, E_UNKNOWN on error + */ "<method name=\"peekDomain\">\n" "<arg name=\"name\" type=\"s\" direction=\"in\" />\n" "<arg name=\"domainID\" type=\"q\" direction=\"out\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * registers a domain + (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ "<method name=\"registerDomain\">\n" "<arg name=\"domainData\" type=\"(qsssbbi)\" direction=\"in\" />\n" "<arg name=\"returnBusname\" type=\"s\" direction=\"in\" />\n" @@ -134,92 +190,199 @@ const char* RoutingControlObserverDBusStubAdapter::getMethodsDBusIntrospectionXm "<arg name=\"domainID\" type=\"q\" direction=\"out\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * deregisters a domain. All sources, sinks, gateways and crossfaders from that + * domain will be removed as well. + (at)return E_OK on succes, E_NON_EXISTENT if + * not found E_UNKOWN on error + */ "<method name=\"deregisterDomain\">\n" "<arg name=\"domainID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * registers a gateway. (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ "<method name=\"registerGateway\">\n" "<arg name=\"gatewayData\" type=\"(qsqqqqqaqaqab)\" direction=\"in\" />\n" "<arg name=\"gatewayID\" type=\"q\" direction=\"out\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * deregisters a gateway. Also removes all sinks and sources of the controlling + * domain. + (at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ "<method name=\"deregisterGateway\">\n" "<arg name=\"gatewayID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * This function returns the ID to the given sinkName. If already a sink is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the sink. The other parameters of the sink will + * be overwritten when the sink is registered. + (at)return E_OK on success, + * E_UNKNOWN on error + */ "<method name=\"peekSink\">\n" "<arg name=\"name\" type=\"s\" direction=\"in\" />\n" "<arg name=\"sinkID\" type=\"q\" direction=\"out\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * Registers a sink. If the sink is part of a gateway, the listconnectionFormats + * is copied to the gatewayInformation + (at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ "<method name=\"registerSink\">\n" "<arg name=\"sinkData\" type=\"(qsqqnb(iq)ina(qn)aqa(qn)a(qin)a(qin))\" direction=\"in\" />\n" "<arg name=\"sinkID\" type=\"q\" direction=\"out\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * deregisters a sink. + (at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ "<method name=\"deregisterSink\">\n" "<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * This function returns the ID to the given sourceName. If already a source is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the source. The other parameters of the source + * will be overwritten when the source is registered. + (at)return E_OK on + * success, E_UNKNOWN on error + */ "<method name=\"peekSource\">\n" "<arg name=\"name\" type=\"s\" direction=\"in\" />\n" "<arg name=\"sourceID\" type=\"q\" direction=\"out\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * registers a source. If the source is part of a gateway, the + * listconnectionFormats is copied to the gatewayInformation + (at)return E_OK on + * success, E_UNKNOWN on error, E_ALREADY_EXIST if either name or sourceID + * already exists + */ "<method name=\"registerSource\">\n" "<arg name=\"sourceData\" type=\"(qqsqinb(iq)ia(qn)aqa(qn)a(qin)a(qin))\" direction=\"in\" />\n" "<arg name=\"sourceID\" type=\"q\" direction=\"out\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * deregisters a source + (at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ "<method name=\"deregisterSource\">\n" "<arg name=\"sourceID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * this function registers a crossfader. + (at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ "<method name=\"registerCrossfader\">\n" "<arg name=\"crossfaderData\" type=\"(qsqqqi)\" direction=\"in\" />\n" "<arg name=\"crossfaderID\" type=\"q\" direction=\"out\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * this function deregisters a crossfader. removes all sources and sinks assiated + * as well. + (at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ "<method name=\"deregisterCrossfader\">\n" "<arg name=\"crossfaderID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. + (at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ "<method name=\"peekSourceClassID\">\n" "<arg name=\"name\" type=\"s\" direction=\"in\" />\n" "<arg name=\"sourceClassID\" type=\"q\" direction=\"out\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. + (at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ "<method name=\"peekSinkClassID\">\n" "<arg name=\"name\" type=\"s\" direction=\"in\" />\n" "<arg name=\"sinkClassID\" type=\"q\" direction=\"out\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * is called when a low level interrupt changes it status. + */ "<method name=\"hookInterruptStatusChange\">\n" "<arg name=\"sourceID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"interruptState\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * This hook is called when all elements from a domain are registered. + Is used by + * the Controller to know when all expected domains are finally registered + */ "<method name=\"hookDomainRegistrationComplete\">\n" "<arg name=\"domainID\" type=\"q\" direction=\"in\" />\n" "</method>\n" + /** + * is called when a sink changes its availability + */ "<method name=\"hookSinkAvailablityStatusChange\">\n" "<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"availability\" type=\"(iq)\" direction=\"in\" />\n" "</method>\n" + /** + * is called when a source changes its availability + */ "<method name=\"hookSourceAvailablityStatusChange\">\n" "<arg name=\"sourceID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"availability\" type=\"(iq)\" direction=\"in\" />\n" "</method>\n" + /** + * is called when a domain changes its status. This used for early domains only + */ "<method name=\"hookDomainStateChange\">\n" "<arg name=\"domainID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"domainState\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * is called when the timinginformation (delay) changed for a connection. + */ "<method name=\"hookTimingInformationChanged\">\n" "<arg name=\"connectionID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"delay\" type=\"n\" direction=\"in\" />\n" "</method>\n" + /** + * this function is used to send out all data that has been changed in an early + * state. + (at)return E_OK on success, E_UNKNOWN on error + */ "<method name=\"sendChangedData\">\n" "<arg name=\"earlyData\" type=\"a(i(yv)(yv))\" direction=\"in\" />\n" "</method>\n" + /** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * gatewayID is not valid. + */ "<method name=\"updateGateway\">\n" "<arg name=\"gatewayID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"listSourceFormats\" type=\"aq\" direction=\"in\" />\n" @@ -227,6 +390,10 @@ const char* RoutingControlObserverDBusStubAdapter::getMethodsDBusIntrospectionXm "<arg name=\"convertionMatrix\" type=\"ab\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * sinkID is not valid. + */ "<method name=\"updateSink\">\n" "<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"sinkClassID\" type=\"q\" direction=\"in\" />\n" @@ -235,6 +402,18 @@ const char* RoutingControlObserverDBusStubAdapter::getMethodsDBusIntrospectionXm "<arg name=\"listMainSoundProperties\" type=\"a(qn)\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * updates data of an source. (at)return E_OK on success, E_NON_EXISTENT if the + * sourceID in the struct is not valid. + Please note that only the following + * data out of am_Source_s have effect when they are + * changed: + sourceClassID, + listSoundProperties, + listConnectionFormats, + * + listMainSoundProperties + */ "<method name=\"updateSource\">\n" "<arg name=\"sourceID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"sourceClassID\" type=\"q\" direction=\"in\" />\n" @@ -243,23 +422,38 @@ const char* RoutingControlObserverDBusStubAdapter::getMethodsDBusIntrospectionXm "<arg name=\"listMainSoundProperties\" type=\"a(qn)\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"out\" />\n" "</method>\n" + /** + * acknowledges a asyncSetSinkVolumes + */ "<method name=\"ackSetVolumes\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"listvolumes\" type=\"a(i(yv)nqn)\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * The acknowledge of the SinkNotificationConfiguration + */ "<method name=\"ackSinkNotificationConfiguration\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * The acknowledge of the SourceNotificationConfiguration + */ "<method name=\"ackSourceNotificationConfiguration\">\n" "<arg name=\"handle\" type=\"(iq)\" direction=\"in\" />\n" "<arg name=\"error\" type=\"i\" direction=\"in\" />\n" "</method>\n" + /** + * is called whenever a notified value needs to be send + */ "<method name=\"hookSinkNotificationDataChange\">\n" "<arg name=\"sinkID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"payload\" type=\"(qn)\" direction=\"in\" />\n" "</method>\n" + /** + * is called whenever a notified value needs to be send + */ "<method name=\"hookSourceNotificationDataChange\">\n" "<arg name=\"sourceID\" type=\"q\" direction=\"in\" />\n" "<arg name=\"payload\" type=\"(qn)\" direction=\"in\" />\n" @@ -268,229 +462,416 @@ const char* RoutingControlObserverDBusStubAdapter::getMethodsDBusIntrospectionXm "<arg name=\"domainName\" type=\"s\" direction=\"in\" />\n" "</method>\n" ; + return introspectionData; } +/** + * This attribute signals to the clients the current routing state. +A client + * should notify himself to this attribute in order to know the current state and + * act accordingly. + */ static CommonAPI::DBus::DBusGetAttributeStubDispatcher< RoutingControlObserverStub, am_RoutingReady_e > getRoutingReadyAttributeStubDispatcher(&RoutingControlObserverStub::getRoutingReadyAttribute, "i"); -static CommonAPI::DBus::DBusSetObservableAttributeStubDispatcher< - RoutingControlObserverStub, - am_RoutingReady_e - > setRoutingReadyAttributeStubDispatcher( - &RoutingControlObserverStub::getRoutingReadyAttribute, - &RoutingControlObserverStubRemoteEvent::onRemoteSetRoutingReadyAttribute, - &RoutingControlObserverStubRemoteEvent::onRemoteRoutingReadyAttributeChanged, - &RoutingControlObserverStubAdapter::fireRoutingReadyAttributeChanged, - "i"); +/** + * acknowledges a asyncConnect + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Handle_s, am_connectionID_t, am_Error_e>, std::tuple<> > ackConnectStubDispatcher(&RoutingControlObserverStub::ackConnect, ""); +/** + * acknowledges a asyncDisconnect + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Handle_s, am_connectionID_t, am_Error_e>, std::tuple<> > ackDisconnectStubDispatcher(&RoutingControlObserverStub::ackDisconnect, ""); +/** + * acknowledges a asyncsetSinkVolume + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Handle_s, am_volume_t, am_Error_e>, std::tuple<> > ackSetSinkVolumeChangeStubDispatcher(&RoutingControlObserverStub::ackSetSinkVolumeChange, ""); +/** + * acknowledges a asyncsetSourceVolume + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Handle_s, am_volume_t, am_Error_e>, std::tuple<> > ackSetSourceVolumeChangeStubDispatcher(&RoutingControlObserverStub::ackSetSourceVolumeChange, ""); +/** + * acknowlegde for asyncSetSourceState + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Handle_s, am_Error_e>, std::tuple<> > ackSetSourceStateStubDispatcher(&RoutingControlObserverStub::ackSetSourceState, ""); +/** + * acknowledges asyncSetSinkSoundProperties + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Handle_s, am_Error_e>, std::tuple<> > ackSetSinkSoundPropertiesStubDispatcher(&RoutingControlObserverStub::ackSetSinkSoundProperties, ""); +/** + * acknowledges asyncSetSinkSoundProperty + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Handle_s, am_Error_e>, std::tuple<> > ackSetSinkSoundPropertyStubDispatcher(&RoutingControlObserverStub::ackSetSinkSoundProperty, ""); +/** + * acknowledges asyncSetSourceSoundProperties + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Handle_s, am_Error_e>, std::tuple<> > ackSetSourceSoundPropertiesStubDispatcher(&RoutingControlObserverStub::ackSetSourceSoundProperties, ""); +/** + * acknowledges asyncSetSourceSoundProperty + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Handle_s, am_Error_e>, std::tuple<> > ackSetSourceSoundPropertyStubDispatcher(&RoutingControlObserverStub::ackSetSourceSoundProperty, ""); +/** + * acknowledges asyncCrossFade + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Handle_s, am_HotSink_e, am_Error_e>, std::tuple<> > ackCrossFadingStubDispatcher(&RoutingControlObserverStub::ackCrossFading, ""); +/** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Handle_s, am_sourceID_t, am_volume_t>, std::tuple<> > ackSourceVolumeTickStubDispatcher(&RoutingControlObserverStub::ackSourceVolumeTick, ""); +/** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Handle_s, am_sinkID_t, am_volume_t>, std::tuple<> > ackSinkVolumeTickStubDispatcher(&RoutingControlObserverStub::ackSinkVolumeTick, ""); +/** + * This function returns the ID to the given domainName. If already a domain is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the domain. The other parameters of the domain + * will be overwritten when the domain is registered. +(at)return E_OK on + * success, E_UNKNOWN on error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<std::string>, std::tuple<am_domainID_t, am_Error_e> > peekDomainStubDispatcher(&RoutingControlObserverStub::peekDomain, "qi"); +/** + * registers a domain +(at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Domain_s, std::string, std::string>, std::tuple<am_domainID_t, am_Error_e> > registerDomainStubDispatcher(&RoutingControlObserverStub::registerDomain, "qi"); +/** + * deregisters a domain. All sources, sinks, gateways and crossfaders from that + * domain will be removed as well. +(at)return E_OK on succes, E_NON_EXISTENT if + * not found E_UNKOWN on error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_domainID_t>, std::tuple<am_Error_e> > deregisterDomainStubDispatcher(&RoutingControlObserverStub::deregisterDomain, "i"); +/** + * registers a gateway. (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Gateway_s>, std::tuple<am_gatewayID_t, am_Error_e> > registerGatewayStubDispatcher(&RoutingControlObserverStub::registerGateway, "qi"); +/** + * deregisters a gateway. Also removes all sinks and sources of the controlling + * domain. +(at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_gatewayID_t>, std::tuple<am_Error_e> > deregisterGatewayStubDispatcher(&RoutingControlObserverStub::deregisterGateway, "i"); +/** + * This function returns the ID to the given sinkName. If already a sink is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the sink. The other parameters of the sink will + * be overwritten when the sink is registered. +(at)return E_OK on success, + * E_UNKNOWN on error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<std::string>, std::tuple<am_sinkID_t, am_Error_e> > peekSinkStubDispatcher(&RoutingControlObserverStub::peekSink, "qi"); +/** + * Registers a sink. If the sink is part of a gateway, the listconnectionFormats + * is copied to the gatewayInformation +(at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Sink_s>, std::tuple<am_sinkID_t, am_Error_e> > registerSinkStubDispatcher(&RoutingControlObserverStub::registerSink, "qi"); +/** + * deregisters a sink. +(at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_sinkID_t>, std::tuple<am_Error_e> > deregisterSinkStubDispatcher(&RoutingControlObserverStub::deregisterSink, "i"); +/** + * This function returns the ID to the given sourceName. If already a source is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the source. The other parameters of the source + * will be overwritten when the source is registered. +(at)return E_OK on + * success, E_UNKNOWN on error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<std::string>, std::tuple<am_sourceID_t, am_Error_e> > peekSourceStubDispatcher(&RoutingControlObserverStub::peekSource, "qi"); +/** + * registers a source. If the source is part of a gateway, the + * listconnectionFormats is copied to the gatewayInformation +(at)return E_OK on + * success, E_UNKNOWN on error, E_ALREADY_EXIST if either name or sourceID + * already exists + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Source_s>, std::tuple<am_sourceID_t, am_Error_e> > registerSourceStubDispatcher(&RoutingControlObserverStub::registerSource, "qi"); +/** + * deregisters a source +(at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_sourceID_t>, std::tuple<am_Error_e> > deregisterSourceStubDispatcher(&RoutingControlObserverStub::deregisterSource, "i"); +/** + * this function registers a crossfader. +(at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Crossfader_s>, std::tuple<am_crossfaderID_t, am_Error_e> > registerCrossfaderStubDispatcher(&RoutingControlObserverStub::registerCrossfader, "qi"); +/** + * this function deregisters a crossfader. removes all sources and sinks assiated + * as well. +(at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_crossfaderID_t>, std::tuple<am_Error_e> > deregisterCrossfaderStubDispatcher(&RoutingControlObserverStub::deregisterCrossfader, "i"); +/** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. +(at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<std::string>, std::tuple<am_sourceClass_t, am_Error_e> > peekSourceClassIDStubDispatcher(&RoutingControlObserverStub::peekSourceClassID, "qi"); +/** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. +(at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<std::string>, std::tuple<am_sinkClass_t, am_Error_e> > peekSinkClassIDStubDispatcher(&RoutingControlObserverStub::peekSinkClassID, "qi"); +/** + * is called when a low level interrupt changes it status. + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_sourceID_t, am_InterruptState_e>, std::tuple<> > hookInterruptStatusChangeStubDispatcher(&RoutingControlObserverStub::hookInterruptStatusChange, ""); +/** + * This hook is called when all elements from a domain are registered. +Is used by + * the Controller to know when all expected domains are finally registered + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_domainID_t>, std::tuple<> > hookDomainRegistrationCompleteStubDispatcher(&RoutingControlObserverStub::hookDomainRegistrationComplete, ""); +/** + * is called when a sink changes its availability + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_sinkID_t, am_Availability_s>, std::tuple<> > hookSinkAvailablityStatusChangeStubDispatcher(&RoutingControlObserverStub::hookSinkAvailablityStatusChange, ""); +/** + * is called when a source changes its availability + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_sourceID_t, am_Availability_s>, std::tuple<> > hookSourceAvailablityStatusChangeStubDispatcher(&RoutingControlObserverStub::hookSourceAvailablityStatusChange, ""); +/** + * is called when a domain changes its status. This used for early domains only + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_domainID_t, am_DomainState_e>, std::tuple<> > hookDomainStateChangeStubDispatcher(&RoutingControlObserverStub::hookDomainStateChange, ""); +/** + * is called when the timinginformation (delay) changed for a connection. + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_connectionID_t, am_timeSync_t>, std::tuple<> > hookTimingInformationChangedStubDispatcher(&RoutingControlObserverStub::hookTimingInformationChanged, ""); +/** + * this function is used to send out all data that has been changed in an early + * state. +(at)return E_OK on success, E_UNKNOWN on error + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_EarlyData_L>, std::tuple<> > sendChangedDataStubDispatcher(&RoutingControlObserverStub::sendChangedData, ""); +/** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * gatewayID is not valid. + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_gatewayID_t, am_ConnectionFormat_L, am_ConnectionFormat_L, am_Convertion_L>, std::tuple<am_Error_e> > updateGatewayStubDispatcher(&RoutingControlObserverStub::updateGateway, "i"); +/** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * sinkID is not valid. + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_sinkID_t, am_sinkClass_t, am_SoundProperty_L, am_ConnectionFormat_L, am_MainSoundProperty_L>, std::tuple<am_Error_e> > updateSinkStubDispatcher(&RoutingControlObserverStub::updateSink, "i"); +/** + * updates data of an source. (at)return E_OK on success, E_NON_EXISTENT if the + * sourceID in the struct is not valid. +Please note that only the following + * data out of am_Source_s have effect when they are + * changed: +sourceClassID, +listSoundProperties, +listConnectionFormats, + * +listMainSoundProperties + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_sourceID_t, am_sourceClass_t, am_SoundProperty_L, am_ConnectionFormat_L, am_MainSoundProperty_L>, std::tuple<am_Error_e> > updateSourceStubDispatcher(&RoutingControlObserverStub::updateSource, "i"); +/** + * acknowledges a asyncSetSinkVolumes + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Handle_s, am_Volumes_L, am_Error_e>, std::tuple<> > ackSetVolumesStubDispatcher(&RoutingControlObserverStub::ackSetVolumes, ""); +/** + * The acknowledge of the SinkNotificationConfiguration + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Handle_s, am_Error_e>, std::tuple<> > ackSinkNotificationConfigurationStubDispatcher(&RoutingControlObserverStub::ackSinkNotificationConfiguration, ""); +/** + * The acknowledge of the SourceNotificationConfiguration + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_Handle_s, am_Error_e>, std::tuple<> > ackSourceNotificationConfigurationStubDispatcher(&RoutingControlObserverStub::ackSourceNotificationConfiguration, ""); +/** + * is called whenever a notified value needs to be send + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_sinkID_t, am_NotificationPayload_s>, std::tuple<> > hookSinkNotificationDataChangeStubDispatcher(&RoutingControlObserverStub::hookSinkNotificationDataChange, ""); +/** + * is called whenever a notified value needs to be send + */ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< RoutingControlObserverStub, std::tuple<am_sourceID_t, am_NotificationPayload_s>, @@ -502,8 +883,14 @@ static CommonAPI::DBus::DBusMethodWithReplyStubDispatcher< std::tuple<> > confirmRoutingRundownStubDispatcher(&RoutingControlObserverStub::confirmRoutingRundown, ""); +/** + * This attribute signals to the clients the current routing state. +A client + * should notify himself to this attribute in order to know the current state and + * act accordingly. + */ void RoutingControlObserverDBusStubAdapter::fireRoutingReadyAttributeChanged(const am_RoutingReady_e& value) { - CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_RoutingReady_e>> + CommonAPI::DBus::DBusStubSignalHelper<CommonAPI::DBus::DBusSerializableArguments<am_RoutingReady_e>> ::sendSignal( *this, "onRoutingReadyAttributeChanged", @@ -513,56 +900,253 @@ void RoutingControlObserverDBusStubAdapter::fireRoutingReadyAttributeChanged(con } +const RoutingControlObserverDBusStubAdapter::StubDispatcherTable& RoutingControlObserverDBusStubAdapter::getStubDispatcherTable() { + static const RoutingControlObserverDBusStubAdapter::StubDispatcherTable stubDispatcherTable = { + /** + * This attribute signals to the clients the current routing state. + A client + * should notify himself to this attribute in order to know the current state and + * act accordingly. + */ + { { "getRoutingReadyAttribute", "" }, &org::genivi::am::getRoutingReadyAttributeStubDispatcher } + , + /** + * acknowledges a asyncConnect + */ + { { "ackConnect", "(iq)qi" }, &org::genivi::am::ackConnectStubDispatcher }, + /** + * acknowledges a asyncDisconnect + */ + { { "ackDisconnect", "(iq)qi" }, &org::genivi::am::ackDisconnectStubDispatcher }, + /** + * acknowledges a asyncsetSinkVolume + */ + { { "ackSetSinkVolumeChange", "(iq)ni" }, &org::genivi::am::ackSetSinkVolumeChangeStubDispatcher }, + /** + * acknowledges a asyncsetSourceVolume + */ + { { "ackSetSourceVolumeChange", "(iq)ni" }, &org::genivi::am::ackSetSourceVolumeChangeStubDispatcher }, + /** + * acknowlegde for asyncSetSourceState + */ + { { "ackSetSourceState", "(iq)i" }, &org::genivi::am::ackSetSourceStateStubDispatcher }, + /** + * acknowledges asyncSetSinkSoundProperties + */ + { { "ackSetSinkSoundProperties", "(iq)i" }, &org::genivi::am::ackSetSinkSoundPropertiesStubDispatcher }, + /** + * acknowledges asyncSetSinkSoundProperty + */ + { { "ackSetSinkSoundProperty", "(iq)i" }, &org::genivi::am::ackSetSinkSoundPropertyStubDispatcher }, + /** + * acknowledges asyncSetSourceSoundProperties + */ + { { "ackSetSourceSoundProperties", "(iq)i" }, &org::genivi::am::ackSetSourceSoundPropertiesStubDispatcher }, + /** + * acknowledges asyncSetSourceSoundProperty + */ + { { "ackSetSourceSoundProperty", "(iq)i" }, &org::genivi::am::ackSetSourceSoundPropertyStubDispatcher }, + /** + * acknowledges asyncCrossFade + */ + { { "ackCrossFading", "(iq)ii" }, &org::genivi::am::ackCrossFadingStubDispatcher }, + /** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ + { { "ackSourceVolumeTick", "(iq)qn" }, &org::genivi::am::ackSourceVolumeTickStubDispatcher }, + /** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ + { { "ackSinkVolumeTick", "(iq)qn" }, &org::genivi::am::ackSinkVolumeTickStubDispatcher }, + /** + * This function returns the ID to the given domainName. If already a domain is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the domain. The other parameters of the domain + * will be overwritten when the domain is registered. + (at)return E_OK on + * success, E_UNKNOWN on error + */ + { { "peekDomain", "s" }, &org::genivi::am::peekDomainStubDispatcher }, + /** + * registers a domain + (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ + { { "registerDomain", "(qsssbbi)ss" }, &org::genivi::am::registerDomainStubDispatcher }, + /** + * deregisters a domain. All sources, sinks, gateways and crossfaders from that + * domain will be removed as well. + (at)return E_OK on succes, E_NON_EXISTENT if + * not found E_UNKOWN on error + */ + { { "deregisterDomain", "q" }, &org::genivi::am::deregisterDomainStubDispatcher }, + /** + * registers a gateway. (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ + { { "registerGateway", "(qsqqqqqaqaqab)" }, &org::genivi::am::registerGatewayStubDispatcher }, + /** + * deregisters a gateway. Also removes all sinks and sources of the controlling + * domain. + (at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ + { { "deregisterGateway", "q" }, &org::genivi::am::deregisterGatewayStubDispatcher }, + /** + * This function returns the ID to the given sinkName. If already a sink is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the sink. The other parameters of the sink will + * be overwritten when the sink is registered. + (at)return E_OK on success, + * E_UNKNOWN on error + */ + { { "peekSink", "s" }, &org::genivi::am::peekSinkStubDispatcher }, + /** + * Registers a sink. If the sink is part of a gateway, the listconnectionFormats + * is copied to the gatewayInformation + (at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ + { { "registerSink", "(qsqqnb(iq)ina(qn)aqa(qn)a(qin)a(qin))" }, &org::genivi::am::registerSinkStubDispatcher }, + /** + * deregisters a sink. + (at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ + { { "deregisterSink", "q" }, &org::genivi::am::deregisterSinkStubDispatcher }, + /** + * This function returns the ID to the given sourceName. If already a source is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the source. The other parameters of the source + * will be overwritten when the source is registered. + (at)return E_OK on + * success, E_UNKNOWN on error + */ + { { "peekSource", "s" }, &org::genivi::am::peekSourceStubDispatcher }, + /** + * registers a source. If the source is part of a gateway, the + * listconnectionFormats is copied to the gatewayInformation + (at)return E_OK on + * success, E_UNKNOWN on error, E_ALREADY_EXIST if either name or sourceID + * already exists + */ + { { "registerSource", "(qqsqinb(iq)ia(qn)aqa(qn)a(qin)a(qin))" }, &org::genivi::am::registerSourceStubDispatcher }, + /** + * deregisters a source + (at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ + { { "deregisterSource", "q" }, &org::genivi::am::deregisterSourceStubDispatcher }, + /** + * this function registers a crossfader. + (at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ + { { "registerCrossfader", "(qsqqqi)" }, &org::genivi::am::registerCrossfaderStubDispatcher }, + /** + * this function deregisters a crossfader. removes all sources and sinks assiated + * as well. + (at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ + { { "deregisterCrossfader", "q" }, &org::genivi::am::deregisterCrossfaderStubDispatcher }, + /** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. + (at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ + { { "peekSourceClassID", "s" }, &org::genivi::am::peekSourceClassIDStubDispatcher }, + /** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. + (at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ + { { "peekSinkClassID", "s" }, &org::genivi::am::peekSinkClassIDStubDispatcher }, + /** + * is called when a low level interrupt changes it status. + */ + { { "hookInterruptStatusChange", "qi" }, &org::genivi::am::hookInterruptStatusChangeStubDispatcher }, + /** + * This hook is called when all elements from a domain are registered. + Is used by + * the Controller to know when all expected domains are finally registered + */ + { { "hookDomainRegistrationComplete", "q" }, &org::genivi::am::hookDomainRegistrationCompleteStubDispatcher }, + /** + * is called when a sink changes its availability + */ + { { "hookSinkAvailablityStatusChange", "q(iq)" }, &org::genivi::am::hookSinkAvailablityStatusChangeStubDispatcher }, + /** + * is called when a source changes its availability + */ + { { "hookSourceAvailablityStatusChange", "q(iq)" }, &org::genivi::am::hookSourceAvailablityStatusChangeStubDispatcher }, + /** + * is called when a domain changes its status. This used for early domains only + */ + { { "hookDomainStateChange", "qi" }, &org::genivi::am::hookDomainStateChangeStubDispatcher }, + /** + * is called when the timinginformation (delay) changed for a connection. + */ + { { "hookTimingInformationChanged", "qn" }, &org::genivi::am::hookTimingInformationChangedStubDispatcher }, + /** + * this function is used to send out all data that has been changed in an early + * state. + (at)return E_OK on success, E_UNKNOWN on error + */ + { { "sendChangedData", "a(i(yv)(yv))" }, &org::genivi::am::sendChangedDataStubDispatcher }, + /** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * gatewayID is not valid. + */ + { { "updateGateway", "qaqaqab" }, &org::genivi::am::updateGatewayStubDispatcher }, + /** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * sinkID is not valid. + */ + { { "updateSink", "qqa(qn)aqa(qn)" }, &org::genivi::am::updateSinkStubDispatcher }, + /** + * updates data of an source. (at)return E_OK on success, E_NON_EXISTENT if the + * sourceID in the struct is not valid. + Please note that only the following + * data out of am_Source_s have effect when they are + * changed: + sourceClassID, + listSoundProperties, + listConnectionFormats, + * + listMainSoundProperties + */ + { { "updateSource", "qqa(qn)aqa(qn)" }, &org::genivi::am::updateSourceStubDispatcher }, + /** + * acknowledges a asyncSetSinkVolumes + */ + { { "ackSetVolumes", "(iq)a(i(yv)nqn)i" }, &org::genivi::am::ackSetVolumesStubDispatcher }, + /** + * The acknowledge of the SinkNotificationConfiguration + */ + { { "ackSinkNotificationConfiguration", "(iq)i" }, &org::genivi::am::ackSinkNotificationConfigurationStubDispatcher }, + /** + * The acknowledge of the SourceNotificationConfiguration + */ + { { "ackSourceNotificationConfiguration", "(iq)i" }, &org::genivi::am::ackSourceNotificationConfigurationStubDispatcher }, + /** + * is called whenever a notified value needs to be send + */ + { { "hookSinkNotificationDataChange", "q(qn)" }, &org::genivi::am::hookSinkNotificationDataChangeStubDispatcher }, + /** + * is called whenever a notified value needs to be send + */ + { { "hookSourceNotificationDataChange", "q(qn)" }, &org::genivi::am::hookSourceNotificationDataChangeStubDispatcher }, + { { "confirmRoutingRundown", "s" }, &org::genivi::am::confirmRoutingRundownStubDispatcher } + }; + return stubDispatcherTable; +} + + } // namespace am } // namespace genivi } // namespace org - -template<> -const org::genivi::am::RoutingControlObserverDBusStubAdapterHelper::StubDispatcherTable org::genivi::am::RoutingControlObserverDBusStubAdapterHelper::stubDispatcherTable_ = { - { { "getRoutingReadyAttribute", "" }, &org::genivi::am::getRoutingReadyAttributeStubDispatcher } - , { { "setRoutingReadyAttribute", "i" }, &org::genivi::am::setRoutingReadyAttributeStubDispatcher } - , - { { "ackConnect", "(iq)qi" }, &org::genivi::am::ackConnectStubDispatcher }, - { { "ackDisconnect", "(iq)qi" }, &org::genivi::am::ackDisconnectStubDispatcher }, - { { "ackSetSinkVolumeChange", "(iq)ni" }, &org::genivi::am::ackSetSinkVolumeChangeStubDispatcher }, - { { "ackSetSourceVolumeChange", "(iq)ni" }, &org::genivi::am::ackSetSourceVolumeChangeStubDispatcher }, - { { "ackSetSourceState", "(iq)i" }, &org::genivi::am::ackSetSourceStateStubDispatcher }, - { { "ackSetSinkSoundProperties", "(iq)i" }, &org::genivi::am::ackSetSinkSoundPropertiesStubDispatcher }, - { { "ackSetSinkSoundProperty", "(iq)i" }, &org::genivi::am::ackSetSinkSoundPropertyStubDispatcher }, - { { "ackSetSourceSoundProperties", "(iq)i" }, &org::genivi::am::ackSetSourceSoundPropertiesStubDispatcher }, - { { "ackSetSourceSoundProperty", "(iq)i" }, &org::genivi::am::ackSetSourceSoundPropertyStubDispatcher }, - { { "ackCrossFading", "(iq)ii" }, &org::genivi::am::ackCrossFadingStubDispatcher }, - { { "ackSourceVolumeTick", "(iq)qn" }, &org::genivi::am::ackSourceVolumeTickStubDispatcher }, - { { "ackSinkVolumeTick", "(iq)qn" }, &org::genivi::am::ackSinkVolumeTickStubDispatcher }, - { { "peekDomain", "s" }, &org::genivi::am::peekDomainStubDispatcher }, - { { "registerDomain", "(qsssbbi)ss" }, &org::genivi::am::registerDomainStubDispatcher }, - { { "deregisterDomain", "q" }, &org::genivi::am::deregisterDomainStubDispatcher }, - { { "registerGateway", "(qsqqqqqaqaqab)" }, &org::genivi::am::registerGatewayStubDispatcher }, - { { "deregisterGateway", "q" }, &org::genivi::am::deregisterGatewayStubDispatcher }, - { { "peekSink", "s" }, &org::genivi::am::peekSinkStubDispatcher }, - { { "registerSink", "(qsqqnb(iq)ina(qn)aqa(qn)a(qin)a(qin))" }, &org::genivi::am::registerSinkStubDispatcher }, - { { "deregisterSink", "q" }, &org::genivi::am::deregisterSinkStubDispatcher }, - { { "peekSource", "s" }, &org::genivi::am::peekSourceStubDispatcher }, - { { "registerSource", "(qqsqinb(iq)ia(qn)aqa(qn)a(qin)a(qin))" }, &org::genivi::am::registerSourceStubDispatcher }, - { { "deregisterSource", "q" }, &org::genivi::am::deregisterSourceStubDispatcher }, - { { "registerCrossfader", "(qsqqqi)" }, &org::genivi::am::registerCrossfaderStubDispatcher }, - { { "deregisterCrossfader", "q" }, &org::genivi::am::deregisterCrossfaderStubDispatcher }, - { { "peekSourceClassID", "s" }, &org::genivi::am::peekSourceClassIDStubDispatcher }, - { { "peekSinkClassID", "s" }, &org::genivi::am::peekSinkClassIDStubDispatcher }, - { { "hookInterruptStatusChange", "qi" }, &org::genivi::am::hookInterruptStatusChangeStubDispatcher }, - { { "hookDomainRegistrationComplete", "q" }, &org::genivi::am::hookDomainRegistrationCompleteStubDispatcher }, - { { "hookSinkAvailablityStatusChange", "q(iq)" }, &org::genivi::am::hookSinkAvailablityStatusChangeStubDispatcher }, - { { "hookSourceAvailablityStatusChange", "q(iq)" }, &org::genivi::am::hookSourceAvailablityStatusChangeStubDispatcher }, - { { "hookDomainStateChange", "qi" }, &org::genivi::am::hookDomainStateChangeStubDispatcher }, - { { "hookTimingInformationChanged", "qn" }, &org::genivi::am::hookTimingInformationChangedStubDispatcher }, - { { "sendChangedData", "a(i(yv)(yv))" }, &org::genivi::am::sendChangedDataStubDispatcher }, - { { "updateGateway", "qaqaqab" }, &org::genivi::am::updateGatewayStubDispatcher }, - { { "updateSink", "qqa(qn)aqa(qn)" }, &org::genivi::am::updateSinkStubDispatcher }, - { { "updateSource", "qqa(qn)aqa(qn)" }, &org::genivi::am::updateSourceStubDispatcher }, - { { "ackSetVolumes", "(iq)a(i(yv)nqn)i" }, &org::genivi::am::ackSetVolumesStubDispatcher }, - { { "ackSinkNotificationConfiguration", "(iq)i" }, &org::genivi::am::ackSinkNotificationConfigurationStubDispatcher }, - { { "ackSourceNotificationConfiguration", "(iq)i" }, &org::genivi::am::ackSourceNotificationConfigurationStubDispatcher }, - { { "hookSinkNotificationDataChange", "q(qn)" }, &org::genivi::am::hookSinkNotificationDataChangeStubDispatcher }, - { { "hookSourceNotificationDataChange", "q(qn)" }, &org::genivi::am::hookSourceNotificationDataChangeStubDispatcher }, - { { "confirmRoutingRundown", "s" }, &org::genivi::am::confirmRoutingRundownStubDispatcher } -}; diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusStubAdapter.h b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusStubAdapter.h index e8eefd1..65508fe 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusStubAdapter.h +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverDBusStubAdapter.h @@ -1,37 +1,40 @@ /* -* 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/. */ +/** + * Routing Receive sendInterface description. + * @author Christian Mueller + */ #ifndef ORG_GENIVI_AM_Routing_Control_Observer_DBUS_STUB_ADAPTER_H_ #define ORG_GENIVI_AM_Routing_Control_Observer_DBUS_STUB_ADAPTER_H_ #include <org/genivi/am/RoutingControlObserverStub.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,18 +47,34 @@ typedef CommonAPI::DBus::DBusStubAdapterHelper<RoutingControlObserverStub> Routi class RoutingControlObserverDBusStubAdapter: public RoutingControlObserverStubAdapter, public RoutingControlObserverDBusStubAdapterHelper { public: RoutingControlObserverDBusStubAdapter( + 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); - + + ~RoutingControlObserverDBusStubAdapter(); + + /** + * This attribute signals to the clients the current routing state. + A client + * should notify himself to this attribute in order to know the current state and + * act accordingly. + */ void fireRoutingReadyAttributeChanged(const am_RoutingReady_e& value); + + + const StubDispatcherTable& getStubDispatcherTable(); + + void deactivateManagedInstances(); protected: virtual const char* getMethodsDBusIntrospectionXmlData() const; + + private: }; } // namespace am diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverProxy.h b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverProxy.h index 7a22e9d..c25ed8d 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverProxy.h +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverProxy.h @@ -1,34 +1,35 @@ /* -* 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/. */ +/** + * Routing Receive sendInterface description. + * @author Christian Mueller + */ #ifndef ORG_GENIVI_AM_Routing_Control_Observer_PROXY_H_ #define ORG_GENIVI_AM_Routing_Control_Observer_PROXY_H_ #include "RoutingControlObserverProxyBase.h" +#if !defined (COMMONAPI_INTERNAL_COMPILATION) #define COMMONAPI_INTERNAL_COMPILATION +#endif #include <CommonAPI/AttributeExtension.h> #include <CommonAPI/Factory.h> @@ -45,22 +46,29 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua RoutingControlObserverProxy(std::shared_ptr<CommonAPI::Proxy> delegate); ~RoutingControlObserverProxy(); - /// Returns the wrapper class that provides access to the attribute RoutingReady. + /** + * This attribute signals to the clients the current routing state. + A client + * should notify himself to this attribute in order to know the current state and + * act accordingly. + */ + /** + * Returns the wrapper class that provides access to the attribute RoutingReady. + */ virtual RoutingReadyAttribute& getRoutingReadyAttribute() { return delegate_->getRoutingReadyAttribute(); } - - /** + * acknowledges a asyncConnect + * * Calls ackConnect with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 ackConnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, CommonAPI::CallStatus& callStatus); /** @@ -74,15 +82,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> ackConnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, AckConnectAsyncCallback callback); - /** + * acknowledges a asyncDisconnect + * * Calls ackDisconnect with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 ackDisconnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, CommonAPI::CallStatus& callStatus); /** @@ -96,15 +104,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> ackDisconnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, AckDisconnectAsyncCallback callback); - /** + * acknowledges a asyncsetSinkVolume + * * Calls ackSetSinkVolumeChange with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 ackSetSinkVolumeChange(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, CommonAPI::CallStatus& callStatus); /** @@ -118,15 +126,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> ackSetSinkVolumeChangeAsync(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, AckSetSinkVolumeChangeAsyncCallback callback); - /** + * acknowledges a asyncsetSourceVolume + * * Calls ackSetSourceVolumeChange with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 ackSetSourceVolumeChange(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, CommonAPI::CallStatus& callStatus); /** @@ -140,15 +148,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> ackSetSourceVolumeChangeAsync(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, AckSetSourceVolumeChangeAsyncCallback callback); - /** + * acknowlegde for asyncSetSourceState + * * Calls ackSetSourceState with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 ackSetSourceState(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus); /** @@ -162,15 +170,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> ackSetSourceStateAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSourceStateAsyncCallback callback); - /** + * acknowledges asyncSetSinkSoundProperties + * * Calls ackSetSinkSoundProperties with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 ackSetSinkSoundProperties(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus); /** @@ -184,15 +192,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> ackSetSinkSoundPropertiesAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSinkSoundPropertiesAsyncCallback callback); - /** + * acknowledges asyncSetSinkSoundProperty + * * Calls ackSetSinkSoundProperty with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 ackSetSinkSoundProperty(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus); /** @@ -206,15 +214,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> ackSetSinkSoundPropertyAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSinkSoundPropertyAsyncCallback callback); - /** + * acknowledges asyncSetSourceSoundProperties + * * Calls ackSetSourceSoundProperties with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 ackSetSourceSoundProperties(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus); /** @@ -228,15 +236,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> ackSetSourceSoundPropertiesAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSourceSoundPropertiesAsyncCallback callback); - /** + * acknowledges asyncSetSourceSoundProperty + * * Calls ackSetSourceSoundProperty with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 ackSetSourceSoundProperty(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus); /** @@ -250,15 +258,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> ackSetSourceSoundPropertyAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSourceSoundPropertyAsyncCallback callback); - /** + * acknowledges asyncCrossFade + * * Calls ackCrossFading with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 ackCrossFading(const am_Handle_s& handle, const am_HotSink_e& hotSink, const am_Error_e& error, CommonAPI::CallStatus& callStatus); /** @@ -272,15 +280,16 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> ackCrossFadingAsync(const am_Handle_s& handle, const am_HotSink_e& hotSink, const am_Error_e& error, AckCrossFadingAsyncCallback callback); - /** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + * * Calls ackSourceVolumeTick with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 ackSourceVolumeTick(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, CommonAPI::CallStatus& callStatus); /** @@ -294,15 +303,16 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> ackSourceVolumeTickAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, AckSourceVolumeTickAsyncCallback callback); - /** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + * * Calls ackSinkVolumeTick with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 ackSinkVolumeTick(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, CommonAPI::CallStatus& callStatus); /** @@ -316,16 +326,21 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> ackSinkVolumeTickAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, AckSinkVolumeTickAsyncCallback callback); - /** + * This function returns the ID to the given domainName. If already a domain is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the domain. The other parameters of the domain + * will be overwritten when the domain is registered. + (at)return E_OK on + * success, E_UNKNOWN on error + * * Calls peekDomain 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 peekDomain(const std::string& name, CommonAPI::CallStatus& callStatus, am_domainID_t& domainID, am_Error_e& error); /** @@ -339,16 +354,18 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> peekDomainAsync(const std::string& name, PeekDomainAsyncCallback callback); - /** + * registers a domain + (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + * * Calls registerDomain 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 registerDomain(const am_Domain_s& domainData, const std::string& returnBusname, const std::string& returnInterface, CommonAPI::CallStatus& callStatus, am_domainID_t& domainID, am_Error_e& error); /** @@ -362,16 +379,19 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> registerDomainAsync(const am_Domain_s& domainData, const std::string& returnBusname, const std::string& returnInterface, RegisterDomainAsyncCallback callback); - /** + * deregisters a domain. All sources, sinks, gateways and crossfaders from that + * domain will be removed as well. + (at)return E_OK on succes, E_NON_EXISTENT if + * not found E_UNKOWN on error + * * Calls deregisterDomain 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 deregisterDomain(const am_domainID_t& domainID, CommonAPI::CallStatus& callStatus, am_Error_e& error); /** @@ -385,16 +405,17 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> deregisterDomainAsync(const am_domainID_t& domainID, DeregisterDomainAsyncCallback callback); - /** + * registers a gateway. (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + * * Calls registerGateway 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 registerGateway(const am_Gateway_s& gatewayData, CommonAPI::CallStatus& callStatus, am_gatewayID_t& gatewayID, am_Error_e& error); /** @@ -408,16 +429,19 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> registerGatewayAsync(const am_Gateway_s& gatewayData, RegisterGatewayAsyncCallback callback); - /** + * deregisters a gateway. Also removes all sinks and sources of the controlling + * domain. + (at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + * * Calls deregisterGateway 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 deregisterGateway(const am_gatewayID_t& gatewayID, CommonAPI::CallStatus& callStatus, am_Error_e& error); /** @@ -431,16 +455,21 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> deregisterGatewayAsync(const am_gatewayID_t& gatewayID, DeregisterGatewayAsyncCallback callback); - /** + * This function returns the ID to the given sinkName. If already a sink is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the sink. The other parameters of the sink will + * be overwritten when the sink is registered. + (at)return E_OK on success, + * E_UNKNOWN on error + * * Calls peekSink 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 peekSink(const std::string& name, CommonAPI::CallStatus& callStatus, am_sinkID_t& sinkID, am_Error_e& error); /** @@ -454,16 +483,19 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> peekSinkAsync(const std::string& name, PeekSinkAsyncCallback callback); - /** + * Registers a sink. If the sink is part of a gateway, the listconnectionFormats + * is copied to the gatewayInformation + (at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + * * Calls registerSink 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 registerSink(const am_Sink_s& sinkData, CommonAPI::CallStatus& callStatus, am_sinkID_t& sinkID, am_Error_e& error); /** @@ -477,16 +509,18 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> registerSinkAsync(const am_Sink_s& sinkData, RegisterSinkAsyncCallback callback); - /** + * deregisters a sink. + (at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + * * Calls deregisterSink 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 deregisterSink(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_Error_e& error); /** @@ -500,16 +534,21 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> deregisterSinkAsync(const am_sinkID_t& sinkID, DeregisterSinkAsyncCallback callback); - /** + * This function returns the ID to the given sourceName. If already a source is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the source. The other parameters of the source + * will be overwritten when the source is registered. + (at)return E_OK on + * success, E_UNKNOWN on error + * * Calls peekSource 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 peekSource(const std::string& name, CommonAPI::CallStatus& callStatus, am_sourceID_t& sourceID, am_Error_e& error); /** @@ -523,16 +562,20 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> peekSourceAsync(const std::string& name, PeekSourceAsyncCallback callback); - /** + * registers a source. If the source is part of a gateway, the + * listconnectionFormats is copied to the gatewayInformation + (at)return E_OK on + * success, E_UNKNOWN on error, E_ALREADY_EXIST if either name or sourceID + * already exists + * * Calls registerSource 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 registerSource(const am_Source_s& sourceData, CommonAPI::CallStatus& callStatus, am_sourceID_t& sourceID, am_Error_e& error); /** @@ -546,16 +589,18 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> registerSourceAsync(const am_Source_s& sourceData, RegisterSourceAsyncCallback callback); - /** + * deregisters a source + (at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + * * Calls deregisterSource 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 deregisterSource(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_Error_e& error); /** @@ -569,16 +614,18 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> deregisterSourceAsync(const am_sourceID_t& sourceID, DeregisterSourceAsyncCallback callback); - /** + * this function registers a crossfader. + (at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + * * Calls registerCrossfader 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 registerCrossfader(const am_Crossfader_s& crossfaderData, CommonAPI::CallStatus& callStatus, am_crossfaderID_t& crossfaderID, am_Error_e& error); /** @@ -592,16 +639,19 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> registerCrossfaderAsync(const am_Crossfader_s& crossfaderData, RegisterCrossfaderAsyncCallback callback); - /** + * this function deregisters a crossfader. removes all sources and sinks assiated + * as well. + (at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + * * Calls deregisterCrossfader 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 deregisterCrossfader(const am_crossfaderID_t& crossfaderID, CommonAPI::CallStatus& callStatus, am_Error_e& error); /** @@ -615,16 +665,19 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> deregisterCrossfaderAsync(const am_crossfaderID_t& crossfaderID, DeregisterCrossfaderAsyncCallback callback); - /** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. + (at)return E_OK on succes, + * E_DATABASE_ERROR on error + * * Calls peekSourceClassID 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 peekSourceClassID(const std::string& name, CommonAPI::CallStatus& callStatus, am_sourceClass_t& sourceClassID, am_Error_e& error); /** @@ -638,16 +691,19 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> peekSourceClassIDAsync(const std::string& name, PeekSourceClassIDAsyncCallback callback); - /** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. + (at)return E_OK on succes, + * E_DATABASE_ERROR on error + * * Calls peekSinkClassID 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 peekSinkClassID(const std::string& name, CommonAPI::CallStatus& callStatus, am_sinkClass_t& sinkClassID, am_Error_e& error); /** @@ -661,15 +717,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> peekSinkClassIDAsync(const std::string& name, PeekSinkClassIDAsyncCallback callback); - /** + * is called when a low level interrupt changes it status. + * * Calls hookInterruptStatusChange with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 hookInterruptStatusChange(const am_sourceID_t& sourceID, const am_InterruptState_e& interruptState, CommonAPI::CallStatus& callStatus); /** @@ -683,15 +739,17 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> hookInterruptStatusChangeAsync(const am_sourceID_t& sourceID, const am_InterruptState_e& interruptState, HookInterruptStatusChangeAsyncCallback callback); - /** + * This hook is called when all elements from a domain are registered. + Is used by + * the Controller to know when all expected domains are finally registered + * * Calls hookDomainRegistrationComplete with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 hookDomainRegistrationComplete(const am_domainID_t& domainID, CommonAPI::CallStatus& callStatus); /** @@ -705,15 +763,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> hookDomainRegistrationCompleteAsync(const am_domainID_t& domainID, HookDomainRegistrationCompleteAsyncCallback callback); - /** + * is called when a sink changes its availability + * * Calls hookSinkAvailablityStatusChange with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 hookSinkAvailablityStatusChange(const am_sinkID_t& sinkID, const am_Availability_s& availability, CommonAPI::CallStatus& callStatus); /** @@ -727,15 +785,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> hookSinkAvailablityStatusChangeAsync(const am_sinkID_t& sinkID, const am_Availability_s& availability, HookSinkAvailablityStatusChangeAsyncCallback callback); - /** + * is called when a source changes its availability + * * Calls hookSourceAvailablityStatusChange with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 hookSourceAvailablityStatusChange(const am_sourceID_t& sourceID, const am_Availability_s& availability, CommonAPI::CallStatus& callStatus); /** @@ -749,15 +807,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> hookSourceAvailablityStatusChangeAsync(const am_sourceID_t& sourceID, const am_Availability_s& availability, HookSourceAvailablityStatusChangeAsyncCallback callback); - /** + * is called when a domain changes its status. This used for early domains only + * * Calls hookDomainStateChange with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 hookDomainStateChange(const am_domainID_t& domainID, const am_DomainState_e& domainState, CommonAPI::CallStatus& callStatus); /** @@ -771,15 +829,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> hookDomainStateChangeAsync(const am_domainID_t& domainID, const am_DomainState_e& domainState, HookDomainStateChangeAsyncCallback callback); - /** + * is called when the timinginformation (delay) changed for a connection. + * * Calls hookTimingInformationChanged with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 hookTimingInformationChanged(const am_connectionID_t& connectionID, const am_timeSync_t& delay, CommonAPI::CallStatus& callStatus); /** @@ -793,15 +851,17 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> hookTimingInformationChangedAsync(const am_connectionID_t& connectionID, const am_timeSync_t& delay, HookTimingInformationChangedAsyncCallback callback); - /** + * this function is used to send out all data that has been changed in an early + * state. + (at)return E_OK on success, E_UNKNOWN on error + * * Calls sendChangedData with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 sendChangedData(const am_EarlyData_L& earlyData, CommonAPI::CallStatus& callStatus); /** @@ -815,16 +875,17 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> sendChangedDataAsync(const am_EarlyData_L& earlyData, SendChangedDataAsyncCallback callback); - /** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * gatewayID is not valid. + * * Calls updateGateway 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 updateGateway(const am_gatewayID_t& gatewayID, const am_ConnectionFormat_L& listSourceFormats, const am_ConnectionFormat_L& listSinkFormats, const am_Convertion_L& convertionMatrix, CommonAPI::CallStatus& callStatus, am_Error_e& error); /** @@ -838,16 +899,17 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> updateGatewayAsync(const am_gatewayID_t& gatewayID, const am_ConnectionFormat_L& listSourceFormats, const am_ConnectionFormat_L& listSinkFormats, const am_Convertion_L& convertionMatrix, UpdateGatewayAsyncCallback callback); - /** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * sinkID is not valid. + * * Calls updateSink 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 updateSink(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, CommonAPI::CallStatus& callStatus, am_Error_e& error); /** @@ -861,16 +923,25 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> updateSinkAsync(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, UpdateSinkAsyncCallback callback); - /** + * updates data of an source. (at)return E_OK on success, E_NON_EXISTENT if the + * sourceID in the struct is not valid. + Please note that only the following + * data out of am_Source_s have effect when they are + * changed: + sourceClassID, + listSoundProperties, + listConnectionFormats, + * + listMainSoundProperties + * * Calls updateSource 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 updateSource(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, CommonAPI::CallStatus& callStatus, am_Error_e& error); /** @@ -884,15 +955,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> updateSourceAsync(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, UpdateSourceAsyncCallback callback); - /** + * acknowledges a asyncSetSinkVolumes + * * Calls ackSetVolumes with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 ackSetVolumes(const am_Handle_s& handle, const am_Volumes_L& listvolumes, const am_Error_e& error, CommonAPI::CallStatus& callStatus); /** @@ -906,15 +977,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> ackSetVolumesAsync(const am_Handle_s& handle, const am_Volumes_L& listvolumes, const am_Error_e& error, AckSetVolumesAsyncCallback callback); - /** + * The acknowledge of the SinkNotificationConfiguration + * * Calls ackSinkNotificationConfiguration with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 ackSinkNotificationConfiguration(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus); /** @@ -928,15 +999,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> ackSinkNotificationConfigurationAsync(const am_Handle_s& handle, const am_Error_e& error, AckSinkNotificationConfigurationAsyncCallback callback); - /** + * The acknowledge of the SourceNotificationConfiguration + * * Calls ackSourceNotificationConfiguration with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 ackSourceNotificationConfiguration(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus); /** @@ -950,15 +1021,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> ackSourceNotificationConfigurationAsync(const am_Handle_s& handle, const am_Error_e& error, AckSourceNotificationConfigurationAsyncCallback callback); - /** + * is called whenever a notified value needs to be send + * * Calls hookSinkNotificationDataChange with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 hookSinkNotificationDataChange(const am_sinkID_t& sinkID, const am_NotificationPayload_s& payload, CommonAPI::CallStatus& callStatus); /** @@ -972,15 +1043,15 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> hookSinkNotificationDataChangeAsync(const am_sinkID_t& sinkID, const am_NotificationPayload_s& payload, HookSinkNotificationDataChangeAsyncCallback callback); - /** + * is called whenever a notified value needs to be send + * * Calls hookSourceNotificationDataChange with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 hookSourceNotificationDataChange(const am_sourceID_t& sourceID, const am_NotificationPayload_s& payload, CommonAPI::CallStatus& callStatus); /** @@ -994,15 +1065,13 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> hookSourceNotificationDataChangeAsync(const am_sourceID_t& sourceID, const am_NotificationPayload_s& payload, HookSourceNotificationDataChangeAsyncCallback callback); - /** * Calls confirmRoutingRundown with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 confirmRoutingRundown(const std::string& domainName, CommonAPI::CallStatus& callStatus); /** @@ -1016,23 +1085,39 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> confirmRoutingRundownAsync(const std::string& domainName, ConfirmRoutingRundownAsyncCallback 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. */ @@ -1049,6 +1134,12 @@ class RoutingControlObserverProxy: virtual public RoutingControlObserver, virtua }; namespace RoutingControlObserverExtensions { + /** + * This attribute signals to the clients the current routing state. + A client + * should notify himself to this attribute in order to know the current state and + * act accordingly. + */ template <template <typename > class _ExtensionType> class RoutingReadyAttributeExtension { public: @@ -1083,6 +1174,9 @@ template <typename ... _AttributeExtensions> RoutingControlObserverProxy<_AttributeExtensions...>::~RoutingControlObserverProxy() { } +/** + * acknowledges a asyncConnect + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::ackConnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { delegate_->ackConnect(handle, connectionID, error, callStatus); @@ -1092,7 +1186,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::ackConnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, AckConnectAsyncCallback callback) { return delegate_->ackConnectAsync(handle, connectionID, error, callback); } - +/** + * acknowledges a asyncDisconnect + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::ackDisconnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { delegate_->ackDisconnect(handle, connectionID, error, callStatus); @@ -1102,7 +1198,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::ackDisconnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, AckDisconnectAsyncCallback callback) { return delegate_->ackDisconnectAsync(handle, connectionID, error, callback); } - +/** + * acknowledges a asyncsetSinkVolume + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::ackSetSinkVolumeChange(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { delegate_->ackSetSinkVolumeChange(handle, volume, error, callStatus); @@ -1112,7 +1210,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::ackSetSinkVolumeChangeAsync(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, AckSetSinkVolumeChangeAsyncCallback callback) { return delegate_->ackSetSinkVolumeChangeAsync(handle, volume, error, callback); } - +/** + * acknowledges a asyncsetSourceVolume + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::ackSetSourceVolumeChange(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { delegate_->ackSetSourceVolumeChange(handle, volume, error, callStatus); @@ -1122,7 +1222,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::ackSetSourceVolumeChangeAsync(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, AckSetSourceVolumeChangeAsyncCallback callback) { return delegate_->ackSetSourceVolumeChangeAsync(handle, volume, error, callback); } - +/** + * acknowlegde for asyncSetSourceState + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::ackSetSourceState(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { delegate_->ackSetSourceState(handle, error, callStatus); @@ -1132,7 +1234,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::ackSetSourceStateAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSourceStateAsyncCallback callback) { return delegate_->ackSetSourceStateAsync(handle, error, callback); } - +/** + * acknowledges asyncSetSinkSoundProperties + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::ackSetSinkSoundProperties(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { delegate_->ackSetSinkSoundProperties(handle, error, callStatus); @@ -1142,7 +1246,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::ackSetSinkSoundPropertiesAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSinkSoundPropertiesAsyncCallback callback) { return delegate_->ackSetSinkSoundPropertiesAsync(handle, error, callback); } - +/** + * acknowledges asyncSetSinkSoundProperty + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::ackSetSinkSoundProperty(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { delegate_->ackSetSinkSoundProperty(handle, error, callStatus); @@ -1152,7 +1258,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::ackSetSinkSoundPropertyAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSinkSoundPropertyAsyncCallback callback) { return delegate_->ackSetSinkSoundPropertyAsync(handle, error, callback); } - +/** + * acknowledges asyncSetSourceSoundProperties + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::ackSetSourceSoundProperties(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { delegate_->ackSetSourceSoundProperties(handle, error, callStatus); @@ -1162,7 +1270,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::ackSetSourceSoundPropertiesAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSourceSoundPropertiesAsyncCallback callback) { return delegate_->ackSetSourceSoundPropertiesAsync(handle, error, callback); } - +/** + * acknowledges asyncSetSourceSoundProperty + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::ackSetSourceSoundProperty(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { delegate_->ackSetSourceSoundProperty(handle, error, callStatus); @@ -1172,7 +1282,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::ackSetSourceSoundPropertyAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSourceSoundPropertyAsyncCallback callback) { return delegate_->ackSetSourceSoundPropertyAsync(handle, error, callback); } - +/** + * acknowledges asyncCrossFade + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::ackCrossFading(const am_Handle_s& handle, const am_HotSink_e& hotSink, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { delegate_->ackCrossFading(handle, hotSink, error, callStatus); @@ -1182,7 +1294,10 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::ackCrossFadingAsync(const am_Handle_s& handle, const am_HotSink_e& hotSink, const am_Error_e& error, AckCrossFadingAsyncCallback callback) { return delegate_->ackCrossFadingAsync(handle, hotSink, error, callback); } - +/** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::ackSourceVolumeTick(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, CommonAPI::CallStatus& callStatus) { delegate_->ackSourceVolumeTick(handle, sourceID, volume, callStatus); @@ -1192,7 +1307,10 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::ackSourceVolumeTickAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, AckSourceVolumeTickAsyncCallback callback) { return delegate_->ackSourceVolumeTickAsync(handle, sourceID, volume, callback); } - +/** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::ackSinkVolumeTick(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, CommonAPI::CallStatus& callStatus) { delegate_->ackSinkVolumeTick(handle, sinkID, volume, callStatus); @@ -1202,7 +1320,14 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::ackSinkVolumeTickAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, AckSinkVolumeTickAsyncCallback callback) { return delegate_->ackSinkVolumeTickAsync(handle, sinkID, volume, callback); } - +/** + * This function returns the ID to the given domainName. If already a domain is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the domain. The other parameters of the domain + * will be overwritten when the domain is registered. +(at)return E_OK on + * success, E_UNKNOWN on error + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::peekDomain(const std::string& name, CommonAPI::CallStatus& callStatus, am_domainID_t& domainID, am_Error_e& error) { delegate_->peekDomain(name, callStatus, domainID, error); @@ -1212,7 +1337,11 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::peekDomainAsync(const std::string& name, PeekDomainAsyncCallback callback) { return delegate_->peekDomainAsync(name, callback); } - +/** + * registers a domain +(at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::registerDomain(const am_Domain_s& domainData, const std::string& returnBusname, const std::string& returnInterface, CommonAPI::CallStatus& callStatus, am_domainID_t& domainID, am_Error_e& error) { delegate_->registerDomain(domainData, returnBusname, returnInterface, callStatus, domainID, error); @@ -1222,7 +1351,12 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::registerDomainAsync(const am_Domain_s& domainData, const std::string& returnBusname, const std::string& returnInterface, RegisterDomainAsyncCallback callback) { return delegate_->registerDomainAsync(domainData, returnBusname, returnInterface, callback); } - +/** + * deregisters a domain. All sources, sinks, gateways and crossfaders from that + * domain will be removed as well. +(at)return E_OK on succes, E_NON_EXISTENT if + * not found E_UNKOWN on error + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::deregisterDomain(const am_domainID_t& domainID, CommonAPI::CallStatus& callStatus, am_Error_e& error) { delegate_->deregisterDomain(domainID, callStatus, error); @@ -1232,7 +1366,10 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::deregisterDomainAsync(const am_domainID_t& domainID, DeregisterDomainAsyncCallback callback) { return delegate_->deregisterDomainAsync(domainID, callback); } - +/** + * registers a gateway. (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::registerGateway(const am_Gateway_s& gatewayData, CommonAPI::CallStatus& callStatus, am_gatewayID_t& gatewayID, am_Error_e& error) { delegate_->registerGateway(gatewayData, callStatus, gatewayID, error); @@ -1242,7 +1379,12 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::registerGatewayAsync(const am_Gateway_s& gatewayData, RegisterGatewayAsyncCallback callback) { return delegate_->registerGatewayAsync(gatewayData, callback); } - +/** + * deregisters a gateway. Also removes all sinks and sources of the controlling + * domain. +(at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::deregisterGateway(const am_gatewayID_t& gatewayID, CommonAPI::CallStatus& callStatus, am_Error_e& error) { delegate_->deregisterGateway(gatewayID, callStatus, error); @@ -1252,7 +1394,14 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::deregisterGatewayAsync(const am_gatewayID_t& gatewayID, DeregisterGatewayAsyncCallback callback) { return delegate_->deregisterGatewayAsync(gatewayID, callback); } - +/** + * This function returns the ID to the given sinkName. If already a sink is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the sink. The other parameters of the sink will + * be overwritten when the sink is registered. +(at)return E_OK on success, + * E_UNKNOWN on error + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::peekSink(const std::string& name, CommonAPI::CallStatus& callStatus, am_sinkID_t& sinkID, am_Error_e& error) { delegate_->peekSink(name, callStatus, sinkID, error); @@ -1262,7 +1411,12 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::peekSinkAsync(const std::string& name, PeekSinkAsyncCallback callback) { return delegate_->peekSinkAsync(name, callback); } - +/** + * Registers a sink. If the sink is part of a gateway, the listconnectionFormats + * is copied to the gatewayInformation +(at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::registerSink(const am_Sink_s& sinkData, CommonAPI::CallStatus& callStatus, am_sinkID_t& sinkID, am_Error_e& error) { delegate_->registerSink(sinkData, callStatus, sinkID, error); @@ -1272,7 +1426,11 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::registerSinkAsync(const am_Sink_s& sinkData, RegisterSinkAsyncCallback callback) { return delegate_->registerSinkAsync(sinkData, callback); } - +/** + * deregisters a sink. +(at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::deregisterSink(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_Error_e& error) { delegate_->deregisterSink(sinkID, callStatus, error); @@ -1282,7 +1440,14 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::deregisterSinkAsync(const am_sinkID_t& sinkID, DeregisterSinkAsyncCallback callback) { return delegate_->deregisterSinkAsync(sinkID, callback); } - +/** + * This function returns the ID to the given sourceName. If already a source is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the source. The other parameters of the source + * will be overwritten when the source is registered. +(at)return E_OK on + * success, E_UNKNOWN on error + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::peekSource(const std::string& name, CommonAPI::CallStatus& callStatus, am_sourceID_t& sourceID, am_Error_e& error) { delegate_->peekSource(name, callStatus, sourceID, error); @@ -1292,7 +1457,13 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::peekSourceAsync(const std::string& name, PeekSourceAsyncCallback callback) { return delegate_->peekSourceAsync(name, callback); } - +/** + * registers a source. If the source is part of a gateway, the + * listconnectionFormats is copied to the gatewayInformation +(at)return E_OK on + * success, E_UNKNOWN on error, E_ALREADY_EXIST if either name or sourceID + * already exists + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::registerSource(const am_Source_s& sourceData, CommonAPI::CallStatus& callStatus, am_sourceID_t& sourceID, am_Error_e& error) { delegate_->registerSource(sourceData, callStatus, sourceID, error); @@ -1302,7 +1473,11 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::registerSourceAsync(const am_Source_s& sourceData, RegisterSourceAsyncCallback callback) { return delegate_->registerSourceAsync(sourceData, callback); } - +/** + * deregisters a source +(at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::deregisterSource(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_Error_e& error) { delegate_->deregisterSource(sourceID, callStatus, error); @@ -1312,7 +1487,11 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::deregisterSourceAsync(const am_sourceID_t& sourceID, DeregisterSourceAsyncCallback callback) { return delegate_->deregisterSourceAsync(sourceID, callback); } - +/** + * this function registers a crossfader. +(at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::registerCrossfader(const am_Crossfader_s& crossfaderData, CommonAPI::CallStatus& callStatus, am_crossfaderID_t& crossfaderID, am_Error_e& error) { delegate_->registerCrossfader(crossfaderData, callStatus, crossfaderID, error); @@ -1322,7 +1501,12 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::registerCrossfaderAsync(const am_Crossfader_s& crossfaderData, RegisterCrossfaderAsyncCallback callback) { return delegate_->registerCrossfaderAsync(crossfaderData, callback); } - +/** + * this function deregisters a crossfader. removes all sources and sinks assiated + * as well. +(at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::deregisterCrossfader(const am_crossfaderID_t& crossfaderID, CommonAPI::CallStatus& callStatus, am_Error_e& error) { delegate_->deregisterCrossfader(crossfaderID, callStatus, error); @@ -1332,7 +1516,12 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::deregisterCrossfaderAsync(const am_crossfaderID_t& crossfaderID, DeregisterCrossfaderAsyncCallback callback) { return delegate_->deregisterCrossfaderAsync(crossfaderID, callback); } - +/** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. +(at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::peekSourceClassID(const std::string& name, CommonAPI::CallStatus& callStatus, am_sourceClass_t& sourceClassID, am_Error_e& error) { delegate_->peekSourceClassID(name, callStatus, sourceClassID, error); @@ -1342,7 +1531,12 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::peekSourceClassIDAsync(const std::string& name, PeekSourceClassIDAsyncCallback callback) { return delegate_->peekSourceClassIDAsync(name, callback); } - +/** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. +(at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::peekSinkClassID(const std::string& name, CommonAPI::CallStatus& callStatus, am_sinkClass_t& sinkClassID, am_Error_e& error) { delegate_->peekSinkClassID(name, callStatus, sinkClassID, error); @@ -1352,7 +1546,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::peekSinkClassIDAsync(const std::string& name, PeekSinkClassIDAsyncCallback callback) { return delegate_->peekSinkClassIDAsync(name, callback); } - +/** + * is called when a low level interrupt changes it status. + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::hookInterruptStatusChange(const am_sourceID_t& sourceID, const am_InterruptState_e& interruptState, CommonAPI::CallStatus& callStatus) { delegate_->hookInterruptStatusChange(sourceID, interruptState, callStatus); @@ -1362,7 +1558,11 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::hookInterruptStatusChangeAsync(const am_sourceID_t& sourceID, const am_InterruptState_e& interruptState, HookInterruptStatusChangeAsyncCallback callback) { return delegate_->hookInterruptStatusChangeAsync(sourceID, interruptState, callback); } - +/** + * This hook is called when all elements from a domain are registered. +Is used by + * the Controller to know when all expected domains are finally registered + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::hookDomainRegistrationComplete(const am_domainID_t& domainID, CommonAPI::CallStatus& callStatus) { delegate_->hookDomainRegistrationComplete(domainID, callStatus); @@ -1372,7 +1572,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::hookDomainRegistrationCompleteAsync(const am_domainID_t& domainID, HookDomainRegistrationCompleteAsyncCallback callback) { return delegate_->hookDomainRegistrationCompleteAsync(domainID, callback); } - +/** + * is called when a sink changes its availability + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::hookSinkAvailablityStatusChange(const am_sinkID_t& sinkID, const am_Availability_s& availability, CommonAPI::CallStatus& callStatus) { delegate_->hookSinkAvailablityStatusChange(sinkID, availability, callStatus); @@ -1382,7 +1584,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::hookSinkAvailablityStatusChangeAsync(const am_sinkID_t& sinkID, const am_Availability_s& availability, HookSinkAvailablityStatusChangeAsyncCallback callback) { return delegate_->hookSinkAvailablityStatusChangeAsync(sinkID, availability, callback); } - +/** + * is called when a source changes its availability + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::hookSourceAvailablityStatusChange(const am_sourceID_t& sourceID, const am_Availability_s& availability, CommonAPI::CallStatus& callStatus) { delegate_->hookSourceAvailablityStatusChange(sourceID, availability, callStatus); @@ -1392,7 +1596,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::hookSourceAvailablityStatusChangeAsync(const am_sourceID_t& sourceID, const am_Availability_s& availability, HookSourceAvailablityStatusChangeAsyncCallback callback) { return delegate_->hookSourceAvailablityStatusChangeAsync(sourceID, availability, callback); } - +/** + * is called when a domain changes its status. This used for early domains only + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::hookDomainStateChange(const am_domainID_t& domainID, const am_DomainState_e& domainState, CommonAPI::CallStatus& callStatus) { delegate_->hookDomainStateChange(domainID, domainState, callStatus); @@ -1402,7 +1608,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::hookDomainStateChangeAsync(const am_domainID_t& domainID, const am_DomainState_e& domainState, HookDomainStateChangeAsyncCallback callback) { return delegate_->hookDomainStateChangeAsync(domainID, domainState, callback); } - +/** + * is called when the timinginformation (delay) changed for a connection. + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::hookTimingInformationChanged(const am_connectionID_t& connectionID, const am_timeSync_t& delay, CommonAPI::CallStatus& callStatus) { delegate_->hookTimingInformationChanged(connectionID, delay, callStatus); @@ -1412,7 +1620,11 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::hookTimingInformationChangedAsync(const am_connectionID_t& connectionID, const am_timeSync_t& delay, HookTimingInformationChangedAsyncCallback callback) { return delegate_->hookTimingInformationChangedAsync(connectionID, delay, callback); } - +/** + * this function is used to send out all data that has been changed in an early + * state. +(at)return E_OK on success, E_UNKNOWN on error + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::sendChangedData(const am_EarlyData_L& earlyData, CommonAPI::CallStatus& callStatus) { delegate_->sendChangedData(earlyData, callStatus); @@ -1422,7 +1634,10 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::sendChangedDataAsync(const am_EarlyData_L& earlyData, SendChangedDataAsyncCallback callback) { return delegate_->sendChangedDataAsync(earlyData, callback); } - +/** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * gatewayID is not valid. + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::updateGateway(const am_gatewayID_t& gatewayID, const am_ConnectionFormat_L& listSourceFormats, const am_ConnectionFormat_L& listSinkFormats, const am_Convertion_L& convertionMatrix, CommonAPI::CallStatus& callStatus, am_Error_e& error) { delegate_->updateGateway(gatewayID, listSourceFormats, listSinkFormats, convertionMatrix, callStatus, error); @@ -1432,7 +1647,10 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::updateGatewayAsync(const am_gatewayID_t& gatewayID, const am_ConnectionFormat_L& listSourceFormats, const am_ConnectionFormat_L& listSinkFormats, const am_Convertion_L& convertionMatrix, UpdateGatewayAsyncCallback callback) { return delegate_->updateGatewayAsync(gatewayID, listSourceFormats, listSinkFormats, convertionMatrix, callback); } - +/** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * sinkID is not valid. + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::updateSink(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, CommonAPI::CallStatus& callStatus, am_Error_e& error) { delegate_->updateSink(sinkID, sinkClassID, listSoundProperties, listConnectionFormats, listMainSoundProperties, callStatus, error); @@ -1442,7 +1660,18 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::updateSinkAsync(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, UpdateSinkAsyncCallback callback) { return delegate_->updateSinkAsync(sinkID, sinkClassID, listSoundProperties, listConnectionFormats, listMainSoundProperties, callback); } - +/** + * updates data of an source. (at)return E_OK on success, E_NON_EXISTENT if the + * sourceID in the struct is not valid. +Please note that only the following + * data out of am_Source_s have effect when they are + * changed: +sourceClassID, +listSoundProperties, +listConnectionFormats, + * +listMainSoundProperties + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::updateSource(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, CommonAPI::CallStatus& callStatus, am_Error_e& error) { delegate_->updateSource(sourceID, sourceClassID, listSoundProperties, listConnectionFormats, listMainSoundProperties, callStatus, error); @@ -1452,7 +1681,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::updateSourceAsync(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, UpdateSourceAsyncCallback callback) { return delegate_->updateSourceAsync(sourceID, sourceClassID, listSoundProperties, listConnectionFormats, listMainSoundProperties, callback); } - +/** + * acknowledges a asyncSetSinkVolumes + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::ackSetVolumes(const am_Handle_s& handle, const am_Volumes_L& listvolumes, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { delegate_->ackSetVolumes(handle, listvolumes, error, callStatus); @@ -1462,7 +1693,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::ackSetVolumesAsync(const am_Handle_s& handle, const am_Volumes_L& listvolumes, const am_Error_e& error, AckSetVolumesAsyncCallback callback) { return delegate_->ackSetVolumesAsync(handle, listvolumes, error, callback); } - +/** + * The acknowledge of the SinkNotificationConfiguration + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::ackSinkNotificationConfiguration(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { delegate_->ackSinkNotificationConfiguration(handle, error, callStatus); @@ -1472,7 +1705,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::ackSinkNotificationConfigurationAsync(const am_Handle_s& handle, const am_Error_e& error, AckSinkNotificationConfigurationAsyncCallback callback) { return delegate_->ackSinkNotificationConfigurationAsync(handle, error, callback); } - +/** + * The acknowledge of the SourceNotificationConfiguration + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::ackSourceNotificationConfiguration(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) { delegate_->ackSourceNotificationConfiguration(handle, error, callStatus); @@ -1482,7 +1717,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::ackSourceNotificationConfigurationAsync(const am_Handle_s& handle, const am_Error_e& error, AckSourceNotificationConfigurationAsyncCallback callback) { return delegate_->ackSourceNotificationConfigurationAsync(handle, error, callback); } - +/** + * is called whenever a notified value needs to be send + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::hookSinkNotificationDataChange(const am_sinkID_t& sinkID, const am_NotificationPayload_s& payload, CommonAPI::CallStatus& callStatus) { delegate_->hookSinkNotificationDataChange(sinkID, payload, callStatus); @@ -1492,7 +1729,9 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::hookSinkNotificationDataChangeAsync(const am_sinkID_t& sinkID, const am_NotificationPayload_s& payload, HookSinkNotificationDataChangeAsyncCallback callback) { return delegate_->hookSinkNotificationDataChangeAsync(sinkID, payload, callback); } - +/** + * is called whenever a notified value needs to be send + */ template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::hookSourceNotificationDataChange(const am_sourceID_t& sourceID, const am_NotificationPayload_s& payload, CommonAPI::CallStatus& callStatus) { delegate_->hookSourceNotificationDataChange(sourceID, payload, callStatus); @@ -1502,7 +1741,6 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensions...>::hookSourceNotificationDataChangeAsync(const am_sourceID_t& sourceID, const am_NotificationPayload_s& payload, HookSourceNotificationDataChangeAsyncCallback callback) { return delegate_->hookSourceNotificationDataChangeAsync(sourceID, payload, callback); } - template <typename ... _AttributeExtensions> void RoutingControlObserverProxy<_AttributeExtensions...>::confirmRoutingRundown(const std::string& domainName, CommonAPI::CallStatus& callStatus) { delegate_->confirmRoutingRundown(domainName, callStatus); @@ -1513,7 +1751,6 @@ std::future<CommonAPI::CallStatus> RoutingControlObserverProxy<_AttributeExtensi return delegate_->confirmRoutingRundownAsync(domainName, callback); } - template <typename ... _AttributeExtensions> std::string RoutingControlObserverProxy<_AttributeExtensions...>::getAddress() const { return delegate_->getAddress(); @@ -1540,6 +1777,11 @@ bool RoutingControlObserverProxy<_AttributeExtensions...>::isAvailable() const { } template <typename ... _AttributeExtensions> +bool RoutingControlObserverProxy<_AttributeExtensions...>::isAvailableBlocking() const { + return delegate_->isAvailableBlocking(); +} + +template <typename ... _AttributeExtensions> CommonAPI::ProxyStatusEvent& RoutingControlObserverProxy<_AttributeExtensions...>::getProxyStatusEvent() { return delegate_->getProxyStatusEvent(); } @@ -1549,6 +1791,8 @@ CommonAPI::InterfaceVersionAttribute& RoutingControlObserverProxy<_AttributeExte return delegate_->getInterfaceVersionAttribute(); } + + } // namespace am } // namespace genivi } // namespace org @@ -1563,5 +1807,4 @@ struct DefaultAttributeProxyFactoryHelper<org::genivi::am::RoutingControlObserve }; } - #endif // ORG_GENIVI_AM_Routing_Control_Observer_PROXY_H_ diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverProxyBase.h b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverProxyBase.h index dd47b17..4e72887 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverProxyBase.h +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverProxyBase.h @@ -1,239 +1,393 @@ - /* - * 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/. +*/ +/** + * Routing Receive sendInterface description. + * @author Christian Mueller */ - #ifndef ORG_GENIVI_AM_Routing_Control_Observer_PROXY_BASE_H_ - #define ORG_GENIVI_AM_Routing_Control_Observer_PROXY_BASE_H_ - - #include "RoutingControlObserver.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> - - #include <CommonAPI/Attribute.h> - #include <CommonAPI/Proxy.h> - #include <functional> - #include <future> - - #undef COMMONAPI_INTERNAL_COMPILATION - - namespace org { - namespace genivi { - namespace am { - - class RoutingControlObserverProxyBase: virtual public CommonAPI::Proxy { - public: - typedef CommonAPI::ObservableAttribute<am_RoutingReady_e> RoutingReadyAttribute; - typedef std::function<void(const CommonAPI::CallStatus&)> AckConnectAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AckDisconnectAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AckSetSinkVolumeChangeAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AckSetSourceVolumeChangeAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AckSetSourceStateAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AckSetSinkSoundPropertiesAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AckSetSinkSoundPropertyAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AckSetSourceSoundPropertiesAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AckSetSourceSoundPropertyAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AckCrossFadingAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AckSourceVolumeTickAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AckSinkVolumeTickAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_domainID_t&, const am_Error_e&)> PeekDomainAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_domainID_t&, const am_Error_e&)> RegisterDomainAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> DeregisterDomainAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_gatewayID_t&, const am_Error_e&)> RegisterGatewayAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> DeregisterGatewayAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_sinkID_t&, const am_Error_e&)> PeekSinkAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_sinkID_t&, const am_Error_e&)> RegisterSinkAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> DeregisterSinkAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_sourceID_t&, const am_Error_e&)> PeekSourceAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_sourceID_t&, const am_Error_e&)> RegisterSourceAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> DeregisterSourceAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_crossfaderID_t&, const am_Error_e&)> RegisterCrossfaderAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> DeregisterCrossfaderAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_sourceClass_t&, const am_Error_e&)> PeekSourceClassIDAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_sinkClass_t&, const am_Error_e&)> PeekSinkClassIDAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> HookInterruptStatusChangeAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> HookDomainRegistrationCompleteAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> HookSinkAvailablityStatusChangeAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> HookSourceAvailablityStatusChangeAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> HookDomainStateChangeAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> HookTimingInformationChangedAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> SendChangedDataAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> UpdateGatewayAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> UpdateSinkAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> UpdateSourceAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AckSetVolumesAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AckSinkNotificationConfigurationAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AckSourceNotificationConfigurationAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> HookSinkNotificationDataChangeAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> HookSourceNotificationDataChangeAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> ConfirmRoutingRundownAsyncCallback; - - virtual RoutingReadyAttribute& getRoutingReadyAttribute() = 0; - - - - virtual void ackConnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> ackConnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, AckConnectAsyncCallback callback) = 0; - - virtual void ackDisconnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> ackDisconnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, AckDisconnectAsyncCallback callback) = 0; - - virtual void ackSetSinkVolumeChange(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> ackSetSinkVolumeChangeAsync(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, AckSetSinkVolumeChangeAsyncCallback callback) = 0; - - virtual void ackSetSourceVolumeChange(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> ackSetSourceVolumeChangeAsync(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, AckSetSourceVolumeChangeAsyncCallback callback) = 0; - - virtual void ackSetSourceState(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> ackSetSourceStateAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSourceStateAsyncCallback callback) = 0; - - virtual void ackSetSinkSoundProperties(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> ackSetSinkSoundPropertiesAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSinkSoundPropertiesAsyncCallback callback) = 0; - - virtual void ackSetSinkSoundProperty(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> ackSetSinkSoundPropertyAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSinkSoundPropertyAsyncCallback callback) = 0; - - virtual void ackSetSourceSoundProperties(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> ackSetSourceSoundPropertiesAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSourceSoundPropertiesAsyncCallback callback) = 0; - - virtual void ackSetSourceSoundProperty(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> ackSetSourceSoundPropertyAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSourceSoundPropertyAsyncCallback callback) = 0; - - virtual void ackCrossFading(const am_Handle_s& handle, const am_HotSink_e& hotSink, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> ackCrossFadingAsync(const am_Handle_s& handle, const am_HotSink_e& hotSink, const am_Error_e& error, AckCrossFadingAsyncCallback callback) = 0; - - virtual void ackSourceVolumeTick(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> ackSourceVolumeTickAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, AckSourceVolumeTickAsyncCallback callback) = 0; - - virtual void ackSinkVolumeTick(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> ackSinkVolumeTickAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, AckSinkVolumeTickAsyncCallback callback) = 0; - - virtual void peekDomain(const std::string& name, CommonAPI::CallStatus& callStatus, am_domainID_t& domainID, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> peekDomainAsync(const std::string& name, PeekDomainAsyncCallback callback) = 0; - - virtual void registerDomain(const am_Domain_s& domainData, const std::string& returnBusname, const std::string& returnInterface, CommonAPI::CallStatus& callStatus, am_domainID_t& domainID, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> registerDomainAsync(const am_Domain_s& domainData, const std::string& returnBusname, const std::string& returnInterface, RegisterDomainAsyncCallback callback) = 0; - - virtual void deregisterDomain(const am_domainID_t& domainID, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> deregisterDomainAsync(const am_domainID_t& domainID, DeregisterDomainAsyncCallback callback) = 0; - - virtual void registerGateway(const am_Gateway_s& gatewayData, CommonAPI::CallStatus& callStatus, am_gatewayID_t& gatewayID, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> registerGatewayAsync(const am_Gateway_s& gatewayData, RegisterGatewayAsyncCallback callback) = 0; - - virtual void deregisterGateway(const am_gatewayID_t& gatewayID, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> deregisterGatewayAsync(const am_gatewayID_t& gatewayID, DeregisterGatewayAsyncCallback callback) = 0; - - virtual void peekSink(const std::string& name, CommonAPI::CallStatus& callStatus, am_sinkID_t& sinkID, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> peekSinkAsync(const std::string& name, PeekSinkAsyncCallback callback) = 0; - - virtual void registerSink(const am_Sink_s& sinkData, CommonAPI::CallStatus& callStatus, am_sinkID_t& sinkID, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> registerSinkAsync(const am_Sink_s& sinkData, RegisterSinkAsyncCallback callback) = 0; - - virtual void deregisterSink(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> deregisterSinkAsync(const am_sinkID_t& sinkID, DeregisterSinkAsyncCallback callback) = 0; - - virtual void peekSource(const std::string& name, CommonAPI::CallStatus& callStatus, am_sourceID_t& sourceID, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> peekSourceAsync(const std::string& name, PeekSourceAsyncCallback callback) = 0; - - virtual void registerSource(const am_Source_s& sourceData, CommonAPI::CallStatus& callStatus, am_sourceID_t& sourceID, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> registerSourceAsync(const am_Source_s& sourceData, RegisterSourceAsyncCallback callback) = 0; - - virtual void deregisterSource(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> deregisterSourceAsync(const am_sourceID_t& sourceID, DeregisterSourceAsyncCallback callback) = 0; - - virtual void registerCrossfader(const am_Crossfader_s& crossfaderData, CommonAPI::CallStatus& callStatus, am_crossfaderID_t& crossfaderID, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> registerCrossfaderAsync(const am_Crossfader_s& crossfaderData, RegisterCrossfaderAsyncCallback callback) = 0; - - virtual void deregisterCrossfader(const am_crossfaderID_t& crossfaderID, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> deregisterCrossfaderAsync(const am_crossfaderID_t& crossfaderID, DeregisterCrossfaderAsyncCallback callback) = 0; - - virtual void peekSourceClassID(const std::string& name, CommonAPI::CallStatus& callStatus, am_sourceClass_t& sourceClassID, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> peekSourceClassIDAsync(const std::string& name, PeekSourceClassIDAsyncCallback callback) = 0; - - virtual void peekSinkClassID(const std::string& name, CommonAPI::CallStatus& callStatus, am_sinkClass_t& sinkClassID, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> peekSinkClassIDAsync(const std::string& name, PeekSinkClassIDAsyncCallback callback) = 0; - - virtual void hookInterruptStatusChange(const am_sourceID_t& sourceID, const am_InterruptState_e& interruptState, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> hookInterruptStatusChangeAsync(const am_sourceID_t& sourceID, const am_InterruptState_e& interruptState, HookInterruptStatusChangeAsyncCallback callback) = 0; - - virtual void hookDomainRegistrationComplete(const am_domainID_t& domainID, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> hookDomainRegistrationCompleteAsync(const am_domainID_t& domainID, HookDomainRegistrationCompleteAsyncCallback callback) = 0; - - virtual void hookSinkAvailablityStatusChange(const am_sinkID_t& sinkID, const am_Availability_s& availability, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> hookSinkAvailablityStatusChangeAsync(const am_sinkID_t& sinkID, const am_Availability_s& availability, HookSinkAvailablityStatusChangeAsyncCallback callback) = 0; - - virtual void hookSourceAvailablityStatusChange(const am_sourceID_t& sourceID, const am_Availability_s& availability, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> hookSourceAvailablityStatusChangeAsync(const am_sourceID_t& sourceID, const am_Availability_s& availability, HookSourceAvailablityStatusChangeAsyncCallback callback) = 0; - - virtual void hookDomainStateChange(const am_domainID_t& domainID, const am_DomainState_e& domainState, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> hookDomainStateChangeAsync(const am_domainID_t& domainID, const am_DomainState_e& domainState, HookDomainStateChangeAsyncCallback callback) = 0; - - virtual void hookTimingInformationChanged(const am_connectionID_t& connectionID, const am_timeSync_t& delay, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> hookTimingInformationChangedAsync(const am_connectionID_t& connectionID, const am_timeSync_t& delay, HookTimingInformationChangedAsyncCallback callback) = 0; - - virtual void sendChangedData(const am_EarlyData_L& earlyData, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> sendChangedDataAsync(const am_EarlyData_L& earlyData, SendChangedDataAsyncCallback callback) = 0; - - virtual void updateGateway(const am_gatewayID_t& gatewayID, const am_ConnectionFormat_L& listSourceFormats, const am_ConnectionFormat_L& listSinkFormats, const am_Convertion_L& convertionMatrix, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> updateGatewayAsync(const am_gatewayID_t& gatewayID, const am_ConnectionFormat_L& listSourceFormats, const am_ConnectionFormat_L& listSinkFormats, const am_Convertion_L& convertionMatrix, UpdateGatewayAsyncCallback callback) = 0; - - virtual void updateSink(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> updateSinkAsync(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, UpdateSinkAsyncCallback callback) = 0; - - virtual void updateSource(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> updateSourceAsync(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, UpdateSourceAsyncCallback callback) = 0; - - virtual void ackSetVolumes(const am_Handle_s& handle, const am_Volumes_L& listvolumes, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> ackSetVolumesAsync(const am_Handle_s& handle, const am_Volumes_L& listvolumes, const am_Error_e& error, AckSetVolumesAsyncCallback callback) = 0; - - virtual void ackSinkNotificationConfiguration(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> ackSinkNotificationConfigurationAsync(const am_Handle_s& handle, const am_Error_e& error, AckSinkNotificationConfigurationAsyncCallback callback) = 0; - - virtual void ackSourceNotificationConfiguration(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> ackSourceNotificationConfigurationAsync(const am_Handle_s& handle, const am_Error_e& error, AckSourceNotificationConfigurationAsyncCallback callback) = 0; - - virtual void hookSinkNotificationDataChange(const am_sinkID_t& sinkID, const am_NotificationPayload_s& payload, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> hookSinkNotificationDataChangeAsync(const am_sinkID_t& sinkID, const am_NotificationPayload_s& payload, HookSinkNotificationDataChangeAsyncCallback callback) = 0; - - virtual void hookSourceNotificationDataChange(const am_sourceID_t& sourceID, const am_NotificationPayload_s& payload, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> hookSourceNotificationDataChangeAsync(const am_sourceID_t& sourceID, const am_NotificationPayload_s& payload, HookSourceNotificationDataChangeAsyncCallback callback) = 0; - - virtual void confirmRoutingRundown(const std::string& domainName, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> confirmRoutingRundownAsync(const std::string& domainName, ConfirmRoutingRundownAsyncCallback callback) = 0; - }; - - } // namespace am - } // namespace genivi - } // namespace org - - #endif // ORG_GENIVI_AM_Routing_Control_Observer_PROXY_BASE_H_ +#ifndef ORG_GENIVI_AM_Routing_Control_Observer_PROXY_BASE_H_ +#define ORG_GENIVI_AM_Routing_Control_Observer_PROXY_BASE_H_ + +#include "RoutingControlObserver.h" + + +#include <org/genivi/am.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 <vector> + +#include <CommonAPI/Attribute.h> +#include <CommonAPI/Proxy.h> +#include <functional> +#include <future> + +#undef COMMONAPI_INTERNAL_COMPILATION + +namespace org { +namespace genivi { +namespace am { + +class RoutingControlObserverProxyBase: virtual public CommonAPI::Proxy { + public: + typedef CommonAPI::ObservableReadonlyAttribute<am_RoutingReady_e> RoutingReadyAttribute; + + typedef std::function<void(const CommonAPI::CallStatus&)> AckConnectAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AckDisconnectAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AckSetSinkVolumeChangeAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AckSetSourceVolumeChangeAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AckSetSourceStateAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AckSetSinkSoundPropertiesAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AckSetSinkSoundPropertyAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AckSetSourceSoundPropertiesAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AckSetSourceSoundPropertyAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AckCrossFadingAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AckSourceVolumeTickAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AckSinkVolumeTickAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_domainID_t&, const am_Error_e&)> PeekDomainAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_domainID_t&, const am_Error_e&)> RegisterDomainAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> DeregisterDomainAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_gatewayID_t&, const am_Error_e&)> RegisterGatewayAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> DeregisterGatewayAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_sinkID_t&, const am_Error_e&)> PeekSinkAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_sinkID_t&, const am_Error_e&)> RegisterSinkAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> DeregisterSinkAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_sourceID_t&, const am_Error_e&)> PeekSourceAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_sourceID_t&, const am_Error_e&)> RegisterSourceAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> DeregisterSourceAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_crossfaderID_t&, const am_Error_e&)> RegisterCrossfaderAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> DeregisterCrossfaderAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_sourceClass_t&, const am_Error_e&)> PeekSourceClassIDAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_sinkClass_t&, const am_Error_e&)> PeekSinkClassIDAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> HookInterruptStatusChangeAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> HookDomainRegistrationCompleteAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> HookSinkAvailablityStatusChangeAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> HookSourceAvailablityStatusChangeAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> HookDomainStateChangeAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> HookTimingInformationChangedAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> SendChangedDataAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> UpdateGatewayAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> UpdateSinkAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> UpdateSourceAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AckSetVolumesAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AckSinkNotificationConfigurationAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AckSourceNotificationConfigurationAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> HookSinkNotificationDataChangeAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> HookSourceNotificationDataChangeAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> ConfirmRoutingRundownAsyncCallback; + + /** + * This attribute signals to the clients the current routing state. + A client + * should notify himself to this attribute in order to know the current state and + * act accordingly. + */ + virtual RoutingReadyAttribute& getRoutingReadyAttribute() = 0; + + + /** + * acknowledges a asyncConnect + */ + virtual void ackConnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> ackConnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, AckConnectAsyncCallback callback) = 0; + /** + * acknowledges a asyncDisconnect + */ + virtual void ackDisconnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> ackDisconnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_Error_e& error, AckDisconnectAsyncCallback callback) = 0; + /** + * acknowledges a asyncsetSinkVolume + */ + virtual void ackSetSinkVolumeChange(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> ackSetSinkVolumeChangeAsync(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, AckSetSinkVolumeChangeAsyncCallback callback) = 0; + /** + * acknowledges a asyncsetSourceVolume + */ + virtual void ackSetSourceVolumeChange(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> ackSetSourceVolumeChangeAsync(const am_Handle_s& handle, const am_volume_t& volume, const am_Error_e& error, AckSetSourceVolumeChangeAsyncCallback callback) = 0; + /** + * acknowlegde for asyncSetSourceState + */ + virtual void ackSetSourceState(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> ackSetSourceStateAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSourceStateAsyncCallback callback) = 0; + /** + * acknowledges asyncSetSinkSoundProperties + */ + virtual void ackSetSinkSoundProperties(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> ackSetSinkSoundPropertiesAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSinkSoundPropertiesAsyncCallback callback) = 0; + /** + * acknowledges asyncSetSinkSoundProperty + */ + virtual void ackSetSinkSoundProperty(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> ackSetSinkSoundPropertyAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSinkSoundPropertyAsyncCallback callback) = 0; + /** + * acknowledges asyncSetSourceSoundProperties + */ + virtual void ackSetSourceSoundProperties(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> ackSetSourceSoundPropertiesAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSourceSoundPropertiesAsyncCallback callback) = 0; + /** + * acknowledges asyncSetSourceSoundProperty + */ + virtual void ackSetSourceSoundProperty(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> ackSetSourceSoundPropertyAsync(const am_Handle_s& handle, const am_Error_e& error, AckSetSourceSoundPropertyAsyncCallback callback) = 0; + /** + * acknowledges asyncCrossFade + */ + virtual void ackCrossFading(const am_Handle_s& handle, const am_HotSink_e& hotSink, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> ackCrossFadingAsync(const am_Handle_s& handle, const am_HotSink_e& hotSink, const am_Error_e& error, AckCrossFadingAsyncCallback callback) = 0; + /** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ + virtual void ackSourceVolumeTick(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> ackSourceVolumeTickAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, AckSourceVolumeTickAsyncCallback callback) = 0; + /** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ + virtual void ackSinkVolumeTick(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> ackSinkVolumeTickAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, AckSinkVolumeTickAsyncCallback callback) = 0; + /** + * This function returns the ID to the given domainName. If already a domain is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the domain. The other parameters of the domain + * will be overwritten when the domain is registered. + (at)return E_OK on + * success, E_UNKNOWN on error + */ + virtual void peekDomain(const std::string& name, CommonAPI::CallStatus& callStatus, am_domainID_t& domainID, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> peekDomainAsync(const std::string& name, PeekDomainAsyncCallback callback) = 0; + /** + * registers a domain + (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ + virtual void registerDomain(const am_Domain_s& domainData, const std::string& returnBusname, const std::string& returnInterface, CommonAPI::CallStatus& callStatus, am_domainID_t& domainID, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> registerDomainAsync(const am_Domain_s& domainData, const std::string& returnBusname, const std::string& returnInterface, RegisterDomainAsyncCallback callback) = 0; + /** + * deregisters a domain. All sources, sinks, gateways and crossfaders from that + * domain will be removed as well. + (at)return E_OK on succes, E_NON_EXISTENT if + * not found E_UNKOWN on error + */ + virtual void deregisterDomain(const am_domainID_t& domainID, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> deregisterDomainAsync(const am_domainID_t& domainID, DeregisterDomainAsyncCallback callback) = 0; + /** + * registers a gateway. (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ + virtual void registerGateway(const am_Gateway_s& gatewayData, CommonAPI::CallStatus& callStatus, am_gatewayID_t& gatewayID, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> registerGatewayAsync(const am_Gateway_s& gatewayData, RegisterGatewayAsyncCallback callback) = 0; + /** + * deregisters a gateway. Also removes all sinks and sources of the controlling + * domain. + (at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ + virtual void deregisterGateway(const am_gatewayID_t& gatewayID, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> deregisterGatewayAsync(const am_gatewayID_t& gatewayID, DeregisterGatewayAsyncCallback callback) = 0; + /** + * This function returns the ID to the given sinkName. If already a sink is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the sink. The other parameters of the sink will + * be overwritten when the sink is registered. + (at)return E_OK on success, + * E_UNKNOWN on error + */ + virtual void peekSink(const std::string& name, CommonAPI::CallStatus& callStatus, am_sinkID_t& sinkID, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> peekSinkAsync(const std::string& name, PeekSinkAsyncCallback callback) = 0; + /** + * Registers a sink. If the sink is part of a gateway, the listconnectionFormats + * is copied to the gatewayInformation + (at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ + virtual void registerSink(const am_Sink_s& sinkData, CommonAPI::CallStatus& callStatus, am_sinkID_t& sinkID, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> registerSinkAsync(const am_Sink_s& sinkData, RegisterSinkAsyncCallback callback) = 0; + /** + * deregisters a sink. + (at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ + virtual void deregisterSink(const am_sinkID_t& sinkID, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> deregisterSinkAsync(const am_sinkID_t& sinkID, DeregisterSinkAsyncCallback callback) = 0; + /** + * This function returns the ID to the given sourceName. If already a source is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the source. The other parameters of the source + * will be overwritten when the source is registered. + (at)return E_OK on + * success, E_UNKNOWN on error + */ + virtual void peekSource(const std::string& name, CommonAPI::CallStatus& callStatus, am_sourceID_t& sourceID, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> peekSourceAsync(const std::string& name, PeekSourceAsyncCallback callback) = 0; + /** + * registers a source. If the source is part of a gateway, the + * listconnectionFormats is copied to the gatewayInformation + (at)return E_OK on + * success, E_UNKNOWN on error, E_ALREADY_EXIST if either name or sourceID + * already exists + */ + virtual void registerSource(const am_Source_s& sourceData, CommonAPI::CallStatus& callStatus, am_sourceID_t& sourceID, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> registerSourceAsync(const am_Source_s& sourceData, RegisterSourceAsyncCallback callback) = 0; + /** + * deregisters a source + (at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ + virtual void deregisterSource(const am_sourceID_t& sourceID, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> deregisterSourceAsync(const am_sourceID_t& sourceID, DeregisterSourceAsyncCallback callback) = 0; + /** + * this function registers a crossfader. + (at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ + virtual void registerCrossfader(const am_Crossfader_s& crossfaderData, CommonAPI::CallStatus& callStatus, am_crossfaderID_t& crossfaderID, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> registerCrossfaderAsync(const am_Crossfader_s& crossfaderData, RegisterCrossfaderAsyncCallback callback) = 0; + /** + * this function deregisters a crossfader. removes all sources and sinks assiated + * as well. + (at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ + virtual void deregisterCrossfader(const am_crossfaderID_t& crossfaderID, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> deregisterCrossfaderAsync(const am_crossfaderID_t& crossfaderID, DeregisterCrossfaderAsyncCallback callback) = 0; + /** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. + (at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ + virtual void peekSourceClassID(const std::string& name, CommonAPI::CallStatus& callStatus, am_sourceClass_t& sourceClassID, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> peekSourceClassIDAsync(const std::string& name, PeekSourceClassIDAsyncCallback callback) = 0; + /** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. + (at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ + virtual void peekSinkClassID(const std::string& name, CommonAPI::CallStatus& callStatus, am_sinkClass_t& sinkClassID, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> peekSinkClassIDAsync(const std::string& name, PeekSinkClassIDAsyncCallback callback) = 0; + /** + * is called when a low level interrupt changes it status. + */ + virtual void hookInterruptStatusChange(const am_sourceID_t& sourceID, const am_InterruptState_e& interruptState, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> hookInterruptStatusChangeAsync(const am_sourceID_t& sourceID, const am_InterruptState_e& interruptState, HookInterruptStatusChangeAsyncCallback callback) = 0; + /** + * This hook is called when all elements from a domain are registered. + Is used by + * the Controller to know when all expected domains are finally registered + */ + virtual void hookDomainRegistrationComplete(const am_domainID_t& domainID, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> hookDomainRegistrationCompleteAsync(const am_domainID_t& domainID, HookDomainRegistrationCompleteAsyncCallback callback) = 0; + /** + * is called when a sink changes its availability + */ + virtual void hookSinkAvailablityStatusChange(const am_sinkID_t& sinkID, const am_Availability_s& availability, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> hookSinkAvailablityStatusChangeAsync(const am_sinkID_t& sinkID, const am_Availability_s& availability, HookSinkAvailablityStatusChangeAsyncCallback callback) = 0; + /** + * is called when a source changes its availability + */ + virtual void hookSourceAvailablityStatusChange(const am_sourceID_t& sourceID, const am_Availability_s& availability, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> hookSourceAvailablityStatusChangeAsync(const am_sourceID_t& sourceID, const am_Availability_s& availability, HookSourceAvailablityStatusChangeAsyncCallback callback) = 0; + /** + * is called when a domain changes its status. This used for early domains only + */ + virtual void hookDomainStateChange(const am_domainID_t& domainID, const am_DomainState_e& domainState, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> hookDomainStateChangeAsync(const am_domainID_t& domainID, const am_DomainState_e& domainState, HookDomainStateChangeAsyncCallback callback) = 0; + /** + * is called when the timinginformation (delay) changed for a connection. + */ + virtual void hookTimingInformationChanged(const am_connectionID_t& connectionID, const am_timeSync_t& delay, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> hookTimingInformationChangedAsync(const am_connectionID_t& connectionID, const am_timeSync_t& delay, HookTimingInformationChangedAsyncCallback callback) = 0; + /** + * this function is used to send out all data that has been changed in an early + * state. + (at)return E_OK on success, E_UNKNOWN on error + */ + virtual void sendChangedData(const am_EarlyData_L& earlyData, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> sendChangedDataAsync(const am_EarlyData_L& earlyData, SendChangedDataAsyncCallback callback) = 0; + /** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * gatewayID is not valid. + */ + virtual void updateGateway(const am_gatewayID_t& gatewayID, const am_ConnectionFormat_L& listSourceFormats, const am_ConnectionFormat_L& listSinkFormats, const am_Convertion_L& convertionMatrix, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> updateGatewayAsync(const am_gatewayID_t& gatewayID, const am_ConnectionFormat_L& listSourceFormats, const am_ConnectionFormat_L& listSinkFormats, const am_Convertion_L& convertionMatrix, UpdateGatewayAsyncCallback callback) = 0; + /** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * sinkID is not valid. + */ + virtual void updateSink(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> updateSinkAsync(const am_sinkID_t& sinkID, const am_sinkClass_t& sinkClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, UpdateSinkAsyncCallback callback) = 0; + /** + * updates data of an source. (at)return E_OK on success, E_NON_EXISTENT if the + * sourceID in the struct is not valid. + Please note that only the following + * data out of am_Source_s have effect when they are + * changed: + sourceClassID, + listSoundProperties, + listConnectionFormats, + * + listMainSoundProperties + */ + virtual void updateSource(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> updateSourceAsync(const am_sourceID_t& sourceID, const am_sourceClass_t& sourceClassID, const am_SoundProperty_L& listSoundProperties, const am_ConnectionFormat_L& listConnectionFormats, const am_MainSoundProperty_L& listMainSoundProperties, UpdateSourceAsyncCallback callback) = 0; + /** + * acknowledges a asyncSetSinkVolumes + */ + virtual void ackSetVolumes(const am_Handle_s& handle, const am_Volumes_L& listvolumes, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> ackSetVolumesAsync(const am_Handle_s& handle, const am_Volumes_L& listvolumes, const am_Error_e& error, AckSetVolumesAsyncCallback callback) = 0; + /** + * The acknowledge of the SinkNotificationConfiguration + */ + virtual void ackSinkNotificationConfiguration(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> ackSinkNotificationConfigurationAsync(const am_Handle_s& handle, const am_Error_e& error, AckSinkNotificationConfigurationAsyncCallback callback) = 0; + /** + * The acknowledge of the SourceNotificationConfiguration + */ + virtual void ackSourceNotificationConfiguration(const am_Handle_s& handle, const am_Error_e& error, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> ackSourceNotificationConfigurationAsync(const am_Handle_s& handle, const am_Error_e& error, AckSourceNotificationConfigurationAsyncCallback callback) = 0; + /** + * is called whenever a notified value needs to be send + */ + virtual void hookSinkNotificationDataChange(const am_sinkID_t& sinkID, const am_NotificationPayload_s& payload, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> hookSinkNotificationDataChangeAsync(const am_sinkID_t& sinkID, const am_NotificationPayload_s& payload, HookSinkNotificationDataChangeAsyncCallback callback) = 0; + /** + * is called whenever a notified value needs to be send + */ + virtual void hookSourceNotificationDataChange(const am_sourceID_t& sourceID, const am_NotificationPayload_s& payload, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> hookSourceNotificationDataChangeAsync(const am_sourceID_t& sourceID, const am_NotificationPayload_s& payload, HookSourceNotificationDataChangeAsyncCallback callback) = 0; + virtual void confirmRoutingRundown(const std::string& domainName, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> confirmRoutingRundownAsync(const std::string& domainName, ConfirmRoutingRundownAsyncCallback callback) = 0; +}; + +} // namespace am +} // namespace genivi +} // namespace org + +#endif // ORG_GENIVI_AM_Routing_Control_Observer_PROXY_BASE_H_ diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverStub.h b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverStub.h index 0c27b29..c61cf5d 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverStub.h +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverStub.h @@ -1,28 +1,27 @@ /* -* 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/. */ +/** + * Routing Receive sendInterface description. + * @author Christian Mueller + */ #ifndef ORG_GENIVI_AM_Routing_Control_Observer_STUB_H_ #define ORG_GENIVI_AM_Routing_Control_Observer_STUB_H_ @@ -32,7 +31,9 @@ #include "RoutingControlObserver.h" +#if !defined (COMMONAPI_INTERNAL_COMPILATION) #define COMMONAPI_INTERNAL_COMPILATION +#endif #include <CommonAPI/InputStream.h> #include <CommonAPI/OutputStream.h> @@ -60,6 +61,15 @@ class RoutingControlObserverStubAdapter: virtual public CommonAPI::StubAdapter, ///Notifies all remote listeners about a change of value of the attribute RoutingReady. virtual void fireRoutingReadyAttributeChanged(const am_RoutingReady_e& RoutingReady) = 0; + + + virtual void deactivateManagedInstances() = 0; + +protected: + /** + * Defines properties for storing the ClientIds of clients / proxies that have + * subscribed to the selective broadcasts + */ }; @@ -79,10 +89,6 @@ class RoutingControlObserverStubRemoteEvent { public: virtual ~RoutingControlObserverStubRemoteEvent() { } - /// Verification callback for remote set requests on the attribute RoutingReady. - virtual bool onRemoteSetRoutingReadyAttribute(am_RoutingReady_e RoutingReady) = 0; - /// Action callback for remote set requests on the attribute RoutingReady. - virtual void onRemoteRoutingReadyAttributeChanged() = 0; }; @@ -97,95 +103,290 @@ class RoutingControlObserverStub : public CommonAPI::Stub<RoutingControlObserver public: virtual ~RoutingControlObserverStub() { } - /// Provides getter access to the attribute RoutingReady. - virtual const am_RoutingReady_e& getRoutingReadyAttribute() = 0; + /** + * This attribute signals to the clients the current routing state. + A client + * should notify himself to this attribute in order to know the current state and + * act accordingly. + */ + /// Provides getter access to the attribute RoutingReady + virtual const am_RoutingReady_e& getRoutingReadyAttribute(const std::shared_ptr<CommonAPI::ClientId> clientId) = 0; + /** + * acknowledges a asyncConnect + */ /// This is the method that will be called on remote calls on the method ackConnect. - virtual void ackConnect(am_Handle_s handle, am_connectionID_t connectionID, am_Error_e error) = 0; + virtual void ackConnect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_connectionID_t connectionID, am_Error_e error) = 0; + /** + * acknowledges a asyncDisconnect + */ /// This is the method that will be called on remote calls on the method ackDisconnect. - virtual void ackDisconnect(am_Handle_s handle, am_connectionID_t connectionID, am_Error_e error) = 0; + virtual void ackDisconnect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_connectionID_t connectionID, am_Error_e error) = 0; + /** + * acknowledges a asyncsetSinkVolume + */ /// This is the method that will be called on remote calls on the method ackSetSinkVolumeChange. - virtual void ackSetSinkVolumeChange(am_Handle_s handle, am_volume_t volume, am_Error_e error) = 0; + virtual void ackSetSinkVolumeChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_volume_t volume, am_Error_e error) = 0; + /** + * acknowledges a asyncsetSourceVolume + */ /// This is the method that will be called on remote calls on the method ackSetSourceVolumeChange. - virtual void ackSetSourceVolumeChange(am_Handle_s handle, am_volume_t volume, am_Error_e error) = 0; + virtual void ackSetSourceVolumeChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_volume_t volume, am_Error_e error) = 0; + /** + * acknowlegde for asyncSetSourceState + */ /// This is the method that will be called on remote calls on the method ackSetSourceState. - virtual void ackSetSourceState(am_Handle_s handle, am_Error_e error) = 0; + virtual void ackSetSourceState(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error) = 0; + /** + * acknowledges asyncSetSinkSoundProperties + */ /// This is the method that will be called on remote calls on the method ackSetSinkSoundProperties. - virtual void ackSetSinkSoundProperties(am_Handle_s handle, am_Error_e error) = 0; + virtual void ackSetSinkSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error) = 0; + /** + * acknowledges asyncSetSinkSoundProperty + */ /// This is the method that will be called on remote calls on the method ackSetSinkSoundProperty. - virtual void ackSetSinkSoundProperty(am_Handle_s handle, am_Error_e error) = 0; + virtual void ackSetSinkSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error) = 0; + /** + * acknowledges asyncSetSourceSoundProperties + */ /// This is the method that will be called on remote calls on the method ackSetSourceSoundProperties. - virtual void ackSetSourceSoundProperties(am_Handle_s handle, am_Error_e error) = 0; + virtual void ackSetSourceSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error) = 0; + /** + * acknowledges asyncSetSourceSoundProperty + */ /// This is the method that will be called on remote calls on the method ackSetSourceSoundProperty. - virtual void ackSetSourceSoundProperty(am_Handle_s handle, am_Error_e error) = 0; + virtual void ackSetSourceSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error) = 0; + /** + * acknowledges asyncCrossFade + */ /// This is the method that will be called on remote calls on the method ackCrossFading. - virtual void ackCrossFading(am_Handle_s handle, am_HotSink_e hotSink, am_Error_e error) = 0; + virtual void ackCrossFading(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_HotSink_e hotSink, am_Error_e error) = 0; + /** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ /// This is the method that will be called on remote calls on the method ackSourceVolumeTick. - virtual void ackSourceVolumeTick(am_Handle_s handle, am_sourceID_t sourceID, am_volume_t volume) = 0; + virtual void ackSourceVolumeTick(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_volume_t volume) = 0; + /** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ /// This is the method that will be called on remote calls on the method ackSinkVolumeTick. - virtual void ackSinkVolumeTick(am_Handle_s handle, am_sinkID_t sinkID, am_volume_t volume) = 0; + virtual void ackSinkVolumeTick(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sinkID_t sinkID, am_volume_t volume) = 0; + /** + * This function returns the ID to the given domainName. If already a domain is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the domain. The other parameters of the domain + * will be overwritten when the domain is registered. + (at)return E_OK on + * success, E_UNKNOWN on error + */ /// This is the method that will be called on remote calls on the method peekDomain. - virtual void peekDomain(std::string name, am_domainID_t& domainID, am_Error_e& error) = 0; + virtual void peekDomain(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string name, am_domainID_t& domainID, am_Error_e& error) = 0; + /** + * registers a domain + (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ /// This is the method that will be called on remote calls on the method registerDomain. - virtual void registerDomain(am_Domain_s domainData, std::string returnBusname, std::string returnInterface, am_domainID_t& domainID, am_Error_e& error) = 0; + virtual void registerDomain(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Domain_s domainData, std::string returnBusname, std::string returnInterface, am_domainID_t& domainID, am_Error_e& error) = 0; + /** + * deregisters a domain. All sources, sinks, gateways and crossfaders from that + * domain will be removed as well. + (at)return E_OK on succes, E_NON_EXISTENT if + * not found E_UNKOWN on error + */ /// This is the method that will be called on remote calls on the method deregisterDomain. - virtual void deregisterDomain(am_domainID_t domainID, am_Error_e& error) = 0; + virtual void deregisterDomain(const std::shared_ptr<CommonAPI::ClientId> clientId, am_domainID_t domainID, am_Error_e& error) = 0; + /** + * registers a gateway. (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ /// This is the method that will be called on remote calls on the method registerGateway. - virtual void registerGateway(am_Gateway_s gatewayData, am_gatewayID_t& gatewayID, am_Error_e& error) = 0; + virtual void registerGateway(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Gateway_s gatewayData, am_gatewayID_t& gatewayID, am_Error_e& error) = 0; + /** + * deregisters a gateway. Also removes all sinks and sources of the controlling + * domain. + (at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ /// This is the method that will be called on remote calls on the method deregisterGateway. - virtual void deregisterGateway(am_gatewayID_t gatewayID, am_Error_e& error) = 0; + virtual void deregisterGateway(const std::shared_ptr<CommonAPI::ClientId> clientId, am_gatewayID_t gatewayID, am_Error_e& error) = 0; + /** + * This function returns the ID to the given sinkName. If already a sink is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the sink. The other parameters of the sink will + * be overwritten when the sink is registered. + (at)return E_OK on success, + * E_UNKNOWN on error + */ /// This is the method that will be called on remote calls on the method peekSink. - virtual void peekSink(std::string name, am_sinkID_t& sinkID, am_Error_e& error) = 0; + virtual void peekSink(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string name, am_sinkID_t& sinkID, am_Error_e& error) = 0; + /** + * Registers a sink. If the sink is part of a gateway, the listconnectionFormats + * is copied to the gatewayInformation + (at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ /// This is the method that will be called on remote calls on the method registerSink. - virtual void registerSink(am_Sink_s sinkData, am_sinkID_t& sinkID, am_Error_e& error) = 0; + virtual void registerSink(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Sink_s sinkData, am_sinkID_t& sinkID, am_Error_e& error) = 0; + /** + * deregisters a sink. + (at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ /// This is the method that will be called on remote calls on the method deregisterSink. - virtual void deregisterSink(am_sinkID_t sinkID, am_Error_e& error) = 0; + virtual void deregisterSink(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_Error_e& error) = 0; + /** + * This function returns the ID to the given sourceName. If already a source is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the source. The other parameters of the source + * will be overwritten when the source is registered. + (at)return E_OK on + * success, E_UNKNOWN on error + */ /// This is the method that will be called on remote calls on the method peekSource. - virtual void peekSource(std::string name, am_sourceID_t& sourceID, am_Error_e& error) = 0; + virtual void peekSource(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string name, am_sourceID_t& sourceID, am_Error_e& error) = 0; + /** + * registers a source. If the source is part of a gateway, the + * listconnectionFormats is copied to the gatewayInformation + (at)return E_OK on + * success, E_UNKNOWN on error, E_ALREADY_EXIST if either name or sourceID + * already exists + */ /// This is the method that will be called on remote calls on the method registerSource. - virtual void registerSource(am_Source_s sourceData, am_sourceID_t& sourceID, am_Error_e& error) = 0; + virtual void registerSource(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Source_s sourceData, am_sourceID_t& sourceID, am_Error_e& error) = 0; + /** + * deregisters a source + (at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ /// This is the method that will be called on remote calls on the method deregisterSource. - virtual void deregisterSource(am_sourceID_t sourceID, am_Error_e& error) = 0; + virtual void deregisterSource(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_Error_e& error) = 0; + /** + * this function registers a crossfader. + (at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ /// This is the method that will be called on remote calls on the method registerCrossfader. - virtual void registerCrossfader(am_Crossfader_s crossfaderData, am_crossfaderID_t& crossfaderID, am_Error_e& error) = 0; + virtual void registerCrossfader(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Crossfader_s crossfaderData, am_crossfaderID_t& crossfaderID, am_Error_e& error) = 0; + /** + * this function deregisters a crossfader. removes all sources and sinks assiated + * as well. + (at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ /// This is the method that will be called on remote calls on the method deregisterCrossfader. - virtual void deregisterCrossfader(am_crossfaderID_t crossfaderID, am_Error_e& error) = 0; + virtual void deregisterCrossfader(const std::shared_ptr<CommonAPI::ClientId> clientId, am_crossfaderID_t crossfaderID, am_Error_e& error) = 0; + /** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. + (at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ /// This is the method that will be called on remote calls on the method peekSourceClassID. - virtual void peekSourceClassID(std::string name, am_sourceClass_t& sourceClassID, am_Error_e& error) = 0; + virtual void peekSourceClassID(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string name, am_sourceClass_t& sourceClassID, am_Error_e& error) = 0; + /** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. + (at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ /// This is the method that will be called on remote calls on the method peekSinkClassID. - virtual void peekSinkClassID(std::string name, am_sinkClass_t& sinkClassID, am_Error_e& error) = 0; + virtual void peekSinkClassID(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string name, am_sinkClass_t& sinkClassID, am_Error_e& error) = 0; + /** + * is called when a low level interrupt changes it status. + */ /// This is the method that will be called on remote calls on the method hookInterruptStatusChange. - virtual void hookInterruptStatusChange(am_sourceID_t sourceID, am_InterruptState_e interruptState) = 0; + virtual void hookInterruptStatusChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_InterruptState_e interruptState) = 0; + /** + * This hook is called when all elements from a domain are registered. + Is used by + * the Controller to know when all expected domains are finally registered + */ /// This is the method that will be called on remote calls on the method hookDomainRegistrationComplete. - virtual void hookDomainRegistrationComplete(am_domainID_t domainID) = 0; + virtual void hookDomainRegistrationComplete(const std::shared_ptr<CommonAPI::ClientId> clientId, am_domainID_t domainID) = 0; + /** + * is called when a sink changes its availability + */ /// This is the method that will be called on remote calls on the method hookSinkAvailablityStatusChange. - virtual void hookSinkAvailablityStatusChange(am_sinkID_t sinkID, am_Availability_s availability) = 0; + virtual void hookSinkAvailablityStatusChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_Availability_s availability) = 0; + /** + * is called when a source changes its availability + */ /// This is the method that will be called on remote calls on the method hookSourceAvailablityStatusChange. - virtual void hookSourceAvailablityStatusChange(am_sourceID_t sourceID, am_Availability_s availability) = 0; + virtual void hookSourceAvailablityStatusChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_Availability_s availability) = 0; + /** + * is called when a domain changes its status. This used for early domains only + */ /// This is the method that will be called on remote calls on the method hookDomainStateChange. - virtual void hookDomainStateChange(am_domainID_t domainID, am_DomainState_e domainState) = 0; + virtual void hookDomainStateChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_domainID_t domainID, am_DomainState_e domainState) = 0; + /** + * is called when the timinginformation (delay) changed for a connection. + */ /// This is the method that will be called on remote calls on the method hookTimingInformationChanged. - virtual void hookTimingInformationChanged(am_connectionID_t connectionID, am_timeSync_t delay) = 0; + virtual void hookTimingInformationChanged(const std::shared_ptr<CommonAPI::ClientId> clientId, am_connectionID_t connectionID, am_timeSync_t delay) = 0; + /** + * this function is used to send out all data that has been changed in an early + * state. + (at)return E_OK on success, E_UNKNOWN on error + */ /// This is the method that will be called on remote calls on the method sendChangedData. - virtual void sendChangedData(am_EarlyData_L earlyData) = 0; + virtual void sendChangedData(const std::shared_ptr<CommonAPI::ClientId> clientId, am_EarlyData_L earlyData) = 0; + /** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * gatewayID is not valid. + */ /// This is the method that will be called on remote calls on the method updateGateway. - virtual void updateGateway(am_gatewayID_t gatewayID, am_ConnectionFormat_L listSourceFormats, am_ConnectionFormat_L listSinkFormats, am_Convertion_L convertionMatrix, am_Error_e& error) = 0; + virtual void updateGateway(const std::shared_ptr<CommonAPI::ClientId> clientId, am_gatewayID_t gatewayID, am_ConnectionFormat_L listSourceFormats, am_ConnectionFormat_L listSinkFormats, am_Convertion_L convertionMatrix, am_Error_e& error) = 0; + /** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * sinkID is not valid. + */ /// This is the method that will be called on remote calls on the method updateSink. - virtual void updateSink(am_sinkID_t sinkID, am_sinkClass_t sinkClassID, am_SoundProperty_L listSoundProperties, am_ConnectionFormat_L listConnectionFormats, am_MainSoundProperty_L listMainSoundProperties, am_Error_e& error) = 0; + virtual void updateSink(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_sinkClass_t sinkClassID, am_SoundProperty_L listSoundProperties, am_ConnectionFormat_L listConnectionFormats, am_MainSoundProperty_L listMainSoundProperties, am_Error_e& error) = 0; + /** + * updates data of an source. (at)return E_OK on success, E_NON_EXISTENT if the + * sourceID in the struct is not valid. + Please note that only the following + * data out of am_Source_s have effect when they are + * changed: + sourceClassID, + listSoundProperties, + listConnectionFormats, + * + listMainSoundProperties + */ /// This is the method that will be called on remote calls on the method updateSource. - virtual void updateSource(am_sourceID_t sourceID, am_sourceClass_t sourceClassID, am_SoundProperty_L listSoundProperties, am_ConnectionFormat_L listConnectionFormats, am_MainSoundProperty_L listMainSoundProperties, am_Error_e& error) = 0; + virtual void updateSource(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_sourceClass_t sourceClassID, am_SoundProperty_L listSoundProperties, am_ConnectionFormat_L listConnectionFormats, am_MainSoundProperty_L listMainSoundProperties, am_Error_e& error) = 0; + /** + * acknowledges a asyncSetSinkVolumes + */ /// This is the method that will be called on remote calls on the method ackSetVolumes. - virtual void ackSetVolumes(am_Handle_s handle, am_Volumes_L listvolumes, am_Error_e error) = 0; + virtual void ackSetVolumes(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Volumes_L listvolumes, am_Error_e error) = 0; + /** + * The acknowledge of the SinkNotificationConfiguration + */ /// This is the method that will be called on remote calls on the method ackSinkNotificationConfiguration. - virtual void ackSinkNotificationConfiguration(am_Handle_s handle, am_Error_e error) = 0; + virtual void ackSinkNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error) = 0; + /** + * The acknowledge of the SourceNotificationConfiguration + */ /// This is the method that will be called on remote calls on the method ackSourceNotificationConfiguration. - virtual void ackSourceNotificationConfiguration(am_Handle_s handle, am_Error_e error) = 0; + virtual void ackSourceNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error) = 0; + /** + * is called whenever a notified value needs to be send + */ /// This is the method that will be called on remote calls on the method hookSinkNotificationDataChange. - virtual void hookSinkNotificationDataChange(am_sinkID_t sinkID, am_NotificationPayload_s payload) = 0; + virtual void hookSinkNotificationDataChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_NotificationPayload_s payload) = 0; + /** + * is called whenever a notified value needs to be send + */ /// This is the method that will be called on remote calls on the method hookSourceNotificationDataChange. - virtual void hookSourceNotificationDataChange(am_sourceID_t sourceID, am_NotificationPayload_s payload) = 0; + virtual void hookSourceNotificationDataChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_NotificationPayload_s payload) = 0; /// This is the method that will be called on remote calls on the method confirmRoutingRundown. - virtual void confirmRoutingRundown(std::string domainName) = 0; + virtual void confirmRoutingRundown(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string domainName) = 0; }; diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverStubDefault.cpp b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverStubDefault.cpp index 7c7c503..463b5bf 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverStubDefault.cpp +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverStubDefault.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/RoutingControlObserverStubDefault.h> @@ -42,14 +37,15 @@ const am_RoutingReady_e& RoutingControlObserverStubDefault::getRoutingReadyAttri return routingReadyAttributeValue_; } +const am_RoutingReady_e& RoutingControlObserverStubDefault::getRoutingReadyAttribute(const std::shared_ptr<CommonAPI::ClientId> clientId) { + return getRoutingReadyAttribute(); +} + void RoutingControlObserverStubDefault::setRoutingReadyAttribute(am_RoutingReady_e value) { const bool valueChanged = trySetRoutingReadyAttribute(std::move(value)); - if (valueChanged) + if (valueChanged) { stubAdapter_->fireRoutingReadyAttributeChanged(routingReadyAttributeValue_); -} - -void RoutingControlObserverStubDefault::onRemoteRoutingReadyAttributeChanged() { - // No operation in default + } } bool RoutingControlObserverStubDefault::trySetRoutingReadyAttribute(am_RoutingReady_e value) { @@ -65,189 +61,544 @@ bool RoutingControlObserverStubDefault::validateRoutingReadyAttributeRequestedVa return true; } -bool RoutingControlObserverStubDefault::RemoteEventHandler::onRemoteSetRoutingReadyAttribute(am_RoutingReady_e value) { - return defaultStub_->trySetRoutingReadyAttribute(std::move(value)); -} - -void RoutingControlObserverStubDefault::RemoteEventHandler::onRemoteRoutingReadyAttributeChanged() { - defaultStub_->onRemoteRoutingReadyAttributeChanged(); -} +/** + * acknowledges a asyncConnect + */ +void RoutingControlObserverStubDefault::ackConnect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_connectionID_t connectionID, am_Error_e error) { + // Call old style methods in default + ackConnect(handle, connectionID, error); +} void RoutingControlObserverStubDefault::ackConnect(am_Handle_s handle, am_connectionID_t connectionID, am_Error_e error) { // No operation in default } +/** + * acknowledges a asyncDisconnect + */ +void RoutingControlObserverStubDefault::ackDisconnect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_connectionID_t connectionID, am_Error_e error) { + // Call old style methods in default + ackDisconnect(handle, connectionID, error); +} void RoutingControlObserverStubDefault::ackDisconnect(am_Handle_s handle, am_connectionID_t connectionID, am_Error_e error) { // No operation in default } +/** + * acknowledges a asyncsetSinkVolume + */ +void RoutingControlObserverStubDefault::ackSetSinkVolumeChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_volume_t volume, am_Error_e error) { + // Call old style methods in default + ackSetSinkVolumeChange(handle, volume, error); +} void RoutingControlObserverStubDefault::ackSetSinkVolumeChange(am_Handle_s handle, am_volume_t volume, am_Error_e error) { // No operation in default } +/** + * acknowledges a asyncsetSourceVolume + */ +void RoutingControlObserverStubDefault::ackSetSourceVolumeChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_volume_t volume, am_Error_e error) { + // Call old style methods in default + ackSetSourceVolumeChange(handle, volume, error); +} void RoutingControlObserverStubDefault::ackSetSourceVolumeChange(am_Handle_s handle, am_volume_t volume, am_Error_e error) { // No operation in default } +/** + * acknowlegde for asyncSetSourceState + */ +void RoutingControlObserverStubDefault::ackSetSourceState(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error) { + // Call old style methods in default + ackSetSourceState(handle, error); +} void RoutingControlObserverStubDefault::ackSetSourceState(am_Handle_s handle, am_Error_e error) { // No operation in default } +/** + * acknowledges asyncSetSinkSoundProperties + */ +void RoutingControlObserverStubDefault::ackSetSinkSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error) { + // Call old style methods in default + ackSetSinkSoundProperties(handle, error); +} void RoutingControlObserverStubDefault::ackSetSinkSoundProperties(am_Handle_s handle, am_Error_e error) { // No operation in default } +/** + * acknowledges asyncSetSinkSoundProperty + */ +void RoutingControlObserverStubDefault::ackSetSinkSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error) { + // Call old style methods in default + ackSetSinkSoundProperty(handle, error); +} void RoutingControlObserverStubDefault::ackSetSinkSoundProperty(am_Handle_s handle, am_Error_e error) { // No operation in default } +/** + * acknowledges asyncSetSourceSoundProperties + */ +void RoutingControlObserverStubDefault::ackSetSourceSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error) { + // Call old style methods in default + ackSetSourceSoundProperties(handle, error); +} void RoutingControlObserverStubDefault::ackSetSourceSoundProperties(am_Handle_s handle, am_Error_e error) { // No operation in default } +/** + * acknowledges asyncSetSourceSoundProperty + */ +void RoutingControlObserverStubDefault::ackSetSourceSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error) { + // Call old style methods in default + ackSetSourceSoundProperty(handle, error); +} void RoutingControlObserverStubDefault::ackSetSourceSoundProperty(am_Handle_s handle, am_Error_e error) { // No operation in default } +/** + * acknowledges asyncCrossFade + */ +void RoutingControlObserverStubDefault::ackCrossFading(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_HotSink_e hotSink, am_Error_e error) { + // Call old style methods in default + ackCrossFading(handle, hotSink, error); +} void RoutingControlObserverStubDefault::ackCrossFading(am_Handle_s handle, am_HotSink_e hotSink, am_Error_e error) { // No operation in default } +/** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ +void RoutingControlObserverStubDefault::ackSourceVolumeTick(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_volume_t volume) { + // Call old style methods in default + ackSourceVolumeTick(handle, sourceID, volume); +} void RoutingControlObserverStubDefault::ackSourceVolumeTick(am_Handle_s handle, am_sourceID_t sourceID, am_volume_t volume) { // No operation in default } +/** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ +void RoutingControlObserverStubDefault::ackSinkVolumeTick(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sinkID_t sinkID, am_volume_t volume) { + // Call old style methods in default + ackSinkVolumeTick(handle, sinkID, volume); +} void RoutingControlObserverStubDefault::ackSinkVolumeTick(am_Handle_s handle, am_sinkID_t sinkID, am_volume_t volume) { // No operation in default } +/** + * This function returns the ID to the given domainName. If already a domain is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the domain. The other parameters of the domain + * will be overwritten when the domain is registered. +(at)return E_OK on + * success, E_UNKNOWN on error + */ +void RoutingControlObserverStubDefault::peekDomain(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string name, am_domainID_t& domainID, am_Error_e& error) { + // Call old style methods in default + peekDomain(name, domainID, error); +} void RoutingControlObserverStubDefault::peekDomain(std::string name, am_domainID_t& domainID, am_Error_e& error) { // No operation in default } +/** + * registers a domain +(at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ +void RoutingControlObserverStubDefault::registerDomain(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Domain_s domainData, std::string returnBusname, std::string returnInterface, am_domainID_t& domainID, am_Error_e& error) { + // Call old style methods in default + registerDomain(domainData, returnBusname, returnInterface, domainID, error); +} void RoutingControlObserverStubDefault::registerDomain(am_Domain_s domainData, std::string returnBusname, std::string returnInterface, am_domainID_t& domainID, am_Error_e& error) { // No operation in default } +/** + * deregisters a domain. All sources, sinks, gateways and crossfaders from that + * domain will be removed as well. +(at)return E_OK on succes, E_NON_EXISTENT if + * not found E_UNKOWN on error + */ +void RoutingControlObserverStubDefault::deregisterDomain(const std::shared_ptr<CommonAPI::ClientId> clientId, am_domainID_t domainID, am_Error_e& error) { + // Call old style methods in default + deregisterDomain(domainID, error); +} void RoutingControlObserverStubDefault::deregisterDomain(am_domainID_t domainID, am_Error_e& error) { // No operation in default } +/** + * registers a gateway. (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ +void RoutingControlObserverStubDefault::registerGateway(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Gateway_s gatewayData, am_gatewayID_t& gatewayID, am_Error_e& error) { + // Call old style methods in default + registerGateway(gatewayData, gatewayID, error); +} void RoutingControlObserverStubDefault::registerGateway(am_Gateway_s gatewayData, am_gatewayID_t& gatewayID, am_Error_e& error) { // No operation in default } +/** + * deregisters a gateway. Also removes all sinks and sources of the controlling + * domain. +(at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ +void RoutingControlObserverStubDefault::deregisterGateway(const std::shared_ptr<CommonAPI::ClientId> clientId, am_gatewayID_t gatewayID, am_Error_e& error) { + // Call old style methods in default + deregisterGateway(gatewayID, error); +} void RoutingControlObserverStubDefault::deregisterGateway(am_gatewayID_t gatewayID, am_Error_e& error) { // No operation in default } +/** + * This function returns the ID to the given sinkName. If already a sink is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the sink. The other parameters of the sink will + * be overwritten when the sink is registered. +(at)return E_OK on success, + * E_UNKNOWN on error + */ +void RoutingControlObserverStubDefault::peekSink(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string name, am_sinkID_t& sinkID, am_Error_e& error) { + // Call old style methods in default + peekSink(name, sinkID, error); +} void RoutingControlObserverStubDefault::peekSink(std::string name, am_sinkID_t& sinkID, am_Error_e& error) { // No operation in default } +/** + * Registers a sink. If the sink is part of a gateway, the listconnectionFormats + * is copied to the gatewayInformation +(at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ +void RoutingControlObserverStubDefault::registerSink(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Sink_s sinkData, am_sinkID_t& sinkID, am_Error_e& error) { + // Call old style methods in default + registerSink(sinkData, sinkID, error); +} void RoutingControlObserverStubDefault::registerSink(am_Sink_s sinkData, am_sinkID_t& sinkID, am_Error_e& error) { // No operation in default } +/** + * deregisters a sink. +(at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ +void RoutingControlObserverStubDefault::deregisterSink(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_Error_e& error) { + // Call old style methods in default + deregisterSink(sinkID, error); +} void RoutingControlObserverStubDefault::deregisterSink(am_sinkID_t sinkID, am_Error_e& error) { // No operation in default } +/** + * This function returns the ID to the given sourceName. If already a source is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the source. The other parameters of the source + * will be overwritten when the source is registered. +(at)return E_OK on + * success, E_UNKNOWN on error + */ +void RoutingControlObserverStubDefault::peekSource(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string name, am_sourceID_t& sourceID, am_Error_e& error) { + // Call old style methods in default + peekSource(name, sourceID, error); +} void RoutingControlObserverStubDefault::peekSource(std::string name, am_sourceID_t& sourceID, am_Error_e& error) { // No operation in default } +/** + * registers a source. If the source is part of a gateway, the + * listconnectionFormats is copied to the gatewayInformation +(at)return E_OK on + * success, E_UNKNOWN on error, E_ALREADY_EXIST if either name or sourceID + * already exists + */ +void RoutingControlObserverStubDefault::registerSource(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Source_s sourceData, am_sourceID_t& sourceID, am_Error_e& error) { + // Call old style methods in default + registerSource(sourceData, sourceID, error); +} void RoutingControlObserverStubDefault::registerSource(am_Source_s sourceData, am_sourceID_t& sourceID, am_Error_e& error) { // No operation in default } +/** + * deregisters a source +(at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ +void RoutingControlObserverStubDefault::deregisterSource(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_Error_e& error) { + // Call old style methods in default + deregisterSource(sourceID, error); +} void RoutingControlObserverStubDefault::deregisterSource(am_sourceID_t sourceID, am_Error_e& error) { // No operation in default } +/** + * this function registers a crossfader. +(at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ +void RoutingControlObserverStubDefault::registerCrossfader(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Crossfader_s crossfaderData, am_crossfaderID_t& crossfaderID, am_Error_e& error) { + // Call old style methods in default + registerCrossfader(crossfaderData, crossfaderID, error); +} void RoutingControlObserverStubDefault::registerCrossfader(am_Crossfader_s crossfaderData, am_crossfaderID_t& crossfaderID, am_Error_e& error) { // No operation in default } +/** + * this function deregisters a crossfader. removes all sources and sinks assiated + * as well. +(at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ +void RoutingControlObserverStubDefault::deregisterCrossfader(const std::shared_ptr<CommonAPI::ClientId> clientId, am_crossfaderID_t crossfaderID, am_Error_e& error) { + // Call old style methods in default + deregisterCrossfader(crossfaderID, error); +} void RoutingControlObserverStubDefault::deregisterCrossfader(am_crossfaderID_t crossfaderID, am_Error_e& error) { // No operation in default } +/** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. +(at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ +void RoutingControlObserverStubDefault::peekSourceClassID(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string name, am_sourceClass_t& sourceClassID, am_Error_e& error) { + // Call old style methods in default + peekSourceClassID(name, sourceClassID, error); +} void RoutingControlObserverStubDefault::peekSourceClassID(std::string name, am_sourceClass_t& sourceClassID, am_Error_e& error) { // No operation in default } +/** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. +(at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ +void RoutingControlObserverStubDefault::peekSinkClassID(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string name, am_sinkClass_t& sinkClassID, am_Error_e& error) { + // Call old style methods in default + peekSinkClassID(name, sinkClassID, error); +} void RoutingControlObserverStubDefault::peekSinkClassID(std::string name, am_sinkClass_t& sinkClassID, am_Error_e& error) { // No operation in default } +/** + * is called when a low level interrupt changes it status. + */ +void RoutingControlObserverStubDefault::hookInterruptStatusChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_InterruptState_e interruptState) { + // Call old style methods in default + hookInterruptStatusChange(sourceID, interruptState); +} void RoutingControlObserverStubDefault::hookInterruptStatusChange(am_sourceID_t sourceID, am_InterruptState_e interruptState) { // No operation in default } +/** + * This hook is called when all elements from a domain are registered. +Is used by + * the Controller to know when all expected domains are finally registered + */ +void RoutingControlObserverStubDefault::hookDomainRegistrationComplete(const std::shared_ptr<CommonAPI::ClientId> clientId, am_domainID_t domainID) { + // Call old style methods in default + hookDomainRegistrationComplete(domainID); +} void RoutingControlObserverStubDefault::hookDomainRegistrationComplete(am_domainID_t domainID) { // No operation in default } +/** + * is called when a sink changes its availability + */ +void RoutingControlObserverStubDefault::hookSinkAvailablityStatusChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_Availability_s availability) { + // Call old style methods in default + hookSinkAvailablityStatusChange(sinkID, availability); +} void RoutingControlObserverStubDefault::hookSinkAvailablityStatusChange(am_sinkID_t sinkID, am_Availability_s availability) { // No operation in default } +/** + * is called when a source changes its availability + */ +void RoutingControlObserverStubDefault::hookSourceAvailablityStatusChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_Availability_s availability) { + // Call old style methods in default + hookSourceAvailablityStatusChange(sourceID, availability); +} void RoutingControlObserverStubDefault::hookSourceAvailablityStatusChange(am_sourceID_t sourceID, am_Availability_s availability) { // No operation in default } +/** + * is called when a domain changes its status. This used for early domains only + */ +void RoutingControlObserverStubDefault::hookDomainStateChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_domainID_t domainID, am_DomainState_e domainState) { + // Call old style methods in default + hookDomainStateChange(domainID, domainState); +} void RoutingControlObserverStubDefault::hookDomainStateChange(am_domainID_t domainID, am_DomainState_e domainState) { // No operation in default } +/** + * is called when the timinginformation (delay) changed for a connection. + */ +void RoutingControlObserverStubDefault::hookTimingInformationChanged(const std::shared_ptr<CommonAPI::ClientId> clientId, am_connectionID_t connectionID, am_timeSync_t delay) { + // Call old style methods in default + hookTimingInformationChanged(connectionID, delay); +} void RoutingControlObserverStubDefault::hookTimingInformationChanged(am_connectionID_t connectionID, am_timeSync_t delay) { // No operation in default } +/** + * this function is used to send out all data that has been changed in an early + * state. +(at)return E_OK on success, E_UNKNOWN on error + */ +void RoutingControlObserverStubDefault::sendChangedData(const std::shared_ptr<CommonAPI::ClientId> clientId, am_EarlyData_L earlyData) { + // Call old style methods in default + sendChangedData(earlyData); +} void RoutingControlObserverStubDefault::sendChangedData(am_EarlyData_L earlyData) { // No operation in default } +/** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * gatewayID is not valid. + */ +void RoutingControlObserverStubDefault::updateGateway(const std::shared_ptr<CommonAPI::ClientId> clientId, am_gatewayID_t gatewayID, am_ConnectionFormat_L listSourceFormats, am_ConnectionFormat_L listSinkFormats, am_Convertion_L convertionMatrix, am_Error_e& error) { + // Call old style methods in default + updateGateway(gatewayID, listSourceFormats, listSinkFormats, convertionMatrix, error); +} void RoutingControlObserverStubDefault::updateGateway(am_gatewayID_t gatewayID, am_ConnectionFormat_L listSourceFormats, am_ConnectionFormat_L listSinkFormats, am_Convertion_L convertionMatrix, am_Error_e& error) { // No operation in default } +/** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * sinkID is not valid. + */ +void RoutingControlObserverStubDefault::updateSink(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_sinkClass_t sinkClassID, am_SoundProperty_L listSoundProperties, am_ConnectionFormat_L listConnectionFormats, am_MainSoundProperty_L listMainSoundProperties, am_Error_e& error) { + // Call old style methods in default + updateSink(sinkID, sinkClassID, listSoundProperties, listConnectionFormats, listMainSoundProperties, error); +} void RoutingControlObserverStubDefault::updateSink(am_sinkID_t sinkID, am_sinkClass_t sinkClassID, am_SoundProperty_L listSoundProperties, am_ConnectionFormat_L listConnectionFormats, am_MainSoundProperty_L listMainSoundProperties, am_Error_e& error) { // No operation in default } +/** + * updates data of an source. (at)return E_OK on success, E_NON_EXISTENT if the + * sourceID in the struct is not valid. +Please note that only the following + * data out of am_Source_s have effect when they are + * changed: +sourceClassID, +listSoundProperties, +listConnectionFormats, + * +listMainSoundProperties + */ +void RoutingControlObserverStubDefault::updateSource(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_sourceClass_t sourceClassID, am_SoundProperty_L listSoundProperties, am_ConnectionFormat_L listConnectionFormats, am_MainSoundProperty_L listMainSoundProperties, am_Error_e& error) { + // Call old style methods in default + updateSource(sourceID, sourceClassID, listSoundProperties, listConnectionFormats, listMainSoundProperties, error); +} void RoutingControlObserverStubDefault::updateSource(am_sourceID_t sourceID, am_sourceClass_t sourceClassID, am_SoundProperty_L listSoundProperties, am_ConnectionFormat_L listConnectionFormats, am_MainSoundProperty_L listMainSoundProperties, am_Error_e& error) { // No operation in default } +/** + * acknowledges a asyncSetSinkVolumes + */ +void RoutingControlObserverStubDefault::ackSetVolumes(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Volumes_L listvolumes, am_Error_e error) { + // Call old style methods in default + ackSetVolumes(handle, listvolumes, error); +} void RoutingControlObserverStubDefault::ackSetVolumes(am_Handle_s handle, am_Volumes_L listvolumes, am_Error_e error) { // No operation in default } +/** + * The acknowledge of the SinkNotificationConfiguration + */ +void RoutingControlObserverStubDefault::ackSinkNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error) { + // Call old style methods in default + ackSinkNotificationConfiguration(handle, error); +} void RoutingControlObserverStubDefault::ackSinkNotificationConfiguration(am_Handle_s handle, am_Error_e error) { // No operation in default } +/** + * The acknowledge of the SourceNotificationConfiguration + */ +void RoutingControlObserverStubDefault::ackSourceNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error) { + // Call old style methods in default + ackSourceNotificationConfiguration(handle, error); +} void RoutingControlObserverStubDefault::ackSourceNotificationConfiguration(am_Handle_s handle, am_Error_e error) { // No operation in default } +/** + * is called whenever a notified value needs to be send + */ +void RoutingControlObserverStubDefault::hookSinkNotificationDataChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_NotificationPayload_s payload) { + // Call old style methods in default + hookSinkNotificationDataChange(sinkID, payload); +} void RoutingControlObserverStubDefault::hookSinkNotificationDataChange(am_sinkID_t sinkID, am_NotificationPayload_s payload) { // No operation in default } +/** + * is called whenever a notified value needs to be send + */ +void RoutingControlObserverStubDefault::hookSourceNotificationDataChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_NotificationPayload_s payload) { + // Call old style methods in default + hookSourceNotificationDataChange(sourceID, payload); +} void RoutingControlObserverStubDefault::hookSourceNotificationDataChange(am_sourceID_t sourceID, am_NotificationPayload_s payload) { // No operation in default } +void RoutingControlObserverStubDefault::confirmRoutingRundown(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string domainName) { + // Call old style methods in default + confirmRoutingRundown(domainName); +} void RoutingControlObserverStubDefault::confirmRoutingRundown(std::string domainName) { // No operation in default } + RoutingControlObserverStubDefault::RemoteEventHandler::RemoteEventHandler(RoutingControlObserverStubDefault* defaultStub): defaultStub_(defaultStub) { } diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverStubDefault.h b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverStubDefault.h index db1c939..bbabddb 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverStubDefault.h +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverStubDefault.h @@ -1,32 +1,32 @@ /* -* 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/. */ +/** + * Routing Receive sendInterface description. + * @author Christian Mueller + */ #ifndef ORG_GENIVI_AM_Routing_Control_Observer_STUB_DEFAULT_H_ #define ORG_GENIVI_AM_Routing_Control_Observer_STUB_DEFAULT_H_ #include <org/genivi/am/RoutingControlObserverStub.h> +#include <sstream> namespace org { namespace genivi { @@ -37,7 +37,7 @@ namespace am { * RoutingControlObserverStub. 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,110 +49,351 @@ class RoutingControlObserverStubDefault : public RoutingControlObserverStub { RoutingControlObserverStubRemoteEvent* initStubAdapter(const std::shared_ptr<RoutingControlObserverStubAdapter>& stubAdapter); virtual const am_RoutingReady_e& getRoutingReadyAttribute(); + virtual const am_RoutingReady_e& getRoutingReadyAttribute(const std::shared_ptr<CommonAPI::ClientId> clientId); virtual void setRoutingReadyAttribute(am_RoutingReady_e value); - + /** + * acknowledges a asyncConnect + */ + virtual void ackConnect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_connectionID_t connectionID, am_Error_e error); virtual void ackConnect(am_Handle_s handle, am_connectionID_t connectionID, am_Error_e error); + /** + * acknowledges a asyncDisconnect + */ + virtual void ackDisconnect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_connectionID_t connectionID, am_Error_e error); virtual void ackDisconnect(am_Handle_s handle, am_connectionID_t connectionID, am_Error_e error); + /** + * acknowledges a asyncsetSinkVolume + */ + virtual void ackSetSinkVolumeChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_volume_t volume, am_Error_e error); virtual void ackSetSinkVolumeChange(am_Handle_s handle, am_volume_t volume, am_Error_e error); + /** + * acknowledges a asyncsetSourceVolume + */ + virtual void ackSetSourceVolumeChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_volume_t volume, am_Error_e error); virtual void ackSetSourceVolumeChange(am_Handle_s handle, am_volume_t volume, am_Error_e error); + /** + * acknowlegde for asyncSetSourceState + */ + virtual void ackSetSourceState(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error); virtual void ackSetSourceState(am_Handle_s handle, am_Error_e error); + /** + * acknowledges asyncSetSinkSoundProperties + */ + virtual void ackSetSinkSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error); virtual void ackSetSinkSoundProperties(am_Handle_s handle, am_Error_e error); + /** + * acknowledges asyncSetSinkSoundProperty + */ + virtual void ackSetSinkSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error); virtual void ackSetSinkSoundProperty(am_Handle_s handle, am_Error_e error); + /** + * acknowledges asyncSetSourceSoundProperties + */ + virtual void ackSetSourceSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error); virtual void ackSetSourceSoundProperties(am_Handle_s handle, am_Error_e error); + /** + * acknowledges asyncSetSourceSoundProperty + */ + virtual void ackSetSourceSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error); virtual void ackSetSourceSoundProperty(am_Handle_s handle, am_Error_e error); + /** + * acknowledges asyncCrossFade + */ + virtual void ackCrossFading(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_HotSink_e hotSink, am_Error_e error); virtual void ackCrossFading(am_Handle_s handle, am_HotSink_e hotSink, am_Error_e error); + /** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ + virtual void ackSourceVolumeTick(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_volume_t volume); virtual void ackSourceVolumeTick(am_Handle_s handle, am_sourceID_t sourceID, am_volume_t volume); + /** + * acknowledges a volume tick. This can be used to display volumechanges during + * ramps + */ + virtual void ackSinkVolumeTick(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sinkID_t sinkID, am_volume_t volume); virtual void ackSinkVolumeTick(am_Handle_s handle, am_sinkID_t sinkID, am_volume_t volume); + /** + * This function returns the ID to the given domainName. If already a domain is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the domain. The other parameters of the domain + * will be overwritten when the domain is registered. + (at)return E_OK on + * success, E_UNKNOWN on error + */ + virtual void peekDomain(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string name, am_domainID_t& domainID, am_Error_e& error); virtual void peekDomain(std::string name, am_domainID_t& domainID, am_Error_e& error); + /** + * registers a domain + (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ + virtual void registerDomain(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Domain_s domainData, std::string returnBusname, std::string returnInterface, am_domainID_t& domainID, am_Error_e& error); virtual void registerDomain(am_Domain_s domainData, std::string returnBusname, std::string returnInterface, am_domainID_t& domainID, am_Error_e& error); + /** + * deregisters a domain. All sources, sinks, gateways and crossfaders from that + * domain will be removed as well. + (at)return E_OK on succes, E_NON_EXISTENT if + * not found E_UNKOWN on error + */ + virtual void deregisterDomain(const std::shared_ptr<CommonAPI::ClientId> clientId, am_domainID_t domainID, am_Error_e& error); virtual void deregisterDomain(am_domainID_t domainID, am_Error_e& error); + /** + * registers a gateway. (at)return E_OK on succes, E_ALREADY_EXISTENT if already + * registered E_UNKOWN on error + */ + virtual void registerGateway(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Gateway_s gatewayData, am_gatewayID_t& gatewayID, am_Error_e& error); virtual void registerGateway(am_Gateway_s gatewayData, am_gatewayID_t& gatewayID, am_Error_e& error); + /** + * deregisters a gateway. Also removes all sinks and sources of the controlling + * domain. + (at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ + virtual void deregisterGateway(const std::shared_ptr<CommonAPI::ClientId> clientId, am_gatewayID_t gatewayID, am_Error_e& error); virtual void deregisterGateway(am_gatewayID_t gatewayID, am_Error_e& error); + /** + * This function returns the ID to the given sinkName. If already a sink is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the sink. The other parameters of the sink will + * be overwritten when the sink is registered. + (at)return E_OK on success, + * E_UNKNOWN on error + */ + virtual void peekSink(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string name, am_sinkID_t& sinkID, am_Error_e& error); virtual void peekSink(std::string name, am_sinkID_t& sinkID, am_Error_e& error); + /** + * Registers a sink. If the sink is part of a gateway, the listconnectionFormats + * is copied to the gatewayInformation + (at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ + virtual void registerSink(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Sink_s sinkData, am_sinkID_t& sinkID, am_Error_e& error); virtual void registerSink(am_Sink_s sinkData, am_sinkID_t& sinkID, am_Error_e& error); + /** + * deregisters a sink. + (at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ + virtual void deregisterSink(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_Error_e& error); virtual void deregisterSink(am_sinkID_t sinkID, am_Error_e& error); + /** + * This function returns the ID to the given sourceName. If already a source is + * registered with this name, it will return the corresponding ID, if not it will + * reserve an ID but not register the source. The other parameters of the source + * will be overwritten when the source is registered. + (at)return E_OK on + * success, E_UNKNOWN on error + */ + virtual void peekSource(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string name, am_sourceID_t& sourceID, am_Error_e& error); virtual void peekSource(std::string name, am_sourceID_t& sourceID, am_Error_e& error); + /** + * registers a source. If the source is part of a gateway, the + * listconnectionFormats is copied to the gatewayInformation + (at)return E_OK on + * success, E_UNKNOWN on error, E_ALREADY_EXIST if either name or sourceID + * already exists + */ + virtual void registerSource(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Source_s sourceData, am_sourceID_t& sourceID, am_Error_e& error); virtual void registerSource(am_Source_s sourceData, am_sourceID_t& sourceID, am_Error_e& error); + /** + * deregisters a source + (at)return E_OK on succes, E_NON_EXISTENT if not found + * E_UNKOWN on error + */ + virtual void deregisterSource(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_Error_e& error); virtual void deregisterSource(am_sourceID_t sourceID, am_Error_e& error); + /** + * this function registers a crossfader. + (at)return E_OK on succes, + * E_ALREADY_EXISTENT if already registered E_UNKOWN on error + */ + virtual void registerCrossfader(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Crossfader_s crossfaderData, am_crossfaderID_t& crossfaderID, am_Error_e& error); virtual void registerCrossfader(am_Crossfader_s crossfaderData, am_crossfaderID_t& crossfaderID, am_Error_e& error); + /** + * this function deregisters a crossfader. removes all sources and sinks assiated + * as well. + (at)return E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on + * error + */ + virtual void deregisterCrossfader(const std::shared_ptr<CommonAPI::ClientId> clientId, am_crossfaderID_t crossfaderID, am_Error_e& error); virtual void deregisterCrossfader(am_crossfaderID_t crossfaderID, am_Error_e& error); + /** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. + (at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ + virtual void peekSourceClassID(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string name, am_sourceClass_t& sourceClassID, am_Error_e& error); virtual void peekSourceClassID(std::string name, am_sourceClass_t& sourceClassID, am_Error_e& error); + /** + * this function peeks a sourceclassID. It is used by the RoutingPlugins to + * determine the SinkClassIDs of a sinkClass. + (at)return E_OK on succes, + * E_DATABASE_ERROR on error + */ + virtual void peekSinkClassID(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string name, am_sinkClass_t& sinkClassID, am_Error_e& error); virtual void peekSinkClassID(std::string name, am_sinkClass_t& sinkClassID, am_Error_e& error); + /** + * is called when a low level interrupt changes it status. + */ + virtual void hookInterruptStatusChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_InterruptState_e interruptState); virtual void hookInterruptStatusChange(am_sourceID_t sourceID, am_InterruptState_e interruptState); + /** + * This hook is called when all elements from a domain are registered. + Is used by + * the Controller to know when all expected domains are finally registered + */ + virtual void hookDomainRegistrationComplete(const std::shared_ptr<CommonAPI::ClientId> clientId, am_domainID_t domainID); virtual void hookDomainRegistrationComplete(am_domainID_t domainID); + /** + * is called when a sink changes its availability + */ + virtual void hookSinkAvailablityStatusChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_Availability_s availability); virtual void hookSinkAvailablityStatusChange(am_sinkID_t sinkID, am_Availability_s availability); + /** + * is called when a source changes its availability + */ + virtual void hookSourceAvailablityStatusChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_Availability_s availability); virtual void hookSourceAvailablityStatusChange(am_sourceID_t sourceID, am_Availability_s availability); + /** + * is called when a domain changes its status. This used for early domains only + */ + virtual void hookDomainStateChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_domainID_t domainID, am_DomainState_e domainState); virtual void hookDomainStateChange(am_domainID_t domainID, am_DomainState_e domainState); + /** + * is called when the timinginformation (delay) changed for a connection. + */ + virtual void hookTimingInformationChanged(const std::shared_ptr<CommonAPI::ClientId> clientId, am_connectionID_t connectionID, am_timeSync_t delay); virtual void hookTimingInformationChanged(am_connectionID_t connectionID, am_timeSync_t delay); + /** + * this function is used to send out all data that has been changed in an early + * state. + (at)return E_OK on success, E_UNKNOWN on error + */ + virtual void sendChangedData(const std::shared_ptr<CommonAPI::ClientId> clientId, am_EarlyData_L earlyData); virtual void sendChangedData(am_EarlyData_L earlyData); + /** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * gatewayID is not valid. + */ + virtual void updateGateway(const std::shared_ptr<CommonAPI::ClientId> clientId, am_gatewayID_t gatewayID, am_ConnectionFormat_L listSourceFormats, am_ConnectionFormat_L listSinkFormats, am_Convertion_L convertionMatrix, am_Error_e& error); virtual void updateGateway(am_gatewayID_t gatewayID, am_ConnectionFormat_L listSourceFormats, am_ConnectionFormat_L listSinkFormats, am_Convertion_L convertionMatrix, am_Error_e& error); + /** + * updates data of an gateway. (at)return E_OK on success, E_NON_EXISTENT if the + * sinkID is not valid. + */ + virtual void updateSink(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_sinkClass_t sinkClassID, am_SoundProperty_L listSoundProperties, am_ConnectionFormat_L listConnectionFormats, am_MainSoundProperty_L listMainSoundProperties, am_Error_e& error); virtual void updateSink(am_sinkID_t sinkID, am_sinkClass_t sinkClassID, am_SoundProperty_L listSoundProperties, am_ConnectionFormat_L listConnectionFormats, am_MainSoundProperty_L listMainSoundProperties, am_Error_e& error); + /** + * updates data of an source. (at)return E_OK on success, E_NON_EXISTENT if the + * sourceID in the struct is not valid. + Please note that only the following + * data out of am_Source_s have effect when they are + * changed: + sourceClassID, + listSoundProperties, + listConnectionFormats, + * + listMainSoundProperties + */ + virtual void updateSource(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_sourceClass_t sourceClassID, am_SoundProperty_L listSoundProperties, am_ConnectionFormat_L listConnectionFormats, am_MainSoundProperty_L listMainSoundProperties, am_Error_e& error); virtual void updateSource(am_sourceID_t sourceID, am_sourceClass_t sourceClassID, am_SoundProperty_L listSoundProperties, am_ConnectionFormat_L listConnectionFormats, am_MainSoundProperty_L listMainSoundProperties, am_Error_e& error); + /** + * acknowledges a asyncSetSinkVolumes + */ + virtual void ackSetVolumes(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Volumes_L listvolumes, am_Error_e error); virtual void ackSetVolumes(am_Handle_s handle, am_Volumes_L listvolumes, am_Error_e error); + /** + * The acknowledge of the SinkNotificationConfiguration + */ + virtual void ackSinkNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error); virtual void ackSinkNotificationConfiguration(am_Handle_s handle, am_Error_e error); + /** + * The acknowledge of the SourceNotificationConfiguration + */ + virtual void ackSourceNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Error_e error); virtual void ackSourceNotificationConfiguration(am_Handle_s handle, am_Error_e error); + /** + * is called whenever a notified value needs to be send + */ + virtual void hookSinkNotificationDataChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sinkID_t sinkID, am_NotificationPayload_s payload); virtual void hookSinkNotificationDataChange(am_sinkID_t sinkID, am_NotificationPayload_s payload); + /** + * is called whenever a notified value needs to be send + */ + virtual void hookSourceNotificationDataChange(const std::shared_ptr<CommonAPI::ClientId> clientId, am_sourceID_t sourceID, am_NotificationPayload_s payload); virtual void hookSourceNotificationDataChange(am_sourceID_t sourceID, am_NotificationPayload_s payload); + virtual void confirmRoutingRundown(const std::shared_ptr<CommonAPI::ClientId> clientId, std::string domainName); virtual void confirmRoutingRundown(std::string domainName); + protected: - virtual void onRemoteRoutingReadyAttributeChanged(); + /** + * This attribute signals to the clients the current routing state. + A client + * should notify himself to this attribute in order to know the current state and + * act accordingly. + */ virtual bool trySetRoutingReadyAttribute(am_RoutingReady_e value); virtual bool validateRoutingReadyAttributeRequestedValue(const am_RoutingReady_e& value); - - + std::shared_ptr<RoutingControlObserverStubAdapter> stubAdapter_; private: class RemoteEventHandler: public RoutingControlObserverStubRemoteEvent { public: RemoteEventHandler(RoutingControlObserverStubDefault* defaultStub); - virtual bool onRemoteSetRoutingReadyAttribute(am_RoutingReady_e value); - virtual void onRemoteRoutingReadyAttributeChanged(); + /** + * This attribute signals to the clients the current routing state. + A client + * should notify himself to this attribute in order to know the current state and + * act accordingly. + */ private: @@ -160,8 +401,13 @@ class RoutingControlObserverStubDefault : public RoutingControlObserverStub { }; RemoteEventHandler remoteEventHandler_; - std::shared_ptr<RoutingControlObserverStubAdapter> stubAdapter_; + /** + * This attribute signals to the clients the current routing state. + A client + * should notify himself to this attribute in order to know the current state and + * act accordingly. + */ am_RoutingReady_e routingReadyAttributeValue_; }; diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlProxy.h b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlProxy.h index 0bace13..ff9ea51 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlProxy.h +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlProxy.h @@ -1,34 +1,35 @@ /* -* 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/. */ +/** + * This class implements everything from Audiomanager -> RoutingAdapter + * @author Christian Mueller + */ #ifndef ORG_GENIVI_AM_Routing_Control_PROXY_H_ #define ORG_GENIVI_AM_Routing_Control_PROXY_H_ #include "RoutingControlProxyBase.h" +#if !defined (COMMONAPI_INTERNAL_COMPILATION) #define COMMONAPI_INTERNAL_COMPILATION +#endif #undef COMMONAPI_INTERNAL_COMPILATION @@ -45,15 +46,17 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing - /** + * aborts an asynchronous action. + (at)return E_OK on success, E_UNKNOWN on error, + * E_NON_EXISTENT if handle was not found + * * Calls asyncAbort with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 asyncAbort(const am_Handle_s& handle, CommonAPI::CallStatus& callStatus); /** @@ -67,15 +70,17 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> asyncAbortAsync(const am_Handle_s& handle, AsyncAbortAsyncCallback callback); - /** + * connects a source to a sink + (at)return E_OK on success, E_UNKNOWN on error, + * E_WRONG_FORMAT in case am_ConnectionFormat_e does not match + * * Calls asyncConnect with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 asyncConnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, const am_ConnectionFormat_pe& connectionFormat, CommonAPI::CallStatus& callStatus); /** @@ -89,15 +94,17 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> asyncConnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, const am_ConnectionFormat_pe& connectionFormat, AsyncConnectAsyncCallback callback); - /** + * disconnect a connection with given connectionID + (at)return E_OK on success, + * E_UNKNOWN on error, E_NON_EXISTENT if connection was not found + * * Calls asyncDisconnect with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 asyncDisconnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, CommonAPI::CallStatus& callStatus); /** @@ -111,15 +118,19 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> asyncDisconnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, AsyncDisconnectAsyncCallback callback); - /** + * this method is used to set the volume of a sink. This function is used to drive + * ramps, to mute or unmute or directly set the value. The difference is made + * through the ramptype. + (at)return E_OK on success, E_UNKNOWN on error, + * E_OUT_OF_RANGE if new volume is out of range + * * Calls asyncSetSinkVolume with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 asyncSetSinkVolume(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, CommonAPI::CallStatus& callStatus); /** @@ -133,15 +144,21 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> asyncSetSinkVolumeAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, AsyncSetSinkVolumeAsyncCallback callback); - /** + * sets the volume of a source. This method is used to set the volume of a sink. + * This function is used to drive ramps, to mute or unmute or directly set the + * value. The difference is made through the ramptype. + (at)return E_OK on + * success, E_UNKNOWN on error, E_OUT_OF_RANGE if volume is out of + * range. + triggers the acknowledge ackSourceVolumeChange + * * Calls asyncSetSourceVolume with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 asyncSetSourceVolume(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, CommonAPI::CallStatus& callStatus); /** @@ -155,15 +172,17 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> asyncSetSourceVolumeAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, AsyncSetSourceVolumeAsyncCallback callback); - /** + * This function is used to set the source state of a particular + * source. + (at)return E_OK on success, E_UNKNOWN on error + * * Calls asyncSetSourceState with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 asyncSetSourceState(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SourceState_e& state, CommonAPI::CallStatus& callStatus); /** @@ -177,15 +196,17 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> asyncSetSourceStateAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SourceState_e& state, AsyncSetSourceStateAsyncCallback callback); - /** + * this function sets the sinksoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + * * Calls asyncSetSinkSoundProperties with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 asyncSetSinkSoundProperties(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_L& listSoundProperties, CommonAPI::CallStatus& callStatus); /** @@ -199,15 +220,17 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> asyncSetSinkSoundPropertiesAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_L& listSoundProperties, AsyncSetSinkSoundPropertiesAsyncCallback callback); - /** + * this function sets the sinksoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + * * Calls asyncSetSinkSoundProperty with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 asyncSetSinkSoundProperty(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus); /** @@ -221,15 +244,17 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> asyncSetSinkSoundPropertyAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_s& soundProperty, AsyncSetSinkSoundPropertyAsyncCallback callback); - /** + * this function sets the sourcesoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + * * Calls asyncSetSourceSoundProperties with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 asyncSetSourceSoundProperties(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_L& listSoundProperties, CommonAPI::CallStatus& callStatus); /** @@ -243,15 +268,17 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> asyncSetSourceSoundPropertiesAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_L& listSoundProperties, AsyncSetSourceSoundPropertiesAsyncCallback callback); - /** + * this function sets the sourcesoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + * * Calls asyncSetSourceSoundProperty with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 asyncSetSourceSoundProperty(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus); /** @@ -265,15 +292,17 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> asyncSetSourceSoundPropertyAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_s& soundProperty, AsyncSetSourceSoundPropertyAsyncCallback callback); - /** + * this function triggers crossfading. + (at)return E_OK on success, E_UNKNOWN on + * error + * * Calls asyncCrossFade with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 asyncCrossFade(const am_Handle_s& handle, const am_crossfaderID_t& crossfaderID, const am_HotSink_e& hotSink, const am_RampType_pe& rampType, const am_time_t& time, CommonAPI::CallStatus& callStatus); /** @@ -287,16 +316,18 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> asyncCrossFadeAsync(const am_Handle_s& handle, const am_crossfaderID_t& crossfaderID, const am_HotSink_e& hotSink, const am_RampType_pe& rampType, const am_time_t& time, AsyncCrossFadeAsyncCallback callback); - /** + * this function is used for early and late audio functions to set the domain + * state + (at)return E_OK on success, E_UNKNOWN on error + * * Calls setDomainState 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 setDomainState(const am_domainID_t& domainID, const am_DomainState_e& domainState, CommonAPI::CallStatus& callStatus, am_Error_e& error); /** @@ -310,15 +341,13 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> setDomainStateAsync(const am_domainID_t& domainID, const am_DomainState_e& domainState, SetDomainStateAsyncCallback callback); - /** * Calls asyncSetVolumes with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 asyncSetVolumes(const am_Handle_s& handle, const am_Volumes_L& volumes, CommonAPI::CallStatus& callStatus); /** @@ -332,15 +361,13 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> asyncSetVolumesAsync(const am_Handle_s& handle, const am_Volumes_L& volumes, AsyncSetVolumesAsyncCallback callback); - /** * Calls asyncSetSinkNotificationConfiguration with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 asyncSetSinkNotificationConfiguration(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& notificationConfiguration, CommonAPI::CallStatus& callStatus); /** @@ -354,15 +381,13 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> asyncSetSinkNotificationConfigurationAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& notificationConfiguration, AsyncSetSinkNotificationConfigurationAsyncCallback callback); - /** * Calls asyncSetSourceNotificationConfiguration with synchronous semantics. * - * All const parameters are input parameters to this method. + * All const parameters are input parameters to this method. * 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 asyncSetSourceNotificationConfiguration(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& notificationConfiguration, CommonAPI::CallStatus& callStatus); /** @@ -376,23 +401,39 @@ class RoutingControlProxy: virtual public RoutingControl, virtual public Routing * It will provide the same value for CallStatus as will be handed to the callback. */ virtual std::future<CommonAPI::CallStatus> asyncSetSourceNotificationConfigurationAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& notificationConfiguration, AsyncSetSourceNotificationConfigurationAsyncCallback 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. */ @@ -422,6 +463,11 @@ template <typename ... _AttributeExtensions> RoutingControlProxy<_AttributeExtensions...>::~RoutingControlProxy() { } +/** + * aborts an asynchronous action. +(at)return E_OK on success, E_UNKNOWN on error, + * E_NON_EXISTENT if handle was not found + */ template <typename ... _AttributeExtensions> void RoutingControlProxy<_AttributeExtensions...>::asyncAbort(const am_Handle_s& handle, CommonAPI::CallStatus& callStatus) { delegate_->asyncAbort(handle, callStatus); @@ -431,7 +477,11 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlProxy<_AttributeExtensions...>::asyncAbortAsync(const am_Handle_s& handle, AsyncAbortAsyncCallback callback) { return delegate_->asyncAbortAsync(handle, callback); } - +/** + * connects a source to a sink +(at)return E_OK on success, E_UNKNOWN on error, + * E_WRONG_FORMAT in case am_ConnectionFormat_e does not match + */ template <typename ... _AttributeExtensions> void RoutingControlProxy<_AttributeExtensions...>::asyncConnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, const am_ConnectionFormat_pe& connectionFormat, CommonAPI::CallStatus& callStatus) { delegate_->asyncConnect(handle, connectionID, sourceID, sinkID, connectionFormat, callStatus); @@ -441,7 +491,11 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlProxy<_AttributeExtensions...>::asyncConnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, const am_ConnectionFormat_pe& connectionFormat, AsyncConnectAsyncCallback callback) { return delegate_->asyncConnectAsync(handle, connectionID, sourceID, sinkID, connectionFormat, callback); } - +/** + * disconnect a connection with given connectionID +(at)return E_OK on success, + * E_UNKNOWN on error, E_NON_EXISTENT if connection was not found + */ template <typename ... _AttributeExtensions> void RoutingControlProxy<_AttributeExtensions...>::asyncDisconnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, CommonAPI::CallStatus& callStatus) { delegate_->asyncDisconnect(handle, connectionID, callStatus); @@ -451,7 +505,13 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlProxy<_AttributeExtensions...>::asyncDisconnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, AsyncDisconnectAsyncCallback callback) { return delegate_->asyncDisconnectAsync(handle, connectionID, callback); } - +/** + * this method is used to set the volume of a sink. This function is used to drive + * ramps, to mute or unmute or directly set the value. The difference is made + * through the ramptype. +(at)return E_OK on success, E_UNKNOWN on error, + * E_OUT_OF_RANGE if new volume is out of range + */ template <typename ... _AttributeExtensions> void RoutingControlProxy<_AttributeExtensions...>::asyncSetSinkVolume(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, CommonAPI::CallStatus& callStatus) { delegate_->asyncSetSinkVolume(handle, sinkID, volume, ramp, time, callStatus); @@ -461,7 +521,15 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlProxy<_AttributeExtensions...>::asyncSetSinkVolumeAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, AsyncSetSinkVolumeAsyncCallback callback) { return delegate_->asyncSetSinkVolumeAsync(handle, sinkID, volume, ramp, time, callback); } - +/** + * sets the volume of a source. This method is used to set the volume of a sink. + * This function is used to drive ramps, to mute or unmute or directly set the + * value. The difference is made through the ramptype. +(at)return E_OK on + * success, E_UNKNOWN on error, E_OUT_OF_RANGE if volume is out of + * range. +triggers the acknowledge ackSourceVolumeChange + */ template <typename ... _AttributeExtensions> void RoutingControlProxy<_AttributeExtensions...>::asyncSetSourceVolume(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, CommonAPI::CallStatus& callStatus) { delegate_->asyncSetSourceVolume(handle, sourceID, volume, ramp, time, callStatus); @@ -471,7 +539,11 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlProxy<_AttributeExtensions...>::asyncSetSourceVolumeAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, AsyncSetSourceVolumeAsyncCallback callback) { return delegate_->asyncSetSourceVolumeAsync(handle, sourceID, volume, ramp, time, callback); } - +/** + * This function is used to set the source state of a particular + * source. +(at)return E_OK on success, E_UNKNOWN on error + */ template <typename ... _AttributeExtensions> void RoutingControlProxy<_AttributeExtensions...>::asyncSetSourceState(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SourceState_e& state, CommonAPI::CallStatus& callStatus) { delegate_->asyncSetSourceState(handle, sourceID, state, callStatus); @@ -481,7 +553,11 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlProxy<_AttributeExtensions...>::asyncSetSourceStateAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SourceState_e& state, AsyncSetSourceStateAsyncCallback callback) { return delegate_->asyncSetSourceStateAsync(handle, sourceID, state, callback); } - +/** + * this function sets the sinksoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ template <typename ... _AttributeExtensions> void RoutingControlProxy<_AttributeExtensions...>::asyncSetSinkSoundProperties(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_L& listSoundProperties, CommonAPI::CallStatus& callStatus) { delegate_->asyncSetSinkSoundProperties(handle, sinkID, listSoundProperties, callStatus); @@ -491,7 +567,11 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlProxy<_AttributeExtensions...>::asyncSetSinkSoundPropertiesAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_L& listSoundProperties, AsyncSetSinkSoundPropertiesAsyncCallback callback) { return delegate_->asyncSetSinkSoundPropertiesAsync(handle, sinkID, listSoundProperties, callback); } - +/** + * this function sets the sinksoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ template <typename ... _AttributeExtensions> void RoutingControlProxy<_AttributeExtensions...>::asyncSetSinkSoundProperty(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus) { delegate_->asyncSetSinkSoundProperty(handle, sinkID, soundProperty, callStatus); @@ -501,7 +581,11 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlProxy<_AttributeExtensions...>::asyncSetSinkSoundPropertyAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_s& soundProperty, AsyncSetSinkSoundPropertyAsyncCallback callback) { return delegate_->asyncSetSinkSoundPropertyAsync(handle, sinkID, soundProperty, callback); } - +/** + * this function sets the sourcesoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ template <typename ... _AttributeExtensions> void RoutingControlProxy<_AttributeExtensions...>::asyncSetSourceSoundProperties(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_L& listSoundProperties, CommonAPI::CallStatus& callStatus) { delegate_->asyncSetSourceSoundProperties(handle, sourceID, listSoundProperties, callStatus); @@ -511,7 +595,11 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlProxy<_AttributeExtensions...>::asyncSetSourceSoundPropertiesAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_L& listSoundProperties, AsyncSetSourceSoundPropertiesAsyncCallback callback) { return delegate_->asyncSetSourceSoundPropertiesAsync(handle, sourceID, listSoundProperties, callback); } - +/** + * this function sets the sourcesoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ template <typename ... _AttributeExtensions> void RoutingControlProxy<_AttributeExtensions...>::asyncSetSourceSoundProperty(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus) { delegate_->asyncSetSourceSoundProperty(handle, sourceID, soundProperty, callStatus); @@ -521,7 +609,11 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlProxy<_AttributeExtensions...>::asyncSetSourceSoundPropertyAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_s& soundProperty, AsyncSetSourceSoundPropertyAsyncCallback callback) { return delegate_->asyncSetSourceSoundPropertyAsync(handle, sourceID, soundProperty, callback); } - +/** + * this function triggers crossfading. +(at)return E_OK on success, E_UNKNOWN on + * error + */ template <typename ... _AttributeExtensions> void RoutingControlProxy<_AttributeExtensions...>::asyncCrossFade(const am_Handle_s& handle, const am_crossfaderID_t& crossfaderID, const am_HotSink_e& hotSink, const am_RampType_pe& rampType, const am_time_t& time, CommonAPI::CallStatus& callStatus) { delegate_->asyncCrossFade(handle, crossfaderID, hotSink, rampType, time, callStatus); @@ -531,7 +623,11 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlProxy<_AttributeExtensions...>::asyncCrossFadeAsync(const am_Handle_s& handle, const am_crossfaderID_t& crossfaderID, const am_HotSink_e& hotSink, const am_RampType_pe& rampType, const am_time_t& time, AsyncCrossFadeAsyncCallback callback) { return delegate_->asyncCrossFadeAsync(handle, crossfaderID, hotSink, rampType, time, callback); } - +/** + * this function is used for early and late audio functions to set the domain + * state +(at)return E_OK on success, E_UNKNOWN on error + */ template <typename ... _AttributeExtensions> void RoutingControlProxy<_AttributeExtensions...>::setDomainState(const am_domainID_t& domainID, const am_DomainState_e& domainState, CommonAPI::CallStatus& callStatus, am_Error_e& error) { delegate_->setDomainState(domainID, domainState, callStatus, error); @@ -541,7 +637,6 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlProxy<_AttributeExtensions...>::setDomainStateAsync(const am_domainID_t& domainID, const am_DomainState_e& domainState, SetDomainStateAsyncCallback callback) { return delegate_->setDomainStateAsync(domainID, domainState, callback); } - template <typename ... _AttributeExtensions> void RoutingControlProxy<_AttributeExtensions...>::asyncSetVolumes(const am_Handle_s& handle, const am_Volumes_L& volumes, CommonAPI::CallStatus& callStatus) { delegate_->asyncSetVolumes(handle, volumes, callStatus); @@ -551,7 +646,6 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlProxy<_AttributeExtensions...>::asyncSetVolumesAsync(const am_Handle_s& handle, const am_Volumes_L& volumes, AsyncSetVolumesAsyncCallback callback) { return delegate_->asyncSetVolumesAsync(handle, volumes, callback); } - template <typename ... _AttributeExtensions> void RoutingControlProxy<_AttributeExtensions...>::asyncSetSinkNotificationConfiguration(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& notificationConfiguration, CommonAPI::CallStatus& callStatus) { delegate_->asyncSetSinkNotificationConfiguration(handle, sinkID, notificationConfiguration, callStatus); @@ -561,7 +655,6 @@ template <typename ... _AttributeExtensions> std::future<CommonAPI::CallStatus> RoutingControlProxy<_AttributeExtensions...>::asyncSetSinkNotificationConfigurationAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& notificationConfiguration, AsyncSetSinkNotificationConfigurationAsyncCallback callback) { return delegate_->asyncSetSinkNotificationConfigurationAsync(handle, sinkID, notificationConfiguration, callback); } - template <typename ... _AttributeExtensions> void RoutingControlProxy<_AttributeExtensions...>::asyncSetSourceNotificationConfiguration(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& notificationConfiguration, CommonAPI::CallStatus& callStatus) { delegate_->asyncSetSourceNotificationConfiguration(handle, sourceID, notificationConfiguration, callStatus); @@ -572,7 +665,6 @@ std::future<CommonAPI::CallStatus> RoutingControlProxy<_AttributeExtensions...>: return delegate_->asyncSetSourceNotificationConfigurationAsync(handle, sourceID, notificationConfiguration, callback); } - template <typename ... _AttributeExtensions> std::string RoutingControlProxy<_AttributeExtensions...>::getAddress() const { return delegate_->getAddress(); @@ -599,6 +691,11 @@ bool RoutingControlProxy<_AttributeExtensions...>::isAvailable() const { } template <typename ... _AttributeExtensions> +bool RoutingControlProxy<_AttributeExtensions...>::isAvailableBlocking() const { + return delegate_->isAvailableBlocking(); +} + +template <typename ... _AttributeExtensions> CommonAPI::ProxyStatusEvent& RoutingControlProxy<_AttributeExtensions...>::getProxyStatusEvent() { return delegate_->getProxyStatusEvent(); } @@ -608,10 +705,11 @@ CommonAPI::InterfaceVersionAttribute& RoutingControlProxy<_AttributeExtensions.. return delegate_->getInterfaceVersionAttribute(); } + + } // namespace am } // namespace genivi } // namespace org - #endif // ORG_GENIVI_AM_Routing_Control_PROXY_H_ diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlProxyBase.h b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlProxyBase.h index 7c7c9fe..8afe202 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlProxyBase.h +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlProxyBase.h @@ -1,123 +1,176 @@ - /* - * 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/. +*/ +/** + * This class implements everything from Audiomanager -> RoutingAdapter + * @author Christian Mueller */ - #ifndef ORG_GENIVI_AM_Routing_Control_PROXY_BASE_H_ - #define ORG_GENIVI_AM_Routing_Control_PROXY_BASE_H_ - - #include "RoutingControl.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 <vector> - - #include <CommonAPI/Proxy.h> - #include <functional> - #include <future> - - #undef COMMONAPI_INTERNAL_COMPILATION - - namespace org { - namespace genivi { - namespace am { - - class RoutingControlProxyBase: virtual public CommonAPI::Proxy { - public: - typedef std::function<void(const CommonAPI::CallStatus&)> AsyncAbortAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AsyncConnectAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AsyncDisconnectAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSinkVolumeAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSourceVolumeAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSourceStateAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSinkSoundPropertiesAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSinkSoundPropertyAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSourceSoundPropertiesAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSourceSoundPropertyAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AsyncCrossFadeAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetDomainStateAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetVolumesAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSinkNotificationConfigurationAsyncCallback; - typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSourceNotificationConfigurationAsyncCallback; - - - - - virtual void asyncAbort(const am_Handle_s& handle, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> asyncAbortAsync(const am_Handle_s& handle, AsyncAbortAsyncCallback callback) = 0; - - virtual void asyncConnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, const am_ConnectionFormat_pe& connectionFormat, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> asyncConnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, const am_ConnectionFormat_pe& connectionFormat, AsyncConnectAsyncCallback callback) = 0; - - virtual void asyncDisconnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> asyncDisconnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, AsyncDisconnectAsyncCallback callback) = 0; - - virtual void asyncSetSinkVolume(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> asyncSetSinkVolumeAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, AsyncSetSinkVolumeAsyncCallback callback) = 0; - - virtual void asyncSetSourceVolume(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> asyncSetSourceVolumeAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, AsyncSetSourceVolumeAsyncCallback callback) = 0; - - virtual void asyncSetSourceState(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SourceState_e& state, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> asyncSetSourceStateAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SourceState_e& state, AsyncSetSourceStateAsyncCallback callback) = 0; - - virtual void asyncSetSinkSoundProperties(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_L& listSoundProperties, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> asyncSetSinkSoundPropertiesAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_L& listSoundProperties, AsyncSetSinkSoundPropertiesAsyncCallback callback) = 0; - - virtual void asyncSetSinkSoundProperty(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> asyncSetSinkSoundPropertyAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_s& soundProperty, AsyncSetSinkSoundPropertyAsyncCallback callback) = 0; - - virtual void asyncSetSourceSoundProperties(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_L& listSoundProperties, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> asyncSetSourceSoundPropertiesAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_L& listSoundProperties, AsyncSetSourceSoundPropertiesAsyncCallback callback) = 0; - - virtual void asyncSetSourceSoundProperty(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> asyncSetSourceSoundPropertyAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_s& soundProperty, AsyncSetSourceSoundPropertyAsyncCallback callback) = 0; - - virtual void asyncCrossFade(const am_Handle_s& handle, const am_crossfaderID_t& crossfaderID, const am_HotSink_e& hotSink, const am_RampType_pe& rampType, const am_time_t& time, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> asyncCrossFadeAsync(const am_Handle_s& handle, const am_crossfaderID_t& crossfaderID, const am_HotSink_e& hotSink, const am_RampType_pe& rampType, const am_time_t& time, AsyncCrossFadeAsyncCallback callback) = 0; - - virtual void setDomainState(const am_domainID_t& domainID, const am_DomainState_e& domainState, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; - virtual std::future<CommonAPI::CallStatus> setDomainStateAsync(const am_domainID_t& domainID, const am_DomainState_e& domainState, SetDomainStateAsyncCallback callback) = 0; - - virtual void asyncSetVolumes(const am_Handle_s& handle, const am_Volumes_L& volumes, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> asyncSetVolumesAsync(const am_Handle_s& handle, const am_Volumes_L& volumes, AsyncSetVolumesAsyncCallback callback) = 0; - - virtual void asyncSetSinkNotificationConfiguration(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& notificationConfiguration, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> asyncSetSinkNotificationConfigurationAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& notificationConfiguration, AsyncSetSinkNotificationConfigurationAsyncCallback callback) = 0; - - virtual void asyncSetSourceNotificationConfiguration(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& notificationConfiguration, CommonAPI::CallStatus& callStatus) = 0; - virtual std::future<CommonAPI::CallStatus> asyncSetSourceNotificationConfigurationAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& notificationConfiguration, AsyncSetSourceNotificationConfigurationAsyncCallback callback) = 0; - }; - - } // namespace am - } // namespace genivi - } // namespace org - - #endif // ORG_GENIVI_AM_Routing_Control_PROXY_BASE_H_ +#ifndef ORG_GENIVI_AM_Routing_Control_PROXY_BASE_H_ +#define ORG_GENIVI_AM_Routing_Control_PROXY_BASE_H_ + +#include "RoutingControl.h" + + +#include <org/genivi/am.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 <vector> + +#include <CommonAPI/Proxy.h> +#include <functional> +#include <future> + +#undef COMMONAPI_INTERNAL_COMPILATION + +namespace org { +namespace genivi { +namespace am { + +class RoutingControlProxyBase: virtual public CommonAPI::Proxy { + public: + + typedef std::function<void(const CommonAPI::CallStatus&)> AsyncAbortAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AsyncConnectAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AsyncDisconnectAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSinkVolumeAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSourceVolumeAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSourceStateAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSinkSoundPropertiesAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSinkSoundPropertyAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSourceSoundPropertiesAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSourceSoundPropertyAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AsyncCrossFadeAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&, const am_Error_e&)> SetDomainStateAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetVolumesAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSinkNotificationConfigurationAsyncCallback; + typedef std::function<void(const CommonAPI::CallStatus&)> AsyncSetSourceNotificationConfigurationAsyncCallback; + + + + /** + * aborts an asynchronous action. + (at)return E_OK on success, E_UNKNOWN on error, + * E_NON_EXISTENT if handle was not found + */ + virtual void asyncAbort(const am_Handle_s& handle, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> asyncAbortAsync(const am_Handle_s& handle, AsyncAbortAsyncCallback callback) = 0; + /** + * connects a source to a sink + (at)return E_OK on success, E_UNKNOWN on error, + * E_WRONG_FORMAT in case am_ConnectionFormat_e does not match + */ + virtual void asyncConnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, const am_ConnectionFormat_pe& connectionFormat, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> asyncConnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, const am_sourceID_t& sourceID, const am_sinkID_t& sinkID, const am_ConnectionFormat_pe& connectionFormat, AsyncConnectAsyncCallback callback) = 0; + /** + * disconnect a connection with given connectionID + (at)return E_OK on success, + * E_UNKNOWN on error, E_NON_EXISTENT if connection was not found + */ + virtual void asyncDisconnect(const am_Handle_s& handle, const am_connectionID_t& connectionID, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> asyncDisconnectAsync(const am_Handle_s& handle, const am_connectionID_t& connectionID, AsyncDisconnectAsyncCallback callback) = 0; + /** + * this method is used to set the volume of a sink. This function is used to drive + * ramps, to mute or unmute or directly set the value. The difference is made + * through the ramptype. + (at)return E_OK on success, E_UNKNOWN on error, + * E_OUT_OF_RANGE if new volume is out of range + */ + virtual void asyncSetSinkVolume(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> asyncSetSinkVolumeAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, AsyncSetSinkVolumeAsyncCallback callback) = 0; + /** + * sets the volume of a source. This method is used to set the volume of a sink. + * This function is used to drive ramps, to mute or unmute or directly set the + * value. The difference is made through the ramptype. + (at)return E_OK on + * success, E_UNKNOWN on error, E_OUT_OF_RANGE if volume is out of + * range. + triggers the acknowledge ackSourceVolumeChange + */ + virtual void asyncSetSourceVolume(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> asyncSetSourceVolumeAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_volume_t& volume, const am_RampType_pe& ramp, const am_time_t& time, AsyncSetSourceVolumeAsyncCallback callback) = 0; + /** + * This function is used to set the source state of a particular + * source. + (at)return E_OK on success, E_UNKNOWN on error + */ + virtual void asyncSetSourceState(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SourceState_e& state, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> asyncSetSourceStateAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SourceState_e& state, AsyncSetSourceStateAsyncCallback callback) = 0; + /** + * this function sets the sinksoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ + virtual void asyncSetSinkSoundProperties(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_L& listSoundProperties, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> asyncSetSinkSoundPropertiesAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_L& listSoundProperties, AsyncSetSinkSoundPropertiesAsyncCallback callback) = 0; + /** + * this function sets the sinksoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ + virtual void asyncSetSinkSoundProperty(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> asyncSetSinkSoundPropertyAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_SoundProperty_s& soundProperty, AsyncSetSinkSoundPropertyAsyncCallback callback) = 0; + /** + * this function sets the sourcesoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ + virtual void asyncSetSourceSoundProperties(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_L& listSoundProperties, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> asyncSetSourceSoundPropertiesAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_L& listSoundProperties, AsyncSetSourceSoundPropertiesAsyncCallback callback) = 0; + /** + * this function sets the sourcesoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ + virtual void asyncSetSourceSoundProperty(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_s& soundProperty, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> asyncSetSourceSoundPropertyAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_SoundProperty_s& soundProperty, AsyncSetSourceSoundPropertyAsyncCallback callback) = 0; + /** + * this function triggers crossfading. + (at)return E_OK on success, E_UNKNOWN on + * error + */ + virtual void asyncCrossFade(const am_Handle_s& handle, const am_crossfaderID_t& crossfaderID, const am_HotSink_e& hotSink, const am_RampType_pe& rampType, const am_time_t& time, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> asyncCrossFadeAsync(const am_Handle_s& handle, const am_crossfaderID_t& crossfaderID, const am_HotSink_e& hotSink, const am_RampType_pe& rampType, const am_time_t& time, AsyncCrossFadeAsyncCallback callback) = 0; + /** + * this function is used for early and late audio functions to set the domain + * state + (at)return E_OK on success, E_UNKNOWN on error + */ + virtual void setDomainState(const am_domainID_t& domainID, const am_DomainState_e& domainState, CommonAPI::CallStatus& callStatus, am_Error_e& error) = 0; + virtual std::future<CommonAPI::CallStatus> setDomainStateAsync(const am_domainID_t& domainID, const am_DomainState_e& domainState, SetDomainStateAsyncCallback callback) = 0; + virtual void asyncSetVolumes(const am_Handle_s& handle, const am_Volumes_L& volumes, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> asyncSetVolumesAsync(const am_Handle_s& handle, const am_Volumes_L& volumes, AsyncSetVolumesAsyncCallback callback) = 0; + virtual void asyncSetSinkNotificationConfiguration(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& notificationConfiguration, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> asyncSetSinkNotificationConfigurationAsync(const am_Handle_s& handle, const am_sinkID_t& sinkID, const am_NotificationConfiguration_s& notificationConfiguration, AsyncSetSinkNotificationConfigurationAsyncCallback callback) = 0; + virtual void asyncSetSourceNotificationConfiguration(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& notificationConfiguration, CommonAPI::CallStatus& callStatus) = 0; + virtual std::future<CommonAPI::CallStatus> asyncSetSourceNotificationConfigurationAsync(const am_Handle_s& handle, const am_sourceID_t& sourceID, const am_NotificationConfiguration_s& notificationConfiguration, AsyncSetSourceNotificationConfigurationAsyncCallback callback) = 0; +}; + +} // namespace am +} // namespace genivi +} // namespace org + +#endif // ORG_GENIVI_AM_Routing_Control_PROXY_BASE_H_ diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlStub.h b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlStub.h index 25f74b8..6ba3310 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlStub.h +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlStub.h @@ -1,28 +1,27 @@ /* -* 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/. */ +/** + * This class implements everything from Audiomanager -> RoutingAdapter + * @author Christian Mueller + */ #ifndef ORG_GENIVI_AM_Routing_Control_STUB_H_ #define ORG_GENIVI_AM_Routing_Control_STUB_H_ @@ -32,7 +31,9 @@ #include "RoutingControl.h" +#if !defined (COMMONAPI_INTERNAL_COMPILATION) #define COMMONAPI_INTERNAL_COMPILATION +#endif #include <CommonAPI/InputStream.h> #include <CommonAPI/OutputStream.h> @@ -57,6 +58,15 @@ namespace am { class RoutingControlStubAdapter: virtual public CommonAPI::StubAdapter, public RoutingControl { public: + + + virtual void deactivateManagedInstances() = 0; + +protected: + /** + * Defines properties for storing the ClientIds of clients / proxies that have + * subscribed to the selective broadcasts + */ }; @@ -90,36 +100,102 @@ class RoutingControlStub : public CommonAPI::Stub<RoutingControlStubAdapter , Ro virtual ~RoutingControlStub() { } + /** + * aborts an asynchronous action. + (at)return E_OK on success, E_UNKNOWN on error, + * E_NON_EXISTENT if handle was not found + */ /// This is the method that will be called on remote calls on the method asyncAbort. - virtual void asyncAbort(am_Handle_s handle) = 0; + virtual void asyncAbort(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle) = 0; + /** + * connects a source to a sink + (at)return E_OK on success, E_UNKNOWN on error, + * E_WRONG_FORMAT in case am_ConnectionFormat_e does not match + */ /// This is the method that will be called on remote calls on the method asyncConnect. - virtual void asyncConnect(am_Handle_s handle, am_connectionID_t connectionID, am_sourceID_t sourceID, am_sinkID_t sinkID, am_ConnectionFormat_pe connectionFormat) = 0; + virtual void asyncConnect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_connectionID_t connectionID, am_sourceID_t sourceID, am_sinkID_t sinkID, am_ConnectionFormat_pe connectionFormat) = 0; + /** + * disconnect a connection with given connectionID + (at)return E_OK on success, + * E_UNKNOWN on error, E_NON_EXISTENT if connection was not found + */ /// This is the method that will be called on remote calls on the method asyncDisconnect. - virtual void asyncDisconnect(am_Handle_s handle, am_connectionID_t connectionID) = 0; + virtual void asyncDisconnect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_connectionID_t connectionID) = 0; + /** + * this method is used to set the volume of a sink. This function is used to drive + * ramps, to mute or unmute or directly set the value. The difference is made + * through the ramptype. + (at)return E_OK on success, E_UNKNOWN on error, + * E_OUT_OF_RANGE if new volume is out of range + */ /// This is the method that will be called on remote calls on the method asyncSetSinkVolume. - virtual void asyncSetSinkVolume(am_Handle_s handle, am_sinkID_t sinkID, am_volume_t volume, am_RampType_pe ramp, am_time_t time) = 0; + virtual void asyncSetSinkVolume(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sinkID_t sinkID, am_volume_t volume, am_RampType_pe ramp, am_time_t time) = 0; + /** + * sets the volume of a source. This method is used to set the volume of a sink. + * This function is used to drive ramps, to mute or unmute or directly set the + * value. The difference is made through the ramptype. + (at)return E_OK on + * success, E_UNKNOWN on error, E_OUT_OF_RANGE if volume is out of + * range. + triggers the acknowledge ackSourceVolumeChange + */ /// This is the method that will be called on remote calls on the method asyncSetSourceVolume. - virtual void asyncSetSourceVolume(am_Handle_s handle, am_sourceID_t sourceID, am_volume_t volume, am_RampType_pe ramp, am_time_t time) = 0; + virtual void asyncSetSourceVolume(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_volume_t volume, am_RampType_pe ramp, am_time_t time) = 0; + /** + * This function is used to set the source state of a particular + * source. + (at)return E_OK on success, E_UNKNOWN on error + */ /// This is the method that will be called on remote calls on the method asyncSetSourceState. - virtual void asyncSetSourceState(am_Handle_s handle, am_sourceID_t sourceID, am_SourceState_e state) = 0; + virtual void asyncSetSourceState(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_SourceState_e state) = 0; + /** + * this function sets the sinksoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ /// This is the method that will be called on remote calls on the method asyncSetSinkSoundProperties. - virtual void asyncSetSinkSoundProperties(am_Handle_s handle, am_sinkID_t sinkID, am_SoundProperty_L listSoundProperties) = 0; + virtual void asyncSetSinkSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sinkID_t sinkID, am_SoundProperty_L listSoundProperties) = 0; + /** + * this function sets the sinksoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ /// This is the method that will be called on remote calls on the method asyncSetSinkSoundProperty. - virtual void asyncSetSinkSoundProperty(am_Handle_s handle, am_sinkID_t sinkID, am_SoundProperty_s soundProperty) = 0; + virtual void asyncSetSinkSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sinkID_t sinkID, am_SoundProperty_s soundProperty) = 0; + /** + * this function sets the sourcesoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ /// This is the method that will be called on remote calls on the method asyncSetSourceSoundProperties. - virtual void asyncSetSourceSoundProperties(am_Handle_s handle, am_sourceID_t sourceID, am_SoundProperty_L listSoundProperties) = 0; + virtual void asyncSetSourceSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_SoundProperty_L listSoundProperties) = 0; + /** + * this function sets the sourcesoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ /// This is the method that will be called on remote calls on the method asyncSetSourceSoundProperty. - virtual void asyncSetSourceSoundProperty(am_Handle_s handle, am_sourceID_t sourceID, am_SoundProperty_s soundProperty) = 0; + virtual void asyncSetSourceSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_SoundProperty_s soundProperty) = 0; + /** + * this function triggers crossfading. + (at)return E_OK on success, E_UNKNOWN on + * error + */ /// This is the method that will be called on remote calls on the method asyncCrossFade. - virtual void asyncCrossFade(am_Handle_s handle, am_crossfaderID_t crossfaderID, am_HotSink_e hotSink, am_RampType_pe rampType, am_time_t time) = 0; + virtual void asyncCrossFade(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_crossfaderID_t crossfaderID, am_HotSink_e hotSink, am_RampType_pe rampType, am_time_t time) = 0; + /** + * this function is used for early and late audio functions to set the domain + * state + (at)return E_OK on success, E_UNKNOWN on error + */ /// This is the method that will be called on remote calls on the method setDomainState. - virtual void setDomainState(am_domainID_t domainID, am_DomainState_e domainState, am_Error_e& error) = 0; + virtual void setDomainState(const std::shared_ptr<CommonAPI::ClientId> clientId, am_domainID_t domainID, am_DomainState_e domainState, am_Error_e& error) = 0; /// This is the method that will be called on remote calls on the method asyncSetVolumes. - virtual void asyncSetVolumes(am_Handle_s handle, am_Volumes_L volumes) = 0; + virtual void asyncSetVolumes(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Volumes_L volumes) = 0; /// This is the method that will be called on remote calls on the method asyncSetSinkNotificationConfiguration. - virtual void asyncSetSinkNotificationConfiguration(am_Handle_s handle, am_sinkID_t sinkID, am_NotificationConfiguration_s notificationConfiguration) = 0; + virtual void asyncSetSinkNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sinkID_t sinkID, am_NotificationConfiguration_s notificationConfiguration) = 0; /// This is the method that will be called on remote calls on the method asyncSetSourceNotificationConfiguration. - virtual void asyncSetSourceNotificationConfiguration(am_Handle_s handle, am_sourceID_t sourceID, am_NotificationConfiguration_s notificationConfiguration) = 0; + virtual void asyncSetSourceNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_NotificationConfiguration_s notificationConfiguration) = 0; }; diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlStubDefault.cpp b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlStubDefault.cpp index 0a5e4a2..932f17a 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlStubDefault.cpp +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlStubDefault.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/RoutingControlStubDefault.h> @@ -39,68 +34,195 @@ RoutingControlStubRemoteEvent* RoutingControlStubDefault::initStubAdapter(const } +/** + * aborts an asynchronous action. +(at)return E_OK on success, E_UNKNOWN on error, + * E_NON_EXISTENT if handle was not found + */ +void RoutingControlStubDefault::asyncAbort(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle) { + // Call old style methods in default + asyncAbort(handle); +} void RoutingControlStubDefault::asyncAbort(am_Handle_s handle) { // No operation in default } +/** + * connects a source to a sink +(at)return E_OK on success, E_UNKNOWN on error, + * E_WRONG_FORMAT in case am_ConnectionFormat_e does not match + */ +void RoutingControlStubDefault::asyncConnect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_connectionID_t connectionID, am_sourceID_t sourceID, am_sinkID_t sinkID, am_ConnectionFormat_pe connectionFormat) { + // Call old style methods in default + asyncConnect(handle, connectionID, sourceID, sinkID, connectionFormat); +} void RoutingControlStubDefault::asyncConnect(am_Handle_s handle, am_connectionID_t connectionID, am_sourceID_t sourceID, am_sinkID_t sinkID, am_ConnectionFormat_pe connectionFormat) { // No operation in default } +/** + * disconnect a connection with given connectionID +(at)return E_OK on success, + * E_UNKNOWN on error, E_NON_EXISTENT if connection was not found + */ +void RoutingControlStubDefault::asyncDisconnect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_connectionID_t connectionID) { + // Call old style methods in default + asyncDisconnect(handle, connectionID); +} void RoutingControlStubDefault::asyncDisconnect(am_Handle_s handle, am_connectionID_t connectionID) { // No operation in default } +/** + * this method is used to set the volume of a sink. This function is used to drive + * ramps, to mute or unmute or directly set the value. The difference is made + * through the ramptype. +(at)return E_OK on success, E_UNKNOWN on error, + * E_OUT_OF_RANGE if new volume is out of range + */ +void RoutingControlStubDefault::asyncSetSinkVolume(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sinkID_t sinkID, am_volume_t volume, am_RampType_pe ramp, am_time_t time) { + // Call old style methods in default + asyncSetSinkVolume(handle, sinkID, volume, ramp, time); +} void RoutingControlStubDefault::asyncSetSinkVolume(am_Handle_s handle, am_sinkID_t sinkID, am_volume_t volume, am_RampType_pe ramp, am_time_t time) { // No operation in default } +/** + * sets the volume of a source. This method is used to set the volume of a sink. + * This function is used to drive ramps, to mute or unmute or directly set the + * value. The difference is made through the ramptype. +(at)return E_OK on + * success, E_UNKNOWN on error, E_OUT_OF_RANGE if volume is out of + * range. +triggers the acknowledge ackSourceVolumeChange + */ +void RoutingControlStubDefault::asyncSetSourceVolume(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_volume_t volume, am_RampType_pe ramp, am_time_t time) { + // Call old style methods in default + asyncSetSourceVolume(handle, sourceID, volume, ramp, time); +} void RoutingControlStubDefault::asyncSetSourceVolume(am_Handle_s handle, am_sourceID_t sourceID, am_volume_t volume, am_RampType_pe ramp, am_time_t time) { // No operation in default } +/** + * This function is used to set the source state of a particular + * source. +(at)return E_OK on success, E_UNKNOWN on error + */ +void RoutingControlStubDefault::asyncSetSourceState(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_SourceState_e state) { + // Call old style methods in default + asyncSetSourceState(handle, sourceID, state); +} void RoutingControlStubDefault::asyncSetSourceState(am_Handle_s handle, am_sourceID_t sourceID, am_SourceState_e state) { // No operation in default } +/** + * this function sets the sinksoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ +void RoutingControlStubDefault::asyncSetSinkSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sinkID_t sinkID, am_SoundProperty_L listSoundProperties) { + // Call old style methods in default + asyncSetSinkSoundProperties(handle, sinkID, listSoundProperties); +} void RoutingControlStubDefault::asyncSetSinkSoundProperties(am_Handle_s handle, am_sinkID_t sinkID, am_SoundProperty_L listSoundProperties) { // No operation in default } +/** + * this function sets the sinksoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ +void RoutingControlStubDefault::asyncSetSinkSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sinkID_t sinkID, am_SoundProperty_s soundProperty) { + // Call old style methods in default + asyncSetSinkSoundProperty(handle, sinkID, soundProperty); +} void RoutingControlStubDefault::asyncSetSinkSoundProperty(am_Handle_s handle, am_sinkID_t sinkID, am_SoundProperty_s soundProperty) { // No operation in default } +/** + * this function sets the sourcesoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ +void RoutingControlStubDefault::asyncSetSourceSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_SoundProperty_L listSoundProperties) { + // Call old style methods in default + asyncSetSourceSoundProperties(handle, sourceID, listSoundProperties); +} void RoutingControlStubDefault::asyncSetSourceSoundProperties(am_Handle_s handle, am_sourceID_t sourceID, am_SoundProperty_L listSoundProperties) { // No operation in default } +/** + * this function sets the sourcesoundproperty. +(at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ +void RoutingControlStubDefault::asyncSetSourceSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_SoundProperty_s soundProperty) { + // Call old style methods in default + asyncSetSourceSoundProperty(handle, sourceID, soundProperty); +} void RoutingControlStubDefault::asyncSetSourceSoundProperty(am_Handle_s handle, am_sourceID_t sourceID, am_SoundProperty_s soundProperty) { // No operation in default } +/** + * this function triggers crossfading. +(at)return E_OK on success, E_UNKNOWN on + * error + */ +void RoutingControlStubDefault::asyncCrossFade(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_crossfaderID_t crossfaderID, am_HotSink_e hotSink, am_RampType_pe rampType, am_time_t time) { + // Call old style methods in default + asyncCrossFade(handle, crossfaderID, hotSink, rampType, time); +} void RoutingControlStubDefault::asyncCrossFade(am_Handle_s handle, am_crossfaderID_t crossfaderID, am_HotSink_e hotSink, am_RampType_pe rampType, am_time_t time) { // No operation in default } +/** + * this function is used for early and late audio functions to set the domain + * state +(at)return E_OK on success, E_UNKNOWN on error + */ +void RoutingControlStubDefault::setDomainState(const std::shared_ptr<CommonAPI::ClientId> clientId, am_domainID_t domainID, am_DomainState_e domainState, am_Error_e& error) { + // Call old style methods in default + setDomainState(domainID, domainState, error); +} void RoutingControlStubDefault::setDomainState(am_domainID_t domainID, am_DomainState_e domainState, am_Error_e& error) { // No operation in default } +void RoutingControlStubDefault::asyncSetVolumes(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Volumes_L volumes) { + // Call old style methods in default + asyncSetVolumes(handle, volumes); +} void RoutingControlStubDefault::asyncSetVolumes(am_Handle_s handle, am_Volumes_L volumes) { // No operation in default } +void RoutingControlStubDefault::asyncSetSinkNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sinkID_t sinkID, am_NotificationConfiguration_s notificationConfiguration) { + // Call old style methods in default + asyncSetSinkNotificationConfiguration(handle, sinkID, notificationConfiguration); +} void RoutingControlStubDefault::asyncSetSinkNotificationConfiguration(am_Handle_s handle, am_sinkID_t sinkID, am_NotificationConfiguration_s notificationConfiguration) { // No operation in default } +void RoutingControlStubDefault::asyncSetSourceNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_NotificationConfiguration_s notificationConfiguration) { + // Call old style methods in default + asyncSetSourceNotificationConfiguration(handle, sourceID, notificationConfiguration); +} void RoutingControlStubDefault::asyncSetSourceNotificationConfiguration(am_Handle_s handle, am_sourceID_t sourceID, am_NotificationConfiguration_s notificationConfiguration) { // No operation in default } + RoutingControlStubDefault::RemoteEventHandler::RemoteEventHandler(RoutingControlStubDefault* defaultStub): defaultStub_(defaultStub) { } diff --git a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlStubDefault.h b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlStubDefault.h index f8ca0a9..dad5d93 100644 --- a/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlStubDefault.h +++ b/PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlStubDefault.h @@ -1,32 +1,32 @@ /* -* 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/. */ +/** + * This class implements everything from Audiomanager -> RoutingAdapter + * @author Christian Mueller + */ #ifndef ORG_GENIVI_AM_Routing_Control_STUB_DEFAULT_H_ #define ORG_GENIVI_AM_Routing_Control_STUB_DEFAULT_H_ #include <org/genivi/am/RoutingControlStub.h> +#include <sstream> namespace org { namespace genivi { @@ -37,7 +37,7 @@ namespace am { * RoutingControlStub. 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,40 +49,122 @@ class RoutingControlStubDefault : public RoutingControlStub { RoutingControlStubRemoteEvent* initStubAdapter(const std::shared_ptr<RoutingControlStubAdapter>& stubAdapter); + /** + * aborts an asynchronous action. + (at)return E_OK on success, E_UNKNOWN on error, + * E_NON_EXISTENT if handle was not found + */ + virtual void asyncAbort(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle); virtual void asyncAbort(am_Handle_s handle); + /** + * connects a source to a sink + (at)return E_OK on success, E_UNKNOWN on error, + * E_WRONG_FORMAT in case am_ConnectionFormat_e does not match + */ + virtual void asyncConnect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_connectionID_t connectionID, am_sourceID_t sourceID, am_sinkID_t sinkID, am_ConnectionFormat_pe connectionFormat); virtual void asyncConnect(am_Handle_s handle, am_connectionID_t connectionID, am_sourceID_t sourceID, am_sinkID_t sinkID, am_ConnectionFormat_pe connectionFormat); + /** + * disconnect a connection with given connectionID + (at)return E_OK on success, + * E_UNKNOWN on error, E_NON_EXISTENT if connection was not found + */ + virtual void asyncDisconnect(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_connectionID_t connectionID); virtual void asyncDisconnect(am_Handle_s handle, am_connectionID_t connectionID); + /** + * this method is used to set the volume of a sink. This function is used to drive + * ramps, to mute or unmute or directly set the value. The difference is made + * through the ramptype. + (at)return E_OK on success, E_UNKNOWN on error, + * E_OUT_OF_RANGE if new volume is out of range + */ + virtual void asyncSetSinkVolume(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sinkID_t sinkID, am_volume_t volume, am_RampType_pe ramp, am_time_t time); virtual void asyncSetSinkVolume(am_Handle_s handle, am_sinkID_t sinkID, am_volume_t volume, am_RampType_pe ramp, am_time_t time); + /** + * sets the volume of a source. This method is used to set the volume of a sink. + * This function is used to drive ramps, to mute or unmute or directly set the + * value. The difference is made through the ramptype. + (at)return E_OK on + * success, E_UNKNOWN on error, E_OUT_OF_RANGE if volume is out of + * range. + triggers the acknowledge ackSourceVolumeChange + */ + virtual void asyncSetSourceVolume(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_volume_t volume, am_RampType_pe ramp, am_time_t time); virtual void asyncSetSourceVolume(am_Handle_s handle, am_sourceID_t sourceID, am_volume_t volume, am_RampType_pe ramp, am_time_t time); + /** + * This function is used to set the source state of a particular + * source. + (at)return E_OK on success, E_UNKNOWN on error + */ + virtual void asyncSetSourceState(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_SourceState_e state); virtual void asyncSetSourceState(am_Handle_s handle, am_sourceID_t sourceID, am_SourceState_e state); + /** + * this function sets the sinksoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ + virtual void asyncSetSinkSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sinkID_t sinkID, am_SoundProperty_L listSoundProperties); virtual void asyncSetSinkSoundProperties(am_Handle_s handle, am_sinkID_t sinkID, am_SoundProperty_L listSoundProperties); + /** + * this function sets the sinksoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ + virtual void asyncSetSinkSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sinkID_t sinkID, am_SoundProperty_s soundProperty); virtual void asyncSetSinkSoundProperty(am_Handle_s handle, am_sinkID_t sinkID, am_SoundProperty_s soundProperty); + /** + * this function sets the sourcesoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ + virtual void asyncSetSourceSoundProperties(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_SoundProperty_L listSoundProperties); virtual void asyncSetSourceSoundProperties(am_Handle_s handle, am_sourceID_t sourceID, am_SoundProperty_L listSoundProperties); + /** + * this function sets the sourcesoundproperty. + (at)return E_OK on success, + * E_UNKNOWN on error, E_OUT_OF_RANGE in case the propery value is out of range + */ + virtual void asyncSetSourceSoundProperty(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_SoundProperty_s soundProperty); virtual void asyncSetSourceSoundProperty(am_Handle_s handle, am_sourceID_t sourceID, am_SoundProperty_s soundProperty); + /** + * this function triggers crossfading. + (at)return E_OK on success, E_UNKNOWN on + * error + */ + virtual void asyncCrossFade(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_crossfaderID_t crossfaderID, am_HotSink_e hotSink, am_RampType_pe rampType, am_time_t time); virtual void asyncCrossFade(am_Handle_s handle, am_crossfaderID_t crossfaderID, am_HotSink_e hotSink, am_RampType_pe rampType, am_time_t time); + /** + * this function is used for early and late audio functions to set the domain + * state + (at)return E_OK on success, E_UNKNOWN on error + */ + virtual void setDomainState(const std::shared_ptr<CommonAPI::ClientId> clientId, am_domainID_t domainID, am_DomainState_e domainState, am_Error_e& error); virtual void setDomainState(am_domainID_t domainID, am_DomainState_e domainState, am_Error_e& error); + virtual void asyncSetVolumes(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_Volumes_L volumes); virtual void asyncSetVolumes(am_Handle_s handle, am_Volumes_L volumes); + virtual void asyncSetSinkNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sinkID_t sinkID, am_NotificationConfiguration_s notificationConfiguration); virtual void asyncSetSinkNotificationConfiguration(am_Handle_s handle, am_sinkID_t sinkID, am_NotificationConfiguration_s notificationConfiguration); + virtual void asyncSetSourceNotificationConfiguration(const std::shared_ptr<CommonAPI::ClientId> clientId, am_Handle_s handle, am_sourceID_t sourceID, am_NotificationConfiguration_s notificationConfiguration); virtual void asyncSetSourceNotificationConfiguration(am_Handle_s handle, am_sourceID_t sourceID, am_NotificationConfiguration_s notificationConfiguration); + protected: - + std::shared_ptr<RoutingControlStubAdapter> stubAdapter_; private: class RemoteEventHandler: public RoutingControlStubRemoteEvent { public: @@ -94,7 +176,6 @@ class RoutingControlStubDefault : public RoutingControlStub { }; RemoteEventHandler remoteEventHandler_; - std::shared_ptr<RoutingControlStubAdapter> stubAdapter_; }; |