Crate objc2_avf_audio 

Bindings to the AVFAudio framework

See Apple’s docs and the general docs on framework crates for more information.

Structs

AVAUPresetEventAVMusicEvents

The event class representing a preset load and change on the AVMusicTrack’s destinationAudioUnit.

AVAudio3DAngularOrientationAVAudioTypes

Struct representing the orientation of the listener in 3D space

AVAudio3DMixingPointSourceInHeadModeAVAudioMixing

In-head modes available for AVAudio3DMixingSourceModePointSource in AVAudio3DMixingRenderingAlgorithmAuto

AVAudio3DMixingRenderingAlgorithmAVAudioMixing

Types of rendering algorithms available per input bus of the environment node

AVAudio3DMixingSourceModeAVAudioMixing

Source types available per input bus of the environment node

AVAudio3DPointAVAudioTypes

Struct representing a point in 3D space

AVAudio3DVectorOrientationAVAudioTypes

Struct representing the orientation of the listener in 3D space

AVAudioApplicationAVAudioApplication

Class containing methods that relate to an application bundle’s audio (i.e. a collection of one or more AVAudioSession instances)

AVAudioApplicationMicrophoneInjectionPermissionAVAudioApplication

These are the values returned by microphoneInjectionPermission.

AVAudioApplicationRecordPermissionAVAudioApplication

These are the values returned by recordPermission.

AVAudioBufferAVAudioBuffer

A buffer of audio data, with a format.

AVAudioChannelLayoutAVAudioChannelLayout

A description of the roles of a set of audio channels.

AVAudioCommonFormatAVAudioFormat

A format other than one of the common ones below.

AVAudioCompressedBufferAVAudioBuffer

A subclass of AVAudioBuffer for use with compressed audio formats.

AVAudioConnectionPointAVAudioConnectionPoint

A representation of either a source or destination connection point in AVAudioEngine.

AVAudioContentSourceAVAudioSettings

Apple’s documentation

AVAudioConverterAVAudioConverter

Converts streams of audio between various formats.

AVAudioConverterInputStatusAVAudioConverter

You must return one of these codes from your AVAudioConverterInputBlock.

AVAudioConverterOutputStatusAVAudioConverter

These values are returned from convertToBuffer:error:withInputFromBlock:

AVAudioConverterPrimeInfoAVAudioConverter and AVAudioTypes

This struct is the value of the primeInfo property and specifies priming information.

AVAudioConverterPrimeMethodAVAudioConverter

values for the primeMethod property. See further discussion under AVAudioConverterPrimeInfo.

AVAudioDynamicRangeControlConfigurationAVAudioSettings

Apple’s documentation

AVAudioEngineAVAudioEngine

An AVAudioEngine contains a group of connected AVAudioNodes (“nodes”), each of which performs an audio signal generation, processing, or input/output task.

AVAudioEngineManualRenderingErrorAVAudioEngine

Error codes that could be returned from AVAudioEngine manual rendering mode methods, e.g. enableManualRenderingMode:format:maximumFrameCount:error: and renderOffline:toBuffer:error:. Note that this is not a comprehensive list, and the underlying audio units could return other error codes (e.g. see kAudioUnitErr_* in AudioToolbox/AUComponent.h) from these methods as applicable.

AVAudioEngineManualRenderingModeAVAudioEngine

By default, the engine is connected to an audio device and automatically renders in realtime. It can also be configured to operate in manual rendering mode, i.e. not connected to an audio device and rendering in response to requests from the client.

AVAudioEngineManualRenderingStatusAVAudioEngine

Status codes returned from the render call to the engine operating in manual rendering mode.

AVAudioEnvironmentDistanceAttenuationModelAVAudioEnvironmentNode

Types of distance attenuation models

AVAudioEnvironmentDistanceAttenuationParametersAVAudioEnvironmentNode

Parameters specifying the amount of distance attenuation

AVAudioEnvironmentNodeAVAudioEnvironmentNode and AVAudioNode

Mixer node that simulates a 3D environment

AVAudioEnvironmentOutputTypeAVAudioEnvironmentNode

Types of output for AVAudio3DMixingRenderingAlgorithmAuto

AVAudioEnvironmentReverbParametersAVAudioEnvironmentNode

Parameters used to control the reverb in AVAudioEnvironmentNode

AVAudioFileAVAudioFile

An audio file opened for reading or writing.

AVAudioFormatAVAudioFormat

A representation of an audio format.

AVAudioIONodeAVAudioIONode and AVAudioNode

Base class for a node that performs audio input or output in the engine.

AVAudioInputNodeAVAudioIONode and AVAudioNode

A node that performs audio input in the engine.

AVAudioMixerNodeAVAudioMixerNode and AVAudioNode

A node that mixes its inputs to a single output.

AVAudioMixingDestinationAVAudioMixing

An object representing a connection to a mixer node from a node that conforms to AVAudioMixing protocol

AVAudioNodeAVAudioNode

Base class for an audio generation, processing, or I/O block.

AVAudioOutputNodeAVAudioIONode and AVAudioNode

A node that performs audio output in the engine.

AVAudioPCMBufferAVAudioBuffer

A subclass of AVAudioBuffer for use with PCM audio formats.

AVAudioPlayerAVAudioPlayer

