Documentation

Introduction
Interactive Tutorials
Overview
Frequently Asked Questions
Supported operating systems and browsers
Managing your company
- Dashboard
- Company details
- Managing projects
- Generate Screens
- Backup
- Managing publications
- Manage access rights
- Managing workflow (Kanban)
- Extended metadata
- Support
- External Platform Integration
Creating a new presentation
- Managing metadata
- Font size selection
- Style of the lesson
- Fixed or changeable page size
Managing lessons
- Lesson details
Managing assets
- Updating assets
- Uploading assets
- Video and Audio file formats
- Online resources
- Downloading assets
- Asset Repository
Page management
- Navigation pages and Commons
- Page Navigation Styling
- Header and Footer
- Adding and deleting pages, changing pages order
- Copying pages between presentations
- Changing page size
- Splitting pages
- Page names
- Adding template pages
- Subset of pages
- Merging lessons
- Custom page loader
- Pop-up
Working with templates
- Creating and managing templates
- Private templates
- Public templates
- Updating templates - Replacing templates
- Template CSS classes
- Using external fonts
- Error loading template
CSS class and inline CSS styles
Creating responsive layouts
- Managing Layouts
- Layouts view and basic operations on the multi-layout page
- CSS Stylesheets and Inline CSS in responsive layouts
- Previewing and displaying lessons
- Adding pages from template
- Copying pages between lessons
Creating Accessible Content
- CSS Classes
- Headings
- Alternative texts
- Finding missing alternative texts
- Videos
- Language definition
- Keyboard navigation mode
- Dedicated screen reader
- Keyboard and TTS Modules
- Autofill function (TTS)
- Adding missing TTS modules
- Sorting the modules
- Sort function (TTS)
- Speech text dictionary
- Editing default TTS titles
Adaptive Learning
- Adaptive Learning Editor
- Navigation in the Adaptive Lesson
- Reporting Pages
- Testing The Adaptive Lesson
Printing
- Examples of lessons with digital and print layers
- Printing methods and modes
- Print mode in mAuthor
Content output
- SCORM packages
- Experience API (TinCan)
- Off-line playback
- Add mAuthor lesson to the epub3 book
- Player versions
- Course management
Working with modules
- Working with keyboard navigation
- Inserting modules
- Defining the module's size and position
- Nesting of addons/modules
- Grouping modules
- Favourites
- Grid
- Rulers
- Snapping
- Changing modules' order
- Blocking modules
- Showing/Hiding Modules
- Selecting and editing the modules' style
- Copying modules between pages
- Copying modules between presentations
- Relative layouts
- Content preview
- Drag&Drop and Click&Click module manipulation
- Activity scoring
- Redo & Undo commands
- Iframe animation controlled by Advanced Connector
- Additional classes
- Mutation Observer
Using jQuery
- jQuery Library
Saving user's result
Modules description
- Activities
- Games
  - Board Game
  - Catch
  - Crossword
  - Dice
  - Hangman
  - Magic Boxes
  - Maze
  - Memo Game
  - Puzzle
  - Quiz
  - Shooting Range
  - Sudoku
- Reporting
- Navigation
- Media
  - 3D Viewer
  - Animation
  - Audio
  - Audio Playlist
  - Coloring
  - Drawing
  - Edge Animation
  - Editable Window
  - Flash Cards
  - Glossary
  - Heading
  - Iframe
  - Image
  - Image Viewer
  - Image Viewer Button Controlled
  - IWB Toolbar
  - Layered Image
  - Line
  - LottiePlayer
  - Media Recorder
  - Model Viewer 3D
  - MultiAudio
  - Scoreboard
  - Shape
  - Shape Tracing
  - Slideshow
  - Standard Shapes
  - SVG
  - Swiffy Animation
  - TextAudio
  - Video
  - Vimeo
  - YouTube
  - Zoom Image
  - Zoom
- Scripting
- LearnPen
- CSS z-Indexes list
Math expressions
Private addons' development
- Creating addons
- Sharing the addons
- Addon CSS Guide
- Addon Presenter
- Addon Documentation
- Addon Model
- Player services
- Available JavaScript Libraries
- Addon Scripting
- Sample addon
- Addon-Events
Version control
Player development
- Requirements
- Build process
- Create addon
- Embedding the player
Exporting Lessons
- SCORM 2004
- SCORM 1.2
- xAPI
- Importing Lessons
- HTML5/Offline
Content localisation
- Localisation editor
- Audio narrations
Importing InDesign XML files

LottiePlayer

Description

LottiePlayer allows for easy embedding and playing of Lottie animations and the Lottie-based Telegram Sticker (TGS) animations in lessons.

Properties

The list starts with the common properties, learn more about them by visiting the Modules description section. The other available properties are described below.

Property name

Description

Items

