rx-player/src/main_thread/api/README.md

Canal+ HTML5 Video Player

# The `API`

| Consideration           | Status                                             |
| ----------------------- | -------------------------------------------------- |
| Preferred import style  | Either the `types` file or the API may be imported |
| Multithread environment | Always run in main thread                          |

## Overview

The API is the front-facing part of the code. It will be the only layer used by
applications integrating the RxPlayer library.

As such, its main roles are to:

- provide a comprehensive API for the user
- translate user order into actions in the player
- redirecting events to the user

## Subparts

To facilitate those actions, the API relies on multiple building blocks:

- **the `option utils` (./option_utils.ts)**

  Parse options given to some RxPlayer API calls, to add default parameters and provide
  intelligible warnings/errors

- **the `debug` directory (./debug/)**

  Contains the logic for the debug overlay API, (e.g. that can be rendered through the
  `createDebugElement` RxPlayer API)