API reference

Overview

This is the API reference which presents every RxPlayer API in a single page.

The point of this page is to provide an easier-to-navigate page than the API documentation for when you’re already familiar with it.

API are splitted here in multiple categories depending on if they are properties, methods, events and so on.

Constructor

Constructor options

  • videoElement: specifies the media element on which the content will play.

  • initialVideoBitrate: Ceil value for the initial video bitrate wanted.

  • initialAudioBitrate: Ceil value for the initial audio bitrate wanted.

  • minVideoBitrate: Minimum video bitrate reachable through adaptive streaming.

  • minAudioBitrate: Minimum audio bitrate reachable through adaptive streaming.

  • maxVideoBitrate: Maximum video bitrate reachable through adaptive streaming.

  • maxAudioBitrate: Maximum audio bitrate reachable through adaptive streaming.

  • wantedBufferAhead: Set the default buffering goal.

  • preferredAudioTracks: Set default audio tracks preferences based on tracks characteristics.

  • preferredTextTracks: Set default text tracks preferences based on tracks characteristics.

  • preferredVideoTracks: Set default video tracks preferences based on tracks characteristics.

  • maxBufferAhead: Set the default maximum kept buffer ahead of the current position, in seconds.

  • maxBufferBehind: Set the default maximum kept buffer before the current position, in seconds.

  • maxVideoBufferSize: Set the default maximum size the video buffer can take in the memory, in kilobytes (kb).

  • limitVideoWidth: Limit the maximum video width according to the video element’s current width.

  • throttleVideoBitrateWhenHidden: Limit the maximum video bitrate when the current video is hidden to the user.

  • stopAtEnd: Stop automatically when the end of a content is reached.

  • throttleWhenHidden: [Deprecated] Limit the maximum video bitrate when the current video is hidden to the user.

loadVideo options

Static methods

  • addFeatures: Add features to the RxPlayer (e.g.: multithreading, offline playback etc.).

Methods

Static Properties

  • version: The current version of the RxPlayer.

  • LogLevel: Update the verbosity of the RxPlayer logger.

  • ErrorTypes: All Error types that can be encountered.

  • ErrorCodes: All Error codes that can be encountered.

Events

Error types

Tools

Page List