MPMediaItem Class

Reference

Definition

Namespace:: MediaPlayer

Assembly:: Xamarin.iOS.dll

Assembly:: Xamarin.Mac.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A single piece of media, such as a song or video.

[Foundation.Register("MPMediaItem", true)]
public class MPMediaItem : Foundation.NSObject, Foundation.INSSecureCoding, IDisposable

[Foundation.Register("MPMediaItem", true)]
[ObjCRuntime.Introduced(ObjCRuntime.PlatformName.MacOSX, 10, 12, 2, ObjCRuntime.PlatformArchitecture.Arch64, null)]
public class MPMediaItem : Foundation.NSObject, Foundation.INSSecureCoding, IDisposable

type MPMediaItem = class
    inherit NSObject
    interface INSCoding
    interface INativeObject
    interface IDisposable
    interface INSSecureCoding

Inheritance: Object

NSObject

MPMediaEntity
MPMediaItem

Attributes: RegisterAttribute IntroducedAttribute

Implements: INSCoding INSSecureCoding INativeObject IDisposable

Remarks

Instances of this object expose high-level properties that can be consumed from C# to explore the metadata associated with this media item.

Media Items have persistent identifiers that can be used as unique identifiers across application launches and as long as the media item has not been changed or synchronized again with the host computer. The PersistentID is the persistent ID for the media item. There are also persistent identifiers for the album, the composer, podcast, genre and artists.

For low-level access to the metadat, this class exposes the low-level ValueForProperty(NSString) method and various static properties with the suffix "Property" and the return type NSString.

Constructors

MPMediaItem()	Default constructor that initializes a new instance of this class with no parameters.
MPMediaItem(IntPtr)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime.
MPMediaItem(NSCoder)	A constructor that initializes the object from the data stored in the unarchiver object.
MPMediaItem(NSObjectFlag)	Constructor to call on derived classes to skip initialization and merely allocate the object.

Properties

