avfaudio

func (*AVAUPresetEvent) Element ¶

func (o *AVAUPresetEvent) Element() uint

@property element The element index within the scope (see AudioUnitElement). This should usually be set to 0.

func (*AVAUPresetEvent) InitWithScopeElementDictionary ¶

func (o *AVAUPresetEvent) InitWithScopeElementDictionary(scope uint, element uint, presetDictionary *foundation.NSDictionary[objc.ID, objc.ID]) *AVAUPresetEvent

@method initWithScope:element:dictionary @abstract Initialize the event with the scope, element, and dictionary for the preset. @param scope The audio unit scope for the parameter (see AudioUnitScope). This should always be set to Global. @param element The element index within the scope (see AudioUnitElement). This should usually be set to 0. @param presetDictionary An NSDictionary containing the preset. The audio unit will expect this to be a dictionary structured as an appropriate audio unit preset. @discussion The dictionary passed to this initializer will be copied and is not editable once the event is created.

func (*AVAUPresetEvent) PresetDictionary ¶

func (o *AVAUPresetEvent) PresetDictionary() *foundation.NSDictionary[objc.ID, objc.ID]

@property presetDictionary An NSDictionary containing the preset.

func (*AVAUPresetEvent) Scope ¶

func (o *AVAUPresetEvent) Scope() uint

@property scope The audio unit scope for the parameter (see AudioUnitScope). This should always be set to Global.

func (*AVAUPresetEvent) SetElement ¶

func (o *AVAUPresetEvent) SetElement(element uint)

func (*AVAUPresetEvent) SetScope ¶

func (o *AVAUPresetEvent) SetScope(scope uint)

func (AVAudio3DMixingPointSourceInHeadMode) String ¶

func (e AVAudio3DMixingPointSourceInHeadMode) String() string

func (AVAudio3DMixingRenderingAlgorithm) String ¶

func (e AVAudio3DMixingRenderingAlgorithm) String() string

func (AVAudio3DMixingSourceMode) String ¶

func (e AVAudio3DMixingSourceMode) String() string

func (*AVAudioApplication) IsInputMuted ¶

func (o *AVAudioApplication) IsInputMuted() bool

Get the input muted state - return value is boolean 0 for unmuted or value 1 for muted (input samples zeroed out)

func (*AVAudioApplication) RecordPermission ¶

func (o *AVAudioApplication) RecordPermission() AVAudioApplicationRecordPermission

Returns an enum indicating whether the user has granted or denied permission to record, or has not been asked

func (*AVAudioApplication) SetInputMuteStateChangeHandlerError ¶

func (o *AVAudioApplication) SetInputMuteStateChangeHandlerError(inputMuteHandler func(bool) bool) (bool, error)

@brief Provide a block that implements your app's input (microphone) muting logic (macOS only). The block will be called whenever the input mute state changes, either due to changing the `AVAudioApplication.inputMute` property on this API, or due to a Bluetooth audio accessory gesture (certain AirPods / Beats headphones) changing the mute state. @param inputMuteHandler block that will be called upon every input mute state change. If the boolean `inputShouldBeMuted` is true, your block should mute all input/microphone samples until the next time the handler is called. Your block should return a value of YES if successful, or in exceptional cases return a NO value if the mute action was unsuccesful. Since the input mute handling logic should happen a single place, subsequent calls to this method will overwrite any previously registered block with the one provided. A nil value may be provided to cancel the block being called, e.g. at end of call lifecycle. @note This is available on macOS only - for all other platforms input muting will be handled internally. It is recommended only to perform your input muting logic within this block, and to perform your UI updates for input mute state changes within the handler for AVAudioApplicationInputMuteStateChangeNotification. This handler should be set by the process doing the call's audio I/O.

func (*AVAudioApplication) SetInputMutedError ¶

func (o *AVAudioApplication) SetInputMutedError(muted bool) (bool, error)

@brief Set the muted/unmuted state of the application's audio input. When set true, inputs (microphone etc.) of all audio clients relating to this application will have their samples zeroed out. @note - this is per-application input muting and doesn't affect the hardware mute state.

func (AVAudioApplicationMicrophoneInjectionPermission) String ¶

func (e AVAudioApplicationMicrophoneInjectionPermission) String() string

func (AVAudioApplicationRecordPermission) String ¶

func (e AVAudioApplicationRecordPermission) String() string

func (*AVAudioBuffer) AudioBufferList ¶

func (o *AVAudioBuffer) AudioBufferList() *coreaudiotypes.AudioBufferList

@property audioBufferList @abstract The buffer's underlying AudioBufferList. @discussion For compatibility with lower-level CoreAudio and AudioToolbox API's, this method accesses the buffer implementation's internal AudioBufferList. The buffer list structure must not be modified, though you may modify buffer contents. The mDataByteSize fields of this AudioBufferList express the buffer's current frameLength.

func (*AVAudioBuffer) Format ¶

func (o *AVAudioBuffer) Format() *AVAudioFormat

@property format @abstract The format of the audio in the buffer.

func (*AVAudioBuffer) MutableAudioBufferList ¶

func (o *AVAudioBuffer) MutableAudioBufferList() *coreaudiotypes.AudioBufferList

@property mutableAudioBufferList @abstract A mutable version of the buffer's underlying AudioBufferList. @discussion Some lower-level CoreAudio and AudioToolbox API's require a mutable AudioBufferList, for example, AudioConverterConvertComplexBuffer. The mDataByteSize fields of this AudioBufferList express the buffer's current frameCapacity. If they are altered, you should modify the buffer's frameLength to match.

func (*AVAudioChannelLayout) ChannelCount ¶

func (o *AVAudioChannelLayout) ChannelCount() uint32

@property channelCount @abstract The number of channels of audio data.

func (*AVAudioChannelLayout) InitWithLayout ¶

func (o *AVAudioChannelLayout) InitWithLayout(layout *coreaudiotypes.AudioChannelLayout) *AVAudioChannelLayout

@method initWithLayout: @abstract Initialize from an AudioChannelLayout. @param layout The AudioChannelLayout. @discussion If the provided layout's tag is kAudioChannelLayoutTag_UseChannelDescriptions, this initializer attempts to convert it to a more specific tag.

func (*AVAudioChannelLayout) InitWithLayoutTag ¶

func (o *AVAudioChannelLayout) InitWithLayoutTag(layoutTag uint) *AVAudioChannelLayout

@method initWithLayoutTag: @abstract Initialize from a layout tag. @param layoutTag The tag. @discussion Returns nil if the tag is either kAudioChannelLayoutTag_UseChannelDescriptions or kAudioChannelLayoutTag_UseChannelBitmap.

func (*AVAudioChannelLayout) IsEqual ¶

func (o *AVAudioChannelLayout) IsEqual(object objc.ID) bool

@method isEqual: @abstract Determine whether another AVAudioChannelLayout is exactly equal to this layout. @param object The AVAudioChannelLayout to compare against. @discussion The underlying AudioChannelLayoutTag and AudioChannelLayout are compared for equality.

func (*AVAudioChannelLayout) Layout ¶

func (o *AVAudioChannelLayout) Layout() *coreaudiotypes.AudioChannelLayout

@property layout @abstract The underlying AudioChannelLayout.

func (*AVAudioChannelLayout) LayoutTag ¶

func (o *AVAudioChannelLayout) LayoutTag() uint

@property layoutTag @abstract The layout's tag.

func (AVAudioCommonFormat) String ¶

func (e AVAudioCommonFormat) String() string

func (*AVAudioCompressedBuffer) ByteCapacity ¶

func (o *AVAudioCompressedBuffer) ByteCapacity() uint32

@property byteCapacity @abstract The buffer's capacity in bytes

func (*AVAudioCompressedBuffer) ByteLength ¶

func (o *AVAudioCompressedBuffer) ByteLength() uint32

@property byteLength @abstract The current number of valid bytes in the buffer. @discussion Can be changed as part of an operation that modifies the contents.

func (*AVAudioCompressedBuffer) Data ¶

func (o *AVAudioCompressedBuffer) Data() unsafe.Pointer

@property data @abstract Access the buffer's data bytes.

func (*AVAudioCompressedBuffer) InitWithFormatPacketCapacity ¶

func (o *AVAudioCompressedBuffer) InitWithFormatPacketCapacity(format *AVAudioFormat, packetCapacity uint32) *AVAudioCompressedBuffer

@method initWithFormat:packetCapacity: @abstract Initialize a buffer that is to contain constant bytes per packet compressed audio data. @param format The format of the audio to be contained in the buffer. @param packetCapacity The capacity of the buffer in packets. @discussion This fails if the format is PCM or if the format has variable bytes per packet (format.streamDescription->mBytesPerPacket == 0).

func (*AVAudioCompressedBuffer) InitWithFormatPacketCapacityMaximumPacketSize ¶

func (o *AVAudioCompressedBuffer) InitWithFormatPacketCapacityMaximumPacketSize(format *AVAudioFormat, packetCapacity uint32, maximumPacketSize int) *AVAudioCompressedBuffer

@method initWithFormat:packetCapacity:maximumPacketSize: @abstract Initialize a buffer that is to contain compressed audio data. @param format The format of the audio to be contained in the buffer. @param packetCapacity The capacity of the buffer in packets. @param maximumPacketSize The maximum size in bytes of a compressed packet. The maximum packet size can be obtained from the maximumOutputPacketSize property of an AVAudioConverter configured for encoding this format. @discussion An exception is raised if the format is PCM.

func (*AVAudioCompressedBuffer) MaximumPacketSize ¶

func (o *AVAudioCompressedBuffer) MaximumPacketSize() int

@property maximumPacketSize @abstract The maximum size of a compressed packet in bytes.

func (*AVAudioCompressedBuffer) PacketCapacity ¶

func (o *AVAudioCompressedBuffer) PacketCapacity() uint32

@property packetCapacity @abstract The number of compressed packets the buffer can contain.

func (*AVAudioCompressedBuffer) PacketCount ¶

func (o *AVAudioCompressedBuffer) PacketCount() uint32

@property packetCount @abstract The current number of compressed packets in the buffer. @discussion You may modify the packetCount as part of an operation that modifies its contents. The packetCount must be less than or equal to the packetCapacity.

func (*AVAudioCompressedBuffer) PacketDependencies ¶

func (o *AVAudioCompressedBuffer) PacketDependencies() *coreaudiotypes.AudioStreamPacketDependencyDescription

@property packetDependencies @abstract Access the buffer's array of packet dependencies, if any. @discussion If the format doesn't employ packet dependencies, this will be nil.

func (*AVAudioCompressedBuffer) PacketDescriptions ¶

func (o *AVAudioCompressedBuffer) PacketDescriptions() *coreaudiotypes.AudioStreamPacketDescription

@property packetDescriptions @abstract Access the buffer's array of packet descriptions, if any. @discussion If the format has constant bytes per packet (format.streamDescription->mBytesPerPacket != 0), then this will return nil.

func (*AVAudioCompressedBuffer) SetByteLength ¶

func (o *AVAudioCompressedBuffer) SetByteLength(byteLength uint32)

func (*AVAudioCompressedBuffer) SetPacketCount ¶

func (o *AVAudioCompressedBuffer) SetPacketCount(packetCount uint32)

func (*AVAudioConnectionPoint) Bus ¶

func (o *AVAudioConnectionPoint) Bus() uint

@property bus @abstract Returns the bus on the node in the connection point.

func (*AVAudioConnectionPoint) InitWithNodeBus ¶

func (o *AVAudioConnectionPoint) InitWithNodeBus(node *AVAudioNode, bus uint) *AVAudioConnectionPoint

@method initWithNode:bus: @abstract Create a connection point object. @param node the source or destination node @param bus the output or input bus on the node @discussion If the node is nil, this method fails (returns nil).

func (*AVAudioConnectionPoint) Node ¶

func (o *AVAudioConnectionPoint) Node() *AVAudioNode

@property node @abstract Returns the node in the connection point.

func (AVAudioContentSource) String ¶

func (e AVAudioContentSource) String() string

func (*AVAudioConverter) ApplicableEncodeBitRates ¶

func (o *AVAudioConverter) ApplicableEncodeBitRates() *foundation.NSArray[*foundation.NSNumber]

@property applicableEncodeBitRates @abstract When encoding, an NSArray of NSNumber of bit rates that can be applied based on the current formats and settings. Returns nil if not encoding.

func (*AVAudioConverter) ApplicableEncodeSampleRates ¶

func (o *AVAudioConverter) ApplicableEncodeSampleRates() *foundation.NSArray[*foundation.NSNumber]

@property applicableEncodeSampleRates @abstract When encoding, an NSArray of NSNumber of output sample rates that can be applied based on the current formats and settings. Returns nil if not encoding.

func (*AVAudioConverter) AudioSyncPacketFrequency ¶

func (o *AVAudioConverter) AudioSyncPacketFrequency() int

@property audioSyncPacketFrequency @abstract Number of packets between consecutive sync packets. @discussion A sync packet is an independently-decodable packet that completely refreshes the decoder without needing to decode other packets. When compressing to a format which supports it (such as APAC), the audio sync packet frequency indicates the distance in packets between two sync packets, with non-sync packets between. This is useful to set when saving compressed packets to a file and efficient random access is desired. Note: Separating sync packets by at least one second of encoded audio (e.g. 75 packets) is recommended.

