Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions src/config/configSchema.json
Original file line number Diff line number Diff line change
Expand Up @@ -407,33 +407,54 @@
"properties": {
"options": {
"type": "object",
"description": "Visual customization of captions and subtitles.",
"properties": {
"theme": {
"type": "string",
"description": "A set of predefined styles to apply to the text tracks. Built-in themes: default, videojs-default, yellow-outlined, player-colors (reflects the player's color scheme), 3d. Any other value adds a cld-styled-text-tracks-theme-<value> class you can style with your own CSS.",
"examples": ["player-colors", "yellow-outlined", "3d"],
"default": "default"
},
"fontFace": {
"type": "string",
"description": "The font face to use for the text tracks. Supports any Google font.",
"examples": ["Kanit", "Palatino"],
"default": "Fira Sans"
},
"fontSize": {
"type": "string",
"description": "The font size to use for the text tracks. Use relative units only, such as % or em.",
"examples": ["2rem", "90%"],
"default": "medium"
},
"gravity": {
"type": "string",
"description": "The position of the text tracks on the video or in the containing box.",
"enum": ["top", "right", "bottom", "left", "center", "top-right", "bottom-right", "bottom-left", "top-left"],
"default": "bottom"
},
"box": {
"type": "object",
"description": "The location and size of the containing box that shows the text tracks. Only x, y, width and height are used; values are CSS lengths.",
"properties": {
"x": { "type": "string" },
"y": { "type": "string" },
"width": { "type": "string" },
"height": { "type": "string" }
},
"examples": [{ "x": "0%", "y": "0%", "width": "100%", "height": "100%" }],
"default": {}
},
"style": {
"type": "object",
"description": "Custom CSS styling to apply to the text, as CSS property/value pairs.",
"examples": [{ "color": "black", "opacity": "0.6" }],
"default": {}
},
"wordHighlightStyle": {
"type": "object",
"description": "Custom CSS styling to apply to the highlighted word when using word highlighting for paced subtitles, as CSS property/value pairs.",
"examples": [{ "color": "royalblue" }],
"default": {}
}
},
Expand Down
Loading