KONtx.control.MediaTransportOverlay (KONtx 1.3 and above)

Toolbox media player transport keys user interface

The KONtx.control.MediaTransportOverlay class is an accessory to the KONtx.mediaplayer class used to create the fullscreen transport keys user interface. This control is used to provide an onscreen transport overlay with a progress indicator and a number of optional buttons to control media playback. Its visual appearance is most relevant to a video fullscreen player, but could also be used with audio playback when combined with other visual playback elements. This control pairs up with the KONtx.mediaplayer and not the KONtx.videoplayer (use KONtx.control.VideoTransportOverlay instead).

By default, the KONtx.control.MediaTransportOverlay shows a play/pause button, a stop button, and a visual indication of the playback progress. By toggling flags in the configuration, you can enable additional buttons for more advanced functionality.

Extends

KONtx.element.Container

Example

Properties

Property

Type

Description

backwardseekButton

Boolean

Indicates if a backward seek button should be included in the transport keys. Default value is false. By default, this button does nothing and requires an implementation.

captionsButton

Boolean

Indicates if a captions button (CC) is included in the transport keys. Default value is true.

fadeTimeout

int

Number of seconds the user interface remains on the screen before fading out. Default value is 10. Any keypress on the remote control causes the onscreen controls to be shown.

fastforwardButton

Boolean

Indicates if a fast forward button should be included in the transport keys. Default value is false. This button mimics the fast forward button on the remote by default. If you override its behavior, you can provide custom handling — for example, increasing the speed increment each time the button is pushed.

forwardseekButton

Boolean

Indicates if a forward seek button should be included in the transport keys. Default value is false. By default, this button does nothing and requires an implementation.

infoButton

Boolean

Indicates if an information button should be included in the transport keys. Default value is false. By default, this button does nothing and requires an implementation. Typically this is used to show an overlay with meta information for the currently playing entry.

playButton

Boolean

Indicates if a play button should be included in the transport keys. Default value is true.

resizeButton

Boolean

Indicates if resize button should be included in the transport keys. Default value is false. By default, this button does nothing and requires an implementation. Typically this is used to toggle the viewport size. The resize button appears on the right side of the progress indicator unlike other buttons.

rewindButton

Boolean

Indicates if a rewind button should be included in the transport keys. Default value is false. This button mimics the rewind button on the remote by default. If you override its behavior, you can provide custom handling — for example, increasing the speed increment each time the button is pushed.

stopButton

Boolean

Indicates if a stop button should be included in the transport keys. Default value is true.

Method

Boolean focus();

Tells the control to focus itself.

void hide();

Prevents the media transport overlay from being shown even if the consumer presses a key on the remote control.

void resetState();

Resets the overlay for the transport keys. The state is set to pause. Time index and duration are set to 0. The progress bar is reset to the start and the interval text is set to 00:00:00.

void show();

Re-enables the media transport overlay to be shown when the consumer presses a key on the remote control.

Table of Contents