Apple’s documentation

AVAudioPlayerNodeAVAudioNode and AVAudioPlayerNode

Play buffers or segments of audio files.

AVAudioPlayerNodeBufferOptionsAVAudioPlayerNode

Options controlling buffer scheduling.

AVAudioPlayerNodeCompletionCallbackTypeAVAudioPlayerNode

Specifies when the completion handler must be invoked.

AVAudioQualityAVAudioSettings

Apple’s documentation

AVAudioRecorderAVAudioRecorder

An object that records audio data to a file.

AVAudioRoutingArbiterAVAudioRoutingArbiter

The interface to participate in audio routing arbitration.

AVAudioRoutingArbitrationCategoryAVAudioRoutingArbiter

The category describes the general type of audio that the app plans to use.

AVAudioSequencerAVAudioSequencer

A collection of MIDI events organized into AVMusicTracks, plus a player to play back the events.

AVAudioSessionAVAudioSession

Apple’s documentation

AVAudioSessionActivationOptionsAVAudioSessionTypes

For use with activateWithOptions:completionHandler:

AVAudioSessionCapabilityAVAudioSessionRoute

Describes whether a specific capability is supported and if that capability is currently enabled

AVAudioSessionCategoryOptionsAVAudioSessionTypes

Customization of various aspects of a category’s behavior. Use with AVAudioSession/setCategory:mode:options:error:.

AVAudioSessionChannelDescriptionAVAudioSessionRoute

Information about a port’s audio channels.

AVAudioSessionDataSourceDescriptionAVAudioSessionRoute

Information about one of potentially multiple data sources associated with a port.

AVAudioSessionIOTypeAVAudioSessionTypes

Values to be used by setAggregatedIOPreference:error: method.

AVAudioSessionInterruptionOptionsAVAudioSessionTypes

Values for AVAudioSessionInterruptionOptionKey in AVAudioSessionInterruptionNotification’s userInfo dictionary.

AVAudioSessionInterruptionReasonAVAudioSessionTypes

Values for AVAudioSessionInterruptionReasonKey in AVAudioSessionInterruptionNotification’s userInfo dictionary.

AVAudioSessionInterruptionTypeAVAudioSessionTypes

Values for AVAudioSessionInterruptionTypeKey in AVAudioSessionInterruptionNotification’s userInfo dictionary.

AVAudioSessionMicrophoneInjectionModeAVAudioSessionTypes

Various modes to inject audio coming from a session to another app’s input stream

AVAudioSessionPortDescriptionAVAudioSessionRoute

Information about a port, a physical connector or audio device.

AVAudioSessionPortExtensionBluetoothMicrophoneAVAudioSessionRoute

An object that describes capabilities of Bluetooth microphone ports.

AVAudioSessionPortOverrideAVAudioSessionTypes

For use with overrideOutputAudioPort:error:

AVAudioSessionPromptStyleAVAudioSessionTypes

The prompt style is a hint to sessions that use AVAudioSessionModeVoicePrompt to modify the type of prompt they play in response to other audio activity on the system, such as Siri or phone calls. Sessions that issue voice prompts are encouraged to pay attention to changes in the prompt style and modify their prompts in response. Apple encourages the use of non-verbal prompts when the Short style is requested.

AVAudioSessionRecordPermissionAVAudioSessionTypes

These are the values returned by recordPermission.

AVAudioSessionRenderingModeAVAudioSessionTypes

Apple’s documentation

AVAudioSessionRouteChangeReasonAVAudioSessionTypes

Values for AVAudioSessionRouteChangeReasonKey in AVAudioSessionRouteChangeNotification’s userInfo dictionary

AVAudioSessionRouteDescriptionAVAudioSessionRoute

A description of the input and output ports which comprise a route.

AVAudioSessionRouteSharingPolicyAVAudioSessionTypes

Starting in iOS 11, tvOS 11, and watchOS 5, the route sharing policy allows a session to specify that its output audio should be routed somewhere other than the default system output, when appropriate alternative routes are available.

AVAudioSessionSetActiveOptionsAVAudioSessionTypes

options for use when calling setActive:withOptions:error:

AVAudioSessionSilenceSecondaryAudioHintTypeAVAudioSessionTypes

Values for AVAudioSessionSilenceSecondaryAudioHintTypeKey in AVAudioSessionSilenceSecondaryAudioHintNotification’s userInfo dictionary, to indicate whether optional secondary audio muting should begin or end.

AVAudioSinkNodeAVAudioNode and AVAudioSinkNode

AVAudioSinkNode wraps a client provided block to receive input audio on the audio IO thread.

AVAudioSourceNodeAVAudioNode and AVAudioSourceNode

AVAudioSourceNode wraps a client provided block to supply audio.

AVAudioStereoOrientationAVAudioSessionTypes

Constants indicating stereo input audio orientation, for use with built-in mic input data sources with a stereo polar pattern selected.

AVAudioTimeAVAudioTime

Represent a moment in time.

AVAudioUnitAVAudioNode and AVAudioUnit

An AVAudioNode implemented by an audio unit.

AVAudioUnitComponentAVAudioUnitComponent

Provides details about an audio unit such as type, subtype, manufacturer, location etc. User tags can be added to the AVAudioUnitComponent which can be queried later for display.

