Discord Player

SourcePluginHostOptions

Standalone source host configuration.

You are reading the v8 docsDev
InterfaceTypeScript@discord-player/plugin-host
View sourcepackages/plugin-host/src/host.ts:27
interface SourcePluginHostOptions extends PluginHostOptions, Omit<SourcePluginRuntimeOptions, "player">

Standalone source host configuration.

Properties

hostIdoptionaloverride

Overrides Omit.hostId

hostId?: string

Stable non-secret deployment ID. Required for HTTP; generated only for local handle() usage.

mediaDeliveryoptional

mediaDelivery?: "proxy" | "direct-url"

Return provider URLs directly when no byte transforms are needed. Default proxy. Opt in only when the consuming node can enforce its own DNS/redirect policy and access these URLs. Declared URL-only providers resolve at source.stream invocation; all byte sources remain deferred.

directUrlProvidersoptional

directUrlProviders?: readonly string[]

Providers guaranteed to return only URLs without opening byte resources during track.stream. Required for direct URL optimization; other providers stay lazy. Applicable transforms always force proxying. A provider that violates this promise fails explicitly; legacy and mixed-source providers should be omitted.

mediaPolicyoptional

mediaPolicy?: MediaAccessPolicy

Remote materialization policy; files and private networks are denied by default.

maxTrackStatesoptional

maxTrackStates?: number

Maximum retained process-local Track references; default 1000.

trackStateTtlMsoptional

trackStateTtlMs?: number

State lifetime in milliseconds; default ten minutes. Expired tracks are reconstructed by URL.

blockExtractorsoptional

Inherited from Omit.blockExtractors

blockExtractors?: readonly string[]

Disabled provider IDs.

probeTimeoutoptional

Inherited from Omit.probeTimeout

probeTimeout?: number

Legacy probe timeout hint.

On this page