func (*AVAudioConverter) AvailableEncodeBitRates ¶

func (o *AVAudioConverter) AvailableEncodeBitRates() *foundation.NSArray[*foundation.NSNumber]

@property availableEncodeBitRates @abstract When encoding, an NSArray of NSNumber of all bit rates provided by the codec. Returns nil if not encoding.

func (*AVAudioConverter) AvailableEncodeChannelLayoutTags ¶

func (o *AVAudioConverter) AvailableEncodeChannelLayoutTags() *foundation.NSArray[*foundation.NSNumber]

@property availableEncodeChannelLayoutTags @abstract When encoding, an NSArray of NSNumber of all output channel layout tags provided by the codec. Returns nil if not encoding.

func (*AVAudioConverter) AvailableEncodeSampleRates ¶

func (o *AVAudioConverter) AvailableEncodeSampleRates() *foundation.NSArray[*foundation.NSNumber]

@property availableEncodeSampleRates @abstract When encoding, an NSArray of NSNumber of all output sample rates provided by the codec. Returns nil if not encoding.

func (*AVAudioConverter) BitRate ¶

func (o *AVAudioConverter) BitRate() int

@property bitRate @abstract bitRate in bits per second. Only applies when encoding.

func (*AVAudioConverter) BitRateStrategy ¶

func (o *AVAudioConverter) BitRateStrategy() *foundation.NSString

@property bitRateStrategy @abstract When encoding, an AVEncoderBitRateStrategyKey value constant as defined in AVAudioSettings.h. Returns nil if not encoding.

func (*AVAudioConverter) ChannelMap ¶

func (o *AVAudioConverter) ChannelMap() *foundation.NSArray[*foundation.NSNumber]

@property channelMap @abstract An array of integers indicating from which input to derive each output. @discussion The array has size equal to the number of output channels. Each element's value is the input channel number, starting with zero, that is to be copied to that output. A negative value means that the output channel will have no source and will be silent. Setting a channel map overrides channel mapping due to any channel layouts in the input and output formats that may have been supplied.

func (*AVAudioConverter) ContentSource ¶

func (o *AVAudioConverter) ContentSource() AVAudioContentSource

@property contentSource @abstract Index to select a pre-defined content source type that describes the content type and how it was generated. Note: This is only supported when compressing audio to formats which support it.

func (*AVAudioConverter) ConvertToBufferErrorWithInputFromBlock ¶

func (o *AVAudioConverter) ConvertToBufferErrorWithInputFromBlock(outputBuffer *AVAudioBuffer, outError unsafe.Pointer, inputBlock objc.Block) AVAudioConverterOutputStatus

@method convertToBuffer:error:withInputFromBlock: @abstract Perform any supported conversion. @param inputBlock A block which will be called to get input data as needed. See description for AVAudioConverterInputBlock. @param outputBuffer The output buffer. @param outError An error if the conversion fails. @return An AVAudioConverterOutputStatus is returned. @discussion It attempts to fill the buffer to its capacity. On return, the buffer's length indicates the number of sample frames successfully converted.

func (*AVAudioConverter) ConvertToBufferFromBufferError ¶

func (o *AVAudioConverter) ConvertToBufferFromBufferError(outputBuffer *AVAudioPCMBuffer, inputBuffer *AVAudioPCMBuffer) (bool, error)

@method convertToBuffer:fromBuffer:error: @abstract Perform a simple conversion. That is, a conversion which does not involve codecs or sample rate conversion. @param inputBuffer The input buffer. @param outputBuffer The output buffer. @param outError An error if the conversion fails. @return YES is returned on success, NO when an error has occurred. @discussion The output buffer's frameCapacity should be at least at large as the inputBuffer's frameLength. If the conversion involves a codec or sample rate conversion, you instead must use convertToBuffer:error:withInputFromBlock:.

func (*AVAudioConverter) Dither ¶

func (o *AVAudioConverter) Dither() bool

@property dither @abstract Setting YES will turn on dither, if dither makes sense in given the current formats and settings. Default value is NO.

func (*AVAudioConverter) Downmix ¶

func (o *AVAudioConverter) Downmix() bool

@property downmix @abstract If YES and channel remapping is necessary, then channels will be mixed as appropriate instead of remapped. Default value is NO.

func (*AVAudioConverter) DynamicRangeControlConfiguration ¶

func (o *AVAudioConverter) DynamicRangeControlConfiguration() AVAudioDynamicRangeControlConfiguration

@property dynamicRangeControlConfiguration @abstract Encoder Dynamic Range Control (DRC) configuration. @discussion When supported by the encoder, this property controls which configuration is applied when a bitstream is generated. Note: This is only supported when compressing audio to formats which support it.

func (*AVAudioConverter) InitFromFormatToFormat ¶

func (o *AVAudioConverter) InitFromFormatToFormat(fromFormat *AVAudioFormat, toFormat *AVAudioFormat) *AVAudioConverter

@method initFromFormat:toFormat: @abstract Initialize from input and output formats. @param fromFormat The input format. @param toFormat The output format. @discussion Returns nil if the format conversion is not possible.

func (*AVAudioConverter) InputFormat ¶

func (o *AVAudioConverter) InputFormat() *AVAudioFormat

@property inputFormat @abstract The format of the input audio stream. (NB. AVAudioFormat includes the channel layout)

func (*AVAudioConverter) MagicCookie ¶

func (o *AVAudioConverter) MagicCookie() *foundation.NSData

@property magicCookie @abstract Decoders require some data in the form of a magicCookie in order to decode properly. Encoders will produce a magicCookie.

func (*AVAudioConverter) MaximumOutputPacketSize ¶

func (o *AVAudioConverter) MaximumOutputPacketSize() int

@property maximumOutputPacketSize @abstract The maximum size of an output packet, in bytes. @discussion When encoding it is useful to know how large a packet can be in order to allocate a buffer to receive the output.

func (*AVAudioConverter) OutputFormat ¶

func (o *AVAudioConverter) OutputFormat() *AVAudioFormat

@property outputFormat @abstract The format of the output audio stream. (NB. AVAudioFormat includes the channel layout)

func (*AVAudioConverter) PrimeInfo ¶

func (o *AVAudioConverter) PrimeInfo() AVAudioConverterPrimeInfo

@property primeInfo @abstract Indicates the the number of priming frames.

func (*AVAudioConverter) PrimeMethod ¶

func (o *AVAudioConverter) PrimeMethod() AVAudioConverterPrimeMethod

@property primeMethod @abstract Indicates the priming method to be used by the sample rate converter or decoder.

func (*AVAudioConverter) Reset ¶

func (o *AVAudioConverter) Reset()

@method reset @abstract Resets the converter so that a new stream may be converted.

func (*AVAudioConverter) SampleRateConverterAlgorithm ¶

func (o *AVAudioConverter) SampleRateConverterAlgorithm() *foundation.NSString

@property sampleRateConverterAlgorithm @abstract An AVSampleRateConverterAlgorithmKey value as defined in AVAudioSettings.h.

func (*AVAudioConverter) SampleRateConverterQuality ¶

func (o *AVAudioConverter) SampleRateConverterQuality() int

@property sampleRateConverterQuality @abstract An AVAudioQuality value as defined in AVAudioSettings.h.

func (*AVAudioConverter) SetAudioSyncPacketFrequency ¶

func (o *AVAudioConverter) SetAudioSyncPacketFrequency(audioSyncPacketFrequency int)

func (*AVAudioConverter) SetBitRate ¶

func (o *AVAudioConverter) SetBitRate(bitRate int)

func (*AVAudioConverter) SetBitRateStrategy ¶

func (o *AVAudioConverter) SetBitRateStrategy(bitRateStrategy *foundation.NSString)

func (*AVAudioConverter) SetChannelMap ¶

func (o *AVAudioConverter) SetChannelMap(channelMap *foundation.NSArray[*foundation.NSNumber])

func (*AVAudioConverter) SetContentSource ¶

func (o *AVAudioConverter) SetContentSource(contentSource AVAudioContentSource)

func (*AVAudioConverter) SetDither ¶

func (o *AVAudioConverter) SetDither(dither bool)

func (*AVAudioConverter) SetDownmix ¶

func (o *AVAudioConverter) SetDownmix(downmix bool)

func (*AVAudioConverter) SetDynamicRangeControlConfiguration ¶

func (o *AVAudioConverter) SetDynamicRangeControlConfiguration(dynamicRangeControlConfiguration AVAudioDynamicRangeControlConfiguration)

func (*AVAudioConverter) SetMagicCookie ¶

func (o *AVAudioConverter) SetMagicCookie(magicCookie *foundation.NSData)

func (*AVAudioConverter) SetPrimeInfo ¶

func (o *AVAudioConverter) SetPrimeInfo(primeInfo AVAudioConverterPrimeInfo)

func (*AVAudioConverter) SetPrimeMethod ¶

func (o *AVAudioConverter) SetPrimeMethod(primeMethod AVAudioConverterPrimeMethod)

func (*AVAudioConverter) SetSampleRateConverterAlgorithm ¶

func (o *AVAudioConverter) SetSampleRateConverterAlgorithm(sampleRateConverterAlgorithm *foundation.NSString)

func (*AVAudioConverter) SetSampleRateConverterQuality ¶

func (o *AVAudioConverter) SetSampleRateConverterQuality(sampleRateConverterQuality int)

func (AVAudioConverterInputStatus) String ¶

func (e AVAudioConverterInputStatus) String() string

func (AVAudioConverterOutputStatus) String ¶

func (e AVAudioConverterOutputStatus) String() string

func (AVAudioConverterPrimeMethod) String ¶

func (e AVAudioConverterPrimeMethod) String() string

func (AVAudioDynamicRangeControlConfiguration) String ¶

func (e AVAudioDynamicRangeControlConfiguration) String() string

func (*AVAudioEngine) AttachNode ¶

func (o *AVAudioEngine) AttachNode(node *AVAudioNode)

@method attachNode: @abstract Take ownership of a new node. @param node The node to be attached to the engine. To support the instantiation of arbitrary AVAudioNode subclasses, instances are created externally to the engine, but are not usable until they are attached to the engine via this method. Thus the idiom, without ARC, is: ``` // when building engine: AVAudioNode *_player; // member of controller class (for example) ... _player = [[AVAudioPlayerNode alloc] init]; [engine attachNode: _player]; ... // when destroying engine (without ARC) [_player release]; ```

func (*AVAudioEngine) AttachedNodes ¶

func (o *AVAudioEngine) AttachedNodes() *foundation.NSSet[*AVAudioNode]

@property attachedNodes @abstract Set of all nodes attached to the engine.

func (*AVAudioEngine) ConnectMIDIToFormatBlock ¶

func (o *AVAudioEngine) ConnectMIDIToFormatBlock(sourceNode *AVAudioNode, destinationNode *AVAudioNode, format *AVAudioFormat, tapBlock func(int64, uint8, int, unsafe.Pointer) int)

@method connectMIDI:to:format:block: @abstract Establish a MIDI only connection between two nodes. @param sourceNode The source node. @param destinationNode The destination node. @param format If non-nil, the format of the source node's output bus is set to this format. In all cases, the format of the source nodes' output bus has to match with the destination nodes' output bus format. Although the output bus of the source is not in use, the format needs to be set in order to be able to use the sample rate for MIDI event timing calculations. @param tapBlock If non-nil, this block is called from the source node's `AUMIDIOutputEventBlock` on the realtime thread. The host can tap the MIDI data of the source node through this block. May be nil. Use this method to establish a MIDI only connection between a source node and a destination node that has MIDI input capability. The source node can only be a AVAudioUnit node of type `kAudioUnitType_MIDIProcessor`. The destination node types can be `kAudioUnitType_MusicDevice`, `kAudioUnitType_MusicEffect` or `kAudioUnitType_MIDIProcessor`. Note that any pre-existing MIDI connection involving the destination will be broken. Any client installed block on the source node's audio unit `AUMIDIOutputEventBlock` will be overwritten when making the MIDI connection. Deprecated: since macOS 13.0.

func (*AVAudioEngine) ConnectMIDIToFormatEventListBlock ¶

func (o *AVAudioEngine) ConnectMIDIToFormatEventListBlock(sourceNode *AVAudioNode, destinationNode *AVAudioNode, format *AVAudioFormat, tapBlock func(int64, uint8, unsafe.Pointer) int)

@method connectMIDI:to:format:eventListblock: @abstract Establish a MIDI only connection between two nodes. @param sourceNode The source node. @param destinationNode The destination node. @param format If non-nil, the format of the source node's output bus is set to this format. In all cases, the format of the source nodes' output bus has to match with the destination nodes' output bus format. Although the output bus of the source is not in use, the format needs to be set in order to be able to use the sample rate for MIDI event timing calculations. @param tapBlock This block is called from the source node's `AUMIDIOutputEventListBlock` on the realtime thread. The host can tap the MIDI data of the source node through this block. Use this method to establish a MIDI only connection between a source node and a destination node that has MIDI input capability. The source node can only be a AVAudioUnit node of type `kAudioUnitType_MIDIProcessor`. The destination node types can be `kAudioUnitType_MusicDevice`, `kAudioUnitType_MusicEffect` or `kAudioUnitType_MIDIProcessor`. Note that any pre-existing MIDI connection involving the destination will be broken. Any client installed block on the source node's audio unit `AUMIDIOutputEventListBlock` will be overwritten when making the MIDI connection.

