AudioManager  7.6.6
Native Application Runtime Environment
Public Member Functions | List of all members
am::IAmRoutingReceive Class Referenceabstract

Routing Receive sendInterface description. More...

#include <IAmRouting.h>

Inheritance diagram for am::IAmRoutingReceive:
am::CAmRoutingReceiver

Public Member Functions

 IAmRoutingReceive ()
 
virtual ~IAmRoutingReceive ()
 
virtual void getInterfaceVersion (std::string &version) const =0
 This function returns the version of the interface. More...
 
virtual void ackConnect (const am_Handle_s handle, const am_connectionID_t connectionID, const am_Error_e error)=0
 acknowledges a asyncConnect More...
 
virtual void ackDisconnect (const am_Handle_s handle, const am_connectionID_t connectionID, const am_Error_e error)=0
 acknowledges a asyncDisconnect More...
 
virtual void ackSetSinkVolumeChange (const am_Handle_s handle, const am_volume_t volume, const am_Error_e error)=0
 acknowledges a asyncsetSinkVolume More...
 
virtual void ackSetSourceVolumeChange (const am_Handle_s handle, const am_volume_t volume, const am_Error_e error)=0
 acknowledges a asyncsetSourceVolume More...
 
virtual void ackSetSourceState (const am_Handle_s handle, const am_Error_e error)=0
 acknowlegde for asyncSetSourceState More...
 
virtual void ackSetSinkSoundProperties (const am_Handle_s handle, const am_Error_e error)=0
 acknowledges asyncSetSinkSoundProperties More...
 
virtual void ackSetSinkSoundProperty (const am_Handle_s handle, const am_Error_e error)=0
 acknowledges asyncSetSinkSoundProperty More...
 
virtual void ackSetSourceSoundProperties (const am_Handle_s handle, const am_Error_e error)=0
 acknowledges asyncSetSourceSoundProperties More...
 
virtual void ackSetSourceSoundProperty (const am_Handle_s handle, const am_Error_e error)=0
 acknowledges asyncSetSourceSoundProperty More...
 
virtual void ackCrossFading (const am_Handle_s handle, const am_HotSink_e hotSink, const am_Error_e error)=0
 acknowledges asyncCrossFade More...
 
virtual void ackSourceVolumeTick (const am_Handle_s handle, const am_sourceID_t sourceID, const am_volume_t volume)=0
 acknowledges a volume tick. More...
 
virtual void ackSinkVolumeTick (const am_Handle_s handle, const am_sinkID_t sinkID, const am_volume_t volume)=0
 acknowledges a volume tick. More...
 
virtual am_Error_e peekDomain (const std::string &name, am_domainID_t &domainID)=0
 This function returns the ID to the given domainName. More...
 
virtual am_Error_e registerDomain (const am_Domain_s &domainData, am_domainID_t &domainID)=0
 registers a domain More...
 
virtual am_Error_e deregisterDomain (const am_domainID_t domainID)=0
 deregisters a domain. More...
 
virtual am_Error_e registerConverter (const am_Converter_s &converterData, am_converterID_t &converterID)=0
 registers a converter. More...
 
virtual am_Error_e registerGateway (const am_Gateway_s &gatewayData, am_gatewayID_t &gatewayID)=0
 registers a gateway. More...
 
virtual am_Error_e deregisterConverter (const am_converterID_t converterID)=0
 deregisters a converter. More...
 
virtual am_Error_e deregisterGateway (const am_gatewayID_t gatewayID)=0
 deregisters a gateway. More...
 
virtual am_Error_e peekSink (const std::string &name, am_sinkID_t &sinkID)=0
 This function returns the ID to the given sinkName. More...
 
virtual am_Error_e registerSink (const am_Sink_s &sinkData, am_sinkID_t &sinkID)=0
 Registers a sink. More...
 
virtual am_Error_e deregisterSink (const am_sinkID_t sinkID)=0
 deregisters a sink. More...
 
virtual am_Error_e peekSource (const std::string &name, am_sourceID_t &sourceID)=0
 This function returns the ID to the given sourceName. More...
 
