AudioQueueProcessingTapFlags Enum
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Flags used when an AudioQueue tap is created, and used by the tap processor callback.
This enumeration supports a bitwise combination of its member values.
[System.Flags]
public enum AudioQueueProcessingTapFlagstype AudioQueueProcessingTapFlags = - Inheritance
-
AudioQueueProcessingTapFlags
- Attributes
Fields
| Name | Value | Description |
|---|---|---|
| PreEffects | 1 | The tap is executed before any effects have run. |
| PostEffects | 2 | The tap is executed after any effects have run. |
| Siphon | 4 | The tap is a siphon tap, it can only examine the AudioBuffers provided to the callback, but should not modify its contents. |
| StartOfStream | 256 | Indicates the start of audio and is returned by GetSourceAudio. As a flag passed to a tap processor, this indicates a discontinuity in the audio. Either because it is starting, or because there is a playback gap. For the tap processor this means that the data being requested should correspond to the first frame in the audio source. This should reset any internal state in the tap processor that might have been saved from previous invocations to the tap handler. |
| EndOfStream | 512 | Indicates the end of the audio stream, it happens when the queue is being stopped asynchronosuly and is returned by a call to GetSourceAudio. You must propagate this value to the caller. |
Remarks
The PostEffects, PreEffects, Siphon values are used both when creating a audio queue tap (using CreateProcessingTap(AudioQueueProcessingTapDelegate, AudioQueueProcessingTapFlags, AudioQueueStatus)) and are provided to the tap callback (of type AudioQueueProcessingTapDelegate).
The StartOfStream and EndOfStream are returned by AudioQueueProcessingTap's GetSourceAudio method.