Inherits from NSObject
Declared in MIKMIDIPlayer.h

Overview

MIKMIDIPlayer can be used to play an MIKMIDISequence.

Tasks

Properties

clickTrackEnabled

@property (nonatomic, getter=isClickTrackEnabled) BOOL clickTrackEnabled

currentTimeStamp

@property (nonatomic) MusicTimeStamp currentTimeStamp
Discussion

The current position in the music sequence.

Declared In

MIKMIDIPlayer.h

isPlaying

@property (readonly, nonatomic) BOOL isPlaying
Discussion

Whether or not the player is currently playing. This property can be observed with KVO.

Declared In

MIKMIDIPlayer.h

looping

@property (nonatomic, getter=isLooping) BOOL looping
Discussion

Whether or not the player should loop playback of the music sequence.

Note: MIKMIDI currently only supports looping of an entire music sequence. The results of looping a MIKMIDISequence that has a length shorter than the end of the last MIDI event in the sequence is undefined.

Declared In

MIKMIDIPlayer.h

maxClickTrackTimeStamp

@property (nonatomic) MusicTimeStamp maxClickTrackTimeStamp

metronome

@property (strong, nonatomic) MIKMIDIMetronome *metronome

sequence

@property (strong, nonatomic) MIKMIDISequence *sequence
Discussion

The music sequence to play.

Declared In

MIKMIDIPlayer.h

stopPlaybackAtEndOfSequence

@property (nonatomic) BOOL stopPlaybackAtEndOfSequence

tailDuration

@property (nonatomic) Float64 tailDuration
Discussion

The additional amount of time in seconds to continue playing after the end of the last MIDI event in the sequence. The default is 0.

Declared In

MIKMIDIPlayer.h

Instance Methods

preparePlayback

- (void)preparePlayback
Discussion

Prepares the MusicPlayer for playback.

Call this method in advance of playback to reduce a music player’s startup latency.

Declared In

MIKMIDIPlayer.h

resumePlayback

- (void)resumePlayback
Discussion

Resumes playback of the music sequence from the MusicTimeStamp that the player last stopped at.

Declared In

MIKMIDIPlayer.h

startPlayback

- (void)startPlayback
Discussion

Starts playback from the beginning of the music sequence. Equivalent to calling -startPlaybackFromPosition with a position of 0.

Declared In

MIKMIDIPlayer.h

startPlaybackFromPosition:

- (void)startPlaybackFromPosition:(MusicTimeStamp)position
Discussion

Starts playback of the music sequence from the specified position.

Parameters

position

The MusicTimeStamp to begin playback from.

Declared In

MIKMIDIPlayer.h

stopPlayback

- (void)stopPlayback
Discussion

Stops playback of the music seuqenece.

Declared In

MIKMIDIPlayer.h