virtual am_Error_e registerSource (const am_Source_s &sourceData, am_sourceID_t &sourceID)=0
 registers a source. More...
 
virtual am_Error_e deregisterSource (const am_sourceID_t sourceID)=0
 deregisters a source More...
 
virtual am_Error_e registerCrossfader (const am_Crossfader_s &crossfaderData, am_crossfaderID_t &crossfaderID)=0
 this function registers a crossfader. More...
 
virtual am_Error_e deregisterCrossfader (const am_crossfaderID_t crossfaderID)=0
 this function deregisters a crossfader. More...
 
virtual am_Error_e peekSourceClassID (const std::string &name, am_sourceClass_t &sourceClassID)=0
 this function peeks a sourceclassID. More...
 
virtual am_Error_e peekSinkClassID (const std::string &name, am_sinkClass_t &sinkClassID)=0
 this function peeks a sourceclassID. More...
 
virtual void hookInterruptStatusChange (const am_sourceID_t sourceID, const am_InterruptState_e interruptState)=0
 is called when a low level interrupt changes it status. More...
 
virtual void hookDomainRegistrationComplete (const am_domainID_t domainID)=0
 This hook is called when all elements from a domain are registered. More...
 
virtual void hookSinkAvailablityStatusChange (const am_sinkID_t sinkID, const am_Availability_s &availability)=0
 is called when a sink changes its availability More...
 
virtual void hookSourceAvailablityStatusChange (const am_sourceID_t sourceID, const am_Availability_s &availability)=0
 is called when a source changes its availability More...
 
virtual void hookDomainStateChange (const am_domainID_t domainID, const am_DomainState_e domainState)=0
 is called when a domain changes its status. More...
 
virtual void hookTimingInformationChanged (const am_connectionID_t connectionID, const am_timeSync_t delay)=0
 is called when the timinginformation (delay) changed for a connection. More...
 
virtual void sendChangedData (const std::vector< am_EarlyData_s > &earlyData)=0
 this function is used to send out all data that has been changed in an early state. More...
 
virtual am_Error_e getDBusConnectionWrapper (CAmDbusWrapper *&dbusConnectionWrapper) const =0
 this function is used to retrieve a pointer to the dBusConnectionWrapper More...
 
virtual am_Error_e getSocketHandler (CAmSocketHandler *&socketHandler) const =0
 This function returns the pointer to the socketHandler. More...
 
virtual void confirmRoutingReady (const uint16_t handle, const am_Error_e error)=0
 confirms the setRoutingReady Command More...
 
virtual void confirmRoutingRundown (const uint16_t handle, const am_Error_e error)=0
 confirms the setRoutingRundown Command More...
 
virtual am_Error_e updateConverter (const am_converterID_t converterID, const std::vector< am_CustomConnectionFormat_t > &listSourceFormats, const std::vector< am_CustomConnectionFormat_t > &listSinkFormats, const std::vector< bool > &convertionMatrix)=0
 updates data of an converter. More...
 
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
 updates data of an gateway. More...
 
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
 updates data of an gateway. More...
 
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
 updates data of an source. More...
 
virtual void ackSetVolumes (const am_Handle_s handle, const std::vector< am_Volumes_s > &listvolumes, const am_Error_e error)=0
 acknowledges a asyncSetSinkVolumes More...
 
virtual void ackSinkNotificationConfiguration (const am_Handle_s handle, const am_Error_e error)=0
 The acknowledge of the SinkNotificationConfiguration. More...
 
virtual void ackSourceNotificationConfiguration (const am_Handle_s handle, const am_Error_e error)=0
 The acknowledge of the SourceNotificationConfiguration. More...
 
virtual void hookSinkNotificationDataChange (const am_sinkID_t sinkID, const am_NotificationPayload_s &payload)=0
 is called whenever a notified value needs to be send More...
 
virtual void hookSourceNotificationDataChange (const am_sourceID_t sourceID, const am_NotificationPayload_s &payload)=0
 is called whenever a notified value needs to be send More...
 
