Titanium Mobile

# Titanium.Media.Item

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

Availability
1.4.0
9.2.0
Extends
Titanium.Proxy

# Overview

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 Titanium.Media.openMusicLibrary returns Item objects in its success callback function, while Titanium.Media.queryMusicLibrary returns an array of Item objects.

# Properties

# albumArtist READONLY

Availability
1.4.0
9.2.0
albumArtist :String

Artist credited for the album containing this item.

# albumArtistPersistentID READONLY

Availability
6.1.0
9.2.0
albumArtistPersistentID :Number

The persistent identifier for an album artist.

# albumPersistentID READONLY

Availability
6.1.0
9.2.0
albumPersistentID :Number

The key for the persistent identifier for an album.

# albumTitle READONLY

Availability
1.4.0
9.2.0
albumTitle :String

Title of the album containing this item.

# albumTrackCount READONLY

Availability
1.4.0
9.2.0
albumTrackCount :Number

Number of tracks for the album containing this item.

# albumTrackNumber READONLY

Availability
1.4.0
9.2.0
albumTrackNumber :Number

Track number for this item.

# artist READONLY

Availability
1.4.0
9.2.0
artist :String

Artist credited for this item.

# artwork READONLY

Availability
1.4.0
9.2.0
artwork :Titanium.Blob

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

# assetURL READONLY

Availability
6.1.0
9.2.0
assetURL :String

A URL pointing to the media item.

# beatsPerMinute READONLY

Availability
6.1.0
9.2.0
beatsPerMinute :Number

The number of musical beats per minute for the media item, corresponding to the "BPM" field in the Info tab in the "Get Info" dialog in iTunes.

# bookmarkTime READONLY

Availability
6.1.0
9.2.0
bookmarkTime :String

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

# comments READONLY

Availability
6.1.0
9.2.0
comments :String

Textual information about the media item, corresponding to the "Comments" field in in the Info tab in the Get Info dialog in iTunes.

# composer READONLY

Availability
1.4.0
9.2.0
composer :String

Composer of this item.

# dateAdded READONLY

Availability
6.1.0
9.2.0
dateAdded :Date

Date when the item was added to the music library.

# discCount READONLY

Availability
1.4.0
9.2.0
discCount :Number

Total number of discs for the album containing this item.

# discNumber READONLY

Availability
1.4.0
9.2.0
discNumber :Number

Disc number for this item in the album.

# genre READONLY

Availability
1.4.0
9.2.0
genre :String

Genre of this item.

# genrePersistentID READONLY

Availability
6.1.0
9.2.0
genrePersistentID :Number

The persistent identifier for a genre.

# hasProtectedAsset READONLY

Availability
6.1.0
9.2.0
hasProtectedAsset :Boolean

True if the item represents a protected asset.

# isCloudItem READONLY

Availability
6.1.0
9.2.0
isCloudItem :Boolean

True if the media item is an iCloud item.

# isCompilation READONLY

Availability
1.4.0
9.2.0
isCompilation :Boolean

True if this item is part of a compilation album.

# isExplicit READONLY

Availability
6.1.0
9.2.0
isExplicit :Boolean

True if this item is marked as "Explicit".

# lastPlayedDate READONLY

Availability
6.1.0
9.2.0
lastPlayedDate :Date

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

# lyrics READONLY

Availability
1.4.0
9.2.0
lyrics :String

Lyrics for this item.

# mediaType READONLY

Availability
1.4.0
9.2.0
mediaType :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.

This API can be assigned the following constants:

# persistentID READONLY

Availability
6.1.0
9.2.0
persistentID :String

The key for the persistent identifier for the media item.

# playbackDuration READONLY

Availability
1.4.0
9.2.0
playbackDuration :Number

Length (in seconds) of this item.

# playbackStoreID READONLY

Availability
6.1.0
9.2.0
playbackStoreID :Number

Used to enqueue store tracks by their ID.

# playCount READONLY

Availability
1.4.0
9.2.0
playCount :Number

Number of times the item has been played.

# podcastPersistentID READONLY

Availability
6.1.0
9.2.0
podcastPersistentID :Number

The persistent identifier for an audio podcast.

# podcastTitle READONLY

Availability
1.4.0
9.2.0
podcastTitle :String

Title of a podcast item.

Only included if the media type is MUSIC_MEDIA_TYPE_PODCAST.

# rating READONLY

Availability
1.4.0
9.2.0
rating :Number

Rating for this item.

# releaseDate READONLY

Availability
6.1.0
9.2.0
releaseDate :Date

Date when this this item was released.

# skipCount READONLY

Availability
1.4.0
9.2.0
skipCount :Number

Number of times this item has been skipped.

# title READONLY

Availability
1.4.0
9.2.0
title :String

Title of this item.

# userGrouping READONLY

Availability
6.1.0
9.2.0
userGrouping :String

Corresponds to the "Grouping" field in the Info tab in the "Get Info" dialog in iTunes.

Contents