Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

For an overview of Resources, click here.

Table of Contents

Overview

The Screen Media resource creates a panel displaying a media item in the scene.

You can select from three types of this resource - Guide, Inspector, or Playable. All three types are described individually below.

...

Table of ContentsminLevel1maxLevel7

...

Screen Media Guide

Guide is always present - the user can not dismiss it (it doesn't have an "ok" button).  Guides must be anchored to something in the scene (a scene anchor or a scene object.) Once the media item appears, it will automatically play for the duration of the media.

...

Guide - Required Fields

...

Field Name

Description

Anchors

Specifies the object in the scene that the panel will attach to.  This must be a Scene Anchor or a Scene Object.

Media

Specifies the media item to be displayed.

Guide - Optional Fields

...

Field Name

Description

Title

The title of the media will display for the learner in the header of the panel.

Playback Properties

Sets any playback properties of the media.

Loop

Check if you want the sound to repeat.

Pitch

Adjust the pitch of the sound file.

Volume

0 to 1, 1 is the default.

Start Position

Customize the starting position of the media.

End Position

Customize the end position of the media.

Close when Complete

When chosen will emit a Close event when the media item is complete.

Close Delay

Delay the close of the media.

Guide - Events

...

Open, Activate, and Close (if the Close when Complete option is chosen).

...

Field Name

Description

Title

The title of the media will display for the learner in the header of the panel.

Playback Properties

Sets any playback properties of the media.

Loop

Check if you want the sound to repeat.

Pitch

Adjust the pitch of the sound file.

Volume

0 to 1, 1 is the default.

Start Position

Customize the starting position of the media.

End Position

Customize the end position of the media.

Close when Complete

When chosen will emit a Close event when the media item is complete.

Close Delay

Delay the close of the media.

Inspector - Events

...

Open, Activate, and Close (if the Close when Complete option is chosen).

...

Field Name

Description

Anchors

Specifies the object in the scene that the panel will attach to - a Scene Object or Scene Anchor.  If left blank the media will appear in front of the learner.

Title

The title of the media will display for the learner in the header of the panel.

Playback Properties

Sets any playback properties of the media.

Loop

Check if you want the sound to repeat.

Pitch

Adjust the pitch of the sound file.

Volume

0 to 1, 1 is the default.

Start Position

Customize the starting position of the media.

End Position

Customize the end position of the media.

Close when Complete

When chosen will emit a Close event when the media item is complete.

Close Delay

Delay the close of the media.

Timer

Set delay or time of day settings.

Priority

Specifies how high the priority of the Media is.

If multiple media items are used at the same time, the highest priority action will take effect.

  • Normal: Normal order.

  • High: Next in the queue behind the item that needs to finish.

  • Filler: Will play item if nothing has been played in a while, otherwise, doesn't play at all.

  • Interrupt: Stops what is currently playing and plays immediately.  

Playable - Events

...

Open, Activate, Close, Complete.

Playable - Example in the Headset

...

This is an example of the Playable Screen Media Resource.  

...