@fnet/vast-vmap v0.1.1

@fnet/vast-vmap

This project is a module designed to support Video Ad Serving Template (VAST) and Digital Video Multiple Ad Playlist (VMAP) services. It is designed to simplify the process of creating ad campaigns and structuring the distribution of video ad content.

Main Functionality

The module's primary purpose is to establish an interface between an ad server and a video player's ad plugin. It supports the generation of VAST and VMAP documents using defined ad providers. The module iterates over a list of ad providers and generates a VMAP document structured according to VAST and VMAP standards.

VAST Compliance: The module supports the creation of ad sources from VAST documents. This support enables developers to provide their ad in an XML format and have it included within the VMAP document.

VMAP Compliance: The module uses VMAP format standards to structure ad breaks and include them in a formatted distribution document. Providers' ads are organized accordingly so that their ad content can be executed and displayed at scheduled times within video content.

Notable Features

• Ad Breaks Generation: The module's functionality includes creating ad breaks with specific attributes. Each ad break contains information about the source, extension details, and different properties such as time offset and break type.

• XML Prettification: The module formats XML strings to create clean and readable VMAP documents. This method of 'prettifying' XML improves the file's readability for developers, making the management of ad distributions easier.

• Multi-provider support: This module allows for multiple ad providers. Each provider in the configuration will be called iteratively to prepare its VAST data and build the final VMAP document.

• Flexible Ad Sources: Supports both inline ad data (XML format) and ad tags (URLs to VAST documents). This flexibility enables a more comfortable integration with diverse ad systems.

Final Output

Upon execution, the module forms an XML document confirming to VMAP specifications. This file can be utilized to feed a video player ad plugin with a defined sequence of ad breaks - providing instructions on how and when the particular ads should display. The variety of ad types supported includes pre-roll, mid-roll, post-roll, and banner ads.