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

VTT subtitle content attribute class that encapsulates style and display properties of subtitle text. More...

#include "AliVttSubtitleView.h"

Inheritance diagram for VttContentAttribute:

Properties

NSString * fontName
 字体名称,如 "Arial", "Helvetica" 等 Font name, such as "Arial", "Helvetica", etc.
 
double fontSizePx
 字体大小,单位为像素(px) Font size in pixels (px)
 
int mBackColour
 文本背景颜色,ARGB格式 Text background color in ARGB format
 
BOOL mBold
 是否应用粗体样式 Whether to apply bold style
 
int mBorderStyle
 边框样式类型(保留属性,用于未来扩展) Border style type (reserved property for future extension)
 
BOOL mItalic
 是否应用斜体样式 Whether to apply italic style
 
NSString * moniFontName
 备用字体名称,当主字体不可用时使用 Fallback font name when the main font is unavailable
 
int mOutlineColour
 文本描边颜色,ARGB格式 Text outline color in ARGB format
 
int mOutlineWidthPx
 文本描边宽度,单位为像素(px) Text outline width in pixels (px)
 
int mPrimaryColour
 主要文本颜色,ARGB格式的32位整数 (如 0xFFFFFFFF 表示白色) Primary text color, 32-bit integer in ARGB format (e.g., 0xFFFFFFFF for white)
 
int mSecondaryColour
 辅助颜色,较少使用,保留用于特殊效果 Secondary color, rarely used, reserved for special effects
 
int mShadowColor
 文本阴影颜色,ARGB格式 Text shadow color in ARGB format
 
int mShadowWidthPx
 文本阴影宽度,单位为像素(px) Text shadow width in pixels (px)
 
BOOL mStrikeOut
 是否显示删除线(中划线) Whether to show strikethrough (line-through)
 
BOOL mUnderline
 是否显示下划线 Whether to show underline
 
int styleFlags
 样式标志位,用于标识哪些样式属性已被设置(位掩码) Style flags to identify which style attributes have been set (bitmask)
 
NSMutableArray< NSString * > * styleIds
 应用于该文本的样式ID数组,对应WebVTT中的CSS样式类 Array of style IDs applied to this text, corresponding to CSS style classes in WebVTT
 
NSString * text
 字幕显示的文本内容 Text content for subtitle display
 

Detailed Description

VTT subtitle content attribute class that encapsulates style and display properties of subtitle text.

This class contains all style information for subtitle text, including font, color, size, decoration effects, etc. Supports various style attributes of the WebVTT standard.

Property Documentation

◆ fontName

- (NSString*) fontName
readwritenonatomiccopy

字体名称,如 "Arial", "Helvetica" 等 Font name, such as "Arial", "Helvetica", etc.

◆ fontSizePx

- (double) fontSizePx
readwritenonatomicassign

字体大小,单位为像素(px) Font size in pixels (px)

◆ mBackColour

- (int) mBackColour
readwritenonatomicassign

文本背景颜色,ARGB格式 Text background color in ARGB format

◆ mBold

- (BOOL) mBold
readwritenonatomicassign

是否应用粗体样式 Whether to apply bold style

◆ mBorderStyle

- (int) mBorderStyle
readwritenonatomicassign

边框样式类型(保留属性,用于未来扩展) Border style type (reserved property for future extension)

◆ mItalic

- (BOOL) mItalic
readwritenonatomicassign

是否应用斜体样式 Whether to apply italic style

◆ moniFontName

- (NSString*) moniFontName
readwritenonatomiccopy

备用字体名称,当主字体不可用时使用 Fallback font name when the main font is unavailable

◆ mOutlineColour

- (int) mOutlineColour
readwritenonatomicassign

文本描边颜色,ARGB格式 Text outline color in ARGB format

◆ mOutlineWidthPx

- (int) mOutlineWidthPx
readwritenonatomicassign

文本描边宽度,单位为像素(px) Text outline width in pixels (px)

◆ mPrimaryColour

- (int) mPrimaryColour
readwritenonatomicassign

主要文本颜色,ARGB格式的32位整数 (如 0xFFFFFFFF 表示白色) Primary text color, 32-bit integer in ARGB format (e.g., 0xFFFFFFFF for white)

◆ mSecondaryColour

- (int) mSecondaryColour
readwritenonatomicassign

辅助颜色,较少使用,保留用于特殊效果 Secondary color, rarely used, reserved for special effects

◆ mShadowColor

- (int) mShadowColor
readwritenonatomicassign

文本阴影颜色,ARGB格式 Text shadow color in ARGB format

◆ mShadowWidthPx

- (int) mShadowWidthPx
readwritenonatomicassign

文本阴影宽度,单位为像素(px) Text shadow width in pixels (px)

◆ mStrikeOut

- (BOOL) mStrikeOut
readwritenonatomicassign

是否显示删除线(中划线) Whether to show strikethrough (line-through)

◆ mUnderline

- (BOOL) mUnderline
readwritenonatomicassign

是否显示下划线 Whether to show underline

◆ styleFlags

- (int) styleFlags
readwritenonatomicassign

样式标志位,用于标识哪些样式属性已被设置(位掩码) Style flags to identify which style attributes have been set (bitmask)

◆ styleIds

- (NSMutableArray<NSString *>*) styleIds
readwritenonatomicstrong

应用于该文本的样式ID数组,对应WebVTT中的CSS样式类 Array of style IDs applied to this text, corresponding to CSS style classes in WebVTT

◆ text

- (NSString*) text
readwritenonatomiccopy

字幕显示的文本内容 Text content for subtitle display


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