Digital Playprint - magic-lantern-studio/mle-documentation GitHub Wiki
The Digital Playprint is a runtime translation of a Digital Workprint. The Digital Playprint is consumed by a Runtime Player or engine on the target platform. Thus the playprint must be mastered for a particular platform.
Table of Contents
Introduction
This document describes an API for accessing digital playprints during runtime. It also identifies the tools used for creating and manipulating the Digital Playprint and the components from which the playprint is comprised of.
Operational Codes
The Digital Playprint is essentially a binary representation of the Digital Workprint. It consists of an instruction set used to recreate the workprint during runtime. The instruction set is documented in the following table:
| Instruction | Opcode (Hex) | Opcode (Decimal) | Description |
|---|---|---|---|
| beginActorSet | 0x80 | 128 | Deprecated. Sets are specified through Role bindings. |
| createActor | 0x81 | 129 | Create an Actor. |
| setSet | 0x82 | 130 | Define the active Set. |
| bindRole | 0x83 | 131 | Bind a Role to a Set. If necessary, the Set will be created at this time. |
| parentRole | 0x84 | 132 | Identify the parent for the current Role. |
| childRole | 0x85 | 133 | Identify a child for the current Role. |
| setPropertyOffset | 0x86 | 134 | Set the property offset for the current Actor or Set. |
| setPropertyLength | 0x87 | 135 | Set the length of the property for the current Actor or Set. |
| copyProperty | 0x88 | 136 | Copy the property into the current Actor or Set. |
| copyMediaRef | 0x89 | 137 | Copy the Media Reference into the current Actor or Set |
| endActorGroup | 0x8a | 138 | Complete Actor Group creation and initalization. |
| copyDynamicProperty | 0x8b | 139 | Copy a dynamic property of variable length (i.e. string) into an Actor or Set. |
| copyArrayProperty | 0x8c | 140 | Copy an array of properties into an Actor or Set. |
| createSet | 0x8d | 141 | Create a Set. |
| endSet | 0x8e | 142 | Complete Set creation. |