CYIClosedCaptionsStylingBridge Class Reference

Detailed Description

A bridge which reports operating system closed captions style.

Can be used to access the user's closed captioning style from the operating system settings.

#include <player/YiClosedCaptionsStylingBridge.h>

Classes
struct	Style

Public Types
enum	MODE {   USE_STYLE_FROM_CONTENT,   USE_STYLE_FROM_USER,   UNKNOWN }
enum	FONT_TYPE {   FONT_DEFAULT,   FONT_MONOSPACE_SANS_SERIF,   FONT_PROPORTIONAL_SANS_SERIF,   FONT_MONOSPACE_WITH_SERIF,   FONT_PROPORTIONAL_WITH_SERIF,   FONT_CASUAL,   FONT_CURSIVE,   FONT_SMALL_CAPITALS,   FONT_CUSTOM }
enum	EDGE_STYLE {   DEFAULT_EDGES,   NO_EDGE,   RAISED_EDGES,   DEPRESSED_EDGES,   UNIFORM_EDGES,   DROP_SHADOWED_EDGES }

Public Member Functions
virtual	~CYIClosedCaptionsStylingBridge ()
virtual Style	GetClosedCaptionsStyle () const =0

Static Public Member Functions
static const Style &	GetDefaultStyle ()

Member Enumeration Documentation

enum CYIClosedCaptionsStylingBridge::EDGE_STYLE

An enum that defines the style with which the edge of the closed caption characters should be rendered. DEFAULT_EDGES indicates that the edge style from the content (or from the player) should be used.

Enumerator
DEFAULT_EDGES
NO_EDGE
RAISED_EDGES
DEPRESSED_EDGES
UNIFORM_EDGES
DROP_SHADOWED_EDGES

enum CYIClosedCaptionsStylingBridge::FONT_TYPE

An enum that identifies the font type to use to render closed captions. FONT_DEFAULT indicates that the default font from the content (or from the player) should be used.

Enumerator
FONT_DEFAULT
FONT_MONOSPACE_SANS_SERIF
FONT_PROPORTIONAL_SANS_SERIF
FONT_MONOSPACE_WITH_SERIF
FONT_PROPORTIONAL_WITH_SERIF
FONT_CASUAL
FONT_CURSIVE
FONT_SMALL_CAPITALS
FONT_CUSTOM

enum CYIClosedCaptionsStylingBridge::MODE

An enum that defines whether the style information provided by this bridge should be used to render captions.

Enumerator
USE_STYLE_FROM_CONTENT	Indicates that the captions should be rendered using the style provided in the captions themselves.
USE_STYLE_FROM_USER	Indicates that the captions should be rendered using the styles provided by the user.
UNKNOWN	Indicates that the styling data source is unknown. The captions renderer may use either the styling information from the captions, or from the user.

Constructor & Destructor Documentation

virtual CYIClosedCaptionsStylingBridge::~CYIClosedCaptionsStylingBridge ( )

virtual

Member Function Documentation

virtual Style CYIClosedCaptionsStylingBridge::GetClosedCaptionsStyle ( ) const

pure virtual

Returns the closed captionning style as configured on the operating system.

static const Style& CYIClosedCaptionsStylingBridge::GetDefaultStyle ( )

static

---

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

• player/YiClosedCaptionsStylingBridge.h