nexxPLAY
  • Introduction
  • Javascript SDK
    • Basic Integration
    • Advanced Integration
    • Player Configuration
    • Player Management
    • Playback Control
  • iFrame Integration
    • Embed Codes
    • PostMessage Control
  • native Players
    • nexxPLAY for iOS
    • nexxPLAY for Android
    • nexxPLAY for Flutter
  • Platform Plugins
    • Google AMP
    • Wordpress Plugin
    • React Plugin
  • Integration Enhancements
    • Player UI
    • Audio Player
    • Player DataMode
    • Player Events
    • SDK Override Options
    • VAST Macros
    • GET Parameters
  • Widgets
    • Javascript SDK
    • iFrame Integration
    • Widgets for native Apps
      • iOS Widget
      • Android Widget
      • Android TV Channel
      • Windows 10 LiveTile
    • Widget React Plugin
    • Widget Override Options
  • more Integrations
    • WebViews
    • oEmbed Discovery
    • WebComponent
    • Preview Links
    • Cover Service
    • Reporting for external Players
  • Addons
  • Security and Accessibility
    • Data Protection and Security
    • GDPR and TCF 2.0
    • Accessibility and WCAG
  • Compatibility
  • Changelog
Powered by GitBook
On this page
  • General Playback
  • Playback of multiple Items within a Media Container
  • Playback Mode
  • Changing the Media Object
  • Interacting with connected Files and Downloads
  • Interacting with connected Polls
  1. Javascript SDK

Playback Control

The SDK also allows to control all Playback Mechanisms of the Player in every Moment. The _play.control.interact Namespace is used for these Functions.

There are two Ways to control a Player Instances Playback:

  • it is possible to use the global _play.control.interact.* Method with the Use of a Container-ID Parameter.

  • it is possible to call the Method directly on the Player Instance Object (returned by every _play.control.addPlayer* Method)

General Playback

_play.control.interact.play(CONTAINER-ID)
_play.control.interact.pause(CONTAINER-ID,canBeResumed)
//starts play, if paused and pauses if currently playing.
_play.control.interact.toggle(CONTAINER-ID)
//is identical to play() on an Instance in "paused" State
_play.control.interact.resume(CONTAINER-ID)
//only possible on a Player Instance, that has not been started yet, but is ready to start
_play.control.interact.startMuted(CONTAINER-ID)
_play.control.interact.mute(CONTAINER-ID)
_play.control.interact.unmute(CONTAINER-ID)
_play.control.interact.seekTo(CONTAINER-ID,time)
_play.control.interact.seekBy(CONTAINER-ID,time)
_play.control.interact.setVolume(CONTAINER-ID,[0.1-1])
_play.control.interact.setPlaybackSpeed(CONTAINER-ID,[-1:2])
_play.control.interact.setAudioTrack(CONTAINER-ID,lang,role)
_play.control.interact.setTextTrack(CONTAINER-ID,lang,role)
_play.control.interact.hideTextTrack(CONTAINER-ID)

Playback of multiple Items within a Media Container

//swap to the next Item in a Container Element (Playlist, Collection, AudioAlbum etc)
_play.control.interact.next(CONTAINER-ID)
//swap to the previous Item in a Container Element (Playlist, Collection, AudioAlbum etc)
_play.control.interact.previous(CONTAINER-ID)
//swap to exactly this Position of the Item List
_play.control.interact.swapToPosition(CONTAINER-ID,position)

Playback Mode

//this Command will fail under most conditions (as Fullscreen Enter needs a User Gesture by Browser Security)
_play.control.interact.enterFullscreen(CONTAINER-ID)
_play.control.interact.exitFullscreen(CONTAINER-ID)
_play.control.interact.enterPopout(CONTAINER-ID)
_play.control.interact.exitPopout(CONTAINER-ID,andContinuePlay)

Changing the Media Object

_play.control.interact.swapToMediaItem(CONTAINER-ID,MEDIA-ID,STREAMTYPE,startPosition,delay,reason,showReturnButton)
_play.control.interact.swapToGlobalID(CONTAINER-ID,GLOBAL-ID,startPosition,delay,reason,showReturnButton)
_play.control.interact.swapToRemoteMedia(CONTAINER-ID,REMOTE-REFERENCE,STREAMTYPE,PROVIDER,delay,reason,showReturnButton)

Interacting with connected Files and Downloads

//start Downloading a connected File, indicated by its position in the current File List
_play.control.interact.startDownloadFile(CONTAINER-ID,position);

Interacting with connected Polls

//start Downloading a connected File, indicated by its position in the current File List
_play.control.interact.startPoll(CONTAINER-ID,POLL-ID);

POLL-ID is the valid ID of a Poll. If POLL-ID is omitted, the Player will start the Poll, that has been connected to the current Media (if any).

PreviousPlayer ManagementNextiFrame Integration

Last updated 2 years ago