Runtime Engine Library - magic-lantern-android-studio/mle-documentation GitHub Wiki

The Magic Lantern Software Development Kit provides a runtime engine to facilitate title execution. In fact, if a title is not using the Magic Lantern Runtime Engine, then it is not a Magic Lantern title. The Runtime Engine controls the lifecycle of the title.

The execution model that contols the sequencing of Magic Lantern titles is a cyclic process repeated once per frame. Each actor, role, set, and stage receives control of the processor, in that order. By default, on each frame, all of the actors execute before any of the roles; all of the roles execute before any of the sets, etc. This scheduling order is not strict, however, since an actor may explicitly pass control to its role and that role may explicitly pass control to its set. Programmers can also reorder or augment the scheduling.

The idea behind tha actors-then-roles-then-sets-then-stage ordering is that first the interactivity is computed (actors), then the presentation is computed (roles), then the various resource controllers gain control (sets), then the entire frame presentation is created (stage).

The Runtime Engine Library povides support for:

  1. Interface and base classes for Actor, Role, Media Reference, Set, Stage and Prop title components,
  2. Event dispatching,
  3. Scheduling of title execution,
  4. Reading and processing the Digital Playprint.

Table of Contents

Documentation

The Runtime Engine Library API documentation can be found in the form of Javadoc and HTML pages.

API for Java Packages

API documentation for the Java packages are not currently available online. To generate the Javadoc using the Android Studio project for the Runtime Engine Library, simply follow these instructions:

  1. In the core-runtime project, select Tools->Generate JavaDoc... in the main toolbar.
  2. In the pop-up dialog, specify the directory where the documentation will be generated. We suggest ~/MagicLantern/core-runtime/doc.
  3. The Javadoc HTML will be generated in the project's doc directory.