Package apple.avfaudio

Class AVAudioSequencer

  • All Implemented Interfaces:
    NSObject
    public class AVAudioSequencer
extends NSObject
    AVAudioSequencer A collection of MIDI events organized into AVMusicTracks, plus a player to play back the events. API-Since: 9.0

    • Constructor Detail

      • AVAudioSequencer

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

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

      • automaticallyNotifiesObserversForKey

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

      • beatsForHostTimeError

        public double beatsForHostTimeError​(long inHostTime,
                                    @Nullable
                                    @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        beatsForHostTime:error: 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 0 with an error if the player is not playing or if the starting time of the player was after the specified host time. The method uses the sequence's tempo map to retrieve a beat time from the starting and specified host time.

      • beatsForSeconds

        public double beatsForSeconds​(double seconds)
        beatsForSeconds: Get the beat position (timestamp) for the given time in the AVMusicTrack

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

      • currentPositionInBeats

        public double currentPositionInBeats()
        [@property] currentPositionInBeats The current playback position in beats Setting this positions the sequencer's player to the specified beat. This can be set while the player is playing, in which case playback will resume at the new position.

      • currentPositionInSeconds

        public double currentPositionInSeconds()
        [@property] currentPositionInSeconds The current playback position in seconds Setting this positions the sequencer's player to the specified time. This can be set while the player is playing, in which case playback will resume at the new position.

      • dataWithSMPTEResolutionError

        @NotNull
public @NotNull NSData dataWithSMPTEResolutionError​(long SMPTEResolution,
                                                    @Nullable
                                                    @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        dataWithSMPTEResolution:error: Return a data object containing the events from the sequence All details regarding the SMPTE resolution apply here as well. The returned NSData lifetime is controlled by the client.

      • debugDescription_static

        public static java.lang.String debugDescription_static()

      • description_static

        public static java.lang.String description_static()

      • hash_static

        public static long hash_static()

      • hostTimeForBeatsError

        public long hostTimeForBeatsError​(double inBeats,
                                  @Nullable
                                  @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        hostTimeForBeats:error: 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 0 with an error if the player is not playing or if the starting position of the player (its "starting beat") was after the specified beat. The method uses the sequence's tempo map to translate a beat time from the starting time and beat of the player.

      • init

        public AVAudioSequencer init()
        init Initialize a new sequencer, which will not be connected to an audio engine. This is used to create a sequencer whose tracks will only send events to external MIDI endpoints.
        Overrides:
        init in class NSObject

      • initWithAudioEngine

        public AVAudioSequencer initWithAudioEngine​(@NotNull
                                            @NotNull AVAudioEngine engine)
        initWithAudioEngine: Initialize a new sequencer, handing it the audio engine.

      • instanceMethodSignatureForSelector

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

      • instancesRespondToSelector

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

      • isPlaying

        public boolean isPlaying()
        [@property] playing Indicates whether or not the sequencer's player is playing Returns TRUE if the sequencer's player has been started and not stopped. It may have "played" past the end of the events in the sequence, but it is still considered to be playing (and its time value increasing) until it is explicitly stopped.

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

      • loadFromDataOptionsError

        public boolean loadFromDataOptionsError​(@NotNull
                                        @NotNull NSData data,
                                        long options,
                                        @Nullable
                                        @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        loadFromData:options:error: Parse the data and add the its events to the sequence
        Parameters:
        data - the data to load from
        options - determines how the contents are mapped to tracks inside the sequence
        outError - on exit, if an error occurs, a description of the error

      • loadFromURLOptionsError

        public boolean loadFromURLOptionsError​(@NotNull
                                       @NotNull NSURL fileURL,
                                       long options,
                                       @Nullable
                                       @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        loadFromURL:options:error: Load the file referenced by the URL and add the events to the sequence
        Parameters:
        fileURL - the URL to the file
        options - determines how the file's contents are mapped to tracks inside the sequence
        outError - on exit, if an error occurs, a description of the error

      • prepareToPlay

        public void prepareToPlay()
        prepareToPlay Get ready to play the sequence by prerolling all events Happens automatically on play if it has not already been called, but may produce a delay in startup.

      • rate

        public float rate()
        [@property] rate The playback rate of the sequencer's player 1.0 is normal playback rate. Rate must be > 0.0.

      • resolveClassMethod

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

      • resolveInstanceMethod

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

      • secondsForBeats

        public double secondsForBeats​(double beats)
        secondsForBeats: Get the time in seconds for the given beat position (timestamp) in the AVMusicTrack

      • setCurrentPositionInBeats

        public void setCurrentPositionInBeats​(double value)
        [@property] currentPositionInBeats The current playback position in beats Setting this positions the sequencer's player to the specified beat. This can be set while the player is playing, in which case playback will resume at the new position.

      • setCurrentPositionInSeconds

        public void setCurrentPositionInSeconds​(double value)
        [@property] currentPositionInSeconds The current playback position in seconds Setting this positions the sequencer's player to the specified time. This can be set while the player is playing, in which case playback will resume at the new position.

      • setRate

        public void setRate​(float value)
        [@property] rate The playback rate of the sequencer's player 1.0 is normal playback rate. Rate must be > 0.0.

      • setVersion_static

        public static void setVersion_static​(long aVersion)

      • startAndReturnError

        public boolean startAndReturnError​(@Nullable
                                   @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        startAndReturnError: Start the sequencer's player If the AVAudioSequencer has not been prerolled, it will pre-roll itself and then start. When the sequencer is associated with an audio engine, the sequencer's player will only play if the audio engine is running.

      • stop

        public void stop()
        stop Stop the sequencer's player Stopping the player leaves it in an un-prerolled state, but stores the playback position so that a subsequent call to startAndReturnError will resume where it left off. This action will not stop an associated audio engine.

      • superclass_static

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

      • tempoTrack

        @NotNull
public @NotNull AVMusicTrack tempoTrack()
        [@property] tempoTrack The tempo track Each AVMusicSequence has a single tempo track. All tempo events read from external MIDI files are placed into this track (as well as other appropriate events (e.g., the time signature meta event from the file). The tempo track can be edited and iterated upon as any other track. Non-tempo-related events will generate exceptions if added.

      • tracks

        @NotNull
public @NotNull NSArray<? extends AVMusicTrack> tracks()
        [@property] tracks An NSArray containing all the AVMusicTracks in the sequence This list will not include the tempo track.

      • userInfo

        @NotNull
public @NotNull NSDictionary<java.lang.String,​?> userInfo()
        [@property] userInfo A dictionary containing meta-data derived from a sequence The dictionary can contain one or more of the values accessible via the AVAudioSequencerInfoDictionaryKeys.

      • version_static

        public static long version_static()

      • writeToURLSMPTEResolutionReplaceExistingError

        public boolean writeToURLSMPTEResolutionReplaceExistingError​(@NotNull
                                                             @NotNull NSURL fileURL,
                                                             long resolution,
                                                             boolean replace,
                                                             @Nullable
                                                             @Nullable org.moe.natj.general.ptr.Ptr<NSError> outError)
        writeToURL:SMPTEResolution:replaceExisting:error: Create and write a MIDI file containing the events and complete state of the sequence A MIDI file saved via this method will contain not only the complete MIDI content of the sequence, but also the state of all tracks, including muting, loop points and enablement, etc. It will also contain all non-MIDI AVMusicEvent types which had been added to the sequence's track. MIDI files are normally beat based, but can also have a SMPTE (or real-time rather than beat time) representation. The 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
        Parameters:
        fileURL - the path for the file to be created
        resolution - the relationship between "tick" and quarter note for saving to a Standard MIDI File - pass in zero to use default - this will be the value that is currently set on the tempo track
        replace - if the file already exists, YES will cause it to be overwritten with the new data. Otherwise the call will fail with a permission error.
        outError - on exit, if an error occurs, a description of the error

      • createAndAppendTrack

        @NotNull
public @NotNull AVMusicTrack createAndAppendTrack()
        createAndAppendTrack: Create a new AVMusicTrack and append it to the AVMusicSequencer's list API-Since: 16.0

      • removeTrack

        public boolean removeTrack​(@NotNull
                           @NotNull AVMusicTrack track)
        removeTrack: Remove the given AVMusicTrack from the AVMusicSequencer. This does not destroy the AVMusicTrack because it may be re-used. API-Since: 16.0

      • reverseEvents

        public void reverseEvents()
        reverseEvents: Reverse the order of all events in all AVMusicTracks, including the tempo track API-Since: 16.0

      • setUserCallback

        public void setUserCallback​(@Nullable
                            @Nullable AVAudioSequencer.Block_setUserCallback userCallback)
        setUserCallback: Add a block which will be called each time the AVAudioSequencer encounters an AVMusicUserEvent during playback. The same callback is called for events which occur on any track in the sequencer. Set the block to nil to disable it. API-Since: 16.0

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.