Package apple.avfaudio

Class AVAudioPlayer

  • All Implemented Interfaces:
    NSObject
    public class AVAudioPlayer
extends NSObject
    API-Since: 2.2

    • Constructor Detail

      • AVAudioPlayer

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

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

      • automaticallyNotifiesObserversForKey

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

      • averagePowerForChannel

        public float averagePowerForChannel​(long channelNumber)
        returns average power in decibels for a given channel

      • 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()

      • currentTime

        public double currentTime()
        If the sound is playing, currentTime is the offset into the sound of the current playback position. If the sound is not playing, currentTime is the offset into the sound where playing would start.

      • data

        @Nullable
public @Nullable NSData data()
        returns nil if object was not created with a data object

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • delegate

        @Nullable
public @Nullable AVAudioPlayerDelegate delegate()
        the delegate will be sent messages from the AVAudioPlayerDelegate protocol

      • description_static

        public static java.lang.String description_static()

      • deviceCurrentTime

        public double deviceCurrentTime()
        returns the current time associated with the output device API-Since: 4.0

      • duration

        public double duration()
        the duration of the sound.

      • enableRate

        public boolean enableRate()
        You must set enableRate to YES for the rate property to take effect. You must set this before calling prepareToPlay. API-Since: 5.0

      • format

        @NotNull
public @NotNull AVAudioFormat format()
        returns the format of the audio data API-Since: 10.0

      • hash_static

        public static long hash_static()

      • initWithContentsOfURLError

        public AVAudioPlayer initWithContentsOfURLError​(@NotNull
                                                @NotNull NSURL url,
                                                @Nullable
                                                @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        all data must be in the form of an audio file understood by CoreAudio

      • initWithContentsOfURLFileTypeHintError

        public AVAudioPlayer initWithContentsOfURLFileTypeHintError​(@NotNull
                                                            @NotNull NSURL url,
                                                            @Nullable
                                                            @Nullable java.lang.String utiString,
                                                            @Nullable
                                                            @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        The file type hint is a constant defined in AVMediaFormat.h whose value is a UTI for a file format. e.g. AVFileTypeAIFF. Sometimes the type of a file cannot be determined from the data, or it is actually corrupt. The file type hint tells the parser what kind of data to look for so that files which are not self identifying or possibly even corrupt can be successfully parsed. API-Since: 7.0

      • initWithDataError

        public AVAudioPlayer initWithDataError​(@NotNull
                                       @NotNull NSData data,
                                       @Nullable
                                       @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)

      • initWithDataFileTypeHintError

        public AVAudioPlayer initWithDataFileTypeHintError​(@NotNull
                                                   @NotNull NSData data,
                                                   @Nullable
                                                   @Nullable java.lang.String utiString,
                                                   @Nullable
                                                   @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        API-Since: 7.0

      • instanceMethodSignatureForSelector

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

      • instancesRespondToSelector

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

      • isMeteringEnabled

        public boolean isMeteringEnabled()
        turns level metering on or off. default is off.

      • isPlaying

        public boolean isPlaying()
        is it playing or not?

      • 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)

      • numberOfChannels

        public long numberOfChannels()

      • numberOfLoops

        public long numberOfLoops()
        "numberOfLoops" is the number of times that the sound will return to the beginning upon reaching the end. A value of zero means to play the sound just once. A value of one will result in playing the sound twice, and so on.. Any negative number will loop indefinitely until stopped.

      • pan

        public float pan()
        set panning. -1.0 is left, 0.0 is center, 1.0 is right. API-Since: 4.0

      • pause

        public void pause()
        Pauses playback, but remains ready to play.

      • peakPowerForChannel

        public float peakPowerForChannel​(long channelNumber)
        returns peak power in decibels for a given channel

      • play

        public boolean play()
        This method starts the audio hardware synchronously (if not already running), and triggers the sound playback which is streamed asynchronously.

      • playAtTime

        public boolean playAtTime​(double time)
        This method starts the audio hardware synchronously (if not already running), and triggers the sound playback which is streamed asynchronously at the specified time in the future. Time is an absolute time based on and greater than deviceCurrentTime. API-Since: 4.0

      • prepareToPlay

        public boolean prepareToPlay()
        Transport control Methods that return BOOL return YES on success and NO on failure. Get ready to play the sound. This happens automatically on play.

      • rate

        public float rate()
        See enableRate. The playback rate for the sound. 1.0 is normal, 0.5 is half speed, 2.0 is double speed. API-Since: 5.0

      • resolveClassMethod

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

      • resolveInstanceMethod

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

      • setChannelAssignments

        public void setChannelAssignments​(@Nullable
                                  @Nullable NSArray<? extends AVAudioSessionChannelDescription> value)
        Array of AVAudioSessionChannelDescription objects API-Since: 7.0

      • setCurrentTime

        public void setCurrentTime​(double value)
        If the sound is playing, currentTime is the offset into the sound of the current playback position. If the sound is not playing, currentTime is the offset into the sound where playing would start.

      • setDelegate_unsafe

        public void setDelegate_unsafe​(@Nullable
                               @Nullable AVAudioPlayerDelegate value)
        the delegate will be sent messages from the AVAudioPlayerDelegate protocol

      • setDelegate

        public void setDelegate​(@Nullable
                        @Nullable AVAudioPlayerDelegate value)
        the delegate will be sent messages from the AVAudioPlayerDelegate protocol

      • setEnableRate

        public void setEnableRate​(boolean value)
        You must set enableRate to YES for the rate property to take effect. You must set this before calling prepareToPlay. API-Since: 5.0

      • setMeteringEnabled

        public void setMeteringEnabled​(boolean value)
        turns level metering on or off. default is off.

      • setNumberOfLoops

        public void setNumberOfLoops​(long value)
        "numberOfLoops" is the number of times that the sound will return to the beginning upon reaching the end. A value of zero means to play the sound just once. A value of one will result in playing the sound twice, and so on.. Any negative number will loop indefinitely until stopped.

      • setPan

        public void setPan​(float value)
        set panning. -1.0 is left, 0.0 is center, 1.0 is right. API-Since: 4.0

      • setRate

        public void setRate​(float value)
        See enableRate. The playback rate for the sound. 1.0 is normal, 0.5 is half speed, 2.0 is double speed. API-Since: 5.0

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • setVolume

        public void setVolume​(float value)
        The volume for the sound. The nominal range is from 0.0 to 1.0.

      • setVolumeFadeDuration

        public void setVolumeFadeDuration​(float volume,
                                  double duration)
        fade to a new volume over a duration API-Since: 10.0

      • settings

        @NotNull
public @NotNull NSDictionary<java.lang.String,​?> settings()
        returns a settings dictionary with keys as described in AVAudioSettings.h API-Since: 4.0

      • stop

        public void stop()
        Synchronously stops playback, no longer ready to play. NOTE: - This will block while releasing the audio hardware that was acquired upon calling play() or prepareToPlay()

      • superclass_static

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

      • updateMeters

        public void updateMeters()
        call to refresh meter values

      • url

        @Nullable
public @Nullable NSURL url()
        returns nil if object was not created with a URL

      • version_static

        public static long version_static()

      • volume

        public float volume()
        The volume for the sound. The nominal range is from 0.0 to 1.0.

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.