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


7520
7521
# File 'Monkeybrains.rb', line 7520

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


7484
7485
# File 'Monkeybrains.rb', line 7484

def get()
end

getPlaybackProfileToybox::Media::PlaybackProfile

Get the current media content playback profile

Returns:

Since:

  • 3.0.0


7454
7455
# File 'Monkeybrains.rb', line 7454

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


7464
7465
# File 'Monkeybrains.rb', line 7464

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


7494
7495
# File 'Monkeybrains.rb', line 7494

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


7504
7505
# File 'Monkeybrains.rb', line 7504

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


7474
7475
# File 'Monkeybrains.rb', line 7474

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


7512
7513
# File 'Monkeybrains.rb', line 7512

def shuffling()
end