AVAudioUnitComponentManagerAVAudioUnitComponent

A singleton object that provides an easy way to find audio components that are registered with the system.

AVAudioUnitDelayAVAudioNode and AVAudioUnit and AVAudioUnitDelay and AVAudioUnitEffect

an AVAudioUnitEffect that implements a delay effect

AVAudioUnitDistortionAVAudioNode and AVAudioUnit and AVAudioUnitDistortion and AVAudioUnitEffect

An AVAudioUnitEffect that implements a multi-stage distortion effect.

AVAudioUnitDistortionPresetAVAudioUnitDistortion

Apple’s documentation

AVAudioUnitEQAVAudioNode and AVAudioUnit and AVAudioUnitEQ and AVAudioUnitEffect

An AVAudioUnitEffect that implements a Multi-Band Equalizer.

AVAudioUnitEQFilterParametersAVAudioUnitEQ

Filter parameters used by AVAudioUnitEQ.

AVAudioUnitEQFilterTypeAVAudioUnitEQ

Filter types available to use with AVAudioUnitEQ.

AVAudioUnitEffectAVAudioNode and AVAudioUnit and AVAudioUnitEffect

an AVAudioUnit that processes audio in real-time

AVAudioUnitGeneratorAVAudioNode and AVAudioUnit and AVAudioUnitGenerator

an AVAudioUnit that generates audio output

AVAudioUnitMIDIInstrumentAVAudioNode and AVAudioUnit and AVAudioUnitMIDIInstrument

Base class for MIDI instruments.

AVAudioUnitReverbAVAudioNode and AVAudioUnit and AVAudioUnitEffect and AVAudioUnitReverb

an AVAudioUnitEffect that implements a reverb

AVAudioUnitReverbPresetAVAudioUnitReverb

Apple’s documentation

AVAudioUnitSamplerAVAudioNode and AVAudioUnit and AVAudioUnitMIDIInstrument and AVAudioUnitSampler

Apple’s sampler audio unit.

AVAudioUnitTimeEffectAVAudioNode and AVAudioUnit and AVAudioUnitTimeEffect

an AVAudioUnit that processes audio in non real-time

AVAudioUnitTimePitchAVAudioNode and AVAudioUnit and AVAudioUnitTimeEffect and AVAudioUnitTimePitch

an AVAudioUnitTimeEffect that provides good quality time stretching and pitch shifting

AVAudioUnitVarispeedAVAudioNode and AVAudioUnit and AVAudioUnitTimeEffect and AVAudioUnitVarispeed

an AVAudioUnitTimeEffect that can be used to control the playback rate

AVAudioVoiceProcessingOtherAudioDuckingConfigurationAVAudioIONode

The configuration of ducking other (i.e. non-voice) audio

AVAudioVoiceProcessingOtherAudioDuckingLevelAVAudioIONode

Ducking level applied to other (i.e. non-voice) audio by AVAudio voice processing AU.

AVAudioVoiceProcessingSpeechActivityEventAVAudioIONode

Types of speech activity events.

AVBeatRangeAVAudioSequencer and AVAudioTypes

Used to describe a specific time range within an AVMusicTrack.

AVExtendedNoteOnEventAVMusicEvents

The event class representing a custom extension of a MIDI note-on.

AVExtendedTempoEventAVMusicEvents

The event class representing a tempo change to a specific beats-per-minute value.

AVMIDIChannelEventAVMusicEvents

The event base class for all MIDI messages which operate on a single MIDI channel.

AVMIDIChannelPressureEventAVMusicEvents

The event class representing MIDI channel pressure messages.

AVMIDIControlChangeEventAVMusicEvents

The event class representing MIDI control change messages.

AVMIDIControlChangeMessageTypeAVMusicEvents

Types of MIDI control change events. See the General MIDI Specification for details.

AVMIDIMetaEventAVMusicEvents

The event class representing MIDI Meta-Event messages.

AVMIDIMetaEventTypeAVMusicEvents

Constants which indicate which type of MIDI Meta-Event to create.

AVMIDINoteEventAVMusicEvents

The event class representing MIDI note-on/off messages.

AVMIDIPitchBendEventAVMusicEvents

The event class representing MIDI pitch bend messages.

AVMIDIPlayerAVMIDIPlayer

A player for music file formats (MIDI, iMelody).

AVMIDIPolyPressureEventAVMusicEvents

The event class representing MIDI “poly” or “key” pressure messages.

AVMIDIProgramChangeEventAVMusicEvents

The event class representing MIDI program or patch change messages.

AVMIDISysexEventAVMusicEvents

The event class representing MIDI system exclusive messages.

AVMusicEventAVMusicEvents

The base class for all events associated with an AVMusicTrack.

AVMusicSequenceLoadOptionsAVAudioSequencer

Determines whether data on different MIDI channels is mapped to multiple tracks, or if the tracks are preserved as-is.

AVMusicTrackAVAudioSequencer

A collection of music events which will be sent to a given destination, and which can be offset, muted, etc. independently of events in other tracks.

AVMusicTrackLoopCountAVAudioSequencer

Apple’s documentation

AVMusicUserEventAVMusicEvents

The event class representing custom user messages.

AVParameterEventAVMusicEvents

