This interface is presented by the AudioManager controller. More...

#include <IAmControl.h>

Public Member Functions
	IAmControlSend ()

virtual	~IAmControlSend ()

virtual void	getInterfaceVersion (std::string &version) const =0
	This function returns the version of the interface returns E_OK, E_UNKOWN if version is unknown. More...

virtual am_Error_e	startupController (IAmControlReceive *controlreceiveinterface)=0
	Starts up the controller. More...

virtual void	setControllerReady ()=0
	this message is used tell the controller that it should get ready. More...

virtual void	setControllerRundown (const int16_t signal)=0
	This message tells the controller that he should prepare everything for the power to be switched off. More...

virtual am_Error_e	hookUserConnectionRequest (const am_sourceID_t sourceID, const am_sinkID_t sinkID, am_mainConnectionID_t &mainConnectionID)=0
	is called when a connection request comes in via the command interface More...

virtual am_Error_e	hookUserDisconnectionRequest (const am_mainConnectionID_t connectionID)=0
	is called when a disconnection request comes in via the command interface More...

virtual am_Error_e	hookUserSetMainSinkSoundProperty (const am_sinkID_t sinkID, const am_MainSoundProperty_s &soundProperty)=0
	sets a user MainSinkSoundProperty More...

virtual am_Error_e	hookUserSetMainSourceSoundProperty (const am_sourceID_t sourceID, const am_MainSoundProperty_s &soundProperty)=0
	sets a user MainSourceSoundProperty More...

virtual am_Error_e	hookUserSetSystemProperty (const am_SystemProperty_s &property)=0
	sets a user SystemProperty More...

virtual am_Error_e	hookUserVolumeChange (const am_sinkID_t SinkID, const am_mainVolume_t newVolume)=0
	sets a user volume More...

virtual am_Error_e	hookUserVolumeStep (const am_sinkID_t SinkID, const int16_t increment)=0
	sets a user volume as increment More...

virtual am_Error_e	hookUserSetSinkMuteState (const am_sinkID_t sinkID, const am_MuteState_e muteState)=0
	sets the mute state of a sink More...

virtual am_Error_e	hookSystemRegisterDomain (const am_Domain_s &domainData, am_domainID_t &domainID)=0
	is called when a routing adaptor registers its domain More...

virtual am_Error_e	hookSystemDeregisterDomain (const am_domainID_t domainID)=0
	is called when a routing adaptor wants to derigister a domain More...

virtual void	hookSystemDomainRegistrationComplete (const am_domainID_t domainID)=0
	is called when a domain registered all the elements More...

virtual am_Error_e	hookSystemRegisterSink (const am_Sink_s &sinkData, am_sinkID_t &sinkID)=0
	is called when a routing adaptor registers a sink More...

virtual am_Error_e	hookSystemDeregisterSink (const am_sinkID_t sinkID)=0
	is called when a routing adaptor deregisters a sink More...

virtual am_Error_e	hookSystemRegisterSource (const am_Source_s &sourceData, am_sourceID_t &sourceID)=0
	is called when a routing adaptor registers a source More...

virtual am_Error_e	hookSystemDeregisterSource (const am_sourceID_t sourceID)=0
	is called when a routing adaptor deregisters a source More...

virtual am_Error_e	hookSystemRegisterConverter (const am_Converter_s &converterData, am_converterID_t &converterID)=0
	is called when a routing adaptor registers a converter More...

virtual am_Error_e	hookSystemRegisterGateway (const am_Gateway_s &gatewayData, am_gatewayID_t &gatewayID)=0
	is called when a routing adaptor registers a gateway More...

virtual am_Error_e	hookSystemDeregisterConverter (const am_converterID_t converterID)=0
	is called when a routing adaptor deregisters a converter More...

virtual am_Error_e	hookSystemDeregisterGateway (const am_gatewayID_t gatewayID)=0
	is called when a routing adaptor deregisters a gateway More...