virtual am_Error_e getDomainOfSink (const am_sinkID_t sinkID, am_domainID_t &domainID) const =0
 E_OK in case of success. More...
 
virtual am_Error_e getDomainOfSource (const am_sourceID_t sourceID, am_domainID_t &domainID) const =0
 E_OK in case of success. More...
 
virtual am_Error_e getDomainOfCrossfader (const am_crossfaderID_t crossfader, am_domainID_t &domainID) const =0
 E_OK in case of success. More...
 

Detailed Description

Routing Receive sendInterface description.

This class implements everything from RoutingAdapter -> Audiomanager There are two rules that have to be kept in mind when implementing against this interface:

Warning
  1. CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!!
  2. YOU MAY NOT CALL THE CALLING INTERFACE DURING AN SYNCHRONOUS OR ASYNCHRONOUS CALL THAT EXPECTS A RETURN VALUE.

Violation these rules may lead to unexpected behavior! Nevertheless you can implement thread safe by using the deferred-call pattern described on the wiki which also helps to implement calls that are forbidden.
For more information, please check CAmSerializer

Definition at line 56 of file IAmRouting.h.

Constructor & Destructor Documentation

am::IAmRoutingReceive::IAmRoutingReceive ( )
inline

Definition at line 60 of file IAmRouting.h.

virtual am::IAmRoutingReceive::~IAmRoutingReceive ( )
inlinevirtual

Definition at line 64 of file IAmRouting.h.

Member Function Documentation

virtual void am::IAmRoutingReceive::ackConnect ( const am_Handle_s  handle,
const am_connectionID_t  connectionID,
const am_Error_e  error 
)
pure virtual

acknowledges a asyncConnect

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::ackCrossFading ( const am_Handle_s  handle,
const am_HotSink_e  hotSink,
const am_Error_e  error 
)
pure virtual

acknowledges asyncCrossFade

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::ackDisconnect ( const am_Handle_s  handle,
const am_connectionID_t  connectionID,
const am_Error_e  error 
)
pure virtual

acknowledges a asyncDisconnect

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::ackSetSinkSoundProperties ( const am_Handle_s  handle,
const am_Error_e  error 
)
pure virtual

acknowledges asyncSetSinkSoundProperties

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::ackSetSinkSoundProperty ( const am_Handle_s  handle,
const am_Error_e  error 
)
pure virtual

acknowledges asyncSetSinkSoundProperty

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::ackSetSinkVolumeChange ( const am_Handle_s  handle,
const am_volume_t  volume,
const am_Error_e  error 
)
pure virtual

acknowledges a asyncsetSinkVolume

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::ackSetSourceSoundProperties ( const am_Handle_s  handle,
const am_Error_e  error 
)
pure virtual

acknowledges asyncSetSourceSoundProperties

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::ackSetSourceSoundProperty ( const am_Handle_s  handle,
const am_Error_e  error 
)
pure virtual

acknowledges asyncSetSourceSoundProperty

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::ackSetSourceState ( const am_Handle_s  handle,
const am_Error_e  error 
)
pure virtual

acknowlegde for asyncSetSourceState

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::ackSetSourceVolumeChange ( const am_Handle_s  handle,
const am_volume_t  volume,
const am_Error_e  error 
)
pure virtual

acknowledges a asyncsetSourceVolume

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::ackSetVolumes ( const am_Handle_s  handle,
const std::vector< am_Volumes_s > &  listvolumes,
const am_Error_e  error 
)
pure virtual

acknowledges a asyncSetSinkVolumes

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::ackSinkNotificationConfiguration ( const am_Handle_s  handle,
const am_Error_e  error 
)
pure virtual

The acknowledge of the SinkNotificationConfiguration.

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::ackSinkVolumeTick ( const am_Handle_s  handle,
const am_sinkID_t  sinkID,
const am_volume_t  volume 
)
pure virtual

acknowledges a volume tick.

This can be used to display volumechanges during ramps

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::ackSourceNotificationConfiguration ( const am_Handle_s  handle,
const am_Error_e  error 
)
pure virtual

