Package apple.audiotoolbox.c

Class AudioToolbox

  • public final class AudioToolbox
extends java.lang.Object

    • Method Detail

      • AudioComponentFindNext

        @Nullable
public static @Nullable AudioComponent AudioComponentFindNext​(@Nullable
                                                              @Nullable AudioComponent inComponent,
                                                              @NotNull
                                                              @NotNull AudioComponentDescription inDesc)
        [@function] AudioComponentFindNext Finds an audio component. This function is used to find an audio component that is the closest match to the provided values. Note that the list of available components may change dynamically in situations involving inter-app audio on iOS, or version 3 audio unit extensions. See kAudioComponentRegistrationsChangedNotification.
        Parameters:
        inComponent - If NULL, then the search starts from the beginning until an audio component is found that matches the description provided by inDesc. If non-NULL, then the search starts (continues) from the previously found audio component specified by inComponent, and will return the next found audio component.
        inDesc - The type, subtype and manufacturer fields are used to specify the audio component to search for. A value of 0 (zero) for any of these fields is a wildcard, so the first match found is returned.
        Returns:
        An audio component that matches the search parameters, or NULL if none found. API-Since: 2.0

      • AudioComponentCount

        public static int AudioComponentCount​(@NotNull
                                      @NotNull AudioComponentDescription inDesc)
        [@function] AudioComponentCount Counts audio components. Returns the number of AudioComponents that match the specified AudioComponentDescription.
        Parameters:
        inDesc - The type, subtype and manufacturer fields are used to specify the audio components to count A value of 0 (zero) for any of these fields is a wildcard, so will match any value for this field
        Returns:
        a UInt32. 0 (zero) means no audio components were found that matched the search parameters. API-Since: 2.0

      • AudioComponentCopyName

        public static int AudioComponentCopyName​(@NotNull
                                         @NotNull AudioComponent inComponent,
                                         @NotNull
                                         @NotNull org.moe.natj.general.ptr.Ptr<CFStringRef> outName)
        [@function] AudioComponentCopyName Retrieves the name of an audio component. the name of an audio component
        Parameters:
        inComponent - the audio component (must not be NULL)
        outName - a CFString that is the name of the audio component. This string should be released by the caller.
        Returns:
        an OSStatus result code. API-Since: 2.0

      • AudioComponentGetDescription

        public static int AudioComponentGetDescription​(@NotNull
                                               @NotNull AudioComponent inComponent,
                                               @NotNull
                                               @NotNull AudioComponentDescription outDesc)
        [@function] AudioComponentGetDescription Retrieve an audio component's description. This will return the fully specified audio component description for the provided audio component.
        Parameters:
        inComponent - the audio component (must not be NULL)
        outDesc - the audio component description for the specified audio component
        Returns:
        an OSStatus result code. API-Since: 2.0

      • AudioComponentGetVersion

        public static int AudioComponentGetVersion​(@NotNull
                                           @NotNull AudioComponent inComponent,
                                           @NotNull
                                           @NotNull org.moe.natj.general.ptr.IntPtr outVersion)
        [@function] AudioComponentGetVersion Retrieve an audio component's version.
        Parameters:
        inComponent - the audio component (must not be NULL)
        outVersion - the audio component's version in the form of 0xMMMMmmDD (Major, Minor, Dot)
        Returns:
        an OSStatus result code. API-Since: 2.0

      • AudioComponentInstanceNew

        public static int AudioComponentInstanceNew​(@NotNull
                                            @NotNull AudioComponent inComponent,
                                            @NotNull
                                            @NotNull org.moe.natj.general.ptr.Ptr<AudioComponentInstance> outInstance)
        [@function] AudioComponentInstanceNew Creates an audio component instance. This function creates an instance of a given audio component. The audio component instance is the object that does all of the work, whereas the audio component is the way an application finds and then creates this object to do this work. For example, an audio unit is a type of audio component instance, so to use an audio unit, one finds its audio component, and then creates a new instance of that component. This instance is then used to perform the audio tasks for which it was designed (process, mix, synthesise, etc.).
        Parameters:
        inComponent - the audio component (must not be NULL)
        outInstance - the audio component instance
        Returns:
        an OSStatus result code. API-Since: 2.0

      • AudioComponentInstantiate

        public static void AudioComponentInstantiate​(@NotNull
                                             @NotNull AudioComponent inComponent,
                                             int inOptions,
                                             @NotNull
                                             @NotNull AudioToolbox.Block_AudioComponentInstantiate inCompletionHandler)
        [@function] AudioComponentInstantiate Creates an audio component instance, asynchronously. This is an asynchronous version of AudioComponentInstanceNew(). It must be used to instantiate any component with kAudioComponentFlag_RequiresAsyncInstantiation set in its component flags. It may be used for other components as well. Note: Do not block the main thread while waiting for the completion handler to be called; this can deadlock.
        Parameters:
        inComponent - the audio component
        inOptions - see AudioComponentInstantiationOptions
        inCompletionHandler - called in an arbitrary thread context when instantiation is complete. API-Since: 9.0

      • AudioComponentInstanceDispose

        public static int AudioComponentInstanceDispose​(@NotNull
                                                @NotNull AudioComponentInstance inInstance)
        [@function] AudioComponentInstanceDispose Disposes of an audio component instance. This function will dispose the audio component instance that was created with the New call. It will deallocate any resources that the instance was using.
        Parameters:
        inInstance - the audio component instance to dispose (must not be NULL)
        Returns:
        an OSStatus result code. API-Since: 2.0

      • AudioComponentInstanceGetComponent

        @NotNull
public static @NotNull AudioComponent AudioComponentInstanceGetComponent​(@NotNull
                                                                         @NotNull AudioComponentInstance inInstance)
        [@function] AudioComponentInstanceGetComponent Retrieve the audio component from its instance Allows the application at any time to retrieve the audio component that is the factory object of a given instance (i.e., the audio component that was used to create the instance in the first place). This allows the application to retrieve general information about a particular audio component (its name, version, etc) when one just has an audio component instance to work with
        Parameters:
        inInstance - the audio component instance (must not be NULL, and instance must be valid - that is, not disposed)
        Returns:
        a valid audio component or NULL if no component was found. API-Since: 2.0

      • AudioComponentInstanceCanDo

        public static byte AudioComponentInstanceCanDo​(@NotNull
                                               @NotNull AudioComponentInstance inInstance,
                                               short inSelectorID)
        [@function] AudioComponentInstanceCanDo Determines if an audio component instance implements a particular component API call as signified by the specified selector identifier token.
        Parameters:
        inInstance - the audio component instance
        inSelectorID - a number to signify the audio component API (component selector) as appropriate for the instance's component type.
        Returns:
        a boolean API-Since: 3.0

      • AudioComponentRegister

        @NotNull
public static @NotNull AudioComponent AudioComponentRegister​(@NotNull
                                                             @NotNull AudioComponentDescription inDesc,
                                                             @NotNull
                                                             @NotNull CFStringRef inName,
                                                             int inVersion,
                                                             @NotNull
                                                             @NotNull AudioToolbox.Function_AudioComponentRegister inFactory)
        [@function] AudioComponentRegister Dynamically registers an AudioComponent within the current process AudioComponents are registered either when found in appropriate bundles in the filesystem, or via this call. AudioComponents registered via this call are available only within the current process.
        Parameters:
        inDesc - The AudioComponentDescription that describes the AudioComponent. Note that the registrar needs to be sure to set the flag kAudioComponentFlag_SandboxSafe in the componentFlags field of the AudioComponentDescription to indicate that the AudioComponent can be loaded directly into a sandboxed process.
        inName - the AudioComponent's name
        inVersion - the AudioComponent's version
        inFactory - an AudioComponentFactoryFunction which will create instances of your AudioComponent
        Returns:
        an AudioComponent object API-Since: 5.0

      • AudioUnitInitialize

        public static int AudioUnitInitialize​(@NotNull
                                      @NotNull AudioComponentInstance inUnit)
        [@function] AudioUnitInitialize initialize an audio unit Upon success, the audio unit has been successfully initialized. This means that the formats for input and output are valid and can be supported and it has based its allocations on the max number of frames that it is able to render at any given time. Once initialized, it is in a state where it can be asked to render. In common practice, major state of an audio unit (such as its I/O formats, memory allocations) cannot be changed while an audio unit is initialized.
        Parameters:
        inUnit - The audio unit to initialize
        Returns:
        noErr, or an error representing the reasons why the audio unit was not able to be initialized successfully API-Since: 2.0

      • AudioUnitUninitialize

        public static int AudioUnitUninitialize​(@NotNull
                                        @NotNull AudioComponentInstance inUnit)
        [@function] AudioUnitUninitialize uninitialize an audio unit Once an audio unit has been initialized, to change its state in response to some kind of environmental change, the audio unit should be uninitialized. This will have the effect of the audio unit de-allocating its resources. The caller can then reconfigure the audio unit to match the new environment (for instance, the sample rate to process audio is different than it was) and then re-initialize the audio unit when those changes have been applied.
        Parameters:
        inUnit - The audio unit to uninitialize
        Returns:
        noErr, or an error representing the reasons why the audio unit was not able to be initialized successfully. Typically this call won't return an error unless the audio unit in question is no longer valid. API-Since: 2.0

      • AudioUnitGetPropertyInfo

        public static int AudioUnitGetPropertyInfo​(@NotNull
                                           @NotNull AudioComponentInstance inUnit,
                                           int inID,
                                           int inScope,
                                           int inElement,
                                           @Nullable
                                           @Nullable org.moe.natj.general.ptr.IntPtr outDataSize,
                                           @Nullable
                                           @Nullable org.moe.natj.general.ptr.BytePtr outWritable)
        [@function] AudioUnitGetPropertyInfo retrieves information about a specified property The API can be used to retrieve both the size of the property, and whether it is writable or not. In order to get a general answer on the capability of an audio unit, this function should be called before the audio unit is initialized (as some properties are writable when the audio unit is initialized, and others not)
        Parameters:
        inUnit - the audio unit
        inID - the property identifier
        inScope - the scope of the property
        inElement - the element of the scope
        outDataSize - if not null, then will retrieve the maximum size for the property. if null, then it is ignored
        outWritable - if not null, then will retrieve whether the property can be written or not. if null, then it is ignored
        Returns:
        noErr, or various audio unit errors related to properties API-Since: 2.0

      • AudioUnitGetProperty

        public static int AudioUnitGetProperty​(@NotNull
                                       @NotNull AudioComponentInstance inUnit,
                                       int inID,
                                       int inScope,
                                       int inElement,
                                       @NotNull
                                       @NotNull org.moe.natj.general.ptr.VoidPtr outData,
                                       @NotNull
                                       @NotNull org.moe.natj.general.ptr.IntPtr ioDataSize)
        [@function] AudioUnitGetProperty retrieves the value of a specified property The API can is used to retrieve the value of the property. Property values for audio units are always passed by reference
        Parameters:
        inUnit - the audio unit
        inID - the property identifier
        inScope - the scope of the property
        inElement - the element of the scope
        outData - used to retrieve the value of the property. It should point to memory at least as large as the value described by ioDataSize
        ioDataSize - on input contains the size of the data pointed to by outData, on output, the size of the data that was returned.
        Returns:
        noErr, or various audio unit errors related to properties API-Since: 2.0

      • AudioUnitSetProperty

        public static int AudioUnitSetProperty​(@NotNull
                                       @NotNull AudioComponentInstance inUnit,
                                       int inID,
                                       int inScope,
                                       int inElement,
                                       @Nullable
                                       @Nullable org.moe.natj.general.ptr.ConstVoidPtr inData,
                                       int inDataSize)
        [@function] AudioUnitSetProperty sets the value of a specified property The API can is used to set the value of the property. Property values for audio units are always passed by reference
        Parameters:
        inUnit - the audio unit
        inID - the property identifier
        inScope - the scope of the property
        inElement - the element of the scope
        inData - if not null, then is the new value for the property that will be set. If null, then inDataSize should be zero, and the call is then used to remove a previously set value for a property. This removal is only valid for some properties, as most properties will always have a default value if not set.
        inDataSize - the size of the data being provided in inData
        Returns:
        noErr, or various audio unit errors related to properties API-Since: 2.0

      • AudioUnitAddPropertyListener

        public static int AudioUnitAddPropertyListener​(@NotNull
                                               @NotNull AudioComponentInstance inUnit,
                                               int inID,
                                               @NotNull
                                               @NotNull AudioToolbox.Function_AudioUnitAddPropertyListener inProc,
                                               @Nullable
                                               @Nullable org.moe.natj.general.ptr.VoidPtr inProcUserData)
        [@function] AudioUnitAddPropertyListener registration call to receive notifications for when a property changes When an audio unit property value changes, a notification callback can be called by the audio unit to inform interested parties that this event has occurred. The notification is defined by the tuple of inProc and inProcUserData as paired to the specified property ID, so the previously defined AudioUnitRemovePropertyListener is deprecated because it didn't allow for the provision of the inProcUserData to remove a given listener (so, you should use AudioUnitRemovePropertyListenerWithUserData).
        Parameters:
        inUnit - the audio unit
        inID - the property identifier
        inProc - the procedure to call when the property changes (on any scope or element)
        inProcUserData - the user data to provide with the callback
        Returns:
        noErr, or various audio unit errors related to properties API-Since: 2.0

      • AudioUnitRemovePropertyListenerWithUserData

        public static int AudioUnitRemovePropertyListenerWithUserData​(@NotNull
                                                              @NotNull AudioComponentInstance inUnit,
                                                              int inID,
                                                              @NotNull
                                                              @NotNull AudioToolbox.Function_AudioUnitRemovePropertyListenerWithUserData inProc,
                                                              @Nullable
                                                              @Nullable org.moe.natj.general.ptr.VoidPtr inProcUserData)
        [@function] AudioUnitRemovePropertyListenerWithUserData remove a previously registered property listener Removes a previously registered property listener as specified by the inProc and inProcUser data as paired to the property identifier
        Parameters:
        inUnit - the audio unit
        inID - the property identifier
        inProc - the procedure previously registered
        inProcUserData - the user data paired with the provided inProc
        Returns:
        noErr, or various audio unit errors related to properties API-Since: 2.0

      • AudioUnitAddRenderNotify

        public static int AudioUnitAddRenderNotify​(@NotNull
                                           @NotNull AudioComponentInstance inUnit,
                                           @NotNull
                                           @NotNull AudioToolbox.Function_AudioUnitAddRenderNotify inProc,
                                           @Nullable
                                           @Nullable org.moe.natj.general.ptr.VoidPtr inProcUserData)
        [@function] AudioUnitAddRenderNotify a notification callback to call when an audio unit is asked to render allows an application to register a callback with an audio unit for whenever the audio unit is asked to render. The callback is called both before the audio unit performs its render operations (the render flag's pre-render bit is set) and after the audio unit has completed its render operations (the render flag's post-render bit is set). On post-render, the audio buffer list (ioData) will contain valid audio data that was rendered by the audio unit. The inProc and inProcUserData are treated as a tuple entity, so when wanting to remove one, both the inProc and its inProcUserData must be specified
        Parameters:
        inUnit - the audio unit
        inProc - an AURenderCallback proc
        inProcUserData - the user data that will be provided with the proc when it is called
        Returns:
        noErr, or an audio unit error code API-Since: 2.0

      • AudioUnitRemoveRenderNotify

        public static int AudioUnitRemoveRenderNotify​(@NotNull
                                              @NotNull AudioComponentInstance inUnit,
                                              @NotNull
                                              @NotNull AudioToolbox.Function_AudioUnitRemoveRenderNotify inProc,
                                              @Nullable
                                              @Nullable org.moe.natj.general.ptr.VoidPtr inProcUserData)
        [@function] AudioUnitRemoveRenderNotify remove a previously registered render notification proc
        Parameters:
        inUnit - the audio unit
        inProc - an AURenderCallback proc
        inProcUserData - the user data that was provided with the proc when it was previously registered
        Returns:
        noErr, or an audio unit error code API-Since: 2.0

      • AudioUnitGetParameter

        public static int AudioUnitGetParameter​(@NotNull
                                        @NotNull AudioComponentInstance inUnit,
                                        int inID,
                                        int inScope,
                                        int inElement,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.FloatPtr outValue)
        [@function] AudioUnitGetParameter Get the value of a parameter Get the value of a parameter as specified by its ID, scope and element.
        Parameters:
        inUnit - the audio unit
        inID - the parameter ID
        inScope - the scope for the parameter
        inElement - the element on the scope for the parameter
        outValue - Must be non-null, and upon success will contain the current value for the specified parameter
        Returns:
        noErr, or an audio unit error code (such as InvalidParameter) API-Since: 2.0

      • AudioUnitSetParameter

        public static int AudioUnitSetParameter​(@NotNull
                                        @NotNull AudioComponentInstance inUnit,
                                        int inID,
                                        int inScope,
                                        int inElement,
                                        float inValue,
                                        int inBufferOffsetInFrames)
        [@function] AudioUnitSetParameter Set the value of a parameter Set the value of a parameter as specified by its ID, scope and element. Parameter IDs are consistent across all of the elements in a scope - so for a mixer, the "input volume" parameter can be applied on any input, and the particular input is specified by the elementID.
        Parameters:
        inUnit - the audio unit
        inID - the parameter ID
        inScope - the scope for the parameter
        inElement - the element on the scope for the parameter
        inValue - the new value for the parameter.
        inBufferOffsetInFrames - generally should be set to zero - see AudioUnitScheduleParameters
        Returns:
        noErr, or an audio unit error code (such as InvalidParameter) API-Since: 2.0

      • AudioUnitScheduleParameters

        public static int AudioUnitScheduleParameters​(@NotNull
                                              @NotNull AudioComponentInstance inUnit,
                                              @NotNull
                                              @NotNull org.moe.natj.general.ptr.VoidPtr inParameterEvent,
                                              int inNumParamEvents)
        [@function] AudioUnitScheduleParameters Schedule changes to the value of a parameter This API is used to schedule intra-buffer changes to the value of a parameter (immediate) or to ramp a parameter from a start value to an end value for a specified number of samples (ramp) The API allows for the scheduling of multiple parameter events with the one call. All of the parameter events must apply to the current (and only apply to the current) audio unit render call, so the events are scheduled as a part of the pre-render notification callback. When scheduling an immediate parameter event, the new value at the specified sample buffer offset is provided When scheduling a ramped parameter, the ramp is scheduled each audio unit render for the duration of the ramp. Each schedule of the the new audio unit render specifies the progress of the ramp. Parameters that can have events scheduled to them will indicate this through their parameter info struct
        Parameters:
        inUnit - the audio unit
        inParameterEvent - a pointer to an array of parameter event structs
        inNumParamEvents - the number of parameter event structs pointed to by inParameterEvent
        Returns:
        noErr, or an audio unit error code (such as InvalidParameter) API-Since: 2.0

      • AudioUnitRender

        public static int AudioUnitRender​(@NotNull
                                  @NotNull AudioComponentInstance inUnit,
                                  @Nullable
                                  @Nullable org.moe.natj.general.ptr.IntPtr ioActionFlags,
                                  @NotNull
                                  @NotNull AudioTimeStamp inTimeStamp,
                                  int inOutputBusNumber,
                                  int inNumberFrames,
                                  @NotNull
                                  @NotNull AudioBufferList ioData)
        [@function] AudioUnitRender the render operation where ioData will contain the results of the audio unit's render operations an audio unit will render the amount of audio data described by inNumberOfFrames and the results of that render will be contained within ioData. The caller should provide audio time stamps where at least the sample time is valid and it is incrementing sequentially from its previous call (so, the next time stamp will be the current time stamp + inNumberFrames) If the sample time is not incrementing sequentially, the audio unit will infer that there is some discontinuity with the timeline it is rendering for The caller must provide a valid ioData AudioBufferList that matches the expected topology for the current audio format for the given bus. The buffer list can be of two variants: (1) If the mData pointers are non-null then the audio unit will render its output into those buffers. These buffers should be aligned to 16 byte boundaries (which is normally what malloc will return). (2) If the mData pointers are null, then the audio unit can provide pointers to its own buffers. In this case the audio unit is required to keep those buffers valid for the duration of the calling thread's I/O cycle
        Parameters:
        inUnit - the audio unit
        ioActionFlags - any appropriate action flags for the render operation
        inTimeStamp - the time stamp that applies to this particular render operation. when rendering for multiple output buses the time stamp will generally be the same for each output bus, so the audio unit is able to determine without doubt that this the same render operation
        inOutputBusNumber - the output bus to render for
        inNumberFrames - the number of sample frames to render
        ioData - the audio buffer list that the audio unit is to render into.
        Returns:
        noErr, or an audio unit render error API-Since: 2.0

      • AudioUnitProcess

        public static int AudioUnitProcess​(@NotNull
                                   @NotNull AudioComponentInstance inUnit,
                                   @Nullable
                                   @Nullable org.moe.natj.general.ptr.IntPtr ioActionFlags,
                                   @NotNull
                                   @NotNull AudioTimeStamp inTimeStamp,
                                   int inNumberFrames,
                                   @NotNull
                                   @NotNull AudioBufferList ioData)
        API-Since: 6.0

      • AudioUnitProcessMultiple

        public static int AudioUnitProcessMultiple​(@NotNull
                                           @NotNull AudioComponentInstance inUnit,
                                           @Nullable
                                           @Nullable org.moe.natj.general.ptr.IntPtr ioActionFlags,
                                           @NotNull
                                           @NotNull AudioTimeStamp inTimeStamp,
                                           int inNumberFrames,
                                           int inNumberInputBufferLists,
                                           @NotNull
                                           @NotNull org.moe.natj.general.ptr.Ptr<org.moe.natj.general.ptr.ConstPtr<AudioBufferList>> inInputBufferLists,
                                           int inNumberOutputBufferLists,
                                           @NotNull
                                           @NotNull org.moe.natj.general.ptr.Ptr<org.moe.natj.general.ptr.Ptr<AudioBufferList>> ioOutputBufferLists)
        API-Since: 6.0

      • AudioUnitReset

        public static int AudioUnitReset​(@NotNull
                                 @NotNull AudioComponentInstance inUnit,
                                 int inScope,
                                 int inElement)
        [@function] AudioUnitReset reset an audio unit's render state This call will clear any render state of an audio unit. For instance, with a delay or reverb type of audio unit reset will clear any of the delay lines maintained within the audio unit. Typically, this call is made when an audio unit was previously rendering, and was taken out of the render chain (say, the track it is in was muted) and is being added back in (unmuted). The host should reset the audio unit before adding it back so that it doesn't produce audio from its delay lines that is no longer valid. The call should only clear memory, it should NOT allocate or free memory resources (this is done in the Initialize calls).
        Parameters:
        inUnit - the audio unit
        inScope - the scope - typically this is set to GlobalScope
        inElement - the element - typically this is set to 0
        Returns:
        noErr, or an audio unit error API-Since: 2.0

      • AudioOutputUnitPublish

        @Deprecated
public static int AudioOutputUnitPublish​(@NotNull
                                         @NotNull AudioComponentDescription inDesc,
                                         @NotNull
                                         @NotNull CFStringRef inName,
                                         int inVersion,
                                         @NotNull
                                         @NotNull AudioComponentInstance inOutputUnit)
        Deprecated.
        [@function] AudioOutputUnitPublish Register an audio output unit as available to be used as an audio unit by other applications. This allows a publishing application to register its audio (input/)output unit as being able to be redirected and repurposed as an audio unit effect, generator, music device or music effect by another host application. API-Since: 7.0 Deprecated-Since: 13.0 Deprecated-Message: Inter-App Audio API is deprecated in favor of Audio Units
        Parameters:
        inOutputUnit - The audio output unit to be published.
        inDesc - The AudioComponentDescription under which to register the application.
        inName - The application or component name.
        Returns:
        An OSStatus result code.

      • AudioOutputUnitGetHostIcon

        @Nullable
@Deprecated
public static @Nullable UIImage AudioOutputUnitGetHostIcon​(@NotNull
                                                           @NotNull AudioComponentInstance au,
                                                           float desiredPointSize)
        Deprecated.
        API-Since: 7.0 Deprecated-Since: 13.0 Deprecated-Message: Inter-App Audio API is deprecated in favor of Audio Units

      • AudioComponentGetIcon

        @Nullable
@Deprecated
public static @Nullable UIImage AudioComponentGetIcon​(@NotNull
                                                      @NotNull AudioComponent comp,
                                                      float desiredPointSize)
        Deprecated.
        API-Since: 7.0 Deprecated-Since: 14.0

      • AudioComponentGetLastActiveTime

        @Deprecated
public static double AudioComponentGetLastActiveTime​(@NotNull
                                                     @NotNull AudioComponent comp)
        Deprecated.
        [@function] AudioComponentGetLastActiveTime Fetches the time at which the application publishing the component was last active. Inter-app audio hosts can use this to sort the list of available nodes by how recently the user interacted with them.
        Parameters:
        comp - The AudioComponent being queried.
        Returns:
        The CFAbsoluteTime at which the node was last active (0 if never). API-Since: 7.0 Deprecated-Since: 13.0 Deprecated-Message: Inter-App Audio API is deprecated in favor of Audio Units

      • AudioOutputUnitStart

        public static int AudioOutputUnitStart​(@NotNull
                                       @NotNull AudioComponentInstance ci)
        ----------------------------------------------------------------------------- Start/stop methods for output units ----------------------------------------------------------------------------- API-Since: 2.0

      • AudioOutputUnitStop

        public static int AudioOutputUnitStop​(@NotNull
                                      @NotNull AudioComponentInstance ci)
        API-Since: 2.0

      • GetAudioUnitParameterDisplayType

        public static int GetAudioUnitParameterDisplayType​(int flags)

      • SetAudioUnitParameterDisplayType

        public static int SetAudioUnitParameterDisplayType​(int flags,
                                                   int displayType)

      • MusicDeviceMIDIEvent

        public static int MusicDeviceMIDIEvent​(@NotNull
                                       @NotNull AudioComponentInstance inUnit,
                                       int inStatus,
                                       int inData1,
                                       int inData2,
                                       int inOffsetSampleFrame)
        [@function] MusicDeviceMIDIEvent Used to sent MIDI channel messages to an audio unit This is the API used to send MIDI channel messages to an audio unit. The status and data parameters are used exactly as described by the MIDI specification, including the combination of channel and command in the status byte. All events sent via MusicDeviceMIDIEventList will be delivered to the audio unit in the MIDI protocol returned by kAudioUnitProperty_AudioUnitMIDIProtocol.
        Parameters:
        inUnit - The audio unit
        inStatus - The MIDI status byte
        inData1 - The first MIDI data byte (value is in the range 0 < 128)
        inData2 - The second MIDI data byte (value is in the range 0 < 128). If the MIDI status byte only has one data byte, this should be set to zero.
        inOffsetSampleFrame - If you are scheduling the MIDI Event from the audio unit's render thread, then you can supply a sample offset that the audio unit may apply when applying that event in its next audio unit render. This allows you to schedule to the sample, the time when a MIDI command is applied and is particularly important when starting new notes. If you are not scheduling in the audio unit's render thread, then you should set this value to 0
        Returns:
        noErr, or an audio unit error code API-Since: 5.0

      • MusicDeviceSysEx

        public static int MusicDeviceSysEx​(@NotNull
                                   @NotNull AudioComponentInstance inUnit,
                                   @NotNull
                                   @NotNull java.lang.String inData,
                                   int inLength)
        [@function] MusicDeviceSysEx used to send any non-channel MIDI event to an audio unit This is used to send any non-channel MIDI event to an audio unit. In practise this is a System Exclusive (SysEx) MIDI message
        Parameters:
        inUnit - The audio unit
        inData - The complete MIDI SysEx message including the F0 and F7 start and termination bytes
        inLength - The size, in bytes, of the data
        Returns:
        noErr, or an audio unit error code API-Since: 5.0

      • MusicDeviceStartNote

        public static int MusicDeviceStartNote​(@NotNull
                                       @NotNull AudioComponentInstance inUnit,
                                       int inInstrument,
                                       int inGroupID,
                                       @NotNull
                                       @NotNull org.moe.natj.general.ptr.IntPtr outNoteInstanceID,
                                       int inOffsetSampleFrame,
                                       @NotNull
                                       @NotNull MusicDeviceNoteParams inParams)
        [@function] MusicDeviceStartNote used to start a note This function is used to start a note. The caller must provide a NoteInstanceID to receive a token that is then used to stop the note. The MusicDeviceStopNote call should be used to stop notes started with this API. The token can also be used to address individual notes on the kAudioUnitScope_Note if the audio unit supports it. The instrumentID is no longer used and the kMusicNoteEvent_Unused constant should be specified (this takes the current patch for the specifed group as the sound to use for the note). The Audio unit must provide an unique ID for the note instance ID. This ID must be non-zero and not 0xFFFFFFFF (any other UInt32 value is valid). Not all Music Device audio units implement the semantics of this API (though it is strongly recommended that they do). A host application shoudl query the kMusicDeviceProperty_SupportsStartStopNote to check that this is supported.
        Parameters:
        inUnit - The audio unit
        inInstrument - The instrumentID is no longer used and the kMusicNoteEvent_Unused constant should be specified (this takes the current patch for the specifed group as the sound to use for the note)
        inGroupID - The group ID that this note will be attached too. As with MIDI, all notes sounding on a groupID can be controlled through the various parameters (such as pitch bend, etc) that can be specified on the Group Scope
        outNoteInstanceID - A pointer to receive the token that is used to identify the note. This parameter must be specified
        inOffsetSampleFrame - If you are scheduling the MIDI Event from the audio unit's render thread, then you can supply a sample offset that the audio unit may apply when starting the note in its next audio unit render. This allows you to schedule to the sample and is particularly important when starting new notes. If you are not scheduling in the audio unit's render thread, then you should set this value to 0
        inParams - The parameters to be used when starting the note - pitch and velocity must be specified
        Returns:
        noErr, or an audio unit error code API-Since: 5.0

      • MusicDeviceStopNote

        public static int MusicDeviceStopNote​(@NotNull
                                      @NotNull AudioComponentInstance inUnit,
                                      int inGroupID,
                                      int inNoteInstanceID,
                                      int inOffsetSampleFrame)
        [@function] MusicDeviceStopNote used to stop notes started with the MusicDeviceStartNote call This call is used to stop notes that have been started with the MusicDeviceStartNote call; both the group ID that the note was started on and the noteInstanceID should be specified.
        Parameters:
        inUnit - The audio unit
        inGroupID - the group ID
        inNoteInstanceID - the note instance ID
        inOffsetSampleFrame - the sample offset within the next buffer rendered that the note should be turned off at
        Returns:
        noErr, or an audio unit error code API-Since: 5.0

      • NewAUGraph

        @Deprecated
