SmartComponents

Module: playerapi/stage/StageEventContext

This context provides methods to handle events in the stage scope.

To handle the differences between standard and HTML5 player, it is recommended
to take note of the following example.

Example

onCallback: function (dataTHML5, dataHTML4) {
    var data = dataHTML4 || dataTHML5;
    […]
}

Methods

<inner> bindOnAudioControlChanged()

Binds a component method to the onAudioControlChanged event that is sent by the TTKF Player.

Preconditions:


  • The stated component must provide an "onAudioControlChanged" method.

  • On callback the method receives the following arguments:

    • {object} audio control specific arguments

      • {boolean} audio true if the audio is turned on, otherwise false




Callback time point:


  • On every audio on/off change.

<inner> bindOnPlayModeChanged(component)

Binds a component method to the onPlayModeChanged event that is sent by the TTKF Player.

Preconditions:


  • The stated component must provide an "onPlayModeChanged" method.
  • On callback the method receives the following arguments: *

    • {object} play mode specific arguments

      • {string} mode possible values are "interactive", "presentation" and "film"





Callback time point:


  • The page is displayed on the wbt stage or the play mode is changed

Parameters:
Name Type Description
component Component

The component that provides the specified callback method.