video-ad-sdk/dist/vastRequest/requestNextAd.d.ts

VAST/VPAID SDK that allows video ads to be played on top of any player

import type { VastChain } from '../types';
import { type RequestAdOptions } from './requestAd';
/**
 * Options map to {link @requestNextAd}
 */
export interface RequestNextAdOptions extends RequestAdOptions {
    /**
     * Specifies whether to use buffet ads from an ad pod if possible.
     * If no buffet ad is available it will return the next ad in ad pod sequence.
     * Set it to true if an ad from an adPod failed and you want to replace it with an ad from the ad buffet.
     * Defaults to `false`.
     */
    useAdBuffet?: boolean;
    /**
     * Tells the video player to select an ad from any stand-alone ads available.
     * Note: if the {@link VastChain} contains an adPod this property will be ignored.
     * Defaults to `true`.
     */
    fallbackOnNoAd?: boolean;
}
/**
 * Requests the next ad in the VAST Chain.
 *
 * @param vastChain Array of {@link VastResponse}.
 * @param options Options Map. The allowed properties are:
 * @returns Returns a Promise that will resolve with a VastChain with the newest VAST response at the beginning of the array.
 * If the {@link VastChain} had an error. The first VAST response of the array will contain an error and an errorCode entry.
 */
export declare const requestNextAd: (vastChain: VastChain, options: RequestNextAdOptions) => Promise<VastChain>;