Interface ReadonlyAdController

Read-only view of the ad breaks for the current media and which break, if any, currently contains the playhead.

interface ReadonlyAdController {
    currentAd: AdInfo | null;
    currentAdBreak: AdBreakInfo | null;
    currentTrackAds: TrackAds | null;
    hasAnyListeners(): boolean;
    hasListeners(type: keyof AdEventMap): boolean;
    on<K extends keyof AdEventMap>(
        type: K,
        handler: EventHandler<AdEventMap[K]>,
        options?: SignalOptions,
    ): Unsubscribe;
}

Hierarchy (View Summary)

ReadonlyEventHost<AdEventMap>
- ReadonlyAdController
  - AdController

Index

Properties

currentAd currentAdBreak currentTrackAds

Methods

hasAnyListeners hasListeners on

Properties

`Readonly`currentAd

currentAd: AdInfo | null

The ad currently playing within the active break, or null.

`Readonly`currentAdBreak

currentAdBreak: AdBreakInfo | null

The ad break currently containing the playhead, or null when the playhead is in primary content.

`Readonly`currentTrackAds

currentTrackAds: TrackAds | null

The ad breaks known for the current media.

Methods

hasAnyListeners

hasAnyListeners(): boolean
Returns true if the event host has any listeners.

Returns boolean
Inherited from ReadonlyEventHost.hasAnyListeners
- Defined in vinyl-util/src/event/EventHost.ts:45

hasListeners

hasListeners(type: keyof AdEventMap): boolean
Returns true if the event host has any listeners for the given type.
Parameters
- type: keyof AdEventMap
Returns boolean
Inherited from ReadonlyEventHost.hasListeners
- Defined in vinyl-util/src/event/EventHost.ts:50

on

on<K extends keyof AdEventMap>(
    type: K,
    handler: EventHandler<AdEventMap[K]>,
    options?: SignalOptions,
): Unsubscribe
Adds an event handler for the given typed event.
Type Parameters
- K extends keyof AdEventMap
Parameters
- type: K
  The key representing the event type to listen for.
- handler: EventHandler<AdEventMap[K]>
  A callback to invoke when the event with the given type is dispatched.
- Optionaloptions: SignalOptions
  Options for changing listening behavior.
Returns Unsubscribe
Returns a method, when invoked, removes the handler.
Inherited from ReadonlyEventHost.on
- Defined in vinyl-util/src/event/EventHost.ts:36