Class VideoAdUnit

This class provides shared logic among all the ad units.

Hierarchy

Emitter
- VideoAdUnit
  - VastAdUnit
  - VpaidAdUnit

Index

Constructors

constructor

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

Properties

`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

`Optional` type

type?: string

Ad unit type

Methods

cancel

cancel(): void
Cancels the ad unit.

Returns void

Throws
if ad unit is finished.
- Defined in adUnit/VideoAdUnit.ts:374

currentTime

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

Returns void
the current time of the ad unit.
- Defined in adUnit/VideoAdUnit.ts:399

duration

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

Returns void
the duration of the ad unit.
- Defined in adUnit/VideoAdUnit.ts:383

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 Emitter.emit
- Defined in adUnit/helpers/Emitter/index.ts:100

getVolume

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

Returns void
the volume of the ad unit.

Throws
if ad unit is not started.

Throws
if ad unit is finished.
- Defined in adUnit/VideoAdUnit.ts:365

isFinished

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

isStarted

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

on

on(eventName, listener): VideoAdUnit
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 VideoAdUnit
The Emitter instance.
Inherited from Emitter.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.
- 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.
- Defined in adUnit/VideoAdUnit.ts:410

once

once(eventName, listener): VideoAdUnit
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 VideoAdUnit
The Emitter instance.
Inherited from Emitter.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.
- Defined in adUnit/VideoAdUnit.ts:331

paused

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

Returns void
- Defined in adUnit/VideoAdUnit.ts:390

removeAllListeners

removeAllListeners(eventName): VideoAdUnit
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 VideoAdUnit
The Emitter instance.
Inherited from Emitter.removeAllListeners
- Defined in adUnit/helpers/Emitter/index.ts:64

removeListener

removeListener(eventName, listener): VideoAdUnit
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 VideoAdUnit
The Emitter instance.
Inherited from Emitter.removeListener
- Defined in adUnit/helpers/Emitter/index.ts:46

resize

resize(width, height, mode): Promise<void>
This method resizes the ad unit to fit the available space in the passed VideoAdContainer
Parameters
- width: number
- height: number
- mode: 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.
- Defined in adUnit/VideoAdUnit.ts:455

resume

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

Returns void

Throws
if ad unit is not started.

Throws
if ad unit is finished.
- Defined in adUnit/VideoAdUnit.ts:321

setVolume

setVolume(_volume): void
Sets the volume of the ad unit.
Parameters
- _volume: number
Returns void

Throws
if ad unit is not started.

Throws
if ad unit is finished.
- Defined in adUnit/VideoAdUnit.ts:353

skip

skip(): void
Skips the ad unit.

Returns void

Throws
if ad unit is not started.

Throws
if ad unit is finished.
- Defined in adUnit/VideoAdUnit.ts:341

Class VideoAdUnit

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

vastChain: VastChain

videoAdContainer: VideoAdContainer

options: VideoAdUnitOptions = {}

Returns VideoAdUnit

Properties

Optional error

Optional errorCode

Optional type

Methods

cancel

Returns void

Throws

currentTime

Returns void

duration

Returns void

emit

Parameters

eventName: string

Rest ...args: any[]

Returns boolean

getVolume

Returns void

Throws

Throws

isFinished

Returns boolean

isStarted

Returns boolean

on

Parameters

eventName: string

listener: Listener

Returns VideoAdUnit

onError

Parameters

callback: Listener

Returns void

Throws

onFinish

Parameters

callback: Listener

Returns void

Throws

once

Parameters

eventName: string

listener: Listener

Returns VideoAdUnit

pause

Returns void

Throws

Throws

paused

Returns void

removeAllListeners

Parameters

eventName: string

Returns VideoAdUnit

removeListener

Parameters

eventName: string

listener: Listener

Returns VideoAdUnit

resize

Parameters

width: number

height: number

mode: string

Returns Promise<void>

Throws

`Optional` error

`Optional` errorCode

`Optional` type

`Rest` ...args: any[]