AVAudioFile (moe.platform.ios API)

java.lang.Object
- org.moe.natj.general.NativeObject
- - org.moe.natj.objc.ObjCObject
  - - apple.NSObject
    - - apple.avfaudio.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.

Nested Class Summary
- Nested classes/interfaces inherited from class apple.NSObject
  NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors
Modifier Constructor and Description

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

Constructors
Modifier	Constructor and Description
`protected`	`AVAudioFile(org.moe.natj.general.Pointer peer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`accessInstanceVariablesDirectly()`
`static AVAudioFile`	`alloc()`
`static AVAudioFile`	`allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)`
`static boolean`	`automaticallyNotifiesObserversForKey(java.lang.String key)`
`static void`	`cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)`
`static void`	`cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)`
`static NSArray<java.lang.String>`	`classFallbacksForKeyedArchiver()`
`static org.moe.natj.objc.Class`	`classForKeyedUnarchiver()`
`static java.lang.String`	`debugDescription_static()`
`static java.lang.String`	`description_static()`
`AVAudioFormat`	`fileFormat()` [@property] fileFormat
`long`	`framePosition()` [@property] framePosition
`static long`	`hash_static()`
`AVAudioFile`	`init()`
`AVAudioFile`	`initForReadingCommonFormatInterleavedError(NSURL fileURL, long format, boolean interleaved, org.moe.natj.general.ptr.Ptr<NSError> outError)` initForReading:commonFormat:interleaved:error:
`AVAudioFile`	`initForReadingError(NSURL fileURL, org.moe.natj.general.ptr.Ptr<NSError> outError)` initForReading:error:
`AVAudioFile`	`initForWritingSettingsCommonFormatInterleavedError(NSURL fileURL, NSDictionary<java.lang.String,?> settings, long format, boolean interleaved, org.moe.natj.general.ptr.Ptr<NSError> outError)` initForWriting:settings:commonFormat:interleaved:error:
`AVAudioFile`	`initForWritingSettingsError(NSURL fileURL, NSDictionary<java.lang.String,?> settings, org.moe.natj.general.ptr.Ptr<NSError> outError)` initForWriting:settings:error:
`static NSObject.Function_instanceMethodForSelector_ret`	`instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)`
`static NSMethodSignature`	`instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)`
`static boolean`	`instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)`
`static boolean`	`isSubclassOfClass(org.moe.natj.objc.Class aClass)`
`static NSSet<java.lang.String>`	`keyPathsForValuesAffectingValueForKey(java.lang.String key)`
`long`	`length()` [@property] length
`static AVAudioFile`	`new_objc()`
`AVAudioFormat`	`processingFormat()` [@property] processingFormat
`boolean`	`readIntoBufferError(AVAudioPCMBuffer buffer, org.moe.natj.general.ptr.Ptr<NSError> outError)` readIntoBuffer:error:
`boolean`	`readIntoBufferFrameCountError(AVAudioPCMBuffer buffer, int frames, org.moe.natj.general.ptr.Ptr<NSError> outError)` readIntoBuffer:frameCount:error:
`static boolean`	`resolveClassMethod(org.moe.natj.objc.SEL sel)`
`static boolean`	`resolveInstanceMethod(org.moe.natj.objc.SEL sel)`
`void`	`setFramePosition(long value)` [@property] framePosition
`static void`	`setVersion_static(long aVersion)`
`static org.moe.natj.objc.Class`	`superclass_static()`
`NSURL`	`url()` [@property] url
`static long`	`version_static()`
`boolean`	`writeFromBufferError(AVAudioPCMBuffer buffer, org.moe.natj.general.ptr.Ptr<NSError> outError)` writeFromBuffer:error:

Methods inherited from class apple.NSObject
accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject
equals, toString

Methods inherited from class org.moe.natj.general.NativeObject
finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AVAudioFile
```
protected AVAudioFile(org.moe.natj.general.Pointer peer)
```
- Method Detail
  - accessInstanceVariablesDirectly
```
public static boolean accessInstanceVariablesDirectly()
```
  - alloc
```
public static AVAudioFile alloc()
```
  - allocWithZone
```
public static AVAudioFile allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
```
  - automaticallyNotifiesObserversForKey
```
public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)
```
  - cancelPreviousPerformRequestsWithTarget
```
public static void cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
```
  - cancelPreviousPerformRequestsWithTargetSelectorObject
```
public static void cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)
```
  - classFallbacksForKeyedArchiver
```
public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()
```
  - classForKeyedUnarchiver
```
public static org.moe.natj.objc.Class classForKeyedUnarchiver()
```
  - debugDescription_static
```
public static java.lang.String debugDescription_static()
```
  - description_static
```
public static java.lang.String description_static()
```
  - fileFormat
```
public 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()
```
  - init
```
public AVAudioFile init()
```
    Overrides:
    
    init in class NSObject
  - initForReadingCommonFormatInterleavedError
```
public AVAudioFile initForReadingCommonFormatInterleavedError(NSURL fileURL,
                                                              long format,
                                                              boolean interleaved,
                                                              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(NSURL fileURL,
                                       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(NSURL fileURL,
                                                                      NSDictionary<java.lang.String,?> settings,
                                                                      long format,
                                                                      boolean interleaved,
                                                                      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(NSURL fileURL,
                                               NSDictionary<java.lang.String,?> settings,
                                               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
  - instanceMethodForSelector
```
public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
```
  - instanceMethodSignatureForSelector
```
public static NSMethodSignature instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)
```
  - instancesRespondToSelector
```
public static boolean instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)
```
  - isSubclassOfClass
```
public static boolean isSubclassOfClass(org.moe.natj.objc.Class aClass)
```
  - keyPathsForValuesAffectingValueForKey
```
public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)
```
  - 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.
  - new_objc
```
public static AVAudioFile new_objc()
```
  - processingFormat
```
public AVAudioFormat processingFormat()
```
    [@property] processingFormat
    The processing format of the file.
  - readIntoBufferError
```
public boolean readIntoBufferError(AVAudioPCMBuffer buffer,
                                   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(AVAudioPCMBuffer buffer,
                                             int frames,
                                             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
```
public NSURL url()
```
    [@property] url
    The URL the file is reading or writing.
  - version_static
```
public static long version_static()
```
  - writeFromBufferError
```
public boolean writeFromBufferError(AVAudioPCMBuffer buffer,
                                    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.

Class AVAudioFile

Nested Class Summary

Nested classes/interfaces inherited from class apple.NSObject

Constructor Summary

Method Summary

Methods inherited from class apple.NSObject

Methods inherited from class org.moe.natj.objc.ObjCObject

Methods inherited from class org.moe.natj.general.NativeObject

Methods inherited from class java.lang.Object

Constructor Detail

AVAudioFile

Method Detail

accessInstanceVariablesDirectly

alloc

allocWithZone

automaticallyNotifiesObserversForKey

cancelPreviousPerformRequestsWithTarget

cancelPreviousPerformRequestsWithTargetSelectorObject

classFallbacksForKeyedArchiver

classForKeyedUnarchiver

debugDescription_static

description_static

fileFormat

framePosition

hash_static

init

initForReadingCommonFormatInterleavedError

initForReadingError

initForWritingSettingsCommonFormatInterleavedError

initForWritingSettingsError

instanceMethodForSelector

instanceMethodSignatureForSelector

instancesRespondToSelector

isSubclassOfClass

keyPathsForValuesAffectingValueForKey

length

new_objc

processingFormat

readIntoBufferError

readIntoBufferFrameCountError

resolveClassMethod

resolveInstanceMethod

setFramePosition

setVersion_static

superclass_static

url

version_static

writeFromBufferError