Microsoft DirectX 9.0

_AM_AUDIO_RENDERER_STAT_PARAM Enumeration

The _AM_AUDIO_RENDERER_STAT_PARAM enumeration specifies which performance information to retrieve from the audio renderer.

Syntax

enum _AM_AUDIO_RENDERER_STAT_PARAM {
    AM_AUDREND_STAT_PARAM_BREAK_COUNT = 1,
    AM_AUDREND_STAT_PARAM_SLAVE_MODE,
    AM_AUDREND_STAT_PARAM_SILENCE_DUR,
    AM_AUDREND_STAT_PARAM_LAST_BUFFER_DUR,
    AM_AUDREND_STAT_PARAM_DISCONTINUITIES,
    AM_AUDREND_STAT_PARAM_SLAVE_RATE,
    AM_AUDREND_STAT_PARAM_SLAVE_DROPWRITE_DUR,
    AM_AUDREND_STAT_PARAM_SLAVE_HIGHLOWERROR,
    AM_AUDREND_STAT_PARAM_SLAVE_LASTHIGHLOWERROR, 
    AM_AUDREND_STAT_PARAM_SLAVE_ACCUMERROR, 
    AM_AUDREND_STAT_PARAM_BUFFERFULLNESS,
    AM_AUDREND_STAT_PARAM_JITTER
};

Elements

This enumeration type is used in the IAMAudioRendererStats::GetStatParam method. Each enumeration member defines the meaning of the values that are returned in the pdwParam1 and pdwParam2 parameters of GetStatParam.

The following tables describe each enumeration member.

Enumeration Value AM_AUDREND_STAT_PARAM_BREAK_COUNT
Param1 The cumulative number of breaks in the audio stream.
Param2 Not used.

Enumeration Value AM_AUDREND_STAT_PARAM_BUFFERFULLNESS
Param1 How much audio data is in the audio buffer, as a percentage.
Param2 Not used.

Enumeration Value AM_AUDREND_STAT_PARAM_DISCONTINUITIES
Param1 The cumulative number of discontinuities in the audio stream.
Param2 Not used.

Enumeration Value AM_AUDREND_STAT_PARAM_JITTER
Remarks Not implemented.

Enumeration Value AM_AUDREND_STAT_PARAM_LAST_BUFFER_DUR
Param1 The duration of the most recent audio buffer, in milliseconds.
Param2 Not used.

Enumeration Value AM_AUDREND_STAT_PARAM_SILENCE_DUR
Param1 The cumulative amount of silence the audio renderer has inserted, due to gaps in the time stamps of the incoming samples. The value is given in milliseconds.
Param2 Not used.

Enumeration Value AM_AUDREND_STAT_PARAM_SLAVE_ACCUMERROR
Param1 The accumulated difference between the audio renderer and the master clock, including adjustments made by dropping samples or inserting gaps.
Param2 Not used.
Remarks Valid only when the audio renderer is matching rates to another clock or a live source.

Enumeration Value AM_AUDREND_STAT_PARAM_SLAVE_DROPWRITE_DUR
Param1 The amount of data dropped to stay in sync, in milliseconds.
Param2 The amount of silence added to stay in sync, in milliseconds. (Currently not implemented.)
Remarks Applies only when the Audio Renderer (WaveOut) filter is matching rates to a master clock.

Enumeration Value AM_AUDREND_STAT_PARAM_SLAVE_HIGHLOWERROR
Param1 The highest difference noted between the audio renderer's clock and the clock it is trying to match.
Param2 The lowest difference noted between the audio renderer's clock and the clock it is trying to match.
Remarks Valid only when the audio renderer is matching rates to a master clock.

Enumeration Value AM_AUDREND_STAT_PARAM_SLAVE_LASTHIGHLOWERROR
Param1 The last high error, in milliseconds. A high error occurs when the audio renderer falls behind the clock.
Param2 The last low error, in milliseconds. A low error occurs when the audio renderer runs ahead of the clock.
Remarks Valid only when the audio renderer is matching rates to a master clock.

Enumeration Value AM_AUDREND_STAT_PARAM_SLAVE_MODE
Param1 Indicates the current rate-matching mode. The value is a bitwise combination of the following:

0x00: No rate matching.

0x01: Match rates to a live source.

0x02: Match rates based on the rate of the incoming audio data.

0x04: Match rates with the filter graph's reference clock (when the clock is not provided by the audio renderer).

0x10: Match rates based on the time stamps of the audio samples.
Param2 Not used.

Enumeration Value AM_AUDREND_STAT_PARAM_SLAVE_RATE
Param1 The sample rate that the audio renderer is matching, in samples per second.
Param2 Not used.
Remarks Valid only when the DirectSound Renderer is matching rates to another clock or a live source.

See Also