appsuite_media_api_common_core/com.tomtom.ivi.appsuite.media.api.common.core

Package-level declarations

The main package of the media library. This provides the core facilities for browsing media.

The main entry point of the library are source clients. A SourceClient instance abstracts an Android MediaBrowser instance, to ease its usage to the maximum while providing the full functionality.

The library provides source clients to use in different contexts:

RootSourceClient. A source client to show and browse the content tree of a media source. It provides access to a source's categories (the top-level items used to access all available contents), and loads the media items in those. It can also load (browse) any of the loaded items: this which will replace all previously loaded items.
ItemSourceClient. A source client showing the contents of a single browsable media item, for example a set list of radio stations or a playlist.
SearchSourceClient. A source client to search the content tree of a media source. The media source needs to support this functionality for search to be possible.

All source clients have status callbacks, ErrorCallback, to react to different situations occurring in the remote media source or the library.

The source clients use SourceId to identify a specific media source. They deliver their results via their contents field, in the form of IviMediaItems. An IviMediaItem is a basic data structure used to communicate information about an element in the media domain. It can represent anything from a song to an album to a dashboard grouping all content of a media source.

Types

@IviExperimental(reasons = [])

enum ContentStyle : Enum<ContentStyle>

Specifies a content style (a suggested presentation layout) of media items within the browse tree. Represents values for MediaBundleExtras.EXTRA_CONTENT_STYLE_BROWSABLE_HINT and MediaBundleExtras.EXTRA_CONTENT_STYLE_PLAYABLE_HINT.

@IviExperimental(reasons = [])

abstract class ErrorCallback

Container for callbacks for various error conditions.

ItemSourceClient

@IviExperimental(reasons = [])

class ItemSourceClient(sourceId: SourceId, val mediaItem: IviMediaItem, coroutineDispatcher: CoroutineDispatcher = Options.mediaCoroutineDispatcher) : SourceClient

A SourceClient specialization oriented towards showing the contents of a single media item.

@IviExperimental(reasons = [])

data class IviMediaItem : Parcelable

A basic data structure used to communicate information about an element in the media domain. This element can represent different types of items, from a song to an album to a dashboard representing the content of a media source.

IviMediaItemBuilder

@IviExperimental(reasons = [])

class IviMediaItemBuilder

A builder that creates IviMediaItems.

@IviExperimental(reasons = [])

class IviMediaRating(val type: IviMediaRating.Type = Type.UNSUPPORTED, initialValue: Float = UNRATED) : Serializable

Rating assigned to an IviMediaItem.

IviPlaybackState

@IviExperimental(reasons = [])

sealed class IviPlaybackState : Parcelable

The current state of playback for a given media source.

MediaBundleExtras

@IviExperimental(reasons = [])

object MediaBundleExtras

Names of extras for Bundle to access IviMediaItem data and StandardActionId.

MediaPlaybackTimeInfo

@IviExperimental(reasons = [])

data class MediaPlaybackTimeInfo(val duration: Duration? = null, val position: Duration? = null, val playbackSpeed: Float = INVALID_PLAYBACK_SPEED, val lastPositionUpdateTime: Duration = getElapsedTime()) : Parcelable

Information about a media timeline, such as duration, playing position, and playback speed.

@IviExperimental(reasons = [])

object Options

Global run-time options for media library components.

@IviExperimental(reasons = [])

enum ResultCode : Enum<ResultCode>

Media result codes, coming from library components. These can be used to recognize errors and special notifications coming from media sources.

RootSourceClient

@IviExperimental(reasons = [])

class RootSourceClient(sourceId: SourceId, coroutineDispatcher: CoroutineDispatcher = Options.mediaCoroutineDispatcher) : SourceClient

SourceClient specialization for showing the content of the root of a media source's browsing hierarchy. It provides access to a source's categories (the top-level items used to access all available content), and can be instructed to browse through any of the available content.

SearchSourceClient

@IviExperimental(reasons = [])

class SearchSourceClient(sourceId: SourceId, coroutineDispatcher: CoroutineDispatcher = Options.mediaCoroutineDispatcher) : SourceClient

SourceClient specialization oriented towards searching.

@IviExperimental(reasons = [])

interface SourceClient

A client to browse content offered by a media source.

@IviExperimental(reasons = [])

open class SourceId(val packageName: String, val className: String) : Parcelable

Unique identifier for a media source.

@IviExperimental(reasons = [])

data class SourceInfo(val id: SourceId, val displayName: String, val icon: Icon, val isReady: Boolean, val loginIntent: PendingIntent? = null) : Parcelable

Information about a media source.

Functions

@IviExperimental(reasons = [])

fun List<IviMediaItem>?.containsId(mediaId: String): Boolean

Returns whether this list of IviMediaItems contains an item with the given mediaId.

@IviExperimental(reasons = [])

fun List<IviMediaItem>.dump(): String

Returns the entire contents of a list of IviMediaItems as a string. Useful for debugging, to know the exact contents of a source's data set.

@IviExperimental(reasons = [])

fun List<IviMediaItem>?.findOrNull(mediaId: String): IviMediaItem?

Returns the first IviMediaItem with the given mediaId in this list; null otherwise.

getBrowsableHint

@IviExperimental(reasons = [])

fun Bundle.getBrowsableHint(): ContentStyle?

Gets a presentation hint for browsable items.

@IviExperimental(reasons = [])

fun getElapsedTime(): Duration

Returns the elapsed time to be compared with MediaPlaybackTimeInfo.lastPositionUpdateTime.

getPlayableHint

@IviExperimental(reasons = [])

fun Bundle.getPlayableHint(): ContentStyle?

Gets a presentation hint for playable items.