am::am_Crossfader_s Struct Reference

This struct describes the attribiutes of a crossfader. More...

#include <audiomanagertypes.h>

Public Attributes
am_crossfaderID_t	crossfaderID
	This is the ID of the crossfader, it is unique in the system. More...
std::string	name
	The name of the crossfader. More...
am_sinkID_t	sinkID_A
	The sinkID of the SinkA. More...
am_sinkID_t	sinkID_B
	The sinkID of the SinkB. More...
am_sourceID_t	sourceID
	The sourceID of the crossfader source. More...
am_HotSink_e	hotSink
	This enum can have 3 states: More...

Detailed Description

This struct describes the attribiutes of a crossfader.

Definition at line 560 of file audiomanagertypes.h.

Member Data Documentation

am_crossfaderID_t am::am_Crossfader_s::crossfaderID

This is the ID of the crossfader, it is unique in the system.

There are 2 ways, ID can be created: either it is assigned during the registration process (in a dynamic context, uniqueness will be ensured by the AudioManager daemon), or it is a fixed (the project has to ensure the uniqueness of the ID).

Definition at line 570 of file audiomanagertypes.h.

am_HotSink_e am::am_Crossfader_s::hotSink

This enum can have 3 states:

HS_SINKA sinkA is the current hot one, sinkB is not audible HS_SINKB sinkB is the current hot one, sinkB is not audible HS_INTERMEDIATE the fader is stuck in between a cross-fading action. This could be due to an abort or an error. Before using the crossfader, it must be set to either HS_SINKA or HS_SINKB.

Definition at line 599 of file audiomanagertypes.h.

std::string am::am_Crossfader_s::name

The name of the crossfader.

Must be unique in the whole system.

Definition at line 574 of file audiomanagertypes.h.

am_sinkID_t am::am_Crossfader_s::sinkID_A

The sinkID of the SinkA.

Sinks shall be registered before registering the crossfader.

Definition at line 579 of file audiomanagertypes.h.

am_sinkID_t am::am_Crossfader_s::sinkID_B

The sinkID of the SinkB.

Sinks shall be registered before registering the crossfader.

Definition at line 584 of file audiomanagertypes.h.

am_sourceID_t am::am_Crossfader_s::sourceID

The sourceID of the crossfader source.

The source shall be registered before the crossfader.

Definition at line 589 of file audiomanagertypes.h.

---

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

• include/audiomanagertypes.h