Class VpaidAdUnit

This class provides everything necessary to run a Vpaid ad.

Hierarchy

VideoAdUnit
- VpaidAdUnit

Index

Constructors

constructor

new VpaidAdUnit(vastChain, videoAdContainer, options?): VpaidAdUnit
Creates a VpaidAdUnit.
Parameters
- vastChain: VastChain
  
  The VastChain with all the VastResponse
- videoAdContainer: VideoAdContainer
  
  container instance to place the ad
- options: VideoAdUnitOptions = {}
  
  Options Map
Returns VpaidAdUnit
Overrides VideoAdUnit.constructor
- Defined in adUnit/VpaidAdUnit.ts:347

Properties

`Optional` creativeAd

creativeAd?: VpaidCreativeAdUnit

Reference to the Vpaid Creative ad unit. Will be null before the ad unit starts.

`Optional` error

error?: AdUnitError

If an error occurs it will contain the reference to the error otherwise it will be bull

`Optional` errorCode

errorCode?: number

If an error occurs it will contain the Vast Error code of the error

type

type: string = 'VPAID'

Ad unit type. Will be VPAID for VpaidAdUnit

Methods

cancel

cancel(): Promise<void>
Cancels the ad unit.

Returns Promise<void>

Throws
if ad unit is finished.
Overrides VideoAdUnit.cancel
- Defined in adUnit/VpaidAdUnit.ts:494

currentTime

currentTime(): number
Returns the current time of the ad Creative or 0 if there is no creative.

Note: if the user has engaged with the ad, the currentTime becomes unknown and it will return 0;

Returns number
the current time of the ad unit.
Overrides VideoAdUnit.currentTime
- Defined in adUnit/VpaidAdUnit.ts:537

duration

duration(): number
Returns the duration of the ad Creative or 0 if there is no creative.

Note: if the user has engaged with the ad, the duration becomes unknown and it will return 0;

Returns number
the duration of the ad unit.
Overrides VideoAdUnit.duration
- Defined in adUnit/VpaidAdUnit.ts:516

emit

emit(eventName, ...args): boolean
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.
Parameters
- eventName: string
  
  The name of the event.
- Rest ...args: any[]
Returns boolean
Returns true if the event had listeners, false otherwise.
Inherited from VideoAdUnit.emit
- Defined in adUnit/helpers/Emitter/index.ts:100

getVolume

getVolume(): number
Gets the volume of the ad unit.

Returns number
the volume of the ad unit.

Throws
if ad unit is not started.

Throws
if ad unit is finished.
Overrides VideoAdUnit.getVolume
- Defined in adUnit/VpaidAdUnit.ts:481

isFinished

isFinished(): boolean
Returns boolean
true if the ad unit is finished and false otherwise
Inherited from VideoAdUnit.isFinished
- Defined in adUnit/VideoAdUnit.ts:436

isStarted

isStarted(): boolean
Returns boolean
true if the ad unit has started and false otherwise
Inherited from VideoAdUnit.isStarted
- Defined in adUnit/VideoAdUnit.ts:443

on

on(eventName, listener): VpaidAdUnit
Adds the listener function to the end of the listeners array for the event named eventName.
Parameters
- eventName: string
  
  The name of the event.
- listener: Listener
  
  Listener fn that handles the evt.
Returns VpaidAdUnit
The Emitter instance.
Inherited from VideoAdUnit.on
- Defined in adUnit/helpers/Emitter/index.ts:30

onError

onError(callback): void
Register a callback function that will be called if there is an error while running the ad.
Parameters
- callback: Listener
  
  will be called on ad unit error passing the Error instance and an object with the adUnit and the VastChain.
Returns void

Throws
if ad unit is finished.
Inherited from VideoAdUnit.onError
- Defined in adUnit/VideoAdUnit.ts:425

onFinish

onFinish(callback): void
Register a callback function that will be called whenever the ad finishes. No matter if it was finished because de ad ended, or cancelled or there was an error playing the ad.
Parameters
- callback: Listener
  
  will be called once the ad unit finished
Returns void

Throws
if ad unit is finished.
Inherited from VideoAdUnit.onFinish
- Defined in adUnit/VideoAdUnit.ts:410

once

