BrowseChangeEvent

Kotlin |Java

class BrowseChangeEvent : AnalyticsEvent

kotlin.Any
↳	androidx.car.app.mediaextensions.analytics.event.AnalyticsEvent
	↳	androidx.car.app.mediaextensions.analytics.event.BrowseChangeEvent

Describes a browse node change event.

See also
`<a href="URL`

Summary

Constants
`const Int`	`BROWSE_MODE_LINK = 4` Indicates browsing linked media item
`const Int`	`BROWSE_MODE_LINK_BROWSE = 5` Indicates browsing media items under linked media item
`const Int`	`BROWSE_MODE_SEARCH_BROWSE = 6` Indicates browsing media items under a search result media item
`const Int`	`BROWSE_MODE_SEARCH_RESULTS = 7` Indicates browsing search results media items
`const Int`	`BROWSE_MODE_TREE_BROWSE = 2` Indicates browsing under media items tree root
`const Int`	`BROWSE_MODE_TREE_ROOT = 1` Indicates browsing media items tree root
`const Int`	`BROWSE_MODE_TREE_TAB = 3` Indicates browsing media items one level under root, i.e. tabs.
`const Int`	`BROWSE_MODE_UNKNOWN = 0` Indicates an unknown browse mode type.

Public functions
`Int`	`getBrowseMode()` Mode Platform Component is viewing Browse Nodes.
`String`	`getBrowseNodeId()` Returns the `android.media.browse.MediaBrowser.MediaItem` ID that is the new browse node.
`Int`	`getViewAction()` Returns the `androidx.car.app.mediaextensions.analytics.event.AnalyticsEvent.ViewAction` related to this Browse Change.
`String`	`toString()`

Inherited Constants

From androidx.car.app.mediaextensions.analytics.event.AnalyticsEvent

`const Int`	`EVENT_TYPE_BROWSE_NODE_CHANGED_EVENT = 3` Indicates `BrowseChangeEvent`
`const Int`	`EVENT_TYPE_ERROR_EVENT = 5` Indicates `ErrorEvent`
`const Int`	`EVENT_TYPE_MEDIA_CLICKED_EVENT = 2` Indicates `MediaClickedEvent`
`const Int`	`EVENT_TYPE_UNKNOWN_EVENT = 0` Indicates an unknown event
`const Int`	`EVENT_TYPE_VIEW_CHANGE_EVENT = 4` Indicates `ViewChangeEvent`
`const Int`	`EVENT_TYPE_VISIBLE_ITEMS_EVENT = 1` Indicates `VisibleItemsEvent`
`const Int`	`VIEW_ACTION_HIDE = 0` Indicates view was hidden
`const Int`	`VIEW_ACTION_MODE_NONE = 0` Indicates view action mode is default/none
`const Int`	`VIEW_ACTION_MODE_SCROLL = 1` Indicates view action mode is from a scroll
`const Int`	`VIEW_ACTION_SHOW = 1` Indicates view was shown
`const Int`	`VIEW_COMPONENT_BROWSE_ACTION_OVERFLOW = 8` Indicates event generated from Browse Action Overflow view component
`const Int`	`VIEW_COMPONENT_BROWSE_LIST = 1` Indicates event generated from Browse List view component
`const Int`	`VIEW_COMPONENT_BROWSE_TABS = 2` Indicates event generated from Browse Tabs view component
`const Int`	`VIEW_COMPONENT_ERROR_MESSAGE = 10` Indicates event generated from Error Message view component
`const Int`	`VIEW_COMPONENT_LAUNCHER = 6` Indicates event generated from Launcher view component
`const Int`	`VIEW_COMPONENT_MEDIA_HOST = 9` Indicates event generated from Media Host view component
`const Int`	`VIEW_COMPONENT_MINI_PLAYBACK = 5` Indicates event generated from Mini Playback view component
`const Int`	`VIEW_COMPONENT_PLAYBACK = 4` Indicates event generated from Playback view component
`const Int`	`VIEW_COMPONENT_QUEUE_LIST = 3` Indicates event generated from Queue List view component
`const Int`	`VIEW_COMPONENT_SETTINGS_VIEW = 7` Indicates event generated from Settings view component
`const Int`	`VIEW_COMPONENT_UNKNOWN_COMPONENT = 0` Indicates event generated from an Unknown view component

Inherited functions

From androidx.car.app.mediaextensions.analytics.event.AnalyticsEvent

`Int`	`getAnalyticsVersion()` Returns the analytics version.
`String`	`getComponent()` Returns the platform component that is generating analytic events.
`Int`	`getEventType()` Returns the `EventType`.
`Long`	`getTimestampMillis()` Returns the time of the event in milliseconds since 1970-01-01T00:00:00Z.

Constants

BROWSE_MODE_LINK

Added in 1.7.0-alpha02

const val BROWSE_MODE_LINK = 4: Int

Indicates browsing linked media item

BROWSE_MODE_LINK_BROWSE

Added in 1.7.0-alpha02

const val BROWSE_MODE_LINK_BROWSE = 5: Int

Indicates browsing media items under linked media item

BROWSE_MODE_SEARCH_BROWSE

Added in 1.7.0-alpha02

const val BROWSE_MODE_SEARCH_BROWSE = 6: Int

Indicates browsing media items under a search result media item

BROWSE_MODE_SEARCH_RESULTS

Added in 1.7.0-alpha02

const val BROWSE_MODE_SEARCH_RESULTS = 7: Int

Indicates browsing search results media items

BROWSE_MODE_TREE_BROWSE

Added in 1.7.0-alpha02

const val BROWSE_MODE_TREE_BROWSE = 2: Int

Indicates browsing under media items tree root

BROWSE_MODE_TREE_ROOT

Added in 1.7.0-alpha02

const val BROWSE_MODE_TREE_ROOT = 1: Int

Indicates browsing media items tree root

BROWSE_MODE_TREE_TAB

Added in 1.7.0-alpha02

const val BROWSE_MODE_TREE_TAB = 3: Int

Indicates browsing media items one level under root, i.e. tabs.

BROWSE_MODE_UNKNOWN

Added in 1.7.0-alpha02

const val BROWSE_MODE_UNKNOWN = 0: Int

Indicates an unknown browse mode type.

Public functions

getBrowseMode

Added in 1.7.0-alpha02

fun getBrowseMode(): Int

Mode Platform Component is viewing Browse Nodes.

getBrowseNodeId

Added in 1.7.0-alpha02

fun getBrowseNodeId(): String

Returns the android.media.browse.MediaBrowser.MediaItem ID that is the new browse node.

Returns
`String`	String MediaItem ID.

getViewAction

Added in 1.7.0-alpha02

fun getViewAction(): Int

Returns the androidx.car.app.mediaextensions.analytics.event.AnalyticsEvent.ViewAction related to this Browse Change.

toString

fun toString(): String