include/routing/IAmRoutingReceive.h

   1 /**\r
   2  * Copyright (C) 2012 - 2014, BMW AG
   3  *\r
   4  * This file is part of GENIVI Project AudioManager.\r
   5  *\r
   6  * Contributions are licensed to the GENIVI Alliance under one or more\r
   7  * Contribution License Agreements.\r
   8  *\r
   9  * \copyright\r
  10  * This Source Code Form is subject to the terms of the\r
  11  * Mozilla Public License, v. 2.0. If a  copy of the MPL was not distributed with\r
  12  * this file, You can obtain one at http://mozilla.org/MPL/2.0/.\r
  13  *\r
  14  *\r
  15  * \author Christian Linke, christian.linke@bmw.de BMW 2011 - 2014
  16  *\r
  17  * \file\r
  18  * For further information see http://projects.genivi.org/audio-manager
  19  *\r
  20  * THIS CODE HAS BEEN GENERATED BY ENTERPRISE ARCHITECT GENIVI MODEL.
  21  * PLEASE CHANGE ONLY IN ENTERPRISE ARCHITECT AND GENERATE AGAIN.
  22  */\r
  23 #if !defined(EA_6ECD9991_3219_4bf4_B9F7_DDE15D8683C6__INCLUDED_)
  24 #define EA_6ECD9991_3219_4bf4_B9F7_DDE15D8683C6__INCLUDED_
  25 \r
  26 #include <vector>\r
  27 #include <string>\r
  28 #include "audiomanagertypes.h"\r
  29 \r
  30 namespace am {\r
  31 class CAmDbusWrapper;\r
  32 class CAmSocketHandler;\r
  33 }\r
  34
  35
  36 #include "audiomanagertypes.h"
  37
  38 #define RoutingReceiveVersion "2.0"
  39 namespace am {
  40
  41 /**
  42  * Routing Receive sendInterface description. This class implements everything
  43  * from RoutingAdapter -> Audiomanager
  44  * There are two rules that have to be kept in mind when implementing against this
  45  * interface:\n
  46  * \warning
  47  * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
  48  * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS
  49  * CALL THAT EXPECTS A RETURN VALUE.\n
  50  * \details
  51  * Violation these rules may lead to unexpected behavior! Nevertheless you can
  52  * implement thread safe by using the deferred-call pattern described on the wiki
  53  * which also helps to implement calls that are forbidden.\n
  54  * For more information, please check CAmSerializer
  55  */
  56 class IAmRoutingReceive
  57 {
  58
  59 public:
  60         IAmRoutingReceive() {
  61
  62         }
  63
  64         virtual ~IAmRoutingReceive() {
  65
  66         }
  67
  68         virtual void  getInterfaceVersion(std::string& version) const =0;
  69         virtual void ackConnect(const am_Handle_s handle, const am_connectionID_t connectionID, const am_Error_e error) =0;
  70         virtual void ackDisconnect(const am_Handle_s handle, const am_connectionID_t connectionID, const am_Error_e error) =0;
  71         virtual void ackSetSinkVolumeChange(const am_Handle_s handle, const am_volume_t volume, const am_Error_e error) =0;
  72         virtual void ackSetSourceVolumeChange(const am_Handle_s handle, const am_volume_t volume, const am_Error_e error) =0;
  73         virtual void ackSetSourceState(const am_Handle_s handle, const am_Error_e error) =0;
  74         virtual void ackSetSinkSoundProperties(const am_Handle_s handle, const am_Error_e error) =0;
  75         virtual void ackSetSinkSoundProperty(const am_Handle_s handle, const am_Error_e error) =0;
  76         virtual void ackSetSourceSoundProperties(const am_Handle_s handle, const am_Error_e error) =0;
  77         virtual void ackSetSourceSoundProperty(const am_Handle_s handle, const am_Error_e error) =0;
  78         virtual void ackCrossFading(const am_Handle_s handle, const am_HotSink_e hotSink, const am_Error_e error) =0;
  79         virtual void ackSourceVolumeTick(const am_Handle_s handle, const am_sourceID_t sourceID, const am_volume_t volume) =0;
  80         virtual void ackSinkVolumeTick(const am_Handle_s handle, const am_sinkID_t sinkID, const am_volume_t volume) =0;
  81         virtual am_Error_e peekDomain(const std::string& name, am_domainID_t& domainID) =0;
  82         virtual am_Error_e registerDomain(const am_Domain_s& domainData, am_domainID_t& domainID) =0;
  83         virtual am_Error_e deregisterDomain(const am_domainID_t domainID) =0;
  84         virtual am_Error_e registerGateway(const am_Gateway_s& gatewayData, am_gatewayID_t& gatewayID) =0;
  85         virtual am_Error_e deregisterGateway(const am_gatewayID_t gatewayID) =0;
  86         virtual am_Error_e peekSink(const std::string& name, am_sinkID_t& sinkID) =0;
  87         virtual am_Error_e registerSink(const am_Sink_s& sinkData, am_sinkID_t& sinkID) =0;
  88         virtual am_Error_e deregisterSink(const am_sinkID_t sinkID) =0;
  89         virtual am_Error_e peekSource(const std::string& name, am_sourceID_t& sourceID) =0;
  90         virtual am_Error_e registerSource(const am_Source_s& sourceData, am_sourceID_t& sourceID) =0;
  91         virtual am_Error_e deregisterSource(const am_sourceID_t sourceID) =0;
  92         virtual am_Error_e registerCrossfader(const am_Crossfader_s& crossfaderData, am_crossfaderID_t& crossfaderID) =0;
  93         virtual am_Error_e deregisterCrossfader(const am_crossfaderID_t crossfaderID) =0;
  94         virtual am_Error_e peekSourceClassID(const std::string& name, am_sourceClass_t& sourceClassID) =0;
  95         virtual am_Error_e peekSinkClassID(const std::string& name, am_sinkClass_t& sinkClassID) =0;
  96         virtual void hookInterruptStatusChange(const am_sourceID_t sourceID, const am_InterruptState_e interruptState) =0;
  97         virtual void hookDomainRegistrationComplete(const am_domainID_t domainID) =0;
  98         virtual void hookSinkAvailablityStatusChange(const am_sinkID_t sinkID, const am_Availability_s& availability) =0;
  99         virtual void hookSourceAvailablityStatusChange(const am_sourceID_t sourceID, const am_Availability_s& availability) =0;
 100         virtual void hookDomainStateChange(const am_domainID_t domainID, const am_DomainState_e domainState) =0;
 101         virtual void hookTimingInformationChanged(const am_connectionID_t connectionID, const am_timeSync_t delay) =0;
 102         virtual void sendChangedData(const std::vector<am_EarlyData_s>& earlyData) =0;
 103         virtual am_Error_e getDBusConnectionWrapper(CAmDbusWrapper*& dbusConnectionWrapper) const =0;
 104         virtual am_Error_e getSocketHandler(CAmSocketHandler*& socketHandler) const =0;
 105         virtual void  confirmRoutingReady(const uint16_t handle, const am_Error_e error) =0;
 106         virtual void  confirmRoutingRundown(const uint16_t handle, const am_Error_e error) =0;
 107         virtual am_Error_e updateGateway(const am_gatewayID_t gatewayID, const std::vector<am_CustomConnectionFormat_t>& listSourceFormats, const std::vector<am_CustomConnectionFormat_t>& listSinkFormats, const std::vector<bool>& convertionMatrix) =0;
 108         virtual am_Error_e updateSink(const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector<am_SoundProperty_s>& listSoundProperties, const std::vector<am_CustomConnectionFormat_t>& listConnectionFormats, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties) =0;
 109         virtual am_Error_e updateSource(const am_sourceID_t sourceID, const am_sourceClass_t sourceClassID, const std::vector<am_SoundProperty_s>& listSoundProperties, const std::vector<am_CustomConnectionFormat_t>& listConnectionFormats, const std::vector<am_MainSoundProperty_s>& listMainSoundProperties) =0;
 110         virtual void ackSetVolumes(const am_Handle_s handle, const std::vector<am_Volumes_s>& listvolumes, const am_Error_e error) =0;
 111         virtual void ackSinkNotificationConfiguration(const am_Handle_s handle, const am_Error_e error) =0;
 112         virtual void ackSourceNotificationConfiguration(const am_Handle_s handle, const am_Error_e error) =0;
 113         virtual void hookSinkNotificationDataChange(const am_sinkID_t sinkID, const am_NotificationPayload_s& payload) =0;
 114         virtual void hookSourceNotificationDataChange(const am_sourceID_t sourceID, const am_NotificationPayload_s& payload) =0;
 115
 116 };
 117 }
 118 #endif // !defined(EA_6ECD9991_3219_4bf4_B9F7_DDE15D8683C6__INCLUDED_)