virtual am_Error_e	hookSystemRegisterCrossfader (const am_Crossfader_s &crossfaderData, am_crossfaderID_t &crossfaderID)=0
	is called when a routing adaptor registers a crossfader More...

virtual am_Error_e	hookSystemDeregisterCrossfader (const am_crossfaderID_t crossfaderID)=0
	is called when a routing adaptor deregisters a crossfader More...

virtual void	hookSystemSinkVolumeTick (const am_Handle_s handle, const am_sinkID_t sinkID, const am_volume_t volume)=0
	volumeticks. More...

virtual void	hookSystemSourceVolumeTick (const am_Handle_s handle, const am_sourceID_t sourceID, const am_volume_t volume)=0
	volumeticks. More...

virtual void	hookSystemInterruptStateChange (const am_sourceID_t sourceID, const am_InterruptState_e interruptState)=0
	is called when an low level interrupt changed its state More...

virtual void	hookSystemSinkAvailablityStateChange (const am_sinkID_t sinkID, const am_Availability_s &availability)=0
	id called when a sink changed its availability More...

virtual void	hookSystemSourceAvailablityStateChange (const am_sourceID_t sourceID, const am_Availability_s &availability)=0
	id called when a source changed its availability More...

virtual void	hookSystemDomainStateChange (const am_domainID_t domainID, const am_DomainState_e state)=0
	id called when domainstate was changed More...

virtual void	hookSystemReceiveEarlyData (const std::vector< am_EarlyData_s > &data)=0
	when early data was received More...

virtual void	hookSystemSpeedChange (const am_speed_t speed)=0
	this hook provides information about speed changes. More...

virtual void	hookSystemTimingInformationChanged (const am_mainConnectionID_t mainConnectionID, const am_timeSync_t time)=0
	this hook is fired whenever the timing information of a mainconnection has changed. More...

virtual void	cbAckConnect (const am_Handle_s handle, const am_Error_e errorID)=0
	ack for connect More...

virtual void	cbAckDisconnect (const am_Handle_s handle, const am_Error_e errorID)=0
	ack for disconnect More...

virtual void	cbAckCrossFade (const am_Handle_s handle, const am_HotSink_e hostsink, const am_Error_e error)=0
	ack for crossfading More...

virtual void	cbAckSetSinkVolumeChange (const am_Handle_s handle, const am_volume_t volume, const am_Error_e error)=0
	ack for sink volume changes More...

virtual void	cbAckSetSourceVolumeChange (const am_Handle_s handle, const am_volume_t voulme, const am_Error_e error)=0
	ack for source volume changes More...

virtual void	cbAckSetSourceState (const am_Handle_s handle, const am_Error_e error)=0
	ack for setting of source states More...

virtual void	cbAckSetSourceSoundProperties (const am_Handle_s handle, const am_Error_e error)=0
	ack for setting of sourcesoundproperties More...

virtual void	cbAckSetSourceSoundProperty (const am_Handle_s handle, const am_Error_e error)=0
	ack for setting of sourcesoundproperties More...

virtual void	cbAckSetSinkSoundProperties (const am_Handle_s handle, const am_Error_e error)=0
	ack for setting of sinksoundproperties More...

virtual void	cbAckSetSinkSoundProperty (const am_Handle_s handle, const am_Error_e error)=0
	ack for setting of sinksoundproperties More...

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
	This function is used by the routing algorithm to retrieve a priorized list of connectionFormats from the Controller. More...

virtual void	confirmCommandReady (const am_Error_e error)=0
	confirms the setCommandReady call More...

virtual void	confirmRoutingReady (const am_Error_e error)=0
	confirms the setRoutingReady call More...

virtual void	confirmCommandRundown (const am_Error_e error)=0
	confirms the setCommandRundown call More...

virtual void	confirmRoutingRundown (const am_Error_e error)=0
	confirms the setRoutingRundown command More...

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
	update form the SinkData More...

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
	update from the source Data More...

