Skip to content

Commit 350c3de

Browse files
committed
Make imsc settings options less generic
1 parent 1d0a07d commit 350c3de

File tree

1 file changed

+25
-3
lines changed

1 file changed

+25
-3
lines changed

src/core/Settings.js

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -513,8 +513,22 @@ import Events from './events/Events';
513513
* When true, only those captions where itts:forcedDisplay="true" will be displayed.
514514
* @property {boolean} [imsc.enableRollUp=true]
515515
* Enable/disable rollUp style display of IMSC captions.
516-
* @property {number} [imsc.options]
517-
* IMSC styling options - including; sizeAdjust, lineHeightAdjust, backgroundOpacityScale and fontFamily. See the renderHtml function of imscJS for full details
516+
* @property {object} [imsc.options]
517+
* IMSC styling options - See the renderHtml function of imscJS for full details
518+
* @property {number} [imsc.options.sizeAdjust]
519+
* IMSC styling option - scales the text size and line padding
520+
* @property {number} [imsc.options.lineHeightAdjust]
521+
* IMSC styling option - scales the line height
522+
* @property {number} [imsc.options.backgroundOpacityScale]
523+
* IMSC styling option - scales the backgroundColor opacity
524+
* @property {string} [imsc.options.fontFamily]
525+
* IMSC styling option - comma-separated list of font family values to use, if present.
526+
* @property {number} [imsc.options.colorOpacityScale]
527+
* IMSC styling option - opacity override on text color
528+
* @property {number} [imsc.options.regionOpacityScale]
529+
* IMSC styling option - scales the region opacity
530+
* @property {string} [imsc.options.textOutline]
531+
* IMSC styling option - textOutline value to use, if present
518532
* @property {object} [webvtt.customRenderingEnabled=false]
519533
* Enables the custom rendering for WebVTT captions. For details refer to the "Subtitles and Captions" sample section of dash.js.
520534
* Custom WebVTT rendering requires the external library vtt.js that can be found in the contrib folder.
@@ -1011,7 +1025,15 @@ function Settings() {
10111025
imsc: {
10121026
displayForcedOnlyMode: false,
10131027
enableRollUp: true,
1014-
options: {},
1028+
options: {
1029+
sizeAdjust: 1,
1030+
lineHeightAdjust: 1,
1031+
backgroundOpacityScale: null,
1032+
fontFamily: null,
1033+
colorOpacityScale: 1,
1034+
regionOpacityScale: null,
1035+
textOutline: null,
1036+
},
10151037
},
10161038
webvtt: {
10171039
customRenderingEnabled: false

0 commit comments

Comments
 (0)