func (*AVAudioEngine) ConnectMIDIToNodesFormatBlock ¶

func (o *AVAudioEngine) ConnectMIDIToNodesFormatBlock(sourceNode *AVAudioNode, destinationNodes *foundation.NSArray[*AVAudioNode], format *AVAudioFormat, tapBlock func(int64, uint8, int, unsafe.Pointer) int)

@method connectMIDI:toNodes:format:block: @abstract Establish a MIDI only connection between a source node and multiple destination nodes. @param sourceNode The source node. @param destinationNodes An array of AVAudioNodes specifying destination nodes. @param format If non-nil, the format of the source node's output bus is set to this format. In all cases, the format of the source nodes' output bus has to match with the destination nodes' output bus format. Although the output bus of the source is not in use, the format needs to be set in order to be able to use the sample rate for MIDI event timing calculations. @param tapBlock If non-nil, this block is called from the source node's `AUMIDIOutputEventBlock` on the realtime thread. The host can tap the MIDI data of the source node through this block. May be nil. Use this method to establish a MIDI only connection between a source node and multiple destination nodes. The source node can only be a AVAudioUnit node of type `kAudioUnitType_MIDIProcessor`. The destination node types can be `kAudioUnitType_MusicDevice`, `kAudioUnitType_MusicEffect` or `kAudioUnitType_MIDIProcessor`. MIDI connections made using this method are either one-to-one (when a single destination connection is specified) or one-to-many (when multiple connections are specified), but never many-to-one. Note that any pre-existing connection involving the destination will be broken. Any client installed block on the source node's audio unit `AUMIDIOutputEventBlock` will be overwritten when making the MIDI connection. Deprecated: since macOS 13.0.

func (*AVAudioEngine) ConnectMIDIToNodesFormatEventListBlock ¶

func (o *AVAudioEngine) ConnectMIDIToNodesFormatEventListBlock(sourceNode *AVAudioNode, destinationNodes *foundation.NSArray[*AVAudioNode], format *AVAudioFormat, tapBlock func(int64, uint8, unsafe.Pointer) int)

@method connectMIDI:toNodes:format:eventListBlock: @abstract Establish a MIDI only connection between a source node and multiple destination nodes. @param sourceNode The source node. @param destinationNodes An array of AVAudioNodes specifying destination nodes. @param format If non-nil, the format of the source node's output bus is set to this format. In all cases, the format of the source nodes' output bus has to match with the destination nodes' output bus format. Although the output bus of the source is not in use, the format needs to be set in order to be able to use the sample rate for MIDI event timing calculations. @param tapBlock This block is called from the source node's `AUMIDIOutputEventListBlock` on the realtime thread. The host can tap the MIDI data of the source node through this block. Use this method to establish a MIDI only connection between a source node and multiple destination nodes. The source node can only be a AVAudioUnit node of type `kAudioUnitType_MIDIProcessor`. The destination node types can be `kAudioUnitType_MusicDevice`, `kAudioUnitType_MusicEffect` or `kAudioUnitType_MIDIProcessor`. MIDI connections made using this method are either one-to-one (when a single destination connection is specified) or one-to-many (when multiple connections are specified), but never many-to-one. Note that any pre-existing connection involving the destination will be broken. Any client installed block on the source node's audio unit `AUMIDIOutputEventListBlock` will be overwritten when making the MIDI connection.

func (*AVAudioEngine) ConnectToConnectionPointsFromBusFormat ¶

func (o *AVAudioEngine) ConnectToConnectionPointsFromBusFormat(sourceNode *AVAudioNode, destNodes *foundation.NSArray[*AVAudioConnectionPoint], sourceBus uint, format *AVAudioFormat)

@method connect:toConnectionPoints:fromBus:format: @abstract Establish connections between a source node and multiple destination nodes. @param sourceNode The source node @param destNodes An array of AVAudioConnectionPoint objects specifying destination nodes and busses @param sourceBus The output bus on source node @param format If non-nil, the format of the source node's output bus is set to this format. In all cases, the format of the destination nodes' input bus is set to match that of the source node's output bus Use this method to establish connections from a source node to multiple destination nodes. Connections made using this method are either one-to-one (when a single destination connection is specified) or one-to-many (when multiple connections are specified), but never many-to-one. To incrementally add a new connection to a source node, use this method with an array of AVAudioConnectionPoint objects comprising of pre-existing connections (obtained from `outputConnectionPointsForNode:outputBus:`) and the new connection. Note that any pre-existing connection involving the destination's input bus will be broken. And, any pre-existing connection on source node which is not a part of the specified destination connection array will also be broken. Also note that when the output of a node is split into multiple paths, all the paths must render at the same rate until they reach a common mixer. In other words, starting from the split node until the common mixer node where all split paths terminate, you cannot have: - any AVAudioUnitTimeEffect - any sample rate conversion

func (*AVAudioEngine) ConnectToFormat ¶

func (o *AVAudioEngine) ConnectToFormat(node1 *AVAudioNode, node2 *AVAudioNode, format *AVAudioFormat)

@method connect:to:format: @abstract Establish a connection between two nodes This calls connect:to:fromBus:toBus:format: using bus 0 on the source node, and bus 0 on the destination node, except in the case of a destination which is a mixer, in which case the destination is the mixer's nextAvailableInputBus.

func (*AVAudioEngine) ConnectToFromBusToBusFormat ¶

func (o *AVAudioEngine) ConnectToFromBusToBusFormat(node1 *AVAudioNode, node2 *AVAudioNode, bus1 uint, bus2 uint, format *AVAudioFormat)

@method connect:to:fromBus:toBus:format: @abstract Establish a connection between two nodes. @param node1 The source node @param node2 The destination node @param bus1 The output bus on the source node @param bus2 The input bus on the destination node @param format If non-nil, the format of the source node's output bus is set to this format. In all cases, the format of the destination node's input bus is set to match that of the source node's output bus. Nodes have input and output buses (AVAudioNodeBus). Use this method to establish one-to-one connections betweeen nodes. Connections made using this method are always one-to-one, never one-to-many or many-to-one. Note that any pre-existing connection(s) involving the source's output bus or the destination's input bus will be broken.

func (*AVAudioEngine) DetachNode ¶

func (o *AVAudioEngine) DetachNode(node *AVAudioNode)

@method detachNode: @abstract Detach a node previously attached to the engine. If necessary, the engine will safely disconnect the node before detaching it.

func (*AVAudioEngine) DisableManualRenderingMode ¶

func (o *AVAudioEngine) DisableManualRenderingMode()

@method disableManualRenderingMode @abstract Set the engine to render to/from an audio device. When disabling the manual rendering mode, the engine: 1. Stops and resets itself (see `stop` and `reset`). 2. Switches the output/input nodes to render to/from an audio device. Their input and output formats may change. 3. Removes any taps previously installed on the input and output nodes. 4. Maintains all the engine connections as is. Calling this method when the engine is already rendering to/from an audio device has no effect.

func (*AVAudioEngine) DisconnectMIDIFrom ¶

func (o *AVAudioEngine) DisconnectMIDIFrom(sourceNode *AVAudioNode, destinationNode *AVAudioNode)

@method disconnectMIDI:from: @abstract Remove a MIDI connection between two nodes. @param sourceNode The node whose MIDI output is to be disconnected. @param destinationNode The node whose MIDI input is to be disconnected. If a tap block is installed on the source node, it will be removed when the last connection from the source node is removed.

func (*AVAudioEngine) DisconnectMIDIFromNodes ¶

func (o *AVAudioEngine) DisconnectMIDIFromNodes(sourceNode *AVAudioNode, destinationNodes *foundation.NSArray[*AVAudioNode])

@method disconnectMIDI:fromNodes: @abstract Remove a MIDI connection between one source node and multiple destination nodes. @param sourceNode The node whose MIDI output is to be disconnected. @param destinationNodes An array of AVAudioNodes specifying nodes whose MIDI input is to be disconnected. If a tap block is installed on the source node, it will be removed when the last connection from the source node is removed.

func (*AVAudioEngine) DisconnectMIDIInput ¶

func (o *AVAudioEngine) DisconnectMIDIInput(node *AVAudioNode)

@method disconnectMIDIInput: @abstract Disconnects all input MIDI connections of this node. @param node The node whose MIDI input is to be disconnected.

func (*AVAudioEngine) DisconnectMIDIOutput ¶

func (o *AVAudioEngine) DisconnectMIDIOutput(node *AVAudioNode)

@method disconnectMIDIOutput: @abstract Disconnects all output MIDI connections of this node. @param node The node whose MIDI outputs are to be disconnected.

func (*AVAudioEngine) DisconnectNodeInput ¶

func (o *AVAudioEngine) DisconnectNodeInput(node *AVAudioNode)

@method disconnectNodeInput: @abstract Remove a connection between two nodes. @param node The node whose inputs are to be disconnected Connections are broken on each of the node's input busses.

func (*AVAudioEngine) DisconnectNodeInputBus ¶

func (o *AVAudioEngine) DisconnectNodeInputBus(node *AVAudioNode, bus uint)

@method disconnectNodeInput:bus: @abstract Remove a connection between two nodes. @param node The node whose input is to be disconnected @param bus The destination's input bus to disconnect

func (*AVAudioEngine) DisconnectNodeOutput ¶

func (o *AVAudioEngine) DisconnectNodeOutput(node *AVAudioNode)

@method disconnectNodeOutput: @abstract Remove a connection between two nodes. @param node The node whose outputs are to be disconnected Connections are broken on each of the node's output busses.

func (*AVAudioEngine) DisconnectNodeOutputBus ¶

func (o *AVAudioEngine) DisconnectNodeOutputBus(node *AVAudioNode, bus uint)

@method disconnectNodeOutput:bus: @abstract Remove a connection between two nodes. @param node The node whose output is to be disconnected @param bus The source's output bus to disconnect

func (*AVAudioEngine) EnableManualRenderingModeFormatMaximumFrameCountError ¶

func (o *AVAudioEngine) EnableManualRenderingModeFormatMaximumFrameCountError(mode AVAudioEngineManualRenderingMode, pcmFormat *AVAudioFormat, maximumFrameCount uint32) (bool, error)

@method enableManualRenderingMode:format:maximumFrameCount:error: @abstract Set the engine to operate in a manual rendering mode with the specified render format and maximum frame count. @param mode The manual rendering mode to use. @param pcmFormat The format of the output PCM audio data from the engine. @param maximumFrameCount The maximum number of PCM sample frames the engine will be asked to produce in any single render call. @param outError On exit, if the engine cannot switch to the manual rendering mode, a description of the error (see `AVAudioEngineManualRenderingError` for the possible errors). @return YES for success. Use this method to configure the engine to render in response to requests from the client. The engine must be in a stopped state before calling this method. The render format must be a PCM format and match the format of the buffer to which the engine is asked to render (see `renderOffline:toBuffer:error:`). It is advised to enable manual rendering mode soon after the engine is created, and before accessing any of mainMixerNode, inputNode or outputNode of the engine. Otherwise, accessing or interacting with the engine before enabling manual rendering mode could have the unintended side-effect of configuring the hardware for device-rendering mode. The input data in manual rendering mode can be supplied through the source nodes, e.g. `AVAudioPlayerNode`, `AVAudioInputNode` etc. When switching to manual rendering mode, the engine: 1. Switches the input and output nodes to manual rendering mode. Their input and output formats may change. 2. Removes any taps previously installed on the input and output nodes. 3. Maintains all the engine connections as is. Reasons for potential failure when switching to manual rendering mode include: - Engine is not in a stopped state.

func (*AVAudioEngine) Init ¶

func (o *AVAudioEngine) Init() *AVAudioEngine

@method init @abstract Initialize a new engine. On creation, the engine is by default connected to an audio device and automatically renders in realtime. It can be configured to operate in manual rendering mode through `enableManualRenderingMode:format:maximumFrameCount:error:`.

func (*AVAudioEngine) InputConnectionPointForNodeInputBus ¶

func (o *AVAudioEngine) InputConnectionPointForNodeInputBus(node *AVAudioNode, bus uint) *AVAudioConnectionPoint

@method inputConnectionPointForNode:inputBus: @abstract Get connection information on a node's input bus. @param node The node whose input connection is being queried. @param bus The node's input bus on which the connection is being queried. @return An AVAudioConnectionPoint object with connection information on the node's specified input bus. Connections are always one-to-one or one-to-many, never many-to-one. Returns nil if there is no connection on the node's specified input bus.

func (*AVAudioEngine) InputNode ¶

func (o *AVAudioEngine) InputNode() *AVAudioInputNode