The event class representing a parameter set/change event on the AVMusicTrack’s destinationAudioUnit.

AVSpeechBoundaryAVSpeechSynthesis

Apple’s documentation

AVSpeechSynthesisMarkerAVSpeechSynthesis

Apple’s documentation

AVSpeechSynthesisMarkerMarkAVSpeechSynthesis

Markers used in the output event callback. Used for providing metadata on synthesized audio.

AVSpeechSynthesisPersonalVoiceAuthorizationStatusAVSpeechSynthesis

Apple’s documentation

AVSpeechSynthesisProviderAudioUnitAVSpeechSynthesisProvider and objc2-audio-toolbox and non-watchOS

Apple’s documentation

AVSpeechSynthesisProviderRequestAVSpeechSynthesisProvider

An AVSpeechSynthesisProviderRequestgets delivered to an AVSpeechSynthesisProviderAudioUnitin order to synthesize audio. This is distinct from an AVSpeechUtterance,which is a generic utterance to be spoken.

AVSpeechSynthesisProviderVoiceAVSpeechSynthesisProvider

The representation of a provided voice that is available for speech synthesis.

AVSpeechSynthesisVoiceAVSpeechSynthesis

AVSpeechSynthesisVoice encapsulates the attributes of the voice used to synthesize speech on the system.

AVSpeechSynthesisVoiceGenderAVSpeechSynthesis

Apple’s documentation

AVSpeechSynthesisVoiceQualityAVSpeechSynthesis

Apple’s documentation

AVSpeechSynthesisVoiceTraitsAVSpeechSynthesis

Apple’s documentation

AVSpeechSynthesizerAVSpeechSynthesis

AVSpeechSynthesizer allows speaking of speech utterances with a basic queuing mechanism.

AVSpeechUtteranceAVSpeechSynthesis

AVSpeechUtterance is the atom of speaking a string or pausing the synthesizer.

Constants

AVAudioSessionInterruptionFlags_ShouldResumeDeprecatedAVAudioSessionDeprecated

Apple’s documentation

AVAudioSessionSetActiveFlags_NotifyOthersOnDeactivationDeprecatedAVAudioSessionDeprecated

Apple’s documentation

Statics

AVAudioApplicationInputMuteStateChangeNotification^⚠AVAudioApplication

Notification sent to registered listeners when the application’s input is muted or unmuted.

AVAudioApplicationMuteStateKey^⚠AVAudioApplication

Keys for AVAudioApplicationInputMuteStateChangeNotification Value is NSNumber type with boolean value 0 for unmuted or value 1 for muted (samples zeroed out)

AVAudioBitRateStrategy_Constant^⚠AVAudioSettings

Apple’s documentation

AVAudioBitRateStrategy_LongTermAverage^⚠AVAudioSettings

Apple’s documentation

AVAudioBitRateStrategy_Variable^⚠AVAudioSettings

Apple’s documentation

AVAudioBitRateStrategy_VariableConstrained^⚠AVAudioSettings

Apple’s documentation

AVAudioEngineConfigurationChangeNotification^⚠AVAudioEngine

A notification generated on engine configuration changes when rendering to/from an audio device.

AVAudioFileTypeKey^⚠AVAudioSettings

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyAlbum^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyApproximateDurationInSeconds^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyArtist^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyChannelLayout^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyComments^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyComposer^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyCopyright^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyEncodingApplication^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyGenre^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyISRC^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyKeySignature^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyLyricist^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyNominalBitRate^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyRecordedDate^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeySourceBitDepth^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeySourceEncoder^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeySubTitle^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyTempo^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyTimeSignature^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyTitle^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyTrackNumber^⚠AVAudioSequencer

Apple’s documentation

AVAudioSequencerInfoDictionaryKeyYear^⚠AVAudioSequencer

Apple’s documentation

AVAudioSessionAvailableInputsChangeNotification^⚠AVAudioSessionTypes

Notification sent to registered listeners when there are changes in availableInputs.

AVAudioSessionCategoryAmbient^⚠AVAudioSessionTypes

Use this category for background sounds such as rain, car engine noise, etc. Mixes with other music.

AVAudioSessionCategoryAudioProcessing^⚠DeprecatedAVAudioSessionTypes

Use this category when using a hardware codec or signal processor while not playing or recording audio.

AVAudioSessionCategoryMultiRoute^⚠AVAudioSessionTypes

Use this category to customize the usage of available audio accessories and built-in audio hardware. For example, this category provides an application with the ability to use an available USB output and headphone output simultaneously for separate, distinct streams of audio data. Use of this category by an application requires a more detailed knowledge of, and interaction with, the capabilities of the available audio routes. May be used for input, output, or both. Note that not all output types and output combinations are eligible for multi-route. Input is limited to the last-in input port. Eligible inputs consist of the following: AVAudioSessionPortUSBAudio, AVAudioSessionPortHeadsetMic, and AVAudioSessionPortBuiltInMic. Eligible outputs consist of the following: AVAudioSessionPortUSBAudio, AVAudioSessionPortLineOut, AVAudioSessionPortHeadphones, AVAudioSessionPortHDMI, and AVAudioSessionPortBuiltInSpeaker. Note that AVAudioSessionPortBuiltInSpeaker is only allowed to be used when there are no other eligible outputs connected.

