AudioToolbox Namespace

The AudioToolbox namespace provides medium-level classes for recording and playing audio.

Classes

_MidiData	An abstract base class for MidiMetaEvent and MidiRawData.
AccessoryInfo	USB Accessory Information
AudioBalanceFade	Holds left/right balance and front/back fade values.
AudioBuffers	Encapsulated a series of AudioBuffers.
AudioChannelLabelExtensions
AudioChannelLayout	Specifies the file or hardware audio channel layout.
AudioChannelLayoutTagExtensions	An extension class that provides a ToAudioChannel(AudioChannelLayoutTag) extension method to the AudioChannelLayoutTag class.
AudioConverter	The linear PCM audio formats converter.
AudioFile	Class used to create audio files or read audio files.
AudioFileGlobalInfo	Encapsulates global audio-file information.
AudioFileInfoDictionary	Metadata-like information relating to a particular audio file.
AudioFileMarkerList	A collection of AudioFileMarkers.
AudioFileRegionList	A list of AudioFileRegions.
AudioFileStream	Process partial audio files.
AudioFormatAvailability	The application developer can use this class to retrieve the properties of available encoders and decoders.
AudioPanningInfo	Information on audio panning.
AudioQueue	Base class for Input and Output audio queues.
AudioQueueException	An exception thrown by the AudioQueue class if there is a problem with the configuration parameters.
AudioQueueProcessingTap	Holds the state for an AudioQueue processing tap.
AudioQueueTimeline	Objects used to track audio queue timelines
AudioSession	Interface to to control the audio context of your application
AudioSessionException	Exception thrown by AudioSession's methods if invalid data is passed to AudioSession, or if the session is not properly configured.
AudioSessionPropertyEventArgs	Provides data for the event.
AudioSessionRouteChangeEventArgs	Provides data for the AudioRouteChanged event.
AudioSource	A derived class from AudioFile that exposes virtual methods that can be hooked into (for reading and writing)
BufferCompletedEventArgs	Provides data for the BufferCompleted event.
InputAudioQueue	An Input Audio Queue, used for audio capturing and recording.
InputCompletedEventArgs	Provides data for the InputCompleted event.
InputSourceInfo	Input accessory information.
InstrumentInfo	Information on an instrument. Returned by GetInstrumentInfo(NSUrl).
MidiMetaEvent	Encapsulates a MIDI meta-event such as a time signature, lyrics, etc.
MidiRawData	Encapsulates a MIDI System-Exclusive (SysEx) message.
MusicEventUserData	A subclass of MidiRawData that describes a user-defined event.
MusicPlayer	An object that plays a MusicSequence.
MusicSequence	A music sequence.
MusicTrack	A music track is a series of time-stamped music events and is a component of a MusicSequence.
OutputAudioQueue	The output AudioQueue.
PacketReceivedEventArgs	Provides data for the E:AudioToolbox.PacketReceivedEventArgs.PacketDecoded event.
PropertyFoundEventArgs	Provides data for the E:AudioToolbox.PropertyFoundEventArgs.PropertyFound event.
SoundBank	A MIDI sound bank.
SystemSound	Provides methods for producing simple sounds.

Structs