@property inputNode @abstract The engine's singleton input node. Audio input is performed via an input node. The engine creates a singleton on demand when this property is first accessed. To receive input, connect another node from the output of the input node, or create a recording tap on it. When the engine is rendering to/from an audio device, the AVAudioSesssion category and/or availability of hardware determine whether an app can perform input. Check for the input node's input format (i.e. hardware format) for non-zero sample rate and channel count to see if input is enabled. Trying to perform input through the input node when it is not enabled or available will cause the engine to throw an error (when possible) or an exception. Note that if the engine has at any point previously had its inputNode enabled and permission to record was granted, then any time the engine is running, the mic-in-use indicator will appear. For applications which may need to dynamically switch between output-only and input-output modes, it may be advantageous to use two engine instances. In manual rendering mode, the input node can be used to synchronously supply data to the engine while it is rendering (see `AVAudioInputNode(setManualRenderingInputPCMFormat:inputBlock:)`.

func (*AVAudioEngine) IsAutoShutdownEnabled ¶

func (o *AVAudioEngine) IsAutoShutdownEnabled() bool

@property autoShutdownEnabled @abstract When auto shutdown is enabled, the engine can start and stop the audio hardware dynamically, to conserve power. This is the enforced behavior on watchOS and can be optionally enabled on other platforms. To conserve power, it is advised that the client pause/stop the engine when not in use. But when auto shutdown is enabled, the engine will stop the audio hardware if it was running idle for a certain duration, and restart it later when required. Note that, because this operation is dynamic, it may affect the start times of the source nodes (e.g. `AVAudioPlayerNode`), if the engine has to resume from its shutdown state. On watchOS, auto shutdown is always enabled. On other platforms, it is disabled by default, but the client can enable it if needed. This property is applicable only when the engine is rendering to/from an audio device. If the value is changed when the engine is in manual rendering mode, it will take effect whenever the engine is switched to render to/from the audio device.

func (*AVAudioEngine) IsInManualRenderingMode ¶

func (o *AVAudioEngine) IsInManualRenderingMode() bool

@property isInManualRenderingMode @abstract Whether or not the engine is operating in manual rendering mode, i.e. not connected to an audio device and rendering in response to the requests from the client

func (*AVAudioEngine) IsRunning ¶

func (o *AVAudioEngine) IsRunning() bool

@property running @abstract The engine's running state.

func (*AVAudioEngine) MainMixerNode ¶

func (o *AVAudioEngine) MainMixerNode() *AVAudioMixerNode

@property mainMixerNode @abstract The engine's optional singleton main mixer node. The engine will construct a singleton main mixer and connect it to the outputNode on demand, when this property is first accessed. You can then connect additional nodes to the mixer. If the client has never explicitly set the connection format between the mainMixerNode and the outputNode, the engine will always set/update the format to track the format of the outputNode on (re)start, even after an AVAudioEngineConfigurationChangeNotification. Otherwise, it's the client's responsibility to set/update this connection format after an AVAudioEngineConfigurationChangeNotification. By default, the mixer's output format (sample rate and channel count) will track the format of the output node. You may however make the connection explicitly with a different format.

func (*AVAudioEngine) ManualRenderingBlock ¶

func (o *AVAudioEngine) ManualRenderingBlock() objc.Block

@property manualRenderingBlock @abstract Block to render the engine operating in manual rendering mode This block based render call must be used to render the engine when operating in `AVAudioEngineManualRenderingModeRealtime`. In this mode, the engine operates under realtime constraints and will not make any blocking call (e.g. calling libdispatch, blocking on a mutex, allocating memory etc.) while rendering. Before invoking the rendering functionality, client must fetch this block and cache the result. The block can then be called from a realtime context, without any possibility of blocking. When rendering in `AVAudioEngineManualRenderingModeOffline`, either this block based render call or `renderOffline:toBuffer:error:` ObjC method can be used. All the rules outlined in `renderOffline:toBuffer:error:` are applicable here as well.

func (*AVAudioEngine) ManualRenderingFormat ¶

func (o *AVAudioEngine) ManualRenderingFormat() *AVAudioFormat

@property manualRenderingFormat @abstract The render format of the engine in manual rendering mode. Querying this property when the engine is not in manual rendering mode will return an invalid format, with zero sample rate and channel count.

func (*AVAudioEngine) ManualRenderingMaximumFrameCount ¶

func (o *AVAudioEngine) ManualRenderingMaximumFrameCount() uint32

@property manualRenderingMaximumFrameCount @abstract The maximum number of PCM sample frames the engine can produce in any single render call in the manual rendering mode. Querying this property when the engine is not in manual rendering mode will return zero.

func (*AVAudioEngine) ManualRenderingMode ¶

func (o *AVAudioEngine) ManualRenderingMode() AVAudioEngineManualRenderingMode

@property manualRenderingMode @abstract The manual rendering mode configured on the engine This property is meaningful only when the engine is operating in manual rendering mode, i.e. when `isInManualRenderingMode` returns true.

func (*AVAudioEngine) ManualRenderingSampleTime ¶

func (o *AVAudioEngine) ManualRenderingSampleTime() int64

@property manualRenderingSampleTime @abstract Indicates where the engine is on its render timeline in manual rendering mode. The timeline in manual rendering mode starts at a sample time of zero, and is in terms of the render format's sample rate. Resetting the engine (see `reset`) will reset the timeline back to zero.

func (*AVAudioEngine) MusicSequence ¶

func (o *AVAudioEngine) MusicSequence() unsafe.Pointer

@property musicSequence @abstract The MusicSequence previously attached to the engine (if any).

func (*AVAudioEngine) OutputConnectionPointsForNodeOutputBus ¶

func (o *AVAudioEngine) OutputConnectionPointsForNodeOutputBus(node *AVAudioNode, bus uint) *foundation.NSArray[*AVAudioConnectionPoint]

@method outputConnectionPointsForNode:outputBus: @abstract Get connection information on a node's output bus. @param node The node whose output connections are being queried. @param bus The node's output bus on which connections are being queried. @return An array of AVAudioConnectionPoint objects with connection information on the node's specified output bus. Connections are always one-to-one or one-to-many, never many-to-one. Returns an empty array if there are no connections on the node's specified output bus.

func (*AVAudioEngine) OutputNode ¶

func (o *AVAudioEngine) OutputNode() *AVAudioOutputNode

@property outputNode @abstract The engine's singleton output node. Audio output is performed via an output node. The engine creates a singleton on demand when this property is first accessed. Connect another node to the input of the output node, or obtain a mixer that is connected there by default, using the "mainMixerNode" property. When the engine is rendering to/from an audio device, the AVAudioSesssion category and/or availability of hardware determine whether an app can perform output. Check the output format of output node (i.e. hardware format) for non-zero sample rate and channel count to see if output is enabled. Trying to perform output through the output node when it is not enabled or available will cause the engine to throw an error (when possible) or an exception. In manual rendering mode, the output format of the output node will determine the render format of the engine. It can be changed through `enableManualRenderingMode:format:maximumFrameCount:error:`.

func (*AVAudioEngine) Pause ¶

func (o *AVAudioEngine) Pause()

@method pause @abstract Pause the engine. When the engine is rendering to/from an audio device, stops the audio hardware and the flow of audio through the engine. When operating in this mode, it is recommended that the engine be paused or stopped (as applicable) when not in use, to minimize power consumption. Pausing the engine does not deallocate the resources allocated by prepare. Resume the engine by invoking start again.

func (*AVAudioEngine) Prepare ¶

func (o *AVAudioEngine) Prepare()

@method prepare @abstract Prepare the engine for starting. This method preallocates many of the resources the engine requires in order to start. Use it to responsively start audio input or output. On AVAudioSession supported platforms, this method may cause the audio session to be implicitly activated. Activating the audio session (implicitly or explicitly) may cause other audio sessions to be interrupted or ducked depending on the session's configuration. It is recommended to configure and activate the app's audio session before preparing the engine. See https://developer.apple.com/library/archive/documentation/Audio/Conceptual/AudioSessionProgrammingGuide/Introduction/Introduction.html for details.

func (*AVAudioEngine) RenderOfflineToBufferError ¶

func (o *AVAudioEngine) RenderOfflineToBufferError(numberOfFrames uint32, buffer *AVAudioPCMBuffer) (AVAudioEngineManualRenderingStatus, error)

@method renderOffline:toBuffer:error: @abstract Render call to the engine operating in the offline manual rendering mode @param numberOfFrames The number of PCM sample frames to be rendered @param buffer The PCM buffer to which the engine must render the audio @param outError On exit, if an error occurs during rendering, a description of the error (see `AVAudioEngineManualRenderingError` for the possible errors) @return One of the status codes from `AVAudioEngineManualRenderingStatus`. Irrespective of the returned status code, on exit, the output buffer's frameLength will indicate the number of PCM samples rendered by the engine The engine must be in the offline manual rendering mode (`AVAudioEngineManualRenderingModeOffline`) and started before calling this method. The format of the buffer must match the render format set through `enableManualRenderingMode:format:maximumFrameCount:error:`. The buffer capacity must be greater than or equal to the number of samples asked to render. On exit, the buffer's frameLength will indicate the number of PCM samples rendered by the engine. The engine's timeline in manual rendering mode starts at a sample time of zero, and is in terms of the render format's sample rate. Resetting the engine (see `reset`) will reset the timeline back to zero. When rendering in `AVAudioEngineManualRenderingModeRealtime`, this ObjC render method must not be used, an error is returned otherwise. Use the block based render call (`manualRenderingBlock`) in that mode instead.

func (*AVAudioEngine) Reset ¶

func (o *AVAudioEngine) Reset()

@method reset @abstract reset Reset all of the nodes in the engine. This will reset all of the nodes in the engine. This is useful, for example, for silencing reverb and delay tails. In manual rendering mode, the render timeline is reset to a sample time of zero.

func (*AVAudioEngine) SetAutoShutdownEnabled ¶

func (o *AVAudioEngine) SetAutoShutdownEnabled(autoShutdownEnabled bool)

func (*AVAudioEngine) SetMusicSequence ¶

func (o *AVAudioEngine) SetMusicSequence(musicSequence unsafe.Pointer)

func (*AVAudioEngine) StartAndReturnError ¶

func (o *AVAudioEngine) StartAndReturnError() (bool, error)

@method startAndReturnError: @abstract Start the engine. @return YES for success Calls prepare if it has not already been called since stop. When the engine is rendering to/from an audio device, starts the audio hardware via the AVAudioInputNode and/or AVAudioOutputNode instances in the engine. Audio begins to flow through the engine. Reasons for potential failure to start in this mode include: 1. There is problem in the structure of the graph. Input can't be routed to output or to a recording tap through converter type nodes. 2. An AVAudioSession error. 3. The driver failed to start the hardware. In manual rendering mode, prepares the engine to render when requested by the client. On AVAudioSession supported platforms, this method may cause the audio session to be implicitly activated. It is recommended to configure and activate the app's audio session before starting the engine. For more information, see the `prepare` method above.

func (*AVAudioEngine) Stop ¶

func (o *AVAudioEngine) Stop()

@method stop @abstract When the engine is rendering to/from an audio device, stops the audio hardware and the engine. When operating in this mode, it is recommended that the engine be paused or stopped (as applicable) when not in use, to minimize power consumption. Stopping the engine releases the resources allocated by prepare.

func (AVAudioEngineManualRenderingError) String ¶

func (e AVAudioEngineManualRenderingError) String() string

func (AVAudioEngineManualRenderingMode) String ¶

func (e AVAudioEngineManualRenderingMode) String() string

func (AVAudioEngineManualRenderingStatus) String ¶

func (e AVAudioEngineManualRenderingStatus) String() string

func (AVAudioEnvironmentDistanceAttenuationModel) String ¶

func (e AVAudioEnvironmentDistanceAttenuationModel) String() string

func (*AVAudioEnvironmentDistanceAttenuationParameters) DistanceAttenuationModel ¶

func (o *AVAudioEnvironmentDistanceAttenuationParameters) DistanceAttenuationModel() AVAudioEnvironmentDistanceAttenuationModel

@property distanceAttenuationModel @abstract Type of distance attenuation model @discussion Default: AVAudioEnvironmentDistanceAttenuationModelInverse

func (*AVAudioEnvironmentDistanceAttenuationParameters) MaximumDistance ¶

func (o *AVAudioEnvironmentDistanceAttenuationParameters) MaximumDistance() float32

@property maximumDistance @abstract The distance beyond which no further attenuation is applied @discussion Default: 100000.0 meters Models: AVAudioEnvironmentDistanceAttenuationModelLinear

func (*AVAudioEnvironmentDistanceAttenuationParameters) ReferenceDistance ¶

func (o *AVAudioEnvironmentDistanceAttenuationParameters) ReferenceDistance() float32

@property referenceDistance @abstract The minimum distance at which attenuation is applied @discussion Default: 1.0 meter Models: AVAudioEnvironmentDistanceAttenuationModelInverse, AVAudioEnvironmentDistanceAttenuationModelLinear

func (*AVAudioEnvironmentDistanceAttenuationParameters) RolloffFactor ¶

func (o *AVAudioEnvironmentDistanceAttenuationParameters) RolloffFactor() float32

@property rolloffFactor @abstract Determines the attenuation curve @discussion A higher value results in a steeper attenuation curve. The rolloff factor should be a value greater than 0. Default: 1.0 Models: AVAudioEnvironmentDistanceAttenuationModelExponential AVAudioEnvironmentDistanceAttenuationModelInverse AVAudioEnvironmentDistanceAttenuationModelLinear

func (*AVAudioEnvironmentDistanceAttenuationParameters) SetDistanceAttenuationModel ¶

func (o *AVAudioEnvironmentDistanceAttenuationParameters) SetDistanceAttenuationModel(distanceAttenuationModel AVAudioEnvironmentDistanceAttenuationModel)

func (*AVAudioEnvironmentDistanceAttenuationParameters) SetMaximumDistance ¶

func (o *AVAudioEnvironmentDistanceAttenuationParameters) SetMaximumDistance(maximumDistance float32)

func (*AVAudioEnvironmentDistanceAttenuationParameters) SetReferenceDistance ¶

func (o *AVAudioEnvironmentDistanceAttenuationParameters) SetReferenceDistance(referenceDistance float32)

func (*AVAudioEnvironmentDistanceAttenuationParameters) SetRolloffFactor ¶

func (o *AVAudioEnvironmentDistanceAttenuationParameters) SetRolloffFactor(rolloffFactor float32)

func (*AVAudioEnvironmentNode) ApplicableRenderingAlgorithms ¶

func (o *AVAudioEnvironmentNode) ApplicableRenderingAlgorithms() *foundation.NSArray[*foundation.NSNumber]

@property applicableRenderingAlgorithms @abstract Returns an array of AVAudio3DMixingRenderingAlgorithm values based on the current output format @discussion AVAudioEnvironmentNode supports several rendering algorithms per input bus which are defined in <AVFAudio/AVAudioMixing.h>. Depending on the current output format of the environment node, this method returns an immutable array of the applicable rendering algorithms. This is important when the environment node has been configured to a multichannel output format because only a subset of the available rendering algorithms are designed to render to all of the channels. This information should be retrieved after a successful connection to the destination node via the engine's connect method.

func (*AVAudioEnvironmentNode) DistanceAttenuationParameters ¶

func (o *AVAudioEnvironmentNode) DistanceAttenuationParameters() *AVAudioEnvironmentDistanceAttenuationParameters

@property distanceAttenuationParameters @abstract The distance attenuation parameters for the environment

func (*AVAudioEnvironmentNode) Init ¶

func (o *AVAudioEnvironmentNode) Init() *AVAudioEnvironmentNode

func (*AVAudioEnvironmentNode) IsListenerHeadTrackingEnabled ¶

func (o *AVAudioEnvironmentNode) IsListenerHeadTrackingEnabled() bool

@property listenerHeadTrackingEnabled @abstract On capable devices, listener orientation will be automatically rotated based on user's head-orientation if enabled.

func (*AVAudioEnvironmentNode) ListenerAngularOrientation ¶

func (o *AVAudioEnvironmentNode) ListenerAngularOrientation() AVAudio3DAngularOrientation

@property listenerAngularOrientation @abstract The listener's orientation in the environment @discussion Changing listenerAngularOrientation will result in a corresponding change in listenerVectorOrientation. All angles are specified in degrees. Default: The default orientation is with the listener looking directly along the negative Z axis. yaw: 0.0 pitch: 0.0 roll: 0.0

func (*AVAudioEnvironmentNode) ListenerPosition ¶

func (o *AVAudioEnvironmentNode) ListenerPosition() AVAudio3DPoint

@property listenerPosition @abstract Sets the listener's position in the 3D environment @discussion The coordinates are specified in meters. Default: The default position of the listener is at the origin. x: 0.0 y: 0.0 z: 0.0

func (*AVAudioEnvironmentNode) ListenerVectorOrientation ¶

func (o *AVAudioEnvironmentNode) ListenerVectorOrientation() AVAudio3DVectorOrientation

@property listenerVectorOrientation @abstract The listener's orientation in the environment @discussion Changing listenerVectorOrientation will result in a corresponding change in listenerAngularOrientation. Default: The default orientation is with the listener looking directly along the negative Z axis. forward: (0, 0, -1) up: (0, 1, 0)

func (*AVAudioEnvironmentNode) NextAvailableInputBus ¶

func (o *AVAudioEnvironmentNode) NextAvailableInputBus() uint

@property nextAvailableInputBus @abstract Find an unused input bus @discussion This will find and return the first input bus to which no other node is connected.

func (*AVAudioEnvironmentNode) OutputType ¶

func (o *AVAudioEnvironmentNode) OutputType() AVAudioEnvironmentOutputType

@property outputType @abstract Type of output hardware to be used with AVAudio3DMixingRenderingAlgorithmAuto @discussion Output hardware cannot be automatically determined in Manual Rendering modes or for wired output. This property can be used to override the output type if the correct type is known. Selecting an output type that does not match the actual hardware can produce unexpected results, especially with AVAudioEnvironmentOutputTypeBuiltInSpeakers. An app choosing a value other than AVAudio3DMixingOutputTypeAuto should listen to route change notifications and update the output type accordingly. Default: AVAudio3DMixingOutputTypeAuto

func (*AVAudioEnvironmentNode) OutputVolume ¶

func (o *AVAudioEnvironmentNode) OutputVolume() float32

@property outputVolume @abstract The mixer's output volume. @discussion This accesses the mixer's output volume (0.0-1.0, inclusive).

func (*AVAudioEnvironmentNode) ReverbParameters ¶

func (o *AVAudioEnvironmentNode) ReverbParameters() *AVAudioEnvironmentReverbParameters

@property reverbParameters @abstract The reverb parameters for the environment

func (*AVAudioEnvironmentNode) SetListenerAngularOrientation ¶

func (o *AVAudioEnvironmentNode) SetListenerAngularOrientation(listenerAngularOrientation AVAudio3DAngularOrientation)

func (*AVAudioEnvironmentNode) SetListenerHeadTrackingEnabled ¶

func (o *AVAudioEnvironmentNode) SetListenerHeadTrackingEnabled(listenerHeadTrackingEnabled bool)

func (*AVAudioEnvironmentNode) SetListenerPosition ¶

func (o *AVAudioEnvironmentNode) SetListenerPosition(listenerPosition AVAudio3DPoint)

func (*AVAudioEnvironmentNode) SetListenerVectorOrientation ¶

func (o *AVAudioEnvironmentNode) SetListenerVectorOrientation(listenerVectorOrientation AVAudio3DVectorOrientation)

func (*AVAudioEnvironmentNode) SetOutputType ¶

func (o *AVAudioEnvironmentNode) SetOutputType(outputType AVAudioEnvironmentOutputType)

func (*AVAudioEnvironmentNode) SetOutputVolume ¶

func (o *AVAudioEnvironmentNode) SetOutputVolume(outputVolume float32)

func (AVAudioEnvironmentOutputType) String ¶

func (e AVAudioEnvironmentOutputType) String() string

func (*AVAudioEnvironmentReverbParameters) Enable ¶

func (o *AVAudioEnvironmentReverbParameters) Enable() bool

@property enable @abstract Turns on/off the reverb @discussion Default: NO

func (*AVAudioEnvironmentReverbParameters) FilterParameters ¶

func (o *AVAudioEnvironmentReverbParameters) FilterParameters() *AVAudioUnitEQFilterParameters

@property filterParameters @abstract filter that applies to the output of the reverb

func (*AVAudioEnvironmentReverbParameters) Level ¶

func (o *AVAudioEnvironmentReverbParameters) Level() float32

@property level @abstract Controls the master level of the reverb @discussion Range: -40 to 40 dB Default: 0.0

func (*AVAudioEnvironmentReverbParameters) LoadFactoryReverbPreset ¶

func (o *AVAudioEnvironmentReverbParameters) LoadFactoryReverbPreset(preset AVAudioUnitReverbPreset)

@method loadFactoryReverbPreset: @abstract Load one of the reverb's factory presets @param preset Reverb preset to be set. @discussion Loading a factory reverb preset changes the sound of the reverb. This works independently of the filter which follows the reverb in the signal chain.

func (*AVAudioEnvironmentReverbParameters) SetEnable ¶

func (o *AVAudioEnvironmentReverbParameters) SetEnable(enable bool)

func (*AVAudioEnvironmentReverbParameters) SetLevel ¶

func (o *AVAudioEnvironmentReverbParameters) SetLevel(level float32)

func (*AVAudioFile) Close ¶

func (o *AVAudioFile) Close()

@method close @abstract Close the audio file. @discussion The underlying file will be closed if open. - It is normally unnecessary to close a file opened for reading (it will be automatically closed when the object is released) - It is only necessary to close a file opened for writing in order to achieve specific control over when the file's header is updated. Note: Once closed, further file read or write operations will fail with kAudio_FileNotFoundError.

func (*AVAudioFile) FileFormat ¶

func (o *AVAudioFile) FileFormat() *AVAudioFormat

@property fileFormat @abstract The on-disk format of the file.

func (*AVAudioFile) FramePosition ¶

func (o *AVAudioFile) FramePosition() int64

@property framePosition @abstract The position in the file at which the next read or write will occur. @discussion Set framePosition to perform a seek before a read or write. A read or write operation advances the frame position by the number of frames read or written.

func (*AVAudioFile) InitForReadingCommonFormatInterleavedError ¶

func (o *AVAudioFile) InitForReadingCommonFormatInterleavedError(fileURL *foundation.NSURL, format AVAudioCommonFormat, interleaved bool) (*AVAudioFile, error)

@method initForReading:commonFormat:interleaved:error: @abstract Open a file for reading, using a specified processing format. @param fileURL the file to open @param format the processing format to use when reading from the file @param interleaved whether to use an interleaved processing format @param outError on exit, if an error occurs, a description of the error

func (*AVAudioFile) InitForReadingError ¶

func (o *AVAudioFile) InitForReadingError(fileURL *foundation.NSURL) (*AVAudioFile, error)

@method initForReading:error: @abstract Open a file for reading. @param fileURL the file to open @param outError on exit, if an error occurs, a description of the error @discussion This opens the file for reading using the standard format (deinterleaved floating point).

func (*AVAudioFile) InitForWritingSettingsCommonFormatInterleavedError ¶

func (o *AVAudioFile) InitForWritingSettingsCommonFormatInterleavedError(fileURL *foundation.NSURL, settings *foundation.NSDictionary[*foundation.NSString, objc.ID], format AVAudioCommonFormat, interleaved bool) (*AVAudioFile, error)

@method initForWriting:settings:commonFormat:interleaved:error: @abstract Open a file for writing. @param fileURL the path at which to create the file @param settings the format of the file to create (See `AVAudioRecorder`.) For linear PCM, only interleaved formats are supported for the saved file, non interleaved setting will be ignored and a warning is shown. @param format the processing format to use when writing to the file. @param interleaved whether to use an interleaved processing format @param outError on exit, if an error occurs, a description of the error @discussion The file type to create can be set through the corresponding settings key. If not set, it will be inferred from the file extension. Will overwrite a file at the specified URL if a file exists.

func (*AVAudioFile) InitForWritingSettingsError ¶

func (o *AVAudioFile) InitForWritingSettingsError(fileURL *foundation.NSURL, settings *foundation.NSDictionary[*foundation.NSString, objc.ID]) (*AVAudioFile, error)

@method initForWriting:settings:error: @abstract Open a file for writing. @param fileURL the path at which to create the file @param settings the format of the file to create (See `AVAudioRecorder`.) For linear PCM, only interleaved formats are supported for the saved file, non interleaved setting will be ignored and a warning is shown. @param outError on exit, if an error occurs, a description of the error @discussion The file type to create can be set through the corresponding settings key. If not set, it will be inferred from the file extension. Will overwrite a file at the specified URL if a file exists. This opens the file for writing using the standard format (deinterleaved floating point).

func (*AVAudioFile) IsOpen ¶

func (o *AVAudioFile) IsOpen() bool

@property isOpen @abstract Whether the file is open or not.

func (*AVAudioFile) Length ¶

func (o *AVAudioFile) Length() int64

@property length @abstract The number of sample frames in the file. @discussion Note: this can be expensive to compute for the first time.

func (*AVAudioFile) ProcessingFormat ¶

func (o *AVAudioFile) ProcessingFormat() *AVAudioFormat

@property processingFormat @abstract The processing format of the file.

func (*AVAudioFile) ReadIntoBufferError ¶

func (o *AVAudioFile) ReadIntoBufferError(buffer *AVAudioPCMBuffer) (bool, error)

@method readIntoBuffer:error: @abstract Read an entire buffer. @param buffer The buffer into which to read from the file. Its format must match the file's processing format. @param outError on exit, if an error occurs, a description of the error @return YES for success. @discussion Reading sequentially from framePosition, attempts to fill the buffer to its capacity. On return, the buffer's length indicates the number of sample frames successfully read.

func (*AVAudioFile) ReadIntoBufferFrameCountError ¶

func (o *AVAudioFile) ReadIntoBufferFrameCountError(buffer *AVAudioPCMBuffer, frames uint32) (bool, error)

@method readIntoBuffer:frameCount:error: @abstract Read a portion of a buffer. @param frames The number of frames to read. @param buffer The buffer into which to read from the file. Its format must match the file's processing format. @param outError on exit, if an error occurs, a description of the error @return YES for success. @discussion Like `readIntoBuffer:error:`, but can be used to read fewer frames than buffer.frameCapacity.

func (*AVAudioFile) SetFramePosition ¶

func (o *AVAudioFile) SetFramePosition(framePosition int64)

func (*AVAudioFile) Url ¶

func (o *AVAudioFile) Url() *foundation.NSURL

@property url @abstract The URL the file is reading or writing.

func (*AVAudioFile) WriteFromBufferError ¶

func (o *AVAudioFile) WriteFromBufferError(buffer *AVAudioPCMBuffer) (bool, error)

@method writeFromBuffer:error: @abstract Write a buffer. @param buffer The buffer from which to write to the file. Its format must match the file's processing format. @param outError on exit, if an error occurs, a description of the error @return YES for success. @discussion Writes sequentially. The buffer's frameLength signifies how much of the buffer is to be written.

func (*AVAudioFormat) ChannelCount ¶

func (o *AVAudioFormat) ChannelCount() uint32

@property channelCount @abstract The number of channels of audio data.

func (*AVAudioFormat) ChannelLayout ¶

func (o *AVAudioFormat) ChannelLayout() *AVAudioChannelLayout

@property channelLayout @abstract The underlying AVAudioChannelLayout, if any. @discussion Only formats with more than 2 channels are required to have channel layouts.

func (*AVAudioFormat) CommonFormat ¶

func (o *AVAudioFormat) CommonFormat() AVAudioCommonFormat

@property commonFormat @abstract An `AVAudioCommonFormat` identifying the format

func (*AVAudioFormat) FormatDescription ¶

func (o *AVAudioFormat) FormatDescription() unsafe.Pointer

@property formatDescription @abstract Converts to a CMAudioFormatDescriptionRef, for use with Core Media API's.

func (*AVAudioFormat) InitStandardFormatWithSampleRateChannelLayout ¶

func (o *AVAudioFormat) InitStandardFormatWithSampleRateChannelLayout(sampleRate float64, layout *AVAudioChannelLayout) *AVAudioFormat

@method initStandardFormatWithSampleRate:channelLayout: @abstract Initialize to deinterleaved float with the specified sample rate and channel layout. @param sampleRate the sample rate @param layout the channel layout. must not be nil.

func (*AVAudioFormat) InitStandardFormatWithSampleRateChannels ¶

func (o *AVAudioFormat) InitStandardFormatWithSampleRateChannels(sampleRate float64, channels uint32) *AVAudioFormat

@method initStandardFormatWithSampleRate:channels: @abstract Initialize to deinterleaved float with the specified sample rate and channel count. @param sampleRate the sample rate @param channels the channel count @discussion If the format specifies more than 2 channels, this method fails (returns nil).

func (*AVAudioFormat) InitWithCMAudioFormatDescription ¶

func (o *AVAudioFormat) InitWithCMAudioFormatDescription(formatDescription unsafe.Pointer) *AVAudioFormat

@method initWithCMAudioFormatDescription: @abstract initialize from a CMAudioFormatDescriptionRef. @param formatDescription the CMAudioFormatDescriptionRef. @discussion If formatDescription is invalid, this method fails (returns nil).

func (*AVAudioFormat) InitWithCommonFormatSampleRateChannelsInterleaved ¶

func (o *AVAudioFormat) InitWithCommonFormatSampleRateChannelsInterleaved(format AVAudioCommonFormat, sampleRate float64, channels uint32, interleaved bool) *AVAudioFormat

@method initWithCommonFormat:sampleRate:channels:interleaved: @abstract Initialize to float with the specified sample rate, channel count and interleavedness. @param format the common format type @param sampleRate the sample rate @param channels the channel count @param interleaved true if interleaved @discussion If the format specifies more than 2 channels, this method fails (returns nil).

func (*AVAudioFormat) InitWithCommonFormatSampleRateInterleavedChannelLayout ¶

func (o *AVAudioFormat) InitWithCommonFormatSampleRateInterleavedChannelLayout(format AVAudioCommonFormat, sampleRate float64, interleaved bool, layout *AVAudioChannelLayout) *AVAudioFormat

@method initWithCommonFormat:sampleRate:interleaved:channelLayout: @abstract Initialize to float with the specified sample rate, channel layout and interleavedness. @param format the common format type @param sampleRate the sample rate @param interleaved true if interleaved @param layout the channel layout. must not be nil.

func (*AVAudioFormat) InitWithSettings ¶

func (o *AVAudioFormat) InitWithSettings(settings *foundation.NSDictionary[*foundation.NSString, objc.ID]) *AVAudioFormat

@method initWithSettings: @abstract Initialize using a settings dictionary. @discussion See AVAudioSettings.h. Note that many settings dictionary elements pertain to encoder settings, not the basic format, and will be ignored. Returns nil if a format cannot be constructed with the provided settings, e.g. when: - AVNumberOfChannelsKey specifies more than 2 channels, but AVChannelLayoutKey hasn't been specified or the layout does not match - AVLinearPCMBitDepthKey for linear PCM format specifies less than 8 or greater than 32 bits - values for the keys are not of the expected types

func (*AVAudioFormat) InitWithStreamDescription ¶

func (o *AVAudioFormat) InitWithStreamDescription(asbd *coreaudiotypes.AudioStreamBasicDescription) *AVAudioFormat

@method initWithStreamDescription: @abstract Initialize from an AudioStreamBasicDescription. @param asbd the AudioStreamBasicDescription @discussion If the format specifies more than 2 channels, this method fails (returns nil).

func (*AVAudioFormat) InitWithStreamDescriptionChannelLayout ¶

func (o *AVAudioFormat) InitWithStreamDescriptionChannelLayout(asbd *coreaudiotypes.AudioStreamBasicDescription, layout *AVAudioChannelLayout) *AVAudioFormat

@method initWithStreamDescription:channelLayout: @abstract Initialize from an AudioStreamBasicDescription and optional channel layout. @param asbd the AudioStreamBasicDescription @param layout the channel layout. Can be nil only if asbd specifies 1 or 2 channels. @discussion If the format specifies more than 2 channels, this method fails (returns nil) unless layout is non-nil.

func (*AVAudioFormat) IsEqual ¶

func (o *AVAudioFormat) IsEqual(object objc.ID) bool

@method isEqual: @abstract Determine whether another format is functionally equivalent. @param object the format to compare against @discussion For PCM, interleavedness is ignored for mono. Differences in the AudioStreamBasicDescription alignment and packedness are ignored when they are not significant (e.g. with 1 channel, 2 bytes per frame and 16 bits per channel, neither alignment, the format is implicitly packed and can be interpreted as either high- or low-aligned.) For AVAudioChannelLayout, a layout with standard mono/stereo tag is considered to be equivalent to a nil layout. Otherwise, the layouts are compared for equality.

func (*AVAudioFormat) IsInterleaved ¶

func (o *AVAudioFormat) IsInterleaved() bool

@property interleaved @abstract Describes whether the samples are interleaved. @discussion For non-PCM formats, the value is undefined.

func (*AVAudioFormat) IsStandard ¶

func (o *AVAudioFormat) IsStandard() bool

@property standard @abstract Describes whether the format is deinterleaved native-endian float.

func (*AVAudioFormat) MagicCookie ¶

func (o *AVAudioFormat) MagicCookie() *foundation.NSData

@property magicCookie @abstract The underlying magic cookie, if any. @discussion A magic cookie contains metadata associated with encoders and decoders. Encoders produce a magic cookie, and some decoders require a magic cookie to decode properly.

func (*AVAudioFormat) SampleRate ¶

func (o *AVAudioFormat) SampleRate() float64

@property sampleRate @abstract A sampling rate in Hertz.

func (*AVAudioFormat) SetMagicCookie ¶

func (o *AVAudioFormat) SetMagicCookie(magicCookie *foundation.NSData)

func (*AVAudioFormat) Settings ¶

func (o *AVAudioFormat) Settings() *foundation.NSDictionary[*foundation.NSString, objc.ID]

@property settings @abstract Returns the format represented as a dictionary with keys from AVAudioSettings.h.

func (*AVAudioFormat) StreamDescription ¶

func (o *AVAudioFormat) StreamDescription() *coreaudiotypes.AudioStreamBasicDescription

@property streamDescription @abstract Returns the AudioStreamBasicDescription, for use with lower-level audio API's.

func (*AVAudioIONode) AudioUnit ¶

func (o *AVAudioIONode) AudioUnit() *carboncore.ComponentInstanceRecord

@property audioUnit @abstract The node's underlying AudioUnit, if any. @discussion This is only necessary for certain advanced usages.

func (*AVAudioIONode) IsVoiceProcessingEnabled ¶

func (o *AVAudioIONode) IsVoiceProcessingEnabled() bool

@property voiceProcessingEnabled @abstract Indicates whether voice processing is enabled.

func (*AVAudioIONode) PresentationLatency ¶

func (o *AVAudioIONode) PresentationLatency() float64

@property presentationLatency @abstract The presentation or hardware latency, applicable when the engine is rendering to/from an audio device. @discussion This corresponds to kAudioDevicePropertyLatency and kAudioStreamPropertyLatency. See <CoreAudio/AudioHardwareBase.h>.

func (*AVAudioIONode) SetVoiceProcessingEnabledError ¶

func (o *AVAudioIONode) SetVoiceProcessingEnabledError(enabled bool) (bool, error)

@method setVoiceProcessingEnabled:error: @abstract Enable or disable voice processing on the IO node. @param enabled Whether voice processing is to be enabled. @param outError On exit, if the IO node cannot enable or diable voice processing, a description of the error @return YES for success @discussion If enabled, the input node does signal processing on the incoming audio (taking out any of the audio that is played from the device at a given time from the incoming audio). Disabling this mode on either of the IO nodes automatically disabled it on the other IO node. Voice processing requires both input and output nodes to be in the voice processing mode. Enabling this mode on either of the IO nodes automatically enables it on the other IO node. Voice processing is only supported when the engine is rendering to the audio device and not in the manual rendering mode. Voice processing can only be be enabled or disabled when the engine is in a stopped state. The output format of the input node and the input format of the output node have to be the same and they can only be changed when the engine is in a stopped state.

func (*AVAudioInputNode) IsVoiceProcessingAGCEnabled ¶

func (o *AVAudioInputNode) IsVoiceProcessingAGCEnabled() bool

@property voiceProcessingAGCEnabled @abstract Enable automatic gain control on the processed microphone uplink. signal. Enabled by default. @discussion Querying this property when voice processing is disabled will return false.

func (*AVAudioInputNode) IsVoiceProcessingBypassed ¶

func (o *AVAudioInputNode) IsVoiceProcessingBypassed() bool

@property voiceProcessingBypassed @abstract Bypass all processing for microphone uplink done by the voice processing unit. @discussion Querying this property when voice processing is disabled will return false.

func (*AVAudioInputNode) IsVoiceProcessingInputMuted ¶

func (o *AVAudioInputNode) IsVoiceProcessingInputMuted() bool

@property voiceProcessingInputMuted @abstract Mutes the input of the voice processing unit. @discussion Querying this property when voice processing is disabled will return false.

func (*AVAudioInputNode) SetManualRenderingInputPCMFormatInputBlock ¶

func (o *AVAudioInputNode) SetManualRenderingInputPCMFormatInputBlock(format *AVAudioFormat, block func(uint32) *coreaudiotypes.AudioBufferList) bool

@method setManualRenderingInputPCMFormat:inputBlock: @abstract Supply the data through the input node to the engine operating in the manual rendering mode. @param format The format of the PCM audio data the block will supply to the engine @param block The block the engine will call on the input node to get the audio to send to the output, when operating in the manual rendering mode. See `AVAudioIONodeInputBlock` for more details @return YES for success @discussion This block must be set if the input node is being used when the engine is operating in manual rendering mode. Switching the engine to render to/from an audio device invalidates any previously set block, and makes this method ineffective.

func (*AVAudioInputNode) SetMutedSpeechActivityEventListener ¶

func (o *AVAudioInputNode) SetMutedSpeechActivityEventListener(listenerBlock func(AVAudioVoiceProcessingSpeechActivityEvent)) bool

@method setMutedSpeechActivityEventListener @abstract Register a listener to be notified when speech activity event occurs while the input is muted. @param listenerBlock The block the engine will call when speech activity event occurs while the input is muted. Passing nil will remove an already set block. @return YES for success @discussion Continuous presence of or lack of speech activity during mute will not cause redundant notification. In order to use this API, it's expected to implement the mute via the voiceProcessingInputMuted.

func (*AVAudioInputNode) SetVoiceProcessingAGCEnabled ¶

func (o *AVAudioInputNode) SetVoiceProcessingAGCEnabled(voiceProcessingAGCEnabled bool)

func (*AVAudioInputNode) SetVoiceProcessingBypassed ¶

func (o *AVAudioInputNode) SetVoiceProcessingBypassed(voiceProcessingBypassed bool)

func (*AVAudioInputNode) SetVoiceProcessingInputMuted ¶

func (o *AVAudioInputNode) SetVoiceProcessingInputMuted(voiceProcessingInputMuted bool)

func (*AVAudioInputNode) SetVoiceProcessingOtherAudioDuckingConfiguration ¶

func (o *AVAudioInputNode) SetVoiceProcessingOtherAudioDuckingConfiguration(voiceProcessingOtherAudioDuckingConfiguration AVAudioVoiceProcessingOtherAudioDuckingConfiguration)

func (*AVAudioInputNode) VoiceProcessingOtherAudioDuckingConfiguration ¶

func (o *AVAudioInputNode) VoiceProcessingOtherAudioDuckingConfiguration() AVAudioVoiceProcessingOtherAudioDuckingConfiguration

@property voiceProcessingOtherAudioDuckingConfiguration @abstract The configuration of ducking other (i.e. non-voice) audio @discussion Configures the ducking of other (i.e. non-voice) audio, including advanced ducking enablement and ducking level. In general, when other audio is played during voice chat, applying a higher level of ducking could increase the intelligibility of the voice chat. If not set, the default ducking configuration is to disable advanced ducking, with a ducking level set to AVAudioVoiceProcessingOtherAudioDuckingLevelDefault.

func (*AVAudioMixerNode) Init ¶

func (o *AVAudioMixerNode) Init() *AVAudioMixerNode

func (*AVAudioMixerNode) NextAvailableInputBus ¶

func (o *AVAudioMixerNode) NextAvailableInputBus() uint

@property nextAvailableInputBus @abstract Find an unused input bus. @discussion This will find and return the first input bus to which no other node is connected.

func (*AVAudioMixerNode) OutputVolume ¶

func (o *AVAudioMixerNode) OutputVolume() float32

@property outputVolume @abstract The mixer's output volume. @discussion This accesses the mixer's output volume (0.0-1.0, inclusive).

func (*AVAudioMixerNode) SetOutputVolume ¶

func (o *AVAudioMixerNode) SetOutputVolume(outputVolume float32)

func (*AVAudioMixingDestination) ConnectionPoint ¶

func (o *AVAudioMixingDestination) ConnectionPoint() *AVAudioConnectionPoint

func (*AVAudioNode) AUAudioUnit ¶

func (o *AVAudioNode) AUAudioUnit() objc.ID

@property AUAudioUnit @abstract An AUAudioUnit wrapping or underlying the implementation's AudioUnit. @discussion This provides an AUAudioUnit which either wraps or underlies the implementation's AudioUnit, depending on how that audio unit is packaged. Applications can interact with this AUAudioUnit to control custom properties, select presets, change parameters, etc. No operations that may conflict with state maintained by the engine should be performed directly on the audio unit. These include changing initialization state, stream formats, channel layouts or connections to other audio units.

func (*AVAudioNode) Engine ¶

func (o *AVAudioNode) Engine() *AVAudioEngine

@property engine @abstract The engine to which the node is attached (or nil).

func (*AVAudioNode) InputFormatForBus ¶

func (o *AVAudioNode) InputFormatForBus(bus uint) *AVAudioFormat

@method inputFormatForBus: @abstract Obtain an input bus's format.

func (*AVAudioNode) InstallTapOnBusBufferSizeFormatBlock ¶

func (o *AVAudioNode) InstallTapOnBusBufferSizeFormatBlock(bus uint, bufferSize uint32, format *AVAudioFormat, tapBlock func(*AVAudioPCMBuffer, *AVAudioTime))

@method installTapOnBus:bufferSize:format:block: @abstract Create a "tap" to record/monitor/observe the output of the node. @param bus the node output bus to which to attach the tap @param bufferSize the requested size of the incoming buffers in sample frames. Supported range is [100, 400] ms. @param format If non-nil, attempts to apply this as the format of the specified output bus. This should only be done when attaching to an output bus which is not connected to another node; an error will result otherwise. The tap and connection formats (if non-nil) on the specified bus should be identical. Otherwise, the latter operation will override any previously set format. @param tapBlock a block to be called with audio buffers @discussion Only one tap may be installed on any bus. Taps may be safely installed and removed while the engine is running. Note that if you have a tap installed on AVAudioOutputNode, there could be a mismatch between the tap buffer format and AVAudioOutputNode's output format, depending on the underlying physical device. Hence, instead of tapping the AVAudioOutputNode, it is advised to tap the node connected to it. E.g. to capture audio from input node: <pre> AVAudioEngine *engine = [[AVAudioEngine alloc] init]; AVAudioInputNode *input = [engine inputNode]; AVAudioFormat *format = [input outputFormatForBus: 0]; [input installTapOnBus: 0 bufferSize: 8192 format: format block: ^(AVAudioPCMBuffer *buf, AVAudioTime *when) { // ‘buf' contains audio captured from input node at time 'when' }]; .... // start engine </pre>

