middleware.js

Members

static, constant allowedGetters :Object

[tech/middleware.js](https://docs.videojs.com/tech_middleware.js.html), [line 183](https://docs.videojs.com/tech_middleware.js.html#line183)

Enumeration of allowed getters where the keys are method names.

static, constant allowedMediators :Object

[tech/middleware.js](https://docs.videojs.com/tech_middleware.js.html), [line 210](https://docs.videojs.com/tech_middleware.js.html#line210)

Enumeration of allowed mediators where the keys are method names.

static, constant allowedSetters :Object

[tech/middleware.js](https://docs.videojs.com/tech_middleware.js.html), [line 199](https://docs.videojs.com/tech_middleware.js.html#line199)

Enumeration of allowed setters where the keys are method names.

Methods

static clearCacheForPlayer(player)

[tech/middleware.js](https://docs.videojs.com/tech_middleware.js.html), [line 246](https://docs.videojs.com/tech_middleware.js.html#line246)

Clear the middleware cache for a player.

Parameters:

static get(middleware, tech, method) → {Mixed}

[tech/middleware.js](https://docs.videojs.com/tech_middleware.js.html), [line 115](https://docs.videojs.com/tech_middleware.js.html#line115)

Calls a getter on the tech first, through each middleware from right to left to the player.

Parameters:

Returns:

Mixed -

The final value from the tech after middleware has intercepted it.

static getMiddleware(type) → {Array.<function()>|undefined}

[tech/middleware.js](https://docs.videojs.com/tech_middleware.js.html), [line 60](https://docs.videojs.com/tech_middleware.js.html#line60)

Gets middlewares by type (or all middlewares).

Parameters:

Returns:

Array.<function()> | undefined -

An array of middlewares or undefined if none exist.

static mediate(middleware, tech, method, arg) → {Mixed}

[tech/middleware.js](https://docs.videojs.com/tech_middleware.js.html), [line 165](https://docs.videojs.com/tech_middleware.js.html#line165)

Takes the argument given to the player and calls the call version of the method on each middleware from left to right.

Then, call the passed in method on the tech and return the result unchanged back to the player, through middleware, this time from right to left.

Parameters:

Returns:

Mixed -

The return value of the method of the tech, regardless of the return values of middlewares.

static set(middleware, tech, method, arg) → {Mixed}

[tech/middleware.js](https://docs.videojs.com/tech_middleware.js.html), [line 138](https://docs.videojs.com/tech_middleware.js.html#line138)

Takes the argument given to the player and calls the setter method on each middleware from left to right to the tech.

Parameters:

Returns:

Mixed -

The return value of the method of the tech.

static setSource(player, src, The)

[tech/middleware.js](https://docs.videojs.com/tech_middleware.js.html), [line 82](https://docs.videojs.com/tech_middleware.js.html#line82)

Asynchronously sets a source using middleware by recursing through any matching middlewares and calling setSource on each, passing along the previous returned value each time.

Parameters:

static setTech(middleware, tech)

[tech/middleware.js](https://docs.videojs.com/tech_middleware.js.html), [line 95](https://docs.videojs.com/tech_middleware.js.html#line95)

When the tech is set, passes the tech to each middleware’s setTech method.

Parameters:

static use(type, middleware)

[tech/middleware.js](https://docs.videojs.com/tech_middleware.js.html), [line 46](https://docs.videojs.com/tech_middleware.js.html#line46)

Define a middleware that the player should use by way of a factory function that returns a middleware object.

Parameters:

Type Definitions

MiddlewareFactory(player)

[tech/middleware.js](https://docs.videojs.com/tech_middleware.js.html), [line 23](https://docs.videojs.com/tech_middleware.js.html#line23)

A middleware factory function that should return a MiddlewareObject.

This factory will be called for each player when needed, with the player passed in as an argument.

Parameters:

MiddlewareObject

[tech/middleware.js](https://docs.videojs.com/tech_middleware.js.html), [line 13](https://docs.videojs.com/tech_middleware.js.html#line13)

A middleware object is a plain JavaScript object that has methods that match the Tech methods found in the lists of allowed getters, setters, and mediators.