makeMovie: Make a Movie
In pmur002/director: Automate video demonstrations

Description Usage Arguments Details Value Author(s) See Also

View source: R/director.R

Make a movie from an XML script file.

makeMovie(filename,
          wd=paste0(gsub("[.]xml$", "", filename), "-movie"),
          TTS=espeakTTS(),
          world=realWorld,
          validate=TRUE,
          clean=FALSE)

`filename`	The name of an XML script file.
`wd`	A path to a working directory, where all files will be created.
`TTS`	An object that can turn text into audio; see `TTS`.
`world`	The world that the movie will be set in; see `realWorld`.
`validate`	Should the script be validated against a DTD.
`clean`	A logical indicating whether to erase the working directory before beginning recording.

The XML file is assumed to have the following structure:

A root element called script, containing ...
A single setting element (optional).
A single stage element with width and height attributes.
One or more scene elements (with optional id and record attributes), containing ...
- One or more shot elements (with optional duration, location and id attributes), containing ...
  - Zero or one keyaction or pointeraction elements, zero or onw location elements, and zero or one dialogue elements.
    
    The keyaction element can have keydelay and linedelay attributes. The content of the keyaction element will be fed as key events to the location that is identified by the location attribute of the keyaction element. If the location is "backstage", the code within the keyaction is just run in a shell.
    
    Each location must have an id attribute and can have x, y, width, and height attributes. The location corresponds to the window that is generated by the keyaction or pointeraction (if any).
    
    A dialogue element contains either text or a speak element that describes dialogue using Speech Synthesis Markup Language (SSML) https://www.w3.org/TR/speech-synthesis11/.

The package contains a DTD for the script structure (see the DTD directory in the installed package) and, if validate is TRUE, the script is validated against that DTD.

A list containing the path to the complete final video, plus paths to individual scene video files.

Paul Murrell

TTS, realWorld.

pmur002/director documentation built on Feb. 18, 2021, 10:23 p.m.