Class: Toybox::Media::ContentIterator

Inherits:
Lang::Object show all

Overview

A user-defined iterator that returns referenced to media content on the system for use by the system media player.

Since:

  • 3.0.0

Instance Method Summary collapse

Methods inherited from Lang::Object

equals, hashCode, method, toString, weak

Instance Method Details

canSkipToybox::Lang::Boolean

Determine if the the current track can be skipped.

Returns:

Since:

  • 3.0.0


8658
8659
# File 'Monkeybrains.rb', line 8658

def canSkip()
end

getToybox::Media::Content

Get the current media content object.

  • A Content object representing the current track

  • null if no tracks remain

  • An error object if an error has occurred. This can be anything that inherits from Object, but it must implement toString()

Returns:

Since:

  • 3.0.0


8622
8623
# File 'Monkeybrains.rb', line 8622

def get()
end

getPlaybackProfileToybox::Media::PlaybackProfile

Get the current media content playback profile

Returns:

Since:

  • 3.0.0


8592
8593
# File 'Monkeybrains.rb', line 8592

def getPlaybackProfile()
end

nextToybox::Media::Content

Get the next media content object.

  • A Content object representing the next track

  • null if no tracks remain

  • An error object if an error occurred. This can be anything that inherits from Object, but it must implement toString().

Returns:

Since:

  • 3.0.0


8602
8603
# File 'Monkeybrains.rb', line 8602

def next()
end

peekNextToybox::Media::Content

Get the next media content object without incrementing the iterator.

  • A Content object representing the current track

  • null if no tracks remain

  • An error object if an error has occurred. This can be anything that inherits from Object, but it must implement toString()

Returns:

Since:

  • 3.0.0


8632
8633
# File 'Monkeybrains.rb', line 8632

def peekNext()
end

peekPreviousToybox::Media::Content

Get the previous media content object without decrementing the iterator.

  • A Content object representing the current track

  • null if no tracks remain

  • An error object if an error has occurred. This can be anything that inherits from Object, but it must implement toString()

Returns:

Since:

  • 3.0.0


8642
8643
# File 'Monkeybrains.rb', line 8642

def peekPrevious()
end

previousToybox::Media::Content

Get the previous media content object.

  • A Content object representing the next track.

  • null if no tracks remain.

  • An error object if an error occurred. This can be anything that inherits from Object, but it must implement toString().

Returns:

Since:

  • 3.0.0


8612
8613
# File 'Monkeybrains.rb', line 8612

def previous()
end

shufflingToybox::Lang::Boolean

Determine if playback is currently set to shuffle.

Returns true if shuffle is on, otherwise false.

Returns:

Since:

  • 3.0.0


8650
8651
# File 'Monkeybrains.rb', line 8650

def shuffling()
end