virtual am_Error_e	hookSystemUpdateConverter (const am_converterID_t converterID, const std::vector< am_CustomConnectionFormat_t > &listSourceConnectionFormats, const std::vector< am_CustomConnectionFormat_t > &listSinkConnectionFormats, const std::vector< bool > &convertionMatrix)=0
	updates the Converter Data More...

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
	updates the Gateway Data More...

virtual void	cbAckSetVolumes (const am_Handle_s handle, const std::vector< am_Volumes_s > &listVolumes, const am_Error_e error)=0
	ack for mulitple volume changes More...

virtual void	cbAckSetSinkNotificationConfiguration (const am_Handle_s handle, const am_Error_e error)=0
	The acknowledge of the sink notification configuration. More...

virtual void	cbAckSetSourceNotificationConfiguration (const am_Handle_s handle, const am_Error_e error)=0
	The acknowledge of the source notification configuration. More...

virtual void	hookSinkNotificationDataChanged (const am_sinkID_t sinkID, const am_NotificationPayload_s &payload)=0
	new sinkNotification data is there! More...

virtual void	hookSourceNotificationDataChanged (const am_sourceID_t sourceID, const am_NotificationPayload_s &payload)=0
	new sourceNotification data is there! More...

virtual am_Error_e	hookUserSetMainSinkNotificationConfiguration (const am_sinkID_t sinkID, const am_NotificationConfiguration_s &notificationConfiguration)=0
	sets a user MainSinkNotificationConfiguration More...

virtual am_Error_e	hookUserSetMainSourceNotificationConfiguration (const am_sourceID_t sourceID, const am_NotificationConfiguration_s &notificationConfiguration)=0
	sets a user MainSourceNotificationConfiguration More...

virtual void	hookSystemSingleTimingInformationChanged (const am_connectionID_t connectionID, const am_timeSync_t time)=0
	This hook is fired whenever the timing information of a connection has changed. More...

Detailed Description

This interface is presented by the AudioManager controller.

All the hooks represent system events that need to be handled. The callback functions are used to handle for example answers to function calls on the AudioManagerCoreInterface. 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 675 of file IAmControl.h.

Constructor & Destructor Documentation

am::IAmControlSend::IAmControlSend ( )

inline

Definition at line 679 of file IAmControl.h.

virtual am::IAmControlSend::~IAmControlSend ( )

inlinevirtual

Definition at line 683 of file IAmControl.h.

Member Function Documentation

virtual void am::IAmControlSend::cbAckConnect	(	const am_Handle_s	handle,
		const am_Error_e	errorID
	)

pure virtual

ack for connect

virtual void am::IAmControlSend::cbAckCrossFade	(	const am_Handle_s	handle,
		const am_HotSink_e	hostsink,
		const am_Error_e	error
	)

pure virtual

ack for crossfading

virtual void am::IAmControlSend::cbAckDisconnect	(	const am_Handle_s	handle,
		const am_Error_e	errorID
	)

pure virtual

ack for disconnect

virtual void am::IAmControlSend::cbAckSetSinkNotificationConfiguration	(	const am_Handle_s	handle,
		const am_Error_e	error
	)

pure virtual

The acknowledge of the sink notification configuration.

virtual void am::IAmControlSend::cbAckSetSinkSoundProperties	(	const am_Handle_s	handle,
		const am_Error_e	error
	)

pure virtual

ack for setting of sinksoundproperties

virtual void am::IAmControlSend::cbAckSetSinkSoundProperty	(	const am_Handle_s	handle,
		const am_Error_e	error
	)

pure virtual

ack for setting of sinksoundproperties

virtual void am::IAmControlSend::cbAckSetSinkVolumeChange	(	const am_Handle_s	handle,
		const am_volume_t	volume,
		const am_Error_e	error
	)

pure virtual

ack for sink volume changes

virtual void am::IAmControlSend::cbAckSetSourceNotificationConfiguration	(	const am_Handle_s	handle,
		const am_Error_e	error
	)

