MediaItem

MediaItem represents metadata associated Signature.

A MediaItem is used in two distinct ways

Referenced by a MatchedMediaItem, and therefore as the result of a match.
As a way of associating metadata with reference signatures in a CustomCatalog.

A MediaItem contains no required fields and may be entirely blank. They can also contain custom data set with custom keys when making a CustomCatalog.

Types

Companion

object Companion

Functions

equals

open operator override fun equals(other: Any?): Boolean

get

fun get(key: String): Any?

Fetch a custom parameter given its key.

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

Properties

appleMusicID

val appleMusicID: String?

The AppleMusic ID.

appleMusicURL

val appleMusicURL: URL?

A link to this media on Apple Music.

artist

val artist: String?

The Artist.

artworkURL

val artworkURL: URL?

A URL to the artwork.

explicitContent

val explicitContent: Boolean?

Is this content explicit.

frequencySkewRanges

val frequencySkewRanges: List<HalfClosedDoubleRange>

A List of HalfClosedDoubleRange that indicate the frequency skew compared to the reference signatureReturns empty list if the backing value is not present, empty, or cannot be converted to a List of HalfClosedDoubleRanges.

genres

val genres: List<String>

Genres.

isrc

val isrc: String?

The ISRC (International Standard Recording Code).

shazamID

val shazamID: String?

The unique ShazamID.

subtitle

val subtitle: String?

Subtitle.

timeRanges

val timeRanges: List<HalfClosedDoubleRange>

A List of HalfClosedDoubleRange that indicate the offsets within the reference signature that this media item describesReturns empty list if the backing value is not present, empty, or cannot be converted to a List of HalfClosedDoubleRanges.

title

val title: String?

Title.

videoURL

val videoURL: URL?

A URL for a Video associated with the media.

webURL

val webURL: URL?

A web URL representing this result.

Inheritors

MatchedMediaItem