Edit

ACX_STREAMAUDIOENGINE_CONFIG structure (acxelements.h)

  • Article

The ACX_STREAMAUDIOENGINE_CONFIG structure is used to define the stream audio engine configuration.

Syntax

typedef struct _ACX_STREAMAUDIOENGINE_CONFIG {
  ULONG                            Size;
  ULONG                            Id;
  const GUID                       *Name;
  ULONG                            Flags;
  ACXVOLUME                        VolumeElement;
  ACXMUTE                          MuteElement;
  ACXPEAKMETER                     PeakMeterElement;
  PACX_STREAMAUDIOENGINE_CALLBACKS Callbacks;
} ACX_STREAMAUDIOENGINE_CONFIG, *PACX_STREAMAUDIOENGINE_CONFIG;

Members

Size

The length, in bytes, of this structure.

Id

A number that represents the element ID.

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.

Flags

Acx peakmeter configuration flags defined by the ACX_STREAMAUDIOENGINE_CONFIG_FLAGS enum.

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

VolumeElement

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

MuteElement

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

PeakMeterElement

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

Callbacks

The ACX_STREAMAUDIOENGINE_CALLBACKS structure that identifies the driver callbacks for ACX audio engine streaming operations.

Remarks

Example

Example usage is shown below.

        ACX_STREAMAUDIOENGINE_CONFIG audioEngineCfg;
        ACX_STREAMAUDIOENGINE_CONFIG_INIT(&audioEngineCfg);
        audioEngineCfg.VolumeElement = volumeElement;
        audioEngineCfg.MuteElement = muteElement;
        audioEngineCfg.PeakMeterElement = peakmeterElement;
        audioEngineCfg.Callbacks = &streamAudioEngineCallbacks;

ACX requirements

Minimum ACX version: 1.0

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

Requirements

Requirement Value
Header acxelements.h

See also