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 stylingMode
 
FontType fontType
 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 fontType is not CUSTOM. More...
 
float fontSizeFractionOfVideoHeight
 The font size, as a fraction of the video height. Ranges from 0 to 1. More...
 
CYIColor characterColor
 
EdgeStyle edgeStyle
 
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 usesDefaultFontSize
 If true, indicates that the font size from the content should be used as font size. More...
 
bool usesDefaultCharacterColor
 If true, indicates that the character color from the content should be used as character color. More...
 
bool usesDefaultEdgeColor
 If true, indicates that the edge color from the content should be used as edge color. More...
 
bool usesDefaultCharacterBackgroundColor
 If true, indicates that the character background color from the content should be used as character background color. More...
 
bool usesDefaultWindowColor
 If true, indicates that the window color from the content should be used as window color. More...
 

Constructor & Destructor Documentation

◆ Style()

CYIClosedCaptionsStylingBridge::Style::Style ( )

Member Function Documentation

◆ GetFontFamily()

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

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

◆ GetFontID()

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

◆ characterBackgroundColor

CYIColor CYIClosedCaptionsStylingBridge::Style::characterBackgroundColor

The color of the background of individual characters.

◆ characterColor

CYIColor CYIClosedCaptionsStylingBridge::Style::characterColor

◆ customFontFamily

CYIString CYIClosedCaptionsStylingBridge::Style::customFontFamily

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

◆ edgeColor

CYIColor CYIClosedCaptionsStylingBridge::Style::edgeColor

◆ edgeStyle

EdgeStyle CYIClosedCaptionsStylingBridge::Style::edgeStyle

◆ fontSizeFractionOfVideoHeight

float CYIClosedCaptionsStylingBridge::Style::fontSizeFractionOfVideoHeight

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

◆ fontType

FontType CYIClosedCaptionsStylingBridge::Style::fontType

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

◆ stylingMode

Mode CYIClosedCaptionsStylingBridge::Style::stylingMode

◆ usesDefaultCharacterBackgroundColor

bool CYIClosedCaptionsStylingBridge::Style::usesDefaultCharacterBackgroundColor

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

◆ usesDefaultCharacterColor

bool CYIClosedCaptionsStylingBridge::Style::usesDefaultCharacterColor

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

◆ usesDefaultEdgeColor

bool CYIClosedCaptionsStylingBridge::Style::usesDefaultEdgeColor

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

◆ usesDefaultFontSize

bool CYIClosedCaptionsStylingBridge::Style::usesDefaultFontSize

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

◆ usesDefaultWindowColor

bool CYIClosedCaptionsStylingBridge::Style::usesDefaultWindowColor

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

◆ windowColor

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: