Skip to main content
Version: 20 Mar 2024

MLWebVTTData

Module: Media Player

WebVTT data structure. More...

#include <ml_media_webvtt.h>

Public Attributes

TypeName
int64_tstart_time_ms
int64_tend_time_ms
char *body
char *id
boolsnap_to_lines
MLWebVTTOrientationorientation
MLWebVTTDirectiondirection
floatrelative_line_position
int32_tline_number
floattext_position
floatsize
MLWebVTTAlignalign

Detailed Description

struct MLWebVTTData;

WebVTT data structure.

Deprecated

Deprecated since 1.4.0. Scheduled for removal.

API Level:

  • 4

Public Attributes Documentation

start_time_ms

int64_t start_time_ms;

Track cue start time in milliseconds.


end_time_ms

int64_t end_time_ms;

Track cue end time in milliseconds.


body

char * body;

WebVTT file body encoded as UTF-8.


id

char * id;

A sequence of characters unique amongst all the WebVTT cue identifiers.


snap_to_lines

bool snap_to_lines;

A boolean indicating whether the line is an integer number of lines.


orientation

MLWebVTTOrientation orientation;
TypeDescription
MLWebVTTOrientationCue orientation setting.

Orientation of the cue.


direction

MLWebVTTDirection direction;
TypeDescription
MLWebVTTDirectionCue direction setting.

The writing direction.


relative_line_position

float relative_line_position;

Relative cue line position.


line_number

int32_t line_number;

WebVTT cue line number.


text_position

float text_position;

The indent of the cue box in the direction defined by the writing direction.


size

float size;

WebVTT cue size.


align

MLWebVTTAlign align;
TypeDescription
MLWebVTTAlignCue aligment setting.

WebVTT cue text alignment.