@adcp/client API Reference - v4.19.0
    Preparing search index...

    Type Alias VASTAsset

    VASTAsset:
        | {
            delivery_type: "url";
            url: string;
            vast_version?: VASTVersion;
            vpaid_enabled?: boolean;
            duration_ms?: number;
            tracking_events?: VASTTrackingEvent[];
            captions_url?: string;
            audio_description_url?: string;
            provenance?: Provenance;
        }
        | {
            delivery_type: "inline";
            content: string;
            vast_version?: VASTVersion;
            vpaid_enabled?: boolean;
            duration_ms?: number;
            tracking_events?: VASTTrackingEvent[];
            captions_url?: string;
            audio_description_url?: string;
            provenance?: Provenance;
        }

    VAST (Video Ad Serving Template) tag for third-party video ad serving

    Type Declaration

    • {
          delivery_type: "url";
          url: string;
          vast_version?: VASTVersion;
          vpaid_enabled?: boolean;
          duration_ms?: number;
          tracking_events?: VASTTrackingEvent[];
          captions_url?: string;
          audio_description_url?: string;
          provenance?: Provenance;
      }
      • delivery_type: "url"

        Discriminator indicating VAST is delivered via URL endpoint

      • url: string

        URL endpoint that returns VAST XML

      • Optionalvast_version?: VASTVersion
      • Optionalvpaid_enabled?: boolean

        Whether VPAID (Video Player-Ad Interface Definition) is supported

      • Optionalduration_ms?: number

        Expected video duration in milliseconds (if known)

      • Optionaltracking_events?: VASTTrackingEvent[]

        Tracking events supported by this VAST tag

      • Optionalcaptions_url?: string

        URL to captions file (WebVTT, SRT, etc.)

      • Optionalaudio_description_url?: string

        URL to audio description track for visually impaired users

      • Optionalprovenance?: Provenance
    • {
          delivery_type: "inline";
          content: string;
          vast_version?: VASTVersion;
          vpaid_enabled?: boolean;
          duration_ms?: number;
          tracking_events?: VASTTrackingEvent[];
          captions_url?: string;
          audio_description_url?: string;
          provenance?: Provenance;
      }
      • delivery_type: "inline"

        Discriminator indicating VAST is delivered as inline XML content

      • content: string

        Inline VAST XML content

      • Optionalvast_version?: VASTVersion
      • Optionalvpaid_enabled?: boolean

        Whether VPAID (Video Player-Ad Interface Definition) is supported

      • Optionalduration_ms?: number

        Expected video duration in milliseconds (if known)

      • Optionaltracking_events?: VASTTrackingEvent[]

        Tracking events supported by this VAST tag

      • Optionalcaptions_url?: string

        URL to captions file (WebVTT, SRT, etc.)

      • Optionalaudio_description_url?: string

        URL to audio description track for visually impaired users

      • Optionalprovenance?: Provenance