Screenplay

class camtasia.screenplay.VOBlock(id, text, section)[source]

Bases: object

A voice-over text block within a screenplay section.

id: str
text: str
section: str
class camtasia.screenplay.PauseMarker(duration_seconds, description)[source]

Bases: object

A timed pause marker in the screenplay.

duration_seconds: float
description: str
class camtasia.screenplay.TransitionMarker(name)[source]

Bases: object

A named transition marker between screenplay segments.

name: str
class camtasia.screenplay.ImageRef(alt, path)[source]

Bases: object

A reference to an image used in the screenplay.

alt: str
path: str
class camtasia.screenplay.ScreenplaySection(title, level, vo_blocks=<factory>, pauses=<factory>, transitions=<factory>, images=<factory>)[source]

Bases: object

A titled section of a screenplay containing VO blocks, pauses, transitions, and images.

title: str
level: int
vo_blocks: list[VOBlock]
pauses: list[PauseMarker]
transitions: list[TransitionMarker]
images: list[ImageRef]
class camtasia.screenplay.Screenplay(sections)[source]

Bases: object

A parsed screenplay composed of sections.

sections: list[ScreenplaySection]
property vo_blocks: list[VOBlock]

Get all voice-over blocks across all sections.

property total_pauses: float

Get the total pause duration in seconds across all sections.

property all_images: list[ImageRef]

Get all image references across all sections.

camtasia.screenplay.parse_screenplay(path)[source]

Parse a markdown screenplay file into a Screenplay object.

Return type:

Screenplay