AVAudioSessionCategoryPlayAndRecord^⚠AVAudioSessionTypes

Use this category when recording and playing back audio.

AVAudioSessionCategoryPlayback^⚠AVAudioSessionTypes

Use this category for music tracks.

AVAudioSessionCategoryRecord^⚠AVAudioSessionTypes

Use this category when recording audio.

AVAudioSessionCategorySoloAmbient^⚠AVAudioSessionTypes

Use this category for background sounds. Other music will stop playing.

AVAudioSessionInterruptionNotification^⚠AVAudioSessionTypes

Notification sent to registered listeners when the system has interrupted the audio session and when the interruption has ended.

AVAudioSessionInterruptionOptionKey^⚠AVAudioSessionTypes

Only present for end interruption events. Value is of type AVAudioSessionInterruptionOptions.

AVAudioSessionInterruptionReasonKey^⚠AVAudioSessionTypes

Only present in begin interruption events. Value is of type AVAudioSessionInterruptionReason.

AVAudioSessionInterruptionTypeKey^⚠AVAudioSessionTypes

keys for AVAudioSessionInterruptionNotification Value is an NSNumber representing an AVAudioSessionInterruptionType

AVAudioSessionInterruptionWasSuspendedKey^⚠DeprecatedAVAudioSessionTypes

Only present in begin interruption events, where the interruption is a direct result of the application being suspended by the operating sytem. Value is a boolean NSNumber, where a true value indicates that the interruption is the result of the application being suspended, rather than being interrupted by another audio session.

AVAudioSessionLocationLower^⚠AVAudioSessionRoute

Apple’s documentation

AVAudioSessionLocationUpper^⚠AVAudioSessionRoute

Apple’s documentation

AVAudioSessionMediaServicesWereLostNotification^⚠AVAudioSessionTypes

Notification sent to registered listeners if the media server is killed.

AVAudioSessionMediaServicesWereResetNotification^⚠AVAudioSessionTypes

Notification sent to registered listeners when the media server restarts.

AVAudioSessionMicrophoneInjectionCapabilitiesChangeNotification^⚠AVAudioSessionTypes

Notification sent to registered listeners when the system’s capability to inject audio into input stream is changed

AVAudioSessionMicrophoneInjectionIsAvailableKey^⚠AVAudioSessionTypes

Keys for AVAudioSessionMicrophoneInjectionCapabilitiesChangeNotification

AVAudioSessionModeDefault^⚠AVAudioSessionTypes

The default mode

AVAudioSessionModeGameChat^⚠AVAudioSessionTypes

Set by Game Kit on behalf of an application that uses a GKVoiceChat object; valid only with the AVAudioSessionCategoryPlayAndRecord category. Do not set this mode directly. If you need similar behavior and are not using a GKVoiceChat object, use AVAudioSessionModeVoiceChat instead.

AVAudioSessionModeMeasurement^⚠AVAudioSessionTypes

Appropriate for applications that wish to minimize the effect of system-supplied signal processing for input and/or output audio signals. This mode disables some dynamics processing on input and output resulting in a lower output playback level.

AVAudioSessionModeMoviePlayback^⚠AVAudioSessionTypes

Appropriate for applications playing movie content. Only valid with AVAudioSessionCategoryPlayback. Setting this mode engages appropriate output signal processing for movie playback scenarios. Content using this mode is eligible for Enhance Dialogue processing on supported routes with capable hardware

AVAudioSessionModeShortFormVideo^⚠AVAudioSessionTypes

Appropriate for applications playing short-form video content.

AVAudioSessionModeSpokenAudio^⚠AVAudioSessionTypes

Appropriate for applications which play spoken audio and wish to be paused (via audio session interruption) rather than ducked if another app (such as a navigation app) plays a spoken audio prompt. Examples of apps that would use this are podcast players and audio books. For more information, see the related category option AVAudioSessionCategoryOptionInterruptSpokenAudioAndMixWithOthers.

AVAudioSessionModeVideoChat^⚠AVAudioSessionTypes

Only valid with kAudioSessionCategory_PlayAndRecord. Reduces the number of allowable audio routes to be only those that are appropriate for video chat applications. May engage appropriate system-supplied signal processing. Has the side effect of setting AVAudioSessionCategoryOptionAllowBluetoothHFP and AVAudioSessionCategoryOptionDefaultToSpeaker. Using this mode without the VoiceProcessing IO unit or AVAudioEngine with voice processing enabled will result in the following:

AVAudioSessionModeVideoRecording^⚠AVAudioSessionTypes

Only valid with AVAudioSessionCategoryPlayAndRecord or AVAudioSessionCategoryRecord. Modifies the audio routing options and may engage appropriate system-supplied signal processing.

AVAudioSessionModeVoiceChat^⚠AVAudioSessionTypes

Only valid with AVAudioSessionCategoryPlayAndRecord. Appropriate for Voice over IP (VoIP) applications. Reduces the number of allowable audio routes to be only those that are appropriate for VoIP applications and may engage appropriate system-supplied signal processing. Has the side effect of setting AVAudioSessionCategoryOptionAllowBluetoothHFP. Using this mode without the VoiceProcessing IO unit or AVAudioEngine with voice processing enabled will result in the following:

