ACX_MUTE_CONFIG structure (acxelements.h)

Article
10/03/2023

The ACX_MUTE_CONFIG structure is used to define the acx mute configuration.

Syntax

typedef struct _ACX_MUTE_CONFIG {
  ULONG               Size;
  ULONG               Id;
  const GUID          *Name;
  ULONG               Flags;
  ULONG               ChannelsCount;
  PACX_MUTE_CALLBACKS Callbacks;
} ACX_MUTE_CONFIG, *PACX_MUTE_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 mute configuration flags defined by the ACX_MUTE_CONFIG_FLAGS enum.

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

ChannelsCount

The number of channels. This is a one based count.

Callbacks

The ACX_MUTE_CALLBACKS structure that identifies the driver callbacks for ACX mute operations.

Remarks

Example

Example usage is shown below.

    ACX_MUTE_CALLBACKS              muteCallbacks;
    ACX_MUTE_CONFIG                 muteCfg;
    ACXMUTE                         muteElement;

    //
    // Create three elements to handle mute for the audioengine element
    //
    ACX_MUTE_CALLBACKS_INIT(&muteCallbacks);
    muteCallbacks.EvtAcxMuteAssignState = CodecR_EvtMuteAssignState;
    muteCallbacks.EvtAcxMuteRetrieveState = CodecR_EvtMuteRetrieveState;

    ACX_MUTE_CONFIG_INIT(&muteCfg);
    muteCfg.ChannelsCount = MAX_CHANNELS;
    muteCfg.Name = &KSAUDFNAME_WAVE_MUTE;
    muteCfg.Callbacks = &muteCallbacks;

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