Module: playerapi/stage/StageMetadata

This module provides data according to the stage scope.

Methods

<static> getMetadata() → {module:standardPlayer/ComponentParameters}

Gets an object with all sequence metadata

Returns:

The metadata of sequence.

Type
module:standardPlayer/ComponentParameters

<inner> getAvailablePlayModes() → {Object}

Gets the play modes that that the author intended for the wbt.

Returns:

interactive : Boolean
presentation : Boolean
film : Boolean

Type
Object

<inner> getContentLanguage() → {string}

Gets the content language.

Returns:

The content language in ISO 3166 format ("en-us","de-de")..

Type
string

<inner> getDefaultPlayMode() → {String}

Gets the default play mode for the wbt

Returns:

interactive, presentation or film

Type
String

<inner> getHeight() → {number}

Gets the stage height.

Returns:

The export height for the WBT.

Type
number

<inner> getMainPath() → {module:playerapi/path/LearningPathMetadata}

Gets the main path metadata

Returns:
Type
module:playerapi/path/LearningPathMetadata

<inner> getWidth() → {number}

Gets the stage width.

Returns:

The export width for the WBT.

Type
number