func (*AVAudioNode) LastRenderTime ¶

func (o *AVAudioNode) LastRenderTime() *AVAudioTime

@property lastRenderTime @abstract Obtain the time for which the node most recently rendered. @discussion Will return nil if the engine is not running or if the node is not connected to an input or output node.

func (*AVAudioNode) Latency ¶

func (o *AVAudioNode) Latency() float64

@property latency @abstract The processing latency of the node, in seconds. @discussion This property reflects the delay between when an impulse in the audio stream arrives at the input vs. output of the node. This should reflect the delay due to signal processing (e.g. filters, FFT's, etc.), not delay or reverberation which is being applied as an effect. A value of zero indicates either no latency or an unknown latency.

func (*AVAudioNode) NameForInputBus ¶

func (o *AVAudioNode) NameForInputBus(bus uint) *foundation.NSString

@method nameForInputBus: @abstract Return the name of an input bus.

func (*AVAudioNode) NameForOutputBus ¶

func (o *AVAudioNode) NameForOutputBus(bus uint) *foundation.NSString

@method nameForOutputBus: @abstract Return the name of an output bus.

func (*AVAudioNode) NumberOfInputs ¶

func (o *AVAudioNode) NumberOfInputs() uint

@property numberOfInputs @abstract The node's number of input busses.

func (*AVAudioNode) NumberOfOutputs ¶

func (o *AVAudioNode) NumberOfOutputs() uint

@property numberOfOutputs @abstract The node's number of output busses.

func (*AVAudioNode) OutputFormatForBus ¶

func (o *AVAudioNode) OutputFormatForBus(bus uint) *AVAudioFormat

@method outputFormatForBus: @abstract Obtain an output bus's format.

func (*AVAudioNode) OutputPresentationLatency ¶

func (o *AVAudioNode) OutputPresentationLatency() float64

@property outputPresentationLatency @abstract The maximum render pipeline latency downstream of the node, in seconds. @discussion This describes the maximum time it will take for the audio at the output of a node to be presented. For instance, the output presentation latency of the output node in the engine is: - zero in manual rendering mode - the presentation latency of the device itself when rendering to an audio device (see `AVAudioIONode(presentationLatency)`) The output presentation latency of a node connected directly to the output node is the output node's presentation latency plus the output node's processing latency (see `latency`). For a node which is exclusively in the input node chain (i.e. not connected to engine's output node), this property reflects the latency for the output of this node to be presented at the output of the terminating node in the input chain. A value of zero indicates either an unknown or no latency. Note that this latency value can change as the engine is reconfigured (started/stopped, connections made/altered downstream of this node etc.). So it is recommended not to cache this value and fetch it whenever it's needed.

func (*AVAudioNode) RemoveTapOnBus ¶

func (o *AVAudioNode) RemoveTapOnBus(bus uint)

@method removeTapOnBus: @abstract Destroy a tap. @param bus the node output bus whose tap is to be destroyed

func (*AVAudioNode) Reset ¶

func (o *AVAudioNode) Reset()

@method reset @abstract Clear a unit's previous processing state.

func (*AVAudioPCMBuffer) FloatChannelData ¶

func (o *AVAudioPCMBuffer) FloatChannelData() unsafe.Pointer

@property floatChannelData @abstract Access the buffer's float audio samples. @discussion floatChannelData returns pointers to the buffer's audio samples if the buffer's format is 32-bit float, or nil if it is another format. The returned pointer is to format.channelCount pointers to float. Each of these pointers is to "frameLength" valid samples, which are spaced by "stride" samples. If format.interleaved is false (as with the standard deinterleaved float format), then the pointers will be to separate chunks of memory. "stride" is 1. If format.interleaved is true, then the pointers will refer into the same chunk of interleaved samples, each offset by 1 frame. "stride" is the number of interleaved channels.

func (*AVAudioPCMBuffer) FrameCapacity ¶

func (o *AVAudioPCMBuffer) FrameCapacity() uint32

@property frameCapacity @abstract The buffer's capacity, in audio sample frames.

func (*AVAudioPCMBuffer) FrameLength ¶

func (o *AVAudioPCMBuffer) FrameLength() uint32

@property frameLength @abstract The current number of valid sample frames in the buffer. @discussion You may modify the length of the buffer as part of an operation that modifies its contents. The length must be less than or equal to the frameCapacity. Modifying frameLength will update the mDataByteSize in each of the underlying AudioBufferList's AudioBuffer's correspondingly, and vice versa. Note that in the case of deinterleaved formats, mDataByteSize will refers the size of one channel's worth of audio samples.

func (*AVAudioPCMBuffer) InitWithPCMFormatBufferListNoCopyDeallocator ¶

func (o *AVAudioPCMBuffer) InitWithPCMFormatBufferListNoCopyDeallocator(format *AVAudioFormat, bufferList *coreaudiotypes.AudioBufferList, deallocator func(*coreaudiotypes.AudioBufferList)) *AVAudioPCMBuffer

@method initWithPCMFormat:bufferListNoCopy:deallocator: @abstract Initialize a buffer that is to contain PCM audio samples with a given AudioBufferList without copying samples and a custom deallocator block. @param format The format of the PCM audio to be contained in the buffer. @param bufferList The buffer list with allocated memory to contain the PCM audio data. @param deallocator A block to invoke when the resulting AVAudioPCMBuffer object is deallocated. @discussion An exception is raised if the format is not PCM. Returns nil in the following cases: - if the format has zero bytes per frame (format.streamDescription->mBytesPerFrame == 0) - if supplied buffer has zero number of buffers - if each buffer's data byte size are not equal or if any of the buffers' data byte size is zero - if there is a mismatch between the format's number of buffers and the AudioBufferList's size (1 if interleaved, mChannelsPerFrame if deinterleaved) - if the AudioBufferList's pointer to the buffer of audio data is null. Use the deallocator block to define your own deallocation behavior for the provided AudioBufferList's underlying memory. The AudioBufferList passed to the deallocator is identical to the one which was passed to the initializer, in terms of the buffer count, and each buffer's mData and mDataByteSize members.

func (*AVAudioPCMBuffer) InitWithPCMFormatFrameCapacity ¶

func (o *AVAudioPCMBuffer) InitWithPCMFormatFrameCapacity(format *AVAudioFormat, frameCapacity uint32) *AVAudioPCMBuffer

@method initWithPCMFormat:frameCapacity: @abstract Initialize a buffer that is to contain PCM audio samples. @param format The format of the PCM audio to be contained in the buffer. @param frameCapacity The capacity of the buffer in PCM sample frames. @discussion An exception is raised if the format is not PCM. Returns nil in the following cases: - if the format has zero bytes per frame (format.streamDescription->mBytesPerFrame == 0) - if the buffer byte capacity (frameCapacity * format.streamDescription->mBytesPerFrame) cannot be represented by an uint32_t

func (*AVAudioPCMBuffer) Int16ChannelData ¶

func (o *AVAudioPCMBuffer) Int16ChannelData() unsafe.Pointer

@property int16ChannelData @abstract Access the buffer's int16_t audio samples. @discussion int16ChannelData returns the buffer's audio samples if the buffer's format has 2-byte integer samples, or nil if it is another format. See the discussion of floatChannelData.

func (*AVAudioPCMBuffer) Int32ChannelData ¶

func (o *AVAudioPCMBuffer) Int32ChannelData() unsafe.Pointer

@property int32ChannelData @abstract Access the buffer's int32_t audio samples. @discussion int32ChannelData returns the buffer's audio samples if the buffer's format has 4-byte integer samples, or nil if it is another format. See the discussion of floatChannelData.

func (*AVAudioPCMBuffer) SetFrameLength ¶

func (o *AVAudioPCMBuffer) SetFrameLength(frameLength uint32)

func (*AVAudioPCMBuffer) Stride ¶

func (o *AVAudioPCMBuffer) Stride() uint

@property stride @abstract The buffer's number of interleaved channels. @discussion Useful in conjunction with floatChannelData etc.

func (*AVAudioPlayer) AveragePowerForChannel ¶

func (o *AVAudioPlayer) AveragePowerForChannel(channelNumber uint) float32

func (*AVAudioPlayer) CurrentDevice ¶

func (o *AVAudioPlayer) CurrentDevice() *foundation.NSString

func (*AVAudioPlayer) CurrentTime ¶

func (o *AVAudioPlayer) CurrentTime() float64

func (*AVAudioPlayer) Data ¶

func (o *AVAudioPlayer) Data() *foundation.NSData

func (*AVAudioPlayer) Delegate ¶

func (o *AVAudioPlayer) Delegate() AVAudioPlayerDelegate

func (*AVAudioPlayer) DeviceCurrentTime ¶

func (o *AVAudioPlayer) DeviceCurrentTime() float64

func (*AVAudioPlayer) Duration ¶

func (o *AVAudioPlayer) Duration() float64

func (*AVAudioPlayer) EnableRate ¶

func (o *AVAudioPlayer) EnableRate() bool

func (*AVAudioPlayer) Format ¶

func (o *AVAudioPlayer) Format() *AVAudioFormat

func (*AVAudioPlayer) InitWithContentsOfURLError ¶

func (o *AVAudioPlayer) InitWithContentsOfURLError(url *foundation.NSURL) (*AVAudioPlayer, error)

func (*AVAudioPlayer) InitWithContentsOfURLFileTypeHintError ¶

func (o *AVAudioPlayer) InitWithContentsOfURLFileTypeHintError(url *foundation.NSURL, utiString *foundation.NSString) (*AVAudioPlayer, error)

func (*AVAudioPlayer) InitWithDataError ¶

func (o *AVAudioPlayer) InitWithDataError(data *foundation.NSData) (*AVAudioPlayer, error)

func (*AVAudioPlayer) InitWithDataFileTypeHintError ¶

func (o *AVAudioPlayer) InitWithDataFileTypeHintError(data *foundation.NSData, utiString *foundation.NSString) (*AVAudioPlayer, error)

func (*AVAudioPlayer) IsMeteringEnabled ¶

func (o *AVAudioPlayer) IsMeteringEnabled() bool

func (*AVAudioPlayer) IsPlaying ¶

func (o *AVAudioPlayer) IsPlaying() bool

func (*AVAudioPlayer) NumberOfChannels ¶

func (o *AVAudioPlayer) NumberOfChannels() uint

func (*AVAudioPlayer) NumberOfLoops ¶

func (o *AVAudioPlayer) NumberOfLoops() int

func (*AVAudioPlayer) Pan ¶

func (o *AVAudioPlayer) Pan() float32

func (*AVAudioPlayer) Pause ¶

func (o *AVAudioPlayer) Pause()

func (*AVAudioPlayer) PeakPowerForChannel ¶

func (o *AVAudioPlayer) PeakPowerForChannel(channelNumber uint) float32

func (*AVAudioPlayer) Play ¶

func (o *AVAudioPlayer) Play() bool

func (*AVAudioPlayer) PlayAtTime ¶

func (o *AVAudioPlayer) PlayAtTime(time_ float64) bool

func (*AVAudioPlayer) PrepareToPlay ¶

func (o *AVAudioPlayer) PrepareToPlay() bool

func (*AVAudioPlayer) Rate ¶

func (o *AVAudioPlayer) Rate() float32

func (*AVAudioPlayer) SetCurrentDevice ¶

func (o *AVAudioPlayer) SetCurrentDevice(currentDevice *foundation.NSString)

func (*AVAudioPlayer) SetCurrentTime ¶

func (o *AVAudioPlayer) SetCurrentTime(currentTime float64)

func (*AVAudioPlayer) SetDelegate ¶

func (o *AVAudioPlayer) SetDelegate(delegate AVAudioPlayerDelegate)

func (*AVAudioPlayer) SetEnableRate ¶

func (o *AVAudioPlayer) SetEnableRate(enableRate bool)

func (*AVAudioPlayer) SetMeteringEnabled ¶

func (o *AVAudioPlayer) SetMeteringEnabled(meteringEnabled bool)

func (*AVAudioPlayer) SetNumberOfLoops ¶

func (o *AVAudioPlayer) SetNumberOfLoops(numberOfLoops int)

func (*AVAudioPlayer) SetPan ¶

func (o *AVAudioPlayer) SetPan(pan float32)

func (*AVAudioPlayer) SetRate ¶

func (o *AVAudioPlayer) SetRate(rate float32)

func (*AVAudioPlayer) SetVolume ¶

func (o *AVAudioPlayer) SetVolume(volume float32)

func (*AVAudioPlayer) SetVolumeFadeDuration ¶

func (o *AVAudioPlayer) SetVolumeFadeDuration(volume float32, duration float64)

func (*AVAudioPlayer) Settings ¶

func (o *AVAudioPlayer) Settings() *foundation.NSDictionary[*foundation.NSString, objc.ID]

func (*AVAudioPlayer) Stop ¶

func (o *AVAudioPlayer) Stop()

func (*AVAudioPlayer) UpdateMeters ¶

func (o *AVAudioPlayer) UpdateMeters()

func (*AVAudioPlayer) Url ¶

func (o *AVAudioPlayer) Url() *foundation.NSURL

func (*AVAudioPlayer) Volume ¶

func (o *AVAudioPlayer) Volume() float32

func (*AVAudioPlayerNode) Init ¶

func (o *AVAudioPlayerNode) Init() *AVAudioPlayerNode

func (*AVAudioPlayerNode) IsPlaying ¶

func (o *AVAudioPlayerNode) IsPlaying() bool

func (*AVAudioPlayerNode) NodeTimeForPlayerTime ¶

func (o *AVAudioPlayerNode) NodeTimeForPlayerTime(playerTime *AVAudioTime) *AVAudioTime

@method nodeTimeForPlayerTime: @abstract Convert from player time to node time. @param playerTime a time relative to the player's start time @return a node time @discussion This method and its inverse `playerTimeForNodeTime:` are discussed in the introduction to this class. If the player is not playing when this method is called, nil is returned.

func (*AVAudioPlayerNode) Pause ¶

func (o *AVAudioPlayerNode) Pause()

@method pause @abstract Pause playback. @discussion The player's sample time does not advance while the node is paused. Note that pausing or stopping all the players connected to an engine does not pause or stop the engine or the underlying hardware. The engine must be explicitly paused or stopped for the hardware to stop.

func (*AVAudioPlayerNode) Play ¶

func (o *AVAudioPlayerNode) Play()

@method play @abstract Start or resume playback immediately. @discussion equivalent to playAtTime:nil

func (*AVAudioPlayerNode) PlayAtTime ¶

func (o *AVAudioPlayerNode) PlayAtTime(when *AVAudioTime)

@method playAtTime: @abstract Start or resume playback at a specific time. @param when the node time at which to start or resume playback. nil signifies "now". @discussion This node is initially paused. Requests to play buffers or file segments are enqueued, and any necessary decoding begins immediately. Playback does not begin, however, until the player has started playing, via this method. Note that providing an AVAudioTime which is past (before lastRenderTime) will cause the player to begin playback immediately. E.g. To start a player X seconds in future: <pre> // start engine and player NSError *nsErr = nil; [_engine startAndReturnError:&nsErr]; if (!nsErr) { const float kStartDelayTime = 0.5; // sec AVAudioFormat *outputFormat = [_player outputFormatForBus:0]; AVAudioFramePosition startSampleTime = _player.lastRenderTime.sampleTime + kStartDelayTime * outputFormat.sampleRate; AVAudioTime *startTime = [AVAudioTime timeWithSampleTime:startSampleTime atRate:outputFormat.sampleRate]; [_player playAtTime:startTime]; } </pre>

func (*AVAudioPlayerNode) PlayerTimeForNodeTime ¶

func (o *AVAudioPlayerNode) PlayerTimeForNodeTime(nodeTime *AVAudioTime) *AVAudioTime

@method playerTimeForNodeTime: @abstract Convert from node time to player time. @param nodeTime a node time @return a time relative to the player's start time @discussion This method and its inverse `nodeTimeForPlayerTime:` are discussed in the introduction to this class. If the player is not playing when this method is called, nil is returned.

func (*AVAudioPlayerNode) PrepareWithFrameCount ¶

func (o *AVAudioPlayerNode) PrepareWithFrameCount(frameCount uint32)

@method prepareWithFrameCount: @abstract Prepares previously scheduled file regions or buffers for playback. @param frameCount The number of sample frames of data to be prepared before returning.

func (*AVAudioPlayerNode) ScheduleBufferAtTimeOptionsCompletionCallbackTypeCompletionHandler ¶

func (o *AVAudioPlayerNode) ScheduleBufferAtTimeOptionsCompletionCallbackTypeCompletionHandler(buffer *AVAudioPCMBuffer, when *AVAudioTime, options AVAudioPlayerNodeBufferOptions, callbackType AVAudioPlayerNodeCompletionCallbackType, completionHandler func(AVAudioPlayerNodeCompletionCallbackType))

@method scheduleBuffer:atTime:options:completionCallbackType:completionHandler: @abstract Schedule playing samples from an AVAudioBuffer. @param buffer the buffer to play @param when the time at which to play the buffer. see the discussion of timestamps, above. @param options options for looping, interrupting other buffers, etc. @param callbackType option to specify when the completion handler must be called @param completionHandler called after the buffer has been consumed by the player or has finished playing back or the player is stopped. may be nil.

func (*AVAudioPlayerNode) ScheduleBufferAtTimeOptionsCompletionHandler ¶

func (o *AVAudioPlayerNode) ScheduleBufferAtTimeOptionsCompletionHandler(buffer *AVAudioPCMBuffer, when *AVAudioTime, options AVAudioPlayerNodeBufferOptions, completionHandler func())

@method scheduleBuffer:atTime:options:completionHandler: @abstract Schedule playing samples from an AVAudioBuffer. @param buffer the buffer to play @param when the time at which to play the buffer. see the discussion of timestamps, above. @param options options for looping, interrupting other buffers, etc. @param completionHandler called after the buffer has been consumed by the player or the player is stopped. may be nil. @discussion It is possible for the completionHandler to be called before rendering begins or before the buffer is played completely.

func (*AVAudioPlayerNode) ScheduleBufferCompletionCallbackTypeCompletionHandler ¶

func (o *AVAudioPlayerNode) ScheduleBufferCompletionCallbackTypeCompletionHandler(buffer *AVAudioPCMBuffer, callbackType AVAudioPlayerNodeCompletionCallbackType, completionHandler func(AVAudioPlayerNodeCompletionCallbackType))

@method scheduleBuffer:completionCallbackType:completionHandler: @abstract Schedule playing samples from an AVAudioBuffer. @param buffer the buffer to play @param callbackType option to specify when the completion handler must be called @param completionHandler called after the buffer has been consumed by the player or has finished playing back or the player is stopped. may be nil. @discussion Schedules the buffer to be played following any previously scheduled commands.

func (*AVAudioPlayerNode) ScheduleBufferCompletionHandler ¶

func (o *AVAudioPlayerNode) ScheduleBufferCompletionHandler(buffer *AVAudioPCMBuffer, completionHandler func())

@method scheduleBuffer:completionHandler: @abstract Schedule playing samples from an AVAudioBuffer. @param buffer the buffer to play @param completionHandler called after the buffer has been consumed by the player or the player is stopped. may be nil. @discussion Schedules the buffer to be played following any previously scheduled commands. It is possible for the completionHandler to be called before rendering begins or before the buffer is played completely.

func (*AVAudioPlayerNode) ScheduleFileAtTimeCompletionCallbackTypeCompletionHandler ¶

func (o *AVAudioPlayerNode) ScheduleFileAtTimeCompletionCallbackTypeCompletionHandler(file *AVAudioFile, when *AVAudioTime, callbackType AVAudioPlayerNodeCompletionCallbackType, completionHandler func(AVAudioPlayerNodeCompletionCallbackType))

@method scheduleFile:atTime:completionCallbackType:completionHandler: @abstract Schedule playing of an entire audio file. @param file the file to play @param when the time at which to play the file. see the discussion of timestamps, above. @param callbackType option to specify when the completion handler must be called @param completionHandler called after the file has been consumed by the player or has finished playing back or the player is stopped. may be nil.

func (*AVAudioPlayerNode) ScheduleFileAtTimeCompletionHandler ¶

func (o *AVAudioPlayerNode) ScheduleFileAtTimeCompletionHandler(file *AVAudioFile, when *AVAudioTime, completionHandler func())

@method scheduleFile:atTime:completionHandler: @abstract Schedule playing of an entire audio file. @param file the file to play @param when the time at which to play the file. see the discussion of timestamps, above. @param completionHandler called after the file has been consumed by the player or the player is stopped. may be nil. @discussion It is possible for the completionHandler to be called before rendering begins or before the file is played completely.

func (*AVAudioPlayerNode) ScheduleSegmentStartingFrameFrameCountAtTimeCompletionCallbackTypeCompletionHandler ¶

func (o *AVAudioPlayerNode) ScheduleSegmentStartingFrameFrameCountAtTimeCompletionCallbackTypeCompletionHandler(file *AVAudioFile, startFrame int64, numberFrames uint32, when *AVAudioTime, callbackType AVAudioPlayerNodeCompletionCallbackType, completionHandler func(AVAudioPlayerNodeCompletionCallbackType))

@method scheduleSegment:startingFrame:frameCount:atTime:completionCallbackType:completionHandler: @abstract Schedule playing a segment of an audio file. @param file the file to play @param startFrame the starting frame position in the stream @param numberFrames the number of frames to play @param when the time at which to play the region. see the discussion of timestamps, above. @param callbackType option to specify when the completion handler must be called @param completionHandler called after the segment has been consumed by the player or has finished playing back or the player is stopped. may be nil.

func (*AVAudioPlayerNode) ScheduleSegmentStartingFrameFrameCountAtTimeCompletionHandler ¶

func (o *AVAudioPlayerNode) ScheduleSegmentStartingFrameFrameCountAtTimeCompletionHandler(file *AVAudioFile, startFrame int64, numberFrames uint32, when *AVAudioTime, completionHandler func())