aeidon.Subtitle

Source: aeidon/subtitle.py

Anchestors: builtins.object

class aeidon.Subtitle

Data store and basic position manipulation of a single subtitle.

Subtitle.start

Start position in native units

Subtitle.start_time

Start time as string

Subtitle.start_frame

Start frame as integer

Subtitle.start_seconds

Start seconds as float

Subtitle.end

End position in native units

Subtitle.end_time

End time as string

Subtitle.end_frame

End frame as integer

Subtitle.end_seconds

End seconds as float

Subtitle.duration

Duration in native units

Subtitle.duration_time

Duration in time as string

Subtitle.duration_frame

Duration in frames as integer

Subtitle.duration_seconds

Duration in seconds as float

Subtitle.main_text

Main text

Subtitle.tran_text

Translation text

Subtitle.calc

aeidon.Calculator instance used

Subtitle.framerate

aeidon.framerates item

Subtitle.mode

aeidon.modes item

Positions can be set as times, frames or seconds. Use aeidon.as_time(), aeidon.as_frame() or aeidon.as_seconds() if necessary to ensure correct type.

Additional format-specific attributes are kept under separate containers, e.g. ssa for Sub Station Alpha formats, accessed as subtitle.ssa.*. These containers are lazily created upon first use in order to avoid slow instantiation and excessive memory use when handling simpler formats.

Methods

Subtitle.__init__(mode=None, framerate=None)

Initialize a Subtitle instance.

Subtitle.convert_framerate(framerate)

Set framerate and convert positions to it.

Subtitle.copy()

Return a new subtitle instance with the same values.

Subtitle.get_duration(mode)

Return duration in mode.

Subtitle.get_end(mode)

Return end position in mode.

Subtitle.get_start(mode)

Return start position in mode.

Subtitle.get_text(doc)

Return text corresponding to doc.

Subtitle.has_container(name)

Return True if container has been instantiated.

Subtitle.scale_positions(value)

Multiply start and end positions by value.

Subtitle.set_text(doc, value)

Set text corresponding to doc to value.

Subtitle.shift_positions(value)

Add value to start and end positions.