AudioBuffer	Represents a collection of audio samples.
AudioChannelDescription	Describes an Audio Channel.
AudioClassDescription	A class that describes an installed codec.
AudioConverterPrimeInfo	The priming information for an audio converter.
AudioFileMarker	A class that represents a specific named position within an audio file.
AudioFilePacketTableInfo	Represents the number of valid frames in a file and where they begin or end.
AudioFileRegion	Represents a named region within an audio file.
AudioFileSmpteTime	A struct that encapsulates a Society of Motion Picture and Television Engineers time.
AudioFormat	Tuple structure that encapsulates both an AudioChannelLayoutTag and an AudioStreamBasicDescription.
AudioQueueBuffer	Represents an audio queue buffer.
AudioQueueChannelAssignment	Channel assignments used as a parameter to the SetChannelAssignments(AudioQueueChannelAssignment[]) method.
AudioQueueLevelMeterState	Represents the level meter information on an audio channel.
AudioQueueParameterEvent	A class that encapsulates values used as parameterEvents in calls to the EnqueueBuffer(AudioQueueBuffer*) method.
AudioStreamBasicDescription	Audio packet stream description.
AudioStreamPacketDescription	Describes audio packets that do not have a standard size and packets that are interleaved with non-audio data.
AudioTimeStamp	Represents an audio time stamp in various formats.
AudioValueRange	A struct that holds minimum and maximum float values, indicating a range.
CABarBeatTime	Struct defining bar beat time, for use with MusicSequence methods such as BarBeatTimeToBeats(CABarBeatTime, Double).
ExtendedNoteOnEvent	A struct that describes a note-on event with extended parameters.
MidiChannelMessage	A struct describing a MIDI channel message. Used by the AddMidiChannelEvent(Double, MidiChannelMessage) method.
MidiNoteMessage	Encapsulates a MIDI musical note.
SmpteTime	SMPTE-based time representation. SMPTE times are used to synchronize an point in the audio stream with some external event.

Enums