pure virtual

The acknowledge of the source notification configuration.

virtual void am::IAmControlSend::cbAckSetSourceSoundProperties	(	const am_Handle_s	handle,
		const am_Error_e	error
	)

pure virtual

ack for setting of sourcesoundproperties

virtual void am::IAmControlSend::cbAckSetSourceSoundProperty	(	const am_Handle_s	handle,
		const am_Error_e	error
	)

pure virtual

ack for setting of sourcesoundproperties

virtual void am::IAmControlSend::cbAckSetSourceState	(	const am_Handle_s	handle,
		const am_Error_e	error
	)

pure virtual

ack for setting of source states

virtual void am::IAmControlSend::cbAckSetSourceVolumeChange	(	const am_Handle_s	handle,
		const am_volume_t	voulme,
		const am_Error_e	error
	)

pure virtual

ack for source volume changes

virtual void am::IAmControlSend::cbAckSetVolumes	(	const am_Handle_s	handle,
		const std::vector< am_Volumes_s > &	listVolumes,
		const am_Error_e	error
	)

pure virtual

ack for mulitple volume changes

virtual void am::IAmControlSend::confirmCommandReady ( const am_Error_e error )

pure virtual

confirms the setCommandReady call

virtual void am::IAmControlSend::confirmCommandRundown ( const am_Error_e error )

pure virtual

confirms the setCommandRundown call

virtual void am::IAmControlSend::confirmRoutingReady ( const am_Error_e error )

pure virtual

confirms the setRoutingReady call

virtual void am::IAmControlSend::confirmRoutingRundown ( const am_Error_e error )

pure virtual

confirms the setRoutingRundown command

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

pure virtual

This function is used by the routing algorithm to retrieve a priorized list of connectionFormats from the Controller.

Returns: E_OK in case of successfull priorisation.

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

pure virtual

This function returns the version of the interface returns E_OK, E_UNKOWN if version is unknown.

virtual void am::IAmControlSend::hookSinkNotificationDataChanged	(	const am_sinkID_t	sinkID,
		const am_NotificationPayload_s &	payload
	)

pure virtual

new sinkNotification data is there!

virtual void am::IAmControlSend::hookSourceNotificationDataChanged	(	const am_sourceID_t	sourceID,
		const am_NotificationPayload_s &	payload
	)

pure virtual

new sourceNotification data is there!

virtual am_Error_e am::IAmControlSend::hookSystemDeregisterConverter ( const am_converterID_t converterID )

pure virtual

is called when a routing adaptor deregisters a converter

Returns: E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if not found

virtual am_Error_e am::IAmControlSend::hookSystemDeregisterCrossfader ( const am_crossfaderID_t crossfaderID )

pure virtual

is called when a routing adaptor deregisters a crossfader

Returns: E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if not found

virtual am_Error_e am::IAmControlSend::hookSystemDeregisterDomain ( const am_domainID_t domainID )

pure virtual

is called when a routing adaptor wants to derigister a domain

Returns: E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if not found

virtual am_Error_e am::IAmControlSend::hookSystemDeregisterGateway ( const am_gatewayID_t gatewayID )

pure virtual

is called when a routing adaptor deregisters a gateway

Returns: E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if not found

virtual am_Error_e am::IAmControlSend::hookSystemDeregisterSink ( const am_sinkID_t sinkID )

pure virtual

is called when a routing adaptor deregisters a sink

Returns: E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if not found

virtual am_Error_e am::IAmControlSend::hookSystemDeregisterSource ( const am_sourceID_t sourceID )

pure virtual

is called when a routing adaptor deregisters a source

Returns: E_OK on success, E_UNKNOWN on error, E_NON_EXISTENT if not found

virtual void am::IAmControlSend::hookSystemDomainRegistrationComplete ( const am_domainID_t domainID )

pure virtual

is called when a domain registered all the elements

virtual void am::IAmControlSend::hookSystemDomainStateChange	(	const am_domainID_t	domainID,
		const am_DomainState_e	state
	)

