Discord Player
Generated APITypeScript@discord-player/plugin-host

PortableSourceQuery

Portable search input, normalized before crossing the metadata boundary.

You are reading the v8 docsDev
InterfaceTypeScript@discord-player/plugin-host
View sourcepackages/plugin-host/src/protocol.ts:67
interface PortableSourceQuery

Portable search input, normalized before crossing the metadata boundary.

Properties

query

query: string

Prefix-stripped query when a registered custom protocol was selected.

protocoloptional

protocol?: string

Owned custom protocol.

providerHintoptional

providerHint?: string

Generic provider hint, independent of provider/deployment selection.

optionsoptional

options?: Omit<SearchOptions, "searchEngine" | "hostId" | "signal" | "resolveCustomProtocols" | "requestedBy" | "requestOptions"> & {
  requestedBy?: string | null;
}

Serializable public search hints; never includes request credentials or cancellation.

PortableLyricsRequest

Lyrics metadata request; persistence intentionally excludes runtime source-state hints.

PortableSourceResult

HTTP metadata response payload inside Remedia's handled/result envelope.

On this page

PropertiesqueryprotocolproviderHintoptions