Package apple.avfaudio

Class AVAudioFile

  • All Implemented Interfaces:
    NSObject
    public class AVAudioFile
extends NSObject
    AVAudioFile An audio file opened for reading or writing. Regardless of the file's actual format, reading and writing the file is done via `AVAudioPCMBuffer` objects, containing samples in an `AVAudioCommonFormat`, referred to as the file's "processing format." Conversions are performed to and from the file's actual format. Reads and writes are always sequential, but random access is possible by setting the framePosition property. API-Since: 8.0

    • Constructor Detail

      • AVAudioFile

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

        public static AVAudioFile allocWithZone​(org.moe.natj.general.ptr.VoidPtr zone)

      • automaticallyNotifiesObserversForKey

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

      • cancelPreviousPerformRequestsWithTarget

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

      • cancelPreviousPerformRequestsWithTargetSelectorObject

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

      • classFallbacksForKeyedArchiver

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

      • classForKeyedUnarchiver

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

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • fileFormat

        @NotNull
public @NotNull AVAudioFormat fileFormat()
        [@property] fileFormat The on-disk format of the file.

      • framePosition

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

      • hash_static

        public static long hash_static()

      • initForReadingCommonFormatInterleavedError

        public AVAudioFile initForReadingCommonFormatInterleavedError​(@NotNull
                                                              @NotNull NSURL fileURL,
                                                              long format,
                                                              boolean interleaved,
                                                              @Nullable
                                                              @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        initForReading:commonFormat:interleaved:error: Open a file for reading, using a specified processing format.
        Parameters:
        fileURL - the file to open
        format - the processing format to use when reading from the file
        interleaved - whether to use an interleaved processing format
        outError - on exit, if an error occurs, a description of the error

      • initForReadingError

        public AVAudioFile initForReadingError​(@NotNull
                                       @NotNull NSURL fileURL,
                                       @Nullable
                                       @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        initForReading:error: Open a file for reading. This opens the file for reading using the standard format (deinterleaved floating point).
        Parameters:
        fileURL - the file to open
        outError - on exit, if an error occurs, a description of the error

      • initForWritingSettingsCommonFormatInterleavedError

        public AVAudioFile initForWritingSettingsCommonFormatInterleavedError​(@NotNull
                                                                      @NotNull NSURL fileURL,
                                                                      @NotNull
                                                                      @NotNull NSDictionary<java.lang.String,​?> settings,
                                                                      long format,
                                                                      boolean interleaved,
                                                                      @Nullable
                                                                      @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        initForWriting:settings:commonFormat:interleaved:error: Open a file for writing. The file type to create can be set through the corresponding settings key. If not set, it will be inferred from the file extension. Will overwrite a file at the specified URL if a file exists.
        Parameters:
        fileURL - the path at which to create the file
        settings - the format of the file to create (See `AVAudioRecorder`.) For linear PCM, only interleaved formats are supported for the saved file, non interleaved setting will be ignored and a warning is shown.
        format - the processing format to use when writing to the file.
        interleaved - whether to use an interleaved processing format
        outError - on exit, if an error occurs, a description of the error

      • initForWritingSettingsError

        public AVAudioFile initForWritingSettingsError​(@NotNull
                                               @NotNull NSURL fileURL,
                                               @NotNull
                                               @NotNull NSDictionary<java.lang.String,​?> settings,
                                               @Nullable
                                               @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        initForWriting:settings:error: Open a file for writing. The file type to create can be set through the corresponding settings key. If not set, it will be inferred from the file extension. Will overwrite a file at the specified URL if a file exists. This opens the file for writing using the standard format (deinterleaved floating point).
        Parameters:
        fileURL - the path at which to create the file
        settings - the format of the file to create (See `AVAudioRecorder`.) For linear PCM, only interleaved formats are supported for the saved file, non interleaved setting will be ignored and a warning is shown.
        outError - on exit, if an error occurs, a description of the error

      • instanceMethodSignatureForSelector

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

      • instancesRespondToSelector

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

      • isSubclassOfClass

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

      • keyPathsForValuesAffectingValueForKey

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

      • length

        public long length()
        [@property] length The number of sample frames in the file. Note: this can be expensive to compute for the first time.

      • processingFormat

        @NotNull
public @NotNull AVAudioFormat processingFormat()
        [@property] processingFormat The processing format of the file.

      • readIntoBufferError

        public boolean readIntoBufferError​(@NotNull
                                   @NotNull AVAudioPCMBuffer buffer,
                                   @Nullable
                                   @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        readIntoBuffer:error: Read an entire buffer. Reading sequentially from framePosition, attempts to fill the buffer to its capacity. On return, the buffer's length indicates the number of sample frames successfully read.
        Parameters:
        buffer - The buffer into which to read from the file. Its format must match the file's processing format.
        outError - on exit, if an error occurs, a description of the error
        Returns:
        YES for success.

      • readIntoBufferFrameCountError

        public boolean readIntoBufferFrameCountError​(@NotNull
                                             @NotNull AVAudioPCMBuffer buffer,
                                             int frames,
                                             @Nullable
                                             @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        readIntoBuffer:frameCount:error: Read a portion of a buffer. Like `readIntoBuffer:error:`, but can be used to read fewer frames than buffer.frameCapacity.
        Parameters:
        frames - The number of frames to read.
        buffer - The buffer into which to read from the file. Its format must match the file's processing format.
        outError - on exit, if an error occurs, a description of the error
        Returns:
        YES for success.

      • resolveClassMethod

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

      • resolveInstanceMethod

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

      • setFramePosition

        public void setFramePosition​(long value)
        [@property] framePosition The position in the file at which the next read or write will occur. Set framePosition to perform a seek before a read or write. A read or write operation advances the frame position by the number of frames read or written.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • superclass_static

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

      • url

        @NotNull
public @NotNull NSURL url()
        [@property] url The URL the file is reading or writing.

      • version_static

        public static long version_static()

      • writeFromBufferError

        public boolean writeFromBufferError​(@NotNull
                                    @NotNull AVAudioPCMBuffer buffer,
                                    @Nullable
                                    @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        writeFromBuffer:error: Write a buffer. Writes sequentially. The buffer's frameLength signifies how much of the buffer is to be written.
        Parameters:
        buffer - The buffer from which to write to the file. Its format must match the file's processing format.
        outError - on exit, if an error occurs, a description of the error
        Returns:
        YES for success.

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.