RxPlayer documentation

Overview

You can find here various documentation pages about the RxPlayer.

If you wish to use the RxPlayer as a library, you can directly check the API Documentation.

For those wanting to contribute, we also began documenting the code architecture.

API Documentation

The general API Documentation can be found here:

• Complete API documentation

For a shortcut, here are some other quick links you might want to check:

• Player options
• loadVideo options
• Player Errors
• Player Events
• Text track handling
• Import a minimal version of the Player

Architecture Documentation

An architecture documentation is in progress.

The main page can be found here:

• Code architecture documentation

Other pages

You can also find other pages on various subjects related to the RxPlayer here:

• a list of term and definitions used by the RxPlayer
• how to port the player from a v2.x.x to a v3.x.x
• an article about why we switched our codebase from JavaScript to TypeScript