features/browser

configureBrowser()

function configureBrowser(configuration): void;

Configures the browser with routes, tabs, and other settings. Also registers the browser with the player to enable:

• Media URL transformation for authenticated playback
• Android Auto / CarPlay browsing integration
• Playback of browsable tracks via navigate()

Parameters

Parameter	Type	Description
configuration	BrowserConfiguration	Browser configuration including routes, tabs, media config, etc.

Returns

void

Example

configureBrowser({
  routes: {
    '/albums/:id': { path: '/api/albums/:id' }
  },
  tabs: [
    { title: 'Home', url: '/' },
    { title: 'Search', url: '/search' }
  ]
})

---

useContent()

function useContent(): 
  | ResolvedTrack
  | undefined;

Returns

| ResolvedTrack | undefined

---

getContent()

function getContent(): 
  | ResolvedTrack
  | undefined;

Returns

| ResolvedTrack | undefined

---

onContentChanged

const onContentChanged: NativeUpdatedValue<
  | ResolvedTrack
| undefined>;

---

navigate()

function navigate(pathOrTrack): void;

Parameters

Parameter	Type
pathOrTrack	string | Track

Returns

void

---

notifyContentChanged()

function notifyContentChanged(path): void;

Notifies external media controllers (Android Auto, CarPlay) that content at the specified path has changed and should be refreshed.

Parameters

Parameter	Type	Description
path	string	The path where content has changed (e.g., '/favorites')

Returns

void

Example

// After adding a track to favorites
notifyContentChanged('/favorites')

---

usePath()

function usePath(): string | undefined;

Returns

string | undefined

---

getPath()

function getPath(): string | undefined;

Returns

string | undefined

---

onPathChanged

const onPathChanged: NativeUpdatedValue<string | undefined>;

---

search()

function search(query): Promise<Track[]>;

Searches for tracks using the configured search source.

Parameters

Parameter	Type	Description
query	string	The search query string

Returns

Promise<Track[]>

Promise resolving to an array of matching tracks

See

configureBrowser

Example

const results = await search('jazz')
console.log(`Found ${results.length} tracks`)

---

hasSearch()

function hasSearch(): boolean;

Returns whether search functionality is configured via configureBrowser({ search: ... }).

Returns

boolean

---

useTabs()

function useTabs(): Track[] | undefined;

Returns

Track[] | undefined

---

getTabs()

function getTabs(): Track[] | undefined;

Returns

Track[] | undefined

---

onTabsChanged

const onTabsChanged: NativeUpdatedValue<Track[] | undefined>;