brūhi Script Reference

brūhi Script is a sandboxed scripting language built into brūhi Desktop for dynamic playlist generation and automation. See brūhi Script for full documentation and worked examples.

Safety Limits

Constraint	Value
Max execution time	5 seconds
File system access	None
Network access	None
System calls	None

`library` Object

Query the content library.

Method	Returns	Description
`library.search(query)`	`TrackList`	Full-text search. Accepts FTS5 query syntax.
`library.genre(name)`	`TrackList`	All tracks where genre contains `name` (case-insensitive)
`library.artist(name)`	`TrackList`	All tracks where artist contains `name` (case-insensitive)
`library.recent(days)`	`TrackList`	Tracks added within the last N days
`library.all()`	`TrackList`	All tracks in the library

Search Query Syntax

Syntax	Meaning	Example
`word`	All fields contain word	`jazz`
`"phrase"`	Exact phrase match	`"dark side"`
`field:value`	Match specific field	`genre:rock`
`word1 word2`	Both words (AND)	`jazz blues`
`word1 OR word2`	Either word	`jazz OR blues`
`^word`	Field starts with word	`^a` (artists starting with A)
`word*`	Prefix match	`electr*`

Available field names: title, artist, album, genre

`TrackList` Methods

Method	Returns	Description
`.shuffle()`	`TrackList`	Fisher-Yates shuffle (in-place, returns self)
`.limit(n)`	`TrackList`	Keep first N tracks
`.sort(field)`	`TrackList`	Sort by field: `"title"`, `"artist"`, `"bpm"`, `"year"`, `"duration"`
`.reverse()`	`TrackList`	Reverse order
`.append(list)`	`TrackList`	Append another TrackList

Methods can be chained:

library.genre("jazz").shuffle().limit(20)

`playlist` Object

Manage the active playlist.

Method	Description
`playlist.set(tracks)`	Replace the playlist with a TrackList
`playlist.append(tracks)`	Append a TrackList to the current playlist
`playlist.clear()`	Empty the playlist

`queue` Object

Manage the upcoming track queue.

Method	Description
`queue.add(tracks)`	Add a TrackList to the end of the queue
`queue.clear()`	Clear the queue

`deck` Object

Control the playback decks.

Method	Description
`deck.a.load(track)`	Load a track onto Deck A
`deck.b.load(track)`	Load a track onto Deck B
`deck.a.play()`	Start playback on Deck A
`deck.b.play()`	Start playback on Deck B
`deck.a.pause()`	Pause Deck A
`deck.b.pause()`	Pause Deck B
`deck.a.stop()`	Stop Deck A
`deck.b.stop()`	Stop Deck B

`schedule` Object

Read-only access to the current schedule state.

Property	Type	Description
`schedule.current`	Block or `null`	Currently active schedule block
`schedule.next`	Block or `null`	Next upcoming schedule block
`schedule.current.name`	string	Name of the current block
`schedule.current.ends_in`	number	Seconds until current block ends

Common Patterns

Random genre selection, limited

library.genre("Pop").shuffle().limit(25)

Multi-genre pool, shuffled

library.genre("Rock").append(library.genre("Indie")).shuffle().limit(30)

Recent additions only

library.recent(7).shuffle()

BPM-sorted playlist

library.genre("EDM").sort("bpm")

Keyword search, artist-sorted

library.search("title:live").sort("artist")

Error Messages

Message	Cause
`Script timed out after 5s`	Script took too long; reduce complexity or library size
`Unknown method 'x' on TrackList`	Typo in method name
`Cannot call library.search with 0 arguments`	Missing query string
`playlist.set requires a TrackList`	Passed wrong type (e.g., a string instead of a TrackList)
`Invalid sort field 'x'`	Valid fields: `title`, `artist`, `bpm`, `year`, `duration`