GCKMediaTextTrackStyle Class

Instance Methods | Class Methods | Properties

GCKMediaTextTrackStyle Class Reference

Overview

A class representing a style for a text media track.

Inherits NSObject. Implements <NSCopying>.

Instance Method Summary
(instancetype)	- init
	Designated initializer. More...

Class Method Summary
(instancetype)	+ createDefault
	Creates an instance with default values based on the system's closed captioning settings. More...

Property Summary
CGFloat	fontScale
	The font scaling factor for the text. More...
GCKColor *	foregroundColor
	The foreground color. More...
GCKColor *	backgroundColor
	The background color. More...
GCKMediaTextTrackStyleEdgeType	edgeType
	The edge type. More...
GCKColor *	edgeColor
	The edge color. More...
GCKMediaTextTrackStyleWindowType	windowType
	The window type. More...
GCKColor *	windowColor
	The window color. More...
CGFloat	windowRoundedCornerRadius
	Rounded corner radius absolute value in pixels. More...
NSString *	fontFamily
	The font family; if the font is not available, the generic font family will be used. More...
GCKMediaTextTrackStyleFontGenericFamily	fontGenericFamily
	The generic font family. More...
GCKMediaTextTrackStyleFontStyle	fontStyle
	The font style. More...
id	customData
	The custom data, if any. More...

Method Detail

- (instancetype) init

Designated initializer.

All properties are mutable and so can be supplied after construction.

+ (instancetype) createDefault

Creates an instance with default values based on the system's closed captioning settings.

This method will return nil on systems older than iOS 7.

Property Detail

- (CGFloat) fontScale

readwritenonatomicassign

The font scaling factor for the text.

- (GCKColor*) foregroundColor

readwritenonatomiccopy

The foreground color.

- (GCKColor*) backgroundColor

readwritenonatomiccopy

The background color.

- (GCKMediaTextTrackStyleEdgeType) edgeType

readwritenonatomicassign

The edge type.

- (GCKColor*) edgeColor

readwritenonatomiccopy

The edge color.

- (GCKMediaTextTrackStyleWindowType) windowType

readwritenonatomicassign

The window type.

- (GCKColor*) windowColor

readwritenonatomiccopy

The window color.

- (CGFloat) windowRoundedCornerRadius

readwritenonatomicassign

Rounded corner radius absolute value in pixels.

- (NSString*) fontFamily

readwritenonatomiccopy

The font family; if the font is not available, the generic font family will be used.

- (GCKMediaTextTrackStyleFontGenericFamily) fontGenericFamily

readwritenonatomicassign

The generic font family.

- (GCKMediaTextTrackStyleFontStyle) fontStyle

readwritenonatomicassign

The font style.

- (id) customData

readwritenonatomicstrong

The custom data, if any.