pure virtual

id called when domainstate was changed

virtual void am::IAmControlSend::hookSystemInterruptStateChange	(	const am_sourceID_t	sourceID,
		const am_InterruptState_e	interruptState
	)

pure virtual

is called when an low level interrupt changed its state

virtual void am::IAmControlSend::hookSystemReceiveEarlyData ( const std::vector< am_EarlyData_s > & data )

pure virtual

when early data was received

virtual am_Error_e am::IAmControlSend::hookSystemRegisterConverter	(	const am_Converter_s &	converterData,
		am_converterID_t &	converterID
	)

pure virtual

is called when a routing adaptor registers a converter

Returns: E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists

virtual am_Error_e am::IAmControlSend::hookSystemRegisterCrossfader	(	const am_Crossfader_s &	crossfaderData,
		am_crossfaderID_t &	crossfaderID
	)

pure virtual

is called when a routing adaptor registers a crossfader

Returns: E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists

virtual am_Error_e am::IAmControlSend::hookSystemRegisterDomain	(	const am_Domain_s &	domainData,
		am_domainID_t &	domainID
	)

pure virtual

is called when a routing adaptor registers its domain

Returns: E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists

virtual am_Error_e am::IAmControlSend::hookSystemRegisterGateway	(	const am_Gateway_s &	gatewayData,
		am_gatewayID_t &	gatewayID
	)

pure virtual

is called when a routing adaptor registers a gateway

Returns: E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists

virtual am_Error_e am::IAmControlSend::hookSystemRegisterSink	(	const am_Sink_s &	sinkData,
		am_sinkID_t &	sinkID
	)

pure virtual

is called when a routing adaptor registers a sink

Returns: E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists

virtual am_Error_e am::IAmControlSend::hookSystemRegisterSource	(	const am_Source_s &	sourceData,
		am_sourceID_t &	sourceID
	)

pure virtual

is called when a routing adaptor registers a source

Returns: E_OK on success, E_UNKNOWN on error, E_ALREADY_EXISTENT if already exists

virtual void am::IAmControlSend::hookSystemSingleTimingInformationChanged	(	const am_connectionID_t	connectionID,
		const am_timeSync_t	time
	)

pure virtual

This hook is fired whenever the timing information of a connection has changed.

virtual void am::IAmControlSend::hookSystemSinkAvailablityStateChange	(	const am_sinkID_t	sinkID,
		const am_Availability_s &	availability
	)

pure virtual

id called when a sink changed its availability

virtual void am::IAmControlSend::hookSystemSinkVolumeTick	(	const am_Handle_s	handle,
		const am_sinkID_t	sinkID,
		const am_volume_t	volume
	)

pure virtual

volumeticks.

therse are used to indicate volumechanges during a ramp

virtual void am::IAmControlSend::hookSystemSourceAvailablityStateChange	(	const am_sourceID_t	sourceID,
		const am_Availability_s &	availability
	)

pure virtual

id called when a source changed its availability

virtual void am::IAmControlSend::hookSystemSourceVolumeTick	(	const am_Handle_s	handle,
		const am_sourceID_t	sourceID,
		const am_volume_t	volume
	)

pure virtual

volumeticks.

therse are used to indicate volumechanges during a ramp

virtual void am::IAmControlSend::hookSystemSpeedChange ( const am_speed_t speed )

pure virtual

this hook provides information about speed changes.

The quantization and sampling rate of the speed can be adjusted at compile time of the AudioManagerDaemon.

virtual void am::IAmControlSend::hookSystemTimingInformationChanged	(	const am_mainConnectionID_t	mainConnectionID,
		const am_timeSync_t	time
	)

pure virtual

this hook is fired whenever the timing information of a mainconnection has changed.