Property name	Description
Animation JSON	File of the animation in JSON.
Loop	When set to true, loops the animation. The property does not work when the property Play in succession is set to true and the property Loops number does not have a defined value.
Loops number	The Loops number property defines the number of times to loop the animation. Setting the count property to 0 and setting the loop to true, loops the animation indefinitely. Property only works when property Loop is set to true.
Autoplay	When set to true, automatically plays the visible animation on loading it.
Direction	Direction of the animation. Set to Forward, to play the animation forward or set to Backward, to play it backward.
Mode	Play mode. Setting the mode to Bounce plays the animation in an indefinite cycle, forward and then backward.
Speed	Animation speed. Set this parameter to any positive number.
Intermission [ms]	Duration (in milliseconds) to pause before playing each cycle in a looped animation. Set this parameter to 0 (no pause) or any positive number.
Background	Background color. By default, the background is transparent and will take the color of the parent container. Supported formats: HEX - for example: #D5F5E3 RGB - for example: RGB(255,0,0) RGBA - for example: RGBA(255,0,0,0.3)
Alternative text	This text will be read by the Text to Speech module after the user performs an action.
Preview alternative text	This text will be read by the Text to Speech module in the preview.

Controls

When set to true, displays player controls.

Play in succession

When set to true, all animations are played one after another. Autoplay works automatically. Looping will not work without setting the value to the property Loops number.

Loop succession

When set to true, after playing the last animation it goes back to the first one. Works only when the Play in succession is set to true.

Send event on every frame

When set to true, animations send frame event on every frame.

Lang attribute

This property allows defining the language for this module (different than the language of the lesson).

Speech texts

List of speech texts: Play button, Pause button, Stop button, Loop button, Paused, Stopped. This text will be read by the Text to Speech module after the user performs an action.

Supported commands

Command name	Params	Description
load	animationIndex, URL	Load the animation. The animation index should be from 1 to n, where n is the number of configured animation files. URL, or a JSON string or object representing a Bodymovin JSON animation to play.
play	animationIndex	Play the animation. The animation index should be from 1 to n, where n is the number of configured animation files. If the animation index will not be provided, then the current animation starts playing. All other animations will be stopped.
pause	animationIndex	Pause the animation. The animation index should be from 1 to n, where n is the number of configured animation files. If the animation index will not be provided, then the current animation will be paused.
stop	animationIndex	Stop the animation. The animation index should be from 1 to n, where n is the number of configured animation files. If the animation index will not be provided, then the current animation will be stopped.
freeze	animationIndex	Animation is paused due to the player being invisible. The animation index should be from 1 to n, where n is the number of configured animation files. If the animation index will not be provided, then the current animation will be frozen.
playAll	---	Current animation will be played. All other animations will be stopped.
pauseAll	---	All animations will be paused.
stopAll	---	All animations will be stopped.
freezeAll	---	All animations will be paused due to the player being invisible.
loop	animationIndex, value	Enables or disables looping the animation. Animation index should be from 1 to n, where n is the number of configured animation Value is true or false - true enables looping, while false disables looping.
frame	animationIndex, numberFrame	Seek animation to a given frame. Animation index should be from 1 to n, where n is the number of configured animation files. NumberFrame can either be a number or a percent string (for example, 40%).
show	---	Show the module.
hide	---	Hide the module.
jumpTo	animationIndex	Jumps to animation with the specified index. The animation index should be from 1 to n, where n is the number of configured animation files. Providing an animation number out of this range will have no effect.
next	---	Jumps to the next animation. If the last animation is currently displayed, this command will have no effect.
previous	---	Jumps to the previous animation. If the first animation is currently displayed, this command will have no effect.

Events

LottiePlayer module sends ValueChanged type events to Event Bus when the user selects it.

Field name	Description
Item	---
Value	1
Score	---

The load event occurs when the animation loads.

Field name	Description
Item	Number of the animation from the list. Animation number should be from 1 to n.
Value	load
Score	---

The error event occurs when the animation source cannot be parsed, fails to load, or has format errors.

Field name	Description
Item	Number animation from the list. Animation number should be from 1 to n.
Value	error
Score	---

The ready event occurs when animation data is loaded, and the player is ready.

Field name	Description
Item	Number of the animation from the list. Animation number should be from 1 to n.
Value	ready
Score	---

The play event occurs when the animation starts playing.

Field name	Description
Item	Number of the animation from the list. Animation number should be from 1 to n.
Value	play
Score	---

The pause event occurs when the animation is paused.

Field name	Description
Item	Number of the animation from the list. Animation number should be from 1 to n.
Value	pause
Score	---

The stop event occurs when the animation is stopped.

Field name	Description
Item	Number of the animation from the list. Animation number should be from 1 to n.
Value	stop
Score	---

The freeze event occurs when animation is paused due to the player being invisible.

Field name	Description
Item	Number of the animation from the list. Animation number should be from 1 to n.
Value	freeze
Score	---

The loop event occurs when the animation loop is completed.

Field name	Description
Item	Number of the animation from the list. Animation number should be from 1 to n.
Value	loop
Score	---

The complete event occurs when the animation is complete (all loops completed).

Field name	Description
Item	Number of the animation from the list. Animation number should be from 1 to n.
Value	complete
Score	---

The frame event occurs when a new frame is entered.

Field name	Description
Item	Number of the animation from the list. Animation number should be from 1 to n.
Value	frame
Score	---

CSS classes

Class name	Description
.lottie-player-invalid-configuration	Module's invalid configuration.
.lottie-player-visible-animation	Indicates the style that applies to currently displayed animation.
.lottie-player-invisible-animation	Indicates the style that applies to not displayed animations.
lottie-player::part(keyboard_navigation_active_element)	Indicates the style that applies to the control activated by the keyboard navigation.