[@liveryvideo/interactive-bridge](../index.md) / MockPlayerBridge

# Class: MockPlayerBridge

Mock player bridge for testing purposes; returning dummy values where real values are not available.
And with dummy support for custom command: `subscribeAuthToken` as used on the test page.

## Extends

- [`AbstractPlayerBridge`](AbstractPlayerBridge.md)

## Methods

### authenticate()

> **authenticate**(`tokenOrClaims?`): `Promise`\<`unknown`\>

Authenticate user in interactive layer with specified token or claims,
or logout the user by passing an `undefined` value.

#### Parameters

##### tokenOrClaims?

JWT token string or claims to authenticate with or undefined to logout

`string` | [`AuthClaims`](../interfaces/AuthClaims.md)

#### Returns

`Promise`\<`unknown`\>

#### Inherited from

[`AbstractPlayerBridge`](AbstractPlayerBridge.md).[`authenticate`](AbstractPlayerBridge.md#authenticate)

***

### ~~options()~~

> **options**(): `Promise`\<[`InteractivePlayerOptions`](../interfaces/InteractivePlayerOptions.md)\>

Returns promise of options from interactive layer for the player.
Or default options if the interactive bridge doesn't support this/these yet.

Note: In the future this could also pass options from player to the interactive layer.

#### Returns

`Promise`\<[`InteractivePlayerOptions`](../interfaces/InteractivePlayerOptions.md)\>

#### Deprecated

In the next major version options passing should be integrated into the LiveryBridge handshake.

#### Inherited from

[`AbstractPlayerBridge`](AbstractPlayerBridge.md).[`options`](AbstractPlayerBridge.md#options)

***

### registerPlayerCommand()

> **registerPlayerCommand**(`name`, `handler`): `void`

Register `handler` function to be called with `arg` and `listener` when `sendPlayerCommand()` is called
from the interactive layer side with matching `name`.

#### Parameters

##### name

`string`

##### handler

(`arg`, `listener`) => `unknown`

#### Returns

`void`

#### Inherited from

[`AbstractPlayerBridge`](AbstractPlayerBridge.md).[`registerPlayerCommand`](AbstractPlayerBridge.md#registerplayercommand)

***

### sendInteractiveCommand()

> **sendInteractiveCommand**(`name`, `arg?`, `listener?`): `Promise`\<`unknown`\>

Returns promise of value returned by the interactive layer's custom command handler with matching `name` that is passed `arg`.
Any `handler` `listener` calls will subsequently also be bridged to this `listener` callback.

#### Parameters

##### name

`string`

##### arg?

`unknown`

##### listener?

(`value`) => `void`

#### Returns

`Promise`\<`unknown`\>

#### Inherited from

[`AbstractPlayerBridge`](AbstractPlayerBridge.md).[`sendInteractiveCommand`](AbstractPlayerBridge.md#sendinteractivecommand)

***

### unregisterPlayerCommand()

> **unregisterPlayerCommand**(`name`): `void`

Unregister custom interactive command by name.

#### Parameters

##### name

`string`

#### Returns

`void`

#### Inherited from

[`AbstractPlayerBridge`](AbstractPlayerBridge.md).[`unregisterPlayerCommand`](AbstractPlayerBridge.md#unregisterplayercommand)