Interface Yospace

The Yospace API.

Remarks

- Available since v2.14.7.

interface Yospace {
    session: object;
    addEventListener<TType>(type, listener): void;
    registerPlayer(callbackCollection): void;
    removeEventListener<TType>(type, listener): void;
}

Hierarchy (view full)

EventDispatcher<YospaceEventMap>
- Yospace

Index

Properties

Methods

addEventListener registerPlayer removeEventListener

Properties

`Readonly` session

session: object

The Yospace session.

Methods

addEventListener

addEventListener<TType>(type, listener): void
Add the given listener for the given event type(s).
Type Parameters
- TType extends "sessionavailable"
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<YospaceEventMap[TType]>
  The callback which is executed when the event occurs.
Returns void
Inherited from EventDispatcher.addEventListener

registerPlayer

registerPlayer(callbackCollection): void
Register a set of callbacks to the player to the Yospace SDK.
Parameters
- callbackCollection: YospaceCallbackObject
  The YospaceCallbackObject
Returns void
Remarks

- These callbacks will be used by the Yospace SDK to provide feedback to the player.

removeEventListener

removeEventListener<TType>(type, listener): void
Remove the given listener for the given event type(s).
Type Parameters
- TType extends "sessionavailable"
Parameters
- type: TType | readonly TType[]
  The type of the event.
- listener: EventListener<YospaceEventMap[TType]>
  The callback which will be removed.
Returns void
Inherited from EventDispatcher.removeEventListener