From 49bda37b0d3e7aee91fcff687866c195abe7df67 Mon Sep 17 00:00:00 2001 From: Erik Demaine Date: Wed, 6 Sep 2017 17:40:33 -0400 Subject: [PATCH] Document playbackRates --- docs/guides/options.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/docs/guides/options.md b/docs/guides/options.md index 7132cad75e..72102dc06d 100644 --- a/docs/guides/options.md +++ b/docs/guides/options.md @@ -26,6 +26,7 @@ * [languages](#languages) * [nativeControlsForTouch](#nativecontrolsfortouch) * [notSupportedMessage](#notsupportedmessage) + * [playbackRates](#playbackrates) * [plugins](#plugins) * [sourceOrder](#sourceorder) * [sources](#sources) @@ -180,6 +181,24 @@ Explicitly set a default value for [the associated tech option](#nativecontrolsf Allows overriding the default message that is displayed when Video.js cannot play back a media source. +### `playbackRates` + +> Type: `Array` + +An array of numbers strictly greater than 0, where 1 means regular speed +(100%), 0.5 means half-speed (50%), 2 means double-speed (200%), etc. +If specified, Video.js displays a control (of class `vjs-playback-rate`) +allowing the user to choose playback speed from among the array of choices. +The choices are presented in the specified order from bottom to top. + +For example: + +```js +videojs('my-player', { + playbackRates: [0.5, 1, 1.5, 2] +}); +``` + ### `plugins` > Type: `Object`