Skip to content

Latest commit

 

History

History
127 lines (91 loc) · 3.32 KB

ns-acxelements-acx_audioengine_config.md

File metadata and controls

127 lines (91 loc) · 3.32 KB
Raw
UID tech.root title ms.date targetos description prerelease req.construct-type req.ddi-compliance req.dll req.header req.include-header req.kmdf-ver req.lib req.max-support req.redist req.target-min-winverclnt req.target-min-winversvr req.target-type req.typenames req.umdf-ver req.unicode-ansi topic_type api_type api_location api_name f1_keywords dev_langs
NS:acxelements._ACX_AUDIOENGINE_CONFIG
audio
ACX_AUDIOENGINE_CONFIG
04/29/2022
Windows
The ACX_AUDIOENGINE_CONFIG structure is used to define the audio engine configuration.
false
structure
acxelements.h
ACX_AUDIOENGINE_CONFIG, *PACX_AUDIOENGINE_CONFIG
apiref
HeaderDef
acxelements.h
_ACX_AUDIOENGINE_CONFIG
PACX_AUDIOENGINE_CONFIG
ACX_AUDIOENGINE_CONFIG
_ACX_AUDIOENGINE_CONFIG
acxelements/_ACX_AUDIOENGINE_CONFIG
PACX_AUDIOENGINE_CONFIG
acxelements/PACX_AUDIOENGINE_CONFIG
ACX_AUDIOENGINE_CONFIG
acxelements/ACX_AUDIOENGINE_CONFIG
c++

-description

The ACX_AUDIOENGINE_CONFIG structure is used to define the audio engine configuration.

-struct-fields

-field Size

The length, in bytes, of this structure.

-field Id

A number that represents the element ID.

-field Name

A pointer to a GUID that represents the name of the element. Can be used for debugging and will default to GUID_NULL if not provided.

-field Flags

Audio engine configuration flags defined by the ACX_AUDIOENGINE_CONFIG_FLAGS enum.

No flag bits are currently defined. Set this member to zero - AcxAudioEngineConfigNoFlags

-field HostPin

An existing ACXPIN object that serves as the host pin for the audio engine. For more information about ACX objects, see Summary of ACX Objects.

-field OffloadPin

An existing ACXPIN object that represents the offload pin.

-field LoopbackPin

An existing ACXPIN object that represents the loopback pin.

-field VolumeElement

An existing ACXVOLUME object that is used for volume operations by the audio engine.

-field MuteElement

An existing ACXMUTE object that is used for mute operations by the audio engine.

-field PeakMeterElement

An existing ACXPEAKMETER object that is used for peakmeter operations by the audio engine.

-field Callbacks

An ACX_AUDIOENGINE_CALLBACKS structure that defines the callbacks for the audio engine.

-remarks

Example

Example usage is shown below.

    ACX_AUDIOENGINE_CONFIG          audioEngineCfg;  
    ACX_AUDIOENGINE_CALLBACKS       audioEngineCallbacks;

    // Initialize the config structure
    ACX_AUDIOENGINE_CONFIG_INIT(&audioEngineCfg);
    // Set the values of the structure
    audioEngineCfg.HostPin = Pins[HostPin];
    audioEngineCfg.OffloadPin = Pins[OffloadPin];
    audioEngineCfg.LoopbackPin = Pins[LoopbackPin];
    audioEngineCfg.VolumeElement = volumeElement;
    audioEngineCfg.MuteElement = muteElement;
    audioEngineCfg.PeakMeterElement = peakmeterElement;
    audioEngineCfg.Callbacks = &audioEngineCallbacks;

ACX requirements

Minimum ACX version: 1.0

For more information about ACX versions, see ACX version overview.

-see-also

  • [acxelements.h header](index.md)