public static int NewAUGraph​(@NotNull
                             @NotNull org.moe.natj.general.ptr.Ptr<AUGraph> outGraph)
        Deprecated.
        [@function] NewAUGraph Create a new AUGraph
        Parameters:
        outGraph - the new AUGraph object API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • DisposeAUGraph

        @Deprecated
public static int DisposeAUGraph​(@NotNull
                                 @NotNull AUGraph inGraph)
        Deprecated.
        [@function] DisposeAUGraph Dispose an AUGraph Deallocates the AUGraph along with its nodes and their resources.
        Parameters:
        inGraph - the AUGraph object to be disposed API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphAddNode

        @Deprecated
public static int AUGraphAddNode​(@NotNull
                                 @NotNull AUGraph inGraph,
                                 @NotNull
                                 @NotNull AudioComponentDescription inDescription,
                                 @NotNull
                                 @NotNull org.moe.natj.general.ptr.IntPtr outNode)
        Deprecated.
        [@function] AUGraphAddNode Add a node to an AUGraph Creates a node in the graph that is an AudioUnit, using the supplied AudioComponentDescription to find and open that unit.
        Parameters:
        inGraph - the AUGraph object
        inDescription - the AudioComponentDescription used to find and open the AudioUnit
        outNode - the newly added node API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphRemoveNode

        @Deprecated
public static int AUGraphRemoveNode​(@NotNull
                                    @NotNull AUGraph inGraph,
                                    int inNode)
        Deprecated.
        [@function] AUGraphRemoveNode Remove a node from an AUGraph Nodes can be removed from any thread context. The output node of the AUGraph cannot be removed while the graph is running.
        Parameters:
        inGraph - the AUGraph object
        inNode - the node to be removed API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphGetNodeCount

        @Deprecated
public static int AUGraphGetNodeCount​(@NotNull
                                      @NotNull AUGraph inGraph,
                                      @NotNull
                                      @NotNull org.moe.natj.general.ptr.IntPtr outNumberOfNodes)
        Deprecated.
        [@function] AUGraphGetNodeCount The number of nodes in an AUGraph
        Parameters:
        inGraph - the AUGraph object
        outNumberOfNodes - the number of nodes API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphGetIndNode

        @Deprecated
public static int AUGraphGetIndNode​(@NotNull
                                    @NotNull AUGraph inGraph,
                                    int inIndex,
                                    @NotNull
                                    @NotNull org.moe.natj.general.ptr.IntPtr outNode)
        Deprecated.
        [@function] AUGraphGetIndNode Returns the node at a given index By using AUGraphGetNodeCount in conjunction with this call, you can iterate through the nodes of an AUGraph.
        Parameters:
        inGraph - the AUGraph object
        inIndex - the index of the node to retrieve
        outNode - the node at that index API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphNodeInfo

        @Deprecated
public static int AUGraphNodeInfo​(@NotNull
                                  @NotNull AUGraph inGraph,
                                  int inNode,
                                  @Nullable
                                  @Nullable AudioComponentDescription outDescription,
                                  @Nullable
                                  @Nullable org.moe.natj.general.ptr.Ptr<AudioComponentInstance> outAudioUnit)
        Deprecated.
        [@function] AUGraphNodeInfo Returns information about a particular AUNode You can pass in NULL for any of the out parameters if you're not interested in that value.
        Parameters:
        inGraph - the AUGraph object
        inNode - the node to query
        outDescription - the component description that would describe the AudioUnit of this node
        outAudioUnit - the AudioUnit of this node API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphConnectNodeInput

        @Deprecated
public static int AUGraphConnectNodeInput​(@NotNull
                                          @NotNull AUGraph inGraph,
                                          int inSourceNode,
                                          int inSourceOutputNumber,
                                          int inDestNode,
                                          int inDestInputNumber)
        Deprecated.
        [@function] AUGraphConnectNodeInput connect a node's output to a node's input API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphSetNodeInputCallback

        @Deprecated
public static int AUGraphSetNodeInputCallback​(@NotNull
                                              @NotNull AUGraph inGraph,
                                              int inDestNode,
                                              int inDestInputNumber,
                                              @NotNull
                                              @NotNull AURenderCallbackStruct inInputCallback)
        Deprecated.
        [@function] AUGraphSetNodeInputCallback Set a callback for the specified node's specified input.
        Parameters:
        inInputCallback - The callback that will provide input data to the node API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphDisconnectNodeInput

        @Deprecated
public static int AUGraphDisconnectNodeInput​(@NotNull
                                             @NotNull AUGraph inGraph,
                                             int inDestNode,
                                             int inDestInputNumber)
        Deprecated.
        [@function] AUGraphDisconnectNodeInput disconnect a node's input This can be used to disconnect either a connection or callback interaction to the specified node input API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphClearConnections

        @Deprecated
public static int AUGraphClearConnections​(@NotNull
                                          @NotNull AUGraph inGraph)
        Deprecated.
        [@function] AUGraphClearConnections clear all of the interactions in a graph This will clear all connections and callback interactions of the nodes of a graph API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphGetNumberOfInteractions

        @Deprecated
public static int AUGraphGetNumberOfInteractions​(@NotNull
                                                 @NotNull AUGraph inGraph,
                                                 @NotNull
                                                 @NotNull org.moe.natj.general.ptr.IntPtr outNumInteractions)
        Deprecated.
        [@function] AUGraphGetNumberOfInteractions Retrieve the number of interactions of a graph The number of node interactions currently being managed by the graph API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphGetInteractionInfo

        @Deprecated
public static int AUGraphGetInteractionInfo​(@NotNull
                                            @NotNull AUGraph inGraph,
                                            int inInteractionIndex,
                                            @NotNull
                                            @NotNull org.moe.natj.general.ptr.VoidPtr outInteraction)
        Deprecated.
        [@function] AUGraphGetInteractionInfo Retrieve information about a particular interaction in a graph Returns information about a particular interaction. inInteractionIndex is based on the outNumInteractions value and is only valid if no edits to the graph's state have been made. An app can iterate through the interactions (as with the nodes) of a graph by retrieving the number of interactions, and then iterating an index from 0 < numInteractions
        Parameters:
        outInteraction - the interaction information at the specified index API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphCountNodeInteractions

        @Deprecated
public static int AUGraphCountNodeInteractions​(@NotNull
                                               @NotNull AUGraph inGraph,
                                               int inNode,
                                               @NotNull
                                               @NotNull org.moe.natj.general.ptr.IntPtr outNumInteractions)
        Deprecated.
        [@function] AUGraphCountNodeInteractions Retrieve the number of interactions of a graph's node The number of node interactions currently being managed by the graph for the specified node. API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphGetNodeInteractions

        @Deprecated
public static int AUGraphGetNodeInteractions​(@NotNull
                                             @NotNull AUGraph inGraph,
                                             int inNode,
                                             @NotNull
                                             @NotNull org.moe.natj.general.ptr.IntPtr ioNumInteractions,
                                             @NotNull
                                             @NotNull org.moe.natj.general.ptr.VoidPtr outInteractions)
        Deprecated.
        [@function] AUGraphGetNodeInteractions Retrieve information about the interactions in a graph for a given node
        Parameters:
        ioNumInteractions - on input, specifies the number of interactions that can be returned on output, specifies the number of interactions returned.
        outInteractions - the interactions the specified node is involved in API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphUpdate

        @Deprecated
