Module API - end-user/story

Description

A story is the entry point of BeamToIX web browser library. It has the following functions:

• Manage multiple scenes, including insert and remove.
• Manage scene transitions.
• Manage flyovers.
• Start the rendering process.
• Communicate with the render server agent.
• Load the complete story from a configuration file.

The workflow summary is:

• A story automatically creates DOM scenes.
• In each scene, the user adds its animations.
• The user executes story.render which will process the animation pipeline frame by frame and sends it to the render server agent.
• The render server agent will communicate with a headless server such as puppeteer to store each frame on the disk.