---
url: https://docs.moqtail.dev/ts/api/player/interfaces/ElementContext.md
---
# Interface: ElementContext

Given to `init`, one per element instance.

## Properties

### catalog?

> `readonly` `optional` **catalog?**: [`CatalogReader`](CatalogReader.md)

Set for elements the catalog loads, and inherited by what they load.

***

### client

> `readonly` **client**: [`MOQtailClient`](../../client/classes/MOQtailClient.md)

Always the current client, it changes after a reconnect.

***

### player

> `readonly` **player**: [`PlayerHandle`](../type-aliases/PlayerHandle.md)

***

### signal

> `readonly` **signal**: `AbortSignal`

Aborted when the instance is destroyed.

***

### tracks

> `readonly` **tracks**: readonly (`object` & `object` & `object`)\[]

The tracks this instance was loaded for, empty without a catalog.

***

### worker?

> `readonly` `optional` **worker?**: `object`

Set while the player has a worker and the definition's `threads` allows it.

#### bridge()

> **bridge**(`pad`): `void`

Sends them to `receive()` on the main thread instead. Each worker pad the element takes needs one of the two.

##### Parameters

###### pad

[`Pad`](../classes/Pad.md)

##### Returns

`void`

#### create()

> **create**<`E`>(`name`, `request?`): `Remote`<`E`>

Creates the engine `serveWorker` registered as `name`. Calls on it queue until it exists, and a
failure to create it reaches `context.fail`.

##### Type Parameters

###### E

`E` *extends* [`Engine`](../worker/interfaces/Engine.md)

##### Parameters

###### name

`string`

###### request?

###### options?

`object`

The engine's `init.options`.

###### outputs?

[`Pad`](../classes/Pad.md)\[]

Source pads of the element, carrying `THREAD` `worker`: the engine's `init.outputs`, in order.

###### report?

(`report`) => `void`

The engine's `init.report`.

###### transfer?

`Transferable`\[]

Transferred with `options`, for example an `OffscreenCanvas`.

##### Returns

`Remote`<`E`>

#### has()

> **has**(`name`): `boolean`

##### Parameters

###### name

`string`

##### Returns

`boolean`

#### inWorker()

> **inWorker**(`pad`): `boolean`

Whether `pad` is a worker pad, or a sink pad one feeds.

##### Parameters

###### pad

[`Pad`](../classes/Pad.md)

##### Returns

`boolean`

#### link()

> **link**(`pad`, `engine`): `void`

Sends the items of `pad`, a sink pad fed by a worker pad, to `engine` in the worker.

##### Parameters

###### pad

[`Pad`](../classes/Pad.md)

###### engine

`Remote`<[`Engine`](../worker/interfaces/Engine.md)>

##### Returns

`void`

## Methods

### attach()

> **attach**(`element`): `void`

Called by the `BaseElement` constructor, so the player hears what the instance emits.

#### Parameters

##### element

[`BaseElement`](../classes/BaseElement.md)

#### Returns

`void`

***

### cost()

> **cost**(`track`): `Promise`<`number` | `undefined`>

How many transforms the chain would load to take the pad of the source `probe()` picks for `track`
to a declared sink. Undefined when none is reached, or an element on the way doesn't `supports` the
track. 0 without declared sinks, or for a source whose definition doesn't say what pad it makes.
Worked out from capabilities, not `negotiate`: a declared transform that declines a pad it could take,
as WebCodecs does past its first, still gets transforms loaded for it.

#### Parameters

##### track

[`Identifiers`](Identifiers.md)

#### Returns

`Promise`<`number` | `undefined`>

***

### fail()

> **fail**(`error`): `void`

Reports a fatal error from outside `receive()`, such as a decoder's or an engine's.

#### Parameters

##### error

[`PlayerError`](../classes/PlayerError.md)

#### Returns

`void`

***

### load()

> **load**<`E`>(`definition`, `request?`): `Promise`<`E`>

Returns the existing instance when the same definition and tracks are already loaded.

#### Type Parameters

##### E

`E` *extends* [`BaseElement`](../classes/BaseElement.md)

#### Parameters

##### definition

[`ElementDefinition`](ElementDefinition.md)<`E`>

##### request?

[`ElementLoadRequest`](ElementLoadRequest.md)

#### Returns

`Promise`<`E`>

***

### probe()

> **probe**(`identifiers`): [`SourceElementDefinition`](SourceElementDefinition.md)<[`SourceElement`](../classes/SourceElement.md), readonly (keyof [`ElementInterfaces`](ElementInterfaces.md))\[]> | `undefined`

The source definition the player would pick for `identifiers`, as `source()` does.

#### Parameters

##### identifiers

[`Identifiers`](Identifiers.md)

#### Returns

[`SourceElementDefinition`](SourceElementDefinition.md)<[`SourceElement`](../classes/SourceElement.md), readonly (keyof [`ElementInterfaces`](ElementInterfaces.md))\[]> | `undefined`

***

### release()

> **release**(`element`): `Promise`<`void`>

Drops this element's reference to one it loaded; it's destroyed once no holder is left.

#### Parameters

##### element

[`BaseElement`](../classes/BaseElement.md)

#### Returns

`Promise`<`void`>

***

### switchSource()

> **switchSource**(`identifiers`): [`SourceElementDefinition`](SourceElementDefinition.md)<[`SourceElement`](../classes/SourceElement.md), readonly (keyof [`ElementInterfaces`](ElementInterfaces.md))\[]> | `undefined`

The active plugins' switch source that ranks first for `identifiers`, as `probe()` ranks.

#### Parameters

##### identifiers

[`Identifiers`](Identifiers.md)

#### Returns

[`SourceElementDefinition`](SourceElementDefinition.md)<[`SourceElement`](../classes/SourceElement.md), readonly (keyof [`ElementInterfaces`](ElementInterfaces.md))\[]> | `undefined`
