Class YospaceConnector

Implements

EventDispatcher<YospaceEventMap>

Index

Constructors

Methods

addEventListener registerAnalyticEventObserver removeEventListener setupYospaceSession unregisterAnalyticEventObserver

Constructors

constructor

new YospaceConnector(player: ChromelessPlayer): YospaceConnector
Parameters
- player: ChromelessPlayer
Returns YospaceConnector
- Defined in integration/YospaceConnector.ts:20

Methods

addEventListener

addEventListener<TType extends "sessionavailable">(
type: TType | TType[],
listener: EventListener<YospaceEventMap[TType]>,
): void
Add the given listener for the given event type(s).
Type Parameters
- TType extends "sessionavailable"
Parameters
- type: TType | TType[]
  The type of the event.
- listener: EventListener<YospaceEventMap[TType]>
  The callback which is executed when the event occurs.
Returns void
Implementation of EventDispatcher.addEventListener
- Defined in integration/YospaceConnector.ts:65

registerAnalyticEventObserver

registerAnalyticEventObserver(
analyticEventObserver: AnalyticEventObserver,
): void
Register an analytics event observer to the Yospace SDK.
Parameters
- analyticEventObserver: AnalyticEventObserver
  the observer that will be registered to the Yospace SDK.
Returns void
Throws
Error if the session is not yet initialised.
- Defined in integration/YospaceConnector.ts:52

removeEventListener

removeEventListener<TType extends "sessionavailable">(
type: TType | TType[],
listener: EventListener<YospaceEventMap[TType]>,
): void
Remove the given listener for the given event type(s).
Type Parameters
- TType extends "sessionavailable"
Parameters
- type: TType | TType[]
  The type of the event.
- listener: EventListener<YospaceEventMap[TType]>
  The callback which will be removed.
Returns void
Implementation of EventDispatcher.removeEventListener
- Defined in integration/YospaceConnector.ts:72

setupYospaceSession

setupYospaceSession(
sourceDescription: SourceDescription,
sessionProperties?: SessionProperties,
): Promise<void>
Creates the Yospace session and sets the Yospace source from the session to the player.

As of THEOplayer 7.4.0, you can also set player.source directly instead of using this method.
Parameters
- sourceDescription: SourceDescription
  The source that will be used to create the Yospace session. This should have at least one source whose TypedSource.ssai is a YospaceServerSideAdInsertionConfiguration.
- OptionalsessionProperties: SessionProperties
  The properties that will be used set to customize the Yospace session.
Returns Promise<void>
Throws
Error if the Yospace Ad Management SDK is not available.

Throws
Error if something goes wrong in setting up the session.
- Defined in integration/YospaceConnector.ts:39

unregisterAnalyticEventObserver

unregisterAnalyticEventObserver(
analyticEventObserver: AnalyticEventObserver,
): void
Unregister an analytics event observer from the Yospace SDK.
Parameters
- analyticEventObserver: AnalyticEventObserver
  the observer that will be unregistered from the Yospace SDK.
Returns void
- Defined in integration/YospaceConnector.ts:61