virtual am_Error_e am::IAmControlSend::hookSystemUpdateConverter	(	const am_converterID_t	converterID,
		const std::vector< am_CustomConnectionFormat_t > &	listSourceConnectionFormats,
		const std::vector< am_CustomConnectionFormat_t > &	listSinkConnectionFormats,
		const std::vector< bool > &	convertionMatrix
	)

pure virtual

updates the Converter Data

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

pure virtual

updates the Gateway Data

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

pure virtual

update form the SinkData

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

pure virtual

update from the source Data

virtual am_Error_e am::IAmControlSend::hookUserConnectionRequest	(	const am_sourceID_t	sourceID,
		const am_sinkID_t	sinkID,
		am_mainConnectionID_t &	mainConnectionID
	)

pure virtual

is called when a connection request comes in via the command interface

Returns: E_OK on success, E_NOT_POSSIBLE on error, E_ALREADY_EXISTENT if already exists

virtual am_Error_e am::IAmControlSend::hookUserDisconnectionRequest ( const am_mainConnectionID_t connectionID )

pure virtual

is called when a disconnection request comes in via the command interface

Returns: E_OK on success, E_NOT_POSSIBLE on error, E_NON_EXISTENT if connection does not exists

virtual am_Error_e am::IAmControlSend::hookUserSetMainSinkNotificationConfiguration	(	const am_sinkID_t	sinkID,
		const am_NotificationConfiguration_s &	notificationConfiguration
	)

pure virtual

sets a user MainSinkNotificationConfiguration

Returns: E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error

virtual am_Error_e am::IAmControlSend::hookUserSetMainSinkSoundProperty	(	const am_sinkID_t	sinkID,
		const am_MainSoundProperty_s &	soundProperty
	)

pure virtual

sets a user MainSinkSoundProperty

Returns: E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error

virtual am_Error_e am::IAmControlSend::hookUserSetMainSourceNotificationConfiguration	(	const am_sourceID_t	sourceID,
		const am_NotificationConfiguration_s &	notificationConfiguration
	)

pure virtual

sets a user MainSourceNotificationConfiguration

Returns: E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error

virtual am_Error_e am::IAmControlSend::hookUserSetMainSourceSoundProperty	(	const am_sourceID_t	sourceID,
		const am_MainSoundProperty_s &	soundProperty
	)

pure virtual

sets a user MainSourceSoundProperty

Returns: E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error

virtual am_Error_e am::IAmControlSend::hookUserSetSinkMuteState	(	const am_sinkID_t	sinkID,
		const am_MuteState_e	muteState
	)

pure virtual

sets the mute state of a sink

Returns: E_OK on success, E_UNKNOWN on error

virtual am_Error_e am::IAmControlSend::hookUserSetSystemProperty ( const am_SystemProperty_s & property )

pure virtual

sets a user SystemProperty

Returns: E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error

virtual am_Error_e am::IAmControlSend::hookUserVolumeChange	(	const am_sinkID_t	SinkID,
		const am_mainVolume_t	newVolume
	)

pure virtual

sets a user volume

Returns: E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error

virtual am_Error_e am::IAmControlSend::hookUserVolumeStep	(	const am_sinkID_t	SinkID,
		const int16_t	increment
	)

pure virtual

sets a user volume as increment

Returns: E_OK on success, E_OUT_OF_RANGE if out of range, E_UNKNOWN on error

virtual void am::IAmControlSend::setControllerReady ( )

pure virtual

this message is used tell the controller that it should get ready.

This message must be acknowledged via confirmControllerReady.

virtual void am::IAmControlSend::setControllerRundown ( const int16_t signal )

pure virtual

This message tells the controller that he should prepare everything for the power to be switched off.

This message must be acknowledged via confirmControllerRundown. The method will give the signal as integer that was responsible for calling the setControllerRundown. This function is called from the signal handler, either direct (when the program is killed) or from within the mainloop (if the program is terminated).

virtual am_Error_e am::IAmControlSend::startupController ( IAmControlReceive * controlreceiveinterface )

pure virtual

Starts up the controller.

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

include/IAmControl.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation