---
url: https://docs.moqtail.dev/ts/api/player/classes/MOQtailPlayer.md
---
# Class: MOQtailPlayer

## Extends

* [`Emitter`](../../util/classes/Emitter.md)<[`PlayerEvents`](../interfaces/PlayerEvents.md)>

## Constructors

### Constructor

> **new MOQtailPlayer**(`options?`): `MOQtailPlayer`

Runs each plugin's `init` and `setup`.

#### Parameters

##### options?

[`MOQtailPlayerOptions`](../interfaces/MOQtailPlayerOptions.md) = `{}`

#### Returns

`MOQtailPlayer`

#### Throws

PlayerError `UNSUPPORTED_ORIGIN` when two plugins set a setup parameter differently.

#### Throws

TypeError for a plugin listed twice, or a config its `init` rejects.

#### Overrides

[`Emitter`](../../util/classes/Emitter.md).[`constructor`](../../util/classes/Emitter.md#constructor)

## Properties

### options

> `readonly` **options**: `Readonly`<[`MOQtailPlayerOptions`](../interfaces/MOQtailPlayerOptions.md)>

## Accessors

### abrController

#### Get Signature

> **get** **abrController**(): [`AbrController`](../interfaces/AbrController.md) | `undefined`

The active plugins' ABR controller while it's attached.

##### Returns

[`AbrController`](../interfaces/AbrController.md) | `undefined`

***

### bufferController

#### Get Signature

> **get** **bufferController**(): [`BufferController`](../interfaces/BufferController.md) | `undefined`

The active plugins' buffer controller while it's attached.

##### Returns

[`BufferController`](../interfaces/BufferController.md) | `undefined`

***

### client

#### Get Signature

> **get** **client**(): [`MOQtailClient`](../../client/classes/MOQtailClient.md) | `undefined`

The shared client while this player holds it; a reconnect replaces it (see the `client` event).

##### Returns

[`MOQtailClient`](../../client/classes/MOQtailClient.md) | `undefined`

***

### mediaSink

#### Get Signature

> **get** **mediaSink**(): [`SinkElement`](SinkElement.md) & [`MediaSinkElement`](../interfaces/MediaSinkElement.md) | `undefined`

The first sink in chain order that provides `MEDIA_SINK`.

##### Returns

[`SinkElement`](SinkElement.md) & [`MediaSinkElement`](../interfaces/MediaSinkElement.md) | `undefined`

***

### mediaSources

#### Get Signature

> **get** **mediaSources**(): readonly ([`SourceElement`](SourceElement.md) & [`MediaSourceElement`](../interfaces/MediaSourceElement.md))\[]

Sources that provide `MEDIA_SOURCE`, except those loaded by another media source.

##### Returns

readonly ([`SourceElement`](SourceElement.md) & [`MediaSourceElement`](../interfaces/MediaSourceElement.md))\[]

***

### sources

#### Get Signature

> **get** **sources**(): readonly [`SourceElement`](SourceElement.md)\[]

##### Returns

readonly [`SourceElement`](SourceElement.md)\[]

***

### state

#### Get Signature

> **get** **state**(): [`PlayerState`](../type-aliases/PlayerState.md)

##### Returns

[`PlayerState`](../type-aliases/PlayerState.md)

## Methods

### destroy()

> **destroy**(): `Promise`<`void`>

Aborts in-flight work, destroys sinks then sources, and releases the client last. Callable in any state.

#### Returns

`Promise`<`void`>

***

### emit()

> **emit**<`K`>(`event`, ...`args`): `void`

Calls every listener of `event` with `args`. Allocates nothing when there are none.

#### Type Parameters

##### K

`K` *extends* `"client"` | `"warning"` | `"error"` | `"catalog"` | `"ended"` | `"statechange"` | `"playing"` | `"pause"` | `"stalled"` | `"reconnecting"` | `"reconnected"` | `"timelineevent"` | `"autoplayblocked"` | `"renditionchange"` | `"selectionchange"` | `"streamtypechange"`

#### Parameters

##### event

`K`

##### args

...`Parameters`<[`PlayerEvents`](../interfaces/PlayerEvents.md)\[`K`]>

#### Returns

`void`

#### Inherited from

[`Emitter`](../../util/classes/Emitter.md).[`emit`](../../util/classes/Emitter.md#emit)

***

### init()

> **init**(): `Promise`<`void`>

Connects and negotiates the chain; rejects with `UNSUPPORTED_SOURCE` when no element accepts a
source. A track URL no element accepts alone is requested, and probed again by its properties.
Idempotent.

#### Returns

`Promise`<`void`>

***

### isAbrAvailable()

> **isAbrAvailable**(`source`): `boolean`

Whether `source` switches renditions automatically: it provides `ABR`, or an ABR controller can
drive it, since the stream is live and no media source provides `ABR`. A rendition picked
manually detaches the controller but leaves this true, so selecting every rendition again resumes it.

#### Parameters

##### source

[`SourceElement`](SourceElement.md)

#### Returns

`boolean`

***

### off()

> **off**<`K`>(`event`, `listener`): `void`

Removes `listener`, the same function given to `on()`, from `event`.

#### Type Parameters

##### K

`K` *extends* `"client"` | `"warning"` | `"error"` | `"catalog"` | `"ended"` | `"statechange"` | `"playing"` | `"pause"` | `"stalled"` | `"reconnecting"` | `"reconnected"` | `"timelineevent"` | `"autoplayblocked"` | `"renditionchange"` | `"selectionchange"` | `"streamtypechange"`

#### Parameters

##### event

`K`

##### listener

[`PlayerEvents`](../interfaces/PlayerEvents.md)\[`K`]

#### Returns

`void`

#### Inherited from

[`Emitter`](../../util/classes/Emitter.md).[`off`](../../util/classes/Emitter.md#off)

***

### on()

> **on**<`K`>(`event`, `listener`): `void`

Adds `listener` for `event`. Adding the same function twice has no effect.

#### Type Parameters

##### K

`K` *extends* `"client"` | `"warning"` | `"error"` | `"catalog"` | `"ended"` | `"statechange"` | `"playing"` | `"pause"` | `"stalled"` | `"reconnecting"` | `"reconnected"` | `"timelineevent"` | `"autoplayblocked"` | `"renditionchange"` | `"selectionchange"` | `"streamtypechange"`

#### Parameters

##### event

`K`

##### listener

[`PlayerEvents`](../interfaces/PlayerEvents.md)\[`K`]

#### Returns

`void`

#### Inherited from

[`Emitter`](../../util/classes/Emitter.md).[`on`](../../util/classes/Emitter.md#on)

***

### pause()

> **pause**(): `Promise`<`void`>

#### Returns

`Promise`<`void`>

***

### play()

> **play**(): `Promise`<`void`>

A `NotAllowedError` moves the player to `paused` and emits `autoplayblocked`.

#### Returns

`Promise`<`void`>

***

### registerElement()

> **registerElement**(`definition`): `this`

Registers an element on this player only, ahead of the plugins' and built-in ones: a source for
the probe, a transform for the chain to load where a pad needs one. Call it before `source()`.

#### Parameters

##### definition

[`ElementDefinition`](../interfaces/ElementDefinition.md)

#### Returns

`this`

***

### seek()

> **seek**(`mediaTime`): `Promise`<`void`>

Seconds. Resolves or rejects as the media sink's `seek()` does.

#### Parameters

##### mediaTime

`number`

#### Returns

`Promise`<`void`>

***

### setPlaybackRate()

> **setPlaybackRate**(`rate`): `void`

#### Parameters

##### rate

`number`

#### Returns

`void`

***

### sink()

#### Call Signature

> **sink**(`video`, `options?`): `this`

A video element gets the `MSE` sink with `options`, a canvas the `Playout` sink with them.

##### Parameters

###### video

`HTMLVideoElement`

###### options?

`Omit`<[`MSEOptions`](../interfaces/MSEOptions.md), `"video"`>

##### Returns

`this`

#### Call Signature

> **sink**(`canvas`, `options?`): `this`

A video element gets the `MSE` sink with `options`, a canvas the `Playout` sink with them.

##### Parameters

###### canvas

`HTMLCanvasElement`

###### options?

`Omit`<[`PlayoutOptions`](../interfaces/PlayoutOptions.md), `"canvas"`>

##### Returns

`this`

#### Call Signature

> **sink**(`definition`, `options?`): `this`

A video element gets the `MSE` sink with `options`, a canvas the `Playout` sink with them.

##### Parameters

###### definition

[`SinkElementDefinition`](../interfaces/SinkElementDefinition.md)

###### options?

`Record`<`string`, `unknown`>

##### Returns

`this`

***

### source()

> **source**(`uri`, `options?`): `this`

Adds a top-level source for a moqt URI. `init()` picks its element, once the peer's SETUP
decided which plugins are active, and gives it `{ ...options, source }`.

#### Parameters

##### uri

`string`

##### options?

###### switchFrom?

`boolean`

#### Returns

`this`

#### Throws

PlayerError `UNSUPPORTED_SOURCE` for a URI that can't be used here, `UNSUPPORTED_ORIGIN`
for another origin or client setup; the player stays `idle`.

***

### start()

> **start**(): `Promise`<`void`>

`init()`, then `play()`. Idempotent.

#### Returns

`Promise`<`void`>

***

### transform()

> **transform**(`definition`, `options?`): `this`

Adds a transform, created with `options` after the sources, in call order.

#### Parameters

##### definition

[`TransformElementDefinition`](../interfaces/TransformElementDefinition.md)

##### options?

`Record`<`string`, `unknown`> = `{}`

#### Returns

`this`
