AudioQueue.CreateProcessingTap Method

Definition

Creates a processing tap in the AudioQueue.

public AudioToolbox.AudioQueueProcessingTap CreateProcessingTap (AudioToolbox.AudioQueueProcessingTapDelegate processingCallback, AudioToolbox.AudioQueueProcessingTapFlags flags, out AudioToolbox.AudioQueueStatus status);
member this.CreateProcessingTap : AudioToolbox.AudioQueueProcessingTapDelegate * AudioToolbox.AudioQueueProcessingTapFlags *  -> AudioToolbox.AudioQueueProcessingTap

Parameters

processingCallback
AudioQueueProcessingTapDelegate

Tap handler to invoke.

flags
AudioQueueProcessingTapFlags

Determines the kind of processing that this tap does (pre-process, post-process or siphon).

status
AudioQueueStatus

Result code from creating the processing tap.

Returns

Object that can be used to control the tap. Disposing it terminates the tap.

Remarks

Taps will receive the audio data once the buffer is decoded for output queues and input data before encoding for input queues. The flags determine when the processing takes place.

There are three types: pre-processing, post-processing and siphon. The first two should provide the data requested during the callback, typically by calling the AudioQueueProcessingTap's GetSourceAudio method and optionally performing some transormation on the buffers and returning these buffers to the caller. Siphoning taps receive buffers with the data and can inspect the data, but should not alter its contents. See the AudioQueueProcessingTapDelegate documentation for more information.

To establish a tap, the queue must be in the stopped state.

Applies to