AERenderContext.h File Reference
#import <Foundation/Foundation.h>
#import <AudioToolbox/AudioToolbox.h>
#import "AEBufferStack.h"

Go to the source code of this file.

Classes

struct  AERenderContext
 Render context. More...
 

Functions

void AERenderContextOutput (const AERenderContext *_Nonnull context, int bufferCount)
 Mix stack items onto the output.
 
void AERenderContextOutputToChannels (const AERenderContext *_Nonnull context, int bufferCount, AEChannelSet channels)
 Mix stack items onto the output, with specific channel configuration.
 

Class Documentation

struct AERenderContext

Render context.

This structure is passed into the render loop block, and contains information about the current rendering environment, as well as providing access to the render's buffer stack.

Class Members
const AudioBufferList *_Nonnull output The output buffer list. You should write to this to produce audio.
UInt32 frames The number of frames to render to the output.
double sampleRate The current sample rate, in Hertz.
const AudioTimeStamp *_Nonnull timestamp The current audio timestamp.
BOOL offlineRendering Whether rendering is offline (faster than realtime)
AEBufferStack *_Nonnull stack The buffer stack. Use this as a workspace for generating and processing audio.

Function Documentation

void AERenderContextOutput ( const AERenderContext *_Nonnull  context,
int  bufferCount 
)

Mix stack items onto the output.

The given number of stack items will mixed into the context's output. This method is a convenience wrapper for AEBufferStackMixToBufferList.

Parameters
contextThe context
bufferCountNumber of buffers on the stack to process, or 0 for all
void AERenderContextOutputToChannels ( const AERenderContext *_Nonnull  context,
int  bufferCount,
AEChannelSet  channels 
)

Mix stack items onto the output, with specific channel configuration.

The given number of stack items will mixed into the context's output. This method is a convenience wrapper for AEBufferStackMixToBufferListChannels.

Parameters
contextThe context
bufferCountNumber of buffers on the stack to process, or 0 for all
channelsThe set of channels to output to. If stereo, any mono inputs will be doubled to stereo. If mono, any stereo inputs will be mixed down.