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

SearchSourceClient

@IviExperimental(reasons = [])

class SearchSourceClient(context: Context, sourceId: SourceId) : SourceClient

SourceClient specialization oriented towards searching.

Call search, and retrieve the updated contents as soon as isLoading is false.

Parameters

context

Android context.

sourceId

ID of the source to connect to.

Constructors

SearchSourceClient

constructor(context: Context, sourceId: SourceId)

Properties

contents

open override val contents: LiveData<List<IviMediaItem>>

The list of IviMediaItem results obtained by searching for query. Initially empty. The contents will be updated over time if the source decides to do so.

isAvailable

open override val isAvailable: LiveData<Boolean>

Whether the source can be queried and provide content.

isLoading

open override val isLoading: LiveData<Boolean>

Whether the source is loading content.

mediaErrors

open override val mediaErrors: Flow<MediaError>

Collect mediaErrors to receive notifications about error conditions.

query

val query: LiveData<String>

The last search query. Initially empty. When calling search, this LiveData value will be updated.

rootMetadata

open override val rootMetadata: LiveData<Bundle?>

The client root extras. Can be used to store various values to determine source behavior.

Functions

coLaunchBrowserAction

open suspend override fun <T> coLaunchBrowserAction(browserAction: BrowserAction<T>): BrowserActionResult<T>

Launch a browser action.

connect

open override fun connect()

Connects client to a media source to display the content. The connection is kept until disconnect is called.

disconnect

open override fun disconnect()

Disconnects client from a media source and clears the content.

@MainThread

fun search(query: String?)

Starts a search for query. If the client is available, starts searching immediately. Otherwise, the query will be saved until available.

setTag

open override fun setTag(tag: String)

Set a tag to identify this client in debugging logs.