Subtitles

class av.subtitles.stream.SubtitleStream

Bases: Stream

decode(packet: Packet | None = None) → list[AssSubtitle] | list[BitmapSubtitle]

decode2(packet: Packet) → SubtitleSet | None

class av.subtitles.subtitle.SubtitleSet

Bases: object

A SubtitleSet can contain many Subtitle objects.

Wraps AVSubtitle.

static create(bytes text: bytes, int start: int, int end: int, int pts: int = 0, int subtitle_format: int = 1) → 'SubtitleSet'

Create a SubtitleSet for encoding.

Args:

text: The subtitle text in ASS dialogue format

(e.g. b”0,0,Default,,0,0,0,,Hello World”)

start: Start display time as offset from pts (typically 0) end: End display time as offset from pts (i.e., duration) pts: Presentation timestamp in stream time_base units subtitle_format: Subtitle format (default 1 for text)

Note:

All timing values should be in stream time_base units. For MKV (time_base=1/1000), units are milliseconds. For MP4 (time_base=1/1000000), units are microseconds.

Returns:

A SubtitleSet ready for encoding

end_display_time

format

pts

Same as packet pts, in av.time_base.

rects

start_display_time

class av.subtitles.subtitle.Subtitle

Bases: object

An abstract base class for each concrete type of subtitle. Wraps AVSubtitleRect

type

class av.subtitles.subtitle.AssSubtitle

Bases: Subtitle

Represents an ASS/Text subtitle format, as opposed to a bitmap Subtitle format.

ass

Returns the subtitle in the ASS/SSA format. Used by the vast majority of subtitle formats.

dialogue

Extract the dialogue from the ass format. Strip comments.

text

Rarely used attribute. You’re probably looking for dialogue.

class av.subtitles.subtitle.BitmapSubtitle

Bases: Subtitle

height

nb_colors

planes

width

x

y

class av.subtitles.subtitle.BitmapSubtitlePlane

Bases: object

buffer_size

index

subtitle