AVAudioSessionModeVoicePrompt^⚠AVAudioSessionTypes

Appropriate for applications which play audio using text to speech. Setting this mode allows for different routing behaviors when connected to certain audio devices such as CarPlay. An example of an app that would use this mode is a turn by turn navigation app that plays short prompts to the user. Typically, these same types of applications would also configure their session to use AVAudioSessionCategoryOptionDuckOthers and AVAudioSessionCategoryOptionInterruptSpokenAudioAndMixWithOthers

AVAudioSessionMuteStateKey^⚠AVAudioSessionTypes

Keys for AVAudioSessionOutputMuteStateChangeNotification Value is NSNumber type with boolean value 0 for unmuted or value 1 for muted (samples zeroed out)

AVAudioSessionOrientationBack^⚠AVAudioSessionRoute

Apple’s documentation

AVAudioSessionOrientationBottom^⚠AVAudioSessionRoute

Apple’s documentation

AVAudioSessionOrientationFront^⚠AVAudioSessionRoute

Apple’s documentation

AVAudioSessionOrientationLeft^⚠AVAudioSessionRoute

Apple’s documentation

AVAudioSessionOrientationRight^⚠AVAudioSessionRoute

Apple’s documentation

AVAudioSessionOrientationTop^⚠AVAudioSessionRoute

Apple’s documentation

AVAudioSessionOutputMuteStateChangeNotification^⚠AVAudioSessionTypes

Notification sent to registered listeners when session’s output mute state changes.

AVAudioSessionPolarPatternCardioid^⚠AVAudioSessionRoute

Apple’s documentation

AVAudioSessionPolarPatternOmnidirectional^⚠AVAudioSessionRoute

Apple’s documentation

AVAudioSessionPolarPatternStereo^⚠AVAudioSessionRoute

If you select a data source with AVAudioSessionPolarPatternStereo, then you must call setPreferredInputOrientation:error: on your Audio Session so that left and right are presented from the correct directions.

AVAudioSessionPolarPatternSubcardioid^⚠AVAudioSessionRoute

Apple’s documentation

AVAudioSessionPortAVB^⚠AVAudioSessionTypes

Input or output connected via AVB (Audio Video Bridging)

AVAudioSessionPortAirPlay^⚠AVAudioSessionTypes

Output on a remote Air Play device

AVAudioSessionPortBluetoothA2DP^⚠AVAudioSessionTypes

Output on a Bluetooth A2DP device

AVAudioSessionPortBluetoothHFP^⚠AVAudioSessionTypes

Input or output on a Bluetooth Hands-Free Profile device

AVAudioSessionPortBluetoothLE^⚠AVAudioSessionTypes

Output on a Bluetooth Low Energy device

AVAudioSessionPortBuiltInMic^⚠AVAudioSessionTypes

Built-in microphone on an iOS device

AVAudioSessionPortBuiltInReceiver^⚠AVAudioSessionTypes

The speaker you hold to your ear when on a phone call

AVAudioSessionPortBuiltInSpeaker^⚠AVAudioSessionTypes

Built-in speaker on an iOS device

AVAudioSessionPortCarAudio^⚠AVAudioSessionTypes

Input or output via Car Audio

AVAudioSessionPortContinuityMicrophone^⚠AVAudioSessionTypes

Continuity microphone for appletv.

AVAudioSessionPortDisplayPort^⚠AVAudioSessionTypes

Input or output connected via DisplayPort

AVAudioSessionPortFireWire^⚠AVAudioSessionTypes

Input or output connected via FireWire

AVAudioSessionPortHDMI^⚠AVAudioSessionTypes

Output via High-Definition Multimedia Interface

AVAudioSessionPortHeadphones^⚠AVAudioSessionTypes

Headphone or headset output

AVAudioSessionPortHeadsetMic^⚠AVAudioSessionTypes

Microphone on a wired headset. Headset refers to an accessory that has headphone outputs paired with a microphone.

AVAudioSessionPortLineIn^⚠AVAudioSessionTypes

Line level input on a dock connector

AVAudioSessionPortLineOut^⚠AVAudioSessionTypes

Line level output on a dock connector

AVAudioSessionPortPCI^⚠AVAudioSessionTypes

Input or output connected via the PCI (Peripheral Component Interconnect) bus

AVAudioSessionPortThunderbolt^⚠AVAudioSessionTypes

Input or output connected via Thunderbolt

AVAudioSessionPortUSBAudio^⚠AVAudioSessionTypes

Input or output on a Universal Serial Bus device

AVAudioSessionPortVirtual^⚠AVAudioSessionTypes

Input or output that does not correspond to real audio hardware

AVAudioSessionRenderingCapabilitiesChangeNotification^⚠AVAudioSessionTypes

Notification sent to registered listeners when the rendering capabilities change.

AVAudioSessionRenderingModeChangeNotification^⚠AVAudioSessionTypes

Notification sent to registered listeners when the resolved rendering mode changes.

AVAudioSessionRenderingModeNewRenderingModeKey^⚠AVAudioSessionTypes

keys for AVAudioSessionRenderingModeChangeNotification Contains a payload of NSInteger representing the new resolved rendering mode

AVAudioSessionRouteChangeNotification^⚠AVAudioSessionTypes

Notification sent to registered listeners when an audio route change has occurred.

