Instance Methods | Protected Member Functions | Properties | List of all members
OOClosedCaptionsStyle Class Reference
Captions

Defines text style to be used when displaying closed captions. More...

#import <OOClosedCaptionsStyle.h>

+ Inheritance diagram for OOClosedCaptionsStyle:

Instance Methods

(void) - updateStyle
 update closed caption style More...
 
(NSComparisonResult) - compare:
 compare closed captions style More...
 

Protected Member Functions

(typedef) - NS_ENUM
 Closed captions presentation, deprecated. More...
 

Properties

UIColor * textColor
 Closed captions text color. More...
 
CGFloat textOpacity
 Closed captions text opacity (between opaque and semi-transparent) More...
 
NSInteger textSize
 Closed caption text size (from 50% to 200% of default size) More...
 
NSString * textFontName
 Closed captions text font name. More...
 
UIColor * windowColor
 Closed captions window color. More...
 
CGFloat windowOpacity
 Closed captions window opacity. More...
 
OOClosedCaptionPresentation presentation
 Closed captions presentation. More...
 
MACaptionAppearanceTextEdgeStyle edgeStyle
 Closed captions edge attributes. More...
 
MACaptionAppearanceDisplayType displayType
 The type of captions that should be displayed. More...
 
UIColor * backgroundColor
 This is the background of text itself instead of the backgound of the window holding the text So in our SDK when we mention "background" we mean the " window" in this case Closed captions background color. More...
 
CGFloat backgroundOpacity
 Closed captions background opacity (between opaque and semi-transparent) This this is only used for classic settings in device otherwise we choose windowOpacity for background opacity. More...
 

Detailed Description

Defines text style to be used when displaying closed captions.

Method Documentation

- (NSComparisonResult) compare: (OOClosedCaptionsStyle *)  closedCaptionDeviceStyle

compare closed captions style

- (typedef) NS_ENUM (NSInteger) 
(OOClosedCaptionPresentation)   

Closed captions presentation, deprecated.

text that appears all at once

text that scrolls up as new text appears

text where each new letter or word is displayed as it arrives

- (void) updateStyle

update closed caption style

Property Documentation

- (UIColor*) backgroundColor
readwritenonatomicstrong

This is the background of text itself instead of the backgound of the window holding the text So in our SDK when we mention "background" we mean the " window" in this case Closed captions background color.

- (CGFloat) backgroundOpacity
readwritenonatomicassign

Closed captions background opacity (between opaque and semi-transparent) This this is only used for classic settings in device otherwise we choose windowOpacity for background opacity.

- (MACaptionAppearanceDisplayType) displayType
readwritenonatomicassign

The type of captions that should be displayed.

- (MACaptionAppearanceTextEdgeStyle) edgeStyle
readwritenonatomicassign

Closed captions edge attributes.

- (OOClosedCaptionPresentation) presentation
readwritenonatomicassign

Closed captions presentation.

- (UIColor*) textColor
readwritenonatomicstrong

Closed captions text color.

- (NSString*) textFontName
readwritenonatomicstrong

Closed captions text font name.

- (CGFloat) textOpacity
readwritenonatomicassign

Closed captions text opacity (between opaque and semi-transparent)

- (NSInteger) textSize
readwritenonatomicassign

Closed caption text size (from 50% to 200% of default size)

- (UIColor*) windowColor
readwritenonatomicstrong

Closed captions window color.

- (CGFloat) windowOpacity
readwritenonatomicassign

Closed captions window opacity.

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