The acknowledge of the SourceNotificationConfiguration.

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::ackSourceVolumeTick ( const am_Handle_s  handle,
const am_sourceID_t  sourceID,
const am_volume_t  volume 
)
pure virtual

acknowledges a volume tick.

This can be used to display volumechanges during ramps

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::confirmRoutingReady ( const uint16_t  handle,
const am_Error_e  error 
)
pure virtual

confirms the setRoutingReady Command

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::confirmRoutingRundown ( const uint16_t  handle,
const am_Error_e  error 
)
pure virtual

confirms the setRoutingRundown Command

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::deregisterConverter ( const am_converterID_t  converterID)
pure virtual

deregisters a converter.

Also removes all sinks and sources of the controlling domain.

Returns
E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::deregisterCrossfader ( const am_crossfaderID_t  crossfaderID)
pure virtual

this function deregisters a crossfader.

removes all sources and sinks assiated as well.

Returns
E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::deregisterDomain ( const am_domainID_t  domainID)
pure virtual

deregisters a domain.

All sources, sinks, gateways and crossfaders from that domain will be removed as well.

Returns
E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::deregisterGateway ( const am_gatewayID_t  gatewayID)
pure virtual

deregisters a gateway.

Also removes all sinks and sources of the controlling domain.

Returns
E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::deregisterSink ( const am_sinkID_t  sinkID)
pure virtual

deregisters a sink.

Returns
E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::deregisterSource ( const am_sourceID_t  sourceID)
pure virtual

deregisters a source

Returns
E_OK on succes, E_NON_EXISTENT if not found E_UNKOWN on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::getDBusConnectionWrapper ( CAmDbusWrapper *&  dbusConnectionWrapper) const
pure virtual

this function is used to retrieve a pointer to the dBusConnectionWrapper

Returns
E_OK if pointer is valid, E_UKNOWN if AudioManager was compiled without DBus Support

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::getDomainOfCrossfader ( const am_crossfaderID_t  crossfader,
am_domainID_t &  domainID 
) const
pure virtual

E_OK in case of success.

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::getDomainOfSink ( const am_sinkID_t  sinkID,
am_domainID_t &  domainID 
) const
pure virtual

E_OK in case of success.

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::getDomainOfSource ( const am_sourceID_t  sourceID,
am_domainID_t &  domainID 
) const
pure virtual

E_OK in case of success.

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::getInterfaceVersion ( std::string &  version) const
pure virtual

This function returns the version of the interface.

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::getSocketHandler ( CAmSocketHandler *&  socketHandler) const
pure virtual

This function returns the pointer to the socketHandler.

This can be used to integrate socket-based activites like communication with the mainloop of the AudioManager. returns E_OK if pointer is valid, E_UNKNOWN in case AudioManager was compiled without socketHandler support,

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::hookDomainRegistrationComplete ( const am_domainID_t  domainID)
pure virtual

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

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::hookDomainStateChange ( const am_domainID_t  domainID,
const am_DomainState_e  domainState 
)
pure virtual

is called when a domain changes its status.

This used for early domains only

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::hookInterruptStatusChange ( const am_sourceID_t  sourceID,
const am_InterruptState_e  interruptState 
)
pure virtual

is called when a low level interrupt changes it status.

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::hookSinkAvailablityStatusChange ( const am_sinkID_t  sinkID,
const am_Availability_s &  availability 
)
pure virtual

is called when a sink changes its availability

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::hookSinkNotificationDataChange ( const am_sinkID_t  sinkID,
const am_NotificationPayload_s &  payload 
)
pure virtual

is called whenever a notified value needs to be send

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::hookSourceAvailablityStatusChange ( const am_sourceID_t  sourceID,
const am_Availability_s &  availability 
)
pure virtual

is called when a source changes its availability

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::hookSourceNotificationDataChange ( const am_sourceID_t  sourceID,
const am_NotificationPayload_s &  payload 
)
pure virtual

is called whenever a notified value needs to be send

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::hookTimingInformationChanged ( const am_connectionID_t  connectionID,
const am_timeSync_t  delay 
)
pure virtual