AlbumArtist	The Album's artist
AlbumArtistPersistentID	The Album's Artist Persistent ID
AlbumArtistPersistentIDProperty	Represents the value associated with the constant MPMediaItemPropertyAlbumArtistPersistentID
AlbumArtistProperty	Represents the value associated with the constant MPMediaItemPropertyAlbumArtist
AlbumPersistentID	The Album's persistent id
AlbumPersistentIDProperty	Represents the value associated with the constant MPMediaItemPropertyAlbumPersistentID
AlbumTitle	The album title
AlbumTitleProperty	Represents the value associated with the constant MPMediaItemPropertyAlbumTitle
AlbumTrackCount	The album track count
AlbumTrackCountProperty	Represents the value associated with the constant MPMediaItemPropertyAlbumTrackCount
AlbumTrackNumber	The album track
AlbumTrackNumberProperty	Represents the value associated with the constant MPMediaItemPropertyAlbumTrackNumber
Artist	The artist
ArtistPersistentID	The Artist Persistent ID
ArtistPersistentIDProperty	Represents the value associated with the constant MPMediaItemPropertyArtistPersistentID
ArtistProperty	Represents the value associated with the constant MPMediaItemPropertyArtist
Artwork	The artwork
ArtworkProperty	Represents the value associated with the constant MPMediaItemPropertyArtwork
AssetURL	The asset URL
AssetURLProperty	Represents the value associated with the constant MPMediaItemPropertyAssetURL
BeatsPerMinute	The beats per minute
BeatsPerMinuteProperty	Represents the value associated with the constant MPMediaItemPropertyBeatsPerMinute
BookmarkTime	The user bookmark time
BookmarkTimeProperty	Represents the value associated with the constant MPMediaItemPropertyBookmarkTime
Class	(Inherited from NSObject)
ClassHandle	The handle for this class.
Comments	The comments
CommentsProperty	Represents the value associated with the constant MPMediaItemPropertyComments
Composer	The composer
ComposerPersistentID	The Composer Persistent ID
ComposerPersistentIDProperty	Represents the value associated with the constant MPMediaItemPropertyComposerPersistentID
ComposerProperty	Represents the value associated with the constant MPMediaItemPropertyComposer
DateAdded
DateAddedProperty	The value that is associated with the MPMediaItemPropertyDateAdded constant.
DebugDescription	A developer-meaningful description of this object. (Inherited from NSObject)
Description	Description of the object, the Objective-C version of ToString. (Inherited from NSObject)
DiscCount	The number of discs in the album that contains this media item.
DiscCountProperty	Represents the value associated with the constant MPMediaItemPropertyDiscCount
DiscNumber	The disc number
DiscNumberProperty	Represents the value associated with the constant MPMediaItemPropertyDiscNumber
Genre	The genre.
GenrePersistentID	The Genre Persistent ID
GenrePersistentIDProperty	Represents the value associated with the constant MPMediaItemPropertyGenrePersistentID
GenreProperty	Represents the value associated with the constant MPMediaItemPropertyGenre
Handle	Handle (pointer) to the unmanaged object representation. (Inherited from NSObject)
HasProtectedAsset
HasProtectedAssetProperty	The value that is associated with the MPMediaItemPropertyHasProtectedAsset constant.
IsCloudItem	Determines if the item is an iCloud item or not.
IsCloudItemProperty	Represents the value associated with the constant MPMediaItemPropertyIsCloudItem
IsCompilation	Set to true if this is media item belongs to a compilation.
IsCompilationProperty	Represents the value associated with the constant MPMediaItemPropertyIsCompilation
IsDirectBinding	(Inherited from NSObject)
IsExplicitItem
IsExplicitProperty	The value that is associated with the MPMediaItemPropertyIsExplicit constant.
IsProxy	(Inherited from NSObject)
LastPlayedDate	The last date that this item was played.
LastPlayedDateProperty	Represents the value associated with the constant MPMediaItemPropertyLastPlayedDate
Lyrics	The lyrics.
LyricsProperty	Represents the value associated with the constant MPMediaItemPropertyLyrics
MediaType	Media type for this media item.
MediaTypeProperty	Represents the value associated with the constant MPMediaItemPropertyMediaType
PersistentID	The Persistent ID
PersistentIDProperty	Represents the value associated with the constant MPMediaItemPropertyPersistentID
PlaybackDuration	Playback duration in seconds.
PlaybackDurationProperty	Represents the value associated with the constant MPMediaItemPropertyPlaybackDuration
PlaybackStoreID	Gets the non-library ID.
PlaybackStoreIDProperty	Backing store for the P:MediaPlayer.MediaItem.PlaybackStoreID property.
PlayCount	Number of times this item has been played.
PlayCountProperty	Represents the value associated with the constant MPMediaItemPropertyPlayCount
PodcastPersistentID	The Podcast Persistent ID.
PodcastPersistentIDProperty	Represents the value associated with the constant MPMediaItemPropertyPodcastPersistentID
PodcastTitle	Title for the podcast.
PodcastTitleProperty	Represents the value associated with the constant MPMediaItemPropertyPodcastTitle
PropertyPersistentID
Rating	The user assigned rating in the range zero to five.
RatingProperty	Represents the value associated with the constant MPMediaItemPropertyRating
ReleaseDate	The release date for this media item.
ReleaseDateProperty	Represents the value associated with the constant MPMediaItemPropertyReleaseDate
RetainCount	Returns the current Objective-C retain count for the object. (Inherited from NSObject)
Self	(Inherited from NSObject)
SkipCount	Number of times this item has been skipped from playing back.
SkipCountProperty	Represents the value associated with the constant MPMediaItemPropertySkipCount
Superclass	(Inherited from NSObject)
SuperHandle	Handle used to represent the methods in the base class for this NSObject. (Inherited from NSObject)
Title	The title for this media item.
TitleProperty	Represents the value associated with the constant MPMediaItemPropertyTitle
UserGrouping	User defined grouping for this media item.
UserGroupingProperty	Represents the value associated with the constant MPMediaItemPropertyUserGrouping
Zone	(Inherited from NSObject)

Methods