AVAudioSessionRouteChangePreviousRouteKey^⚠AVAudioSessionTypes

value is AVAudioSessionRouteDescription *

AVAudioSessionRouteChangeReasonKey^⚠AVAudioSessionTypes

keys for AVAudioSessionRouteChangeNotification value is an NSNumber representing an AVAudioSessionRouteChangeReason

AVAudioSessionSilenceSecondaryAudioHintNotification^⚠AVAudioSessionTypes

Notification sent to registered listeners when they are in the foreground with an active audio session and primary audio from other applications starts and stops.

AVAudioSessionSilenceSecondaryAudioHintTypeKey^⚠AVAudioSessionTypes

keys for AVAudioSessionSilenceSecondaryAudioHintNotification value is an NSNumber representing an AVAudioSessionSilenceSecondaryAudioHintType

AVAudioSessionSpatialAudioEnabledKey^⚠AVAudioSessionTypes

keys for AVAudioSessionSpatialPlaybackCapabilitiesChangedNotification value is an NSNumber whose boolean value indicates if spatial audio enabled.

AVAudioSessionSpatialPlaybackCapabilitiesChangedNotification^⚠AVAudioSessionTypes

Notification sent to registered listeners when spatial playback capabilities are changed due to a change in user preference.

AVAudioSessionUserIntentToUnmuteOutputNotification^⚠AVAudioSessionTypes

Notification sent to registered listeners when the application’s output is muted and user hints to unmute.

AVAudioUnitComponentManagerRegistrationsChangedNotification^⚠AVAudioUnitComponent

A notification generated when AVAudioUnitComponentManager updates its list of components.

AVAudioUnitComponentTagsDidChangeNotification^⚠AVAudioUnitComponent

Apple’s documentation

AVAudioUnitManufacturerNameApple^⚠AVAudioUnitComponent

Apple’s documentation

AVAudioUnitTypeEffect^⚠AVAudioUnitComponent

Apple’s documentation

AVAudioUnitTypeFormatConverter^⚠AVAudioUnitComponent

Apple’s documentation

AVAudioUnitTypeGenerator^⚠AVAudioUnitComponent

Apple’s documentation

AVAudioUnitTypeMIDIProcessor^⚠AVAudioUnitComponent

Apple’s documentation

AVAudioUnitTypeMixer^⚠AVAudioUnitComponent

Apple’s documentation

AVAudioUnitTypeMusicDevice^⚠AVAudioUnitComponent

Apple’s documentation

AVAudioUnitTypeMusicEffect^⚠AVAudioUnitComponent

Apple’s documentation

AVAudioUnitTypeOfflineEffect^⚠AVAudioUnitComponent

Apple’s documentation

AVAudioUnitTypeOutput^⚠AVAudioUnitComponent

Apple’s documentation

AVAudioUnitTypePanner^⚠AVAudioUnitComponent

Apple’s documentation

AVChannelLayoutKey^⚠AVAudioSettings

Apple’s documentation

AVEncoderASPFrequencyKey^⚠AVAudioSettings

Apple’s documentation

AVEncoderAudioQualityForVBRKey^⚠AVAudioSettings

Apple’s documentation

AVEncoderAudioQualityKey^⚠AVAudioSettings

Apple’s documentation

AVEncoderBitDepthHintKey^⚠AVAudioSettings

Apple’s documentation

AVEncoderBitRateKey^⚠AVAudioSettings

Apple’s documentation

AVEncoderBitRatePerChannelKey^⚠AVAudioSettings

Apple’s documentation

AVEncoderBitRateStrategyKey^⚠AVAudioSettings

Apple’s documentation

AVEncoderContentSourceKey^⚠AVAudioSettings

Apple’s documentation

AVEncoderDynamicRangeControlConfigurationKey^⚠AVAudioSettings

Apple’s documentation

AVExtendedNoteOnEventDefaultInstrument^⚠AVMusicEvents

A constant representing the default instrument ID to use for an AVExtendedNoteOnEvent. This indicates to the system to use the instrument currently loaded on the channel referenced by the groupID. This is the only supported value at this time.

AVFormatIDKey^⚠AVAudioSettings

Apple’s documentation

AVLinearPCMBitDepthKey^⚠AVAudioSettings

Apple’s documentation

AVLinearPCMIsBigEndianKey^⚠AVAudioSettings

Apple’s documentation

AVLinearPCMIsFloatKey^⚠AVAudioSettings

Apple’s documentation

AVLinearPCMIsNonInterleaved^⚠AVAudioSettings

Apple’s documentation

AVNumberOfChannelsKey^⚠AVAudioSettings

Apple’s documentation

AVSampleRateConverterAlgorithmKey^⚠AVAudioSettings

Apple’s documentation

AVSampleRateConverterAlgorithm_Mastering^⚠AVAudioSettings

Apple’s documentation

AVSampleRateConverterAlgorithm_MinimumPhase^⚠AVAudioSettings

Apple’s documentation

AVSampleRateConverterAlgorithm_Normal^⚠AVAudioSettings

Apple’s documentation

AVSampleRateConverterAudioQualityKey^⚠AVAudioSettings

Apple’s documentation

AVSampleRateKey^⚠AVAudioSettings

Apple’s documentation

