GCKMediaTextTrackStyle Class

  • The GCKMediaTextTrackStyle class represents a style for a text media track and inherits from NSObject,

  • An instance can be created using the designated initializer or by creating a default instance based on the system's closed captioning settings on iOS 7 and later.

  • The class provides properties to customize various aspects of the text track style, including font scale, foreground and background colors, edge type and color, window type and color, window rounded corner radius, font family and generic family, font style, and custom data.

  • Some window-related properties may not be supported on all receiver devices.

GCKMediaTextTrackStyle Class Reference

Overview

A class representing a style for a text media track.

Inherits NSObject, <NSCopying>, and <NSSecureCoding>.

Instance Method Summary

(instancetype) 
- init
Designated initializer. More...

Class Method Summary

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

Property Summary

CGFloat 
The font scaling factor for the text. More...
The foreground color. More...
The background color. More...
GCKMediaTextTrackStyleEdgeType 
The edge type. More...
The edge color. More...
GCKMediaTextTrackStyleWindowType 
The window type. More...
The window color. More...
Rounded corner radius absolute value in pixels. More...
NSString * 
The font family; if the font is not available, the generic font family will be used. More...
GCKMediaTextTrackStyleFontGenericFamily 
The generic font family. More...
GCKMediaTextTrackStyleFontStyle 
The font style. More...
id 
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
read write nonatomic assign

The font scaling factor for the text.

- ( GCKColor *) foregroundColor
read write nonatomic copy

The foreground color.

- ( GCKColor *) backgroundColor
read write nonatomic copy

The background color.

- (GCKMediaTextTrackStyleEdgeType) edgeType
read write nonatomic assign

The edge type.

- ( GCKColor *) edgeColor
read write nonatomic copy

The edge color.

- (GCKMediaTextTrackStyleWindowType) windowType
read write nonatomic assign

The window type.

Some receiver devices may not support this attribute.

- ( GCKColor *) windowColor
read write nonatomic copy

The window color.

Some receiver devices may not support this attribute.

- (CGFloat) windowRoundedCornerRadius
read write nonatomic assign

Rounded corner radius absolute value in pixels.

Some receiver devices may not support this attribute.

- (NSString*) fontFamily
read write nonatomic copy

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

- (GCKMediaTextTrackStyleFontGenericFamily) fontGenericFamily
read write nonatomic assign

The generic font family.

- (GCKMediaTextTrackStyleFontStyle) fontStyle
read write nonatomic assign

The font style.

- (id) customData
read write nonatomic strong

The custom data, if any.

Create a Mobile Website
View Site in Mobile | Classic
Share by: