Skip to content

Interface: MOQtailPlayerOptions ​

Properties ​

catalogTimeoutMs? ​

optional catalogTimeoutMs?: number

Default 10 000.


client? ​

optional client?: object

Shared by every player on the client, compared for UNSUPPORTED_ORIGIN.

reconnectAttempts? ​

optional reconnectAttempts?: number

Default 5.

setupOptions? ​

optional setupOptions?: SetupOptions

transportOptions? ​

optional transportOptions?: WebTransportOptions & object

Type Declaration ​
protocols? ​

optional protocols?: string[]


eventTimelines? ​

optional eventTimelines?: string[] | "all"


maxCatalogBytes? ​

optional maxCatalogBytes?: number

Default 16 MiB.


objectOrdering? ​

optional objectOrdering?: ObjectOrdering

How media sources order each request's objects. Default: a 150 ms window.


plugins? ​

optional plugins?: Plugin[]

Entries made with definePlugin. Their setup parameters are shared; their features apply to this player.


preferredLanguage? ​

optional preferredLanguage?: string


preferWorker? ​

optional preferWorker?: boolean

Runs the engines of elements that allow it, such as decoding and canvas rendering, in a worker the player starts, where the browser has what they need. Default true.


worker? ​

optional worker?: () => Worker

Starts the worker from your own script, which calls serveWorker from moqtail/player/worker with your elements' engines. Used with preferWorker only.

Returns ​

Worker