VideoDB Documentation
Quick Start Guide
Guide: Subtitles
Adding Subtitles
This guide gives you an introduction to adding Subtitle Styles by showing you visual outputs of the configurations available for the SubtitleStyle class, such as
🛠️ Setup
📦 Installing packages
%pip install videodb
🔑 API Keys
import os
os.environ["VIDEO_DB_API_KEY"] = ""
🌐 Connect to VideoDB
from videodb import connect
conn = connect()
coll = conn.get_collection()
🎥 Upload Video
Upload a base video to add subtitle. For this guide, we’ll use following video
video = coll.upload(url="https://www.youtube.com/watch?v=il39Ks4mV9g")
video.play()
You can upload from your local file system too by passing file_path in upload()
🔊 Index Spoken Words
First, we need to index the video using () function.This ensures the availability of the transcript. Without this step VideoDB wouldn’t be able to add captions to any video.
video.index_spoken_words()
📝 Default Subtitles
To add subtitles to your video you can use () .
from videodb import play_stream
# Add Subtitle to Video
stream_url = video.add_subtitle()
# Play stream
play_stream(stream_url)
💅 Custom Styled Subtitles
To customise the style of subtitle, pass SubtitleStytle() with configured styles to ()
View API Reference for SubtitleStyle class 💅
1. Typography and Style
Configure Typography of the Subtitle by passing following parameters to SubtitleStyle() class
from videodb import SubtitleStyle, play_stream
stream_url = video.add_subtitle(
SubtitleStyle(
font_name = "Roboto",
font_size = 12,
spacing = 0,
bold = False,
italic = False,
underline = False,
strike_out = False
)
)
play_stream(stream_url)
2. Color and Effects
Configure color of Subtitle by passing following parameters to SubtitleStyle() class
Format of Color
SubtitleStyle accepts colors in the RR hexadecimal format, where the sequence represents the blue, green, and red components,
&H prefix is required in this color format.
And when transparency is needed, an alpha value is placed at the beginning, yielding BBGGRR.
from videodb import SubtitleStyle
stream_url = video.add_subtitle(
SubtitleStyle(
primary_colour = "&H00A5CFFF",
secondary_colour = "&H00FFFF00",
outline_colour = "&H000341C1",
back_colour = "&H803B3B3B",
)
)
play_stream(stream_url)
3. Position and Margins
Configure alignment and position of Subtitle by passing following parameters to SubtitleStyle() class
View API Reference to know more about SubtitleAlignment
from videodb import SubtitleStyle, SubtitleAlignment
stream_url = video.add_subtitle(
SubtitleStyle(
alignment = SubtitleAlignment.middle_center,
margin_l = 10,
margin_r = 10,
margin_v = 20,
)
)
play_stream(stream_url)
4. Text Transformation
Transform the text size and spacing by passing following parameters to SubtitleStyle() class
from videodb import SubtitleStyle
stream_url = video.add_subtitle(
SubtitleStyle(
scale_x = 1.5,
scale_y = 3,
angle = 0,
)
)
play_stream(stream_url)
5. Borders and Shadow
Add border style, outline and shadow by passing following parameters to SubtitleStyle() class
View API Reference to know more about SubtitleBorderStyle
from videodb import SubtitleStyle, SubtitleBorderStyle
Want to print your doc?
This is not the way.
This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
CtrlP
) instead.