Python library overview

The Python library is the package captionbob. Each page shows one module with its public classes and functions, from the docstrings of the code. A name is public when it does not start with an underscore.

captionbob.effect_common

The shared code of the effects of captionbob.

• captionbob.effect_common.ass_script: ASS script text: the subtitle format that the ffmpeg filter ass draws.
• captionbob.effect_common.caption_measure: Caption measure: where libass draws each word of a caption.
• captionbob.effect_common.effect_common: The common part of the effects.

captionbob.effects

Effects of captionbob. An effect shows the captions on the video.

• captionbob.effects.amber: Amber effect: cream serif words with an orange, larger spoken word.
• captionbob.effects.apex: The apex effect: bold white capitals whose keyword grows when spoken.
• captionbob.effects.arcade: The arcade effect: bold white words with a teal neon glow.
• captionbob.effects.azure: Azure effect: white words on a dark box, with the spoken word in blue.
• captionbob.effects.blaze: The blaze effect: large narrow yellow capitals.
• captionbob.effects.blitz: Blitz effect: heavy slanted capitals with one line in a strong color.
• captionbob.effects.bolt: The bolt effect: heavy capitals whose spoken line has a strong color.
• captionbob.effects.bouncy_emoji: Bouncy emoji effect: a caption grows into place under an emoji.
• captionbob.effects.brick: Brick effect: narrow capitals, a soft shadow and keywords that glow.
• captionbob.effects.candy: The candy effect: two heavy words with a keyword color and an emoji.
• captionbob.effects.chalk: The chalk effect: one or two white words on a gray see-through box.
• captionbob.effects.cherry: The cherry effect: two words in bold white capitals with a soft glow.
• captionbob.effects.clara: Clara effect: small white bold phrases in one or two lines.
• captionbob.effects.cobalt: Cobalt effect: white words in one line, with a larger blue keyword.
• captionbob.effects.color_shift_emoji: Color shift emoji effect: the lines of a caption take a color in turn,
• captionbob.effects.dash: The dash effect: narrow white words in sentence case.
• captionbob.effects.fade_in: Fade in effect: a caption shows whole and fades in.
• captionbob.effects.flare: Flare effect: bold white capitals and an orange-red spoken word.
• captionbob.effects.floating_color_shift_emoji: Floating color shift emoji effect: a caption floats with an emoji above
• captionbob.effects.ghost: The ghost effect: hollow white capitals with a soft glow.
• captionbob.effects.glitch: The glitch effect: heavy white capitals whose spoken word splits.
• captionbob.effects.glow_reveal: Glow reveal effect: each word lights up when it is spoken, with a glow.
• captionbob.effects.grace: Grace effect: white serif words that fade in one by one, with a glow.
• captionbob.effects.halo: The halo effect: two words in bold gold serif letters with a glow.
• captionbob.effects.honey: Honey effect: yellow bold serif words with a soft dark shadow.
• captionbob.effects.hush: The hush effect: small white capitals whose words rise into place.
• captionbob.effects.indigo: Indigo effect: narrow light capitals on an indigo box.
• captionbob.effects.iris: Iris effect: capitals with a gradient, a blue spoken word and keywords.
• captionbob.effects.keyword_float: Keyword float effect: a caption floats, and its keywords stand out.
• captionbob.effects.lime: The lime effect: white words on black boxes, one line on a green box.
• captionbob.effects.linen: Linen effect: plain white words on a black box with a soft shadow.
• captionbob.effects.lumen: The lumen effect: small bold white capitals with a soft glow.
• captionbob.effects.mist: The mist effect: small white capitals with a soft glow, whose words fade
• captionbob.effects.moving_highlight: Moving highlight effect: a box behind the word that is spoken.
• captionbob.effects.olive: Olive effect: serif sentence case on a dark box, the spoken word on a
• captionbob.effects.ollie: Ollie effect: heavy off-white words that build up to two lines.
• captionbob.effects.pebble: Pebble effect: gray words on a dark box that light up when spoken.
• captionbob.effects.poppy: Poppy effect: bold rounded white words that pop in, with an emoji.
• captionbob.effects.progressive_opacity: Progressive opacity effect: each word is dim until it is spoken.
• captionbob.effects.punch: Punch effect: bold white words and a heavy slanted keyword.
• captionbob.effects.rally: The rally effect: narrow white capitals whose spoken word takes a color.
• captionbob.effects.remy: The remy effect: narrow leaning white capitals with a hard black shadow.
• captionbob.effects.ribbon: The ribbon effect: bold white words with a colored bar under the line
• captionbob.effects.riot: The riot effect: heavy capitals whose spoken line has a bright color.
• captionbob.effects.rosie: The rosie effect: large bold white words with a red keyword.
• captionbob.effects.ruby: The ruby effect: heavy white capitals with a thick black outline.
• captionbob.effects.scribe: The scribe effect: bold yellow words that lean, typed letter by letter.
• captionbob.effects.silk: The silk effect: white sentence case, the spoken line bold.
• captionbob.effects.slate: The slate effect: small white words on dark gray boxes.
• captionbob.effects.solo: Solo effect: one or two bold rounded words that pop in, with an emoji.
• captionbob.effects.spark: The spark effect: small heavy capitals whose spoken line is larger and
• captionbob.effects.sunny: The sunny effect: white title case words that rise in, keywords yellow.
• captionbob.effects.surge: Surge effect: heavy capitals that slide, zoom or spin into their place.
• captionbob.effects.swift: Swift effect: slanted bold white words that appear one by one.
• captionbob.effects.swipe_from_left: Swipe from left effect: a caption comes in from the left and fades out.
• captionbob.effects.swipe_from_left_with_trail: Swipe from left with trail effect: a caption comes in with a trail.
• captionbob.effects.swipe_from_right: Swipe from right effect: a caption comes in from the right and fades out.
• captionbob.effects.swipe_from_right_with_trail: Swipe from right with trail effect: a caption comes in with a trail.
• captionbob.effects.tiger: The tiger effect: heavy orange capitals that lean, shown word by word.
• captionbob.effects.titan: Titan effect: heavy slanted capitals, keywords that glow and an emoji.
• captionbob.effects.torch: The torch effect: heavy white capitals with the spoken word on a box.
• captionbob.effects.typewriter: Typewriter effect: the letters of a caption appear one after the other.
• captionbob.effects.verse: The verse effect: white words that fade in one by one, with keywords in
• captionbob.effects.volt: The volt effect: heavy narrow light blue capitals with a blue glow.
• captionbob.effects.wisp: Wisp effect: two words at a time in tight letters with a soft glow.
• captionbob.effects.word_by_word: Word by word effect: the words of a caption appear one after the other.
• captionbob.effects.word_hopping_emoji: Word hopping emoji effect: an emoji hops from word to word above a
• captionbob.effects.word_hopping_emoji_push: Word hopping emoji push effect: each word of a caption is pushed down in
• captionbob.effects.word_magnify: Word magnify effect: each word is large when it is spoken.
• captionbob.effects.zest: Zest effect: bold white capitals that drift, with a larger keyword.
• captionbob.effects.zoom_in: Zoom in effect: a caption fades in small and grows to its full size.

