Skip to content

Commit

Permalink
feat(FEC-12229): append KS to thumbnail API (#177)
Browse files Browse the repository at this point in the history
adding new configuration - `loadThumbnailWithKs` which defines whether the player needs to append ks to thumbnail api request or not.

- default of `loadThumbnailWithKs` is false
- implemented for ovp only

Solves FEC-12229
  • Loading branch information
lianbenjamin committed May 9, 2022
1 parent 8e40a36 commit 9db2419
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ sudo: required
dist: xenial
language: node_js
node_js:
- 'node'
- '17'
env:
global:
- NODE_OPTIONS="--openssl-legacy-provider"
Expand Down
15 changes: 13 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ var provider = new playkit.providers.ott.Provider(config);
env: ProviderEnvConfigObject, // optional
networkRetryParameters: ProviderNetworkRetryParameters, // optional
filterOptions: ProviderFilterOptionsObject, // optional
ignoreServerConfig: boolean // optional
ignoreServerConfig: boolean, // optional
loadThumbnailWithKs: boolean // optional
}
```

Expand Down Expand Up @@ -201,4 +202,14 @@ var provider = new playkit.providers.ott.Provider(config);
> ##### Type: `boolean`
>
>
> ##### Description: Instructs the player to ignore the server configuration.
> ##### Description: Instructs the player to ignore the server configuration.
> ##
>
> ### config.loadThumbnailWithKs
>
> ##### Type: `boolean`
>
> ##### Default: `false`
>
> ##### Description: Defines whether to add KS to OVP thumbnail API request or not.>
3 changes: 2 additions & 1 deletion flow-typed/types/provider-options.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ declare type ProviderOptionsObject = {
env?: ProviderEnvConfigObject,
networkRetryParameters?: ProviderNetworkRetryParameters,
filterOptions?: ProviderFilterOptionsObject,
ignoreServerConfig?: boolean
ignoreServerConfig?: boolean,
loadThumbnailWithKs?: boolean
};
3 changes: 2 additions & 1 deletion src/k-provider/ovp/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@ const defaultConfig: Object = {
apiVersion: '3.3.0',
format: 1
},
useApiCaptions: true
useApiCaptions: true,
loadThumbnailWithKs: false
};

export default class OVPConfiguration {
Expand Down

0 comments on commit 9db2419

Please sign in to comment.