include/control/IAmControlSend.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_D17C9A1A_AB65_4f6e_A787_51033D190C21__INCLUDED_)
  24 #define EA_D17C9A1A_AB65_4f6e_A787_51033D190C21__INCLUDED_
  25 \r
  26 #include <vector>\r
  27 #include <string>\r
  28 #include "audiomanagertypes.h"\r
  29 \r
  30 namespace am {\r
  31 class IAmControlReceive;\r
  32 }
  33
  34 #include "IAmControlReceive.h"
  35 #include "audiomanagertypes.h"
  36 #include "NodeStateManager.h"
  37
  38 #define ControlSendVersion "2.0"
  39 namespace am {
  40
  41 /**
  42  * This interface is presented by the AudioManager controller.
  43  * All the hooks represent system events that need to be handled. The callback
  44  * functions are used to handle for example answers to function calls on the
  45  * AudioManagerCoreInterface.
  46  * There are two rules that have to be kept in mind when implementing against this
  47  * interface:\n
  48  * \warning
  49  * 1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!! \n
  50  * 2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS
  51  * CALL THAT EXPECTS A RETURN VALUE.\n
  52  * \details
  53  * Violation these rules may lead to unexpected behavior! Nevertheless you can
  54  * implement thread safe by using the deferred-call pattern described on the wiki
  55  * which also helps to implement calls that are forbidden.\n
  56  * For more information, please check CAmSerializer
  57  */
  58 class IAmControlSend
  59 {
  60
  61 public:
  62         IAmControlSend() {
  63
  64         }
  65
  66         virtual ~IAmControlSend() {
  67
  68         }
  69
  70         virtual void getInterfaceVersion(std::string& version) const =0;
  71         virtual am_Error_e startupController(IAmControlReceive* controlreceiveinterface) =0;
  72         virtual void setControllerReady() =0;
  73         virtual void setControllerRundown(const int16_t signal) =0;
  74         virtual am_Error_e hookUserConnectionRequest(const am_sourceID_t sourceID, const am_sinkID_t sinkID, am_mainConnectionID_t& mainConnectionID) =0;
  75         virtual am_Error_e hookUserDisconnectionRequest(const am_mainConnectionID_t connectionID) =0;
  76         virtual am_Error_e hookUserSetMainSinkSoundProperty(const am_sinkID_t sinkID, const am_MainSoundProperty_s& soundProperty) =0;
  77         virtual am_Error_e hookUserSetMainSourceSoundProperty(const am_sourceID_t sourceID, const am_MainSoundProperty_s& soundProperty) =0;
  78         virtual am_Error_e hookUserSetSystemProperty(const am_SystemProperty_s& property) =0;
  79         virtual am_Error_e hookUserVolumeChange(const am_sinkID_t SinkID, const am_mainVolume_t newVolume) =0;
  80         virtual am_Error_e hookUserVolumeStep(const am_sinkID_t SinkID, const int16_t increment) =0;
  81         virtual am_Error_e hookUserSetSinkMuteState(const am_sinkID_t sinkID, const am_MuteState_e muteState) =0;
  82         virtual am_Error_e hookSystemRegisterDomain(const am_Domain_s& domainData, am_domainID_t& domainID) =0;
  83         virtual am_Error_e hookSystemDeregisterDomain(const am_domainID_t domainID) =0;
  84         virtual void hookSystemDomainRegistrationComplete(const am_domainID_t domainID) =0;
  85         virtual am_Error_e hookSystemRegisterSink(const am_Sink_s& sinkData, am_sinkID_t& sinkID) =0;
  86         virtual am_Error_e hookSystemDeregisterSink(const am_sinkID_t sinkID) =0;
  87         virtual am_Error_e hookSystemRegisterSource(const am_Source_s& sourceData, am_sourceID_t& sourceID) =0;
  88         virtual am_Error_e hookSystemDeregisterSource(const am_sourceID_t sourceID) =0;
  89         virtual am_Error_e hookSystemRegisterGateway(const am_Gateway_s& gatewayData, am_gatewayID_t& gatewayID) =0;
  90         virtual am_Error_e hookSystemDeregisterGateway(const am_gatewayID_t gatewayID) =0;
  91         virtual am_Error_e hookSystemRegisterCrossfader(const am_Crossfader_s& crossfaderData, am_crossfaderID_t& crossfaderID) =0;
  92         virtual am_Error_e hookSystemDeregisterCrossfader(const am_crossfaderID_t crossfaderID) =0;
  93         virtual void hookSystemSinkVolumeTick(const am_Handle_s handle, const am_sinkID_t sinkID, const am_volume_t volume) =0;
  94         virtual void hookSystemSourceVolumeTick(const am_Handle_s handle, const am_sourceID_t sourceID, const am_volume_t volume) =0;
  95         virtual void hookSystemInterruptStateChange(const am_sourceID_t sourceID, const am_InterruptState_e interruptState) =0;
  96         virtual void hookSystemSinkAvailablityStateChange(const am_sinkID_t sinkID, const am_Availability_s& availability) =0;
  97         virtual void hookSystemSourceAvailablityStateChange(const am_sourceID_t sourceID, const am_Availability_s& availability) =0;
  98         virtual void hookSystemDomainStateChange(const am_domainID_t domainID, const am_DomainState_e state) =0;
  99         virtual void hookSystemReceiveEarlyData(const std::vector<am_EarlyData_s>& data) =0;
 100         virtual void hookSystemSpeedChange(const am_speed_t speed) =0;
 101         virtual void hookSystemTimingInformationChanged(const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time) =0;
 102         virtual void cbAckConnect(const am_Handle_s handle, const am_Error_e errorID) =0;
 103         virtual void cbAckDisconnect(const am_Handle_s handle, const am_Error_e errorID) =0;
 104         virtual void cbAckCrossFade(const am_Handle_s handle, const am_HotSink_e hostsink, const am_Error_e error) =0;
 105         virtual void cbAckSetSinkVolumeChange(const am_Handle_s handle, const am_volume_t volume, const am_Error_e error) =0;
 106         virtual void cbAckSetSourceVolumeChange(const am_Handle_s handle, const am_volume_t voulme, const am_Error_e error) =0;
 107         virtual void cbAckSetSourceState(const am_Handle_s handle, const am_Error_e error) =0;
 108         virtual void cbAckSetSourceSoundProperties(const am_Handle_s handle, const am_Error_e error) =0;
 109         virtual void cbAckSetSourceSoundProperty(const am_Handle_s handle, const am_Error_e error) =0;
 110         virtual void cbAckSetSinkSoundProperties(const am_Handle_s handle, const am_Error_e error) =0;
 111         virtual void cbAckSetSinkSoundProperty(const am_Handle_s handle, const am_Error_e error) =0;
 112         virtual am_Error_e getConnectionFormatChoice(const am_sourceID_t sourceID, const am_sinkID_t sinkID, const am_Route_s listRoute, const std::vector<am_CustomConnectionFormat_t> listPossibleConnectionFormats, std::vector<am_CustomConnectionFormat_t>& listPrioConnectionFormats) =0;
 113         virtual void confirmCommandReady(const am_Error_e error) =0;
 114         virtual void confirmRoutingReady(const am_Error_e error) =0;
 115         virtual void confirmCommandRundown(const am_Error_e error) =0;
 116         virtual void confirmRoutingRundown(const am_Error_e error) =0;
 117         virtual am_Error_e hookSystemUpdateSink(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;
 118         virtual am_Error_e hookSystemUpdateSource(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;
 119         virtual am_Error_e hookSystemUpdateGateway(const am_gatewayID_t gatewayID, const std::vector<am_CustomConnectionFormat_t>& listSourceConnectionFormats, const std::vector<am_CustomConnectionFormat_t>& listSinkConnectionFormats, const std::vector<bool>& convertionMatrix) =0;
 120         virtual void cbAckSetVolumes(const am_Handle_s handle, const std::vector<am_Volumes_s>& listVolumes, const am_Error_e error) =0;
 121         virtual void cbAckSetSinkNotificationConfiguration(const am_Handle_s handle, const am_Error_e error) =0;
 122         virtual void cbAckSetSourceNotificationConfiguration(const am_Handle_s handle, const am_Error_e error) =0;
 123         virtual void hookSinkNotificationDataChanged(const am_sinkID_t sinkID, const am_NotificationPayload_s& payload) =0;
 124         virtual void hookSourceNotificationDataChanged(const am_sourceID_t sourceID, const am_NotificationPayload_s& payload) =0;
 125         virtual am_Error_e hookUserSetMainSinkNotificationConfiguration(const am_sinkID_t sinkID, const am_NotificationConfiguration_s& notificationConfiguration) =0;
 126         virtual am_Error_e hookUserSetMainSourceNotificationConfiguration(const am_sourceID_t sourceID, const am_NotificationConfiguration_s& notificationConfiguration) =0;
 127         virtual void hookSystemNodeStateChanged(const NsmNodeState_e NodeStateId) =0;
 128         virtual void hookSystemNodeApplicationModeChanged(const NsmApplicationMode_e ApplicationModeId) =0;
 129         virtual void hookSystemSessionStateChanged(const std::string& sessionName, const NsmSeat_e seatID, const NsmSessionState_e sessionStateID) =0;
 130         virtual NsmErrorStatus_e hookSystemLifecycleRequest(const uint32_t Request, const uint32_t RequestId) =0;
 131
 132 };
 133 }
 134 #endif // !defined(EA_D17C9A1A_AB65_4f6e_A787_51033D190C21__INCLUDED_)