AudioQueueProcessingTap.GetSourceAudio Method

Definition

Deprecated: Retrieve source audio.

public AudioToolbox.AudioQueueStatus GetSourceAudio (uint numberOfFrames, ref AudioToolbox.AudioTimeStamp timeStamp, out AudioToolbox.AudioQueueProcessingTapFlags flags, out uint parentNumberOfFrames, AudioToolbox.AudioBuffers data);
member this.GetSourceAudio : uint32 *  *  *  * AudioToolbox.AudioBuffers -> AudioToolbox.AudioQueueStatus

Parameters

numberOfFrames
UInt32

Number of frames requires by the Tap processor.

timeStamp
AudioTimeStamp

For input queues, the timestamp is returned. For output queues, it must contain the timestamp.

parentNumberOfFrames
UInt32

Returns the number of provided frames.

data
AudioBuffers

The AudioBuffers that contain the source data.

Returns

Remarks

Memory management for the AudioBuffers is as follows. If the AudioBuffer Data field contains IntPtr.Zero, the AudioQueue will allocate the buffers and release them after the tap processor has executed. If the value is not-null, it must point to a block of memory large enough to hold the requested number of frames.

This method should only be called from the AudioProcessingTap callback.

Applies to