# Player changelog


<!-- synced from player repo, do not edit by hand -->

<!-- ## UNRELEASED -->

<!-- ## [v2.161.0](https://docs.kinescope.com/player-docs/)

### ⚠ BREAKING CHANGES

- `IFrame Player API`
  - Factory methods [for creating a player](https://docs.kinescope.com/player-docs/embedding/iframe-api-create-player/) `getById` and `getAll` were removed to prevent access to player objects from the browser console. -->

## [v2.160.1](https://docs.kinescope.com/player-docs/)

### ⚠ BREAKING CHANGES

- `IFrame Player API`
  - If a watermark is enabled in the dashboard but watermark text is not provided when creating the player, the player throws an error. Watermark text must be set when creating the player.

- `IFrame Regular`
  - If a watermark is enabled in the dashboard but watermark text is not provided in the `watermark` URL parameter, the player throws an error.

## [v2.156.0](https://docs.kinescope.com/player-docs/)

### ⚠ BREAKING CHANGES

- `IFrame Player API`
  - The structure of `playlist[].cta` changed; see [player parameters](https://docs.kinescope.com/player-docs/embedding/iframe-api-control-player/#setPlaylistItemOptions).

## [v2.150.0](https://docs.kinescope.com/player-docs/)

### ⚠ BREAKING CHANGES

- `IFrame Player API`
  - Parameter `theme.subtitles.textSize` was renamed to `textScale`. See [player parameters](https://docs.kinescope.com/player-docs/embedding/iframe-api-create-player/#create-options).
  - Undocumented parameter `behavior.textTrack.rollup` was removed. See [player parameters](https://docs.kinescope.com/player-docs/embedding/iframe-api-create-player/#create-options).

## [v2.139.1](https://docs.kinescope.com/player-docs/)

### ⚠ BREAKING CHANGES

- `IFrame Player API`
  - The `Events` property [on the player factory](https://docs.kinescope.com/player-docs/embedding/iframe-api-create-player/) was removed. Use the [Events](https://docs.kinescope.com/player-docs/embedding/iframe-api-control-player/#events) property on the player control object instead.

## [v2.121.0](https://docs.kinescope.com/player-docs/)

### ⚠ BREAKING CHANGES

- `IFrame Player API`
  - To prevent changing or removing the watermark via the iframe `src` attribute, watermark parameters must be set after player creation with [setOptions](https://docs.kinescope.com/player-docs/embedding/iframe-api-control-player/#setOptions).

    Example:

    ```ts
    playerFactory.create(params).then(function (player) {
      player.setOptions({ui: {watermark: {text: 'watermark'}}});
    });
    ```

## [v2.115.0](https://docs.kinescope.com/player-docs/)

### ⚠ BREAKING CHANGES

- `IFrame Player API`
  - Default value for `ui.watermark.mode` changed to `random`. See [player parameters](https://docs.kinescope.com/player-docs/embedding/iframe-api-create-player/#create-options).

## [v2.106.0](https://docs.kinescope.com/player-docs/)

### ⚠ BREAKING CHANGES

- `IFrame Player API`
  - Player event `AutoQualityChanged` was removed. Use `QualityChanged` instead. See [player event handlers](https://docs.kinescope.com/player-docs/embedding/iframe-api-control-player/#EventListeners).

  - Player method `getCurrentVideoQuality` is deprecated and will be removed. Use `getVideoQuality` instead. See [player methods](https://docs.kinescope.com/player-docs/embedding/iframe-api-control-player/).

  - Factory property `PlayerEvent` is deprecated and will be removed. Use `Events` instead. See [factory properties](https://docs.kinescope.com/player-docs/embedding/iframe-api-create-player/).

## [v2.101.0](https://docs.kinescope.com/player-docs/)

### ⚠ BREAKING CHANGES

- `IFrame Regular`
  - Parameter `watermark` is ignored unless watermark functionality is enabled in the dashboard. See [embed parameters](https://docs.kinescope.com/player-docs/embedding/simple-iframe-embed/).

## [v2.48.0](https://docs.kinescope.com/player-docs/)

### ⚠ BREAKING CHANGES

- `IFrame Regular`
  - Parameter `header` was removed. See [embed parameters](https://docs.kinescope.com/player-docs/embedding/simple-iframe-embed/).

- `IFrame Player API`
  - Parameter `ui.openChaptersOnLoad` was removed. See [player parameters](https://docs.kinescope.com/player-docs/embedding/iframe-api-create-player/#create-options).

## [v2.36.0](https://docs.kinescope.com/player-docs/)

### ⚠ BREAKING CHANGES

- `IFrame Regular`
  - Parameter `header` was replaced with `title`. Existing embeds with `header` still work for a while; new embeds should use `title`. See [embed parameters](https://docs.kinescope.com/player-docs/embedding/simple-iframe-embed/).

- `IFrame Player API`
  - Parameter `ui.openChaptersOnLoad` is deprecated and will be removed. See [player parameters](https://docs.kinescope.com/player-docs/embedding/iframe-api-create-player/#create-options).

<!-- ## [v2.31.0](https://docs.kinescope.com/player-docs/)

### ⚠ BREAKING CHANGES

- `IFrame Player API`

  - Player method [`destroy`](https://docs.kinescope.com/player-docs/embedding/iframe-api-control-player/) now returns `void` instead of `Promise`. -->

## [v2.27.0](https://docs.kinescope.com/player-docs/)

### ⚠ BREAKING CHANGES

- `IFrame Player API`
  - Player creation parameters `files` and `actions` moved into `PlaylistItemOptions` of the `playlist` parameter. See [player creation](https://docs.kinescope.com/player-docs/embedding/iframe-api-create-player/#create-options).

<!-- ### Features -->