Skip to content
Typography and StyleColor and EffectsPositioning and MarginsText TransformationBorders and Shadow, 
Default: "Arial" Type: str 
Default: 18Type: float
Default: "&H00FFFFFF" (white)Type: str
Default: "&H000000FF" (red)Type: str
Default: "&H00000000" (black)Type: str
Default: &H00000000" (black)Type: str
Default: False Type: bool
Default: FalseType: bool
Default: FalseType: bool
Default: FalseType: bool
Default: 1.0 (100%, no scaling)Type: float
Default: 1.0 (100%, no scaling)Type: float
Default: 0Type: float
Default: 0 (no rotation)Type: float
Default: SubtitleBorderStyle.outlineType: int or SubtitleBorderStyle
.no_border or 1 .opaque_box or 3 .outline or 4
Default: 1.0 (px)Type: float
Default: 0.0Type: float
Default: SubtitleAlignment.bottom_centerType: SubtitleAlignment or int SubtitleAlignment.bottom_left or 1SubtitleAlignment.bottom_center or 2 SubtitleAlignment.bottom_right or 3 SubtitleAlignment.middle_left or 8, 9 SubtitleAlignment.middle_center or 10
VideoDB Documentation
- Pages
Ref: Subtitle Styles
) function supports many parameters for styling your captions or subtitles according to your brand and guidelines. You can create your own
This document provides an API Reference to the parameters of SubtitleStyle function.
Import
Import SubtitleStyle from VideoDB module
from videodb import SubtitleStyle, connect
conn = connect()
coll = conn.get_collection()
video = coll.get_video("MY_VIDEO_ID")
video.add_subtitle(
SubtitleStyle(
font_name = <>,
font_size = <>,
spacing = <>,
....
....
)
)
SubtitleStyle
This function supports following parameters for styling 👇
font_name
The name of the font to use for the subtitles.
font_size
The size of the subtitle text in points.
primary_colour
secondary_colour
The color used for secondary effects like karaoke
outline_colour
The color of the text outline.
back_colour
The background color of the subtitle box
bold
Indicates if the subtitle text is bold.
italic
Indicates if the subtitle text is italicized.
underline
Indicates if the subtitle text is underlined.
strike_out
Indicates if the subtitle text has a strikethrough.
scale_x
The horizontal scale of the subtitle text in percentage.
scale_y
The vertical scale of the subtitle text in percentage.
spacing
Space between characters in pixels.
angle
The rotation angle of the subtitle text in degrees.
border_style
The style of the border around the text
This field accepts following value.
Usage:
from videodb import SubtitleStyle, SubtitleBorderStyle, connect
conn = connect()
coll = conn.get_collection()
video = coll.get_video("MY_VIDEO_ID")
video.add_subtitle(
SubtitleStyle(
border_style = SubtitleBorderStyle.outline
)
)
outline
The width (px) of the outline around the text.
shadow
The depth of the shadow behind the text in pixels.
alignment
The position of the subtitle text on the screen, typically an enumerated type following the SSA/ASS standard.
This field accepts following value.
Want to print your doc?
This is not the way.
This is not the way.
Try clicking the ··· in the right corner or using a keyboard shortcut (
CtrlP
) instead.