AddObserver(NSObject, NSString, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using NSString keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSObject, String, NSKeyValueObservingOptions, IntPtr)	Registers an object for being observed externally (using string keyPath). Observed changes are dispatched to the observer’s object ObserveValue(NSString, NSObject, NSDictionary, IntPtr) method. (Inherited from NSObject)
AddObserver(NSString, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AddObserver(String, NSKeyValueObservingOptions, Action<NSObservedChange>)	Registers an object for being observed externally using an arbitrary method. (Inherited from NSObject)
AwakeFromNib()	Called after the object has been loaded from the nib file. Overriders must call base.AwakeFromNib(). (Inherited from NSObject)
BeginInvokeOnMainThread(Action)	(Inherited from NSObject)
BeginInvokeOnMainThread(Selector, NSObject)	Invokes asynchrously the specified code on the main UI thread. (Inherited from NSObject)
Bind(NSString, NSObject, String, NSDictionary)	(Inherited from NSObject)
Bind(String, NSObject, String, NSDictionary)	Obsolete. (Inherited from NSObject)
BindingInfo(String)	Obsolete. (Inherited from NSObject)
BindingOptionDescriptions(String)	Obsolete. (Inherited from NSObject)
BindingValueClass(String)	Obsolete. (Inherited from NSObject)
CanFilterByProperty(NSString)
CommitEditing()	(Inherited from NSObject)
CommitEditing(NSObject, Selector, IntPtr)	(Inherited from NSObject)
ConformsToProtocol(IntPtr)	Invoked to determine if this object implements the specified protocol. (Inherited from NSObject)
Copy()	Performs a copy of the underlying Objective-C object. (Inherited from NSObject)
DangerousAutorelease()	(Inherited from NSObject)
DangerousRelease()	(Inherited from NSObject)
DangerousRetain()	(Inherited from NSObject)
DidChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates a change occurred to the indexes for a to-many relationship. (Inherited from NSObject)
DidChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
DidChangeValue(String)	Indicates that a change occurred on the specified key. (Inherited from NSObject)
Dispose()	Releases the resources used by the NSObject object. (Inherited from NSObject)
Dispose(Boolean)	Releases the resources used by the NSObject object. (Inherited from NSObject)
DoesNotRecognizeSelector(Selector)	Indicates that this object does not recognize the specified selector. (Inherited from NSObject)
EncodeTo(NSCoder)
EncodeTo(NSCoder)	Encodes the state of the object on the provided encoder (Inherited from MPMediaEntity)
EnumerateValues(NSSet, MPMediaItemEnumerator)
EnumerateValues(NSSet, MPMediaItemEnumerator)	Runs the provided `enumerator` on the values for the specified properties. (Inherited from MPMediaEntity)
Equals(NSObject)	(Inherited from NSObject)
Equals(Object)	(Inherited from NSObject)
ExposedBindings()	(Inherited from NSObject)
GetBindingInfo(NSString)	(Inherited from NSObject)
GetBindingOptionDescriptions(NSString)	(Inherited from NSObject)
GetBindingValueClass(NSString)	(Inherited from NSObject)
GetDictionaryOfValuesFromKeys(NSString[])	Retrieves the values of the specified keys. (Inherited from NSObject)
GetHashCode()	Generates a hash code for the current instance. (Inherited from NSObject)
GetMethodForSelector(Selector)	(Inherited from NSObject)
GetNativeField(String)	Obsolete. (Inherited from NSObject)
GetNativeHash()	(Inherited from NSObject)
GetObject(NSObject)
GetObject(NSObject)	(Inherited from MPMediaEntity)
GetPersistentIDProperty(MPMediaGrouping)	Returns the persistent ID for the specified grouping type.
GetTitleProperty(MPMediaGrouping)	Returns the title for the specified grouping type
Init()	(Inherited from NSObject)
InitializeHandle(IntPtr)	(Inherited from NSObject)
InitializeHandle(IntPtr, String)	(Inherited from NSObject)
Invoke(Action, Double)	(Inherited from NSObject)
Invoke(Action, TimeSpan)	(Inherited from NSObject)
InvokeOnMainThread(Action)	(Inherited from NSObject)
InvokeOnMainThread(Selector, NSObject)	Invokes synchrously the specified code on the main UI thread. (Inherited from NSObject)
IsEqual(NSObject)	(Inherited from NSObject)
IsKindOfClass(Class)	(Inherited from NSObject)
IsMemberOfClass(Class)	(Inherited from NSObject)
MarkDirty()	Promotes a regular peer object (IsDirectBinding is true) into a toggleref object. (Inherited from NSObject)
MutableCopy()	Creates a mutable copy of the specified NSObject. (Inherited from NSObject)
ObjectDidEndEditing(NSObject)	(Inherited from NSObject)
ObserveValue(NSString, NSObject, NSDictionary, IntPtr)	Indicates that the value at the specified keyPath relative to this object has changed. (Inherited from NSObject)
PerformSelector(Selector)	(Inherited from NSObject)
PerformSelector(Selector, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSObject, Double)	Invokes the selector on the current instance and if the `obj` is not null, it passes this as its single parameter. (Inherited from NSObject)
PerformSelector(Selector, NSObject, Double, NSString[])	(Inherited from NSObject)
PerformSelector(Selector, NSObject, NSObject)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean)	(Inherited from NSObject)
PerformSelector(Selector, NSThread, NSObject, Boolean, NSString[])	(Inherited from NSObject)
PrepareForInterfaceBuilder()	(Inherited from NSObject)
RemoveObserver(NSObject, NSString)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RemoveObserver(NSObject, NSString, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RemoveObserver(NSObject, String)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath. (Inherited from NSObject)
RemoveObserver(NSObject, String, IntPtr)	Stops the specified observer from receiving further notifications of changed values for the specified keyPath and context. (Inherited from NSObject)
RespondsToSelector(Selector)	Whether this object recognizes the specified selector. (Inherited from NSObject)
SetNativeField(String, NSObject)	Obsolete. (Inherited from NSObject)
SetNilValueForKey(NSString)	Sets the value of the specified key to null. (Inherited from NSObject)
SetValueForKey(NSObject, NSString)	Sets the value of the property specified by the key to the specified value. (Inherited from NSObject)
SetValueForKeyPath(IntPtr, NSString)	A constructor used when creating managed representations of unmanaged objects; Called by the runtime. (Inherited from NSObject)
SetValueForKeyPath(NSObject, NSString)	Sets the value of a property that can be reached using a keypath. (Inherited from NSObject)
SetValueForUndefinedKey(NSObject, NSString)	Indicates an attempt to write a value to an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
SetValuesForKeysWithDictionary(NSDictionary)	Sets the values of this NSObject to those in the specified dictionary. (Inherited from NSObject)
ToString()	Returns a string representation of the value of the current instance. (Inherited from NSObject)
Unbind(NSString)	(Inherited from NSObject)
Unbind(String)	Obsolete. (Inherited from NSObject)
ValueForKey(NSString)	Returns the value of the property associated with the specified key. (Inherited from NSObject)
ValueForKeyPath(NSString)	Returns the value of a property that can be reached using a keypath. (Inherited from NSObject)
ValueForProperty(NSString)
ValueForProperty(NSString)	Returns the value for the specified `property`. (Inherited from MPMediaEntity)
ValueForUndefinedKey(NSString)	Indicates an attempt to read a value of an undefined key. If not overridden, raises an NSUndefinedKeyException. (Inherited from NSObject)
WillChange(NSKeyValueChange, NSIndexSet, NSString)	Indicates that the values of the specified indices in the specified key are about to change. (Inherited from NSObject)
WillChange(NSString, NSKeyValueSetMutationKind, NSSet)	(Inherited from NSObject)
WillChangeValue(String)	Indicates that the value of the specified key is about to change. (Inherited from NSObject)

Extension Methods

ObjectDidBeginEditing(NSObject, INSEditor)
ObjectDidEndEditing(NSObject, INSEditor)
GetValidModes(NSObject, NSFontPanel)
ValidateToolbarItem(NSObject, NSToolbarItem)
GetDebugDescription(INSObjectProtocol)
AcceptsPreviewPanelControl(NSObject, QLPreviewPanel)
BeginPreviewPanelControl(NSObject, QLPreviewPanel)
EndPreviewPanelControl(NSObject, QLPreviewPanel)
GetAccessibilityCustomRotors(NSObject)	Gets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.
SetAccessibilityCustomRotors(NSObject, UIAccessibilityCustomRotor[])	Sets the array of UIAccessibilityCustomRotor objects appropriate for `this` object.

Applies to