Package apple.audiotoolbox

Class AUAudioUnitBus

  • All Implemented Interfaces:
    NSObject
    public class AUAudioUnitBus
extends NSObject
    AUAudioUnitBus An input or output connection point on an audio unit.

    • Constructor Detail

      • AUAudioUnitBus

        protected AUAudioUnitBus​(org.moe.natj.general.Pointer peer)

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static java.lang.Object allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

        public static void cancelPreviousPerformRequestsWithTargetSelectorObject​(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

      • classFallbacksForKeyedArchiver

        public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

      • classForKeyedUnarchiver

        public static org.moe.natj.objc.Class classForKeyedUnarchiver()

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • instanceMethodSignatureForSelector

        public static NSMethodSignature instanceMethodSignatureForSelector​(org.moe.natj.objc.SEL aSelector)

      • instancesRespondToSelector

        public static boolean instancesRespondToSelector​(org.moe.natj.objc.SEL aSelector)

      • isSubclassOfClass

        public static boolean isSubclassOfClass​(org.moe.natj.objc.Class aClass)

      • keyPathsForValuesAffectingValueForKey

        public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey​(java.lang.String key)

      • new_objc

        public static java.lang.Object new_objc()

      • resolveClassMethod

        public static boolean resolveClassMethod​(org.moe.natj.objc.SEL sel)

      • resolveInstanceMethod

        public static boolean resolveInstanceMethod​(org.moe.natj.objc.SEL sel)

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

        public static org.moe.natj.objc.Class superclass_static()

      • version_static

        public static long version_static()

      • busType

        public long busType()
        [@property] busType The AUAudioUnitBusType.

      • contextPresentationLatency

        public double contextPresentationLatency()
        [@property] contextPresentationLatency Information about latency in the audio unit's processing context. This should not be confused with the audio unit's latency property, where the audio unit describes to the host any processing latency it introduces between its input and its output. A host may set this property to describe to the audio unit the presentation latency of its input and/or output audio data. Latency is described in seconds. A value of zero means either no latency or an unknown latency. A host should set this property on each active bus, since, for example, the audio routing path to each of multiple output busses may differ. For input busses: Describes how long ago the audio arriving on this bus was acquired. For instance, when reading from a file to the first audio unit in a chain, the input presentation latency is zero. For audio input from a device, this initial input latency is the presentation latency of the device itself, i.e. the device's safety offset and latency. A second chained audio unit's input presentation latency will be the input presentation latency of the first unit, plus the processing latency of the first unit. For output busses: Describes how long it will be before the output audio of an audio unit is presented. For instance, when writing to a file, the output presentation latency of the last audio unit in a chain is zero. When the audio from that audio unit is to be played to a device, then that initial presentation latency will be the presentation latency of the device itself, which is the I/O buffer size, plus the device's safety offset and latency A previous chained audio unit's output presentation latency is the last unit's presentation latency plus its processing latency. So, for a given audio unit anywhere within a mixing graph, the input and output presentation latencies describe to that unit how long from the moment of generation it has taken for its input to arrive, and how long it will take for its output to be presented. Bridged to the v2 property kAudioUnitProperty_PresentationLatency.

      • format

        public AVAudioFormat format()
        [@property] format The audio format and channel layout of audio being transferred on the bus. Bridged to the v2 property kAudioUnitProperty_StreamFormat.

      • index

        public long index()
        [@property] index The index of this bus in the containing array.

      • initWithFormatError

        public AUAudioUnitBus initWithFormatError​(AVAudioFormat format,
                                          org.moe.natj.general.ptr.Ptr<NSError> outError)
        initWithFormat:error: initialize with a default format.
        Parameters:
        format - The initial format for the bus.
        outError - An error if the format is unsupported for the bus.

      • isEnabled

        public boolean isEnabled()
        [@property] enabled Whether the bus is active. Hosts must enable input busses before using them. The reason for this is to allow a unit such as a mixer to be prepared to render a large number of inputs, but avoid the work of preparing to pull inputs which are not in use. Bridged to the v2 properties kAudioUnitProperty_MakeConnection and kAudioUnitProperty_SetRenderCallback.

      • setEnabled

        public void setEnabled​(boolean value)
        [@property] enabled Whether the bus is active. Hosts must enable input busses before using them. The reason for this is to allow a unit such as a mixer to be prepared to render a large number of inputs, but avoid the work of preparing to pull inputs which are not in use. Bridged to the v2 properties kAudioUnitProperty_MakeConnection and kAudioUnitProperty_SetRenderCallback.

      • maximumChannelCount

        public int maximumChannelCount()
        [@property] maximumChannelCount The maximum numbers of channels supported for this bus. If supportedChannelCounts is set, then this value is derived from supportedChannelCounts. If setting maximumChannelCount makes the current format unsupported, then format will be set to nil. The default value is UINT_MAX.

      • name

        public java.lang.String name()
        [@property] name A name for the bus. Can be set by host.

      • ownerAudioUnit

        public AUAudioUnit ownerAudioUnit()
        [@property] ownerAudioUnit The audio unit that owns the bus.

      • setContextPresentationLatency

        public void setContextPresentationLatency​(double value)
        [@property] contextPresentationLatency Information about latency in the audio unit's processing context. This should not be confused with the audio unit's latency property, where the audio unit describes to the host any processing latency it introduces between its input and its output. A host may set this property to describe to the audio unit the presentation latency of its input and/or output audio data. Latency is described in seconds. A value of zero means either no latency or an unknown latency. A host should set this property on each active bus, since, for example, the audio routing path to each of multiple output busses may differ. For input busses: Describes how long ago the audio arriving on this bus was acquired. For instance, when reading from a file to the first audio unit in a chain, the input presentation latency is zero. For audio input from a device, this initial input latency is the presentation latency of the device itself, i.e. the device's safety offset and latency. A second chained audio unit's input presentation latency will be the input presentation latency of the first unit, plus the processing latency of the first unit. For output busses: Describes how long it will be before the output audio of an audio unit is presented. For instance, when writing to a file, the output presentation latency of the last audio unit in a chain is zero. When the audio from that audio unit is to be played to a device, then that initial presentation latency will be the presentation latency of the device itself, which is the I/O buffer size, plus the device's safety offset and latency A previous chained audio unit's output presentation latency is the last unit's presentation latency plus its processing latency. So, for a given audio unit anywhere within a mixing graph, the input and output presentation latencies describe to that unit how long from the moment of generation it has taken for its input to arrive, and how long it will take for its output to be presented. Bridged to the v2 property kAudioUnitProperty_PresentationLatency.

      • setFormatError

        public boolean setFormatError​(AVAudioFormat format,
                              org.moe.natj.general.ptr.Ptr<NSError> outError)
        [@property] setFormat:error: Sets the bus's audio format. Audio units can generally be expected to support AVAudioFormat's standard format (deinterleaved 32-bit float), at any sample rate. Channel counts can be more complex; see AUAudioUnit.channelCapabilities.

      • setMaximumChannelCount

        public void setMaximumChannelCount​(int value)
        [@property] maximumChannelCount The maximum numbers of channels supported for this bus. If supportedChannelCounts is set, then this value is derived from supportedChannelCounts. If setting maximumChannelCount makes the current format unsupported, then format will be set to nil. The default value is UINT_MAX.

      • setName

        public void setName​(java.lang.String value)
        [@property] name A name for the bus. Can be set by host.

      • setSupportedChannelCounts

        public void setSupportedChannelCounts​(NSArray<? extends NSNumber> value)
        [@property] supportedChannelCounts An array of numbers giving the supported numbers of channels for this bus. If supportedChannelCounts is nil, then any number less than or equal to maximumChannelCount is supported. If setting supportedChannelCounts makes the current format unsupported, then format will be set to nil. The default value is nil.

      • supportedChannelCounts

        public NSArray<? extends NSNumber> supportedChannelCounts()
        [@property] supportedChannelCounts An array of numbers giving the supported numbers of channels for this bus. If supportedChannelCounts is nil, then any number less than or equal to maximumChannelCount is supported. If setting supportedChannelCounts makes the current format unsupported, then format will be set to nil. The default value is nil.

      • supportedChannelLayoutTags

        public NSArray<? extends NSNumber> supportedChannelLayoutTags()
        [@property] supportedChannelLayoutTags This is an array of NSNumbers representing AudioChannelLayoutTag.

      • setShouldAllocateBuffer

        public void setShouldAllocateBuffer​(boolean value)
        [@property] shouldAllocateBuffer Controls the audio unit's allocation strategy for a bus. Hosts can set this flag to communicate whether an audio unit should allocate its own buffer. By default this flag is set to true. On the output side, shouldAllocateBuffer=false means the AU can assume that it will be called with non-null output buffers. If shouldAllocateBuffer=true (the default), the AU must be prepared to be called with null pointers and replace them with pointers to its internally allocated buffer. On the input side, shouldAllocateBuffer=false means the AU can pull for input using a buffer list with null buffer pointers, and assume that the pull input block will provide pointers. If shouldAllocateBuffer=true (the default), the AU must pull with non-null pointers while still being prepared for the source to replace them with pointers of its own. Bridged to the v2 property kAudioUnitProperty_ShouldAllocateBuffer.

      • shouldAllocateBuffer

        public boolean shouldAllocateBuffer()
        [@property] shouldAllocateBuffer Controls the audio unit's allocation strategy for a bus. Hosts can set this flag to communicate whether an audio unit should allocate its own buffer. By default this flag is set to true. On the output side, shouldAllocateBuffer=false means the AU can assume that it will be called with non-null output buffers. If shouldAllocateBuffer=true (the default), the AU must be prepared to be called with null pointers and replace them with pointers to its internally allocated buffer. On the input side, shouldAllocateBuffer=false means the AU can pull for input using a buffer list with null buffer pointers, and assume that the pull input block will provide pointers. If shouldAllocateBuffer=true (the default), the AU must pull with non-null pointers while still being prepared for the source to replace them with pointers of its own. Bridged to the v2 property kAudioUnitProperty_ShouldAllocateBuffer.