StormByte-Multimedia 3.3.2
C++26 multimedia processing module of the StormByte suite
Loading...
Searching...
No Matches
StormByte::Multimedia::PreviewSubtitle Struct Reference

Timed decoded subtitle, retaining text, bitmap and styling information. More...

#include <StormByte/multimedia/display.hxx>

Collaboration diagram for StormByte::Multimedia::PreviewSubtitle:

Public Member Functions

 PreviewSubtitle ()=default
 Construct an empty cue.
 PreviewSubtitle (const PreviewSubtitle &other)=default
 Copy a cue.
 PreviewSubtitle (PreviewSubtitle &&other) noexcept=default
 Move a cue.
 ~PreviewSubtitle () noexcept=default
 Release cue storage.
PreviewSubtitle & operator= (const PreviewSubtitle &other)=default
 Copy a cue.
PreviewSubtitle & operator= (PreviewSubtitle &&other) noexcept=default
 Move a cue.

Public Attributes

Safe::Vector< SubtitleRegion > m_regions
 Decoded rectangles; empty means clear.
Safe::String m_style_header
 ASS/SSA decoder header, if supplied.
Safe::Vector< Safe::Shared< const Attachment > > m_fonts
 Shared embedded TTF/OTF resources for styled rendering.
int m_canvas_width = 0
 Subtitle canvas width; zero if unspecified.
int m_canvas_height = 0
 Subtitle canvas height; zero if unspecified.
std::uint64_t m_epoch = 0
 Delivery generation.
std::uint64_t m_id = 0
 Cue identity within the epoch.
double m_start = 0
 Inclusive start in media seconds.
double m_end = 0
 Exclusive end; infinity means until a matching clear or stream drain.

Detailed Description

Timed decoded subtitle, retaining text, bitmap and styling information.

Constructor & Destructor Documentation

◆ PreviewSubtitle() [1/3]

StormByte::Multimedia::PreviewSubtitle::PreviewSubtitle ( )
default

Construct an empty cue.

◆ PreviewSubtitle() [2/3]

StormByte::Multimedia::PreviewSubtitle::PreviewSubtitle ( const PreviewSubtitle & other)
default

Copy a cue.

Parameters
otherSource.

◆ PreviewSubtitle() [3/3]

StormByte::Multimedia::PreviewSubtitle::PreviewSubtitle ( PreviewSubtitle && other)
defaultnoexcept

Move a cue.

Parameters
otherSource.

◆ ~PreviewSubtitle()

StormByte::Multimedia::PreviewSubtitle::~PreviewSubtitle ( )
defaultnoexcept

Release cue storage.

Member Function Documentation

◆ operator=() [1/2]

PreviewSubtitle & StormByte::Multimedia::PreviewSubtitle::operator= ( const PreviewSubtitle & other)
default

Copy a cue.

Parameters
otherSource.
Returns
This cue.

◆ operator=() [2/2]

PreviewSubtitle & StormByte::Multimedia::PreviewSubtitle::operator= ( PreviewSubtitle && other)
defaultnoexcept

Move a cue.

Parameters
otherSource.
Returns
This cue.

Member Data Documentation

◆ m_canvas_height

int StormByte::Multimedia::PreviewSubtitle::m_canvas_height = 0

Subtitle canvas height; zero if unspecified.

◆ m_canvas_width

int StormByte::Multimedia::PreviewSubtitle::m_canvas_width = 0

Subtitle canvas width; zero if unspecified.

◆ m_end

double StormByte::Multimedia::PreviewSubtitle::m_end = 0

Exclusive end; infinity means until a matching clear or stream drain.

◆ m_epoch

std::uint64_t StormByte::Multimedia::PreviewSubtitle::m_epoch = 0

Delivery generation.

◆ m_fonts

Safe::Vector<Safe::Shared<const Attachment> > StormByte::Multimedia::PreviewSubtitle::m_fonts

Shared embedded TTF/OTF resources for styled rendering.

◆ m_id

std::uint64_t StormByte::Multimedia::PreviewSubtitle::m_id = 0

Cue identity within the epoch.

◆ m_regions

Safe::Vector<SubtitleRegion> StormByte::Multimedia::PreviewSubtitle::m_regions

Decoded rectangles; empty means clear.

◆ m_start

double StormByte::Multimedia::PreviewSubtitle::m_start = 0

Inclusive start in media seconds.

◆ m_style_header

Safe::String StormByte::Multimedia::PreviewSubtitle::m_style_header

ASS/SSA decoder header, if supplied.


The documentation for this struct was generated from the following file: