Class: Toybox.Media.ContentIterator

Inherits:

Toybox.Lang.Object

• Toybox.Lang.Object
• Toybox.Media.ContentIterator

Overview

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

Since:

API Level 3.0.0

Instance Method Summary

• canSkip() as Lang.Boolean

  Determine if the the current track can be skipped.

• get() as Media.Content or Null

  Get the current media content object.

• getPlaybackProfile() as Media.PlaybackProfile or Null

  Get the current media content playback profile.

• next() as Media.Content or Null

  Get the next media content object.

• peekNext() as Media.Content or Null

  Get the next media content object without incrementing the iterator.

• peekPrevious() as Media.Content or Null

  Get the previous media content object without decrementing the iterator.

• previous() as Media.Content or Null

  Get the previous media content object.

• repeatMode() as Media.RepeatMode or Null

  Get the current repeat state.

• shuffling() as Lang.Boolean

  Determine if playback is currently set to shuffle.

Instance Method Details

canSkip() as Lang.Boolean

Determine if the the current track can be skipped.

Returns:

• Lang.Boolean —

  Returns true if the current track can be skipped, otherwise false.

Since:

API Level 3.0.0

get() as Media.Content or Null

Get the current media content object.

Returns:

• Media.Content —

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

Since:

API Level 3.0.0

getPlaybackProfile() as Media.PlaybackProfile or Null

Get the current media content playback profile

Returns:

• Media.PlaybackProfile

Since:

API Level 3.0.0

next() as Media.Content or Null

Get the next media content object.

Returns:

• Media.Content —

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

Since:

API Level 3.0.0

peekNext() as Media.Content or Null

Get the next media content object without incrementing the iterator.

Returns:

• Media.Content —

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

Since:

API Level 3.0.0

peekPrevious() as Media.Content or Null

Get the previous media content object without decrementing the iterator.

Returns:

• Media.Content —

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

Since:

API Level 3.0.0

previous() as Media.Content or Null

Get the previous media content object.

Returns:

• Media.Content —

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

Since:

API Level 3.0.0

repeatMode() as Media.RepeatMode or Null

Get the current repeat state

Returns:

• Media.RepeatMode —

  The REPEAT_MODE_* enum value that represents the current repeat state

Since:

API Level 3.0.0

shuffling() as Lang.Boolean

Determine if playback is currently set to shuffle.

Returns true if shuffle is on, otherwise false.

Returns:

• Lang.Boolean

Since:

API Level 3.0.0