@streetscape.gl/monochrome/src/playback-control/README.md

A toolkit of React components for streetscape.gl

# PlaybackControl

A stateless video playback control component.

**Features**

- Play / Pause
- Seeking
- Responsive labels
- Markers

## Usage

```js
import {PlaybackControl} from '@streetscape.gl/monochrome';
const View = () => {
  return (
    <PlaybackControl
      currentTime={8.3}
      endTime={20}
      isPlaying={false}
      onPlay={() => {}}
      onSeek={() => {}}
    />
  );
};
```

## API Reference

### Static Methods

- `PlaybackControl.formatTimeCode` -
  - `value` **(number)** - time in seconds
  - `format` **(string)** - format code, default `{hh}:{mm}:{ss}.{SSS}`.
    - `h` - hours
    - `m` - minutes
    - `s` - seconds
    - `S` - decimal seconds

### Props

- `width` **(string|number)** - width of the control. Default `100%`.
- `style` **(object, optional)** - custom CSS overrides. See "Styling" section below.
- `compact` **(boolean, optional)** - use compact layout mode of the control. Defaults to `false`.
- `currentTime` **(number)** - current time in seconds
- `startTime` **(number, optional)** - start time in seconds, default `0`
- `endTime` **(number)** - end time in seconds
- `isPlaying` **(boolean)** - whether the video is playing
- `step` **(number, optional)** - scrub interval in seconds
- `tickSpacing` **(number, optional)** - spacing between ticks in pixels, default `100`.
- `formatTick` **(function, optional)** - format of ticks. Default
  `t => formatTimeCode(t, '{mm}:{ss}')`.
- `formatTimestamp` **(function, optional)** - format of the current time label. Default
  `t => formatTimeCode(t, '{mm}:{ss}.{S}')`.
- `className` **(string, optional)** - additional class name
- `bufferRange` **(array|object, optional)** - one or multiple time ranges of loaded buffers to mark
  the track. Each item should contain the following fields:
  - `startTime` **(number)** starting timestamp of a time range
  - `endTime` **(number)** ending timestamp of a time range
- `markers` **(array, optional)** - array of additional highlights to mark the timeline. Each marker
  should contain the following fields:
  - `time` or `startTime`, `endTime` **(number)** a single timestamp or a time range
  - `style` **(object, optional)** style of the marker
  - `content` **(element, optional)** content of the marker
- `onPlay` **(function, optional)** - callback when user play.
- `onPause` **(function, optional)** - callback when user pause.
- `onSeek` **(function, optional)** - callback when user scrubs.

### Styling

The `style` prop expects an object that may contain the following keys:

- `padding` **(number|object)** - padding at the sides of the slider in pixels. If provided as
  object, in the shape of `{left, right}`. Default `24`.
- `wrapper` - the top level container.
- `ticks` - the container of the ticks.
- `tick` - one of the ticks.
- `tickLabel` - the label of a tick.
- `markers` - the container of the markers.
- `marker` - one of the markers.
- `buffer` - one of the buffer indicators.
- `slider` **(object)** - the slider. The value will be passed to the
  [Slider](../shared/slider/README.md) component.
- `controls` - the container of the controls.
- `playPauseButton` - the play/pause button.
- `iconPlay` **(element)** - the play icon.
- `iconPause` **(element)** - the pause icon.
- `timestamp` - the timestamp.

The values define the styling overrides for the respective child components. Unless noted otherwise,
each value is an object, or a callback function.

A custom style callback function will receive the following arguments:

- `props` **(object)**
  - `theme` **(object)** - the current theme
  - `compact` **(boolean)**
  - `isPlaying` **(boolean)**