AliyunPlayer v7.11.0
Aliyun Player API Reference Manual for iOS Platforms
Loading...
Searching...
No Matches
AliVttSubtitleConst Class Reference

Global constant configuration class for subtitle rendering. More...

#include "AliVttSubtitleView.h"

Inheritance diagram for AliVttSubtitleConst:

Properties

CGFloat defaultExtraHeightFactor
 Extra height coefficient for complex characters.
 
NSInteger defaultFontColor
 Default font color.
 
NSString * defaultFontName
 Default font name.
 
NSInteger defaultFontSize
 Default font size.
 
NSInteger defaultLineCount
 Default maximum number of display lines.
 
CGFloat defaultLineHeightVH
 Default line height ratio to video height.
 
CGFloat defaultMaxShowingWidthFactor
 Maximum subtitle width ratio to video width.
 
CGFloat defaultWidthPaddingSize
 Text padding size.
 
NSString * pseudoClassBold
 Bold pseudo-class identifier.
 
NSString * pseudoClassItalic
 Italic pseudo-class identifier.
 

Detailed Description

Global constant configuration class for subtitle rendering.

Provides default configuration parameters for subtitle rendering with support for custom extensions. Clients can inherit this class and override corresponding methods to customize subtitle display effects Supports various style attributes of the WebVTT standard.

Property Documentation

◆ defaultExtraHeightFactor

- (CGFloat) defaultExtraHeightFactor
readnonatomicassign

Extra height coefficient for complex characters.

Returns
Height coefficient, default value is 0.3 (30%)
Note
Used for displaying complex characters like Thai and Chinese, preventing superscripts and subscripts from being truncated

◆ defaultFontColor

- (NSInteger) defaultFontColor
readnonatomicassign

Default font color.

Returns
Color value in ARGB format, default is 0xFFFFFFFF (white)

◆ defaultFontName

- (NSString*) defaultFontName
readnonatomicassign

Default font name.

Returns
Font name, default is "Arial"
Note
Used as default when no font is specified in CSS styles

◆ defaultFontSize

- (NSInteger) defaultFontSize
readnonatomicassign

Default font size.

Returns
Font size in pixels, default value is 20
Note
This value affects the basic display size of subtitle text

◆ defaultLineCount

- (NSInteger) defaultLineCount
readnonatomicassign

Default maximum number of display lines.

Returns
Maximum number of lines, default value is 18
Note
Prevents subtitle content from overflowing the display area

◆ defaultLineHeightVH

- (CGFloat) defaultLineHeightVH
readnonatomicassign

Default line height ratio to video height.

Returns
Line height ratio, default value is 0.0533 (approximately 5.33%)
Note
Used for calculating subtitle line spacing and vertical layout

◆ defaultMaxShowingWidthFactor

- (CGFloat) defaultMaxShowingWidthFactor
readnonatomicassign

Maximum subtitle width ratio to video width.

Returns
Width ratio, default value is 0.7 (70%)
Note
Used to control subtitle text wrapping and horizontal layout constraints

◆ defaultWidthPaddingSize

- (CGFloat) defaultWidthPaddingSize
readnonatomicassign

Text padding size.

Returns
Padding in pixels, default value is 2.0
Note
Prevents text from being truncated at boundaries

◆ pseudoClassBold

- (NSString*) pseudoClassBold
readnonatomicassign

Bold pseudo-class identifier.

Returns
Pseudo-class string, default is "b"
Note
Used for bold markup in WebVTT style parsing

◆ pseudoClassItalic

- (NSString*) pseudoClassItalic
readnonatomicassign

Italic pseudo-class identifier.

Returns
Pseudo-class string, default is "i"
Note
Used for italic markup in WebVTT style parsing

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