[c8bm]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the background color of the subtitle regions.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
The subtitle bitmap text.
This property is set on the output sample of all subtitle bitmap converters.
Type: String
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets a value indicating whether to emit captions immediately.
If true the caption converter will produce a subtitle sample immediately following a change in the visual state of the caption decoder. If false the samples are delayed in order to determine the duration between visual state changes.
Type: Bool
Specifies the background color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the foreground color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets a value indicating whether to perform analysis during conversion
Note: Defaults to false.
Type: Bool
[ccbm]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the background color of the subtitle regions.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
The subtitle bitmap text.
This property is set on the output sample of all subtitle bitmap converters.
Type: String
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets a value indicating whether to emit captions immediately.
If true the caption converter will produce a subtitle sample immediately following a change in the visual state of the caption decoder. If false the samples are delayed in order to determine the duration between visual state changes.
Type: Bool
Specifies the background color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the foreground color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets a value indicating whether to perform analysis during conversion
Note: Defaults to false.
Type: Bool
Specifies the caption decoder channel.
| Value | Meaning |
|---|---|
0 |
CEA-608 CC1 |
1 |
CEA-608 CC2 |
2 |
CEA-608 CC3 |
3 |
CEA-608 CC4 |
10 |
CEA-708 Service 1 |
11 |
CEA-708 Service 2 |
12 |
CEA-708 Service 3 |
13 |
CEA-708 Service 4 |
14 |
CEA-708 Service 5 |
15 |
CEA-708 Service 6 |
Type: Int
Gets the underlying caption decoder CObject.
Type: Pointer
Indicates whether to display CEA-608 XDS (Extended Data Services).
Type: Bool
Gets or sets flags for caption decoder options.
Type: Int
[cvtt]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Gets or sets the caption decoder channel.
| Value | Meaning |
|---|---|
0 |
CEA-608 CC1 |
1 |
CEA-608 CC2 |
2 |
CEA-608 CC3 |
3 |
CEA-608 CC4 |
10 |
CEA-708 Service 1 |
11 |
CEA-708 Service 2 |
12 |
CEA-708 Service 3 |
13 |
CEA-708 Service 4 |
14 |
CEA-708 Service 5 |
15 |
CEA-708 Service 6 |
Type: Int
The starting time for the first sample.
Used in the webvtt output.
Type: Int64
Gets or sets a value indicating whether to display XDS.
Type: Bool
Gets or sets the immediate mode option.
false: Output samples will be produced at the completion of a subtitle. true: Each input sample will produce an output sample of the current state.
Type: Bool
[ciem]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the output frame rate for captions and subtitles.
Type: Double
Gets or sets the region right margin.
Note: Default 0.1 = 10% safe area margin.
Type: Double
Specifies the offset (in seconds) applied to caption and subtitle timecode values.
Type: Double
Specifies the offset (in seconds) applied to caption and subtitle times.
Type: Double
Gets or sets the code page of the subtitles.
Type: Int
Specifies the rate multiplier applied to caption and subtitle times. For example, a rate of 1.001 compensates for drop frame.
Type: Double
Specifies the mode use to convert caption and subtitle timecode values to 0 based times.
| Value | Meaning |
|---|---|
0 |
Subtract the value of the StartFrame property. |
1 |
Subtract the first frame timecode. |
2 |
Subtract the starting timecode rounded to the nearest hour. For example, 10:00:01:00 is converted to 00:00:01:00. |
Type: Int32
Specifies the number of text lines used to reformat roll-up captions to pop-on captions.
Type: Int
Gets or sets the drop shadow distance setting.
Set as a multiplier of font size, e.g. 0.1 = 10% of font size.
Type: Double
Indicates whether timecode values should be specified in drop frame format.
Type: Bool
Gets or sets the options to snap subtitles to the top and/or bottom margin
| Value | Meaning |
|---|---|
1 |
Snap all to top |
2 |
Snap all to bottom |
3 |
Snap subtitles to the top or bottom depending on which is closer |
Type: Int32
Specifies the start time (in seconds) of the retimed captions and subtitles.
If a program begins at 01:00:00:00 and you set this to 3600.0, the program start time will be pinned to 01:00:00:00 even after applying retiming.
Type: Double
Specifies the starting frame number.
Type: Int32
Specifies the Display Standard Code (DSC)
| Value | Meaning |
|---|---|
0 |
Open subtitling |
1 |
Level-1 teletext |
2 |
Level-2 teletext |
Type: Int
Specifies the XDS program name.
Type: utf8[]
Gets or sets the text background padding type.
| Value | Name | Description |
|---|---|---|
0 |
PaddingType_Default | Apply some padding around string backgrounds) |
1 |
PaddingType_Fit | Fit the background as closely to the text as possible) |
2 |
PaddingType_FullStripe | Extend the background to the left and right edge of the screen) |
Type: Int
Gets or sets the language code in ISO-639 packed format.
Type: UInt16
Gets or sets the TTML include offset metadata option.
When true, TTML outputs will include metadata about the source start timecode and offset applied.
Type: Bool
Specifies the XDS program type(s)
A comma delimited string containing a list of XDS program types.
Type: utf8[]
Gets or sets whether the background color applies to all regions or only certain regions.
| Value | Name | Description |
|---|---|---|
0 |
ColorOverrideMode_All | all string backgrounds will be modified |
1 |
ColorOverrideMode_Opaque | only strings with opaque backgrounds will be modified |
2 |
ColorOverrideMode_Transparent | only strings with transparent backgrounds will be modified |
Type: Int
Specifies the XDS V-chip content rating.
| Ratings | Rating Flags |
|---|---|
TV-MA |
V Violence/Fantasy Violence |
TV-14 |
S Sexual Situations |
TV-PG |
L Adult Language |
TV-Y7 |
D Sexually Suggestive Dialog |
TV-Y |
Note: Rating flags are added in parentheses. For example, TV-MA (VSL)
Type: utf8[]
Specifies the XDS CGMS value.
No copying is permitted
PSP On; 4
PSP On; 2
PSP On; Split Burst Off
One generation of copies may be made
Note: Optional: (Analog Source Bit)
Type: utf8[]
Pads the output duration by 1 second to ensure that program ends on an empty frame rather than a caption or subtitle.
Used to ensure the output ends on an empty frame instead of a caption/subtitle frame.
Type: Bool
Specifies the subtitle ancillary page number.
Type: Int
Specifies the VANC line number for Teletext VBI line 3.
Type: Int
Gets or sets the metadata properties.
Type: Propeerties
Enables or disables CEA-708 wide mode (42 column)
Note that some decoders do not properly handle wide mode.
Type: Bool
Gets or sets the drop shadow setting.
Type: Bool
Gets or sets the language tag.
Use a language tag format appropriate for the output format, e.g. IETF BCP 47 (‘en’ or ‘en-US’) for TTML/XML. For EBU-STL, use: ‘Latin’, ‘Latin/Cyrillic’, ‘Latin/Arabic’, ‘Latin/Greek’, or ‘Latin/Hebrew’. For Teletext, use: ‘Latin’, ‘Cyrillic-1’, ‘Cyrillic-2’, ‘Cyrillic-3’, ‘Arabic’, ‘Greek’, or ‘Hebrew’.
Type: utf8[]
The sample duration of the rendered subtitle bitmap.
Type: Int
Indicates whether timecode metadata in source samples should be ignored.
Type: Bool
Specifies the field number used when decoding SCC captions.
| Value | Meaning |
|---|---|
0 |
Field 1 (CC1/CC2) |
1 |
Field 2 (CC3/CC4) |
Type: Int
Gets or sets the text outline size used for secondary subtitles.
Range: 0 (no outline) to 100 (outline size 100% of font size)
Type: Double
Gets or sets the field (0 or 1) for outputting SCC samples.
Type: Int
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the VANC line number for Teletext VANC line 1.
Type: Int
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets the font family name.
Type: utf8[]
Specifies the subtitle page number.
Type: Int
Gets or sets the font family name used for secondary subtitles.
Type: utf8[]
Gets or sets the text foreground color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the text foreground color used for secondary subtitles.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the text background color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets whether the background color applies to all strings or only certain strings.
| Value | Name | Description |
|---|---|---|
0 |
ColorOverrideMode_All | all string backgrounds will be modified |
1 |
ColorOverrideMode_Opaque | only strings with opaque backgrounds will be modified |
2 |
ColorOverrideMode_Transparent | only strings with transparent backgrounds will be modified |
Type: Int
Specifies a particular TTML output variant
| Value | Meaning |
|---|---|
0 |
Basic |
1 |
SPMTE ST2052 |
2 |
SPMTE ISMC1 |
3 |
SPMTE iTT |
4 |
SPMTE EBU-TT |
5 |
SPMTE ISMC1_1 |
Note: Defaults to Basic when input is a subtitle format, or SMPTE-2052 when the input is a caption format.
Type: Int32
Gets or sets the text outline color in TTML <color> format.
Type: utf8[]
Gets or sets the text outline color used for secondary subtitles in TTML <color> format.
Type: utf8[]
Specifies the DVB subtitle type according to ETSI EN 300 468 Table 26
| Value | Meaning |
|---|---|
16 |
Normal |
32 |
Hard of hearing |
Type: Byte
Specifies the size of the bitmap color palette in bits, allowable values are 4, 16 or 256.
Type: Int
Gets or sets the text outline size as a percentage of the font size.
Range: 0 (no outline) to 100 (outline size 100% of font size)
Type: Double
Gets or sets the region background color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Specifies the VANC line number for Teletext VANC line 2.
Type: Int
Gets or sets the force bold setting.
Type: Bool
Sets the timecode metadata type to be used for caption extraction from video sources.
When not specified, the CiemConverter uses a default list of timecode formats. When specified, the CiemConverter will only look for the specified timecode format.
Type: Four
Gets or sets the region bottom margin.
Note: Default 0.1 = 10% safe area margin.
Type: Double
Specifies the caption channel, caption service or Teletext page to decode
| Value | Meaning |
|---|---|
0 |
CEA-608 CC1 |
1 |
CEA-608 CC2 |
2 |
CEA-608 CC3 |
3 |
CEA-608 CC4 |
10 |
CEA-708 Service 1 |
11 |
CEA-708 Service 2 |
12 |
CEA-708 Service 3 |
13 |
CEA-708 Service 4 |
14 |
CEA-708 Service 5 |
15 |
CEA-708 Service 6 |
888 |
Teletext Page |
Type: Int
Gets or sets the subtitle normalize colors option.
When true, subtitle colors will be normalized to the nearest matching TTML named color.
Type: Bool
Enables or disables double height mode.
Note: Default is true.
Type: Bool
Gets or sets the name of the character set encoding used to parse a subtitle source.
Type: utf8[]
Gets or sets the Remove Slate option.
Note: Default = false
When set to true, a first subtitle which is detected as a slate subtitle will be removed. See: SlateKeyword and SlateMinLines properties.
Type: Bool
Gets or sets the region left margin.
Note: Default 0.1 = 10% safe area margin.
Type: Double
Gets or sets the drop shadow blur radius setting.
Units are in pixels, e.g. 5.0 pixel blur radius
Type: Bool
Gets or sets the region top margin.
Note: Default 0.1 = 10% safe area margin.
Type: Double
Specifies the VANC line number for Teletext VBI line 1.
Type: Int
Gets or sets the region font scaling.
Values in the range of (0, 4.0) are treated as a multiplier, e.g. 2.0 = 200% of default font size. Values >= 4.0 are treated as an absolute pixel size, e.g. 48.0 = 48px font size.
Type: Double
Gets or sets the region font scaling used for secondary subtitles.
Values in the range of (0, 4.0) are treated as a multiplier, e.g. 2.0 = 200% of default font size. Values >= 4.0 are treated as an absolute pixel size, e.g. 48.0 = 48px font size.
Type: Double
Gets or sets the drop shadow angle setting.
Units are degrees with 0 being Right, 90 being Up, 315 is Down & Right.
Type: Double
Gets or sets the drop shadow color setting in TTML <color> format.
Type: utf8[]
Specifies the page number (e.g. 888).
Type: Int
Specifies the VANC line number for Teletext VBI line 2.
Type: Int
Specifies the VANC line number for Teletext VBI line 4.
Type: Int
Specifies the VANC line number for Teletext VANC line 5.
Type: Int
Specifies the type of filler data.
| Value | Meaning |
|---|---|
0 |
Packet 31 (default) |
1 |
Null page headers |
2 |
None |
Type: Int
Specifies the national option character set.
Note: Default is 0 (English). See ETS 300 706 for values.
Type: Int
Sets the value of the X-TIMESTAMP-MAP=MPEGTS: header.
Type: utf8[]
Specifies the TTML time expression mode
| Value | Meaning |
|---|---|
0 |
Default |
1 |
HHMMSSFF |
2 |
HHMMSSsss |
3 |
Frames |
4 |
Ticks |
5 |
Seconds |
Note: Default is HHMMSSFF for ST2052 and iTT, HHMMSSsss for other profiles.
Type: Int
Indicates whether to include the frame rate in the TTML.
Type: Bool
Indicates whether to include the aspect ratio in the TTML.
Type: Bool
Gets or sets the omit style tags property.
By default, WebVTT and SRT outputs include HTML-like style tags for underline, italics, and bold. Setting this property to true will disable adding these style tags.
Note: Default = False
Type: Bool
Gets or sets the VTT Use Line Numbers option.
Note: Default = false (cue vertical position is written as % of vertical height)
When set to true, cue vertical position will be expressed as a line number 1 - 15. Negative line numbers count up from the bottom of the screen.
Type: Bool
Gets or sets the VTT Use Line Alignment option.
Note: Default = false (line position is always computed assuming line aligment = ‘start’)
When set to true, cue line alignment will be specified in the cue settings. E.g. line:50%,center
Type: Bool
Gets or sets the slate keyword option.
Sets a keyword used to detect a slate first subtitle, e.g. ‘TITLE:’ or ‘TRANSLATOR:’ If RemoveSlate is set to true and the first subtitle contains this word, the subtitle will be removed.
Note: Default = (none)
Type: utf8[]
Gets or sets the slate minimum number of lines option.
Sets the minimum number of text lines needed to detect that the first subtitle is a slate. If RemoveSlate is set to true and the first subtitle contains at least this number of lines, it will be removed.
Note: Default = 0
Type: Int
Gets or sets the Teletext ‘accurate decoding’ mode.
Accurate Mode is intended for decoding Teletext to bitmaps (subtitle overlay, burn-in) as a reference monitor would. For example, double height text will be vertically stretched, and text will be constrained to a 4x3 canvas within wider aspect ratio outputs. This mode is not ideal when converting to other subtitle formats such as TTML or WebVTT.
Note: Defaults = False
Type: Bool
Gets or sets the National Option character set.
The National Option character set adds additional special characters to the base Latin set. Unless the file contains metadata to specify the desired national option set, the user must specify the desired national option set, otherwise some special characters may be decoded incorrectly.
| Value | Meaning |
|---|---|
0 |
English |
1 |
German |
2 |
Swedish/Finnish/Hungarian (not implemented) |
3 |
Italian |
4 |
French |
5 |
Portuguese/Spanish |
Note: Default = 0 (English)
Type: int
Gets or sets the WebVTT omit cue settings mode.
By default, WebVTT outputs include cue settings for positioning. Setting this property to true will disable adding these cue settings.
Note: Default = False
Type: Bool
Gets or sets the subtitle normalize regions option.
When true, subtitle regions will be normalized to commonly used region definitions, where possible.
Type: Bool
Sets the frame number from which caption data will be emitted. No active caption data will be emitted prior to this frame. Any prior frames will contain empty caption packets only.
Default = 0 This value should be specified in the output frame rate.
Type: int
Sets the EBU metadata strings for EBU-STL.
property keys: OriginalProgramTitle, OriginalEpisodeTitle, TranslatedProgramTitle, TranslatedEpisodeTitle, TranslatorName, TranslatorContactDetails, SubtitleListReferenceCode, CreationDate, RevisionDate, RevisionNumber, TotalNumberOfDisks, DiskSequenceNumber, CountryOfOrigin, Publisher, EditorName, EditorContactDetails
Type: Properties
Sets the Time Code Status (TCS) for EBU-STL.
Default = 0 (not used)
Type: int
Sets the Time Code Start-of-Program (TCP) for EBU-STL.
Default = empty string
Type: string
@brief Treat EBU-STL chevrons as italics markers.
@details By default, chevrons (< and >) in EBU-STL are treated as text. When set to true, chevrons will be treated as italics markers instead.
@type Bool
@brief Sets the EBU-STL use grid alignment setting.
@details By default, EBU-STL outputs will use Left/Center/Right Justifcation when outputting in Open Subtitles mode (see SubtitleTeletextDisplayStandard ), or Not Justified (grid alignment) when using the Teletext mode. Setting this property overrides the default behavior.
@type Bool
@brief Sets the EBU-STL force center alignment setting.
@details By default, EBU-STL outputs will use Left/Center/Right Justifcation depending on the position of the source subtitle. Setting this property overrides the justification to always be center.
@type Bool
@brief Sets the TTML vertical split position.
@details Some TTML profiles place subtitles into a top or bottom region depending on the position of the source subtitle. By default, subtitles higher than the middle (0.5) are placed in the top region. Set this value to control the split between top and bottom subtitles. E.g. 0.2 = subtitles in the top 20% of screen height will be placed in the top region.
@type Double
@brief Sets the EBU-STL format code setting.
@details By default, EBU-STL outputs will set the Disk Format Code (DFC) based on the output framerate. Standard values are STL30.01 and STL25.01 for 30/25fps respectively, non-standard values include STL23.01, STL24.01, STL29.01, STL50.01, STL59.01, and STL60.01 for 23.976, 24, 29.97, 50, 59.94, and 60fps respectively. This setting will override the default value. The string must be 8 characters long.
@type string
Plain text timecode options.
| Value | Name | Description |
|---|---|---|
0 |
InOut | Start and End timecodes. |
1 |
In | Start timecode only. |
2 |
None | No timecodes, subtitle text only. |
Plain text timecode formats.
| Value | Name | Description |
|---|---|---|
0 |
HHMMSSFF | HH:MM:SS:FF |
1 |
HHMMSSsss | HH:MM:SS.sss |
Plain text line delimiters.
| Value | Name | Description |
|---|---|---|
0 |
Newline | 1 newline between subtitle lines and 2 newlines between subtitles. |
1 |
Tab | tab delimited |
[dcbm]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the background color of the subtitle regions.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
The subtitle bitmap text.
This property is set on the output sample of all subtitle bitmap converters.
Type: String
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets a value indicating whether to emit captions immediately.
If true the caption converter will produce a subtitle sample immediately following a change in the visual state of the caption decoder. If false the samples are delayed in order to determine the duration between visual state changes.
Type: Bool
Specifies the background color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the foreground color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets a value indicating whether to perform analysis during conversion
Note: Defaults to false.
Type: Bool
[dvbm]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the background color of the subtitle regions.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
The subtitle bitmap text.
This property is set on the output sample of all subtitle bitmap converters.
Type: String
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets a value indicating whether to emit captions immediately.
If true the caption converter will produce a subtitle sample immediately following a change in the visual state of the caption decoder. If false the samples are delayed in order to determine the duration between visual state changes.
Type: Bool
Specifies the background color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the foreground color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets a value indicating whether to perform analysis during conversion
Note: Defaults to false.
Type: Bool
[lcbm]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the background color of the subtitle regions.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
The subtitle bitmap text.
This property is set on the output sample of all subtitle bitmap converters.
Type: String
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets a value indicating whether to emit captions immediately.
If true the caption converter will produce a subtitle sample immediately following a change in the visual state of the caption decoder. If false the samples are delayed in order to determine the duration between visual state changes.
Type: Bool
Specifies the background color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the foreground color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets a value indicating whether to perform analysis during conversion
Note: Defaults to false.
Type: Bool
[arbm]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the background color of the subtitle regions.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
The subtitle bitmap text.
This property is set on the output sample of all subtitle bitmap converters.
Type: String
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets a value indicating whether to emit captions immediately.
If true the caption converter will produce a subtitle sample immediately following a change in the visual state of the caption decoder. If false the samples are delayed in order to determine the duration between visual state changes.
Type: Bool
Specifies the background color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the foreground color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets a value indicating whether to perform analysis during conversion
Note: Defaults to false.
Type: Bool
Gets or sets a value indicating whether to display CS (clear screen) commands.
Type: Bool
[pabm]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the background color of the subtitle regions.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
The subtitle bitmap text.
This property is set on the output sample of all subtitle bitmap converters.
Type: String
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets a value indicating whether to emit captions immediately.
If true the caption converter will produce a subtitle sample immediately following a change in the visual state of the caption decoder. If false the samples are delayed in order to determine the duration between visual state changes.
Type: Bool
Specifies the background color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the foreground color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets a value indicating whether to perform analysis during conversion
Note: Defaults to false.
Type: Bool
Gets or sets the name of the character set encoding used to parse a subtitle source.
Type: utf8[]
[srbm]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the background color of the subtitle regions.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
The subtitle bitmap text.
This property is set on the output sample of all subtitle bitmap converters.
Type: String
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets a value indicating whether to emit captions immediately.
If true the caption converter will produce a subtitle sample immediately following a change in the visual state of the caption decoder. If false the samples are delayed in order to determine the duration between visual state changes.
Type: Bool
Specifies the background color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the foreground color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets a value indicating whether to perform analysis during conversion
Note: Defaults to false.
Type: Bool
[ssty]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Gets or sets the drop shadow angle setting.
Units are degrees with 0 being Right, 90 being Up, 315 is Down & Right.
Type: Double
Sets the text foreground color. This property contains a TTML.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Sets the drop shadow distance setting.
Set as a multiplier of font size, e.g. 0.1 = 10% of font size.
Type: Double
Gets or sets the options to snap subtitles to the top and/or bottom margin
| Value | Meaning |
|---|---|
1 |
Snap all to top |
2 |
Snap all to bottom |
3 |
Snap subtitles to the top or bottom depending on which is closer |
Type: Int32
Specifies the text background color as a TTML color value
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Sets whether the background color applies to all regions or only certain regions.
| Value | Name | Description |
|---|---|---|
0 |
ColorOverrideMode_All | all string backgrounds will be modified |
1 |
ColorOverrideMode_Opaque | only strings with opaque backgrounds will be modified |
2 |
ColorOverrideMode_Transparent | only strings with transparent backgrounds will be modified |
Type: Int
Specifies the font family name for subtitle text.
Type: utf8[]
Specifies the font family name used for secondary subtitles.
Type: utf8[]
Sets whether the background color applies to all strings or only certain strings.
| Value | Name | Description |
|---|---|---|
0 |
ColorOverrideMode_All | all string backgrounds will be modified |
1 |
ColorOverrideMode_Opaque | only strings with opaque backgrounds will be modified |
2 |
ColorOverrideMode_Transparent | only strings with transparent backgrounds will be modified |
Type: Int
Specifies the text foreground color as a TTML color value
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Sets the text background padding type.
| Value | Name | Description |
|---|---|---|
0 |
PaddingType_Default | Apply some padding around string backgrounds |
1 |
PaddingType_Fit | Fit the background as closely to the text as possible |
2 |
PaddingType_FullStripe | Extend the background to the left and right edge of the screen |
Type: Int
Sets the text outline size as a percentage of the font size.
Range: 0 (no outline) to 100 (outline size 100% of font size)
Type: Double
Sets the text outline color in TTML <color> format.
Type: utf8[]
Gets or sets the text outline size for secondary subtitles as a percentage of the font size.
Range: 0 (no outline) to 100 (outline size 100% of font size)
Type: Double
Sets the text outline color used for secondary subtitles in TTML <color> format.
Type: utf8[]
Sets the force bold setting.
Type: Bool
Sets the region left margin.
Note: Default 0.1 = 10% safe area margin.
Type: Double
Specifies the region background color as a TTML color value.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Sets the region right margin.
Note: Default 0.1 = 10% safe area margin.
Type: Double
Sets the region top margin.
Note: Default 0.1 = 10% safe area margin.
Type: Double
Sets the region bottom magrin.
Note: Default 0.1 = 10% safe area margin.
Type: Double
Sets the region font scaling.
Values in the range of (0, 4.0) are treated as a multiplier, e.g. 2.0 = 200% of default font size. Values >= 4.0 are treated as an absolute pixel size, e.g. 48.0 = 48px font size.
Type: Double
Sets the region font scaling used for secondary subtitles.
Values in the range of (0, 4.0) are treated as a multiplier, e.g. 2.0 = 200% of default font size. Values >= 4.0 are treated as an absolute pixel size, e.g. 48.0 = 48px font size.
Type: Double
Sets the drop shadow setting.
Type: Bool
Sets the drop shadow color setting in TTML <color> format.
Type: utf8[]
Sets the drop shadow blur radius setting.
Units are in pixels, e.g. 5.0 pixel blur radius
Type: Bool
Gets or sets the subtitle normalize regions option.
When true, subtitle regions will be normalized to commonly used region definitions, where possible.
Type: Bool
[spc ]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
The bit rate to be reflected on the output properties.
See Also: CMediaProperties
Type: Int64
The frame duration rounding method.
When converting frame durations this property determines how new durations will be calculated if rounding should occur.
Note: Defaults to Nearest.
Type: RoundingMethods
The properties collection to set on the output media properties.
Each property in the collection will be set as named property on the output media properties.
Note: Defaults to nullptr.
Type: CProperties
The format to be reflected on the output properties.
See Also: CMediaProperties
Type: Four
The language to be reflected on the output properties.
See Also: CMediaProperties
Type: UInt16
The region to be reflected on the output properties.
See Also: CMediaProperties
Type: UInt16
The media duration to be reflected on the output properties.
See Also: CMediaProperties
Type: Int64
The frame duration to be reflected on the output properties.
Additionally each sample will reflect the frame duration.
See Also: CSubtitleProperties
Type: Int32
The time scale to be reflected on the output properties.
See Also: CSubtitleProperties
Type: Int32
Frame duration rounding method.
| Value | Name | Description |
|---|---|---|
0 |
None | Do not change the frame durations. |
2 |
Down | Round down to the closest time. |
1 |
Override | Override with the output frame duration, do not round. Note, the media duration may not be the same. |
3 |
Up | Round up to the closest time. |
4 |
Nearest | Round to the nearest frame duration. |
[sfbm]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the background color of the subtitle regions.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
The subtitle bitmap text.
This property is set on the output sample of all subtitle bitmap converters.
Type: String
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets a value indicating whether to emit captions immediately.
If true the caption converter will produce a subtitle sample immediately following a change in the visual state of the caption decoder. If false the samples are delayed in order to determine the duration between visual state changes.
Type: Bool
Specifies the background color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the foreground color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets a value indicating whether to perform analysis during conversion
Note: Defaults to false.
Type: Bool
[stbm]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the background color of the subtitle regions.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
The subtitle bitmap text.
This property is set on the output sample of all subtitle bitmap converters.
Type: String
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets a value indicating whether to emit captions immediately.
If true the caption converter will produce a subtitle sample immediately following a change in the visual state of the caption decoder. If false the samples are delayed in order to determine the duration between visual state changes.
Type: Bool
Specifies the background color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the foreground color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets a value indicating whether to perform analysis during conversion
Note: Defaults to false.
Type: Bool
@brief Treat EBU-STL chevrons as italics markers.
@details By default, chevrons (< and >) in EBU-STL are treated as text. When set to true, chevrons will be treated as italics markers instead.
@type Bool
[lstf]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the background color of the subtitle regions.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
The subtitle bitmap text.
This property is set on the output sample of all subtitle bitmap converters.
Type: String
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets a value indicating whether to emit captions immediately.
If true the caption converter will produce a subtitle sample immediately following a change in the visual state of the caption decoder. If false the samples are delayed in order to determine the duration between visual state changes.
Type: Bool
Specifies the background color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the foreground color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets a value indicating whether to perform analysis during conversion
Note: Defaults to false.
Type: Bool
Time scale of output frame rate.
Type: Int64
[tebm]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the background color of the subtitle regions.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
The subtitle bitmap text.
This property is set on the output sample of all subtitle bitmap converters.
Type: String
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets a value indicating whether to emit captions immediately.
If true the caption converter will produce a subtitle sample immediately following a change in the visual state of the caption decoder. If false the samples are delayed in order to determine the duration between visual state changes.
Type: Bool
Specifies the background color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the foreground color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets a value indicating whether to perform analysis during conversion
Note: Defaults to false.
Type: Bool
Specifies the caption decoder channel.
| Value | Meaning |
|---|---|
0 |
CEA-608 CC1 |
1 |
CEA-608 CC2 |
2 |
CEA-608 CC3 |
3 |
CEA-608 CC4 |
10 |
CEA-708 Service 1 |
11 |
CEA-708 Service 2 |
12 |
CEA-708 Service 3 |
13 |
CEA-708 Service 4 |
14 |
CEA-708 Service 5 |
15 |
CEA-708 Service 6 |
Type: Int
Gets or sets the name of the character set encoding used to parse a subtitle source.
Type: utf8[]
Gets or sets the ‘accurate decoding’ mode.
Accurate Mode is intended for decoding Teletext to bitmaps (subtitle overlay, burn-in) as a reference monitor would. For example, double height text will be vertically stretched, and text will be constrained to a 4x3 canvas within wider aspect ratio outputs. This mode is not ideal when converting to other subtitle formats such as TTML or WebVTT.
Note: Default = false
Type: Bool
Gets or sets the National Option character set.
The National Option character set adds additional special characters to the base Latin set. Unless the file contains metadata to specify the desired national option set, the user must specify the desired national option set, otherwise some special characters may be decoded incorrectly.
| Value | Meaning |
|---|---|
0 |
English |
1 |
German |
2 |
Swedish/Finnish/Hungarian (not implemented) |
3 |
Italian |
4 |
French |
5 |
Portuguese/Spanish |
Note: Default = 0 (English)
Type: int
[txbm]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the background color of the subtitle regions.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
The subtitle bitmap text.
This property is set on the output sample of all subtitle bitmap converters.
Type: String
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets a value indicating whether to emit captions immediately.
If true the caption converter will produce a subtitle sample immediately following a change in the visual state of the caption decoder. If false the samples are delayed in order to determine the duration between visual state changes.
Type: Bool
Specifies the background color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the foreground color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets a value indicating whether to perform analysis during conversion
Note: Defaults to false.
Type: Bool
[ttbm]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the background color of the subtitle regions.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
The subtitle bitmap text.
This property is set on the output sample of all subtitle bitmap converters.
Type: String
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets a value indicating whether to emit captions immediately.
If true the caption converter will produce a subtitle sample immediately following a change in the visual state of the caption decoder. If false the samples are delayed in order to determine the duration between visual state changes.
Type: Bool
Specifies the background color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the foreground color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets a value indicating whether to perform analysis during conversion
Note: Defaults to false.
Type: Bool
[vtbm]Four character code that specifies the output video stream format
Type: Four
True if the filter is using hardware acceleration.
Note: This property is read only.
Type: Bool
Specifies the background color of the subtitle regions.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
The subtitle bitmap text.
This property is set on the output sample of all subtitle bitmap converters.
Type: String
Gets or sets the width (in pixels) of the rendered bitmap subtitles.
Type: Int
Gets or sets a value indicating whether to emit captions immediately.
If true the caption converter will produce a subtitle sample immediately following a change in the visual state of the caption decoder. If false the samples are delayed in order to determine the duration between visual state changes.
Type: Bool
Specifies the background color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets the height (in pixels) of the rendered bitmap subtitles.
Type: Int
Specifies the foreground color of the subtitle text as a TTML color.
This property contains a TTML <color> according to section 8.3.2:
Type: utf8[]
Gets or sets a value indicating whether to perform analysis during conversion
Note: Defaults to false.
Type: Bool