Skip to content

Titanium.Media.Item

A representation of a media item returned by openMusicLibrary or queryMusicLibrary.

This is a read-only object that describes a single media item, not a playlist. Titanium does not support access to playlists.

Item objects cannot be created explicitly. The openMusicLibrary returns Item objects in its success callback function, while queryMusicLibrary returns an array of Item objects.

Extends: Titanium.Proxy · Since: 1.4.0 · Platforms: iphone, ipad, macos

Properties #

albumArtist#

Type: String

Artist credited for the album containing this item.

albumArtistPersistentID#

Type: Number

The persistent identifier for an album artist.

albumPersistentID#

Type: Number

The key for the persistent identifier for an album.

albumTitle#

Type: String

Title of the album containing this item.

albumTrackCount#

Type: Number

Number of tracks for the album containing this item.

albumTrackNumber#

Type: Number

Track number for this item.

apiName#

extended

Type: String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button.

artist#

Type: String

Artist credited for this item.

artwork#

Type: Titanium.Blob

Image for the item's artwork as a Blob object, or null if no artwork is
available.

assetURL#

Type: String

A URL pointing to the media item.

beatsPerMinute#

Type: Number

The number of musical beats per minute for the media item.

bookmarkTime#

Type: String

The user's place in the media item the most recent time it was played.

bubbleParent#

extended

Type: Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often
established by the add() method. For example, for a button added to a window, a
click event on the button would bubble up to the window. Other common parents are
table sections to their rows, table views to their sections, and scrollable views
to their views. Set this property to false to disable the bubbling to the proxy's parent.

comments#

Type: String

Textual information about the media item.

composer#

Type: String

Composer of this item.

dateAdded#

Type: Date

Date when the item was added to the music library.

discCount#

Type: Number

Total number of discs for the album containing this item.

discNumber#

Type: Number

Disc number for this item in the album.

genre#

Type: String

Genre of this item.

genrePersistentID#

Type: Number

The persistent identifier for a genre.

hasProtectedAsset#

Type: Boolean

True if the item represents a protected asset.

isCloudItem#

Type: Boolean

True if the media item is an iCloud item.

isCompilation#

Type: Boolean

True if this item is part of a compilation album.

isExplicit#

Type: Boolean

True if this item is marked as "Explicit".

lastPlayedDate#

Type: Date

The most recent calendar date on which the user played the media item.

lifecycleContainer#

extended

Type: Titanium.UI.Window, Titanium.UI.TabGroup

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks
will also be called on the proxy. Proxies that require the activity lifecycle will need this property set
to the appropriate containing Window or TabGroup.

lyrics#

Type: String

Lyrics for this item.

mediaType#

Type: Number

The type of the media.

At least in theory, a single item can have more than one media type, in which case the
value represents a bitwise-OR of all the applicable media types.

persistentID#

Type: String

The key for the persistent identifier for the media item.

playbackDuration#

Type: Number

Length (in seconds) of this item.

playbackStoreID#

Type: Number

Used to enqueue store tracks by their ID.

playCount#

Type: Number

Number of times the item has been played.

podcastPersistentID#

Type: Number

The persistent identifier for an audio podcast.

podcastTitle#

Type: String

Title of a podcast item.

Only included if the media type is Titanium.Media.MUSIC_MEDIA_TYPE_PODCAST.

rating#

Type: Number

Rating for this item.

releaseDate#

Type: Date

Date when this this item was released.

skipCount#

Type: Number

Number of times this item has been skipped.

title#

Type: String

Title of this item.

userGrouping#

Type: String

Grouping information for the media item.

Methods #

addEventListener #

extended

Adds the specified callback as an event listener for the named event.

Parameters:
NameTypeSummaryOptional
nameStringName of the event.No
callbackCallback<Titanium.Event>Callback function to invoke when the event is fired.No

applyProperties #

extended

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that
myproxy[key] = value.

Parameters:
NameTypeSummaryOptional
propsDictionaryA dictionary of properties to apply.No

fireEvent #

extended

Fires a synthesized event to any registered listeners.

Parameters:
NameTypeSummaryOptional
nameStringName of the event.No
eventDictionaryA dictionary of keys and values to add to the Titanium.Event object sent to the listeners.Yes

removeEventListener #

extended

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function
in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);
Parameters:
NameTypeSummaryOptional
nameStringName of the event.No
callbackCallback<Titanium.Event>Callback function to remove. Must be the same function passed to addEventListener.No

Titanium SDK Documentation