AVSpeechSynthesisAvailableVoicesDidChangeNotification^⚠AVSpeechSynthesis

Posted when available voices for speech synthesis on the system have changed. For example, if new 3rd party voices are available through a downloaded app, or if a new personal voice is available and the app is authorized to access personal voices.

AVSpeechSynthesisIPANotationAttribute^⚠AVSpeechSynthesis

Apple’s documentation

AVSpeechSynthesisVoiceIdentifierAlex^⚠AVSpeechSynthesis

Apple’s documentation

AVSpeechUtteranceDefaultSpeechRate^⚠AVSpeechSynthesis

Apple’s documentation

AVSpeechUtteranceMaximumSpeechRate^⚠AVSpeechSynthesis

Apple’s documentation

AVSpeechUtteranceMinimumSpeechRate^⚠AVSpeechSynthesis

Apple’s documentation

Traits

AVAudio3DMixingAVAudioMixing

Protocol that defines 3D mixing properties

AVAudioMixingAVAudioMixing

Protocol that defines properties applicable to the input bus of a mixer node

AVAudioPlayerDelegateAVAudioPlayer

Apple’s documentation

AVAudioRecorderDelegateAVAudioRecorder

A protocol for delegates of AVAudioRecorder.

AVAudioSessionDelegateDeprecatedAVAudioSessionDeprecated

Apple’s documentation

AVAudioStereoMixingAVAudioMixing

Protocol that defines stereo mixing properties

AVSpeechSynthesizerDelegateAVSpeechSynthesis

Defines an interface for delegates of AVSpeechSynthesizer to receive notifications of important speech utterance events.

Type Aliases

AVAudio3DVectorAVAudioTypes

Struct representing a vector in 3D space

AVAudioChannelCountAVAudioTypes

A number of audio channels.

AVAudioConverterInputBlockAVAudioBuffer and AVAudioConverter and AVAudioTypes and block2

A block which will be called by convertToBuffer:error:withInputFromBlock: to get input data as needed.

AVAudioEngineManualRenderingBlockAVAudioEngine and AVAudioTypes and block2 and objc2-core-audio-types

Block to render the engine when operating in manual rendering mode

AVAudioFrameCountAVAudioTypes

A number of audio sample frames.

AVAudioFramePositionAVAudioTypes

A position in an audio file or stream.

AVAudioIONodeInputBlockAVAudioIONode and AVAudioTypes and block2 and objc2-core-audio-types

A block which will be called by AVAudioEngine’s render call when operating in the manual rendering mode, to get input data as needed.

AVAudioNodeBusAVAudioTypes

The index of a bus on an AVAudioNode.

AVAudioNodeCompletionHandlerAVAudioTypes and block2

Generic callback handler.

AVAudioNodeTapBlockAVAudioBuffer and AVAudioNode and AVAudioTime and block2

A block that receives copies of the output of an AVAudioNode.

AVAudioPacketCountAVAudioTypes

A number of packets of compressed audio data.

AVAudioPlayerNodeCompletionHandlerAVAudioPlayerNode and block2

Buffer or file completion callback handler.

AVAudioSequencerInfoDictionaryKeyAVAudioSequencer

Apple’s documentation

AVAudioSequencerUserCallbackAVAudioSequencer and AVAudioTypes and block2

Apple’s documentation

AVAudioSessionCategoryAVAudioSessionTypes

A category defines a broad set of behaviors for a session.

AVAudioSessionLocationAVAudioSessionRoute

The location of a data source on an iOS device.

AVAudioSessionModeAVAudioSessionTypes

Modes modify the audio category in order to introduce behavior that is tailored to the specific use of audio within an application. Available in iOS 5.0 and greater.

AVAudioSessionOrientationAVAudioSessionRoute

The orientation or directionality of a data source on an iOS device.

AVAudioSessionPolarPatternAVAudioSessionRoute

The possible polar patterns for a data source on an iOS device.

AVAudioSessionPortAVAudioSessionTypes

A port describes a specific type of audio input or output device or connector.

AVAudioSinkNodeReceiverBlockAVAudioSinkNode and AVAudioTypes and block2 and objc2-core-audio-types

Block to receive audio data from AVAudioSinkNode

AVAudioSourceNodeRenderBlockAVAudioSourceNode and AVAudioTypes and block2 and objc2-core-audio-types

Block to supply audio data to AVAudioSourceNode

AVMIDIPlayerCompletionHandlerAVMIDIPlayer and block2

Generic callback block.

AVMusicEventEnumerationBlockAVAudioSequencer and AVAudioTypes and AVMusicEvents and block2

The block type used to enumerate and optionally remove AVMusicEvents when using AVMusicTrack(enumerateEventsInRange:usingBlock:)

AVMusicTimeStampAVAudioTypes

The time position in beats of playback and events in the AVAudioSequencer and its components.

AVSpeechSynthesisProviderOutputBlockAVSpeechSynthesis and AVSpeechSynthesisProvider and block2

A block of information that is relevant to the generation of speech synthesis.

AVSpeechSynthesizerBufferCallbackAVAudioBuffer and AVSpeechSynthesis and block2

Apple’s documentation

AVSpeechSynthesizerMarkerCallbackAVSpeechSynthesis and block2

Apple’s documentation