once(eventName, listener): VpaidAdUnit
Adds a one time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.
Parameters
- eventName: string
  
  The name of the event.
- listener: Listener
  
  Listener fn that handles the evt.
Returns VpaidAdUnit
The Emitter instance.
Inherited from VideoAdUnit.once
- Defined in adUnit/helpers/Emitter/index.ts:82

pause

pause(): void
Pauses the ad unit.

Returns void

Throws
if ad unit is not started.

Throws
if ad unit is finished.
Overrides VideoAdUnit.pause
- Defined in adUnit/VpaidAdUnit.ts:440

paused

paused(): boolean
Returns true if the ad is paused and false otherwise

Returns boolean
Overrides VideoAdUnit.paused
- Defined in adUnit/VpaidAdUnit.ts:457

removeAllListeners

removeAllListeners(eventName): VpaidAdUnit
Removes all listeners, or those of the specified eventName.
Parameters
- eventName: string
  
  The name of the event. Optional if omitted all listeners will be removed.
Returns VpaidAdUnit
The Emitter instance.
Inherited from VideoAdUnit.removeAllListeners
- Defined in adUnit/helpers/Emitter/index.ts:64

removeListener

removeListener(eventName, listener): VpaidAdUnit
Removes the specified listener from the listener array for the event named eventName.
Parameters
- eventName: string
  
  The name of the event.
- listener: Listener
  
  Listener fn that handles the evt.
Returns VpaidAdUnit
The Emitter instance.
Inherited from VideoAdUnit.removeListener
- Defined in adUnit/helpers/Emitter/index.ts:46

resize

resize(width, height, viewmode): Promise<void>
This method resizes the ad unit to fit the available space in the passed VideoAdContainer
Parameters
- width: number
- height: number
- viewmode: string
Returns Promise<void>
Promise that resolves once the unit was resized

Throws
if ad unit is not started.

Throws
if ad unit is finished.
Overrides VideoAdUnit.resize
- Defined in adUnit/VpaidAdUnit.ts:559

resume

resume(): void
Resumes a previously paused ad unit.

Returns void

Throws
if ad unit is not started.

Throws
if ad unit is finished.
Overrides VideoAdUnit.resume
- Defined in adUnit/VpaidAdUnit.ts:430

setVolume

setVolume(volume): void
Sets the volume of the ad unit.
Parameters
- volume: number
  
  must be a value between 0 and 1;
Returns void

Throws
if ad unit is not started.

Throws
if ad unit is finished.
Overrides VideoAdUnit.setVolume
- Defined in adUnit/VpaidAdUnit.ts:469

skip

skip(): void
Skip the ad unit.

Returns void

Throws
if ad unit is not started.

Throws
if ad unit is finished.
Overrides VideoAdUnit.skip
- Defined in adUnit/VpaidAdUnit.ts:450

start

start(): Promise<void>
Starts the ad unit.

Returns Promise<void>

Throws
if called twice.

Throws
if ad unit is finished.
Overrides VideoAdUnit.start
- Defined in adUnit/VpaidAdUnit.ts:366

Class VpaidAdUnit

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

vastChain: VastChain

videoAdContainer: VideoAdContainer

options: VideoAdUnitOptions = {}

Returns VpaidAdUnit

Properties

Optional creativeAd

Optional error

Optional errorCode

type

Methods

cancel

Returns Promise<void>

Throws

currentTime

Returns number

duration

Returns number

emit

Parameters

eventName: string

Rest ...args: any[]

Returns boolean

getVolume

Returns number

Throws

Throws

isFinished

Returns boolean

isStarted

Returns boolean

on

Parameters

eventName: string

listener: Listener

Returns VpaidAdUnit

onError

Parameters

callback: Listener

Returns void

Throws

onFinish

Parameters

callback: Listener

Returns void

Throws

once

Parameters

eventName: string

listener: Listener

Returns VpaidAdUnit

pause

Returns void

Throws

Throws

paused

Returns boolean

removeAllListeners

Parameters

eventName: string

Returns VpaidAdUnit

removeListener

Parameters

eventName: string

listener: Listener

Returns VpaidAdUnit

resize

Parameters

width: number

height: number

viewmode: string

Returns Promise<void>

`Optional` creativeAd

`Optional` error

`Optional` errorCode

`Rest` ...args: any[]