THEOplayer Web SDK Connectors
    Preparing search index...

    Interface Advert

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

    Hierarchy (View Summary)

    Index

    Properties

    broker

    Methods

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

    Properties

    broker: YospaceSession

    Methods

    • Parameters

      • key: string
      • value: string

      Returns void

    • Parameters

      • playhead: number

      Returns number

    Settings

    Member Visibility

    On This Page

    Properties
    Methods