captionbob.emoji

Emoji part of captionbob: the emoji closest in meaning to a keyword.

• captionbob.emoji.emoji_font: Emoji font: the PNG image of an emoji in a color emoji font.
• captionbob.emoji.emoji_matcher: Emoji matcher: the emoji closest in meaning to a word.
• captionbob.emoji.text_embedder: Text embedder: the meaning vector of a text in many languages.
• captionbob.emoji.unicode_emoji: Unicode emoji data: the name, group, skin tones and keywords of an emoji.

captionbob.plugins

Plugins of captionbob. A plugin acts on the whole video, not on a caption.

• captionbob.plugins.audio_bar_waveform: Audio bar waveform plugin for the whole video.
• captionbob.plugins.audio_line_waveform: Audio line waveform plugin for the whole video.
• captionbob.plugins.audio_waveform_progress_bar: Audio waveform progress bar plugin for the whole video.
• captionbob.plugins.border_frame_progress_bar: Border frame progress bar plugin for the whole video.
• captionbob.plugins.dual_corner_trail_progress_bar: Dual corner trail progress bar plugin for the whole video.
• captionbob.plugins.progress_bar: Progress bar plugin for the whole video.

captionbob.render

Render part of captionbob: a video version made into a captioned video.

• captionbob.render.burn: The burn of a video with one ffmpeg.
• captionbob.render.command_line: The command line of captionbob: one JSON request in, JSON lines out.
• captionbob.render.effect_catalog: The effects of captionbob by name.
• captionbob.render.ffmpeg_expression: The ffmpeg expressions of the image layers, read with no ffmpeg.
• captionbob.render.plugin_catalog: The plugins of captionbob by name.
• captionbob.render.preview_layers: The emoji layers of a video version for the live preview.
• captionbob.render.settings_values: The settings of an effect or a plugin as JSON values.
• captionbob.render.video_version: One version of a video: the style, the transcript and the plugins.

captionbob.transcript

Transcript part of captionbob: the words of a video with their times.

• captionbob.transcript.caption_groups: Caption groups: the few words that show together as one caption.
• captionbob.transcript.keywords: Keywords of a caption group.
• captionbob.transcript.nvidia_libraries: Loader of the NVIDIA libraries of the Python environment.
• captionbob.transcript.speech_coverage: Speech coverage: the places where the speech of a video has no word.
• captionbob.transcript.transcript: The words of one video with their times.
• captionbob.transcript.whisper_transcriber: Whisper transcriber: the words of a video with their times.
• captionbob.transcript.word_kinds: Word kinds of a transcript, from Stanza.

captionbob.video

Video part of captionbob: the facts of a video that the other parts need.

• captionbob.video.video_info: The facts of one video that the plugins and the render step need.
• captionbob.video.video_probe: The facts of a video file, read with ffprobe.