Edit

Share via

AcxAudioEngineGetDeviceFormatList function (acxelements.h)

  • Article

The AcxAudioEngineGetDeviceFormatList function retrieves the ACXDATAFORMATLIST object that holds the list of supported formats for the audio engine node. For more information about ACX objects, see Summary of ACX Objects.

Syntax

ACXDATAFORMATLIST AcxAudioEngineGetDeviceFormatList(
  ACXAUDIOENGINE AudioEngine
);

Parameters

AudioEngine

An ACXAUDIOENGINE object that is used in a render circuit, to represent a DSP.

Return value

The ACXDATAFORMATLIST object which holds the list of supported formats for the specified ACXAUDIOENGINE object.

Remarks

Example

Example usage is shown below.

    status = AcxDataFormatCreate(Device, &attributes, &formatCfg, &formatPcm44100c2);
    formatCtx = GetCodecFormatContext(formatPcm44100c2);

    // Get the current audio engine device format list
    formatList = AcxAudioEngineGetDeviceFormatList(audioEngineElement);
    if (formatList == NULL)
    {
        status = STATUS_INSUFFICIENT_RESOURCES;
        goto exit;
    }

    // Add our supported formats to the audio engine device format list
    status = AcxDataFormatListAddDataFormat(formatList, formatPcm44100c2);

ACX requirements

Minimum ACX version: 1.0

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

Requirements

Requirement Value
Header acxelements.h
IRQL PASSIVE_LEVEL

See also