Skip to content

Commit 4f0f2b9

Browse files
committed
readme: add missing documentation
1 parent 17f88f1 commit 4f0f2b9

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

README.md

+3
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,9 @@ When creating an instance of SubtitleOctopus, you can set the following options:
118118
occurs if browser doesn't support web workers). (Optional)
119119
- `debug`: Whether performance info is printed in the console. (Default:
120120
`false`)
121+
- `prescaleFactor`: Scale down (`< 1.0`) the subtitles canvas to `prescaleHeight` to improve speed, or scale it up (`> 1.0`) to improve quality. (Default: `null` - no scaling)
122+
- `prescaleHeight`: The height beyond which the subtitles canvas won't be pre-scaled. (Default: `1080`)
123+
- `maxHeight`: The maximum height of the subtitles canvas. (Default: `0` - no limit)
121124

122125
Additionally there are options to choose between different rendering modes, which are detailed
123126
below. If multiple rendering options are set any of them may be used, they are not additive.

0 commit comments

Comments
 (0)