Interface Advert

interface Advert {
    addMacroSubstitution(key, value): void;
    getAdType(): string;
    getAdVerifications(): AdVerification[];
    getCompanionAdsByType(type): CompanionCreative[];
    getCompanionRequired(): string;
    getDuration(): number;
    getIdentifier(): string;
    getLinearCreative(): LinearCreative;
    getMediaIdentifier(): string;
    getNonLinearCreativesByType(type): NonLinearCreative[];
    getProperties(): VASTProperty[];
    getProperty(name): null | VASTProperty;
    getRemainingTime(playhead): number;
    getSequence(): number;
    getSkipOffset(): number;
    getStart(): number;
    isActive(): boolean;
    isFiller(): boolean;
    isNonLinear(): boolean;
    onErrorEvent(errorCode?): void;
    onImpressionEvent(): void;
    onViewableEvent(event): void;
}

Hierarchy (view full)

Methods

addMacroSubstitution getAdType getAdVerifications getCompanionAdsByType getCompanionRequired getDuration getIdentifier getLinearCreative getMediaIdentifier getNonLinearCreativesByType getProperties getProperty getRemainingTime getSequence getSkipOffset getStart isActive isFiller isNonLinear onErrorEvent onImpressionEvent onViewableEvent

Methods

addMacroSubstitution

  • addMacroSubstitution(key, value): void

  • Parameters

    • key: string
    • value: string

    Returns void

getAdType

getAdVerifications

getCompanionAdsByType

getCompanionRequired

getDuration

getIdentifier

getLinearCreative

getMediaIdentifier

getNonLinearCreativesByType

getProperties

getProperty

getRemainingTime

  • getRemainingTime(playhead): number

  • Parameters

    • playhead: number

    Returns number

getSequence

getSkipOffset

getStart

isActive

isFiller

isNonLinear

onErrorEvent

onImpressionEvent

onViewableEvent

Settings

Member Visibility

Theme

On This Page

addMacroSubstitutiongetAdTypegetAdVerificationsgetCompanionAdsByTypegetCompanionRequiredgetDurationgetIdentifiergetLinearCreativegetMediaIdentifiergetNonLinearCreativesByTypegetPropertiesgetPropertygetRemainingTimegetSequencegetSkipOffsetgetStartisActiveisFillerisNonLinearonErrorEventonImpressionEventonViewableEvent

Generated using TypeDoc