acxelements.h header
This header is used by the ACX audio class extensions.
For more information, see:
acxelements.h contains the following programming interfaces:
Functions
| ACX_AUDIOENGINE_CALLBACKS_INIT The ACX_AUDIOENGINE_CALLBACKS_INIT function initializes a driver's ACX_AUDIOENGINE_CALLBACKS structure. |
| ACX_AUDIOENGINE_CONFIG_INIT The ACX_AUDIOENGINE_CONFIG_INIT function initializes a driver's ACX_AUDIOENGINE_CONFIG structure. |
| ACX_AUDIOENGINE_CONFIG_INIT_ID As the ACX_AUDIOENGINE_CONFIG_INIT_ID provides the same functionality as ACX_AUDIOENGINE_CONFIG_INIT, the use of ACX_AUDIOENGINE_CONFIG_INIT is recommended. |
| ACX_AUDIOMODULE_CALLBACKS_INIT The ACX_AUDIOMODULE_CALLBACKS_INIT function initializes the ACX_AUDIOMODULE_CALLBACKS structure. |
| ACX_AUDIOMODULE_CONFIG_INIT The ACX_AUDIOMODULE_CONFIG_INIT function initializes an ACX_AUDIOMODULE_CONFIG structure. |
| ACX_AUDIOMODULE_CONFIG_INIT_ID As the ACX_AUDIOMODULE_CONFIG_INIT_ID provides the same functionality as ACX_AUDIOMODULE_CONFIG_INIT, the use of ACX_AUDIOMODULE_CONFIG_INIT is recommended. |
| ACX_ELEMENT_CONFIG_INIT The ACX_ELEMENT_CONFIG_INIT function initializes an ACX_ELEMENT_CONFIG structure. |
| ACX_ELEMENT_CONFIG_INIT_ID As the The ACX_ELEMENT_CONFIG_INIT_ID provides the same functionality as ACX_ELEMENT_CONFIG_INIT, the use of ACX_ELEMENT_CONFIG_INIT is recommended. |
| ACX_KEYWORDSPOTTER_CALLBACKS_INIT The ACX_KEYWORDSPOTTER_CALLBACKS_INIT function initializes a ACX_KEYWORDSPOTTER_CALLBACKS structure. |
| ACX_KEYWORDSPOTTER_CONFIG_INIT The ACX_KEYWORDSPOTTER_CONFIG_INIT function initializes an ACX_KEYWORDSPOTTER_CONFIG structure. |
| ACX_KEYWORDSPOTTER_CONFIG_INIT_ID As the The ACX_KEYWORDSPOTTER_CONFIG_INIT_ID provides the same functionality as ACX_KEYWORDSPOTTER_CONFIG_INIT, the use of ACX_KEYWORDSPOTTER_CONFIG_INIT is recommended. |
| ACX_MUTE_CALLBACKS_INIT The ACX_MUTE_CALLBACKS_INIT function initializes a ACX_MUTE_CALLBACKS structure. |
| ACX_MUTE_CONFIG_INIT The ACX_MUTE_CONFIG_INIT function initializes an ACX_MUTE_CONFIG structure. |
| ACX_MUTE_CONFIG_INIT_ID As the ACX_MUTE_CONFIG_INIT_ID provides the same functionality as ACX_MUTE_CONFIG_INIT, the use of ACX_MUTE_CONFIG_INIT is recommended. |
| ACX_PEAKMETER_CALLBACKS_INIT The ACX_PEAKMETER_CALLBACKS_INIT function initializes a ACX_PEAKMETER_CALLBACKS structure. |
| ACX_PEAKMETER_CONFIG_INIT The ACX_PEAKMETER_CONFIG_INIT function initializes an ACX_PEAKMETER_CONFIG structure. |
| ACX_PEAKMETER_CONFIG_INIT_ID As the ACX_PEAKMETER_CONFIG_INIT_ID provides the same functionality as ACX_PEAKMETER_CONFIG_INIT, the use of ACX_PEAKMETER_CONFIG_INIT is recommended. |
| ACX_STREAMAUDIOENGINE_CALLBACKS_INIT The ACX_STREAMAUDIOENGINE_CALLBACKS_INIT function initializes a ACX_STREAMAUDIOENGINE_CALLBACKS structure. |
| ACX_STREAMAUDIOENGINE_CONFIG_INIT The ACX_STREAMAUDIOENGINE_CONFIG_INIT function initializes an ACX_STREAMAUDIOENGINE_CONFIG structure. |
| ACX_STREAMAUDIOENGINE_CONFIG_INIT_ID As the ACX_STREAMAUDIOENGINE_CONFIG_INIT_ID provides the same functionality as ACX_STREAMAUDIOENGINE_CONFIG_INIT, the use of ACX_STREAMAUDIOENGINE_CONFIG_INIT is recommended. |
| ACX_VOLUME_CALLBACKS_INIT The ACX_VOLUME_CALLBACKS_INIT function initializes a ACX_VOLUME_CALLBACKS structure. |
| ACX_VOLUME_CONFIG_INIT The ACX_VOLUME_CONFIG_INIT function initializes an ACX_VOLUME_CONFIG structure. |
| ACX_VOLUME_CONFIG_INIT_ID At this time, the ACX_VOLUME_CONFIG_INIT_ID can only take AcxElementIdDefault as input for the element ID, which is the same as using ACX_VOLUME_CONFIG_INIT. |
| AcxAudioEngineCreate The AcxAudioEngineCreate function is used to create an audio engine that that will be associated with a circuit WDFDEVICE device object parent. |
| AcxAudioEngineGetDeviceFormatList The AcxAudioEngineGetDeviceFormatList function retrieves a ACXDATAFORMATLIST device format list ACX object. |
| AcxAudioModuleCreate The AcxAudioModuleCreate function is used to create an audio module that that will be associated with an ACX circuit object parent. |
| AcxElementAddEvents The AcxElementAddEvents function provides the ability to add ACXEVENT event objects to an ACXELEMENT object. |
| AcxElementCreate The AcxElementCreate function is used to create an ACXELEMENT object that that will be associated with a circuit or stream device object parent. |
| AcxElementGetContainer The AcxElementGetContainer function retrieves the associated container for the given ACX element. |
| AcxElementGetId The AcxElementGetId function retrieves the number that represents the element ID for a given ACX element object. |
| AcxKeywordSpotterCreate The AcxKeywordSpotterCreate function is used to create an ACX keyword spotter object that that will be associated with a circuit device object parent. |
| AcxMuteChangeStateNotification The AcxMuteChangeStateNotification function sends a notification of a mute state change on an ACXMUTE object so that acx can generate a corresponding event. |
| AcxMuteCreate The AcxMuteCreate function is used to create an ACX mute object that that will be associated with a circuit object parent. |
| AcxPeakMeterCreate The AcxPeakMeterCreate function is used to create an ACX peakmeter object that that will be associated with a circuit object parent. |
| AcxStreamAudioEngineCreate The AcxStreamAudioEngineCreate function is used to create an ACX stream audio engine object that will be associated with an ACX stream object parent. |
| AcxStreamAudioEngineGetStream The AcxStreamAudioEngineGetStream function retrieves the ACXSTREAM object associated with the given stream audio engine object. |
| AcxVolumeChangeLevelNotification The AcxVolumeChangeLevelNotification function sends a notification of a volume level change on an ACXVOLUME object so that acx can generate a corresponding event. |
| AcxVolumeCreate The AcxVolumeCreate function is used to create an ACX volume object that that will be associated with a circuit object parent. |
Callback functions
| EVT_ACX_AUDIOENGINE_ASSIGN_EFFECTS_STATE The EVT_ACX_AUDIOENGINE_ASSIGN_EFFECTS_STATE callback function is implemented by the driver and is called when the global effects state is set for an audio engine node. |
| EVT_ACX_AUDIOENGINE_ASSIGN_ENGINE_FORMAT The EVT_ACX_AUDIOENGINE_ASSIGN_ENGINE_FORMAT callback function is implemented by the driver and is called when the internal mix format is set for an audio engine node. |
| EVT_ACX_AUDIOENGINE_RETRIEVE_BUFFER_SIZE_LIMITS The EVT_ACX_AUDIOENGINE_RETRIEVE_BUFFER_SIZE_LIMITS callback is implemented by the driver and is called when the buffer size limits for a given data format are requested for the specified audio engine. |
| EVT_ACX_AUDIOENGINE_RETRIEVE_EFFECTS_STATE The EVT_ACX_AUDIOENGINE_RETRIEVE_EFFECTS_STATE callback function is implemented by the driver and is called when the global effects state is requested for the specified audio engine node. |
| EVT_ACX_AUDIOENGINE_RETRIEVE_ENGINE_FORMAT The EVT_ACX_AUDIOENGINE_RETRIEVE_ENGINE_FORMAT callback is implemented by the driver and is called when the internal mix format is requested for the specified audio engine. |
| EVT_ACX_AUDIOMODULE_PROCESSCOMMAND EVT_ACX_AUDIOMODULE_PROCESSCOMMAND tells the driver to process a command for an audio module element. |
| EVT_ACX_KEYWORDSPOTTER_ASSIGN_ARM EVT_ACX_KEYWORDSPOTTER_ASSIGN_ARM sets the arm state of the keyword spotter. |
| EVT_ACX_KEYWORDSPOTTER_ASSIGN_PATTERNS EVT_ACX_KEYWORDSPOTTER_ASSIGN_PATTERNS assigns detection patterns for keyword detection to be used by the keyword spotter. |
| EVT_ACX_KEYWORDSPOTTER_ASSIGN_RESET EVT_ACX_KEYWORDSPOTTER_ASSIGN_RESET resets the keyword spotter detector to an unarmed state with no pattern set. |
| EVT_ACX_KEYWORDSPOTTER_RETRIEVE_ARM EVT_ACX_KEYWORDSPOTTER_RETRIEVE_ARM retrieves the current arm state of the keyword spotter. |
| EVT_ACX_MUTE_ASSIGN_STATE The EVT_ACX_MUTE_ASSIGN_STATE callback function is implemented by the driver and is called when the state of a specified channel on a mute node is set. |
| EVT_ACX_MUTE_RETRIEVE_STATE The EVT_ACX_MUTE_RETRIEVE_STATE callback function is implemented by the driver and is called when the state of a specified channel on a mute node is requested. |
| EVT_ACX_PEAKMETER_RETRIEVE_LEVEL The EVT_ACX_PEAKMETER_RETRIEVE_LEVEL callback function is implemented by the driver and is called when the level of a specified channel on a peakmeter node is requested. |
| EVT_ACX_RAMPED_VOLUME_ASSIGN_LEVEL EVT_ACX_RAMPED_VOLUME_ASSIGN_LEVEL is implemented by the driver and is called when the volume level of a channel is set for a volume node. |
| EVT_ACX_STREAMAUDIOENGINE_ASSIGN_CURRENT_WRITE_POSITION The EVT_ACX_STREAMAUDIOENGINE_ASSIGN_CURRENT_WRITE_POSITION callback function is implemented by the driver and is called when the current write position for the specified stream audio engine is set. |
| EVT_ACX_STREAMAUDIOENGINE_ASSIGN_EFFECTS_STATE The EVT_ACX_STREAMAUDIOENGINE_ASSIGN_EFFECTS_STATE callback function is implemented by the driver and is called when the local effects state is set for a stream audio engine node. |
| EVT_ACX_STREAMAUDIOENGINE_ASSIGN_LAST_BUFFER_POSITION The EVT_ACX_STREAMAUDIOENGINE_ASSIGN_LAST_BUFFER_POSITION callback function is implemented by the driver and is called when the position of the last valid byte in the audio buffer is set for the specified stream audio engine. |
| EVT_ACX_STREAMAUDIOENGINE_ASSIGN_LOOPBACK_PROTECTION EVT_ACX_STREAMAUDIOENGINE_ASSIGN_LOOPBACK_PROTECTION is implemented by the driver and is called when the loopback protection status is set for a stream audio engine node. |
| EVT_ACX_STREAMAUDIOENGINE_RETRIEVE_EFFECTS_STATE The EVT_ACX_STREAMAUDIOENGINE_RETRIEVE_EFFECTS_STATE callback function is implemented by the driver and is called when the local effects state is requested for the specified stream audio engine. |
| EVT_ACX_STREAMAUDIOENGINE_RETRIEVE_LINEAR_BUFFER_POSITION The EVT_ACX_STREAMAUDIOENGINE_RETRIEVE_LINEAR_BUFFER_POSITION callback is implemented by the driver and is called when the linear buffer position is requested for the specified stream audio engine. |
| EVT_ACX_STREAMAUDIOENGINE_RETRIEVE_PRESENTATION_POSITION The EVT_ACX_STREAMAUDIOENGINE_RETRIEVE_PRESENTATION_POSITION callback function is implemented by the driver and is called to retrieve the current position within the audio data being rendered to the stream audio engine node. |
| EVT_ACX_VOLUME_ASSIGN_LEVEL The EVT_ACX_VOLUME_ASSIGN_LEVEL callback function is implemented by the driver and is called when the volume level of a channel is set for a volume node. |
| EVT_ACX_VOLUME_RETRIEVE_LEVEL The EVT_ACX_VOLUME_RETRIEVE_LEVEL callback function is implemented by the driver and is called when the volume level of a specified channel on a volume node is requested. |
Structures
| ACX_AUDIOENGINE_CALLBACKS The ACX_AUDIOENGINE_CALLBACKS structure defines callbacks for the ACX audio engine. |
| ACX_AUDIOENGINE_CONFIG The ACX_AUDIOENGINE_CONFIG structure is used to define the audio engine configuration. |
| ACX_AUDIOMODULE_CALLBACKS The ACX_AUDIOMODULE_CALLBACKS structure identifies the driver callbacks for ACX audio module operations. |
| ACX_AUDIOMODULE_CONFIG The ACX_AUDIOMODULE_CONFIG structure is used to define the audio module configuration. |
| ACX_AUDIOMODULE_DESCRIPTOR The ACX_AUDIOMODULE_DESCRIPTOR is used to define an audio module descriptor structure. |
| ACX_ELEMENT_CONFIG The ACX_ELEMENT_CONFIG structure is used to define the audio element configuration. |
| ACX_KEYWORDSPOTTER_CALLBACKS The ACX_KEYWORDSPOTTER_CALLBACKS structure identifies the driver callbacks for key word spotter operations. |
| ACX_KEYWORDSPOTTER_CONFIG The ACX_KEYWORDSPOTTER_CONFIG structure is used to define the audio keyword spotter configuration. |
| ACX_MUTE_CALLBACKS The ACX_MUTE_CALLBACKS structure identifies the driver callbacks for ACX mute operations. |
| ACX_MUTE_CONFIG The ACX_MUTE_CONFIG structure is used to define the audio mute configuration. |
| ACX_PEAKMETER_CALLBACKS The ACX_PEAKMETER_CALLBACKS structure identifies the driver callbacks for ACX peakmeter operations. |
| ACX_PEAKMETER_CONFIG The ACX_PEAKMETER_CONFIG structure is used to define the audio peakmeter configuration. |
| ACX_STREAMAUDIOENGINE_CALLBACKS The ACX_STREAMAUDIOENGINE_CALLBACKS structure identifies the driver callbacks for ACX audio engine stream operations. |
| ACX_STREAMAUDIOENGINE_CONFIG The ACX_STREAMAUDIOENGINE_CONFIG structure is used to define the audio engine stream configuration. |
| ACX_VOLUME_CALLBACKS The ACX_VOLUME_CALLBACKS structure identifies the driver callbacks for ACX volume operations. |
| ACX_VOLUME_CONFIG The ACX_VOLUME_CONFIG structure is used to define the acx volume configuration. |
Enumerations
| ACX_AUDIOENGINE_CONFIG_FLAGS The ACX_AUDIOENGINE_CONFIG_FLAGS enumeration defines the config flags for the ACX audio engine. |
| ACX_AUDIOMODULE_CONFIG_FLAGS The ACX_AUDIOMODULE_CONFIG_FLAGS enumeration defines the config flags for the ACX audio module. |
| ACX_CONSTRICTOR_OPTION The ACX_CONSTRICTOR_OPTION enumeration defines the options for the loopback protection status of a stream audio engine node. |
| ACX_ELEMENT_CONFIG_FLAGS The ACX_ELEMENT_CONFIG_FLAGS enumeration defines the config flags for an ACX element. |
| ACX_KEYWORDSPOTTER_CONFIG_FLAGS The ACX_KEYWORDSPOTTER_CONFIG_FLAGS enumeration defines the config flags for the ACX audio keyword spotter. |
| ACX_MUTE_CONFIG_FLAGS The ACX_MUTE_CONFIG_FLAGS enumeration defines the config flags for the ACX mute element. |
| ACX_PEAKMETER_CONFIG_FLAGS The ACX_PEAKMETER_CONFIG_FLAGS enumeration defines the config flags for the ACX peakmeter element. |
| ACX_STREAMAUDIOENGINE_CONFIG_FLAGS The ACX_STREAMAUDIOENGINE_CONFIG_FLAGS enumeration defines the config flags for the ACX stream audio engine. |
| ACX_VOLUME_CONFIG_FLAGS The ACX_VOLUME_CONFIG_FLAGS enumeration defines the config flags for the ACX volume element. |
| ACX_VOLUME_CURVE_TYPE The ACX_VOLUME_CURVE_TYPE enumeration defines constants that specify a curve algorithm to be applied to set a volume level. |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for