This interface handles all communication from the AudioManagerDaemon towards the system. More...

#include <IAmCommand.h>

Public Member Functions
	IAmCommandSend ()

virtual	~IAmCommandSend ()

virtual void	getInterfaceVersion (std::string &version) const =0
	returns the interface version as string. More...

virtual am_Error_e	startupInterface (IAmCommandReceive *commandreceiveinterface)=0
	This command starts the interface, the plugin itself. More...

virtual void	setCommandReady (const uint16_t handle)=0
	This function will indirectly be called by the Controller and is used to start the Communication. More...

virtual void	setCommandRundown (const uint16_t handle)=0
	This function will indirectly be called by the Controller and is used to stop the Communication. More...

virtual void	cbNewMainConnection (const am_MainConnectionType_s &mainConnection)=0
	Callback that is called when the number of connections change. More...

virtual void	cbRemovedMainConnection (const am_mainConnectionID_t mainConnection)=0
	Callback that is called when the number of connections change. More...

virtual void	cbNewSink (const am_SinkType_s &sink)=0
	Callback that is called when the number of sinks change. More...

virtual void	cbRemovedSink (const am_sinkID_t sinkID)=0
	Callback that is called when the number of sinks change. More...

virtual void	cbNewSource (const am_SourceType_s &source)=0
	Callback that is called when the number of sources change. More...

virtual void	cbRemovedSource (const am_sourceID_t source)=0
	Callback that is called when the number of sources change. More...

virtual void	cbNumberOfSinkClassesChanged ()=0
	this callback is fired if the number of sink classes changed More...

virtual void	cbNumberOfSourceClassesChanged ()=0
	this callback is fired if the number of source classes changed More...

virtual void	cbMainConnectionStateChanged (const am_mainConnectionID_t connectionID, const am_ConnectionState_e connectionState)=0
	This callback is called when the ConnectionState of a connection changed. More...

virtual void	cbMainSinkSoundPropertyChanged (const am_sinkID_t sinkID, const am_MainSoundProperty_s &soundProperty)=0
	this callback indicates that a sinkSoundProperty has changed. More...

virtual void	cbMainSourceSoundPropertyChanged (const am_sourceID_t sourceID, const am_MainSoundProperty_s &soundProperty)=0
	this callback indicates that a sourceSoundProperty has changed. More...

virtual void	cbSinkAvailabilityChanged (const am_sinkID_t sinkID, const am_Availability_s &availability)=0
	this callback is called when the availability of a sink has changed More...

virtual void	cbSourceAvailabilityChanged (const am_sourceID_t sourceID, const am_Availability_s &availability)=0
	this callback is called when the availability of source has changed. More...

virtual void	cbVolumeChanged (const am_sinkID_t sinkID, const am_mainVolume_t volume)=0
	this callback indicates a volume change on the indicated sink More...

virtual void	cbSinkMuteStateChanged (const am_sinkID_t sinkID, const am_MuteState_e muteState)=0
	this callback indicates a mute state change on a sink. More...

virtual void	cbSystemPropertyChanged (const am_SystemProperty_s &systemProperty)=0
	is fired if a systemProperty changed More...

virtual void	cbTimingInformationChanged (const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time)=0
	This callback is fired if the timinginformation for a mainConnectionID changed. More...

virtual void	cbSinkUpdated (const am_sinkID_t sinkID, const am_sinkClass_t sinkClassID, const std::vector< am_MainSoundProperty_s > &listMainSoundProperties)=0
	This callback is called when a sink is updated. More...

virtual void	cbSourceUpdated (const am_sourceID_t sourceID, const am_sourceClass_t sourceClassID, const std::vector< am_MainSoundProperty_s > &listMainSoundProperties)=0
	This callback is called when a source is updated. More...

virtual void	cbSinkNotification (const am_sinkID_t sinkID, const am_NotificationPayload_s &notification)=0
	This callback is called when a notificated value of a sink changes. More...

virtual void	cbSourceNotification (const am_sourceID_t sourceID, const am_NotificationPayload_s &notification)=0
	This callback is called when a notifcated value of a source changes. More...

virtual void	cbMainSinkNotificationConfigurationChanged (const am_sinkID_t sinkID, const am_NotificationConfiguration_s &mainNotificationConfiguration)=0
	This callback is triggered when a mainNotificationConfiguration is changed. More...

virtual void	cbMainSourceNotificationConfigurationChanged (const am_sourceID_t sourceID, const am_NotificationConfiguration_s &mainNotificationConfiguration)=0
	This callback is triggered when a mainNotificationConfiguration is changed. More...

Detailed Description

This interface handles all communication from the AudioManagerDaemon towards the system.

It is designed in such a way that only callbacks with no return types are implemented. So when the CommandInterfacePlugins are designed in such a way that they broadcast signals to any node who is interested in the particular information (like signals on Dbus for example), more information can be retrieved via the CommandReceiveInterface. There are two rules that have to be kept in mind when implementing against this interface:

Warning

CALLS TO THIS INTERFACE ARE NOT THREAD SAFE !!!!
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 243 of file IAmCommand.h.

Constructor & Destructor Documentation

am::IAmCommandSend::IAmCommandSend ( )

inline

Definition at line 247 of file IAmCommand.h.

virtual am::IAmCommandSend::~IAmCommandSend ( )

inlinevirtual

Definition at line 251 of file IAmCommand.h.

Member Function Documentation

virtual void am::IAmCommandSend::cbMainConnectionStateChanged	(	const am_mainConnectionID_t	connectionID,
		const am_ConnectionState_e	connectionState
	)

pure virtual

This callback is called when the ConnectionState of a connection changed.

virtual void am::IAmCommandSend::cbMainSinkNotificationConfigurationChanged	(	const am_sinkID_t	sinkID,
		const am_NotificationConfiguration_s &	mainNotificationConfiguration
	)