public static int AUGraphUpdate​(@NotNull
                                @NotNull AUGraph inGraph,
                                @Nullable
                                @Nullable org.moe.natj.general.ptr.BytePtr outIsUpdated)
        Deprecated.
        [@function] AUGraphUpdate Updates the state of a running AUGraph Call this after performing a series of "edits" on the AUGraph with calls such as AUGraphConnectNodeInput() to finalize those edits. The call will be synchronous if outIsUpdated is NULL, meaning it will block until the changes are incorporated into the graph OR an error is returned from the update process if outIsUpdated is non-NULL, then AUGraphUpdate() will return immediately and outIsUpdated will equal "true" if the changes were already made (no more changes to make) or "false" if changes are still outstanding. Calling from the AUGraphRenderNotification callback: Connection and Disconnection events can be completely processed in the render notification callback of the AUGraph Nodes can also be removed (except for the output node or a sub-graph of the AUGraph) as well. Getting kAUGraphErr_CannotDoInCurrentContext as a result code: If AUGraphUpdate returns this result, then it means it was unable to process the update, due to an inability to safely alter the state of the graph (because another thread was accessing a call that relies on the graph's state having integrity). This result code is only a transitory state, which will pass as soon as your other thread's call to AUGraph (that has the lock) completes. If an error is encountered in the process of an update (say an invalid connection is attempted, a disconnection between nodes that are not connected, etc) on a running graph, then the call will return that error code. It only process events whilst it receives no error results. Thus, if an error is encountered, other events will not be processed until AUGraphUpdate is called again. This is done, in cases where the state of the graph could become inconsistent if further events were processed, so this decision is left up to you. The same applies to the "cant do" error - you have to explicitly call AUGraphUpdate again to have the processing of the events occur.
        Parameters:
        outIsUpdated - if specified returns true if all of the edits were applied to the graph API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphOpen

        @Deprecated
public static int AUGraphOpen​(@NotNull
                              @NotNull AUGraph inGraph)
        Deprecated.
        [@function] AUGraphOpen Open a graph AudioUnits are open but not initialized (no resource allocation occurs here) API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphClose

        @Deprecated
public static int AUGraphClose​(@NotNull
                               @NotNull AUGraph inGraph)
        Deprecated.
        [@function] AUGraphClose Close a graph All AudioUnits are closed - leaving only its nodal representation API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphInitialize

        @Deprecated
public static int AUGraphInitialize​(@NotNull
                                    @NotNull AUGraph inGraph)
        Deprecated.
        [@function] AUGraphInitialize Initialise a graph AudioUnitInitialize() is called on each opened node/AudioUnit (get ready to render) and SubGraph that are involved in a interaction. If the node is not involved, it is initialised after it becomes involved in an interaction. A graph must be opened before it can be initialised. API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphUninitialize

        @Deprecated
public static int AUGraphUninitialize​(@NotNull
                                      @NotNull AUGraph inGraph)
        Deprecated.
        [@function] AUGraphUninitialize Uninitialise a graph The member of the graph are uninitialised API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphStart

        @Deprecated
public static int AUGraphStart​(@NotNull
                               @NotNull AUGraph inGraph)
        Deprecated.
        [@function] AUGraphStart Start a graph Start() is called on the "head" node(s) of the AUGraph (now rendering starts) The graph must be initialised before it can be started. API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphStop

        @Deprecated
public static int AUGraphStop​(@NotNull
                              @NotNull AUGraph inGraph)
        Deprecated.
        [@function] AUGraphStop Stop a graph Stop() is called on the "head" node(s) of the AUGraph (rendering is stopped) API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphIsOpen

        @Deprecated
public static int AUGraphIsOpen​(@NotNull
                                @NotNull AUGraph inGraph,
                                @NotNull
                                @NotNull org.moe.natj.general.ptr.BytePtr outIsOpen)
        Deprecated.
        [@function] AUGraphIsOpen Is the graph open API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphIsInitialized

        @Deprecated
public static int AUGraphIsInitialized​(@NotNull
                                       @NotNull AUGraph inGraph,
                                       @NotNull
                                       @NotNull org.moe.natj.general.ptr.BytePtr outIsInitialized)
        Deprecated.
        [@function] AUGraphIsInitialized Is the graph initialised API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphIsRunning

        @Deprecated
public static int AUGraphIsRunning​(@NotNull
                                   @NotNull AUGraph inGraph,
                                   @NotNull
                                   @NotNull org.moe.natj.general.ptr.BytePtr outIsRunning)
        Deprecated.
        [@function] AUGraphIsRunning Is the graph running (has it been started) API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphGetCPULoad

        @Deprecated
public static int AUGraphGetCPULoad​(@NotNull
                                    @NotNull AUGraph inGraph,
                                    @NotNull
                                    @NotNull org.moe.natj.general.ptr.FloatPtr outAverageCPULoad)
        Deprecated.
        [@function] AUGraphGetCPULoad The CPU load of the graph Returns a short-term running average of the current CPU load of the graph. API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphGetMaxCPULoad

        @Deprecated
public static int AUGraphGetMaxCPULoad​(@NotNull
                                       @NotNull AUGraph inGraph,
                                       @NotNull
                                       @NotNull org.moe.natj.general.ptr.FloatPtr outMaxLoad)
        Deprecated.
        [@function] AUGraphGetMaxCPULoad The Maximum CPU load of the graph Returns the max CPU load of the graph since this call was last made or the graph was last started. API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphAddRenderNotify

        @Deprecated
public static int AUGraphAddRenderNotify​(@NotNull
                                         @NotNull AUGraph inGraph,
                                         @NotNull
                                         @NotNull AudioToolbox.Function_AUGraphAddRenderNotify inCallback,
                                         @Nullable
                                         @Nullable org.moe.natj.general.ptr.VoidPtr inRefCon)
        Deprecated.
        [@function] AUGraphAddRenderNotify Add a notification callback Add a callback that the graph will call every time the graph renders. The callback will be called once before the graph's render operation, and once after the render operation is complete. API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AUGraphRemoveRenderNotify

        @Deprecated
public static int AUGraphRemoveRenderNotify​(@NotNull
                                            @NotNull AUGraph inGraph,
                                            @NotNull
                                            @NotNull AudioToolbox.Function_AUGraphRemoveRenderNotify inCallback,
                                            @Nullable
                                            @Nullable org.moe.natj.general.ptr.VoidPtr inRefCon)
        Deprecated.
        [@function] AUGraphRemoveRenderNotify Remove a notification callback Remove a previously added callback. You must provide both the callback and the refCon that was used previously to add the callback. API-Since: 2.0 Deprecated-Since: 100000.0 Deprecated-Message: AUGraph is deprecated in favor of AVAudioEngine

      • AudioConverterNew

        public static int AudioConverterNew​(@NotNull
                                    @NotNull AudioStreamBasicDescription inSourceFormat,
                                    @NotNull
                                    @NotNull AudioStreamBasicDescription inDestinationFormat,
                                    @NotNull
                                    @NotNull org.moe.natj.general.ptr.Ptr<AudioConverterRef> outAudioConverter)
        ----------------------------------------------------------------------------- [@function] AudioConverterNew Create a new AudioConverter.
        Parameters:
        inSourceFormat - The format of the source audio to be converted.
        inDestinationFormat - The destination format to which the audio is to be converted.
        outAudioConverter - On successful return, points to a new AudioConverter instance.
        Returns:
        An OSStatus result code. For a pair of linear PCM formats, the following conversions are supported:
        • addition and removal of channels, when the stream descriptions' mChannelsPerFrame does not match. Channels may also be reordered and removed using the kAudioConverterChannelMap property.
        • sample rate conversion
        • interleaving/deinterleaving, when the stream descriptions' (mFormatFlags & kAudioFormatFlagIsNonInterleaved) does not match.
        • conversion between any pair of the following formats:
          • 8 bit integer, signed or unsigned
          • 16, 24, or 32-bit integer, big- or little-endian. Other integral bit depths, if high-aligned and non-packed, are also supported
          • 32 and 64-bit float, big- or little-endian.
        Also, encoding and decoding between linear PCM and compressed formats is supported. Functions in AudioToolbox/AudioFormat.h return information about the supported formats. When using a codec, you can use any supported PCM format (as above); the converter will perform any necessary additional conversion between your PCM format and the one created or consumed by the codec. API-Since: 2.0

      • AudioConverterNewSpecific

        public static int AudioConverterNewSpecific​(@NotNull
                                            @NotNull AudioStreamBasicDescription inSourceFormat,
                                            @NotNull
                                            @NotNull AudioStreamBasicDescription inDestinationFormat,
                                            int inNumberClassDescriptions,
                                            @NotNull
                                            @NotNull AudioClassDescription inClassDescriptions,
                                            @NotNull
                                            @NotNull org.moe.natj.general.ptr.Ptr<AudioConverterRef> outAudioConverter)
        ----------------------------------------------------------------------------- [@function] AudioConverterNewSpecific Create a new AudioConverter using specific codecs.
        Parameters:
        inSourceFormat - The format of the source audio to be converted.
        inDestinationFormat - The destination format to which the audio is to be converted.
        inNumberClassDescriptions - The number of class descriptions.
        inClassDescriptions - AudioClassDescriptions specifiying the codec to instantiate.
        outAudioConverter - On successful return, points to a new AudioConverter instance.
        Returns:
        An OSStatus result code. This function is identical to AudioConverterNew(), except that the client may explicitly choose which codec to instantiate if there is more than one choice. API-Since: 2.0

      • AudioConverterDispose

        public static int AudioConverterDispose​(@NotNull
                                        @NotNull AudioConverterRef inAudioConverter)
        ----------------------------------------------------------------------------- [@function] AudioConverterDispose Destroy an AudioConverter.
        Parameters:
        inAudioConverter - The AudioConverter to dispose.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioConverterReset

        public static int AudioConverterReset​(@NotNull
                                      @NotNull AudioConverterRef inAudioConverter)
        ----------------------------------------------------------------------------- [@function] AudioConverterReset Reset an AudioConverter
        Parameters:
        inAudioConverter - The AudioConverter to reset.
        Returns:
        An OSStatus result code. Should be called whenever there is a discontinuity in the source audio stream being provided to the converter. This will flush any internal buffers in the converter. API-Since: 2.0

      • AudioConverterGetPropertyInfo

        public static int AudioConverterGetPropertyInfo​(@NotNull
                                                @NotNull AudioConverterRef inAudioConverter,
                                                int inPropertyID,
                                                @Nullable
                                                @Nullable org.moe.natj.general.ptr.IntPtr outSize,
                                                @Nullable
                                                @Nullable org.moe.natj.general.ptr.BytePtr outWritable)
        ----------------------------------------------------------------------------- [@function] AudioConverterGetPropertyInfo Returns information about an AudioConverter property.
        Parameters:
        inAudioConverter - The AudioConverter to query.
        inPropertyID - The property to query.
        outSize - If non-null, on exit, the maximum size of the property value in bytes.
        outWritable - If non-null, on exit, indicates whether the property value is writable.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioConverterGetProperty

        public static int AudioConverterGetProperty​(@NotNull
                                            @NotNull AudioConverterRef inAudioConverter,
                                            int inPropertyID,
                                            @NotNull
                                            @NotNull org.moe.natj.general.ptr.IntPtr ioPropertyDataSize,
                                            @NotNull
                                            @NotNull org.moe.natj.general.ptr.VoidPtr outPropertyData)
        ----------------------------------------------------------------------------- [@function] AudioConverterGetProperty Returns an AudioConverter property value.
        Parameters:
        inAudioConverter - The AudioConverter to query.
        inPropertyID - The property to fetch.
        ioPropertyDataSize - On entry, the size of the memory pointed to by outPropertyData. On successful exit, the size of the property value.
        outPropertyData - On exit, the property value.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioConverterSetProperty

        public static int AudioConverterSetProperty​(@NotNull
                                            @NotNull AudioConverterRef inAudioConverter,
                                            int inPropertyID,
                                            int inPropertyDataSize,
                                            @NotNull
                                            @NotNull org.moe.natj.general.ptr.ConstVoidPtr inPropertyData)
        ----------------------------------------------------------------------------- [@function] AudioConverterSetProperty Sets an AudioConverter property value.
        Parameters:
        inAudioConverter - The AudioConverter to modify.
        inPropertyID - The property to set.
        inPropertyDataSize - The size in bytes of the property value.
        inPropertyData - Points to the new property value.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioConverterConvertBuffer

        public static int AudioConverterConvertBuffer​(@NotNull
                                              @NotNull AudioConverterRef inAudioConverter,
                                              int inInputDataSize,
                                              @NotNull
                                              @NotNull org.moe.natj.general.ptr.ConstVoidPtr inInputData,
                                              @NotNull
                                              @NotNull org.moe.natj.general.ptr.IntPtr ioOutputDataSize,
                                              @NotNull
                                              @NotNull org.moe.natj.general.ptr.VoidPtr outOutputData)
        ----------------------------------------------------------------------------- [@function] AudioConverterConvertBuffer Converts data from an input buffer to an output buffer.
        Parameters:
        inAudioConverter - The AudioConverter to use.
        inInputDataSize - The size of the buffer inInputData.
        inInputData - The input audio data buffer.
        ioOutputDataSize - On entry, the size of the buffer outOutputData. On exit, the number of bytes written to outOutputData.
        outOutputData - The output data buffer.
        Returns:
        Produces a buffer of output data from an AudioConverter, using the supplied input buffer. WARNING: this function will fail for any conversion where there is a variable relationship between the input and output data buffer sizes. This includes sample rate conversions and most compressed formats. In these cases, use AudioConverterFillComplexBuffer. Generally this function is only appropriate for PCM-to-PCM conversions where there is no sample rate conversion. API-Since: 2.0

      • AudioConverterFillComplexBuffer

        public static int AudioConverterFillComplexBuffer​(@NotNull
                                                  @NotNull AudioConverterRef inAudioConverter,
                                                  @NotNull
                                                  @NotNull AudioToolbox.Function_AudioConverterFillComplexBuffer inInputDataProc,
                                                  @Nullable
                                                  @Nullable org.moe.natj.general.ptr.VoidPtr inInputDataProcUserData,
                                                  @NotNull
                                                  @NotNull org.moe.natj.general.ptr.IntPtr ioOutputDataPacketSize,
                                                  @NotNull
                                                  @NotNull AudioBufferList outOutputData,
                                                  @Nullable
                                                  @Nullable AudioStreamPacketDescription outPacketDescription)
        ----------------------------------------------------------------------------- [@function] AudioConverterFillComplexBuffer Converts data supplied by an input callback function, supporting non-interleaved and packetized formats.
        Parameters:
        inAudioConverter - The AudioConverter to use.
        inInputDataProc - A callback function which supplies the input data.
        inInputDataProcUserData - A value for the use of the callback function.
        ioOutputDataPacketSize - On entry, the capacity of outOutputData expressed in packets in the converter's output format. On exit, the number of packets of converted data that were written to outOutputData.
        outOutputData - The converted output data is written to this buffer. On entry, the buffers' mDataByteSize fields (which must all be the same) reflect buffer capacity. On exit, mDataByteSize is set to the number of bytes written.
        outPacketDescription - If non-null, and the converter's output uses packet descriptions, then packet descriptions are written to this array. It must point to a memory block capable of holding *ioOutputDataPacketSize packet descriptions. (See AudioFormat.h for ways to determine whether an audio format uses packet descriptions).
        Returns:
        An OSStatus result code. Produces a buffer list of output data from an AudioConverter. The supplied input callback function is called whenever necessary. If the output format uses packet descriptions, such as most compressed formats where packets vary in size or duration, the caller is expected to provide a buffer for holding packet descriptions, pointed to by outPacketDescription. The array must have the capacity to hold a packet description for each output packet that may be written. A packet description array is expected even if only a single output packet is to be written. API-Since: 2.0

      • AudioConverterConvertComplexBuffer

        public static int AudioConverterConvertComplexBuffer​(@NotNull
                                                     @NotNull AudioConverterRef inAudioConverter,
                                                     int inNumberPCMFrames,
                                                     @NotNull
                                                     @NotNull AudioBufferList inInputData,
                                                     @NotNull
                                                     @NotNull AudioBufferList outOutputData)
        ----------------------------------------------------------------------------- [@function] AudioConverterConvertComplexBuffer Converts PCM data from an input buffer list to an output buffer list. [@warning] This function will fail for any conversion where there is a variable relationship between the input and output data buffer sizes. This includes sample rate conversions and most compressed formats. In these cases, use AudioConverterFillComplexBuffer. Generally this function is only appropriate for PCM-to-PCM conversions where there is no sample rate conversion. API-Since: 5.0
        Parameters:
        inAudioConverter - The AudioConverter to use.
        inNumberPCMFrames - The number of PCM frames to convert.
        inInputData - The source audio buffer list.
        outOutputData - The converted output data is written to this buffer list.
        Returns:
        An OSStatus result code.

      • NumBytesToNumAudioFileMarkers

        public static long NumBytesToNumAudioFileMarkers​(long inNumBytes)

      • NumAudioFileMarkersToNumBytes

        public static long NumAudioFileMarkersToNumBytes​(long inNumMarkers)

      • AudioFileCreateWithURL

        public static int AudioFileCreateWithURL​(@NotNull
                                         @NotNull CFURLRef inFileRef,
                                         int inFileType,
                                         @NotNull
                                         @NotNull AudioStreamBasicDescription inFormat,
                                         int inFlags,
                                         @NotNull
                                         @NotNull org.moe.natj.general.ptr.Ptr<AudioFileID> outAudioFile)
        [@function] AudioFileCreateWithURL creates a new audio file (or initialises an existing file) creates a new (or initialises an existing) audio file specified by the URL. Upon success, an AudioFileID is returned which can be used for subsequent calls to the AudioFile APIs.
        Parameters:
        inFileRef - an CFURLRef fully specifying the path of the file to create/initialise
        inFileType - an AudioFileTypeID indicating the type of audio file to create.
        inFormat - an AudioStreamBasicDescription describing the data format that will be added to the audio file.
        inFlags - relevant flags for creating/opening the file. if kAudioFileFlags_EraseFile is set, it will erase an existing file if not set, then the Create call will fail if the URL is an existing file
        outAudioFile - if successful, an AudioFileID that can be used for subsequent AudioFile calls.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileOpenURL

        public static int AudioFileOpenURL​(@NotNull
                                   @NotNull CFURLRef inFileRef,
                                   byte inPermissions,
                                   int inFileTypeHint,
                                   @NotNull
                                   @NotNull org.moe.natj.general.ptr.Ptr<AudioFileID> outAudioFile)
        [@function] AudioFileOpenURL Open an existing audio file. Open an existing audio file for reading or reading and writing.
        Parameters:
        inFileRef - the CFURLRef of an existing audio file.
        inPermissions - use the permission constants
        inFileTypeHint - For files which have no filename extension and whose type cannot be easily or uniquely determined from the data (ADTS,AC3), this hint can be used to indicate the file type. Otherwise you can pass zero for this. The hint is only used on OS versions 10.3.1 or greater. For OS versions prior to that, opening files of the above description will fail.
        outAudioFile - upon success, an AudioFileID that can be used for subsequent AudioFile calls.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileInitializeWithCallbacks

        public static int AudioFileInitializeWithCallbacks​(@NotNull
                                                   @NotNull org.moe.natj.general.ptr.VoidPtr inClientData,
                                                   @NotNull
                                                   @NotNull AudioToolbox.Function_AudioFileInitializeWithCallbacks_1 inReadFunc,
                                                   @NotNull
                                                   @NotNull AudioToolbox.Function_AudioFileInitializeWithCallbacks_2 inWriteFunc,
                                                   @NotNull
                                                   @NotNull AudioToolbox.Function_AudioFileInitializeWithCallbacks_3 inGetSizeFunc,
                                                   @NotNull
                                                   @NotNull AudioToolbox.Function_AudioFileInitializeWithCallbacks_4 inSetSizeFunc,
                                                   int inFileType,
                                                   @NotNull
                                                   @NotNull AudioStreamBasicDescription inFormat,
                                                   int inFlags,
                                                   @NotNull
                                                   @NotNull org.moe.natj.general.ptr.Ptr<AudioFileID> outAudioFile)
        [@function] AudioFileInitializeWithCallbacks Wipe clean an existing file. You provide callbacks that the AudioFile API will use to get the data.
        Parameters:
        inClientData - a constant that will be passed to your callbacks.
        inReadFunc - a function that will be called when AudioFile needs to read data.
        inWriteFunc - a function that will be called when AudioFile needs to write data.
        inGetSizeFunc - a function that will be called when AudioFile needs to know the file size.
        inSetSizeFunc - a function that will be called when AudioFile needs to set the file size.
        inFileType - an AudioFileTypeID indicating the type of audio file to which to initialize the file.
        inFormat - an AudioStreamBasicDescription describing the data format that will be added to the audio file.
        inFlags - flags for creating/opening the file. Currently zero.
        outAudioFile - upon success, an AudioFileID that can be used for subsequent AudioFile calls.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileOpenWithCallbacks

        public static int AudioFileOpenWithCallbacks​(@NotNull
                                             @NotNull org.moe.natj.general.ptr.VoidPtr inClientData,
                                             @NotNull
                                             @NotNull AudioToolbox.Function_AudioFileOpenWithCallbacks_1 inReadFunc,
                                             @Nullable
                                             @Nullable AudioToolbox.Function_AudioFileOpenWithCallbacks_2 inWriteFunc,
                                             @NotNull
                                             @NotNull AudioToolbox.Function_AudioFileOpenWithCallbacks_3 inGetSizeFunc,
                                             @Nullable
                                             @Nullable AudioToolbox.Function_AudioFileOpenWithCallbacks_4 inSetSizeFunc,
                                             int inFileTypeHint,
                                             @NotNull
                                             @NotNull org.moe.natj.general.ptr.Ptr<AudioFileID> outAudioFile)
        [@function] AudioFileOpenWithCallbacks Open an existing file. You provide callbacks that the AudioFile API will use to get the data.
        Parameters:
        inClientData - a constant that will be passed to your callbacks.
        inReadFunc - a function that will be called when AudioFile needs to read data.
        inWriteFunc - a function that will be called when AudioFile needs to write data.
        inGetSizeFunc - a function that will be called when AudioFile needs to know the total file size.
        inSetSizeFunc - a function that will be called when AudioFile needs to set the file size.
        inFileTypeHint - For files which have no filename extension and whose type cannot be easily or uniquely determined from the data (ADTS,AC3), this hint can be used to indicate the file type. Otherwise you can pass zero for this. The hint is only used on OS versions 10.3.1 or greater. For OS versions prior to that, opening files of the above description will fail.
        outAudioFile - upon success, an AudioFileID that can be used for subsequent AudioFile calls.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileClose

        public static int AudioFileClose​(@NotNull
                                 @NotNull AudioFileID inAudioFile)
        [@function] AudioFileClose Close an existing audio file.
        Parameters:
        inAudioFile - an AudioFileID.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileOptimize

        public static int AudioFileOptimize​(@NotNull
                                    @NotNull AudioFileID inAudioFile)
        [@function] AudioFileOptimize Move the audio data to the end of the file and other internal optimizations of the file structure. Optimize the file so additional audio data can be appended to the existing data. Generally, this will place the audio data at the end of the file so additional writes can be placed to the file end. This can be a potentially expensive and time-consuming operation and should not be used during time critical operations. There is a kAudioFilePropertyIsOptimized property for checking on the optimized state of the file.
        Parameters:
        inAudioFile - an AudioFileID.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileReadBytes

        public static int AudioFileReadBytes​(@NotNull
                                     @NotNull AudioFileID inAudioFile,
                                     byte inUseCache,
                                     long inStartingByte,
                                     @NotNull
                                     @NotNull org.moe.natj.general.ptr.IntPtr ioNumBytes,
                                     @NotNull
                                     @NotNull org.moe.natj.general.ptr.VoidPtr outBuffer)
        [@function] AudioFileReadBytes Read bytes of audio data from the audio file. Returns kAudioFileEndOfFileError when read encounters end of file.
        Parameters:
        inAudioFile - an AudioFileID.
        inUseCache - true if it is desired to cache the data upon read, else false
        inStartingByte - the byte offset of the audio data desired to be returned
        ioNumBytes - on input, the number of bytes to read, on output, the number of bytes actually read.
        outBuffer - outBuffer should be a void * to user allocated memory large enough for the requested bytes.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileWriteBytes

        public static int AudioFileWriteBytes​(@NotNull
                                      @NotNull AudioFileID inAudioFile,
                                      byte inUseCache,
                                      long inStartingByte,
                                      @NotNull
                                      @NotNull org.moe.natj.general.ptr.IntPtr ioNumBytes,
                                      @NotNull
                                      @NotNull org.moe.natj.general.ptr.ConstVoidPtr inBuffer)
        [@function] AudioFileWriteBytes Write bytes of audio data to the audio file.
        Parameters:
        inAudioFile - an AudioFileID.
        inUseCache - true if it is desired to cache the data upon write, else false
        inStartingByte - the byte offset where the audio data should be written
        ioNumBytes - on input, the number of bytes to write, on output, the number of bytes actually written.
        inBuffer - inBuffer should be a void * containing the bytes to be written
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileReadPacketData

        public static int AudioFileReadPacketData​(@NotNull
                                          @NotNull AudioFileID inAudioFile,
                                          byte inUseCache,
                                          @NotNull
                                          @NotNull org.moe.natj.general.ptr.IntPtr ioNumBytes,
                                          @Nullable
                                          @Nullable org.moe.natj.general.ptr.Ptr<AudioStreamPacketDescription> outPacketDescriptions,
                                          long inStartingPacket,
                                          @NotNull
                                          @NotNull org.moe.natj.general.ptr.IntPtr ioNumPackets,
                                          @Nullable
                                          @Nullable org.moe.natj.general.ptr.VoidPtr outBuffer)
        [@function] AudioFileReadPacketData Read packets of audio data from the audio file. AudioFileReadPacketData reads as many of the requested number of packets as will fit in the buffer size given by ioNumPackets. Unlike the deprecated AudioFileReadPackets, ioNumPackets must be initialized. If the byte size of the number packets requested is less than the buffer size, ioNumBytes will be reduced. If the buffer is too small for the number of packets requested, ioNumPackets and ioNumBytes will be reduced to the number of packets that can be accommodated and their byte size. Returns kAudioFileEndOfFileError when read encounters end of file. For all uncompressed formats, packets == frames.
        Parameters:
        inAudioFile - an AudioFileID.
        inUseCache - true if it is desired to cache the data upon read, else false
        ioNumBytes - on input the size of outBuffer in bytes. on output, the number of bytes actually returned.
        outPacketDescriptions - An array of packet descriptions describing the packets being returned. The size of the array must be greater or equal to the number of packets requested. On return the packet description will be filled out with the packet offsets and sizes. Packet descriptions are ignored for CBR data.
        inStartingPacket - The packet index of the first packet desired to be returned
        ioNumPackets - on input, the number of packets to read, on output, the number of packets actually read.
        outBuffer - outBuffer should be a pointer to user allocated memory.
        Returns:
        returns noErr if successful. API-Since: 2.2

      • AudioFileReadPackets

        @Deprecated
public static int AudioFileReadPackets​(@NotNull
                                       @NotNull AudioFileID inAudioFile,
                                       byte inUseCache,
                                       @NotNull
                                       @NotNull org.moe.natj.general.ptr.IntPtr outNumBytes,
                                       @Nullable
                                       @Nullable org.moe.natj.general.ptr.Ptr<AudioStreamPacketDescription> outPacketDescriptions,
                                       long inStartingPacket,
                                       @NotNull
                                       @NotNull org.moe.natj.general.ptr.IntPtr ioNumPackets,
                                       @Nullable
                                       @Nullable org.moe.natj.general.ptr.VoidPtr outBuffer)
        Deprecated.
        [@function] AudioFileReadPackets Read packets of audio data from the audio file. AudioFileReadPackets is DEPRECATED. Use AudioFileReadPacketData instead. READ THE HEADER DOC FOR AudioFileReadPacketData. It is not a drop-in replacement. In particular, for AudioFileReadPacketData ioNumBytes must be initialized to the buffer size. AudioFileReadPackets assumes you have allocated your buffer to ioNumPackets times the maximum packet size. For many compressed formats this will only use a portion of the buffer since the ratio of the maximum packet size to the typical packet size can be large. Use AudioFileReadPacketData instead.
        Parameters:
        inAudioFile - an AudioFileID.
        inUseCache - true if it is desired to cache the data upon read, else false
        outNumBytes - on output, the number of bytes actually returned
        outPacketDescriptions - on output, an array of packet descriptions describing the packets being returned. NULL may be passed for this parameter. Nothing will be returned for linear pcm data.
        inStartingPacket - the packet index of the first packet desired to be returned
        ioNumPackets - on input, the number of packets to read, on output, the number of packets actually read.
        outBuffer - outBuffer should be a pointer to user allocated memory of size: number of packets requested times file's maximum (or upper bound on) packet size.
        Returns:
        returns noErr if successful. API-Since: 2.0 Deprecated-Since: 8.0 Deprecated-Message: no longer supported

      • AudioFileWritePackets

        public static int AudioFileWritePackets​(@NotNull
                                        @NotNull AudioFileID inAudioFile,
                                        byte inUseCache,
                                        int inNumBytes,
                                        @Nullable
                                        @Nullable org.moe.natj.general.ptr.ConstPtr<AudioStreamPacketDescription> inPacketDescriptions,
                                        long inStartingPacket,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.IntPtr ioNumPackets,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.ConstVoidPtr inBuffer)
        [@function] AudioFileWritePackets Write packets of audio data to the audio file. For all uncompressed formats, packets == frames.
        Parameters:
        inAudioFile - an AudioFileID.
        inUseCache - true if it is desired to cache the data upon write, else false
        inNumBytes - the number of bytes being provided for write
        inPacketDescriptions - an array of packet descriptions describing the packets being provided. Not all formats require packet descriptions to be provided. NULL may be passed if no descriptions are required.
        inStartingPacket - the packet index of where the first packet provided should be placed.
        ioNumPackets - on input, the number of packets to write, on output, the number of packets actually written.
        inBuffer - a void * to user allocated memory containing the packets to write.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileCountUserData

        public static int AudioFileCountUserData​(@NotNull
                                         @NotNull AudioFileID inAudioFile,
                                         int inUserDataID,
                                         @NotNull
                                         @NotNull org.moe.natj.general.ptr.IntPtr outNumberItems)
        [@function] AudioFileCountUserData Get the number of user data items with a certain ID in the file "User Data" refers to chunks in AIFF, CAF and WAVE files, or resources in Sound Designer II files, and possibly other things in other files. For simplicity, referred to below as "chunks".
        Parameters:
        inAudioFile - an AudioFileID.
        inUserDataID - the four char code of the chunk.
        outNumberItems - on output, if successful, number of chunks of this type in the file.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileGetUserDataSize

        public static int AudioFileGetUserDataSize​(@NotNull
                                           @NotNull AudioFileID inAudioFile,
                                           int inUserDataID,
                                           int inIndex,
                                           @NotNull
                                           @NotNull org.moe.natj.general.ptr.IntPtr outUserDataSize)
        [@function] AudioFileGetUserDataSize Get the size of user data in a file
        Parameters:
        inAudioFile - an AudioFileID.
        inUserDataID - the four char code of the chunk.
        inIndex - an index specifying which chunk if there are more than one.
        outUserDataSize - on output, if successful, the size of the user data chunk.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileGetUserData

        public static int AudioFileGetUserData​(@NotNull
                                       @NotNull AudioFileID inAudioFile,
                                       int inUserDataID,
                                       int inIndex,
                                       @NotNull
                                       @NotNull org.moe.natj.general.ptr.IntPtr ioUserDataSize,
                                       @NotNull
                                       @NotNull org.moe.natj.general.ptr.VoidPtr outUserData)
        [@function] AudioFileGetUserData Get the data of a chunk in a file.
        Parameters:
        inAudioFile - an AudioFileID.
        inUserDataID - the four char code of the chunk.
        inIndex - an index specifying which chunk if there are more than one.
        ioUserDataSize - the size of the buffer on input, size of bytes copied to buffer on output
        outUserData - a pointer to a buffer in which to copy the chunk data.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileSetUserData

        public static int AudioFileSetUserData​(@NotNull
                                       @NotNull AudioFileID inAudioFile,
                                       int inUserDataID,
                                       int inIndex,
                                       int inUserDataSize,
                                       @NotNull
                                       @NotNull org.moe.natj.general.ptr.ConstVoidPtr inUserData)
        [@function] AudioFileSetUserData Set the data of a chunk in a file.
        Parameters:
        inAudioFile - an AudioFileID.
        inUserDataID - the four char code of the chunk.
        inIndex - an index specifying which chunk if there are more than one.
        inUserDataSize - on input the size of the data to copy, on output, size of bytes copied from the buffer
        inUserData - a pointer to a buffer from which to copy the chunk data (only the contents of the chunk, not including the chunk header).
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileRemoveUserData

        public static int AudioFileRemoveUserData​(@NotNull
                                          @NotNull AudioFileID inAudioFile,
                                          int inUserDataID,
                                          int inIndex)
        [@function] AudioFileRemoveUserData Remove a user chunk in a file.
        Parameters:
        inAudioFile - an AudioFileID.
        inUserDataID - the four char code of the chunk.
        inIndex - an index specifying which chunk if there are more than one.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileGetPropertyInfo

        public static int AudioFileGetPropertyInfo​(@NotNull
                                           @NotNull AudioFileID inAudioFile,
                                           int inPropertyID,
                                           @Nullable
                                           @Nullable org.moe.natj.general.ptr.IntPtr outDataSize,
                                           @Nullable
                                           @Nullable org.moe.natj.general.ptr.IntPtr isWritable)
        [@function] AudioFileGetPropertyInfo Get information about the size of a property of an AudioFile and whether it can be set.
        Parameters:
        inAudioFile - an AudioFileID.
        inPropertyID - an AudioFileProperty constant.
        outDataSize - the size in bytes of the current value of the property. In order to get the property value, you will need a buffer of this size.
        isWritable - will be set to 1 if writable, or 0 if read only.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileGetProperty

        public static int AudioFileGetProperty​(@NotNull
                                       @NotNull AudioFileID inAudioFile,
                                       int inPropertyID,
                                       @NotNull
                                       @NotNull org.moe.natj.general.ptr.IntPtr ioDataSize,
                                       @NotNull
                                       @NotNull org.moe.natj.general.ptr.VoidPtr outPropertyData)
        [@function] AudioFileGetProperty Copies the value for a property of an AudioFile into a buffer.
        Parameters:
        inAudioFile - an AudioFileID.
        inPropertyID - an AudioFileProperty constant.
        ioDataSize - on input the size of the outPropertyData buffer. On output the number of bytes written to the buffer.
        outPropertyData - the buffer in which to write the property data.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileSetProperty

        public static int AudioFileSetProperty​(@NotNull
                                       @NotNull AudioFileID inAudioFile,
                                       int inPropertyID,
                                       int inDataSize,
                                       @NotNull
                                       @NotNull org.moe.natj.general.ptr.ConstVoidPtr inPropertyData)
        [@function] AudioFileSetProperty Sets the value for a property of an AudioFile .
        Parameters:
        inAudioFile - an AudioFileID.
        inPropertyID - an AudioFileProperty constant.
        inDataSize - the size of the property data.
        inPropertyData - the buffer containing the property data.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileGetGlobalInfoSize

        public static int AudioFileGetGlobalInfoSize​(int inPropertyID,
                                             int inSpecifierSize,
                                             @Nullable
                                             @Nullable org.moe.natj.general.ptr.VoidPtr inSpecifier,
                                             @NotNull
                                             @NotNull org.moe.natj.general.ptr.IntPtr outDataSize)
        [@function] AudioFileGetGlobalInfoSize Get the size of a global property.
        Parameters:
        inPropertyID - an AudioFileGlobalInfo property constant.
        inSpecifierSize - The size of the specifier data.
        inSpecifier - A specifier is a buffer of data used as an input argument to some of the global info properties.
        outDataSize - the size in bytes of the current value of the property. In order to get the property value, you will need a buffer of this size.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileGetGlobalInfo

        public static int AudioFileGetGlobalInfo​(int inPropertyID,
                                         int inSpecifierSize,
                                         @Nullable
                                         @Nullable org.moe.natj.general.ptr.VoidPtr inSpecifier,
                                         @NotNull
                                         @NotNull org.moe.natj.general.ptr.IntPtr ioDataSize,
                                         @NotNull
                                         @NotNull org.moe.natj.general.ptr.VoidPtr outPropertyData)
        [@function] AudioFileGetGlobalInfo Copies the value for a global property into a buffer.
        Parameters:
        inPropertyID - an AudioFileGlobalInfo property constant.
        inSpecifierSize - The size of the specifier data.
        inSpecifier - A specifier is a buffer of data used as an input argument to some of the global info properties.
        ioDataSize - on input the size of the outPropertyData buffer. On output the number of bytes written to the buffer.
        outPropertyData - the buffer in which to write the property data.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFileStreamOpen

        public static int AudioFileStreamOpen​(@Nullable
                                      @Nullable org.moe.natj.general.ptr.VoidPtr inClientData,
                                      @NotNull
                                      @NotNull AudioToolbox.Function_AudioFileStreamOpen_1 inPropertyListenerProc,
                                      @NotNull
                                      @NotNull AudioToolbox.Function_AudioFileStreamOpen_2 inPacketsProc,
                                      int inFileTypeHint,
                                      @NotNull
                                      @NotNull org.moe.natj.general.ptr.Ptr<AudioFileStreamID> outAudioFileStream)
        [@function] AudioFileStreamOpen Create a new audio file stream parser. The client provides the parser with data and the parser calls callbacks when interesting things are found in the data, such as properties and audio packets.
        Parameters:
        inClientData - a constant that will be passed to your callbacks.
        inPropertyListenerProc - Whenever the value of a property is parsed in the data, this function will be called. You can then get the value of the property from in the callback. In some cases, due to boundaries in the input data, the property may return kAudioFileStreamError_DataUnavailable. When unavailable data is requested from within the property listener, the parser will begin caching the property value and will call the property listener again when the property is available. For property values for which kAudioFileStreamPropertyFlag_PropertyIsCached is unset, this will be the only opportunity to get the value of the property, since the data will be disposed upon return of the property listener callback.
        inPacketsProc - Whenever packets are parsed in the data, a pointer to the packets is passed to the client using this callback. At times only a single packet may be passed due to boundaries in the input data.
        inFileTypeHint - For files whose type cannot be easily or uniquely determined from the data (ADTS,AC3), this hint can be used to indicate the file type. Otherwise if you do not know the file type, you can pass zero.
        outAudioFileStream - A new file stream ID for use in other AudioFileStream API calls. API-Since: 2.0

      • AudioFileStreamParseBytes

        public static int AudioFileStreamParseBytes​(@NotNull
                                            @NotNull AudioFileStreamID inAudioFileStream,
                                            int inDataByteSize,
                                            @Nullable
                                            @Nullable org.moe.natj.general.ptr.ConstVoidPtr inData,
                                            int inFlags)
        [@function] AudioFileStreamParseBytes This call is the means for streams to supply data to the parser. Data is expected to be passed in sequentially from the beginning of the file, without gaps. In the course of parsing, the client's property and/or packets callbacks may be called. At the end of the stream, this function must be called once with null data pointer and zero data byte size to flush any remaining packets out of the parser.
        Parameters:
        inAudioFileStream - The file stream ID
        inDataByteSize - The number of bytes passed in for parsing. Must be zero when flushing the parser.
        inData - The data passed in to be parsed. Must be null when flushing the parser.
        inFlags - If there is a data discontinuity, then kAudioFileStreamParseFlag_Discontinuity should be set true. API-Since: 2.0

      • AudioFileStreamSeek

        public static int AudioFileStreamSeek​(@NotNull
                                      @NotNull AudioFileStreamID inAudioFileStream,
                                      long inPacketOffset,
                                      @NotNull
                                      @NotNull org.moe.natj.general.ptr.LongPtr outDataByteOffset,
                                      @NotNull
                                      @NotNull org.moe.natj.general.ptr.IntPtr ioFlags)
        [@function] AudioFileStreamSeek This call is used to seek in the data stream. The client passes in a packet offset to seek to and the parser passes back a byte offset from which to get the data to satisfy that request. The data passed to the next call to AudioFileParseBytes will be assumed to be from that byte offset. For file formats which do not contain packet tables the byte offset may be an estimate. If so, the flag kAudioFileStreamSeekFlag_OffsetIsEstimated will be true.
        Parameters:
        inAudioFileStream - The file stream ID
        inPacketOffset - The offset from the beginning of the file of the packet to which to seek.
        outDataByteOffset - The byte offset of the data from the file's data offset returned. You need to add the value of kAudioFileStreamProperty_DataOffset to get an absolute byte offset in the file.
        ioFlags - If outDataByteOffset is an estimate, then kAudioFileStreamSeekFlag_OffsetIsEstimated will be set on output. There are currently no flags defined for passing into this call. API-Since: 2.0

      • AudioFileStreamGetPropertyInfo

        public static int AudioFileStreamGetPropertyInfo​(@NotNull
                                                 @NotNull AudioFileStreamID inAudioFileStream,
                                                 int inPropertyID,
                                                 @Nullable
                                                 @Nullable org.moe.natj.general.ptr.IntPtr outPropertyDataSize,
                                                 @Nullable
                                                 @Nullable org.moe.natj.general.ptr.BytePtr outWritable)
        [@function] AudioFileStreamGetPropertyInfo Retrieve the info about the given property. The outSize argument will return the size in bytes of the current value of the property.
        Parameters:
        inAudioFileStream - The file stream ID
        inPropertyID - Property ID whose value should be read
        outPropertyDataSize - Size in bytes of the property
        outWritable - whether the property is writable
        Returns:
        an OSStatus return code API-Since: 2.0

      • AudioFileStreamGetProperty

        public static int AudioFileStreamGetProperty​(@NotNull
                                             @NotNull AudioFileStreamID inAudioFileStream,
                                             int inPropertyID,
                                             @NotNull
                                             @NotNull org.moe.natj.general.ptr.IntPtr ioPropertyDataSize,
                                             @NotNull
                                             @NotNull org.moe.natj.general.ptr.VoidPtr outPropertyData)
        [@function] AudioFileStreamGetProperty Retrieve the indicated property data.
        Parameters:
        inAudioFileStream - The file stream ID
        inPropertyID - Property ID whose value should be read
        ioPropertyDataSize - On input, the size of the buffer pointed to by outPropertyData. On output, the number of bytes written.
        outPropertyData - Pointer to the property data buffer
        Returns:
        an OSStatus return code API-Since: 2.0

      • AudioFileStreamSetProperty

        public static int AudioFileStreamSetProperty​(@NotNull
                                             @NotNull AudioFileStreamID inAudioFileStream,
                                             int inPropertyID,
                                             int inPropertyDataSize,
                                             @NotNull
                                             @NotNull org.moe.natj.general.ptr.ConstVoidPtr inPropertyData)
        [@function] AudioFileStreamSetProperty Set the value of the property. There are currently no settable properties.
        Parameters:
        inAudioFileStream - The file stream ID
        inPropertyID - Property ID whose value should be set
        inPropertyDataSize - Size in bytes of the property data
        inPropertyData - Pointer to the property data buffer
        Returns:
        an OSStatus return code API-Since: 2.0

      • AudioFileStreamClose

        public static int AudioFileStreamClose​(@NotNull
                                       @NotNull AudioFileStreamID inAudioFileStream)
        [@function] AudioFileStreamClose Close and deallocate the file stream object.
        Parameters:
        inAudioFileStream - The file stream ID API-Since: 2.0

      • AudioFormatGetPropertyInfo

        public static int AudioFormatGetPropertyInfo​(int inPropertyID,
                                             int inSpecifierSize,
                                             @Nullable
                                             @Nullable org.moe.natj.general.ptr.ConstVoidPtr inSpecifier,
                                             @NotNull
                                             @NotNull org.moe.natj.general.ptr.IntPtr outPropertyDataSize)
        [@function] AudioFormatGetPropertyInfo Retrieve information about the given property
        Parameters:
        inPropertyID - an AudioFormatPropertyID constant.
        inSpecifierSize - The size of the specifier data.
        inSpecifier - A specifier is a buffer of data used as an input argument to some of the properties.
        outPropertyDataSize - The size in bytes of the current value of the property. In order to get the property value, you will need a buffer of this size.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioFormatGetProperty

        public static int AudioFormatGetProperty​(int inPropertyID,
                                         int inSpecifierSize,
                                         @Nullable
                                         @Nullable org.moe.natj.general.ptr.ConstVoidPtr inSpecifier,
                                         @Nullable
                                         @Nullable org.moe.natj.general.ptr.IntPtr ioPropertyDataSize,
                                         @Nullable
                                         @Nullable org.moe.natj.general.ptr.VoidPtr outPropertyData)
        [@function] AudioFormatGetProperty Retrieve the indicated property data
        Parameters:
        inPropertyID - an AudioFormatPropertyID constant.
        inSpecifierSize - The size of the specifier data.
        inSpecifier - A specifier is a buffer of data used as an input argument to some of the properties.
        ioPropertyDataSize - on input the size of the outPropertyData buffer. On output the number of bytes written to the buffer.
        outPropertyData - the buffer in which to write the property data. If outPropertyData is NULL and ioPropertyDataSize is not, the amount that would have been written will be reported.
        Returns:
        returns noErr if successful. API-Since: 2.0

      • AudioQueueNewOutput

        public static int AudioQueueNewOutput​(@NotNull
                                      @NotNull AudioStreamBasicDescription inFormat,
                                      @NotNull
                                      @NotNull AudioToolbox.Function_AudioQueueNewOutput inCallbackProc,
                                      @Nullable
                                      @Nullable org.moe.natj.general.ptr.VoidPtr inUserData,
                                      @Nullable
                                      @Nullable CFRunLoopRef inCallbackRunLoop,
                                      @Nullable
                                      @Nullable CFStringRef inCallbackRunLoopMode,
                                      int inFlags,
                                      @NotNull
                                      @NotNull org.moe.natj.general.ptr.Ptr<AudioQueueRef> outAQ)
        [@function] AudioQueueNewOutput Creates a new audio queue for playing audio data. To create an playback audio queue, you allocate buffers, then queue buffers (using AudioQueueEnqueueBuffer). The callback receives buffers and typically queues them again. To schedule a buffer for playback, providing parameter and start time information, call AudioQueueEnqueueBufferWithParameters.
        Parameters:
        inFormat - A pointer to a structure describing the format of the audio data to be played. For linear PCM, only interleaved formats are supported. Compressed formats are supported.
        inCallbackProc - A pointer to a callback function to be called when the audio queue has finished playing a buffer.
        inUserData - A value or pointer to data that you specify to be passed to the callback function.
        inCallbackRunLoop - The event loop on which inCallbackProc is to be called. If you specify NULL, the callback is called on one of the audio queue's internal threads.
        inCallbackRunLoopMode - The run loop mode in which to call the callback. Typically, you pass kCFRunLoopCommonModes. (NULL also specifies kCFRunLoopCommonModes). Other possibilities are implementation specific. You can choose to create your own thread with your own run loops. For more information on run loops, see Run Loops or CFRunLoop Reference.
        inFlags - Reserved for future use. Pass 0.
        outAQ - On return, this variable contains a pointer to the newly created playback audio queue object.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueNewInput

        public static int AudioQueueNewInput​(@NotNull
                                     @NotNull AudioStreamBasicDescription inFormat,
                                     @NotNull
                                     @NotNull AudioToolbox.Function_AudioQueueNewInput inCallbackProc,
                                     @Nullable
                                     @Nullable org.moe.natj.general.ptr.VoidPtr inUserData,
                                     @Nullable
                                     @Nullable CFRunLoopRef inCallbackRunLoop,
                                     @Nullable
                                     @Nullable CFStringRef inCallbackRunLoopMode,
                                     int inFlags,
                                     @NotNull
                                     @NotNull org.moe.natj.general.ptr.Ptr<AudioQueueRef> outAQ)
        [@function] AudioQueueNewInput Creates a new audio queue for recording audio data. Outline of how to use the queue for input: - create input queue - allocate buffers - enqueue buffers (AudioQueueEnqueueBuffer, not with parameters, no packet descriptions) - the callback receives buffers and re-enqueues them
        Parameters:
        inFormat - A pointer to a structure describing the format of the audio data to be recorded. For linear PCM, only interleaved formats are supported. Compressed formats are supported.
        inCallbackProc - A pointer to a callback function to be called when the audio queue has finished filling a buffer.
        inUserData - A value or pointer to data that you specify to be passed to the callback function.
        inCallbackRunLoop - The event loop on which inCallbackProc is to be called. If you specify NULL, the callback is called on one of the audio queue's internal threads.
        inCallbackRunLoopMode - The run loop mode in which to call the callback. Typically, you pass kCFRunLoopCommonModes. (NULL also specifies kCFRunLoopCommonModes). Other possibilities are implementation specific. You can choose to create your own thread with your own run loops. For more information on run loops, see Run Loops or CFRunLoop Reference.
        inFlags - Reserved for future use. Pass 0.
        outAQ - On return, this variable contains a pointer to the newly created recording audio queue object.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueNewOutputWithDispatchQueue

        public static int AudioQueueNewOutputWithDispatchQueue​(@NotNull
                                                       @NotNull org.moe.natj.general.ptr.Ptr<AudioQueueRef> outAQ,
                                                       @NotNull
                                                       @NotNull AudioStreamBasicDescription inFormat,
                                                       int inFlags,
                                                       @NotNull
                                                       @NotNull dispatch_queue_t inCallbackDispatchQueue,
                                                       @NotNull
                                                       @NotNull AudioToolbox.Block_AudioQueueNewOutputWithDispatchQueue inCallbackBlock)
        [@function] AudioQueueNewOutputWithDispatchQueue Creates a new audio queue for playing audio data. To create an playback audio queue, you allocate buffers, then queue buffers (using AudioQueueEnqueueBuffer). The callback receives buffers and typically queues them again. To schedule a buffer for playback, providing parameter and start time information, call AudioQueueEnqueueBufferWithParameters.
        Parameters:
        outAQ - On return, this variable contains a pointer to the newly created playback audio queue object.
        inFormat - A pointer to a structure describing the format of the audio data to be played. For linear PCM, only interleaved formats are supported. Compressed formats are supported.
        inFlags - Reserved for future use. Pass 0.
        inCallbackDispatchQueue - The dispatch queue from which inCallbackBlock is to be called.
        inCallbackBlock - A pointer to a callback block to be called when the audio queue has finished playing a buffer.
        Returns:
        An OSStatus result code. API-Since: 10.0

      • AudioQueueNewInputWithDispatchQueue

        public static int AudioQueueNewInputWithDispatchQueue​(@NotNull
                                                      @NotNull org.moe.natj.general.ptr.Ptr<AudioQueueRef> outAQ,
                                                      @NotNull
                                                      @NotNull AudioStreamBasicDescription inFormat,
                                                      int inFlags,
                                                      @NotNull
                                                      @NotNull dispatch_queue_t inCallbackDispatchQueue,
                                                      @NotNull
                                                      @NotNull AudioToolbox.Block_AudioQueueNewInputWithDispatchQueue inCallbackBlock)
        [@function] AudioQueueNewInputWithDispatchQueue Creates a new audio queue for recording audio data. Outline of how to use the queue for input: - create input queue - allocate buffers - enqueue buffers (AudioQueueEnqueueBuffer, not with parameters, no packet descriptions) - the callback receives buffers and re-enqueues them
        Parameters:
        outAQ - On return, this variable contains a pointer to the newly created recording audio queue object.
        inFormat - A pointer to a structure describing the format of the audio data to be recorded. For linear PCM, only interleaved formats are supported. Compressed formats are supported.
        inFlags - Reserved for future use. Pass 0.
        inCallbackDispatchQueue - The dispatch queue from which inCallbackBlock is to be called.
        inCallbackBlock - A pointer to a callback block to be called when the audio queue has finished filling a buffer.
        Returns:
        An OSStatus result code. API-Since: 10.0

      • AudioQueueDispose

        public static int AudioQueueDispose​(@NotNull
                                    @NotNull AudioQueueRef inAQ,
                                    byte inImmediate)
        [@function] AudioQueueDispose Disposes an existing audio queue. Disposing of the audio queue also disposes of all its resources, including its buffers.
        Parameters:
        inAQ - The audio queue you want to dispose of
        inImmediate - If you pass true, the audio queue is disposed of immediately (that is, synchronously). If you pass false, disposal does not take place until all enqueued buffers are processed. Whether you call AudioQueueDispose synchronously or asynchronously, you can no longer interact with the queue, and the queue no longer invokes any callbacks to your application after the function returns. Note that if AudioQueueDispose is called from a buffer completion callback or property listener, you may receive further callbacks afterwards.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueAllocateBuffer

        public static int AudioQueueAllocateBuffer​(@NotNull
                                           @NotNull AudioQueueRef inAQ,
                                           int inBufferByteSize,
                                           @NotNull
                                           @NotNull org.moe.natj.general.ptr.Ptr<org.moe.natj.general.ptr.Ptr<AudioQueueBuffer>> outBuffer)
        [@function] AudioQueueAllocateBuffer Asks an audio queue to allocate a buffer. Once allocated, the pointer to the buffer and the buffer's size are fixed and cannot be changed. The mAudioDataByteSize field in the audio queue buffer structure, AudioQueueBuffer, is initially set to 0.
        Parameters:
        inAQ - The audio queue you want to allocate a buffer.
        inBufferByteSize - The desired size of the new buffer, in bytes. An appropriate buffer size depends on the processing you will perform on the data as well as on the audio data format.
        outBuffer - On return, points to the newly created audio buffer. The mAudioDataByteSize field in the audio queue buffer structure, AudioQueueBuffer, is initially set to 0.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueAllocateBufferWithPacketDescriptions

        public static int AudioQueueAllocateBufferWithPacketDescriptions​(@NotNull
                                                                 @NotNull AudioQueueRef inAQ,
                                                                 int inBufferByteSize,
                                                                 int inNumberPacketDescriptions,
                                                                 @NotNull
                                                                 @NotNull org.moe.natj.general.ptr.Ptr<org.moe.natj.general.ptr.Ptr<AudioQueueBuffer>> outBuffer)
        [@function] AudioQueueAllocateBufferWithPacketDescriptions Asks an audio queue to allocate a buffer with space for packet descriptions. Once allocated, the pointer to the buffer and the buffer's size are fixed and cannot be changed. The mAudioDataByteSize field in the audio queue buffer structure, AudioQueueBuffer, is initially set to 0.
        Parameters:
        inAQ - The audio queue you want to allocate a buffer.
        inBufferByteSize - The desired size of the new buffer, in bytes. An appropriate buffer size depends on the processing you will perform on the data as well as on the audio data format.
        inNumberPacketDescriptions - The desired capacity of the packet description array in the new buffer.
        outBuffer - On return, points to the newly created audio buffer. The mAudioDataByteSize field in the audio queue buffer structure, AudioQueueBuffer, is initially set to 0.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueFreeBuffer

        public static int AudioQueueFreeBuffer​(@NotNull
                                       @NotNull AudioQueueRef inAQ,
                                       @NotNull
                                       @NotNull AudioQueueBuffer inBuffer)
        [@function] AudioQueueFreeBuffer Disposes of an audio queue buffer. This function disposes of the buffer allocated by AudioQueueAllocateBuffer. Disposing of an audio queue also automatically disposes of any associated buffers and timeline objects. Call this function only if you want to dispose of a particular buffer while continuing to use an audio queue. You can dispose of buffers only when the associated queue is stopped (that is, not processing audio data).
        Parameters:
        inAQ - The queue from which the buffer was allocated.
        inBuffer - The buffer to be disposed.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueEnqueueBuffer

        public static int AudioQueueEnqueueBuffer​(@NotNull
                                          @NotNull AudioQueueRef inAQ,
                                          @NotNull
                                          @NotNull AudioQueueBuffer inBuffer,
                                          int inNumPacketDescs,
                                          @Nullable
                                          @Nullable AudioStreamPacketDescription inPacketDescs)
        [@function] AudioQueueEnqueueBuffer Assigns a buffer to an audio queue for recording or playback. If the buffer was allocated with AudioQueueAllocateBufferWithPacketDescriptions, the client should provide packet descriptions in the buffer's mPacketDescriptions and mPacketDescriptionCount fields rather than in inPacketDescs and inNumPacketDescs, which should be NULL and 0, respectively, in this case. For an input queue, pass 0 and NULL for inNumPacketDescs and inPacketDescs, respectively. Your callback will receive packet descriptions owned by the audio queue.
        Parameters:
        inAQ - The audio queue you are assigning the buffer to.
        inBuffer - The buffer to queue (that is, to be recorded into or played from).
        inNumPacketDescs - The number of packet descriptions pointed to by the inPacketDescs pointer. Applicable only for output queues and required only for variable-bit-rate (VBR) audio formats. Pass 0 for input queues (no packet descriptions are required).
        inPacketDescs - An array of packet descriptions. Applicable only for output queues and required only for variable-bit-rate (VBR) audio formats. Pass NULL for input queues (no packet descriptions are required).
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueEnqueueBufferWithParameters

        public static int AudioQueueEnqueueBufferWithParameters​(@NotNull
                                                        @NotNull AudioQueueRef inAQ,
                                                        @NotNull
                                                        @NotNull AudioQueueBuffer inBuffer,
                                                        int inNumPacketDescs,
                                                        @Nullable
                                                        @Nullable AudioStreamPacketDescription inPacketDescs,
                                                        int inTrimFramesAtStart,
                                                        int inTrimFramesAtEnd,
                                                        int inNumParamValues,
                                                        @Nullable
                                                        @Nullable AudioQueueParameterEvent inParamValues,
                                                        @Nullable
                                                        @Nullable AudioTimeStamp inStartTime,
                                                        @Nullable
                                                        @Nullable AudioTimeStamp outActualStartTime)
        [@function] AudioQueueEnqueueBufferWithParameters Assigns a buffer to an audio queue for playback, providing parameters and start time information. You can exert some control of the buffer queue by using this function. You can assign audio queue settings that are in effect carried by an audio queue buffer as you enqueue it. Hence, these changes only take effect when an audio queue buffer begins playing. This function queues a buffer for playback only, not for recording. Audio queues for recording have no parameters, do not support variable-bit-rate (VBR) formats (which might require trimming), and have a different way to handle timing. When queued for playback, the buffer must contain the audio data to be played back. See AudioQueueEnqueueBuffer for details on queuing a buffer for recording. If the buffer was allocated with AudioQueueAllocateBufferWithPacketDescriptions, the client should provide packet descriptions in the buffer's mPacketDescriptions and mPacketDescriptionCount fields rather than in inPacketDescs and inNumPacketDescs, which should be NULL and 0, respectively, in this case.
        Parameters:
        inAQ - The audio queue associated with the buffer.
        inBuffer - The buffer to be played from.
        inNumPacketDescs - The number of packet descriptions pointed to by the inPacketDescs parameter. Required only for variable-bit-rate (VBR) audio formats. Pass 0 if no packet descriptions are required.
        inPacketDescs - A pointer to an array of audio stream packet descriptions. Required only for VBR audio formats. Pass NULL if no packet descriptions are required.
        inTrimFramesAtStart - The number of priming frames to skip at the start of the buffer.
        inTrimFramesAtEnd - The number of frames to skip at the end of the buffer.
        inNumParamValues - The number of parameter values pointed to by the inParamValues parameter.
        inParamValues - An array of parameter values. (In macOS v10.5, there is only one parameter, kAudioQueueParam_Volume.) These values are set before buffer playback and cannot be changed while the buffer is playing. How accurately changes in parameters can be scheduled depends on the size of the buffer. If there are no parameters to set (inNumParamValues = 0), pass NULL.
        inStartTime - A pointer to a structure containing the desired start time for playing the buffer. If you specify the time using the mSampleTime field of the AudioTimeStamp structure, the sample time is relative to the time the queue started. If you pass NULL for the start time, the buffer starts immediately after the previously queued buffer, or as soon as possible if no buffers are queued ahead of it. Buffers are played in the order they are queued. If multiple buffers are queued, their times must be in ascending order or NULL; otherwise, an error occurs. The start time indicates when the actual audio data in the buffer is to be played (that is, the trim frames are not counted). Note: When specifying a start time for a buffer, if the buffer is not the first enqueued since AudioQueueStop or AudioQueueReset, it is normally necessary to call AudioQueueFlush before AudioQueueEnqueueBufferWithParameters.
        outActualStartTime - On return, points to an AudioTimeStamp structure indicating when the buffer will actually play.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueStart

        public static int AudioQueueStart​(@NotNull
                                  @NotNull AudioQueueRef inAQ,
                                  @Nullable
                                  @Nullable AudioTimeStamp inStartTime)
        [@function] AudioQueueStart Begins playing or recording audio. If the audio hardware is not already running, this function starts it.
        Parameters:
        inAQ - The audio queue to start.
        inStartTime - A pointer to the time at which the audio queue should start. If you specify the time using the mSampleTime field of the AudioTimeStamp structure, the sample time is referenced to the sample frame timeline of the associated audio device. May be NULL.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueuePrime

        public static int AudioQueuePrime​(@NotNull
                                  @NotNull AudioQueueRef inAQ,
                                  int inNumberOfFramesToPrepare,
                                  @Nullable
                                  @Nullable org.moe.natj.general.ptr.IntPtr outNumberOfFramesPrepared)
        [@function] AudioQueuePrime Begins decoding buffers in preparation for playback. This function begins decoding buffers in preparation for playback. It returns when at least the number of audio sample frames are decoded and ready to play or when all enqueued buffers have been completely decoded. To ensure that a buffer has been decoded and is completely ready for playback, before playback: 1. Call AudioQueueEnqueueBuffer. 2. Call AudioQueuePrime, which waits if you pass 0 to have a default number of frames decoded. 3. Call AudioQueueStart. Calls to AudioQueuePrime following AudioQueueStart/AudioQueuePrime, and before AudioQueueReset/AudioQueueStop, will have no useful effect. In this situation, outNumberOfFramesPrepared will not have a useful return value.
        Parameters:
        inAQ - The audio queue to be primed.
        inNumberOfFramesToPrepare - The number of frames to decode before returning. Pass 0 to decode all enqueued buffers.
        outNumberOfFramesPrepared - If not NULL, on return, a pointer to the number of frames actually decoded and prepared for playback.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueStop

        public static int AudioQueueStop​(@NotNull
                                 @NotNull AudioQueueRef inAQ,
                                 byte inImmediate)
        [@function] AudioQueueStop Stops playing or recording audio. This function resets the audio queue and stops the audio hardware associated with the queue if it is not in use by other audio services. Synchronous stops occur immediately, regardless of previously buffered audio data. Asynchronous stops occur after all queued buffers have been played or recorded.
        Parameters:
        inAQ - The audio queue to stop.
        inImmediate - If you pass true, the stop request occurs immediately (that is, synchronously), and the function returns when the audio queue has stopped. Buffer callbacks are invoked during the stopping. If you pass false, the function returns immediately, but the queue does not stop until all its queued buffers are played or filled (that is, the stop occurs asynchronously). Buffer callbacks are invoked as necessary until the queue actually stops. Also, a playback audio queue callback calls this function when there is no more audio to play. Note that when stopping immediately, all pending buffer callbacks are normally invoked during the process of stopping. But if the calling thread is responding to a buffer callback, then it is possible for additional buffer callbacks to occur after AudioQueueStop returns.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueuePause

        public static int AudioQueuePause​(@NotNull
                                  @NotNull AudioQueueRef inAQ)
        [@function] AudioQueuePause Pauses audio playback or recording. Pausing the queue does not affect buffers or reset the audio queue. To resume playback or recording using the audio queue, call AudioQueueStart.
        Parameters:
        inAQ - The queue to be paused.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueFlush

        public static int AudioQueueFlush​(@NotNull
                                  @NotNull AudioQueueRef inAQ)
        [@function] AudioQueueFlush Resets the audio queue's decoder state. After all queued buffers have been played, the function cleans up all decoder state information. You must call this function following a sequence of buffers of encoded audio; otherwise, some of the audio might not play in the next set of queued buffers. The only time it is not necessary to call AudioQueueFlush is following AudioQueueStop with inImmediate=false. (This action internally calls AudioQueueFlush.) Also, you might wish to call this function before calling AudioQueueStop depending on whether you want to stop immediately regardless of what has played or whether you want to ensure that all buffered data and all data that is in the middle of processing gets recorded or played before stopping.
        Parameters:
        inAQ - The audio queue to be flushed.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueReset

        public static int AudioQueueReset​(@NotNull
                                  @NotNull AudioQueueRef inAQ)
        [@function] AudioQueueReset Resets an audio queue. This function immediately resets an audio queue, flushes any queued buffer, removes all buffers from previously scheduled use, and resets any decoder and digital signal processing (DSP) state information. It also invokes callbacks for any flushed buffers. If you queue any buffers after calling this function, processing does not occur until the decoder and DSP state information is reset. Hence, a discontinuity (that is, a "glitch") might occur. Note that when resetting, all pending buffer callbacks are normally invoked during the process of resetting. But if the calling thread is responding to a buffer callback, then it is possible for additional buffer callbacks to occur after AudioQueueReset returns.
        Parameters:
        inAQ - The audio queue to reset.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueGetParameter

        public static int AudioQueueGetParameter​(@NotNull
                                         @NotNull AudioQueueRef inAQ,
                                         int inParamID,
                                         @NotNull
                                         @NotNull org.moe.natj.general.ptr.FloatPtr outValue)
        [@function] AudioQueueGetParameter Obtains an audio queue parameter value. You can access the current parameter values for an audio queue at any time with this function.
        Parameters:
        inAQ - The audio queue whose parameter value you want to obtain.
        inParamID - The ID of the parameter you want to obtain. In macOS v10.5, audio queues have one parameter available: kAudioQueueParam_Volume, which controls the queue's playback volume.
        outValue - On return, points to the current value of the specified parameter.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueSetParameter

        public static int AudioQueueSetParameter​(@NotNull
                                         @NotNull AudioQueueRef inAQ,
                                         int inParamID,
                                         float inValue)
        [@function] AudioQueueSetParameter Sets an audio queue parameter value.
        Parameters:
        inAQ - The audio queue whose parameter value you want to set.
        inParamID - The ID of the parameter you want to set.
        inValue - The parameter value to set.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueGetProperty

        public static int AudioQueueGetProperty​(@NotNull
                                        @NotNull AudioQueueRef inAQ,
                                        int inID,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.VoidPtr outData,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.IntPtr ioDataSize)
        [@function] AudioQueueGetProperty Obtains an audio queue property value.
        Parameters:
        inAQ - The audio queue whose property value you want to obtain.
        inID - The ID of the property you want to obtain. See "Audio Queue Property IDs."
        outData - On return, points to the desired property value.
        ioDataSize - A pointer to the size of the property data. On input, points to the maximum bytes of space the caller expects to receive. On return, points to the actual data size.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueSetProperty

        public static int AudioQueueSetProperty​(@NotNull
                                        @NotNull AudioQueueRef inAQ,
                                        int inID,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.ConstVoidPtr inData,
                                        int inDataSize)
        [@function] AudioQueueSetProperty Sets an audio queue property value.
        Parameters:
        inAQ - The audio queue whose property value you want to set.
        inID - The ID of the property you want to set. See "Audio Queue Property IDs" for the various audio queue properties.
        inData - A pointer to the property value to set.
        inDataSize - The size of the property data.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueGetPropertySize

        public static int AudioQueueGetPropertySize​(@NotNull
                                            @NotNull AudioQueueRef inAQ,
                                            int inID,
                                            @NotNull
                                            @NotNull org.moe.natj.general.ptr.IntPtr outDataSize)
        [@function] AudioQueueGetPropertySize Obtains the size of an audio queue property.
        Parameters:
        inAQ - The audio queue containing the property value whose size you want to obtain.
        inID - The ID of the property value whose size you want to obtain. See "Audio Queue Property IDs" for possible values.
        outDataSize - On return, points to the size of the specified property value.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueAddPropertyListener

        public static int AudioQueueAddPropertyListener​(@NotNull
                                                @NotNull AudioQueueRef inAQ,
                                                int inID,
                                                @NotNull
                                                @NotNull AudioToolbox.Function_AudioQueueAddPropertyListener inProc,
                                                @Nullable
                                                @Nullable org.moe.natj.general.ptr.VoidPtr inUserData)
        [@function] AudioQueueAddPropertyListener Adds a listener callback for a property. This callback is used to act upon a change in an audio queue property such as kAudioQueueProperty_IsRunning. For instance, if your application has a user interface with a Play/Stop button, and kAudioQueueProperty_IsRunning changes, you need to update your button.
        Parameters:
        inAQ - The audio queue that owns the property you want to assign the listener callback to.
        inID - The ID of the property to which you want to assign a listener callback. See "Audio Queue Property IDs".
        inProc - The listener callback to be called when the property value changes.
        inUserData - A value to be passed to the listener callback when it is called.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueRemovePropertyListener

        public static int AudioQueueRemovePropertyListener​(@NotNull
                                                   @NotNull AudioQueueRef inAQ,
                                                   int inID,
                                                   @NotNull
                                                   @NotNull AudioToolbox.Function_AudioQueueRemovePropertyListener inProc,
                                                   @Nullable
                                                   @Nullable org.moe.natj.general.ptr.VoidPtr inUserData)
        [@function] AudioQueueRemovePropertyListener Removes a listener callback for a property.
        Parameters:
        inAQ - The audio queue that owns the property from which you want to remove a listener.
        inID - The ID of the property from which you want to remove a listener.
        inProc - The listener being removed.
        inUserData - The same inUserData value that was previously passed to AudioQueueAddPropertyListener.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueCreateTimeline

        public static int AudioQueueCreateTimeline​(@NotNull
                                           @NotNull AudioQueueRef inAQ,
                                           @NotNull
                                           @NotNull org.moe.natj.general.ptr.Ptr<AudioQueueTimelineRef> outTimeline)
        [@function] AudioQueueCreateTimeline Creates a timeline object. You need to instantiate a timeline object if you want to know about any timeline discontinuities. See AudioQueueGetCurrentTime for more details.
        Parameters:
        inAQ - The audio queue to associate with the new timeline object.
        outTimeline - On return, points to the newly created timeline object.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueDisposeTimeline

        public static int AudioQueueDisposeTimeline​(@NotNull
                                            @NotNull AudioQueueRef inAQ,
                                            @NotNull
                                            @NotNull AudioQueueTimelineRef inTimeline)
        [@function] AudioQueueDisposeTimeline Disposes of a timeline object. Disposing of an audio queue automatically disposes of any associated timeline objects. Call this function only if you want to dispose of a timeline object and not the audio queue associated with it.
        Parameters:
        inAQ - The audio queue associated with the timeline object you want to dispose of.
        inTimeline - The timeline object to dispose of.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueGetCurrentTime

        public static int AudioQueueGetCurrentTime​(@NotNull
                                           @NotNull AudioQueueRef inAQ,
                                           @Nullable
                                           @Nullable AudioQueueTimelineRef inTimeline,
                                           @Nullable
                                           @Nullable AudioTimeStamp outTimeStamp,
                                           @Nullable
                                           @Nullable org.moe.natj.general.ptr.BytePtr outTimelineDiscontinuity)
        [@function] AudioQueueGetCurrentTime Obtains the current audio queue time. You must specify a timeline object if you want to be notified about any timeline discontinuities in the outTimelineDiscontinuity parameter. If you don't care about discontinuities, pass NULL in the inTimeLine and outTimelineDiscontinuity parameters.
        Parameters:
        inAQ - The audio queue whose current time you want to obtain.
        inTimeline - The audio queue timeline object to which any timeline discontinuities are reported. May be NULL.
        outTimeStamp - On return, points to an audio timestamp structure containing the current audio queue time. The mSampleTime field is in terms of the audio queue's sample rate, and relative to the time at which the queue has started or will start.
        outTimelineDiscontinuity - Can be NULL. On return, only set to true or false if the inTimeLine parameter is not NULL. Set to true if a discontinuity has occurred in the sample timeline of the audio queue. For instance, the device's sample rate changed and a gap occurred in playback or recording, or the audio queue was unable to prepare and playback in time because it was late.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueDeviceGetCurrentTime

        public static int AudioQueueDeviceGetCurrentTime​(@NotNull
                                                 @NotNull AudioQueueRef inAQ,
                                                 @NotNull
                                                 @NotNull AudioTimeStamp outTimeStamp)
        [@function] AudioQueueDeviceGetCurrentTime Obtains the current time of the audio device associated with an audio queue. If the audio device associated with the audio queue is not running, the only valid field in the audio timestamp structure is mHostTime. This result differentiates the action of this function from that of the AudioDeviceGetCurrentTime function, (declared in AudioHardware.h) which returns an error if the audio device is not running.
        Parameters:
        inAQ - The audio queue whose audio device is to be queried.
        outTimeStamp - A pointer to a structure that, on return, contains the current time of the audio device associated with the audio queue.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueDeviceTranslateTime

        public static int AudioQueueDeviceTranslateTime​(@NotNull
                                                @NotNull AudioQueueRef inAQ,
                                                @NotNull
                                                @NotNull AudioTimeStamp inTime,
                                                @NotNull
                                                @NotNull AudioTimeStamp outTime)
        [@function] AudioQueueDeviceTranslateTime Converts the time in the time base of the associated audio device from one representation to another. This function converts from one time representation to another (for example, from sample time to host time or vice versa): - Sample time is the absolute sample frame time. Sample numbers are the count of the samples on the audio device. - Host time is the time base of the host machine such as the time of the bus clock on the CPU. The mSampleTime field in the AudioTimestamp structure (described in Core Audio Data Types Reference) is always in device time, not in audio queue time. Audio queue time is relative to the audio queue's start time. The associated audio device has to be running for the AudioQueueDeviceTranslateTime function to provide a result.
        Parameters:
        inAQ - The queue whose audio device is to perform the requested time translation.
        inTime - A pointer to a structure containing the time to be translated.
        outTime - On entry, mFlags indicate the desired translations. On exit, mFlags indicates which of the requested translated fields were successfully populated.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueDeviceGetNearestStartTime

        public static int AudioQueueDeviceGetNearestStartTime​(@NotNull
                                                      @NotNull AudioQueueRef inAQ,
                                                      @NotNull
                                                      @NotNull AudioTimeStamp ioRequestedStartTime,
                                                      int inFlags)
        [@function] AudioQueueDeviceGetNearestStartTime Obtains an audio device's start time that is closest to a requested start time.
        Parameters:
        inAQ - The audio queue whose device's nearest start time you want to obtain.
        ioRequestedStartTime - On entry, points to the requested start time. On return, points to the actual start time.
        inFlags - Reserved for future use. Pass 0.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueSetOfflineRenderFormat

        public static int AudioQueueSetOfflineRenderFormat​(@NotNull
                                                   @NotNull AudioQueueRef inAQ,
                                                   @Nullable
                                                   @Nullable AudioStreamBasicDescription inFormat,
                                                   @Nullable
                                                   @Nullable AudioChannelLayout inLayout)
        [@function] AudioQueueSetOfflineRenderFormat Specify an audio format to which the queue will perform subsequent offline rendering, or disable offline rendering. An output queue's audio playback can be redirected for capture to an audio file, to support an export function, for example. AudioQueueSetOfflineRenderFormat switches a queue between normal and offline rendering modes.
        Parameters:
        inAQ - The output queue whose offline rendering mode is to be changed.
        inFormat - The desired format for offline rendering. Pass NULL to disable offline rendering and return the queue to normal output to an audio device. This format must be linear PCM and (if not mono) interleaved.
        inLayout - The desired channel layout for offline rendering; also NULL when disabling offline rendering.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueOfflineRender

        public static int AudioQueueOfflineRender​(@NotNull
                                          @NotNull AudioQueueRef inAQ,
                                          @NotNull
                                          @NotNull AudioTimeStamp inTimestamp,
                                          @NotNull
                                          @NotNull AudioQueueBuffer ioBuffer,
                                          int inNumberFrames)
        [@function] AudioQueueOfflineRender Obtain a buffer of audio output from a queue in offline rendering mode.
        Parameters:
        inAQ - The output queue from which to obtain output.
        inTimestamp - The point in time corresponding to the beginning of the output buffer. Only mSampleTime is used. mFlags must include kAudioTimeStampSampleTimeValid.
        ioBuffer - The buffer into which the queue will render.
        inNumberFrames - The number of frames of audio to render. Note that fewer frames than requested may be returned. This can happen if insufficient data was enqueued.
        Returns:
        An OSStatus result code. API-Since: 2.0

      • AudioQueueProcessingTapNew

        public static int AudioQueueProcessingTapNew​(@NotNull
                                             @NotNull AudioQueueRef inAQ,
                                             @NotNull
                                             @NotNull AudioToolbox.Function_AudioQueueProcessingTapNew inCallback,
                                             @Nullable
                                             @Nullable org.moe.natj.general.ptr.VoidPtr inClientData,
                                             int inFlags,
                                             @NotNull
                                             @NotNull org.moe.natj.general.ptr.IntPtr outMaxFrames,
                                             @NotNull
                                             @NotNull AudioStreamBasicDescription outProcessingFormat,
                                             @NotNull
                                             @NotNull org.moe.natj.general.ptr.Ptr<AudioQueueProcessingTapRef> outAQTap)
        [@function] AudioQueueProcessingTapNew Create a new processing tap This function creates a processing tap on a given audio queue. A processing tap can only be established (or removed) on an audio queue that is stopped (paused is not sufficient). The processing tap will then be used to process either decoded data in the case of an output queue, or input data (before it is encoded) in the case of an input queue. The processing is performed on audio either before or after any effects or other processing (varispeed, etc) is applied by the audio queue, depending on inFlags.
        Parameters:
        inAQ - The audio queue from which to create the processing tap
        inCallback - A callback which the queue will call to process the audio
        inClientData - Client data provided to the callback
        inFlags - Flags that are used to control aspects of the processing tap. Valid flags are: - kAudioQueueProcessingTap_PreEffects: processing is done before any further effects are applied by the audio queue to the audio - kAudioQueueProcessingTap_PostEffects: processing is done after all processing is done, including that of other taps. - kAudioQueueProcessingTap_Siphon
        outMaxFrames - The maximum number of sample frames that can be requested of a processing tap at any one time. Typically this will be approximately 50 msec of audio (2048 samples @ 44.1kHz)
        outProcessingFormat - The format in which the client will receive the audio data to be processed. This will always be the same sample rate as the client format and usually the same number of channels as the client format of the audio queue. (NOTE: the number of channels may be different in some cases if the client format has some channel count restrictions, for instance the client provides 5.1 AAC, but the decoder can only produce stereo). The channel order, if the same as the client format, will be the same as the client channel order. If the channel count is changed, it will be to either 1 (mono) or 2 (stereo, in which case the first channel is left, the second right). If the data is not in a convenient format for the client to process in, then the client should convert the data to and from that format. This is the most efficient mechanism to use (as the audio queue can chose a format that is most efficient from its playback (or recording) requirement.
        outAQTap - The processing tap object.
        Returns:
        An OSStatus result code. API-Since: 6.0

      • AudioQueueProcessingTapDispose

        public static int AudioQueueProcessingTapDispose​(@NotNull
                                                 @NotNull AudioQueueProcessingTapRef inAQTap)
        [@function] AudioQueueProcessingTapDispose Dispose a processing tap object As with AudioQueueProcessingTapNew(), this call can only be made on an audio queue that is stopped (paused is not sufficient)
        Parameters:
        inAQTap - The processing tap to dispose.
        Returns:
        An OSStatus result code. API-Since: 6.0

      • AudioQueueProcessingTapGetSourceAudio

        public static int AudioQueueProcessingTapGetSourceAudio​(@NotNull
                                                        @NotNull AudioQueueProcessingTapRef inAQTap,
                                                        int inNumberFrames,
                                                        @NotNull
                                                        @NotNull AudioTimeStamp ioTimeStamp,
                                                        @NotNull
                                                        @NotNull org.moe.natj.general.ptr.IntPtr outFlags,
                                                        @NotNull
                                                        @NotNull org.moe.natj.general.ptr.IntPtr outNumberFrames,
                                                        @NotNull
                                                        @NotNull AudioBufferList ioData)
        [@function] AudioQueueProcessingTapGetSourceAudio Used by a processing tap to retrieve source audio. This function may only be called from the processing tap's callback.
        Parameters:
        inAQTap - the processing tap
        inNumberFrames - the number of frames the processing tap requires for its processing
        ioTimeStamp - On an input audio queue, the timestamp is returned from this function. On an output audio queue, the caller must provide a continuous timestamp.
        outFlags - flags to describe state about the input requested, e.g. discontinuity/complete
        outNumberFrames - the number of source frames that have been provided by the parent audio queue. This can be less than the number of requested frames specified in inNumberFrames
        ioData - the audio buffer list which will contain the source data. The audio queue owns the buffer pointers if NULL pointers were provided (recommended). In this case the source buffers are only valid for the duration of the processing tap callback. If the buffer pointers are non-NULL, then they must be big enough to hold inNumberFrames, and the audio queue will copy its source data into those buffers.
        Returns:
        An OSStatus result code. API-Since: 6.0

      • AudioQueueProcessingTapGetQueueTime

        public static int AudioQueueProcessingTapGetQueueTime​(@NotNull
                                                      @NotNull AudioQueueProcessingTapRef inAQTap,
                                                      @NotNull
                                                      @NotNull org.moe.natj.general.ptr.DoublePtr outQueueSampleTime,
                                                      @NotNull
                                                      @NotNull org.moe.natj.general.ptr.IntPtr outQueueFrameCount)
        [@function] AudioQueueProcessingTapGetQueueTime Used by a processing tap to retrieve the queue's current time. This function may only be called from the processing tap's callback, and only for audio output queues. It must be called after calling AudioQueueProcessingTapGetSourceAudio().
        Parameters:
        inAQTap - the processing tap
        outQueueSampleTime - the current sample time of the audio queue. This will appear to be stationary if the queue is paused.
        outQueueFrameCount - the number of sample frames of queue time corresponding to the current chunk of audio being processed by the tap. This will differ from the frame count passed to the tap if the queue's playback rate is currently other than 1.0, due to the use of time compression/expansion. The frame count can also be 0 if the queue is paused.
        Returns:
        An OSStatus result code. API-Since: 6.0

      • AudioSessionInitialize

        @Deprecated
public static int AudioSessionInitialize​(CFRunLoopRef inRunLoop,
                                         CFStringRef inRunLoopMode,
                                         AudioToolbox.Function_AudioSessionInitialize inInterruptionListener,
                                         org.moe.natj.general.ptr.VoidPtr inClientData)
        Deprecated.
        [@function] AudioSessionInitialize Initialize the AudioSession. This function has to be called once before calling any other AudioSession functions.
        Parameters:
        inRunLoop - A CFRunLoopRef indicating the desired run loop the interruption routine should be run on. Pass NULL to use the main run loop.
        inRunLoopMode - A CFStringRef indicating the run loop mode for the runloop where the completion routine will be executed. Pass NULL to use kCFRunLoopDefaultMode.
        inInterruptionListener - An AudioSessionInterruptionListener to be called when the AudioSession is interrupted.
        inClientData - The client user data to use when calling the interruption listener. API-Since: 2.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • AudioSessionSetActive

        @Deprecated
public static int AudioSessionSetActive​(byte active)
        Deprecated.
        [@function] AudioSessionSetActive Activate or deactivate the AudioSession. Call this function with active set to true to activate this AudioSession (interrupt the currently active AudioSession). Call this function with active set to false to deactivate this AudioSession (allow another interrupted AudioSession to resume). When active is true this call may fail if the currently active AudioSession has a higher priority.
        Parameters:
        active - A Boolean indicating if you want to make this AudioSession active or inactive. API-Since: 2.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • AudioSessionSetActiveWithFlags

        @Deprecated
public static int AudioSessionSetActiveWithFlags​(byte active,
                                                 int inFlags)
        Deprecated.
        [@function] AudioSessionSetActiveWithFlags Same functionality as AudioSessionSetActive, with an additional flags parameter for refining behavior. Call this function with active set to true to activate this AudioSession (interrupt the currently active AudioSession). Call this function with active set to false to deactivate this AudioSession (allow another interrupted AudioSession to resume). Pass in one or more flags to refine the behavior during activation or deactivation. When active is true this call may fail if the currently active AudioSession has a higher priority.
        Parameters:
        active - A Boolean indicating if you want to make this AudioSession active or inactive.
        inFlags - A bitmap containing one or more flags from the AudioSessionActivationFlags enum. API-Since: 4.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • AudioSessionGetProperty

        @Deprecated
public static int AudioSessionGetProperty​(int inID,
                                          org.moe.natj.general.ptr.IntPtr ioDataSize,
                                          org.moe.natj.general.ptr.VoidPtr outData)
        Deprecated.
        [@function] AudioSessionGetProperty Get the value of a property. This function can be called to get the value for a property of the AudioSession. Valid properties are listed in an enum above.
        Parameters:
        inID - The AudioSessionPropertyID for which we want to get the value.
        ioDataSize - The size of the data payload. On entry it should contain the size of the memory pointed to by outData. On exit it will contain the actual size of the data.
        outData - The data for the property will be copied here.
        Returns:
        kAudioSessionNoError if the operation was successful. If the property is a write-only property or only available by way of property listeners, kAudioSessionUnsupportedPropertyError will be returned. Other error codes listed under AudioSession Error Constants also apply to this function. API-Since: 2.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • AudioSessionSetProperty

        @Deprecated
public static int AudioSessionSetProperty​(int inID,
                                          int inDataSize,
                                          org.moe.natj.general.ptr.ConstVoidPtr inData)
        Deprecated.
        [@function] AudioSessionSetProperty Set the value of a property. This function can be called to set the value for a property of the AudioSession. Valid properties are listed in an enum above.
        Parameters:
        inID - The AudioSessionPropertyID for which we want to set the value.
        inDataSize - The size of the data payload.
        inData - The data for the property we want to set.
        Returns:
        kAudioSessionNoError if the operation was successful. If the property is a read-only property or an invalid property value is passed in, kAudioSessionUnsupportedPropertyError will be returned. Other error codes listed under AudioSession Error Constants also apply to this function. API-Since: 2.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • AudioSessionGetPropertySize

        @Deprecated
public static int AudioSessionGetPropertySize​(int inID,
                                              org.moe.natj.general.ptr.IntPtr outDataSize)
        Deprecated.
        [@function] AudioSessionGetPropertySize Get the size of the payload for a property. This function can be called to get the size for the payload of a property. Valid properties are listed in an enum above.
        Parameters:
        inID - The AudioSessionPropertyID for which we want to get the size of the payload.
        outDataSize - The size of the data payload will be copied here. API-Since: 2.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • AudioSessionAddPropertyListener

        @Deprecated
public static int AudioSessionAddPropertyListener​(int inID,
                                                  AudioToolbox.Function_AudioSessionAddPropertyListener inProc,
                                                  org.moe.natj.general.ptr.VoidPtr inClientData)
        Deprecated.
        [@function] AudioSessionAddPropertyListener Add a property listener. This function can be used to add a listener to be called when a property changes. If a listener and user data already exist for this property, they will be replaced. Valid properties are listed above.
        Parameters:
        inID - The AudioSessionPropertyID for which we want to set a listener.
        inProc - The listener to be called when the property changes.
        inClientData - The client user data to use when calling the listener.
        Returns:
        kAudioSessionNoError if the operation was successful. If the property does not support listeners, kAudioSessionUnsupportedPropertyError will be returned. Other error codes listed under AudioSession Error Constants also apply to this function. API-Since: 2.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • AudioSessionRemovePropertyListener

        @Deprecated
public static int AudioSessionRemovePropertyListener​(int inID)
        Deprecated.
        [@function] AudioSessionRemovePropertyListener see AudioSessionRemovePropertyListenerWithUserData see AudioSessionRemovePropertyListenerWithUserData API-Since: 2.0 Deprecated-Since: 2.0 Deprecated-Message: no longer supported

      • AudioSessionRemovePropertyListenerWithUserData

        @Deprecated
public static int AudioSessionRemovePropertyListenerWithUserData​(int inID,
                                                                 AudioToolbox.Function_AudioSessionRemovePropertyListenerWithUserData inProc,
                                                                 org.moe.natj.general.ptr.VoidPtr inClientData)
        Deprecated.
        [@function] AudioSessionRemovePropertyListener Remove a property listener. This function can be called to remove the listener for a property. The caller provides the same proc and user data that was used to add the listener. This ensures that there can be more than one listener established for a given property ID, and each listener can be removed as requested. Valid properties are listed above.
        Parameters:
        inID - The AudioSessionPropertyID for which we want to remove the listener.
        inProc - The proc that was used to add the listener that needs to be removed.
        inClientData - The client data that was used to add the listener that needs to be removed.
        Returns:
        kAudioSessionNoError if the operation was successful. If the property does not support listeners, kAudioSessionUnsupportedPropertyError will be returned. Other error codes listed under AudioSession Error Constants also apply to this function. API-Since: 2.1 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • AudioServicesCreateSystemSoundID

        public static int AudioServicesCreateSystemSoundID​(@NotNull
                                                   @NotNull CFURLRef inFileURL,
                                                   @NotNull
                                                   @NotNull org.moe.natj.general.ptr.IntPtr outSystemSoundID)
        [@function] AudioServicesCreateSystemSoundID Allows the application to designate an audio file for playback by the System Sound server. Returned SystemSoundIDs are passed to AudioServicesPlayAlertSoundWithCompletion() and AudioServicesPlaySystemSoundWithCompletion() to be played. The maximum supported duration for a system sound is 30 secs.
        Parameters:
        inFileURL - A CFURLRef for an AudioFile.
        outSystemSoundID - Returns a SystemSoundID. API-Since: 2.0

      • AudioServicesDisposeSystemSoundID

        public static int AudioServicesDisposeSystemSoundID​(int inSystemSoundID)
        [@function] AudioServicesDisposeSystemSoundID Allows the System Sound server to dispose any resources needed for the provided SystemSoundID. Allows the application to tell the System Sound server that the resources for the associated audio file are no longer required.
        Parameters:
        inSystemSoundID - A SystemSoundID that the application no longer needs to use. API-Since: 2.0

      • AudioServicesPlayAlertSoundWithCompletion

        public static void AudioServicesPlayAlertSoundWithCompletion​(int inSystemSoundID,
                                                             @Nullable
                                                             @Nullable AudioToolbox.Block_AudioServicesPlayAlertSoundWithCompletion inCompletionBlock)
        [@function] AudioServicesPlayAlertSoundWithCompletion Play an alert sound Play the sound designated by the provided SystemSoundID with alert sound behavior.
        Parameters:
        inSystemSoundID - The SystemSoundID to be played. On the desktop the kSystemSoundID_UserPreferredAlert constant can be passed in to play back the alert sound selected by the user in System Preferences. On iOS there is no preferred user alert sound.
        inCompletionBlock - The completion block gets executed for every attempt to play a system sound irrespective of success or failure. The callbacks are issued on a serial queue and the client is responsible for handling thread safety. API-Since: 9.0

      • AudioServicesPlaySystemSoundWithCompletion

        public static void AudioServicesPlaySystemSoundWithCompletion​(int inSystemSoundID,
                                                              @Nullable
                                                              @Nullable AudioToolbox.Block_AudioServicesPlaySystemSoundWithCompletion inCompletionBlock)
        [@function] AudioServicesPlaySystemSoundWithCompletion Play a system sound Play the sound designated by the provided SystemSoundID.
        Parameters:
        inSystemSoundID - The SystemSoundID to be played.
        inCompletionBlock - The completion block gets executed for every attempt to play a system sound irrespective of success or failure. The callbacks are issued on a serial queue and the client is responsible for handling thread safety. API-Since: 9.0

      • AudioServicesGetPropertyInfo

        public static int AudioServicesGetPropertyInfo​(int inPropertyID,
                                               int inSpecifierSize,
                                               @Nullable
                                               @Nullable org.moe.natj.general.ptr.ConstVoidPtr inSpecifier,
                                               @Nullable
                                               @Nullable org.moe.natj.general.ptr.IntPtr outPropertyDataSize,
                                               @Nullable
                                               @Nullable org.moe.natj.general.ptr.BytePtr outWritable)
        [@function] AudioServicesGetPropertyInfo Get information about the size of an AudioServices property and whether it can be set.
        Parameters:
        inPropertyID - a AudioServicesPropertyID constant.
        inSpecifierSize - The size of the specifier data.
        inSpecifier - A specifier is a buffer of data used as an input argument to some of the properties.
        outPropertyDataSize - The size in bytes of the current value of the property. In order to get the property value, you will need a buffer of this size.
        outWritable - Will be set to 1 if writable, or 0 if read only.
        Returns:
        returns kAudioServicesNoError if successful. API-Since: 2.0

      • AudioServicesGetProperty

        public static int AudioServicesGetProperty​(int inPropertyID,
                                           int inSpecifierSize,
                                           @Nullable
                                           @Nullable org.moe.natj.general.ptr.ConstVoidPtr inSpecifier,
                                           @NotNull
                                           @NotNull org.moe.natj.general.ptr.IntPtr ioPropertyDataSize,
                                           @Nullable
                                           @Nullable org.moe.natj.general.ptr.VoidPtr outPropertyData)
        [@function] AudioServicesGetProperty Retrieve the indicated property data
        Parameters:
        inPropertyID - a AudioServicesPropertyID constant.
        inSpecifierSize - The size of the specifier data.
        inSpecifier - A specifier is a buffer of data used as an input argument to some of the properties.
        ioPropertyDataSize - On input, the size of the outPropertyData buffer. On output the number of bytes written to the buffer.
        outPropertyData - The buffer in which to write the property data. May be NULL if caller only wants ioPropertyDataSize to be filled with the amount that would have been written.
        Returns:
        returns kAudioServicesNoError if successful. API-Since: 2.0

      • AudioServicesSetProperty

        public static int AudioServicesSetProperty​(int inPropertyID,
                                           int inSpecifierSize,
                                           @Nullable
                                           @Nullable org.moe.natj.general.ptr.ConstVoidPtr inSpecifier,
                                           int inPropertyDataSize,
                                           @NotNull
                                           @NotNull org.moe.natj.general.ptr.ConstVoidPtr inPropertyData)
        [@function] AudioServicesSetProperty Set the indicated property data
        Parameters:
        inPropertyID - a AudioServicesPropertyID constant.
        inSpecifierSize - The size of the specifier data.
        inSpecifier - A specifier is a buffer of data used as an input argument to some of the properties.
        inPropertyDataSize - The size of the inPropertyData buffer.
        inPropertyData - The buffer containing the property data.
        Returns:
        returns kAudioServicesNoError if successful. API-Since: 2.0

      • AudioServicesPlayAlertSound

        public static void AudioServicesPlayAlertSound​(int inSystemSoundID)
        This function will be deprecated in a future release. Use AudioServicesPlayAlertSoundWithCompletion instead. [@function] AudioServicesPlayAlertSound Play an Alert Sound Play the provided SystemSoundID with AlertSound behavior.
        Parameters:
        inSystemSoundID - A SystemSoundID for the System Sound server to play. On the desktop you can pass the kSystemSoundID_UserPreferredAlert constant to playback the alert sound selected by the user in System Preferences. On iOS there is no preferred user alert sound. API-Since: 2.0

      • AudioServicesPlaySystemSound

        public static void AudioServicesPlaySystemSound​(int inSystemSoundID)
        This function will be deprecated in a future release. Use AudioServicesPlaySystemSoundWithCompletion instead. [@function] AudioServicesPlaySystemSound Play the sound designated by the provided SystemSoundID. A SystemSoundID indicating the desired System Sound to be played.
        Parameters:
        inSystemSoundID - A SystemSoundID for the System Sound server to play. API-Since: 2.0

      • AudioServicesAddSystemSoundCompletion

        public static int AudioServicesAddSystemSoundCompletion​(int inSystemSoundID,
                                                        @Nullable
                                                        @Nullable CFRunLoopRef inRunLoop,
                                                        @Nullable
                                                        @Nullable CFStringRef inRunLoopMode,
                                                        @NotNull
                                                        @NotNull AudioToolbox.Function_AudioServicesAddSystemSoundCompletion inCompletionRoutine,
                                                        @Nullable
                                                        @Nullable org.moe.natj.general.ptr.VoidPtr inClientData)
        This function will be deprecated in a future release. Use AudioServicesPlayAlertSoundWithCompletion or AudioServicesPlaySystemSoundWithCompletion instead. [@function] AudioServicesAddSystemSoundCompletion Call the provided Completion Routine when provided SystemSoundID finishes playing. Once set, the System Sound server will send a message to the System Sound client indicating which SystemSoundID has finished playing.
        Parameters:
        inSystemSoundID - The SystemSoundID to associate with the provided completion routine.
        inRunLoop - A CFRunLoopRef indicating the desired run loop the completion routine should be run on. Pass NULL to use the main run loop.
        inRunLoopMode - A CFStringRef indicating the run loop mode for the runloop where the completion routine will be executed. Pass NULL to use kCFRunLoopDefaultMode.
        inCompletionRoutine - An AudioServicesSystemSoundCompletionProc to be called when the provided SystemSoundID has completed playing in the server.
        inClientData - A void* to pass client data to the completion routine. API-Since: 2.0

      • AudioServicesRemoveSystemSoundCompletion

        public static void AudioServicesRemoveSystemSoundCompletion​(int inSystemSoundID)
        This function will be deprecated in a future release. Use AudioServicesPlayAlertSoundWithCompletion or AudioServicesPlaySystemSoundWithCompletion instead. [@function] AudioServicesRemoveSystemSoundCompletion Disassociate any completion proc for the specified SystemSoundID Tells the SystemSound client to remove any completion proc associated with the provided SystemSoundID
        Parameters:
        inSystemSoundID - The SystemSoundID for which completion routines should be removed. API-Since: 2.0

      • ExtAudioFileOpenURL

        public static int ExtAudioFileOpenURL​(@NotNull
                                      @NotNull CFURLRef inURL,
                                      @NotNull
                                      @NotNull org.moe.natj.general.ptr.Ptr<ExtAudioFileRef> outExtAudioFile)
        [@function] ExtAudioFileOpenURL Opens an audio file specified by a CFURLRef. Allocates a new ExtAudioFileRef, for reading an existing audio file. API-Since: 2.1
        Parameters:
        inURL - The audio file to read.
        outExtAudioFile - On exit, a newly-allocated ExtAudioFileRef.
        Returns:
        An OSStatus error code.

      • ExtAudioFileWrapAudioFileID

        public static int ExtAudioFileWrapAudioFileID​(@NotNull
                                              @NotNull AudioFileID inFileID,
                                              byte inForWriting,
                                              @NotNull
                                              @NotNull org.moe.natj.general.ptr.Ptr<ExtAudioFileRef> outExtAudioFile)
        [@function] ExtAudioFileWrapAudioFileID Wrap an AudioFileID in an ExtAudioFileRef. Allocates a new ExtAudioFileRef which wraps an existing AudioFileID. The client is responsible for keeping the AudioFileID open until the ExtAudioFileRef is disposed. Disposing the ExtAudioFileRef will not close the AudioFileID when this Wrap API call is used, so the client is also responsible for closing the AudioFileID when finished with it. API-Since: 2.1
        Parameters:
        inFileID - The AudioFileID to wrap.
        inForWriting - True if the AudioFileID is a new file opened for writing.
        outExtAudioFile - On exit, a newly-allocated ExtAudioFileRef.
        Returns:
        An OSStatus error code.

      • ExtAudioFileCreateWithURL

        public static int ExtAudioFileCreateWithURL​(@NotNull
                                            @NotNull CFURLRef inURL,
                                            int inFileType,
                                            @NotNull
                                            @NotNull AudioStreamBasicDescription inStreamDesc,
                                            @Nullable
                                            @Nullable AudioChannelLayout inChannelLayout,
                                            int inFlags,
                                            @NotNull
                                            @NotNull org.moe.natj.general.ptr.Ptr<ExtAudioFileRef> outExtAudioFile)
        [@function] ExtAudioFileCreateWithURL Create a new audio file. Creates a new audio file. If the file to be created is in an encoded format, it is permissible for the sample rate in inStreamDesc to be 0, since in all cases, the file's encoding AudioConverter may produce audio at a different sample rate than the source. The file will be created with the audio format actually produced by the encoder. API-Since: 2.1
        Parameters:
        inURL - The URL of the new audio file.
        inFileType - The type of file to create. This is a constant from AudioToolbox/AudioFile.h, e.g. kAudioFileAIFFType. Note that this is not an HFSTypeCode.
        inStreamDesc - The format of the audio data to be written to the file.
        inChannelLayout - The channel layout of the audio data. If non-null, this must be consistent with the number of channels specified by inStreamDesc.
        inFlags - The same flags as are used with AudioFileCreateWithURL Can use these to control whether an existing file is overwritten (or not).
        outExtAudioFile - On exit, a newly-allocated ExtAudioFileRef.
        Returns:
        An OSStatus error code.

      • ExtAudioFileDispose

        public static int ExtAudioFileDispose​(@NotNull
                                      @NotNull ExtAudioFileRef inExtAudioFile)
        [@function] ExtAudioFileDispose Close the file and dispose the object. Closes the file and deletes the object. API-Since: 2.1
        Parameters:
        inExtAudioFile - The extended audio file object.
        Returns:
        An OSStatus error code.

      • ExtAudioFileRead

        public static int ExtAudioFileRead​(@NotNull
                                   @NotNull ExtAudioFileRef inExtAudioFile,
                                   @NotNull
                                   @NotNull org.moe.natj.general.ptr.IntPtr ioNumberFrames,
                                   @NotNull
                                   @NotNull AudioBufferList ioData)
        [@function] ExtAudioFileRead Perform a synchronous sequential read. If the file has a client data format, then the audio data from the file is translated from the file data format to the client format, via the ExtAudioFile's internal AudioConverter. (Note that the use of sequential reads/writes means that an ExtAudioFile must not be read on multiple threads; clients wishing to do this should use the lower-level AudioFile API set). API-Since: 2.1
        Parameters:
        inExtAudioFile - The extended audio file object.
        ioNumberFrames - On entry, ioNumberFrames is the number of frames to be read from the file. On exit, it is the number of frames actually read. A number of factors may cause a fewer number of frames to be read, including the supplied buffers not being large enough, and internal optimizations. If 0 frames are returned, however, this indicates that end-of-file was reached.
        ioData - Buffer(s) into which the audio data is read.
        Returns:
        An OSStatus error code.

      • ExtAudioFileWrite

        public static int ExtAudioFileWrite​(@NotNull
                                    @NotNull ExtAudioFileRef inExtAudioFile,
                                    int inNumberFrames,
                                    @NotNull
                                    @NotNull AudioBufferList ioData)
        [@function] ExtAudioFileWrite Perform a synchronous sequential write. If the file has a client data format, then the audio data in ioData is translated from the client format to the file data format, via the ExtAudioFile's internal AudioConverter. API-Since: 2.1
        Parameters:
        inExtAudioFile - The extended audio file object.
        inNumberFrames - The number of frames to write.
        ioData - The buffer(s) from which audio data is written to the file.
        Returns:
        An OSStatus error code.

      • ExtAudioFileWriteAsync

        public static int ExtAudioFileWriteAsync​(@NotNull
                                         @NotNull ExtAudioFileRef inExtAudioFile,
                                         int inNumberFrames,
                                         @Nullable
                                         @Nullable AudioBufferList ioData)
        [@function] ExtAudioFileWriteAsync Perform an asynchronous sequential write. Writes the provided buffer list to an internal ring buffer and notifies an internal thread to perform the write at a later time. The first time this is called, allocations may be performed. You can call this with 0 frames and null buffer in a non-time-critical context to initialize the asynchronous mechanism. Once initialized, subsequent calls are very efficient and do not take locks; thus this may be used to write to a file from a realtime thread. The client must not mix synchronous and asynchronous writes to the same file. Pending writes are not guaranteed to be flushed to disk until ExtAudioFileDispose is called. N.B. Errors may occur after this call has returned. Such errors may be returned from subsequent calls to this function. API-Since: 2.1
        Parameters:
        inExtAudioFile - The extended audio file object.
        inNumberFrames - The number of frames to write.
        ioData - The buffer(s) from which audio data is written to the file.
        Returns:
        An OSStatus error code.

      • ExtAudioFileSeek

        public static int ExtAudioFileSeek​(@NotNull
                                   @NotNull ExtAudioFileRef inExtAudioFile,
                                   long inFrameOffset)
        [@function] ExtAudioFileSeek Seek to a specific frame position. Sets the file's read position to the specified sample frame number. The next call to ExtAudioFileRead will return samples from precisely this location, even if it is located in the middle of a packet. This function's behavior with files open for writing is currently undefined. API-Since: 2.1
        Parameters:
        inExtAudioFile - The extended audio file object.
        inFrameOffset - The desired seek position, in sample frames, relative to the beginning of the file. This is specified in the sample rate and frame count of the file's format (not the client format)
        Returns:
        An OSStatus error code.

      • ExtAudioFileTell

        public static int ExtAudioFileTell​(@NotNull
                                   @NotNull ExtAudioFileRef inExtAudioFile,
                                   @NotNull
                                   @NotNull org.moe.natj.general.ptr.LongPtr outFrameOffset)
        [@function] ExtAudioFileTell Return the file's read/write position.
        Parameters:
        inExtAudioFile - The extended audio file object.
        outFrameOffset - On exit, the file's current read/write position in sample frames. This is specified in the sample rate and frame count of the file's format (not the client format)
        Returns:
        An OSStatus error code. API-Since: 2.1

      • ExtAudioFileGetPropertyInfo

        public static int ExtAudioFileGetPropertyInfo​(@NotNull
                                              @NotNull ExtAudioFileRef inExtAudioFile,
                                              int inPropertyID,
                                              @Nullable
                                              @Nullable org.moe.natj.general.ptr.IntPtr outSize,
                                              @Nullable
                                              @Nullable org.moe.natj.general.ptr.BytePtr outWritable)
        [@function] ExtAudioFileGetPropertyInfo Get information about a property
        Parameters:
        inExtAudioFile - The extended audio file object.
        inPropertyID - The property being queried.
        outSize - If non-null, on exit, this is set to the size of the property's value.
        outWritable - If non-null, on exit, this indicates whether the property value is settable.
        Returns:
        An OSStatus error code. API-Since: 2.1

      • ExtAudioFileGetProperty

        public static int ExtAudioFileGetProperty​(@NotNull
                                          @NotNull ExtAudioFileRef inExtAudioFile,
                                          int inPropertyID,
                                          @NotNull
                                          @NotNull org.moe.natj.general.ptr.IntPtr ioPropertyDataSize,
                                          @NotNull
                                          @NotNull org.moe.natj.general.ptr.VoidPtr outPropertyData)
        [@function] ExtAudioFileGetProperty Get a property value.
        Parameters:
        inExtAudioFile - The extended audio file object.
        inPropertyID - The property being fetched.
        ioPropertyDataSize - On entry, the size (in bytes) of the memory pointed to by outPropertyData. On exit, the actual size of the property data returned.
        outPropertyData - The value of the property is copied to the memory this points to.
        Returns:
        An OSStatus error code. API-Since: 2.1

      • ExtAudioFileSetProperty

        public static int ExtAudioFileSetProperty​(@NotNull
                                          @NotNull ExtAudioFileRef inExtAudioFile,
                                          int inPropertyID,
                                          int inPropertyDataSize,
                                          @NotNull
                                          @NotNull org.moe.natj.general.ptr.ConstVoidPtr inPropertyData)
        [@function] ExtAudioFileSetProperty Set a property value.
        Parameters:
        inExtAudioFile - The extended audio file object.
        inPropertyID - The property being set.
        inPropertyDataSize - The size of the property data, in bytes.
        inPropertyData - Points to the property's new value.
        Returns:
        An OSStatus error code. API-Since: 2.1

      • NewMusicPlayer

        public static int NewMusicPlayer​(@NotNull
                                 @NotNull org.moe.natj.general.ptr.Ptr<MusicPlayer> outPlayer)
        [@function] NewMusicPlayer Create a new music player A music player is used to play a sequence back. This call is used to create a player When a sequence is to be played by a player, it can play to either an AUGraph, a MIDI Destination or a mixture/combination of both.
        Parameters:
        outPlayer - the newly created player API-Since: 5.0

      • DisposeMusicPlayer

        public static int DisposeMusicPlayer​(@NotNull
                                     @NotNull MusicPlayer inPlayer)
        [@function] DisposeMusicPlayer Dispose a music player
        Parameters:
        inPlayer - the player to dispose API-Since: 5.0

      • MusicPlayerSetSequence

        public static int MusicPlayerSetSequence​(@NotNull
                                         @NotNull MusicPlayer inPlayer,
                                         @Nullable
                                         @Nullable MusicSequence inSequence)
        [@function] MusicPlayerSetSequence Set the sequence for the player to play A Sequence cannot be set on a player while it is playing. Setting a sequence will overide the currently set sequence.
        Parameters:
        inPlayer - the player
        inSequence - the sequence for the player to play API-Since: 5.0

      • MusicPlayerGetSequence

        public static int MusicPlayerGetSequence​(@NotNull
                                         @NotNull MusicPlayer inPlayer,
                                         @NotNull
                                         @NotNull org.moe.natj.general.ptr.Ptr<MusicSequence> outSequence)
        [@function] MusicPlayerGetSequence Get the sequence attached to a player If the player does not have a sequence set, this will return the _NoSequence error
        Parameters:
        inPlayer - the player
        outSequence - the sequence currently set on the player API-Since: 5.0

      • MusicPlayerSetTime

        public static int MusicPlayerSetTime​(@NotNull
                                     @NotNull MusicPlayer inPlayer,
                                     double inTime)
        [@function] MusicPlayerSetTime Set the current time on the player The Get and Set Time calls take a specification of time as beats. This positions the player to the specified time based on the currently set sequence. No range checking on the time value is done. This can be set on a playing player (in which case playing will be resumed from the new time).
        Parameters:
        inPlayer - the player
        inTime - the new time value API-Since: 5.0

      • MusicPlayerGetTime

        public static int MusicPlayerGetTime​(@NotNull
                                     @NotNull MusicPlayer inPlayer,
                                     @NotNull
                                     @NotNull org.moe.natj.general.ptr.DoublePtr outTime)
        [@function] MusicPlayerGetTime Get the current time of the player The Get and Set Time calls take a specification of time as beats. This retrieves the player's current time. If it is playing this time is the time of the player at the time the call was made.
        Parameters:
        inPlayer - the player
        outTime - the current time value API-Since: 5.0

      • MusicPlayerGetHostTimeForBeats

        public static int MusicPlayerGetHostTimeForBeats​(@NotNull
                                                 @NotNull MusicPlayer inPlayer,
                                                 double inBeats,
                                                 @NotNull
                                                 @NotNull org.moe.natj.general.ptr.LongPtr outHostTime)
        [@function] MusicPlayerGetHostTimeForBeats Returns the host time that will be (or was) played at the specified beat. This call is only valid if the player is playing and will return an error if the player is not playing or if the starting position of the player (its "starting beat") was after the specified beat. For general translation of beats to time in a sequence, see the MusicSequence calls for beat<->seconds. The call uses the player's sequence's tempo map to translate a beat time from the starting time and beat of the player.
        Parameters:
        inPlayer - the player
        inBeats - the specified beat-time value
        outHostTime - the corresponding host time API-Since: 5.0

      • MusicPlayerGetBeatsForHostTime

        public static int MusicPlayerGetBeatsForHostTime​(@NotNull
                                                 @NotNull MusicPlayer inPlayer,
                                                 long inHostTime,
                                                 @NotNull
                                                 @NotNull org.moe.natj.general.ptr.DoublePtr outBeats)
        [@function] MusicPlayerGetBeatsForHostTime Returns the beat that will be (or was) played at the specified host time. This call is only valid if the player is playing and will return an error if the player is not playing or if the starting time of the player was after the specified host time. For general translation of beats to time in a sequence, see the MusicSequence calls for beat<->seconds. The call uses the player's sequence's tempo map to retrieve a beat time from the starting and specified host time.
        Parameters:
        inPlayer - the player
        inHostTime - the specified host time value
        outBeats - the corresponding beat time API-Since: 5.0

      • MusicPlayerPreroll

        public static int MusicPlayerPreroll​(@NotNull
                                     @NotNull MusicPlayer inPlayer)
        [@function] MusicPlayerPreroll Prepare the player for playing Allows the player to prepare its state so that starting is has a lower latency. If a player is started without being prerolled, the player will pre-roll itself and then start.
        Parameters:
        inPlayer - the player API-Since: 5.0

      • MusicPlayerStart

        public static int MusicPlayerStart​(@NotNull
                                   @NotNull MusicPlayer inPlayer)
        [@function] MusicPlayerStart Start the player If the player has not been prerolled, it will pre-roll itself and then start.
        Parameters:
        inPlayer - the player API-Since: 5.0

      • MusicPlayerStop

        public static int MusicPlayerStop​(@NotNull
                                  @NotNull MusicPlayer inPlayer)
        [@function] MusicPlayerStop Stop the player
        Parameters:
        inPlayer - the player API-Since: 5.0

      • MusicPlayerIsPlaying

        public static int MusicPlayerIsPlaying​(@NotNull
                                       @NotNull MusicPlayer inPlayer,
                                       @NotNull
                                       @NotNull org.moe.natj.general.ptr.BytePtr outIsPlaying)
        [@function] MusicPlayerIsPlaying Returns the playing state of the player. "Is it playing?" This call returns a non-zero value in outIsPlaying if the player has been started and not stopped. It may have "played" past the events of the attached MusicSequence, but it is still considered to be playing (and its time value increasing) until it is explicitly stopped
        Parameters:
        inPlayer - the player
        outIsPlaying - false if not, true (non-zero) if is playing API-Since: 5.0

      • MusicPlayerSetPlayRateScalar

        public static int MusicPlayerSetPlayRateScalar​(@NotNull
                                               @NotNull MusicPlayer inPlayer,
                                               double inScaleRate)
        [@function] MusicPlayerSetPlayRateScalar Scale the playback rate of the player
        Parameters:
        inPlayer - the player
        inScaleRate - a scalar that will be applied to the playback rate. If 2, playback is twice as fast, if 0.5 it is half as fast. As a scalar, the value must be greater than zero. API-Since: 5.0

      • MusicPlayerGetPlayRateScalar

        public static int MusicPlayerGetPlayRateScalar​(@NotNull
                                               @NotNull MusicPlayer inPlayer,
                                               @NotNull
                                               @NotNull org.moe.natj.general.ptr.DoublePtr outScaleRate)
        [@function] MusicPlayerGetPlayRateScalar Get the playback rate scalar of the player
        Parameters:
        inPlayer - the player
        outScaleRate - the current scalar being applied to the player. Default value is 1.0 API-Since: 5.0

      • NewMusicSequence

        public static int NewMusicSequence​(@NotNull
                                   @NotNull org.moe.natj.general.ptr.Ptr<MusicSequence> outSequence)
        [@functiongroup] Music Sequence [@function] NewMusicSequence Create a new empty sequence A new music sequence will only have a tempo track (with a default tempo of 120 bpm), and the default type is beat based. When a sequence is to be played by a player, it can play to either an AUGraph, a MIDI Destination or a mixture/combination of both. See MusicSequenceSetAUGraph and MusicSequenceSetMIDIEndpoint for the generic destination assignments. Specific tracks can also be assigned nodes of a graph or a MIDI endpoint as targets for the events that they contain; see MusicTrackSetDestNode and MusicTrackSetDestMIDIEndpoint.
        Parameters:
        outSequence - the new sequence API-Since: 5.0

      • DisposeMusicSequence

        public static int DisposeMusicSequence​(@NotNull
                                       @NotNull MusicSequence inSequence)
        [@function] DisposeMusicSequence Dispose the sequence A sequence cannot be disposed while a MusicPlayer has it.
        Parameters:
        inSequence - the sequence API-Since: 5.0

      • MusicSequenceNewTrack

        public static int MusicSequenceNewTrack​(@NotNull
                                        @NotNull MusicSequence inSequence,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.Ptr<MusicTrack> outTrack)
        [@function] MusicSequenceNewTrack Add a new (empty) track to the sequence
        Parameters:
        inSequence - the sequence
        outTrack - the new track (it is always appended to any existing tracks) API-Since: 5.0

      • MusicSequenceDisposeTrack

        public static int MusicSequenceDisposeTrack​(@NotNull
                                            @NotNull MusicSequence inSequence,
                                            @NotNull
                                            @NotNull MusicTrack inTrack)
        [@function] MusicSequenceDisposeTrack Remove and dispose a track from a sequence
        Parameters:
        inSequence - the sequence
        inTrack - the track to remove and dispose API-Since: 5.0

      • MusicSequenceGetTrackCount

        public static int MusicSequenceGetTrackCount​(@NotNull
                                             @NotNull MusicSequence inSequence,
                                             @NotNull
                                             @NotNull org.moe.natj.general.ptr.IntPtr outNumberOfTracks)
        [@function] MusicSequenceGetTrackCount The number of tracks in a sequence. The track count and accessors exclude the tempo track (which is treated as a special case)
        Parameters:
        inSequence - the sequence
        outNumberOfTracks - the number of tracks API-Since: 5.0

      • MusicSequenceGetIndTrack

        public static int MusicSequenceGetIndTrack​(@NotNull
                                           @NotNull MusicSequence inSequence,
                                           int inTrackIndex,
                                           @NotNull
                                           @NotNull org.moe.natj.general.ptr.Ptr<MusicTrack> outTrack)
        [@function] MusicSequenceGetIndTrack Get a track at the specified index Index is zero based. It will return kAudio_ParamError if index is not in the range: 0 < TrackCount The track count and accessors exclude the tempo track (which is treated as a special case)
        Parameters:
        inSequence - the sequence
        inTrackIndex - the index
        outTrack - the track at that index API-Since: 5.0

      • MusicSequenceGetTrackIndex

        public static int MusicSequenceGetTrackIndex​(@NotNull
                                             @NotNull MusicSequence inSequence,
                                             @NotNull
                                             @NotNull MusicTrack inTrack,
                                             @NotNull
                                             @NotNull org.moe.natj.general.ptr.IntPtr outTrackIndex)
        [@function] MusicSequenceGetTrackIndex Get the index for a specific track Index is zero based. It will return an error if the track is not a member of the sequence. The track count and accessors exclude the tempo track (which is treated as a special case)
        Parameters:
        inSequence - the sequence
        inTrack - the track
        outTrackIndex - the index of the track API-Since: 5.0

      • MusicSequenceGetTempoTrack

        public static int MusicSequenceGetTempoTrack​(@NotNull
                                             @NotNull MusicSequence inSequence,
                                             @NotNull
                                             @NotNull org.moe.natj.general.ptr.Ptr<MusicTrack> outTrack)
        [@function] MusicSequenceGetTempoTrack Get the tempo track of the sequence Each sequence has a single tempo track. All tempo events are placed into this tempo track (as well as other appropriate events (time sig for instance from a MIDI file). The tempo track, once retrieved can be edited and iterated upon as any other track. Non-tempo events in a tempo track are ignored.
        Parameters:
        inSequence - the sequence
        outTrack - the tempo track of the sequence API-Since: 5.0

      • MusicSequenceSetAUGraph

        public static int MusicSequenceSetAUGraph​(@NotNull
                                          @NotNull MusicSequence inSequence,
                                          @Nullable
                                          @Nullable AUGraph inGraph)
        [@function] MusicSequenceSetAUGraph Set the graph to be associated with the sequence A sequence can be associated with an AUGraph and this graph will be used to render the events as controlled by the sequence when it is played. By default, all of the tracks of a sequence will find the first AUNode that is an instance of an Apple MusicDevice audio unit (see MusicSequenceGetAUGraph). Specific nodes of the graph can be targeted for different tracks (see MusicTrackSetDestNode). To render a multi-track GM MIDI sequence on iOS, create a custom graph with a MIDISynth audio unit as the MusicDevice. If inGraph is set to NULL, the sequence will reset to use the default graph.
        Parameters:
        inSequence - the sequence
        inGraph - the graph API-Since: 5.0

      • MusicSequenceGetAUGraph

        public static int MusicSequenceGetAUGraph​(@NotNull
                                          @NotNull MusicSequence inSequence,
                                          @NotNull
                                          @NotNull org.moe.natj.general.ptr.Ptr<AUGraph> outGraph)
        [@function] MusicSequenceGetAUGraph Gets the graph currently associated with a sequence By default if no graph is assigned to a sequence then the sequence will create a default graph. This default graph contains a MusicDevice and a DynamicsProcessor and all tracks will be targeted to the MusicDevice. On macOS, this MusicDevice is an instance of a software synthesizer that is compatible with the GM and GS MIDI standards. On iOS, it is an instance of a monotimbral software synthesizer designed to render events from a single MIDI channel. To render multi-track GM MIDI sequences on iOS, create a custom graph with a MIDISynth audio unit as the MusicDevice. This call will thus either return the graph as set by the user, or this default graph.
        Parameters:
        inSequence - the sequence
        outGraph - the graph API-Since: 5.0

      • MusicSequenceSetMIDIEndpoint

        public static int MusicSequenceSetMIDIEndpoint​(@NotNull
                                               @NotNull MusicSequence inSequence,
                                               int inEndpoint)
        [@function] MusicSequenceSetMIDIEndpoint Makes the target of all of the tracks in the sequence a MIDI endpoint This is a convenience function, and is equivalent to iterating through all of the tracks in a sequence and targeting each track to the MIDI endpoint
        Parameters:
        inSequence - the sequence
        inEndpoint - the MIDI endpoint API-Since: 5.0

      • MusicSequenceSetSequenceType

        public static int MusicSequenceSetSequenceType​(@NotNull
                                               @NotNull MusicSequence inSequence,
                                               int inType)
        [@function] MusicSequenceSetSequenceType Set the sequence type (the default is beats) These two calls allow you to get and set a MusicSequence type; specifying kMusicSequenceType_Beats = 'beat', kMusicSequenceType_Seconds = 'secs', kMusicSequenceType_Samples = 'samp' The sequence type can be set to beats at any time. The sequence type can only be set to seconds or samples if there are NO tempo events already in the sequence. For beats - it can have as many tempo events as you want For Samples and Seconds - you should add a single tempo event after setting the type Samples - the tempo is the desired sample rate - e.g. 44100 and each "beat" in the sequence will be interpreted as a sample count at that sample rate (so beat == 44100 is a second) Seconds - the tempo should be set to 60 - a beat is a second. Beats is the default (and is the behaviour on pre 10.5 systems) A meta event of interest for Seconds based MIDI files is the SMPTE Offset meta event - stored in the tempo track. The sequence doesn't do anything with this event (except store/write it)
        Parameters:
        inSequence - the sequence
        inType - the sequence type API-Since: 5.0

      • MusicSequenceGetSequenceType

        public static int MusicSequenceGetSequenceType​(@NotNull
                                               @NotNull MusicSequence inSequence,
                                               @NotNull
                                               @NotNull org.moe.natj.general.ptr.IntPtr outType)
        [@function] MusicSequenceGetSequenceType Get the sequence type See SetSequence for a full description
        Parameters:
        inSequence - the sequence
        outType - the type API-Since: 5.0

      • MusicSequenceFileLoad

        public static int MusicSequenceFileLoad​(@NotNull
                                        @NotNull MusicSequence inSequence,
                                        @NotNull
                                        @NotNull CFURLRef inFileRef,
                                        int inFileTypeHint,
                                        int inFlags)
        [@function] MusicSequenceFileLoad Load the data contained within the referenced file to the sequence This function will parse the file referenced by the URL and add the events to the sequence.
        Parameters:
        inSequence - the sequence
        inFileRef - a file:// URL that references a file
        inFileTypeHint - provides a hint to the sequence on the file type being imported. Can be zero in many cases.
        inFlags - flags that can control how the data is parsed in the file and laid out in the tracks that will be created and added to the sequence in this operation API-Since: 5.0

      • MusicSequenceFileLoadData

        public static int MusicSequenceFileLoadData​(@NotNull
                                            @NotNull MusicSequence inSequence,
                                            @NotNull
                                            @NotNull CFDataRef inData,
                                            int inFileTypeHint,
                                            int inFlags)
        [@function] MusicSequenceFileLoadData Load the data to the sequence This function will parse the data and add the events to the sequence. The data provided needs to be of a particular file type as specified by the fileTypeHint.
        Parameters:
        inSequence - the sequence
        inData - the contents of a valid file loaded into a CFData object
        inFileTypeHint - provides a hint to the sequence on the file type being imported. Can be zero in many cases.
        inFlags - flags that can control how the data is parsed in the file and laid out in the tracks that will be created and added to the sequence in this operation API-Since: 5.0

      • MusicSequenceSetSMPTEResolution

        public static short MusicSequenceSetSMPTEResolution​(byte fps,
                                                    byte ticks)
        [@function] MusicSequenceSetSMPTEResolution Helper function to establish the SMPTE based MIDI file resolution for the specified ticks SMPTE resolution helpers for dealing with the interpretation and creation of tick values for standard MIDI files (see MusicSequenceFileCreate)
        Parameters:
        fps - the frames per second
        ticks - the ticks per quarter note
        Returns:
        the resolution that can be used when creating a MIDI file derived from the two parameters

      • MusicSequenceGetSMPTEResolution

        public static void MusicSequenceGetSMPTEResolution​(short inRes,
                                                   @NotNull
                                                   @NotNull org.moe.natj.general.ptr.BytePtr fps,
                                                   @NotNull
                                                   @NotNull org.moe.natj.general.ptr.BytePtr ticks)
        [@function] MusicSequenceGetSMPTEResolution Helper function to get the fps and ticks from their representation in a SMPTE based MIDI file SMPTE resolution helpers for dealing with the interpretation and creation of tick values for standard MIDI files (see MusicSequenceFileCreate)
        Parameters:
        inRes - the resolution from a MIDI file
        fps - the frames per second
        ticks - the ticks per quarter note

      • MusicSequenceFileCreate

        public static int MusicSequenceFileCreate​(@NotNull
                                          @NotNull MusicSequence inSequence,
                                          @NotNull
                                          @NotNull CFURLRef inFileRef,
                                          int inFileType,
                                          int inFlags,
                                          short inResolution)
        [@function] MusicSequenceFileCreate Create a file from a sequence This function can be (and is most commonly) used to create a MIDI file from the events in a sequence. Only MIDI based events are used when creating the MIDI file. MIDI files are normally beat based, but can also have a SMPTE (or real-time rather than beat time) representation. inResolution is relationship between "tick" and quarter note for saving to Standard MIDI File - pass in zero to use default - this will be the value that is currently set on the tempo track - see the comments for the set track property's time resolution The different Sequence types determine the kinds of files that can be created: Beats When saving a MIDI file, it saves a beats (PPQ) based axis Seconds When saving a MIDI file, it will save it as a SMPTE resolution - so you should specify this resolution when creating the MIDI file. If zero is specified, 25 fps and 40 ticks/frame is used (a time scale of a millisecond) Samples You cannot save to a MIDI file with this sequence type The complete meaning of the 16-bit "division" field in a MIDI File's MThd chunk. If it is positive, then a tick represents 1/D quarter notes. If it negative: bits 14-8 are a signed 7-bit number representing the SMPTE format: -24, -25, -29 (drop), -30 bits 7-0 represents the number of ticks per SMPTE frame typical values: 4, 10, 80, 100 You can obtain millisecond resolution by specifying 25 frames/sec and 40 divisions/frame. 30 fps with 80 bits (ticks) per frame: 0xE250 ((char)0xE2 == -30)
        Parameters:
        inSequence - the sequence
        inFileRef - the location of the file to create
        inFileType - the type of file to create
        inFlags - flags to control the file creation
        inResolution - the resolution (depending on file type and sequence type) API-Since: 5.0

      • MusicSequenceFileCreateData

        public static int MusicSequenceFileCreateData​(@NotNull
                                              @NotNull MusicSequence inSequence,
                                              int inFileType,
                                              int inFlags,
                                              short inResolution,
                                              @NotNull
                                              @NotNull org.moe.natj.general.ptr.Ptr<CFDataRef> outData)
        [@function] MusicSequenceFileCreateData Create a data object from a sequence The same basic parameters apply to this as with the MusicSequenceFileCreate function. The difference being that that function will create a file on disk, whereas this one will create a CFData object that is a file in memory. The CFData object should be released by the caller.
        Parameters:
        inSequence - the sequence
        inFileType - the type of file to create
        inFlags - flags to control the file creation
        inResolution - the resolution (depending on file type and sequence type)
        outData - the resulting data object API-Since: 5.0

      • MusicSequenceReverse

        public static int MusicSequenceReverse​(@NotNull
                                       @NotNull MusicSequence inSequence)
        [@function] MusicSequenceReverse Reverse in time all events in a sequence, including the tempo events
        Parameters:
        inSequence - the sequence API-Since: 5.0

      • MusicSequenceGetSecondsForBeats

        public static int MusicSequenceGetSecondsForBeats​(@NotNull
                                                  @NotNull MusicSequence inSequence,
                                                  double inBeats,
                                                  @NotNull
                                                  @NotNull org.moe.natj.general.ptr.DoublePtr outSeconds)
        [@function] MusicSequenceGetSecondsForBeats Returns a seconds value that would correspond to the supplied beats Uses the sequence's tempo events
        Parameters:
        inSequence - the sequence
        inBeats - the beats
        outSeconds - the seconds (time from 0 beat) API-Since: 5.0

      • MusicSequenceGetBeatsForSeconds

        public static int MusicSequenceGetBeatsForSeconds​(@NotNull
                                                  @NotNull MusicSequence inSequence,
                                                  double inSeconds,
                                                  @NotNull
                                                  @NotNull org.moe.natj.general.ptr.DoublePtr outBeats)
        [@function] MusicSequenceGetBeatsForSeconds Returns a beat value that would correspond to the supplied seconds from zero. Uses the sequence's tempo events
        Parameters:
        inSequence - the sequence
        inSeconds - the seconds
        outBeats - the corresponding beat API-Since: 5.0

      • MusicSequenceSetUserCallback

        public static int MusicSequenceSetUserCallback​(@NotNull
                                               @NotNull MusicSequence inSequence,
                                               @Nullable
                                               @Nullable AudioToolbox.Function_MusicSequenceSetUserCallback inCallback,
                                               @Nullable
                                               @Nullable org.moe.natj.general.ptr.VoidPtr inClientData)
        [@function] MusicSequenceSetUserCallback Establish a user callback for a sequence This call is used to register (or remove if inCallback is NULL) a callback that the MusicSequence will call for ANY UserEvents that are added to any of the tracks of the sequence. If there is a callback registered, then UserEvents will be chased when MusicPlayerSetTime is called. In that case the inStartSliceBeat and inEndSliceBeat will both be the same value and will be the beat that the player is chasing too. In normal cases, where the sequence data is being scheduled for playback, the following will apply: inStartSliceBeat <= inEventTime < inEndSliceBeat The only exception to this is if the track that owns the MusicEvent is looping. In this case the start beat will still be less than the end beat (so your callback can still determine that it is playing, and what beats are currently being scheduled), however, the inEventTime will be the original time-stamped time of the user event.
        Parameters:
        inSequence - the sequence
        inCallback - the callback
        inClientData - client (user supplied) data provided back to the callback when it is called by the sequence API-Since: 5.0

      • MusicSequenceBeatsToBarBeatTime

        public static int MusicSequenceBeatsToBarBeatTime​(@NotNull
                                                  @NotNull MusicSequence inSequence,
                                                  double inBeats,
                                                  int inSubbeatDivisor,
                                                  @NotNull
                                                  @NotNull CABarBeatTime outBarBeatTime)
        [@function] MusicSequenceBeatsToBarBeatTime Convenience function to format a sequence's beat time to its bar-beat time The sequence's tempo track Time Sig events are used to to calculate the bar-beat representation. If there are no Time Sig events added to the sequence 4/4 is assumed. A Time Sig event is a MIDI Meta Event as specified for MIDI files.
        Parameters:
        inSequence - the sequence
        inBeats - the beat which should be represented by the bar-beat
        inSubbeatDivisor - The denominator of the fractional number of beats.
        outBarBeatTime - the formatted bar/beat time API-Since: 5.0

      • MusicSequenceBarBeatTimeToBeats

        public static int MusicSequenceBarBeatTimeToBeats​(@NotNull
                                                  @NotNull MusicSequence inSequence,
                                                  @NotNull
                                                  @NotNull CABarBeatTime inBarBeatTime,
                                                  @NotNull
                                                  @NotNull org.moe.natj.general.ptr.DoublePtr outBeats)
        [@function] MusicSequenceBarBeatTimeToBeats Convenience function to format a bar-beat time to a sequence's beat time The sequence's tempo track Time Sig events are used to to calculate the bar-beat representation. If there are no Time Sig events added to the sequence 4/4 is assumed. A Time Sig event is a MIDI Meta Event as specified for MIDI files.
        Parameters:
        inSequence - the sequence
        inBarBeatTime - the bar-beat time
        outBeats - the sequence's beat time for that bar-beat time API-Since: 5.0

      • MusicSequenceGetInfoDictionary

        @NotNull
public static @NotNull CFDictionaryRef MusicSequenceGetInfoDictionary​(@NotNull
                                                                      @NotNull MusicSequence inSequence)
        [@function] MusicSequenceGetInfoDictionary Returns a dictionary containing meta-data derived from a sequence The dictionary can contain one or more of the kAFInfoDictionary_* keys specified in The caller should release the returned dictionary. If the call fails it will return NULL
        Parameters:
        inSequence - the sequence
        Returns:
        a CFDictionary or NULL if the call fails. API-Since: 5.0

      • MusicTrackGetSequence

        public static int MusicTrackGetSequence​(@NotNull
                                        @NotNull MusicTrack inTrack,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.Ptr<MusicSequence> outSequence)
        [@function] MusicTrackGetSequence Gets the sequence which the track is a member of
        Parameters:
        inTrack - the track
        outSequence - the track's sequence API-Since: 5.0

      • MusicTrackSetDestNode

        public static int MusicTrackSetDestNode​(@NotNull
                                        @NotNull MusicTrack inTrack,
                                        int inNode)
        [@function] MusicTrackSetDestNode Sets the track's target to the specified AUNode The node must be a member of the graph that the track's sequence is using. When played, the track will send all of its events to that node.
        Parameters:
        inTrack - the track
        inNode - the new node API-Since: 5.0

      • MusicTrackSetDestMIDIEndpoint

        public static int MusicTrackSetDestMIDIEndpoint​(@NotNull
                                                @NotNull MusicTrack inTrack,
                                                int inEndpoint)
        [@function] MusicTrackSetDestMIDIEndpoint Sets the track's target to the specified MIDI endpoint When played, the track will send all of its events to the specified MIDI Endpoint.
        Parameters:
        inTrack - the track
        inEndpoint - the new MIDI endpoint API-Since: 5.0

      • MusicTrackGetDestNode

        public static int MusicTrackGetDestNode​(@NotNull
                                        @NotNull MusicTrack inTrack,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.IntPtr outNode)
        [@function] MusicTrackGetDestNode Gets the track's target if it is an AUNode Returns kAudioToolboxErr_IllegalTrackDestination if the track's target is a MIDIEndpointRef and NOT an AUNode
        Parameters:
        inTrack - the track
        outNode - the node target for the track API-Since: 5.0

      • MusicTrackGetDestMIDIEndpoint

        public static int MusicTrackGetDestMIDIEndpoint​(@NotNull
                                                @NotNull MusicTrack inTrack,
                                                @NotNull
                                                @NotNull org.moe.natj.general.ptr.IntPtr outEndpoint)
        [@function] MusicTrackGetDestMIDIEndpoint Gets the track's target if it is a MIDI Endpoint Returns kAudioToolboxErr_IllegalTrackDestination if the track's target is an AUNode and NOT a MIDI Endpoint
        Parameters:
        inTrack - the track
        outEndpoint - the MIDI Endpoint target for the track API-Since: 5.0

      • MusicTrackSetProperty

        public static int MusicTrackSetProperty​(@NotNull
                                        @NotNull MusicTrack inTrack,
                                        int inPropertyID,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.VoidPtr inData,
                                        int inLength)
        [@function] MusicTrackSetProperty Sets the specified property value Property values are always get and set by reference
        Parameters:
        inTrack - the track
        inPropertyID - the property ID
        inData - the new property value
        inLength - the size of the property value being set API-Since: 5.0

      • MusicTrackGetProperty

        public static int MusicTrackGetProperty​(@NotNull
                                        @NotNull MusicTrack inTrack,
                                        int inPropertyID,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.VoidPtr outData,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.IntPtr ioLength)
        [@function] MusicTrackGetProperty Gets the specified property value If outData is NULL, then the size of the data will be passed back in ioLength This allows the client to allocate a buffer of the correct size (useful for variable length properties -- currently all properties have fixed size) Property values are always get and set by reference
        Parameters:
        inTrack - the track
        inPropertyID - the property ID
        outData - if not NULL, points to data of size ioLength
        ioLength - on input the available size of outData, on output the size of the valid data that outData will then point too. API-Since: 5.0

      • MusicTrackMoveEvents

        public static int MusicTrackMoveEvents​(@NotNull
                                       @NotNull MusicTrack inTrack,
                                       double inStartTime,
                                       double inEndTime,
                                       double inMoveTime)
        [@function] MusicTrackMoveEvents Move events in a track Moves all of the events in the specified time range by the moveTime. MoveTime maybe negative to move events backwards (towards zero). All time ranges are [starttime < endtime]
        Parameters:
        inTrack - the track
        inStartTime - the start time for the range of events
        inEndTime - the end time up to which will form the range of the events to move
        inMoveTime - amount of beats to move the selected events. API-Since: 5.0

      • MusicTrackClear

        public static int MusicTrackClear​(@NotNull
                                  @NotNull MusicTrack inTrack,
                                  double inStartTime,
                                  double inEndTime)
        [@function] MusicTrackClear Removes all events within the specified range All time ranges are [starttime < endtime]
        Parameters:
        inTrack - the track
        inStartTime - the start time for the range of events
        inEndTime - the end time up to which will form the range of the events to clear API-Since: 5.0

      • MusicTrackCut

        public static int MusicTrackCut​(@NotNull
                                @NotNull MusicTrack inTrack,
                                double inStartTime,
                                double inEndTime)
        [@function] MusicTrackCut Removes all the events within the specified range Events that fall past the specified range will be moved back by the specified range time. All time ranges are [starttime < endtime]
        Parameters:
        inTrack - the track
        inStartTime - the start time for the range of events
        inEndTime - the end time up to which will form the range of the events to cut out API-Since: 5.0

      • MusicTrackCopyInsert

        public static int MusicTrackCopyInsert​(@NotNull
                                       @NotNull MusicTrack inSourceTrack,
                                       double inSourceStartTime,
                                       double inSourceEndTime,
                                       @NotNull
                                       @NotNull MusicTrack inDestTrack,
                                       double inDestInsertTime)
        [@function] MusicTrackCopyInsert Copies events from one track and inserts them into another Copies all of the events with the specified time range of the source track. It then inserts those events into the destination track. All events at and after inDestInsertTime in inDestTrack are moved forward by the range's duration All time ranges are [starttime < endtime]
        Parameters:
        inSourceTrack - the source track
        inSourceStartTime - the start time for the range of events
        inSourceEndTime - the end time up to which will form the range of the events to copy from the source track
        inDestTrack - the destination track to copy too
        inDestInsertTime - the time at which the copied events will be inserted. API-Since: 5.0

      • MusicTrackMerge

        public static int MusicTrackMerge​(@NotNull
                                  @NotNull MusicTrack inSourceTrack,
                                  double inSourceStartTime,
                                  double inSourceEndTime,
                                  @NotNull
                                  @NotNull MusicTrack inDestTrack,
                                  double inDestInsertTime)
        [@function] MusicTrackMerge Copies events from one track and merges them into another Copies all of the events with the specified time range of the source track. It then merges those events into the destination track starting at inDestInsertTime. All time ranges are [starttime < endtime]
        Parameters:
        inSourceTrack - the source track
        inSourceStartTime - the start time for the range of events
        inSourceEndTime - the end time up to which will form the range of the events to copy from the source track
        inDestTrack - the destination track to copy too
        inDestInsertTime - the time at which the copied events will be merged. API-Since: 5.0

      • MusicTrackNewMIDINoteEvent

        public static int MusicTrackNewMIDINoteEvent​(@NotNull
                                             @NotNull MusicTrack inTrack,
                                             double inTimeStamp,
                                             @NotNull
                                             @NotNull MIDINoteMessage inMessage)
        [@function] MusicTrackNewMIDINoteEvent Adds a MIDINoteMessage event to a track The event is added at the specified time stamp. The time stamp should not be less than zero.
        Parameters:
        inTrack - the track
        inTimeStamp - the time stamp
        inMessage - the event API-Since: 5.0

      • MusicTrackNewMIDIChannelEvent

        public static int MusicTrackNewMIDIChannelEvent​(@NotNull
                                                @NotNull MusicTrack inTrack,
                                                double inTimeStamp,
                                                @NotNull
                                                @NotNull MIDIChannelMessage inMessage)
        [@function] MusicTrackNewMIDIChannelEvent Adds a MIDIChannelMessage event to a track The event is added at the specified time stamp. The time stamp should not be less than zero.
        Parameters:
        inTrack - the track
        inTimeStamp - the time stamp
        inMessage - the event API-Since: 5.0

      • MusicTrackNewMIDIRawDataEvent

        public static int MusicTrackNewMIDIRawDataEvent​(@NotNull
                                                @NotNull MusicTrack inTrack,
                                                double inTimeStamp,
                                                @NotNull
                                                @NotNull MIDIRawData inRawData)
        [@function] MusicTrackNewMIDIRawDataEvent Adds a MIDIRawData event to a track The event is added at the specified time stamp. The time stamp should not be less than zero.
        Parameters:
        inTrack - the track
        inTimeStamp - the time stamp
        inRawData - the event API-Since: 5.0

      • MusicTrackNewExtendedNoteEvent

        public static int MusicTrackNewExtendedNoteEvent​(@NotNull
                                                 @NotNull MusicTrack inTrack,
                                                 double inTimeStamp,
                                                 @NotNull
                                                 @NotNull ExtendedNoteOnEvent inInfo)
        [@function] MusicTrackNewExtendedNoteEvent Adds a ExtendedNoteOnEvent to a track The event is added at the specified time stamp. The time stamp should not be less than zero.
        Parameters:
        inTrack - the track
        inTimeStamp - the time stamp
        inInfo - the event API-Since: 5.0

      • MusicTrackNewParameterEvent

        public static int MusicTrackNewParameterEvent​(@NotNull
                                              @NotNull MusicTrack inTrack,
                                              double inTimeStamp,
                                              @NotNull
                                              @NotNull ParameterEvent inInfo)
        [@function] MusicTrackNewParameterEvent Adds a ParameterEvent to a track The event is added at the specified time stamp. The time stamp should not be less than zero.
        Parameters:
        inTrack - the track
        inTimeStamp - the time stamp
        inInfo - the event API-Since: 5.0

      • MusicTrackNewExtendedTempoEvent

        public static int MusicTrackNewExtendedTempoEvent​(@NotNull
                                                  @NotNull MusicTrack inTrack,
                                                  double inTimeStamp,
                                                  double inBPM)
        [@function] MusicTrackNewExtendedTempoEvent Adds a tempo event to a track The event is added at the specified time stamp. The time stamp should not be less than zero.
        Parameters:
        inTrack - the track
        inTimeStamp - the time stamp
        inBPM - the event API-Since: 5.0

      • MusicTrackNewMetaEvent

        public static int MusicTrackNewMetaEvent​(@NotNull
                                         @NotNull MusicTrack inTrack,
                                         double inTimeStamp,
                                         @NotNull
                                         @NotNull MIDIMetaEvent inMetaEvent)
        [@function] MusicTrackNewMetaEvent Adds a MIDIMetaEvent to a track The event is added at the specified time stamp. The time stamp should not be less than zero.
        Parameters:
        inTrack - the track
        inTimeStamp - the time stamp
        inMetaEvent - the event API-Since: 5.0

      • MusicTrackNewUserEvent

        public static int MusicTrackNewUserEvent​(@NotNull
                                         @NotNull MusicTrack inTrack,
                                         double inTimeStamp,
                                         @NotNull
                                         @NotNull MusicEventUserData inUserData)
        [@function] MusicEventUserData Adds a MusicEventUserData event to a track The event is added at the specified time stamp. The time stamp should not be less than zero.
        Parameters:
        inTrack - the track
        inTimeStamp - the time stamp
        inUserData - the event API-Since: 5.0

      • MusicTrackNewAUPresetEvent

        public static int MusicTrackNewAUPresetEvent​(@NotNull
                                             @NotNull MusicTrack inTrack,
                                             double inTimeStamp,
                                             @NotNull
                                             @NotNull AUPresetEvent inPresetEvent)
        [@function] MusicTrackNewAUPresetEvent Adds a AUPresetEvent to a track The event is added at the specified time stamp. The time stamp should not be less than zero.
        Parameters:
        inTrack - the track
        inTimeStamp - the time stamp
        inPresetEvent - the event API-Since: 5.0

      • NewMusicEventIterator

        public static int NewMusicEventIterator​(@NotNull
                                        @NotNull MusicTrack inTrack,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.Ptr<MusicEventIterator> outIterator)
        [@function] NewMusicEventIterator Creates an iterator to iterator over a track's events The iterator should be considered invalid if a track is edited. In that case you should create a new iterator and seek it to the desired position.
        Parameters:
        inTrack - the track upon which to iterate
        outIterator - the new iterator API-Since: 5.0

      • DisposeMusicEventIterator

        public static int DisposeMusicEventIterator​(@NotNull
                                            @NotNull MusicEventIterator inIterator)
        [@function] DisposeMusicEventIterator Dispose an iterator
        Parameters:
        inIterator - the iterator API-Since: 5.0

      • MusicEventIteratorSeek

        public static int MusicEventIteratorSeek​(@NotNull
                                         @NotNull MusicEventIterator inIterator,
                                         double inTimeStamp)
        [@function] MusicEventIteratorSeek Move the iterator to an event at the specified time If there is no event at the specified time, the iterator will point to the first event after that time. By specifying kMusicTimeStamp_EndOfTrack you will position the iterator to the end of track (which is pointing to the space just AFTER the last event). You can use MusicEventIteratorPreviousEvent to backup to the last event. By specifying 0, you will position the iterator at the first event
        Parameters:
        inIterator - the iterator
        inTimeStamp - the time stamp to seek too API-Since: 5.0

      • MusicEventIteratorNextEvent

        public static int MusicEventIteratorNextEvent​(@NotNull
                                              @NotNull MusicEventIterator inIterator)
        [@function] MusicEventIteratorNextEvent Move the iterator to the next event If the iterator was at the last event, then it will move past the last event and will no longer point to an event. You can use check MusicEventIteratorHasCurrentEvent to see if there is an event at the iterator's current position. See also MusicEventIteratorHasNextEvent. Typically this call is used to move the iterator forwards through the track's events.
        Parameters:
        inIterator - the iterator API-Since: 5.0

      • MusicEventIteratorPreviousEvent

        public static int MusicEventIteratorPreviousEvent​(@NotNull
                                                  @NotNull MusicEventIterator inIterator)
        [@function] MusicEventIteratorPreviousEvent Move the iterator to the previous event If the iterator was at the first event, then it will leave the iterator unchanged and return an error. See also MusicEventIteratorHasPreviousEvent Typically this call is used to move the iterator backwards through the track's events.
        Parameters:
        inIterator - the iterator API-Since: 5.0

      • MusicEventIteratorGetEventInfo

        public static int MusicEventIteratorGetEventInfo​(@NotNull
                                                 @NotNull MusicEventIterator inIterator,
                                                 @NotNull
                                                 @NotNull org.moe.natj.general.ptr.DoublePtr outTimeStamp,
                                                 @NotNull
                                                 @NotNull org.moe.natj.general.ptr.IntPtr outEventType,
                                                 @NotNull
                                                 @NotNull org.moe.natj.general.ptr.Ptr<org.moe.natj.general.ptr.ConstVoidPtr> outEventData,
                                                 @NotNull
                                                 @NotNull org.moe.natj.general.ptr.IntPtr outEventDataSize)
        [@function] MusicEventIteratorGetEventInfo Retrieves the event data at the iterator. Retrieves the event and other information from the iterator's current position. If you do not want specific information (eg, the time stamp) pass in NULL for that parameter.
        Parameters:
        inIterator - the iterator
        outTimeStamp - the time stamp of the event
        outEventType - one of kMusicEventType_XXX that indicates what kind of event type the iterator is currently pointing too
        outEventData - a reference to the event data. The type of data is described by the eventType. This data is read only and should not be edited in place.
        outEventDataSize - the size of the data referenced by outEventData API-Since: 5.0

      • MusicEventIteratorSetEventInfo

        public static int MusicEventIteratorSetEventInfo​(@NotNull
                                                 @NotNull MusicEventIterator inIterator,
                                                 int inEventType,
                                                 @NotNull
                                                 @NotNull org.moe.natj.general.ptr.ConstVoidPtr inEventData)
        [@function] MusicEventIteratorSetEventInfo Changes the type or value of an event Allows you to change either the event type, or the values of the event data, that the iterator is currently pointing too. You cannot change the event's time (to do that you should use MusicEventIteratorSetEventTime).
        Parameters:
        inIterator - the iterator
        inEventType - the new (or existing) type of the event you are changing
        inEventData - the new event data. The size and type of this event data must match the inEventType API-Since: 5.0

      • MusicEventIteratorSetEventTime

        public static int MusicEventIteratorSetEventTime​(@NotNull
                                                 @NotNull MusicEventIterator inIterator,
                                                 double inTimeStamp)
        [@function] MusicEventIteratorSetEventTime Set a new time for an event The iterator will still be pointing to the same event, but as the event will have moved, it may or may not have a next or previous event now (depending of course on the time you moved it too).
        Parameters:
        inIterator - the iterator
        inTimeStamp - the new time stamp of the event API-Since: 5.0

      • MusicEventIteratorDeleteEvent

        public static int MusicEventIteratorDeleteEvent​(@NotNull
                                                @NotNull MusicEventIterator inIterator)
        [@function] MusicEventIteratorDeleteEvent Deletes the event pointed to by the iterator The iterator will reference the next event after the event has been deleted.
        Parameters:
        inIterator - the iterator API-Since: 5.0

      • MusicEventIteratorHasPreviousEvent

        public static int MusicEventIteratorHasPreviousEvent​(@NotNull
                                                     @NotNull MusicEventIterator inIterator,
                                                     @NotNull
                                                     @NotNull org.moe.natj.general.ptr.BytePtr outHasPrevEvent)
        [@function] MusicEventIteratorHasPreviousEvent Does the track have an event previous to the event the iterator is pointing to? To use the iterator going backwards through a track: iter = New Iterator (points at first event) MusicEventIteratorSeek (iter, kMusicTimeStamp_EndOfTrack) // will point it past the last event bool hasPreviousEvent; MusicEventIteratorHasPreviousEvent (iter, &hasPreviousEvent) while (hasPreviousEvent) { MusicEventIteratorPreviousEvent (iter) // do work... MusicEventIteratorGetEventInfo (iter, ... MusicEventIteratorHasPreviousEvent (iter, &hasPreviousEvent); }
        Parameters:
        inIterator - the iterator
        outHasPrevEvent - true if there is a previous event, false if not API-Since: 5.0

      • MusicEventIteratorHasNextEvent

        public static int MusicEventIteratorHasNextEvent​(@NotNull
                                                 @NotNull MusicEventIterator inIterator,
                                                 @NotNull
                                                 @NotNull org.moe.natj.general.ptr.BytePtr outHasNextEvent)
        [@function] MusicEventIteratorHasNextEvent Does the track have an event past the event the iterator is pointing too? To use the iterator going forwards through a track: iter = New Iterator (points at first event) bool hasCurrentEvent; MusicEventIteratorHasCurrentEvent(iter, &hasCurrentEvent); while (hasCurrentEvent) { // do work... MusicEventIteratorGetEventInfo (iter, ... MusicEventIteratorNextEvent (iter) MusicEventIteratorHasCurrentEvent(iter, &hasCurrentEvent); }
        Parameters:
        inIterator - the iterator
        outHasNextEvent - true if there is a next event, false if not API-Since: 5.0

      • MusicEventIteratorHasCurrentEvent

        public static int MusicEventIteratorHasCurrentEvent​(@NotNull
                                                    @NotNull MusicEventIterator inIterator,
                                                    @NotNull
                                                    @NotNull org.moe.natj.general.ptr.BytePtr outHasCurEvent)
        [@function] MusicEventIteratorHasCurrentEvent Is there an event at the iterator's current position?
        Parameters:
        inIterator - the iterator
        outHasCurEvent - true if there is an event, false if not API-Since: 5.0

      • CAShow

        public static void CAShow​(@NotNull
                          @NotNull org.moe.natj.general.ptr.VoidPtr inObject)
        Print the internal state of an object to os_log. API-Since: 2.0

      • CAShowFile

        public static void CAShowFile​(@NotNull
                              @NotNull org.moe.natj.general.ptr.VoidPtr inObject,
                              @NotNull
                              @NotNull FILE inFile)
        Print the internal state of an object to the supplied FILE*. API-Since: 2.0

      • CopyNameFromSoundBank

        public static int CopyNameFromSoundBank​(@NotNull
                                        @NotNull CFURLRef inURL,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.Ptr<CFStringRef> outName)
        [@function] CopyNameFromSoundBank This will return the name of a sound bank from a DLS or SF2 bank. The name should be released by the caller.
        Parameters:
        inURL - The URL for the sound bank.
        outName - A pointer to a CFStringRef to be created and returned by the function.
        Returns:
        returns noErr if successful. API-Since: 7.0

      • CopyInstrumentInfoFromSoundBank

        public static int CopyInstrumentInfoFromSoundBank​(@NotNull
                                                  @NotNull CFURLRef inURL,
                                                  @NotNull
                                                  @NotNull org.moe.natj.general.ptr.Ptr<CFArrayRef> outInstrumentInfo)
        [@function] CopyInstrumentInfoFromSoundBank This will return a CFArray of CFDictionaries, one per instrument found in the DLS or SF2 bank. Each dictionary will contain four items accessed via CFStringRef versions of the keys kInstrumentInfoKey_MSB, kInstrumentInfoKey_LSB, kInstrumentInfoKey_Program, and kInstrumentInfoKey_Name. MSB: An NSNumberRef for the most-significant byte of the bank number. GM melodic banks will return 120 (0x78). GM percussion banks will return 121 (0x79). Custom banks will return their literal value. LSB: An NSNumberRef for the least-significant byte of the bank number. All GM banks will return the bank variation number (0-127). Program Number: An NSNumberRef for the program number (0-127) of an instrument within a particular bank. Name: A CFStringRef containing the name of the instrument. Using these MSB, LSB, and Program values will guarantee that the correct instrument is loaded by the DLS synth or Sampler Audio Unit. The CFArray should be released by the caller.
        Parameters:
        inURL - The URL for the sound bank.
        outInstrumentInfo - A pointer to a CFArrayRef to be created and returned by the function.
        Returns:
        returns noErr if successful. API-Since: 7.0

      • kAudioComponentRegistrationsChangedNotification

        @NotNull
public static @NotNull CFStringRef kAudioComponentRegistrationsChangedNotification()
        [@constant] kAudioComponentRegistrationsChangedNotification Notification generated when the set of available AudioComponents changes. Register for this notification name with `[NSNotificationCenter defaultCenter]` or `CFNotificationCenterGetLocalCenter()`, using an object of NULL. API-Since: 7.0

      • kAudioComponentInstanceInvalidationNotification

        @NotNull
public static @NotNull CFStringRef kAudioComponentInstanceInvalidationNotification()
        [@constant] kAudioComponentInstanceInvalidationNotification Notification generated when the connection to an audio unit extension process is invalidated. Register for this notification name with `[NSNotificationCenter defaultCenter]` or `CFNotificationCenterGetLocalCenter()`. The "object" refers to an AUAudioUnit instance to be observed, or can be nil to observe all instances. This notification can happen for several reasons, for instance the connection being invalidated or the process abnormally ending. There can be multiple notifications for the same event (i.e. a terminated process will also invalidate the connection). The notification's userInfo dictionary may contain the following keys, depending on the reason for the invalidation and the platform in which it's running:

      • kAudioSession_RouteChangeKey_Reason

        @Deprecated
public static CFStringRef kAudioSession_RouteChangeKey_Reason()
        Deprecated.
        CFString version of kAudioSession_AudioRouteChangeKey_Reason. This is more convenient to use than the raw string version. Available in iOS 5.0 or greater API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSession_AudioRouteChangeKey_PreviousRouteDescription

        @Deprecated
public static CFStringRef kAudioSession_AudioRouteChangeKey_PreviousRouteDescription()
        Deprecated.
        CFDictionary keys for kAudioSessionProperty_AudioRouteChange Available in iOS 5.0 or greater API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSession_AudioRouteChangeKey_CurrentRouteDescription

        @Deprecated
public static CFStringRef kAudioSession_AudioRouteChangeKey_CurrentRouteDescription()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSession_AudioRouteKey_Inputs

        @Deprecated
public static CFStringRef kAudioSession_AudioRouteKey_Inputs()
        Deprecated.
        CFDictionary keys for kAudioSessionProperty_AudioRouteDescription Available in iOS 5.0 or greater API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSession_AudioRouteKey_Outputs

        @Deprecated
public static CFStringRef kAudioSession_AudioRouteKey_Outputs()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSession_AudioRouteKey_Type

        @Deprecated
public static CFStringRef kAudioSession_AudioRouteKey_Type()
        Deprecated.
        key(s) for the CFDictionary associated with each entry of the CFArrays returned by kAudioSession_AudioRouteKey_Inputs and kAudioSession_AudioRouteKey_Outputs. Available in iOS 5.0 or greater API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSessionInputRoute_LineIn

        @Deprecated
public static CFStringRef kAudioSessionInputRoute_LineIn()
        Deprecated.
        [@enum] AudioSession route input types These are the strings used with the kAudioSession_AudioRouteKey_Type key for the CFDictionary associated with kAudioSession_AudioRouteKey_Inputs. Available in iOS 5.0 or greater [@constant] kAudioSessionInputRoute_LineIn A line in input [@constant] kAudioSessionInputRoute_BuiltInMic A built-in microphone input. (Note that some devices like early iPods do not have this input) [@constant] kAudioSessionInputRoute_HeadsetMic A microphone that is part of a headset (combined microphone and headphones) [@constant] kAudioSessionInputRoute_BluetoothHFP A microphone that is part of a Bluetooth Hands-Free Profile device [@constant] kAudioSessionInputRoute_USBAudio A Universal Serial Bus input API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSessionInputRoute_BuiltInMic

        @Deprecated
public static CFStringRef kAudioSessionInputRoute_BuiltInMic()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSessionInputRoute_HeadsetMic

        @Deprecated
public static CFStringRef kAudioSessionInputRoute_HeadsetMic()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSessionInputRoute_BluetoothHFP

        @Deprecated
public static CFStringRef kAudioSessionInputRoute_BluetoothHFP()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSessionInputRoute_USBAudio

        @Deprecated
public static CFStringRef kAudioSessionInputRoute_USBAudio()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSessionOutputRoute_LineOut

        @Deprecated
public static CFStringRef kAudioSessionOutputRoute_LineOut()
        Deprecated.
        [@enum] AudioSession route output types These are strings used with the kAudioSession_AudioRouteKey_Type key for the CFDictionary associated with kAudioSession_AudioRouteKey_Outputs. Available in iOS 5.0 or greater [@constant] kAudioSessionOutputRoute_LineOut A line out output [@constant] kAudioSessionOutputRoute_Headphones Speakers in a headset (mic and headphones) or simple headphones [@constant] kAudioSessionOutputRoute_BluetoothHFP Speakers that are part of a Bluetooth Hands-Free Profile device [@constant] kAudioSessionOutputRoute_BluetoothA2DP Speakers in a Bluetooth A2DP device [@constant] kAudioSessionOutputRoute_BuiltInReceiver The speaker you hold to your ear when on a phone call [@constant] kAudioSessionOutputRoute_BuiltInSpeaker The built-in speaker [@constant] kAudioSessionOutputRoute_USBAudio Speaker(s) in a Universal Serial Bus device [@constant] kAudioSessionOutputRoute_HDMI Output via High-Definition Multimedia Interface [@constant] kAudioSessionOutputRoute_AirPlay Output on a remote Air Play device API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSessionOutputRoute_Headphones

        @Deprecated
public static CFStringRef kAudioSessionOutputRoute_Headphones()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSessionOutputRoute_BluetoothHFP

        @Deprecated
public static CFStringRef kAudioSessionOutputRoute_BluetoothHFP()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSessionOutputRoute_BluetoothA2DP

        @Deprecated
public static CFStringRef kAudioSessionOutputRoute_BluetoothA2DP()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSessionOutputRoute_BuiltInReceiver

        @Deprecated
public static CFStringRef kAudioSessionOutputRoute_BuiltInReceiver()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSessionOutputRoute_BuiltInSpeaker

        @Deprecated
public static CFStringRef kAudioSessionOutputRoute_BuiltInSpeaker()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSessionOutputRoute_USBAudio

        @Deprecated
public static CFStringRef kAudioSessionOutputRoute_USBAudio()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSessionOutputRoute_HDMI

        @Deprecated
public static CFStringRef kAudioSessionOutputRoute_HDMI()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSessionOutputRoute_AirPlay

        @Deprecated
public static CFStringRef kAudioSessionOutputRoute_AirPlay()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSession_InputSourceKey_ID

        @Deprecated
public static CFStringRef kAudioSession_InputSourceKey_ID()
        Deprecated.
        CFDictionary keys for kAudioSessionProperty_InputSources API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSession_InputSourceKey_Description

        @Deprecated
public static CFStringRef kAudioSession_InputSourceKey_Description()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSession_OutputDestinationKey_ID

        @Deprecated
public static CFStringRef kAudioSession_OutputDestinationKey_ID()
        Deprecated.
        CFDictionary keys for kAudioSessionProperty_OutputDestinations API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • kAudioSession_OutputDestinationKey_Description

        @Deprecated
public static CFStringRef kAudioSession_OutputDestinationKey_Description()
        Deprecated.
        API-Since: 5.0 Deprecated-Since: 7.0 Deprecated-Message: no longer supported

      • AudioUnitExtensionSetComponentList

        public static int AudioUnitExtensionSetComponentList​(@NotNull
                                                     @NotNull CFStringRef extensionIdentifier,
                                                     @Nullable
                                                     @Nullable CFArrayRef audioComponentInfo)
        [@function] AudioUnitExtensionSetComponentList Allows the implementor of an audio unit extension to dynamically modify the list of component registrations for the extension. Note that the bundle ID of the process calling this API must prefix (or match) the provided extension identifier. API-Since: 11.0
        Parameters:
        extensionIdentifier - The bundle ID of the audio unit extension.
        audioComponentInfo - An array of dictionaries, one for each component, in the same format as described in AudioComponent.h for the Info.plist key "AudioComponents".
        Returns:
        An OSStatus result code.

      • AudioUnitExtensionCopyComponentList

        @Nullable
public static @Nullable CFArrayRef AudioUnitExtensionCopyComponentList​(@NotNull
                                                                       @NotNull CFStringRef extensionIdentifier)
        [@function] AudioUnitExtensionCopyComponentList Returns the component registrations for a given audio unit extension.
        Parameters:
        extensionIdentifier - The bundle ID of the audio unit extension.
        Returns:
        An array of dictionaries, one for each component, in the same format as described in AudioComponent.h for the Info.plist key "AudioComponents". The caller should release this value when done with it. API-Since: 11.0

      • AudioCodecGetPropertyInfo

        public static int AudioCodecGetPropertyInfo​(@NotNull
                                            @NotNull AudioComponentInstance inCodec,
                                            int inPropertyID,
                                            @Nullable
                                            @Nullable org.moe.natj.general.ptr.IntPtr outSize,
                                            @Nullable
                                            @Nullable org.moe.natj.general.ptr.BytePtr outWritable)
        [@function] AudioCodecGetPropertyInfo Retrieve information about the given property. The outSize argument will return the size in bytes of the current value of the property. The outWritable argument will return whether or not the property in question can be changed.
        Parameters:
        inCodec - An AudioCodec instance
        inPropertyID - Property ID whose value should be read
        outSize - Size in bytes of the property
        outWritable - Flag indicating wether the underlying property can be modified or not
        Returns:
        The OSStatus value API-Since: 2.0

      • AudioCodecGetProperty

        public static int AudioCodecGetProperty​(@NotNull
                                        @NotNull AudioComponentInstance inCodec,
                                        int inPropertyID,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.IntPtr ioPropertyDataSize,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.VoidPtr outPropertyData)
        [@function] AudioCodecGetProperty Retrieve the indicated property data. On input, ioDataSize has the size of the data pointed to by outPropertyData. On output, ioDataSize will contain the amount written.
        Parameters:
        inCodec - An AudioCodec instance
        inPropertyID - Property ID whose value should be read
        ioPropertyDataSize - Size in bytes of the property data
        outPropertyData - Pointer to the property data buffer
        Returns:
        The OSStatus value API-Since: 2.0

      • AudioCodecSetProperty

        public static int AudioCodecSetProperty​(@NotNull
                                        @NotNull AudioComponentInstance inCodec,
                                        int inPropertyID,
                                        int inPropertyDataSize,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.ConstVoidPtr inPropertyData)
        [@function] AudioCodecSetProperty Set the indicated property data.
        Parameters:
        inCodec - An AudioCodec instance
        inPropertyID - Property ID whose value should be changed
        inPropertyDataSize - Size in bytes of the property data
        inPropertyData - Pointer to the property data buffer
        Returns:
        The OSStatus value API-Since: 2.0

      • AudioCodecInitialize

        public static int AudioCodecInitialize​(@NotNull
                                       @NotNull AudioComponentInstance inCodec,
                                       @Nullable
                                       @Nullable AudioStreamBasicDescription inInputFormat,
                                       @Nullable
                                       @Nullable AudioStreamBasicDescription inOutputFormat,
                                       @Nullable
                                       @Nullable org.moe.natj.general.ptr.ConstVoidPtr inMagicCookie,
                                       int inMagicCookieByteSize)
        [@function] AudioCodecInitialize This call will allocate any buffers needed and otherwise set the codec up to perform the indicated translation. If an argument is NULL, any previously set properties will be used for preparing the codec for work. Note that this routine will also validate the format information as useable.
        Parameters:
        inCodec - An AudioCodec instance
        inInputFormat - Pointer to an input format structure
        inOutputFormat - Pointer to an output format structure
        inMagicCookie - Pointer to the magic cookie
        inMagicCookieByteSize - Size in bytes of the magic cookie
        Returns:
        The OSStatus value API-Since: 2.0

      • AudioCodecUninitialize

        public static int AudioCodecUninitialize​(@NotNull
                                         @NotNull AudioComponentInstance inCodec)
        [@function] AudioCodecUninitialize This call will move the codec from the initialized state back to the uninitialized state. The codec will release any resources it allocated or claimed in AudioCodecInitialize.
        Parameters:
        inCodec - An AudioCodec instance
        Returns:
        The OSStatus value API-Since: 2.0

      • AudioCodecAppendInputData

        public static int AudioCodecAppendInputData​(@NotNull
                                            @NotNull AudioComponentInstance inCodec,
                                            @NotNull
                                            @NotNull org.moe.natj.general.ptr.ConstVoidPtr inInputData,
                                            @NotNull
                                            @NotNull org.moe.natj.general.ptr.IntPtr ioInputDataByteSize,
                                            @NotNull
                                            @NotNull org.moe.natj.general.ptr.IntPtr ioNumberPackets,
                                            @Nullable
                                            @Nullable AudioStreamPacketDescription inPacketDescription)
        [@function] AudioCodecAppendInputData Append as much of the given data in inInputData to the codec's input buffer as possible and return in ioInputDataByteSize the amount of data used. The inPacketDescription argument is an array of AudioStreamPacketDescription structs that describes the packet layout. The number of elements in this array is indicated on input by ioNumberPackets. On return, this number indicates the number of packets consumed. Note also in this case that it is an error to supply less than a full packet of data at a time.
        Parameters:
        inCodec - An AudioCodec instance
        inInputData - A const pointer to the input data
        ioInputDataByteSize - The size in bytes of the input data in inInputData on input, the number of bytes consumed on output
        ioNumberPackets - The number of packets
        inPacketDescription - The packet description pointer
        Returns:
        The OSStatus value API-Since: 2.0

      • AudioCodecProduceOutputPackets

        public static int AudioCodecProduceOutputPackets​(@NotNull
                                                 @NotNull AudioComponentInstance inCodec,
                                                 @NotNull
                                                 @NotNull org.moe.natj.general.ptr.VoidPtr outOutputData,
                                                 @NotNull
                                                 @NotNull org.moe.natj.general.ptr.IntPtr ioOutputDataByteSize,
                                                 @NotNull
                                                 @NotNull org.moe.natj.general.ptr.IntPtr ioNumberPackets,
                                                 @Nullable
                                                 @Nullable AudioStreamPacketDescription outPacketDescription,
                                                 @NotNull
                                                 @NotNull org.moe.natj.general.ptr.IntPtr outStatus)
        [@function] AudioCodecProduceOutputPackets Produce as many output packets as requested and the amount of input data allows for. The outStatus argument returns information about the codec's status to allow for proper data management. See the constants above for the possible values that can be returned. The outPacketDescription argument is an array of AudioStreamPacketDescription structs that describes the packet layout returned in outOutputData. This argument is optional. Pass NULL if this information is not to be returned. Note that this information is only provided when the output format isn't linear PCM. Note that decoders will always only produce linear PCM data in multiples of the number frames in a packet of the encoded format (as returned by kAudioCodecPropertyPacketFrameSize). Encoders will consume this many frames of linear PCM data to produce a packet of their format.
        Parameters:
        inCodec - The AudioCodec instance
        outOutputData - Pointer to the output data buffer
        ioOutputDataByteSize - A pointer to the size
        ioNumberPackets - number of input/output packets
        Returns:
        The OSStatus value API-Since: 2.0

      • AudioCodecAppendInputBufferList

        public static int AudioCodecAppendInputBufferList​(@NotNull
                                                  @NotNull AudioComponentInstance inCodec,
                                                  @NotNull
                                                  @NotNull AudioBufferList inBufferList,
                                                  @NotNull
                                                  @NotNull org.moe.natj.general.ptr.IntPtr ioNumberPackets,
                                                  @Nullable
                                                  @Nullable AudioStreamPacketDescription inPacketDescription,
                                                  @NotNull
                                                  @NotNull org.moe.natj.general.ptr.IntPtr outBytesConsumed)
        API-Since: 4.0

      • AudioCodecProduceOutputBufferList

        public static int AudioCodecProduceOutputBufferList​(@NotNull
                                                    @NotNull AudioComponentInstance inCodec,
                                                    @NotNull
                                                    @NotNull AudioBufferList ioBufferList,
                                                    @NotNull
                                                    @NotNull org.moe.natj.general.ptr.IntPtr ioNumberPackets,
                                                    @Nullable
                                                    @Nullable AudioStreamPacketDescription outPacketDescription,
                                                    @NotNull
                                                    @NotNull org.moe.natj.general.ptr.IntPtr outStatus)
        API-Since: 4.0

      • AudioCodecReset

        public static int AudioCodecReset​(@NotNull
                                  @NotNull AudioComponentInstance inCodec)
        [@function] AudioCodecReset Flushes all the data in the codec and clears the input buffer. Note that the formats, and magic cookie will be retained so they won't need to be set up again to decode the same data.
        Parameters:
        inCodec - The audio codec descriptor
        Returns:
        the OSStatus value API-Since: 2.0

      • AudioComponentCopyIcon

        @Nullable
public static @Nullable UIImage AudioComponentCopyIcon​(@NotNull
                                                       @NotNull AudioComponent comp)
        [@function] AudioComponentCopyIcon Fetches an icon representing the component. For a component originating in an app extension, the returned icon will be that of the application containing the extension. For components loaded from bundles, the icon will be that of the bundle. The caller is responsible to release this value when done with it. API-Since: 14.0
        Parameters:
        comp - The component whose icon data is to be retrieved.
        Returns:
        A retained UIImage object.

      • AudioWorkIntervalCreate

        @NotNull
public static @NotNull os_workgroup_t AudioWorkIntervalCreate​(@NotNull
                                                              @NotNull java.lang.String name,
                                                              int clock,
                                                              @Nullable
                                                              @Nullable os_workgroup_attr_opaque_s attr)
        [@fn] AudioWorkIntervalCreate Create an OS workgroup interval for use with audio realtime threads.
        Parameters:
        name - A name for the created work interval.
        clock - The clockid in which interval timestamps are specified, e.g. `OS_CLOCK_MACH_ABSOLUTE_TIME` from .
        attr - This field is currently not used and should be NULL.
        Returns:
        A new os_workgroup_interval_t. The client should call `os_workgroup_interval_start()` and `os_workgroup_interval_finish()` to notify the system of the beginning and ending of each work duty cycle. The caller is responsible for releasing this object when finished with it (if not using automatic reference counting). API-Since: 14.0

      • MusicDeviceMIDIEventList

        public static int MusicDeviceMIDIEventList​(@NotNull
                                           @NotNull AudioComponentInstance inUnit,
                                           int inOffsetSampleFrame,
                                           @NotNull
                                           @NotNull MIDIEventList evtList)
        [@function] MusicDeviceMIDIEventList Used to send MIDI messages to an audio unit This API is suitable for sending Universal MIDI Packet (UMP) MIDI messages to an audio unit. The message must be a full non-SysEx event, a partial SysEx event, or a complete SysEx event. Running status is not allowed. MIDI 1.0 in universal packets (MIDI-1UP) and MIDI 2.0 messages are allowed. All events sent via MusicDeviceMIDIEventList will be delivered to the audio unit in the MIDI protocol returned by kAudioUnitProperty_AudioUnitMIDIProtocol. This is bridged to the v2 API property kAudioUnitProperty_MIDIOutputCallback.
        Parameters:
        inUnit - The audio unit
        inOffsetSampleFrame - If you are scheduling the MIDIEventList from the audio unit's render thread, then you can supply a sample offset that the audio unit may apply within its next audio unit render. This allows you to schedule to the sample, the time when a MIDI command is applied and is particularly important when starting new notes. If you are not scheduling in the audio unit's render thread, then you should set this value to 0 inOffsetSampleFrame should serve as the base offset for each packet's timestamp i.e. sampleOffset = inOffsetSampleFrame + evtList.packet[0].timeStamp
        evtList - The MIDIEventList to be sent
        Returns:
        noErr, or an audio unit error code API-Since: 15.0

      • AudioComponentCopyConfigurationInfo

        public static int AudioComponentCopyConfigurationInfo​(@NotNull
                                                      @NotNull AudioComponent inComponent,
                                                      @NotNull
                                                      @NotNull org.moe.natj.general.ptr.Ptr<CFDictionaryRef> outConfigurationInfo)
        [@function] AudioComponentCopyConfigurationInfo Fetches the basic configuration info about a given AudioComponent Currently, only AudioUnits can supply this information.
        Parameters:
        inComponent - The AudioComponent whose info is being fetched.
        outConfigurationInfo - On exit, this is CFDictionaryRef that contains information describing the capabilities of the AudioComponent. The specific information depends on the type of AudioComponent. The keys for the dictionary are defined in AudioUnitProperties.h (or other headers as appropriate for the component type).
        Returns:
        An OSStatus indicating success or failure. API-Since: 16.0

      • AudioComponentValidate

        public static int AudioComponentValidate​(@NotNull
                                         @NotNull AudioComponent inComponent,
                                         @Nullable
                                         @Nullable CFDictionaryRef inValidationParameters,
                                         @NotNull
                                         @NotNull org.moe.natj.general.ptr.IntPtr outValidationResult)
        API-Since: 16.0

      • AudioComponentValidateWithResults

        public static int AudioComponentValidateWithResults​(@NotNull
                                                    @NotNull AudioComponent inComponent,
                                                    @Nullable
                                                    @Nullable CFDictionaryRef inValidationParameters,
                                                    @NotNull
                                                    @NotNull AudioToolbox.Block_AudioComponentValidateWithResults inCompletionHandler)
        [@function] AudioComponentValidateWithResults Tests a specified AudioComponent for API and behavioral conformance asynchronously, returning detailed validation results. Currently, only AudioUnits can can be validated. The `inCompletionHandler` callback has two parameters, an `AudioComponentValidationResult` with result of the validation, and a `CFDictionaryRef` which contains the details of this result. This dictionary may contain the following entries: "Output" An array of strings, with the same content as if the AU was validated on auval. "Result" An `AudioComponentValidationResult` with the result of the validation process. The same as what's in the `AudioComponentValidationResult` in the `inCompletionHandler` and what `AudioComponentValidate` currently returns. "Tests" An array in which each value is a dictionary and may contain: "Name" A descriptive name of the test. "Result" An `AudioComponentValidationResult` with the result of the specific test. "Output" An array of strings with output generated by the test. "WasCached" `YES` if the returned result was cached from previous runs.
        Parameters:
        inComponent - The AudioComponent to validate.
        inValidationParameters - A CFDictionaryRef that contains parameters for the validation operation. Passing NULL for this argument tells the system to use the default parameters.
        inCompletionHandler - Completion callback. See discussion section.
        Returns:
        an OSStatus result code. API-Since: 16.0

      • AUListenerCreateWithDispatchQueue

        public static int AUListenerCreateWithDispatchQueue​(@NotNull
                                                    @NotNull org.moe.natj.general.ptr.Ptr<AUParameterListenerRef> outListener,
                                                    float inNotificationInterval,
                                                    @NotNull
                                                    @NotNull dispatch_queue_t inDispatchQueue,
                                                    @NotNull
                                                    @NotNull AudioToolbox.Block_AUListenerCreateWithDispatchQueue inBlock)
        [@function] AUListenerCreateWithDispatchQueue Create an object for fielding notifications when AudioUnit parameter values change. Note that only parameter changes issued through AUParameterSet will generate notifications to listeners; thus, in most cases, AudioUnit clients should use AUParameterSet in preference to AudioUnitSetParameterValue. API-Since: 6.0
        Parameters:
        outListener - On successful return, an AUParameterListenerRef.
        inNotificationInterval - The minimum time interval, in seconds, at which the callback will be called. If multiple parameter value changes occur within this time interval, the listener will only receive a notification for the last value change that occurred before the callback. If inNotificationInterval is 0, the inRunLoop and inRunLoopMode arguments are ignored, and the callback will be issued immediately, on the thread on which the parameter was changed.
        inDispatchQueue - Dispatch queue on which the callback is called.
        inBlock - Block called when the parameter's value changes.

      • AUListenerCreate

        public static int AUListenerCreate​(@NotNull
                                   @NotNull AudioToolbox.Function_AUListenerCreate inProc,
                                   @NotNull
                                   @NotNull org.moe.natj.general.ptr.VoidPtr inUserData,
                                   @Nullable
                                   @Nullable CFRunLoopRef inRunLoop,
                                   @Nullable
                                   @Nullable CFStringRef inRunLoopMode,
                                   float inNotificationInterval,
                                   @NotNull
                                   @NotNull org.moe.natj.general.ptr.Ptr<AUParameterListenerRef> outListener)
        [@function] AUListenerCreate Create an object for fielding notifications when AudioUnit parameter values change. Note that only parameter changes issued through AUParameterSet will generate notifications to listeners; thus, in most cases, AudioUnit clients should use AUParameterSet in preference to AudioUnitSetParameter. API-Since: 6.0
        Parameters:
        inProc - Function called when the parameter's value changes.
        inUserData - A reference value for the use of the callback function.
        inRunLoop - The run loop on which the callback is called. If NULL, CFRunLoopGetCurrent() is used.
        inRunLoopMode - The run loop mode in which the callback's underlying run loop source will be attached. If NULL, kCFRunLoopDefaultMode is used.
        inNotificationInterval - The minimum time interval, in seconds, at which the callback will be called. If multiple parameter value changes occur within this time interval, the listener will only receive a notification for the last value change that occurred before the callback. If inNotificationInterval is 0, the inRunLoop and inRunLoopMode arguments are ignored, and the callback will be issued immediately, on the thread on which the parameter was changed.
        outListener - On successful return, an AUParameterListenerRef.

      • AUListenerDispose

        public static int AUListenerDispose​(@NotNull
                                    @NotNull AUParameterListenerRef inListener)
        [@function] AUListenerDispose Dispose a parameter listener object.
        Parameters:
        inListener - The parameter listener to dispose. API-Since: 6.0

      • AUListenerAddParameter

        public static int AUListenerAddParameter​(@NotNull
                                         @NotNull AUParameterListenerRef inListener,
                                         @Nullable
                                         @Nullable org.moe.natj.general.ptr.VoidPtr inObject,
                                         @NotNull
                                         @NotNull AudioUnitParameter inParameter)
        [@function] AUListenerAddParameter Connect a parameter to a listener. Associates an arbitrary object (often a user interface widget) with an AudioUnitParameter, and delivers notifications to the specified listener, telling it that the object needs to be informed of the parameter's value change. API-Since: 6.0
        Parameters:
        inListener - The parameter listener which will receive the callback.
        inObject - The object which is interested in the value of the parameter. This will be passed as the inObject parameter to the listener callback function when the parameter changes.
        inParameter - The parameter whose value changes are to generate callbacks.

      • AUListenerRemoveParameter

        public static int AUListenerRemoveParameter​(@NotNull
                                            @NotNull AUParameterListenerRef inListener,
                                            @Nullable
                                            @Nullable org.moe.natj.general.ptr.VoidPtr inObject,
                                            @NotNull
                                            @NotNull AudioUnitParameter inParameter)
        [@function] AUListenerRemoveParameter Remove a parameter/listener connection.
        Parameters:
        inListener - The parameter listener to stop receiving callbacks.
        inObject - The object which is no longer interested in the value of the parameter.
        inParameter - The parameter whose value changes are to stop generating callbacks. API-Since: 6.0

      • AUParameterSet

        public static int AUParameterSet​(@Nullable
                                 @Nullable AUParameterListenerRef inSendingListener,
                                 @Nullable
                                 @Nullable org.moe.natj.general.ptr.VoidPtr inSendingObject,
                                 @NotNull
                                 @NotNull AudioUnitParameter inParameter,
                                 float inValue,
                                 int inBufferOffsetInFrames)
        [@function] AUParameterSet Set an AudioUnit parameter value and notify listeners. Calls AudioUnitSetParameter, and performs/schedules notification callbacks to all parameter listeners, for that parameter -- except that no callback will be generated to the inListener/inObject pair. API-Since: 6.0
        Parameters:
        inSendingListener - A parameter listener generating the change and which does not want to receive a callback as a result of it. May be NULL.
        inSendingObject - The object generating the change and which does not want to receive a callback as a result of it. NULL is treated specially when inListener is non-null; it signifies that none of the specified listener's objects will receive notifications.
        inParameter - The parameter being changed.
        inValue - The new value of the parameter.
        inBufferOffsetInFrames - The offset into the next rendered buffer at which the parameter change will take effect.

      • AUParameterListenerNotify

        public static int AUParameterListenerNotify​(@Nullable
                                            @Nullable AUParameterListenerRef inSendingListener,
                                            @Nullable
                                            @Nullable org.moe.natj.general.ptr.VoidPtr inSendingObject,
                                            @NotNull
                                            @NotNull AudioUnitParameter inParameter)
        [@function] AUParameterListenerNotify Notify listeners of a past parameter change. Performs and schedules the notification callbacks of AUParameterSet, without actually setting an AudioUnit parameter value. Clients scheduling ramped parameter changes to AudioUnits must make this call dynamically during playback in order for AudioUnitViews to be updated. When the view's listener receives a notification, it will be passed the current value of the parameter. A special meaning is applied if the mParameterID value of inParameter is equal to kAUParameterListener_AnyParameter. In this case, ANY listener for ANY parameter value changes on the specified AudioUnit will be notified of the current value of that parameter. API-Since: 6.0
        Parameters:
        inSendingListener - A parameter listener generating the change and which does not want to receive a callback as a result of it. May be NULL.
        inSendingObject - The object generating the change and which does not want to receive a callback as a result of it. NULL is treated specially when inListener is non-null; it signifies that none of the specified listener's objects will receive notifications.
        inParameter - The parameter which was changed.

      • AUEventListenerCreateWithDispatchQueue

        public static int AUEventListenerCreateWithDispatchQueue​(@NotNull
                                                         @NotNull org.moe.natj.general.ptr.Ptr<AUParameterListenerRef> outListener,
                                                         float inNotificationInterval,
                                                         float inValueChangeGranularity,
                                                         @NotNull
                                                         @NotNull dispatch_queue_t inDispatchQueue,
                                                         @NotNull
                                                         @NotNull AudioToolbox.Block_AUEventListenerCreateWithDispatchQueue inBlock)
        [@function] AUEventListenerCreateWithDispatchQueue Creates an Audio Unit event listener. AUEventListener is a specialization of AUParameterListener; use AUListenerDispose to dispose of an AUEventListener. You may use AUListenerAddParameter and AUListenerRemoveParameter with AUEventListerRef's, in addition to AUEventListenerAddEventType / AUEventListenerRemoveEventType. Some examples illustrating inNotificationInterval and inValueChangeGranularity: [1] a UI receiver: inNotificationInterval = 100 ms, inValueChangeGranularity = 100 ms. User interfaces almost never care about previous values, only the current one, and don't wish to perform redraws too often. [2] An automation recorder: inNotificationInterval = 200 ms, inValueChangeGranularity = 10 ms. Automation systems typically wish to record events with a high degree of timing precision, but do not need to be woken up for each event. In case [1], the listener will be called within 100 ms (the notification interval) of an event. It will only receive one notification for any number of value changes to the parameter concerned, occurring within a 100 ms window (the granularity). In case [2], the listener will be received within 200 ms (the notification interval) of an event It can receive more than one notification per parameter, for the last of each group of value changes occurring within a 10 ms window (the granularity). In both cases, thread scheduling latencies may result in more events being delivered to the listener callback than the theoretical maximum (notification interval / granularity). API-Since: 6.0
        Parameters:
        outListener - On successful return, an AUEventListenerRef.
        inNotificationInterval - The minimum time interval, in seconds, at which the callback will be called.
        inValueChangeGranularity - Determines how parameter value changes occurring within this interval are queued; when an event follows a previous one by a smaller time interval than the granularity, then the listener will only be notified for the second parameter change.
        inDispatchQueue - The dispatch queue on which the callback is called.
        inBlock - Block called when an event occurs.

      • AUEventListenerCreate

        public static int AUEventListenerCreate​(@NotNull
                                        @NotNull AudioToolbox.Function_AUEventListenerCreate inProc,
                                        @Nullable
                                        @Nullable org.moe.natj.general.ptr.VoidPtr inUserData,
                                        @Nullable
                                        @Nullable CFRunLoopRef inRunLoop,
                                        @Nullable
                                        @Nullable CFStringRef inRunLoopMode,
                                        float inNotificationInterval,
                                        float inValueChangeGranularity,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.Ptr<AUParameterListenerRef> outListener)
        [@function] AUEventListenerCreate Creates an Audio Unit event listener. See the discussion of AUEventListenerCreateWithDispatchQueue. API-Since: 6.0
        Parameters:
        inProc - Function called when an event occurs.
        inUserData - A reference value for the use of the callback function.
        inRunLoop - The run loop on which the callback is called. If NULL, CFRunLoopGetCurrent() is used.
        inRunLoopMode - The run loop mode in which the callback's underlying run loop source will be attached. If NULL, kCFRunLoopDefaultMode is used.
        inNotificationInterval - The minimum time interval, in seconds, at which the callback will be called.
        inValueChangeGranularity - Determines how parameter value changes occurring within this interval are queued; when an event follows a previous one by a smaller time interval than the granularity, then the listener will only be notified for the second parameter change.
        outListener - On successful return, an AUEventListenerRef.

      • AUEventListenerAddEventType

        public static int AUEventListenerAddEventType​(@NotNull
                                              @NotNull AUParameterListenerRef inListener,
                                              @Nullable
                                              @Nullable org.moe.natj.general.ptr.VoidPtr inObject,
                                              @NotNull
                                              @NotNull org.moe.natj.general.ptr.VoidPtr inEvent)
        [@function] AUEventListenerAddEventType Begin delivering a particular type of events to a listener.
        Parameters:
        inListener - The parameter listener which will receive the events.
        inObject - The object which is interested in the value of the parameter. This will be passed as the inObject parameter to the listener callback function when the parameter changes.
        inEvent - The type of event to listen for.
        Returns:
        An OSStatus error code. API-Since: 6.0

      • AUEventListenerRemoveEventType

        public static int AUEventListenerRemoveEventType​(@NotNull
                                                 @NotNull AUParameterListenerRef inListener,
                                                 @Nullable
                                                 @Nullable org.moe.natj.general.ptr.VoidPtr inObject,
                                                 @NotNull
                                                 @NotNull org.moe.natj.general.ptr.VoidPtr inEvent)
        [@function] AUEventListenerRemoveEventType Stop delivering a particular type of events to a listener.
        Parameters:
        inListener - The parameter listener to stop receiving events.
        inObject - The object which is no longer interested in the value of the parameter.
        inEvent - The type of event to stop listening for.
        Returns:
        An OSStatus error code. API-Since: 6.0

      • AUEventListenerNotify

        public static int AUEventListenerNotify​(@Nullable
                                        @Nullable AUParameterListenerRef inSendingListener,
                                        @Nullable
                                        @Nullable org.moe.natj.general.ptr.VoidPtr inSendingObject,
                                        @NotNull
                                        @NotNull org.moe.natj.general.ptr.VoidPtr inEvent)
        [@function] AUEventListenerNotify Deliver an AudioUnitEvent to all listeners registered to receive it. This is only to be used for notifications about parameter changes (and gestures). It can not be used for notifying changes to property values as these are internal to an audio unit and should not be issued outside of the audio unit itself.
        Parameters:
        inSendingListener - A parameter listener generating the change and which does not want to receive a callback as a result of it. May be NULL.
        inSendingObject - The object generating the change and which does not want to receive a callback as a result of it. NULL is treated specially when inListener is non-null; it signifies that none of the specified listener's objects will receive notifications.
        inEvent - The event to be delivered.
        Returns:
        An OSStatus error code. API-Since: 6.0

      • AUParameterValueFromLinear

        public static float AUParameterValueFromLinear​(float inLinearValue,
                                               @NotNull
                                               @NotNull AudioUnitParameter inParameter)
        [@function] AUParameterValueFromLinear Converts a linear value to a parameter value according to the parameter's units.
        Parameters:
        inLinearValue - The linear value (0.0-1.0) to convert.
        inParameter - The parameter, including its Audio Unit, that will define the conversion of the supplied linear value to a value that is natural to that parameter.
        Returns:
        The converted parameter value, in the parameter's natural units. API-Since: 6.0

      • AUParameterValueToLinear

        public static float AUParameterValueToLinear​(float inParameterValue,
                                             @NotNull
                                             @NotNull AudioUnitParameter inParameter)
        [@function] AUParameterValueToLinear Converts a parameter value to a linear value according to the parameter's units.
        Parameters:
        inParameterValue - The value in the natural units of the specified parameter.
        inParameter - The parameter, including its Audio Unit, that will define the conversion of the supplied parameter value to a corresponding linear value.
        Returns:
        A number 0.0-1.0. API-Since: 6.0

      • AUParameterFormatValue

        @NotNull
public static @NotNull org.moe.natj.general.ptr.BytePtr AUParameterFormatValue​(double inParameterValue,
                                                                               @NotNull
                                                                               @NotNull AudioUnitParameter inParameter,
                                                                               @NotNull
                                                                               @NotNull org.moe.natj.general.ptr.BytePtr inTextBuffer,
                                                                               int inDigits)
        [@function] AUParameterFormatValue Format a parameter value into a string. Formats a floating point value into a string. Computes a power of 10 to which the value will be rounded and displayed as follows: if the the parameter is logarithmic (Hertz), the number of significant digits is inDigits - pow10(inParameterValue) + 1. Otherwise, it is inDigits - pow10(maxValue - minValue) + 1. Example for inDigits=3: pow10 | range | digits after decimal place display ------|--------------|------------------------------------ -2 | .0100-.0999 | 4 -1 | .100-.999 | 3 0 | 1.00-9.99 | 2 1 | 10.0-99.9 | 1 2 | 100-999 | 0 3 | 1000-9990 | -1 4 | 10000-99900 | -2 API-Since: 6.0
        Parameters:
        inParameterValue - The parameter value to be formatted.
        inParameter - The Audio Unit, scope, element, and parameter whose value this is.
        inTextBuffer - The character array to receive the formatted text. Should be at least 32 characters.
        inDigits - The resolution of the string (see example above).
        Returns:
        `inTextBuffer`

      • AudioFileGetUserDataSize64

        public static int AudioFileGetUserDataSize64​(@NotNull
                                             @NotNull AudioFileID inAudioFile,
                                             int inUserDataID,
                                             int inIndex,
                                             @NotNull
                                             @NotNull org.moe.natj.general.ptr.LongPtr outUserDataSize)
        [@function] AudioFileGetUserDataSize64 Get the 64-bit size of user data in a file
        Parameters:
        inAudioFile - an AudioFileID.
        inUserDataID - the four char code of the chunk.
        inIndex - an index specifying which chunk if there are more than one.
        outUserDataSize - on output, if successful, the size of the user data chunk.
        Returns:
        returns noErr if successful. API-Since: 17.0

      • AudioFileGetUserDataAtOffset

        public static int AudioFileGetUserDataAtOffset​(@NotNull
                                               @NotNull AudioFileID inAudioFile,
                                               int inUserDataID,
                                               int inIndex,
                                               long inOffset,
                                               @NotNull
                                               @NotNull org.moe.natj.general.ptr.IntPtr ioUserDataSize,
                                               @NotNull
                                               @NotNull org.moe.natj.general.ptr.VoidPtr outUserData)
        [@function] AudioFileGetUserDataAtOffset Get a part of the data of a chunk in a file.
        Parameters:
        inAudioFile - an AudioFileID.
        inUserDataID - the four char code of the chunk.
        inIndex - an index specifying which chunk if there are more than one.
        inOffset - offset from the first byte of the chunk to the first byte to get.
        ioUserDataSize - the size of the buffer on input, size of bytes copied to buffer on output
        outUserData - a pointer to a buffer in which to copy the chunk data.
        Returns:
        returns noErr if successful. API-Since: 17.0