is called when the timinginformation (delay) changed for a connection.

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::peekDomain ( const std::string &  name,
am_domainID_t &  domainID 
)
pure virtual

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.

Returns
E_OK on success, E_UNKNOWN on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::peekSink ( const std::string &  name,
am_sinkID_t &  sinkID 
)
pure virtual

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.

Returns
E_OK on success, E_UNKNOWN on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::peekSinkClassID ( const std::string &  name,
am_sinkClass_t &  sinkClassID 
)
pure virtual

this function peeks a sourceclassID.

It is used by the RoutingPlugins to determine the SinkClassIDs of a sinkClass.

Returns
E_OK on succes, E_DATABASE_ERROR on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::peekSource ( const std::string &  name,
am_sourceID_t &  sourceID 
)
pure virtual

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.

Returns
E_OK on success, E_UNKNOWN on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::peekSourceClassID ( const std::string &  name,
am_sourceClass_t &  sourceClassID 
)
pure virtual

this function peeks a sourceclassID.

It is used by the RoutingPlugins to determine the SinkClassIDs of a sinkClass.

Returns
E_OK on succes, E_DATABASE_ERROR on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::registerConverter ( const am_Converter_s &  converterData,
am_converterID_t &  converterID 
)
pure virtual

registers a converter.

Returns
E_OK on succes, E_ALREADY_EXISTENT if already registered E_UNKOWN on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::registerCrossfader ( const am_Crossfader_s &  crossfaderData,
am_crossfaderID_t &  crossfaderID 
)
pure virtual

this function registers a crossfader.

Returns
E_OK on succes, E_ALREADY_EXISTENT if already registered E_UNKOWN on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::registerDomain ( const am_Domain_s &  domainData,
am_domainID_t &  domainID 
)
pure virtual

registers a domain

Returns
E_OK on succes, E_ALREADY_EXISTENT if already registered E_UNKOWN on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::registerGateway ( const am_Gateway_s &  gatewayData,
am_gatewayID_t &  gatewayID 
)
pure virtual

registers a gateway.

Returns
E_OK on succes, E_ALREADY_EXISTENT if already registered E_UNKOWN on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::registerSink ( const am_Sink_s &  sinkData,
am_sinkID_t &  sinkID 
)
pure virtual

Registers a sink.

If the sink is part of a gateway, the listconnectionFormats is copied to the gatewayInformation

Returns
E_OK on succes, E_ALREADY_EXISTENT if already registered E_UNKOWN on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::registerSource ( const am_Source_s &  sourceData,
am_sourceID_t &  sourceID 
)
pure virtual

registers a source.

If the source is part of a gateway, the listconnectionFormats is copied to the gatewayInformation

Returns
E_OK on success, E_UNKNOWN on error, E_ALREADY_EXIST if either name or sourceID already exists

Implemented in am::CAmRoutingReceiver.

virtual void am::IAmRoutingReceive::sendChangedData ( const std::vector< am_EarlyData_s > &  earlyData)
pure virtual

this function is used to send out all data that has been changed in an early state.

Returns
E_OK on success, E_UNKNOWN on error

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::updateConverter ( const am_converterID_t  converterID,
const std::vector< am_CustomConnectionFormat_t > &  listSourceFormats,
const std::vector< am_CustomConnectionFormat_t > &  listSinkFormats,
const std::vector< bool > &  convertionMatrix 
)
pure virtual

updates data of an converter.

Returns
E_OK on success, E_NON_EXISTENT if the gatewayID is not valid.

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::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 
)
pure virtual

updates data of an gateway.

Returns
E_OK on success, E_NON_EXISTENT if the gatewayID is not valid.

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::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 
)
pure virtual

updates data of an gateway.

Returns
E_OK on success, E_NON_EXISTENT if the sinkID is not valid.

Implemented in am::CAmRoutingReceiver.

virtual am_Error_e am::IAmRoutingReceive::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 
)
pure virtual

updates data of an source.

Returns
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

Implemented in am::CAmRoutingReceiver.

The documentation for this class was generated from the following file: