diff options
Diffstat (limited to 'PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverProxy.h')
| -rw-r--r-- | PluginRoutingInterfaceCAPI/src-gen/org/genivi/am/RoutingControlObserverProxy.h | 679 |
1 files changed, 461 insertions, 218 deletions
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_ |