ACX_AUDIOENGINE_CALLBACKS structure (acxelements.h)

Article
10/03/2023

The ACX_AUDIOENGINE_CALLBACKS structure defines callbacks for the ACX audio engine.

Syntax

typedef struct _ACX_AUDIOENGINE_CALLBACKS {
  ULONG                                           Size;
  PFN_ACX_AUDIOENGINE_RETRIEVE_BUFFER_SIZE_LIMITS EvtAcxAudioEngineRetrieveBufferSizeLimits;
  PFN_ACX_AUDIOENGINE_ASSIGN_EFFECTS_STATE        EvtAcxAudioEngineAssignEffectsState;
  PFN_ACX_AUDIOENGINE_RETRIEVE_EFFECTS_STATE      EvtAcxAudioEngineRetrieveEffectsState;
  PFN_ACX_AUDIOENGINE_RETRIEVE_ENGINE_FORMAT      EvtAcxAudioEngineRetrieveEngineMixFormat;
  PFN_ACX_AUDIOENGINE_ASSIGN_ENGINE_FORMAT        EvtAcxAudioEngineAssignEngineDeviceFormat;
  PFN_ACX_OBJECT_PROCESS_REQUEST                  EvtAcxAudioEngineProcessRequest;
} ACX_AUDIOENGINE_CALLBACKS, *PACX_AUDIOENGINE_CALLBACKS;

Members

Size

The length, in bytes, of this structure.

EvtAcxAudioEngineRetrieveBufferSizeLimits

The EVT_ACX_AUDIOENGINE_RETRIEVE_BUFFER_SIZE_LIMITS callback.

EvtAcxAudioEngineAssignEffectsState

The EVT_ACX_AUDIOENGINE_ASSIGN_EFFECTS_STATE callback.

EvtAcxAudioEngineRetrieveEffectsState

The EVT_ACX_AUDIOENGINE_RETRIEVE_EFFECTS_STATE callback.

EvtAcxAudioEngineRetrieveEngineMixFormat

The EVT_ACX_AUDIOENGINE_RETRIEVE_ENGINE_FORMAT callback.

EvtAcxAudioEngineAssignEngineDeviceFormat

The EVT_ACX_AUDIOENGINE_ASSIGN_ENGINE_FORMAT callback.

EvtAcxAudioEngineProcessRequest

The EVT_ACX_OBJECT_PROCESS_REQUEST callback.

Remarks

Example

Example usage is shown below.

  ACX_AUDIOENGINE_CALLBACKS       audioEngineCallbacks;

  ACX_AUDIOENGINE_CALLBACKS_INIT(&audioEngineCallbacks);
    audioEngineCallbacks.EvtAcxAudioEngineRetrieveBufferSizeLimits = CodecR_EvtAcxAudioEngineRetrieveBufferSizeLimits;
    audioEngineCallbacks.EvtAcxAudioEngineAssignEffectsState = CodecR_EvtAcxAudioEngineAssignEffectsState;
    audioEngineCallbacks.EvtAcxAudioEngineRetrieveEffectsState = CodecR_EvtAcxAudioEngineRetrieveEffectsState;
    audioEngineCallbacks.EvtAcxAudioEngineRetrieveEngineMixFormat = CodecR_EvtAcxAudioEngineRetrieveEngineMixFormat;
    audioEngineCallbacks.EvtAcxAudioEngineAssignEngineDeviceFormat = CodecR_EvtAcxAudioEngineAssignEngineDeviceFormat;

ACX requirements

Minimum ACX version: 1.0

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

Requirements

Requirement	Value
Header	acxelements.h

Share via