You.i Engine
CYIClosedCaptionsStylingBridge::Style Struct Reference

Detailed Description

A container for closed captions style information.

#include <player/YiClosedCaptionsStylingBridge.h>

Public Member Functions

 Style ()
 
const CYIStringGetFontFamily () const
 
ssize_t GetFontID () const
 

Public Attributes

MODE eStylingMode
 
FONT_TYPE eFontType
 The font type for closed captions. If set to CUSTOM, the font family specified in customFontFamily should be used. More...
 
CYIString customFontFamily
 A custom font family. Has no effect if eFontType is not CUSTOM. More...
 
float fFontSizeFractionOfVideoHeight
 The font size, as a fraction of the video height. Ranges from 0 to 1. More...
 
CYIColor characterColor
 
EDGE_STYLE eEdgeStyle
 
CYIColor edgeColor
 
CYIColor characterBackgroundColor
 The color of the background of individual characters. More...
 
CYIColor windowColor
 The color of the background of the rendering region for the caption. More...
 
bool bUsesDefaultFontSize
 If true, indicates that the font size from the content should be used as font size. More...
 
bool bUsesDefaultCharacterColor
 If true, indicates that the character color from the content should be used as character color. More...
 
bool bUsesDefaultEdgeColor
 If true, indicates that the edge color from the content should be used as edge color. More...
 
bool bUsesDefaultCharacterBackgroundColor
 If true, indicates that the character background color from the content should be used as character background color. More...
 
bool bUsesDefaultWindowColor
 If true, indicates that the window color from the content should be used as window color. More...
 

Constructor & Destructor Documentation

CYIClosedCaptionsStylingBridge::Style::Style ( )

Member Function Documentation

const CYIString& CYIClosedCaptionsStylingBridge::Style::GetFontFamily ( ) const

Fetches and returns a sample font family name for this style. This function reads from the eFontType and customFontFamily fields.

ssize_t CYIClosedCaptionsStylingBridge::Style::GetFontID ( ) const

A convenience function to obtain a font ID for this style's font family. This function may fallback on a different font if the required font is not available on the system.

Member Data Documentation

bool CYIClosedCaptionsStylingBridge::Style::bUsesDefaultCharacterBackgroundColor

If true, indicates that the character background color from the content should be used as character background color.

bool CYIClosedCaptionsStylingBridge::Style::bUsesDefaultCharacterColor

If true, indicates that the character color from the content should be used as character color.

bool CYIClosedCaptionsStylingBridge::Style::bUsesDefaultEdgeColor

If true, indicates that the edge color from the content should be used as edge color.

bool CYIClosedCaptionsStylingBridge::Style::bUsesDefaultFontSize

If true, indicates that the font size from the content should be used as font size.

bool CYIClosedCaptionsStylingBridge::Style::bUsesDefaultWindowColor

If true, indicates that the window color from the content should be used as window color.

CYIColor CYIClosedCaptionsStylingBridge::Style::characterBackgroundColor

The color of the background of individual characters.

CYIColor CYIClosedCaptionsStylingBridge::Style::characterColor
CYIString CYIClosedCaptionsStylingBridge::Style::customFontFamily

A custom font family. Has no effect if eFontType is not CUSTOM.

CYIColor CYIClosedCaptionsStylingBridge::Style::edgeColor
EDGE_STYLE CYIClosedCaptionsStylingBridge::Style::eEdgeStyle
FONT_TYPE CYIClosedCaptionsStylingBridge::Style::eFontType

The font type for closed captions. If set to CUSTOM, the font family specified in customFontFamily should be used.

MODE CYIClosedCaptionsStylingBridge::Style::eStylingMode
float CYIClosedCaptionsStylingBridge::Style::fFontSizeFractionOfVideoHeight

The font size, as a fraction of the video height. Ranges from 0 to 1.

CYIColor CYIClosedCaptionsStylingBridge::Style::windowColor

The color of the background of the rendering region for the caption.


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