AudioBalanceFadeType	An enumeration whose values specify whether balance/fade manipulation should always have a gain of less than 1.0.
AudioChannelBit	An enumeration whose values specify constants in the Bitmap property.
AudioChannelFlags	Flags for the Flags property.
AudioChannelLabel	An enumeration whose values specify the Label property.
AudioChannelLayoutTag	An enumeration whose values are valid for channel layout tags.
AudioCodecComponentType	Enumeration of values used to specify linear PCM conversions.
AudioConverterError	An enumeration whose values specify various types of errors relating to the AudioConverter.
AudioConverterPrimeMethod	The prime method constants.
AudioConverterQuality	Constants for the rendering quality of the sample rate converter.
AudioConverterSampleRateConverterComplexity	Constants for the sample rate conversion algorithm.
AudioFileChunkType	An enumeration whose values specify different types of chunks appropriate to audio files.
AudioFileError	The error codes returned by AudioFile.
AudioFileFlags	An enumeration whose values are valid flags for the M:AudioToolbox.AudioFile.Create* method.
AudioFileLoopDirection	An enumeration whose values specify an audio-loop's direction.
AudioFileMarkerType	An enumeration whose values specify the P:AudioFileMark.Type property.
AudioFilePermission	An enumeration whose values specify the permissions argument in the M:AudioToolbox.AudioFile.Open* method.
AudioFileProperty	An enumeration whose values represent information about a AudioFile. See the GetProperty(AudioFileStreamProperty, Int32, IntPtr) and SetProperty(AudioFileProperty, Int32, IntPtr) methods.
AudioFileRegionFlags	A flagging enumeration whose values are used in the Flags property.
AudioFileStreamProperty	An enumeration whose values represent properties of AudioFileStream.
AudioFileStreamPropertyFlag	An enumeration whose values flag whether a AudioFileStreamProperty is cached.
AudioFileStreamStatus	An enumeration whose values indicate the status following calls to the Seek(Int64, Int64, Boolean) or ParseBytes(Byte[], Int32, Int32, Boolean) methods.
AudioFileType	Known audio file types. Used to specify the kind of audio file to create, or as a hint to the audio parser about the contents of the file.
AudioFormatError	An enumeration whose values specify various errors relating to audio formats.
AudioFormatFlags	Flags describing the stream in the AudioStreamBasicDescription.
AudioFormatType	Audio format identifiers used by AudioStreamBasicDescription.
AudioQueueDeviceProperty	An enumeration whose values specify properties of an audio queue device (number of channels and sample rate).
AudioQueueHardwareCodecPolicy	An enumeration whose values are used for the HardwareCodecPolicy property.
AudioQueueParameter	An enumeration whose values specify various parameters of an audio queue.
AudioQueueProcessingTapFlags	Flags used when an AudioQueue tap is created, and used by the tap processor callback.
AudioQueueProperty	An enumeration whose values specify properties of audio queues.
AudioQueueStatus	An enumeration whose values specify the status of an audio queue.
AudioQueueTimePitchAlgorithm	An enumeration whose values specify the Time Pitch algorithm. Used with TimePitchAlgorithm.
AudioServicesError	An enumeration of values that can be returned by the AddSystemSoundCompletion(Action, CFRunLoop) method.
AudioSessionActiveFlags	Flags passed to AudioSession's SetActive method.
AudioSessionCategory	Categories for your audio session.
AudioSessionErrors	An enumeration whose values can be returned by the SetActive(Boolean, AudioSessionActiveFlags) method or the ErrorCode property.
AudioSessionInputRouteKind	The available audio input sources on the device.
AudioSessionInterruptionState	An enumeration whose values represent the beginning and end of an audio session interruption.
AudioSessionInterruptionType	An enumeration whose values indicate whether the application should resume after an interruption. Returned by the InterruptionType property.
AudioSessionMode	The fine detail over the audio mode, an extension to the AudioSession Category
AudioSessionOutputRouteKind	An enumeration whose values specify different kinds of output routes.
AudioSessionProperty	An enumeration whose values specify properties for audio sessions.
AudioSessionRouteChangeReason	The reason for AudioSession route change event to be raised.
AudioSessionRoutingOverride	Possible values to override the audio route
AudioTimeStamp.AtsFlags	Represents the valid elements in an AudioTimeStamp structure.
MPEG4ObjectID	Enumerates MPEG-4 audio data types.
MusicEventType	An enumeration whose values describe various music event types.
MusicPlayerStatus	An enumeration whose values describe the status of a MusicPlayer.
MusicSequenceFileFlags	Can be used to specify that an existing file should be erased when creating a new file. Used with the CreateFile(NSUrl, MusicSequenceFileTypeID, MusicSequenceFileFlags, UInt16) method.
MusicSequenceFileTypeID	An enumeration that specifies the type of a music sequence file.
MusicSequenceLoadFlags	An enumeration that specifies the loadFlags values in the LoadData(NSData, MusicSequenceFileTypeID, MusicSequenceLoadFlags) and LoadFile(NSUrl, MusicSequenceFileTypeID, MusicSequenceLoadFlags) methods.
MusicSequenceType	An enumeration whose values specify the SequenceType property of a MusicSequence.
PanningMode	An enumeration whose values specify the panning mode (sound-field vs. vector-based).
SmpteTimeFlags	Enumerates SMTPE time states.
SmpteTimeType	An enumeration whose values specify the version of SMPTE time used by a SmpteTime.

Delegates

AudioConverterComplexInputData	Delegate associated with the E:AudioToolbox.AudioConverter.AudioConverterComplexInputData event.
AudioQueue.AudioQueuePropertyChanged	The delegate to be used with the AddListener(AudioQueueProperty, AudioQueue+AudioQueuePropertyChanged) and RemoveListener(AudioQueueProperty, AudioQueue+AudioQueuePropertyChanged) methods.
AudioQueueProcessingTapDelegate	Signature for AudioQueue's Tap callback handlers.
AudioSession.PropertyListener	The delegate used with the AddListener(AudioSessionProperty, AudioSession+PropertyListener) and RemoveListener(AudioSessionProperty, AudioSession+PropertyListener) properties.
MusicSequenceUserCallback

Remarks

Use AudioToolbox to create your own audio processing applications from the basic building blocks: AudioFile to read and write audio files, AudioFileStream to parse audio files progressively; And use the InputAudioQueue to record as well as OutputAudioQueue to play audio.

In addition to the low-level toolkit to create your own audio processing, the SystemSound can be used to play short audio clips.