pure virtual

This callback is triggered when a mainNotificationConfiguration is changed.

virtual void am::IAmCommandSend::cbMainSinkSoundPropertyChanged	(	const am_sinkID_t	sinkID,
		const am_MainSoundProperty_s &	soundProperty
	)

pure virtual

this callback indicates that a sinkSoundProperty has changed.

virtual void am::IAmCommandSend::cbMainSourceNotificationConfigurationChanged	(	const am_sourceID_t	sourceID,
		const am_NotificationConfiguration_s &	mainNotificationConfiguration
	)

pure virtual

This callback is triggered when a mainNotificationConfiguration is changed.

virtual void am::IAmCommandSend::cbMainSourceSoundPropertyChanged	(	const am_sourceID_t	sourceID,
		const am_MainSoundProperty_s &	soundProperty
	)

pure virtual

this callback indicates that a sourceSoundProperty has changed.

virtual void am::IAmCommandSend::cbNewMainConnection ( const am_MainConnectionType_s & mainConnection )

pure virtual

Callback that is called when the number of connections change.

virtual void am::IAmCommandSend::cbNewSink ( const am_SinkType_s & sink )

pure virtual

Callback that is called when the number of sinks change.

virtual void am::IAmCommandSend::cbNewSource ( const am_SourceType_s & source )

pure virtual

Callback that is called when the number of sources change.

virtual void am::IAmCommandSend::cbNumberOfSinkClassesChanged ( )

pure virtual

this callback is fired if the number of sink classes changed

virtual void am::IAmCommandSend::cbNumberOfSourceClassesChanged ( )

pure virtual

this callback is fired if the number of source classes changed

virtual void am::IAmCommandSend::cbRemovedMainConnection ( const am_mainConnectionID_t mainConnection )

pure virtual

Callback that is called when the number of connections change.

virtual void am::IAmCommandSend::cbRemovedSink ( const am_sinkID_t sinkID )

pure virtual

Callback that is called when the number of sinks change.

virtual void am::IAmCommandSend::cbRemovedSource ( const am_sourceID_t source )

pure virtual

Callback that is called when the number of sources change.

virtual void am::IAmCommandSend::cbSinkAvailabilityChanged	(	const am_sinkID_t	sinkID,
		const am_Availability_s &	availability
	)

pure virtual

this callback is called when the availability of a sink has changed

virtual void am::IAmCommandSend::cbSinkMuteStateChanged	(	const am_sinkID_t	sinkID,
		const am_MuteState_e	muteState
	)

pure virtual

this callback indicates a mute state change on a sink.

virtual void am::IAmCommandSend::cbSinkNotification	(	const am_sinkID_t	sinkID,
		const am_NotificationPayload_s &	notification
	)

pure virtual

This callback is called when a notificated value of a sink changes.

virtual void am::IAmCommandSend::cbSinkUpdated	(	const am_sinkID_t	sinkID,
		const am_sinkClass_t	sinkClassID,
		const std::vector< am_MainSoundProperty_s > &	listMainSoundProperties
	)

pure virtual

This callback is called when a sink is updated.

virtual void am::IAmCommandSend::cbSourceAvailabilityChanged	(	const am_sourceID_t	sourceID,
		const am_Availability_s &	availability
	)

pure virtual

this callback is called when the availability of source has changed.

virtual void am::IAmCommandSend::cbSourceNotification	(	const am_sourceID_t	sourceID,
		const am_NotificationPayload_s &	notification
	)

pure virtual

This callback is called when a notifcated value of a source changes.

virtual void am::IAmCommandSend::cbSourceUpdated	(	const am_sourceID_t	sourceID,
		const am_sourceClass_t	sourceClassID,
		const std::vector< am_MainSoundProperty_s > &	listMainSoundProperties
	)

pure virtual

This callback is called when a source is updated.

virtual void am::IAmCommandSend::cbSystemPropertyChanged ( const am_SystemProperty_s & systemProperty )

pure virtual

is fired if a systemProperty changed

virtual void am::IAmCommandSend::cbTimingInformationChanged	(	const am_mainConnectionID_t	mainConnectionID,
		const am_timeSync_t	time
	)

pure virtual

This callback is fired if the timinginformation for a mainConnectionID changed.

virtual void am::IAmCommandSend::cbVolumeChanged	(	const am_sinkID_t	sinkID,
		const am_mainVolume_t	volume
	)

pure virtual

this callback indicates a volume change on the indicated sink

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

pure virtual

returns the interface version as string.

virtual void am::IAmCommandSend::setCommandReady ( const uint16_t handle )

pure virtual

This function will indirectly be called by the Controller and is used to start the Communication.

Before this command, all communication will be ignored by the AudioManager. After the Plugin is ready, it will asynchronously answer with condfirmCommandReady, the handle that is handed over must be returned.

virtual void am::IAmCommandSend::setCommandRundown ( const uint16_t handle )

pure virtual

This function will indirectly be called by the Controller and is used to stop the Communication.

After this command, all communication will be ignored by the AudioManager. The plugin has to be prepared that either the power will be switched off or the Interface is started again with setCommandReady After the Plugin is ready to rundown, it will asynchronously answer with condfirmCommandRundown, the handle that is handed over must be returned.

virtual am_Error_e am::IAmCommandSend::startupInterface ( IAmCommandReceive * commandreceiveinterface )

pure virtual

This command starts the interface, the plugin itself.

This is not meant to start communication with the HMI itself. It is a good idea to implement here everything that sets up the basic communication like DbusCommunication etc... Be aware of side effects with systemd and socketbased communication!

Returns: E_OK on success, E_UNKNOWN on error

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

include/IAmCommand.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation