You.i Engine
IYIClosedCaptionsRenderer::Span Struct Reference

Detailed Description

A struct containing information about a span of text within a Cue.

See also
IYIClosedCaptionsRenderer::Cue

#include <player/YiClosedCaptionsRenderer.h>

Public Member Functions

 Span ()
 

Public Attributes

CYIString text
 
CYIString fontFamily
 
bool italic
 True if the font should be italic. More...
 
bool bold
 True if the font should be bold. More...
 
bool underline
 True if the font should be underlined. More...
 
float fontSize
 The font size in pixels, relative to the video height. More...
 
CYIColor fontColor
 The font color. Defaults to white. More...
 
CYIColor characterBackgroundColor
 The character background color. Defaults to transparent. More...
 

Constructor & Destructor Documentation

◆ Span()

IYIClosedCaptionsRenderer::Span::Span ( )

Member Data Documentation

◆ bold

bool IYIClosedCaptionsRenderer::Span::bold

True if the font should be bold.

◆ characterBackgroundColor

CYIColor IYIClosedCaptionsRenderer::Span::characterBackgroundColor

The character background color. Defaults to transparent.

◆ fontColor

CYIColor IYIClosedCaptionsRenderer::Span::fontColor

The font color. Defaults to white.

◆ fontFamily

CYIString IYIClosedCaptionsRenderer::Span::fontFamily

◆ fontSize

float IYIClosedCaptionsRenderer::Span::fontSize

The font size in pixels, relative to the video height.

◆ italic

bool IYIClosedCaptionsRenderer::Span::italic

True if the font should be italic.

◆ text

CYIString IYIClosedCaptionsRenderer::Span::text

◆ underline

bool IYIClosedCaptionsRenderer::Span::underline

True if the font should be underlined.


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