#import <NvsCaption.h>

Inheritance diagram for NvsCaption:

Instance Methods
(bool)	- applyCaptionStyle:
	Apply the caption style. More...

(bool)	- applyModularCaptionContext:
	Applys modular caption context style. More...

(bool)	- applyModularCaptionRenderer:
	Applys modular caption render style. More...

(bool)	- applyModularCaptionAnimation:
	Applys modular caption loop-animation style. More...

(bool)	- applyModularCaptionInAnimation:
	Applys modular caption in-animation style. Notes：please set loop-Animation to null before you set in-animation, otherwise it will NOT works. More...

(bool)	- applyModularCaptionOutAnimation:
	Applys modular caption out-animation style.Notes：please set loop-Animation to null before you set out-animation, otherwise it will NOT works. More...

(void)	- setModularCaptionAnimationPeroid:
	Set modular caption Animation Peroid. More...

(int)	- getModularCaptionAnimationPeroid
	Get modular caption Animation Peroid. More...

(void)	- setModularCaptionInAnimationDuration:
	Set modular caption in-animation duration. More...

(int)	- getModularCaptionInAnimationDuration
	Get modular caption in-animation duration. More...

(void)	- setModularCaptionOutAnimationDuration:
	Set modular caption out-animation duration. More...

(int)	- getModularCaptionOutAnimationDuration
	Get modular caption out-animation duration. More...

(bool)	- applyCaptionStyleWithAssetDefaultParam:isUseDefaultAssetParam:
	apply the caption style. More...

(void)	- setText:
	Set the caption text. More...

(NSString *)	- getText
	Gets the caption text. More...

(void)	- setVerticalLayout:
	Sets whether the caption is vertical layout. More...

(BOOL)	- getVerticalLayout
	Gets the state whether the caption is vertical layout. More...

(void)	- setTextAlignment:
	Sets the caption horizontal alignment method. More...

(NvsTextAlignment)	- getTextAlignment
	Gets the caption horizontal alignment method. More...

(void)	- setTextVerticalAlignment:
	Sets the caption vertical alignment method, valid for frame-caption only. More...

(NvsTextAlignment)	- getTextVerticalAlignment
	Gets the caption vertical alignment method, valid for frame-caption only. More...

(void)	- setBold:
	Sets whether the caption font is bold. More...

(BOOL)	- getBold
	Gets the state whether the caption font is bold. More...

(void)	- setWeight:
	Sets caption weight. More...

(int)	- getWeight
	Gets the caption weight. More...

(void)	- setItalic:
	Sets whether the caption font is italic. More...

(BOOL)	- getItalic
	Gets the state whether the caption font is italic. More...

(void)	- setUnderline:
	Sets caption under line. More...

(BOOL)	- getUnderline
	Gets the caption under line. More...

(float)	- getLetterSpacing
	Gets caption word spacing. More...

(void)	- setLetterSpacing:
	Sets caption word spacing. More...

(NvsLetterSpacingType)	- getLetterSpacingType
	Gets caption word spacing type. More...

(void)	- setLetterSpacingType:
	Sets caption word spacing type. More...

(float)	- getLineSpacing
	Gets caption line spacing. More...

(void)	- setLineSpacing:
	Sets caption line spacing. More...

(void)	- setTextColor:
	Sets the color of the caption text. More...

(void)	- resetTextColorState
	Resets the color state of the caption text. More...

(NvsColor)	- getTextColor
	Gets the current color value of the caption font. More...

(void)	- setDrawOutline:
	Sets whether the caption draws the outline. More...

(BOOL)	- getDrawOutline
	Gets the status whether the caption draws the outline. More...

(void)	- setOutlineColor:
	Sets the color of the outline for the caption. More...

(NvsColor)	- getOutlineColor
	Gets the color of the outline for the caption. More...

(void)	- resetOutlineColorState
	Resets the outlinecolor state of the caption text. More...

(void)	- setOutlineWidth:
	Sets the width of the outline for the caption. More...

(float)	- getOutlineWidth
	Gets the width of the outline for the caption. More...

(void)	- setDrawShadow:
	Sets the caption shadows. More...

(BOOL)	- getDrawShadow
	Gets the state of the current caption shadow. More...

(void)	- setShadowColor:
	Sets the color of the caption shadow. More...

(NvsColor)	- getShadowColor
	Gets the color of the caption shadow. More...

(void)	- setShadowOffset:
	Sets the offset of the caption shadow. More...

(CGPoint)	- getShadowOffset
	Gets the offset of the caption shadow. More...

(void)	- setShadowFeather:
	Sets the feathering degree of the caption shadow. More...

(float)	- getShadowFeather
	Gets the feathering degree of the caption shadow. More...

(void)	- setFontSize:
	Sets the font size of the caption. More...

(float)	- getFontSize
	Gets the font size of the caption. More...

(void)	- setFrameCaptionMaxFontSize:
	Sets the max font size of the frame caption. only apply to frame caption. More...

(void)	- setFontWithFilePath:
	Sets the caption font. More...

(NSString *)	- getFontFilePath
	Gets the file path of the caption font. More...

(NSString *)	- getFontFamily
	Gets the caption font. More...

(void)	- setFontFamily:
	Sets the caption font. More...

(void)	- setCaptionTranslation:
	Sets the translation amount of the caption. More...

(CGPoint)	- getCaptionTranslation
	Gets the translation amount of the caption. More...

(void)	- translateCaption:
	translates the caption. More...

(void)	- setAnchorPoint:
	Sets the caption anchor. More...

(CGPoint)	- getAnchorPoint
	Gets the caption anchor. More...

(void)	- setScaleX:
	Sets the horizontal scaling factor for the caption. More...

(float)	- getScaleX
	Gets the horizontal scaling factor for the caption. More...

(void)	- setScaleY:
	Sets the vertical scaling factor for the caption. More...

(float)	- getScaleY
	Gets the vertical scaling factor for the caption. More...

(void)	- scaleCaption:anchor:
	Scales the caption. More...

(void)	- setRotationZ:
	Sets the rotation angle for the caption. More...

(float)	- getRotationZ
	Gets the rotation angle for the caption. More...

(void)	- rotateCaption:anchor:
	Rotates the caption. More...

(void)	- rotateCaption:
	Rotates the caption with the caption center point as the anchor point. More...

(void)	- setTextFrameOriginRect:
	Set the original frame size of the frame caption. If the current caption is not a frame caption, this function has no effect. You can get origin frame size. More...

(NvsRect)	- getTextBoundingRect
	Gets the rectangle of the caption text. More...

(NSArray *)	- getBoundingRectangleVertices
	Gets the vertex position of the original enclosing rectangle of the caption after transformation. More...

(NSArray *)	- getCaptionBoundingVertices:
	Gets the transformed vertices position of the original caption bounding. More...

(void)	- setCenterPolarAngle:
	Sets the polar angle of the center point for the caption. It's only valid for the panorama caption. More...

(float)	- getCenterPolarAngle
	Gets the polar angle of the center point for the caption. It's only valid for the panorama caption. More...

(float)	- getTextCenterPolarAngle
	Gets the polar angle of the center point for the caption text. It's only valid for the panorama caption. More...

(void)	- setCenterAzimuthAngle:
	Sets the azimuth angle of the center point for the caption. It's only valid for the panorama caption. More...

(float)	- getCenterAzimuthAngle
	Gets the azimuth angle of the center point for the caption. It's only valid for the panorama caption. More...

(float)	- getTextCenterAzimuthAngle
	Gets the azimuth angle of the center point for the caption text. It's only valid for the panorama caption. More...

(void)	- setPolarAngleRange:
	Sets the ranging angle of the polar angle for the caption. It's only valid for the panorama caption. More...

(float)	- getPolarAngleRange
	Gets the ranging angle of the polar angle for the caption. It's only valid for the panorama caption. More...

(float)	- getTextPolarAngleRange
	Gets the ranging angle of the polar angle for the caption text. It's only valid for the panorama caption. More...

(float)	- getOrthoAngleRange
	Gets the ranging angle which is perpendicular with the polar angle for the caption. It's only valid for the panorama caption. More...

(float)	- getTextOrthoAngleRange
	Gets the ranging angle of which is perpendicular with the polar angle for the caption text. It's only valid for the panorama caption. More...

(void)	- setPanoramicScaleX:
	Sets the horizontal scaling factor for the caption. It's only valid for the panorama caption. More...

(float)	- getPanoramicScaleX
	Gets the horizontal scaling factor for the caption. It's only valid for the panorama caption. More...

(void)	- setPanoramicScaleY:
	Sets the vertical scaling factor for the caption. It's only valid for the panorama caption. More...

(float)	- getPanoramicScaleY
	Gets the vertical scaling factor for the caption. It's only valid for the panorama caption. More...

(void)	- setPanoramicRotation:
	Sets the rotation angle for the caption. It's only valid for the panorama caption. More...

(float)	- getPanoramicRotation
	Gets the rotation angle for the caption. It's only valid for the panorama caption. More...

(void)	- setZValue:
	Sets the Z value of the caption. More...

(float)	- getZValue
	Gets the Z value of the caption. More...

(void)	- setRecordingUserOperation:
	Sets whether to record user actions. More...

(void)	- setOpacity:
	Set the caption opacity. More...

(float)	- getOpacity
	Get the caption opacity. More...

(void)	- setBackgroundColor:
	Set text background color. More...

(NvsColor)	- getBackgroundColor
	Get the current text background color value. More...

(void)	- setBackgroundRadius:
	Set text background rectangle's corner radius. More...

(float)	- getBackgroundRadius
	Get the current text background rectangle's corner radius value. More...

(void)	- setBoundaryPaddingRatio:
	Sets the caption boundary padding ratio. More...

(float)	- getBoundaryPaddingRatio
	Gets the caption boundary padding ratio. More...

(void)	- setSecondaryColor:
	Sets caption secondary color. it is only used in karaoke subtitles now. More...

(NvsColor)	- getSecondaryColor
	Gets the current color value of the caption. More...

(void)	- setSecondaryOutlineColor:
	Sets caption secondary outline color. it is only used in karaoke subtitles now. More...

(NvsColor)	- getSecondaryOutlineColor
	Gets the current outline sencondary color value of the caption. More...

(void)	- setCurrentKeyFrameTime:
	Set the caption KeyFrameTime. More...

(bool)	- setControlPoint:controlPointPair:
	Set the caption's control point pair. More...

(NvsControlPointPair *)	- getControlPoint:
	Get the caption's key frame control point pair. More...

(BOOL)	- isFrameCaption
	Gets whether the caption is a frame caption. More...

(void)	- setTextSpanList:

(NSArray< NvsCaptionSpan * > *)	- getTextSpanList

(NvsCaptionTextLayout *)	- getTextLayout

(int)	- getComplexRenderLayerCount
	Gets the number of complex caption layers. More...

(BOOL)	- hasOutlineLayerInComplexRender:
	Determine if the current layer has outline. More...

(NvsColor)	- getComplexRenderLayerOutlineColor:
	Gets the outline color value for a layer of complex caption. More...

(BOOL)	- setComplexRenderLayerOutlineColor:color:
	Set the outline color value for a layer of complex caption. More...

(float)	- getComplexRenderLayerOutlineWidth:
	Gets the outline width of a layer of complex caption. More...

(BOOL)	- setComplexRenderLayerOutlineWidth:width:
	set the outline width of a layer of complex caption More...

(float)	- getComplexRenderLayerOpacity:
	Gets the opacity of a certain layer of complex caption. More...

(BOOL)	- setComplexRenderLayerOpacity:opacity:
	set the opacity of a certain layer of complex caption. More...

Instance Methods inherited from NvsFx
(void)	- setIntVal:val:
	Set the integer parameter of NvsFx. More...

(int)	- getIntVal:
	Get the integer parameter of NvsFx. More...

(void)	- setIntValAtTime:val:time:
	Set the NvsFx's integer parameter at a specified time point. More...

(int)	- getIntValAtTime:time:
	Get the NvsFx's integer parameter at a specified time point. More...

(void)	- setFloatVal:val:
	Set the float parameter of NvsFx. More...

(double)	- getFloatVal:
	Get the float parameter of NvsFx. More...

(void)	- setFloatValAtTime:val:time:
	Set the NvsFx's float parameter at a specified time point. More...

(double)	- getFloatValAtTime:time:
	Get the NvsFx's float parameter at a specified time point. More...

(void)	- setBooleanVal:val:
	Set the BOOL parameter of NvsFx. More...

(BOOL)	- getBooleanVal:
	Get the BOOL parameter of NvsFx. More...

(void)	- setBooleanValAtTime:val:time:
	Set the NvsFx’s BOOL parameter at a specified time point. More...

(BOOL)	- getBooleanValAtTime:time:
	Get the NvsFx's BOOL parameter at a specified time point. More...

(void)	- setStringVal:val:
	Set the string parameter of NvsFx. More...

(NSString *)	- getStringVal:
	Get the string parameter of NvsFx. More...

(void)	- setStringValAtTime:val:time:
	Set the NvsFx's string parameter at a specified time point. More...

(NSString *)	- getStringValAtTime:time:
	Get the NvsFx's string parameter at a specified time point. More...

(void)	- setColorVal:val:
	Set the color parameter of NvsFx. More...

(NvsColor)	- getColorVal:
	Get the color parameter of NvsFx. More...

(void)	- setColorValAtTime:val:time:
	Set the NvsFx's color parameter at a specified time point. More...

(NvsColor)	- getColorValAtTime:time:
	Get the NvsFx's color parameter at a specified time point. More...

(void)	- setPosition2DVal:val:
	Set the two dimentional coordinates parameter of NvsFx. More...

(NvsPosition2D)	- getPosition2DVal:
	Get the two dimentional coordinates parameter of NvsFx. More...

(void)	- setPosition2DValAtTime:val:time:
	Set the NvsFx's two dimentional coordinates parameter at a specified time point. More...

(NvsPosition2D)	- getPosition2DValAtTime:time:
	Get the NvsFx's two dimentional coordinates parameter at a specified time point. More...

(void)	- setPosition3DVal:val:
	Set the three dimentional coordinates parameter of NvsFx. More...

(NvsPosition3D)	- getPosition3DVal:
	Get the three dimentional coordinates parameter of NvsFx. More...

(void)	- setPosition3DValAtTime:val:time:
	Set the NvsFx's three dimentional coordinates parameter at a specified time point. More...

(NvsPosition3D)	- getPosition3DValAtTime:time:
	Get the NvsFx's three dimentional coordinates parameter at a specified time point. More...

(void)	- setMenuVal:val:
	Set the menu parameter of NvsFx. More...

(NSString *)	- getMenuVal:
	Get the menu parameter of NvsFx. More...

(void)	- setMenuValAtTime:val:time:
	Set the NvsFx's menu parameter at a specified time point. More...

(NSString *)	- getMenuValAtTime:time:
	Get the NvsFx menu parameter at a specified time point. More...

(void)	- setArbDataVal:val:
	Set custom data parameter value. More...

(NvsArbitraryData *)	- getArbDataVal:
	Get custom data parameter value. More...

(void)	- setArbDataValAtTime:val:time:
	Sets custom data parameter value. More...

(NvsArbitraryData *)	- getArbDataValAtTime:time:
	Get custom data parameter value at a specified time point. More...

(bool)	- removeKeyframeAtTime:time:
	Remove key frame at a specified time point from key frame list. More...

(bool)	- removeAllKeyframe:
	Remove all key frames from key frame list. More...

(bool)	- hasKeyframeList:
	Check whether the parameter has key frame list or not. More...

(int64_t)	- findKeyframeTime:time:flags:
	Get key frame at a specified time point. More...

(bool)	- setKeyFrameControlPoint:time:controlPointPair:
	Set key frame control point pair. More...

(NvsControlPointPair *)	- getKeyFrameControlPoint:time:
	Get key frame control point pair. More...

(bool)	- setKeyFrameControlPointMode:time:controlPointModePair:
	Set key frame control point mode pair. More...

(NvsControlPointModePair *)	- getKeyFrameControlPointMode:time:
	Get key frame control point mode pair. More...

(void)	- setFilterIntensity:
	Set the intensity of the filter. More...

(float)	- getFilterIntensity
	Get the intensity of the filter. More...

(void)	- setFilterMask:
	Set the mask of the filter. More...

(bool)	- getFilterMask
	Get the usage of the filter's mask. More...

(void)	- setRegional:
	Set whether the filter is regional. More...

(BOOL)	- getRegional
	Get whether the filter is regional. More...

(void)	- setIgnoreBackground:
	Set whether the regional filter ignores background. More...

(BOOL)	- getIgnoreBackground
	Get whether the regional filter ignores background. More...

(void)	- setInverseRegion:
	Set whether the regional filter inverses region. More...

(BOOL)	- getInverseRegion
	Get whether the regional filter inverses region. More...

(NSArray *)	- getRegion
	Get the region of this regional filter. More...

(void)	- setRegion:
	Set the region of this regional filter. More...

(NvsMaskRegionInfo *)	- getRegionInfo
	Get the mask region informations of the regional filter. More...

(void)	- setRegionInfo:
	Set the mask region informations of the regional filter. More...

(void)	- setRegionInfoAtTime:time:
	Set the regional filter's mask region informations at a specified time point. More...

(NvsMaskRegionInfo *)	- getRegionInfoAtTime:
	Get the the regional filter's mask region informations at a specified time. More...

(void)	- setRegionalFeatherWidth:
	Set the feather width of the regional filter. More...

(float)	- getRegionalFeatherWidth
	Get the feather width of the regional filter. More...

(void)	- setRegionalFeatherWidthAtTime:time:
	Set the regional filter's feather width at a specified time point. More...

(float)	- getRegionalFeatherWidthAtTime:
	Get the regional filter's feather width at a specified time point. More...

(void)	- setRegionCoordinateSystemType:
	Set the coordinate system of the region. More...

(int)	- getRegionCoordinateSystemType
	Get the coordinate system of the region. More...

(NvsParticleSystemContext *)	- getParticleSystemContext
	Get the particle effect context pointer.Please refer to NvsParticleSystemContext. More...

(NvsARFaceContext *)	- getARFaceContext
	Get face effect context pointer.Please refer to NvsARFaceContext. More...

(NvsPaintingEffectContext *)	- getPaintingEffectContext
	Get the particle effect context pointer.Please refer to NvsPaintingEffectContext. More...

(NvsARSceneManipulate *)	- getARSceneManipulate
	Get the AR scene operation pointer.Please refer to NvsARSceneManipulate. More...

(void)	- setExprVar:varValue:
	Set the value of the defined parameter in the expression. More...

(double)	- getExprVar:
	Get the value of the defined parameter in the expression. More...

(void)	- setColorExprVar:varValue:
	Set the color value of the defined parameter in the expression. More...

(NvsColor)	- getColorExprVar:
	Get the color value of the defined parameter in the expression. More...

(void)	- clearExprVar:
	Clear the value of the defined parameter in the expression and set it to the default value of 0. More...

(void)	- clearExprVarCtx
	Clear all parameter values defined in the expression and set them to the default value of 0. More...

Instance Methods inherited from NvsObject
(void)	- setAttachment:forKey:
	Adds an attachment to the NvsObject object to identify the object of the NvsObject or for other purposes. More...

(void)	- setTemplateAttachment:forKey:
	Adds additional template data to the NvsObject object to identify the NvsObject template object. More...

(NSObject *)	- getAttachment:
	Gets attached attachments. More...

(NSString *)	- getTemplateAttachment:
	Gets an template attachment to NvsObject. More...

Properties
BOOL	isPanoramic
	Whether it is a panorama caption. More...

BOOL	isModular
	whether the current caption is a modular caption More...

NvsRoleInTheme	roleInTheme
	The role of captions in the theme (general, title, and trailer.) More...

NvsCategory	category
	Clip type. More...

NSString *	captionStylePackageId
	The package ID of the caption style. More...

NSString *	modularCaptionContextPackageId
	The package ID of the modular caption context style. More...

NSString *	modularCaptionRendererPackageId
	The package ID of the modular caption render style. More...

NSString *	modularCaptionAnimationPackageId
	The package ID of the modular caption animation style. More...

NSString *	modularCaptionInAnimationPackageId
	The package ID of the modular caption in-animation style. More...

NSString *	modularCaptionOutAnimationPackageId
	The package ID of the modular caption out-animation style. More...

Properties inherited from NvsFx
NvsFxDescription *	description
	Special effect description. More...

Detailed Description

captions.

captions are custom text that is superimposed on the video. When editing a video, users can add and remove timeline captions and adjust the captions position. After adding captions, user can also set the style, including font size, color, shadow, stroke, etc.

Warning: In the NvsCaption class, all public APIs are used in the UI thread! ! !

Method Documentation

◆ applyCaptionStyle:

- (bool) applyCaptionStyle: (NSString *) captionStylePackageId

Apply the caption style.

Parameters

captionStylePackageId The resource package ID of the caption style

Returns: Returns bool value. True means it use caption style successfully, and false means it fails.

Warning: This interface will cause the streaming engine state to jump to the state of stopping engine. For details, please refer to The Topic of Changing Engine.

◆ applyCaptionStyleWithAssetDefaultParam:isUseDefaultAssetParam:

- (bool) applyCaptionStyleWithAssetDefaultParam:	(NSString *)	captionStylePackageId
isUseDefaultAssetParam:	(NvsAssetDefaultParam)	isUseDefaultAssetParam

apply the caption style.

Parameters

captionStylePackageId	The resource package ID of the caption style
isUseDefaultAssetParam	Whether to use the default material parameters.

Returns: Returns bool value. True means it use caption style successfully, and false means it fails.

Warning: This interface will cause the streaming engine state to jump to the state of stopping engine. For details, please refer to The Topic of Changing Engine.

◆ applyModularCaptionAnimation:

- (bool) applyModularCaptionAnimation: (NSString *) captionAnimationPackageId

Applys modular caption loop-animation style.

Parameters

captionAnimationPackageId Modular caption loop-animation style resource package ID.

Returns: Returns boolean value. True means a successful application, false means a failure.

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

See also: getModularCaptionAnimationPackageId

Since: 2.15.2

◆ applyModularCaptionContext:

- (bool) applyModularCaptionContext: (NSString *) captionContextPackageId

Applys modular caption context style.

Parameters

captionContextPackageId Modular caption context style resource package ID.

Returns: Returns boolean value. True means a successful application, false means a failure.

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

See also: getModularCaptionContextPackageId

Since: 2.15.2

◆ applyModularCaptionInAnimation:

- (bool) applyModularCaptionInAnimation: (NSString *) captionInAnimationPackageId

Applys modular caption in-animation style. Notes：please set loop-Animation to null before you set in-animation, otherwise it will NOT works.

Parameters

captionInAnimationPackageId Modular caption in-animation style resource package ID.

Returns: Returns boolean value. True means a successful application, false means a failure.

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

See also: getModularCaptionInAnimationPackageId

Since: 2.15.2

◆ applyModularCaptionOutAnimation:

- (bool) applyModularCaptionOutAnimation: (NSString *) captionOutAnimationPackageId

Applys modular caption out-animation style.Notes：please set loop-Animation to null before you set out-animation, otherwise it will NOT works.

Parameters

captionOutAnimationPackageId Modular caption out-animation style resource package ID.

Returns: Returns boolean value. True means a successful application, false means a failure.

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

See also: getModularCaptionOutAnimationPackageId

Since: 2.15.2

◆ applyModularCaptionRenderer:

- (bool) applyModularCaptionRenderer: (NSString *) captionRendererPackageId

Applys modular caption render style.

Parameters

captionRendererPackageId Modular caption render style resource package ID.

Returns: Returns boolean value. True means a successful application, false means a failure.

Warning: This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to Engine Change.

See also: getModularCaptionRenderPackageId

Since: 2.15.2

◆ getAnchorPoint

- (CGPoint) getAnchorPoint

Gets the caption anchor.

Returns: Returns the caption anchor.

Since: 1.15.0

See also: - setAnchorPoint:

◆ getBackgroundColor

- (NvsColor) getBackgroundColor

Get the current text background color value.

Returns: Returns the NvsColor object representing the current background color.

See also: - setBackgroundColor:

Since: 2.15.1

◆ getBackgroundRadius

- (float) getBackgroundRadius

Get the current text background rectangle's corner radius value.

Returns: Returns corner radius value

See also: - setBackgroundRadius:

Since: 2.15.1

◆ getBold

- (BOOL) getBold

Gets the state whether the caption font is bold.

Returns: Returns the state whether the caption font is bold. YES means it is bold, NO means it is not.

See also: - setBold:

◆ getBoundaryPaddingRatio

- (float) getBoundaryPaddingRatio

Gets the caption boundary padding ratio.

Returns: Returns padding ratio.

See also: setBoundaryPaddingRatio

◆ getBoundingRectangleVertices

- (NSArray *) getBoundingRectangleVertices

Gets the vertex position of the original enclosing rectangle of the caption after transformation.

Returns: Returns the NSArray object, the object type is NSValue, and the actual data type is CGPoint, which contains four vertex positions corresponding to the upper left, lower left, lower right, and upper right vertex of the original enclosing rectangle.

Since: 1.8.1

◆ getCaptionBoundingVertices:

- (NSArray *) getCaptionBoundingVertices: (NvsBoundingType) boundingType

Gets the transformed vertices position of the original caption bounding.

Parameters

boundingType Bounding type. Please refer to Bounding Type

Returns: Returns the NSArray object, the object type is NSValue, and the actual data type is CGPoint, which correspond to the top left, bottom left, bottom right, and top right vertices of the original bounding.

Since: 2.9.0

◆ getCaptionTranslation

- (CGPoint) getCaptionTranslation

Gets the translation amount of the caption.

Returns: Returns the CGPoint object indicating the translation amount of the caption which obtained.

See also: - setCaptionTranslation:

◆ getCenterAzimuthAngle

- (float) getCenterAzimuthAngle

Gets the azimuth angle of the center point for the caption. It's only valid for the panorama caption.

Returns: Returns the azimuth angle of the center point (in degrees).
Note: Panorama is not enabled by default after 3.13.0

Since: 1.6.0

◆ getCenterPolarAngle

- (float) getCenterPolarAngle

Gets the polar angle of the center point for the caption. It's only valid for the panorama caption.

Returns: Returns the polar angle of the center point (in degrees).
Note: Panorama is not enabled by default after 3.13.0

Since: 1.6.0

◆ getComplexRenderLayerCount

- (int) getComplexRenderLayerCount

Gets the number of complex caption layers.

Returns: the number of caption layers.

◆ getComplexRenderLayerOpacity:

- (float) getComplexRenderLayerOpacity: (int) layerIndex

Gets the opacity of a certain layer of complex caption.

Parameters

layerIndex layer index

Returns: opacity

◆ getComplexRenderLayerOutlineColor:

- (NvsColor) getComplexRenderLayerOutlineColor: (int) layerIndex

Gets the outline color value for a layer of complex caption.

Parameters

layerIndex layer index

Returns: outline color

◆ getComplexRenderLayerOutlineWidth:

- (float) getComplexRenderLayerOutlineWidth: (int) layerIndex

Gets the outline width of a layer of complex caption.

Parameters

layerIndex layer index

Returns: outline width

◆ getControlPoint:

- (NvsControlPointPair*) getControlPoint: (NSString *) fxParam

Get the caption's key frame control point pair.

Parameters

fxParam The type of data parameter for the caption.

Returns: return control point data.If the control point is {0, 0},the current control point interpolation method is linear interpolation.NvsControlPointPair对象

See also: setControlPoint: controlPointPair

Since: 2.22.0

◆ getDrawOutline

- (BOOL) getDrawOutline

Gets the status whether the caption draws the outline.

Returns: Returns boolean value. YES means it has drawed the outline. NO means it has not.

See also: - setDrawOutline:

◆ getDrawShadow

- (BOOL) getDrawShadow

Gets the state of the current caption shadow.

Returns: Returns BOOL value. YES means the caption has shadow. NO means it is not.

See also: - setDrawShadow:

◆ getFontFamily

- (NSString *) getFontFamily

Gets the caption font.

Since: 2.13.3

See also: setFontFamily

◆ getFontFilePath

- (NSString *) getFontFilePath

Gets the file path of the caption font.

Returns: Returns the file path of the caption font.

Since: 1.3.0

See also: - setFontWithFilePath:

◆ getFontSize

- (float) getFontSize

Gets the font size of the caption.

Returns: Returns the font size of the caption.

See also: - setFontSize:

◆ getItalic

- (BOOL) getItalic

Gets the state whether the caption font is italic.

Returns: Returns boolean value. YES means the caption font is italic. NO means it is not.

See also: - setItalic:

◆ getLetterSpacing

- (float) getLetterSpacing

Gets caption word spacing.

Returns: Returns the float value, the percentage value by default.(LETTER_SPACING_TYPE)

See also: setLetterSpacing; setLetterSpacingType

Since: 1.16.0

◆ getLetterSpacingType

- (NvsLetterSpacingType) getLetterSpacingType

Gets caption word spacing type.

Returns: return letterSpacingType.(LETTER_SPACING_TYPE)

See also: setLetterSpacingType

Since: 2.15.1

◆ getLineSpacing

- (float) getLineSpacing

Gets caption line spacing.

Returns: return float value, line spacing is expressed in absolute value.

See also: setLineSpacing

Since: 2.15.1

◆ getModularCaptionAnimationPeroid

- (int) getModularCaptionAnimationPeroid

Get modular caption Animation Peroid.

Returns: Return animation peroid in million second

See also: setModularCaptionAnimationPeroid

Since: 2.15.2

◆ getModularCaptionInAnimationDuration

- (int) getModularCaptionInAnimationDuration

Get modular caption in-animation duration.

Returns: Return in-animation duration in million second

See also: setModularCaptionInAnimationDuration

Since: 2.15.2

◆ getModularCaptionOutAnimationDuration

- (int) getModularCaptionOutAnimationDuration

Get modular caption out-animation duration.

Returns: Return out-animation duration in million second

See also: setModularCaptionOutAnimationDuration

Since: 2.15.2

◆ getOpacity

- (float) getOpacity

Get the caption opacity.

Returns: Return the opacity.

See also: - setOpacity:

◆ getOrthoAngleRange

- (float) getOrthoAngleRange

Gets the ranging angle which is perpendicular with the polar angle for the caption. It's only valid for the panorama caption.

Returns: Returns the ranging angle which is perpendicular with the polar angle (in degrees).
Note: Panorama is not enabled by default after 3.13.0

Since: 1.7.0

◆ getOutlineColor

- (NvsColor) getOutlineColor

Gets the color of the outline for the caption.

Returns: Returns the NvsColor object representing the color of the outline for the caption.

See also: - setOutlineColor:

◆ getOutlineWidth

- (float) getOutlineWidth

Gets the width of the outline for the caption.

Returns: Returns the width of the outline for the caption.

See also: - setOutlineWidth:

◆ getPanoramicRotation

- (float) getPanoramicRotation

Gets the rotation angle for the caption. It's only valid for the panorama caption.

Returns: Returns the rotation angle of the caption.
Note: Panorama is not enabled by default after 3.13.0

Since: 1.7.1

◆ getPanoramicScaleX

- (float) getPanoramicScaleX

Gets the horizontal scaling factor for the caption. It's only valid for the panorama caption.

Returns: Returns the horizontal scaling factor.
Note: Panorama is not enabled by default after 3.13.0

Since: 1.6.0

◆ getPanoramicScaleY

- (float) getPanoramicScaleY

Gets the vertical scaling factor for the caption. It's only valid for the panorama caption.

Returns: Returns the vertical scaling factor.
Note: Panorama is not enabled by default after 3.13.0

Since: 1.6.0

◆ getPolarAngleRange

- (float) getPolarAngleRange

Gets the ranging angle of the polar angle for the caption. It's only valid for the panorama caption.

Returns: Returns the ranging angle of the polar angle (in degrees).
Note: Panorama is not enabled by default after 3.13.0

Since: 1.6.0

◆ getRotationZ

- (float) getRotationZ

Gets the rotation angle for the caption.

Returns: Returns the rotation angle for the caption.

Since: 1.14.1

See also: - setRotationZ:

◆ getScaleX

- (float) getScaleX

Gets the horizontal scaling factor for the caption.

Returns: Returns the horizontal scaling factor for the caption.

Since: 1.14.1

See also: - setScaleX:; - getScaleY

◆ getScaleY

- (float) getScaleY

Gets the vertical scaling factor for the caption.

Returns: Returns the vertical scaling factor for the caption.

Since: 1.14.1

See also: - setScaleY:; - getScaleX

◆ getSecondaryColor

- (NvsColor) getSecondaryColor

Gets the current color value of the caption.

Returns: Returns the NvsColor object representing the color value obtained.

See also: setSecondaryColor

Since: 2.19.0

◆ getSecondaryOutlineColor

- (NvsColor) getSecondaryOutlineColor

Gets the current outline sencondary color value of the caption.

Returns: Returns the NvsColor object representing the outline sencondary color value obtained.

See also: setSecondaryOutlineColor

Since: 3.1.0

◆ getShadowColor

- (NvsColor) getShadowColor

Gets the color of the caption shadow.

Returns: Returns the NvsColor object representing the caption shadow color which obtained.

See also: - setShadowColor:

◆ getShadowFeather

- (float) getShadowFeather

Gets the feathering degree of the caption shadow.

Returns: Returns feathering degree

See also: setShadowFeather

◆ getShadowOffset

- (CGPoint) getShadowOffset

Gets the offset of the caption shadow.

Returns: Returns CGPoint object representing the caption shadow offset which obtained.

See also: - setShadowOffset:

◆ getText

- (NSString *) getText

Gets the caption text.

Returns: Returns the obtained caption text.

See also: - setText:

◆ getTextAlignment

- (NvsTextAlignment) getTextAlignment

Gets the caption horizontal alignment method.

Returns: Returns the caption horizontal alignment method.

See also: - setTextAlignment:

◆ getTextBoundingRect

- (NvsRect) getTextBoundingRect

Gets the rectangle of the caption text.

Returns: Returns the NvsRect object representing the obtained rectangle.

◆ getTextCenterAzimuthAngle

- (float) getTextCenterAzimuthAngle

Gets the azimuth angle of the center point for the caption text. It's only valid for the panorama caption.

Returns: Returns the polar angle of the center point (in degrees).
Note: Panorama is not enabled by default after 3.13.0

Since: 2.5.1

◆ getTextCenterPolarAngle

- (float) getTextCenterPolarAngle

Gets the polar angle of the center point for the caption text. It's only valid for the panorama caption.

Returns: Returns the polar angle of the center point (in degrees) for the caption text.
Note: Panorama is not enabled by default after 3.13.0

Since: 2.5.1

◆ getTextColor

- (NvsColor) getTextColor

Gets the current color value of the caption font.

Returns: Returns the NvsColor object representing the obtained color value.

See also: - setTextColor:

◆ getTextLayout

- (NvsCaptionTextLayout *) getTextLayout

Parameters

◆ getTextOrthoAngleRange

- (float) getTextOrthoAngleRange

Gets the ranging angle of which is perpendicular with the polar angle for the caption text. It's only valid for the panorama caption.

Returns: Returns the ranging angle of which is perpendicular with the polar angle (in degrees).
Note: Panorama is not enabled by default after 3.13.0

Since: 2.5.1

◆ getTextPolarAngleRange

- (float) getTextPolarAngleRange

Gets the ranging angle of the polar angle for the caption text. It's only valid for the panorama caption.

Returns: Returns the ranging angle of the polar angle for the caption text (in degrees).
Note: Panorama is not enabled by default after 3.13.0

Since: 2.5.1

◆ getTextSpanList

- (NSArray<NvsCaptionSpan *>*) getTextSpanList

Parameters

◆ getTextVerticalAlignment

- (NvsTextAlignment) getTextVerticalAlignment

Gets the caption vertical alignment method, valid for frame-caption only.

Returns: Returns the caption vertical alignment method.

See also: - setTextVerticalAlignment:

Since: 2.19.1

◆ getUnderline

- (BOOL) getUnderline

Gets the caption under line.

Returns: Returns boolean value. True means it is under line, false means it is not.

See also: setUnderline

◆ getVerticalLayout

- (BOOL) getVerticalLayout

Gets the state whether the caption is vertical layout.

Returns: Returns the state whether the caption vertical layout. YES means it is vertical layout, NO means it is not.

See also: - setVerticalLayout:

◆ getWeight

- (int) getWeight

Gets the caption weight.

Returns: Returns the caption weight.

See also: setWeight

◆ getZValue

- (float) getZValue

Gets the Z value of the caption.

Returns: Returns the Z value of the caption.

See also: - setZValue:

◆ hasOutlineLayerInComplexRender:

- (BOOL) hasOutlineLayerInComplexRender: (int) layerIndex

Determine if the current layer has outline.

Parameters

layerIndex layer index

Returns: outline state

◆ isFrameCaption

- (BOOL) isFrameCaption

Gets whether the caption is a frame caption.

Returns: Gets whether the caption is a frame caption.

Since: 2.19.1

◆ resetOutlineColorState

- (void) resetOutlineColorState

Resets the outlinecolor state of the caption text.

See also: - getOutlineColor

◆ resetTextColorState

- (void) resetTextColorState

Resets the color state of the caption text.

See also: - getTextColor

◆ rotateCaption:

- (void) rotateCaption: (float) angle

Rotates the caption with the caption center point as the anchor point.

Parameters

angle The rotation angle of caption

Since: 1.8.1

See also: - rotateCaption:anchor:

◆ rotateCaption:anchor:

- (void) rotateCaption:	(float)	angle
anchor:	(CGPoint)	anchor

Rotates the caption.

Parameters

angle	The rotation angle of the caption
anchor	The rotation anchor of the caption

Since: 1.8.1

See also: - rotateCaption:

◆ scaleCaption:anchor:

- (void) scaleCaption:	(float)	scaleFactor
anchor:	(CGPoint)	anchor

Scales the caption.

Parameters

scaleFactor	The scaling factor for the caption
anchor	The anchor for Scaling the caption

Since: 1.8.1

◆ setAnchorPoint:

- (void) setAnchorPoint: (CGPoint) anchor

Sets the caption anchor.

Parameters

anchor Anchor

Since: 1.15.0

See also: - getAnchorPoint

◆ setBackgroundColor:

- (void) setBackgroundColor: (const NvsColor *) backgroundColor

Set text background color.

Parameters

backgroundColor Background color value.

See also: - getBackgroundColor:

Since: 2.15.1

◆ setBackgroundRadius:

- (void) setBackgroundRadius: (float) radius

Set text background rectangle's corner radius.

Parameters

radius Corner radius value

See also: - getBackgroundRadius:

Since: 2.15.1

◆ setBold:

- (void) setBold: (BOOL) bold

Sets whether the caption font is bold.

Parameters

bold	Indicates whether the caption font is bold.YES means it is bold, NO means it is not.

See also: - getBold

◆ setBoundaryPaddingRatio:

- (void) setBoundaryPaddingRatio: (float) ratio

Sets the caption boundary padding ratio.

Parameters

ratio The padding ratio is a multiple of the font size, default is 0.15

See also: - getBoundaryPaddingRatio

◆ setCaptionTranslation:

- (void) setCaptionTranslation: (CGPoint) translation

Sets the translation amount of the caption.

Parameters

translation The horizontal and vertical absolute translation of the caption.

See also: - getCaptionTranslation; - translateCaption:

◆ setCenterAzimuthAngle:

- (void) setCenterAzimuthAngle: (float) centerAzimuthAngle

Sets the azimuth angle of the center point for the caption. It's only valid for the panorama caption.

Parameters

centerAzimuthAngle the azimuth angle of the center point (in degrees)
Note: Panorama is not enabled by default after 3.13.0

Since: 1.6.0

◆ setCenterPolarAngle:

- (void) setCenterPolarAngle: (float) centerPolarAngle

Sets the polar angle of the center point for the caption. It's only valid for the panorama caption.

Parameters

centerPolarAngle The polar angle of the center point (in degrees).
Note: Panorama is not enabled by default after 3.13.0

Since: 1.6.0

◆ setComplexRenderLayerOpacity:opacity:

- (BOOL) setComplexRenderLayerOpacity:	(int)	layerIndex
opacity:	(float)	opacity

set the opacity of a certain layer of complex caption.

Parameters

layerIndex	layer index
opacity	opacity

Returns: success status

◆ setComplexRenderLayerOutlineColor:color:

- (BOOL) setComplexRenderLayerOutlineColor:	(int)	layerIndex
color:	(NvsColor)	color

Set the outline color value for a layer of complex caption.

Parameters

layerIndex	layer index
color	color

Returns: success status

◆ setComplexRenderLayerOutlineWidth:width:

- (BOOL) setComplexRenderLayerOutlineWidth:	(int)	layerIndex
width:	(float)	width

set the outline width of a layer of complex caption

Parameters

layerIndex	layer index
width	outline width

Returns: success status

◆ setControlPoint:controlPointPair:

- (bool) setControlPoint:	(NSString *)	fxParam
controlPointPair:	(NvsControlPointPair *)	controlPointPair

Set the caption's control point pair.

Parameters

fxParam	The type of data parameter for the caption.
controlPointPair	control point pair.Set the control point to {0, 0}, that is, the current control point is linear interpolation, otherwise it is curve interpolation.

See also: getControlPoint

Since: 2.22.0

◆ setCurrentKeyFrameTime:

- (void) setCurrentKeyFrameTime: (int64_t) time

Set the caption KeyFrameTime.

See also: setCurrentKeyFrameTime

Since: 2.19.1

◆ setDrawOutline:

- (void) setDrawOutline: (BOOL) drawOutline

Sets whether the caption draws the outline.

Parameters

drawOutline whether the caption draws the outline。YES means it draws the outline. NO means it does not.

See also: - getDrawOutline

◆ setDrawShadow:

- (void) setDrawShadow: (BOOL) drawShadow

Sets the caption shadows.

Parameters

drawShadow Whether to set the caption shadow. YES means to set the caption shadow. NO means not.

See also: - getDrawShadow

◆ setFontFamily:

- (void) setFontFamily: (NSString *) family

Sets the caption font.

Parameters

family The font family. if it's a null string, it's set as the default font.

Since: 2.4.2

See also: - getFontFamily

◆ setFontSize:

- (void) setFontSize: (float) fontSize

Sets the font size of the caption.

Parameters

fontSize the font size of the caption

See also: - getFontSize

◆ setFontWithFilePath:

- (void) setFontWithFilePath: (NSString *) filePath

Sets the caption font.

Parameters

filePath The file path of the caption font. If it's a null string,it's set as the default font.

Since: 1.3.0

See also: - getFontFilePath

◆ setFrameCaptionMaxFontSize:

- (void) setFrameCaptionMaxFontSize: (float) maxFontSize

Sets the max font size of the frame caption. only apply to frame caption.

Since: 2.19.1

◆ setItalic:

- (void) setItalic: (BOOL) italic

Sets whether the caption font is italic.

Parameters

italic Whether it is italic. YES means the caption font is italic, and NO means it is not.

See also: - getItalic

◆ setLetterSpacing:

- (void) setLetterSpacing: (float) letterSpacing

Sets caption word spacing.

Parameters

letterSpacing Word spacing is expressed in percentage value by default. (LETTER_SPACING_TYPE)

See also: - getLetterSpacing; setLetterSpacingType

Since: 1.16.0

◆ setLetterSpacingType:

- (void) setLetterSpacingType: (NvsLetterSpacingType) letterSpacingType

Sets caption word spacing type.

Parameters

letterSpacingType Word spacing type.(LETTER_SPACING_TYPE)

See also: - getLetterSpacingType

Since: 2.15.1

◆ setLineSpacing:

- (void) setLineSpacing: (float) lineSpacing

Sets caption line spacing.

Parameters

lineSpacing line spacing is expressed in absolute value.

See also: - getLineSpacing

Since: 2.15.1

◆ setModularCaptionAnimationPeroid:

- (void) setModularCaptionAnimationPeroid: (int) periodInMS

Set modular caption Animation Peroid.

Parameters

periodInMS Animation peroid in million second

See also: - getModularCaptionAnimationPeroid

Since: 2.15.2

◆ setModularCaptionInAnimationDuration:

- (void) setModularCaptionInAnimationDuration: (int) inAnimationDurationInMS

Set modular caption in-animation duration.

Parameters

inAnimationDurationInMS in-animation duration in million second

See also: - getModularCaptionInAnimationDuration

Since: 2.15.2

◆ setModularCaptionOutAnimationDuration:

- (void) setModularCaptionOutAnimationDuration: (int) outAnimationDurationInMS

Set modular caption out-animation duration.

Parameters

outAnimationDurationInMS out-animation duration in million second

See also: - getModularCaptionOutAnimationDuration

Since: 2.15.2

◆ setOpacity:

- (void) setOpacity: (float) opacity

Set the caption opacity.

Parameters

opacity The opacity of caption

See also: - getOpacity

◆ setOutlineColor:

- (void) setOutlineColor: (const NvsColor *) outlineColor

Sets the color of the outline for the caption.

Parameters

outlineColor the color of the outline

See also: - getOutlineColor

◆ setOutlineWidth:

- (void) setOutlineWidth: (float) outlineWidth

Sets the width of the outline for the caption.

Parameters

outlineWidth the width of the outline

See also: - getOutlineWidth

◆ setPanoramicRotation:

- (void) setPanoramicRotation: (float) rotationAngle

Sets the rotation angle for the caption. It's only valid for the panorama caption.

Parameters

rotationAngle The rotation angle
Note: Panorama is not enabled by default after 3.13.0

Since: 1.7.1

◆ setPanoramicScaleX:

- (void) setPanoramicScaleX: (float) scaleX

Sets the horizontal scaling factor for the caption. It's only valid for the panorama caption.

Parameters

scaleX The horizontal scaling factor
Note: Panorama is not enabled by default after 3.13.0

Since: 1.6.0

◆ setPanoramicScaleY:

- (void) setPanoramicScaleY: (float) scaleY

Sets the vertical scaling factor for the caption. It's only valid for the panorama caption.

Parameters

scaleY The vertical scaling factor
Note: Panorama is not enabled by default after 3.13.0

Since: 1.6.0

◆ setPolarAngleRange:

- (void) setPolarAngleRange: (float) polarAngleRange

Sets the ranging angle of the polar angle for the caption. It's only valid for the panorama caption.

Parameters

polarAngleRange the ranging angle of the polar angle (in degrees)
Note: Panorama is not enabled by default after 3.13.0

Since: 1.6.0

◆ setRecordingUserOperation:

- (void) setRecordingUserOperation: (BOOL) recordingUserOperation

Sets whether to record user actions.

Parameters

recordingUserOperation

Since: 2.11.0

◆ setRotationZ:

- (void) setRotationZ: (float) angle

Sets the rotation angle for the caption.

Parameters

angle The rotation angle

Since: 1.14.1

See also: - getRotationZ

◆ setScaleX:

- (void) setScaleX: (float) scale

Sets the horizontal scaling factor for the caption.

Parameters

scale The horizontal scaling factor

Since: 1.14.1

See also: - getScaleX; - setScaleY:

◆ setScaleY:

- (void) setScaleY: (float) scale

Sets the vertical scaling factor for the caption.

Parameters

scale the vertical scaling factor

Since: 1.14.1

See also: - getScaleY; - setScaleX:

◆ setSecondaryColor:

- (void) setSecondaryColor: (const NvsColor *) color

Sets caption secondary color. it is only used in karaoke subtitles now.

Parameters

textColor Caption color value.

See also: - getSecondaryColor

Since: 2.19.0

◆ setSecondaryOutlineColor:

- (void) setSecondaryOutlineColor: (const NvsColor *) color

Sets caption secondary outline color. it is only used in karaoke subtitles now.

Parameters

color Caption outline color value.

See also: - getSecondaryOutlineColor

Since: 3.1.0

◆ setShadowColor:

- (void) setShadowColor: (const NvsColor *) shadowColor

Sets the color of the caption shadow.

Parameters

shadowColor The color of the caption shadow

See also: - getShadowColor

◆ setShadowFeather:

- (void) setShadowFeather: (float) feather

Sets the feathering degree of the caption shadow.

Parameters

feather feathering degree

See also: - getShadowFeather

◆ setShadowOffset:

- (void) setShadowOffset: (CGPoint) shadowOffset

Sets the offset of the caption shadow.

Parameters

shadowOffset The offset of the caption shadow.

See also: - getShadowOffset

◆ setText:

- (void) setText: (NSString *) text

Set the caption text.

Parameters

text	The caption text

See also: - getText

◆ setTextAlignment:

- (void) setTextAlignment: (NvsTextAlignment) textAlign

Sets the caption horizontal alignment method.

Parameters

textAlign the caption horizontal alignment method

See also: - getTextAlignment; setTextVerticalAlignment

◆ setTextColor:

- (void) setTextColor: (const NvsColor *) textColor

Sets the color of the caption text.

Parameters

textColor the color of the caption text

See also: - getTextColor

◆ setTextFrameOriginRect:

- (void) setTextFrameOriginRect: (NvsRect) rc

Set the original frame size of the frame caption. If the current caption is not a frame caption, this function has no effect. You can get origin frame size.

Parameters

rc	New frame size.

See also: getCaptionBoundingVertices

Since: 2.19.0

◆ setTextSpanList:

- (void) setTextSpanList: (NSArray< NvsCaptionSpan * > *) storyboardCaptionSpanList

Parameters

◆ setTextVerticalAlignment:

- (void) setTextVerticalAlignment: (NvsTextAlignment) textVerticalAlign

Sets the caption vertical alignment method, valid for frame-caption only.

Parameters

textAlign the caption vertical alignment method

See also: - getTextVerticalAlignment; setTextAlignment

Since: 2.19.1

◆ setUnderline:

- (void) setUnderline: (BOOL) underline

Sets caption under line.

Parameters

underline Whether it is set to under line.

See also: - getUnderline

◆ setVerticalLayout:

- (void) setVerticalLayout: (BOOL) verticalLayout

Sets whether the caption is vertical layout.

Parameters

verticalLayout Indicates whether the caption is vertical layout.YES means it is vertical layout, NO means it is not.

See also: - getVerticalLayout

◆ setWeight:

- (void) setWeight: (int) weight

Sets caption weight.

Parameters

weight the value in opentype weight integer.

See also: - getWeight

◆ setZValue:

- (void) setZValue: (float) value

Sets the Z value of the caption.

Parameters

value The Z value

See also: - getZValue

◆ translateCaption:

- (void) translateCaption: (CGPoint) translationOffset

translates the caption.

Parameters

translationOffset The horizontal and vertical offset values for the caption translation

Since: 1.7.0

See also: - setCaptionTranslation:; - getCaptionTranslation

Property Documentation

◆ captionStylePackageId

- (NSString*) captionStylePackageId

readatomicassign

The package ID of the caption style.

Since: 2.17.1

◆ category

- (NvsCategory) category

readatomicassign

Clip type.

◆ isModular

- (BOOL) isModular

readatomicassign

whether the current caption is a modular caption

Since: 2.15.2

◆ isPanoramic

- (BOOL) isPanoramic

readatomicassign

Whether it is a panorama caption.

Since: 1.6.0

◆ modularCaptionAnimationPackageId

- (NSString*) modularCaptionAnimationPackageId

readatomicassign

The package ID of the modular caption animation style.

Since: 2.15.2

◆ modularCaptionContextPackageId

- (NSString*) modularCaptionContextPackageId

readatomicassign

The package ID of the modular caption context style.

Since: 2.15.2

◆ modularCaptionInAnimationPackageId

- (NSString*) modularCaptionInAnimationPackageId

readatomicassign

The package ID of the modular caption in-animation style.

Since: 2.15.2

◆ modularCaptionOutAnimationPackageId

- (NSString*) modularCaptionOutAnimationPackageId

readatomicassign

The package ID of the modular caption out-animation style.

Since: 2.15.2

◆ modularCaptionRendererPackageId

- (NSString*) modularCaptionRendererPackageId

readatomicassign

The package ID of the modular caption render style.

Since: 2.15.2

◆ roleInTheme

- (NvsRoleInTheme) roleInTheme

readatomicassign

The role of captions in the theme (general, title, and trailer.)

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

include/sdkcore/ios/NvsCaption.h

Instance Methods

Properties

Detailed Description

Method Documentation

◆ applyCaptionStyle:

◆ applyCaptionStyleWithAssetDefaultParam:isUseDefaultAssetParam:

◆ applyModularCaptionAnimation:

◆ applyModularCaptionContext:

◆ applyModularCaptionInAnimation:

◆ applyModularCaptionOutAnimation:

◆ applyModularCaptionRenderer:

◆ getAnchorPoint

◆ getBackgroundColor

◆ getBackgroundRadius

◆ getBold

◆ getBoundaryPaddingRatio

◆ getBoundingRectangleVertices

◆ getCaptionBoundingVertices:

◆ getCaptionTranslation

◆ getCenterAzimuthAngle

◆ getCenterPolarAngle

◆ getComplexRenderLayerCount

◆ getComplexRenderLayerOpacity:

◆ getComplexRenderLayerOutlineColor:

◆ getComplexRenderLayerOutlineWidth:

◆ getControlPoint:

◆ getDrawOutline

◆ getDrawShadow

◆ getFontFamily

◆ getFontFilePath

◆ getFontSize

◆ getItalic

◆ getLetterSpacing

◆ getLetterSpacingType

◆ getLineSpacing

◆ getModularCaptionAnimationPeroid

◆ getModularCaptionInAnimationDuration

◆ getModularCaptionOutAnimationDuration

◆ getOpacity

◆ getOrthoAngleRange

◆ getOutlineColor

◆ getOutlineWidth

◆ getPanoramicRotation

◆ getPanoramicScaleX

◆ getPanoramicScaleY

◆ getPolarAngleRange

◆ getRotationZ

◆ getScaleX

◆ getScaleY

◆ getSecondaryColor

◆ getSecondaryOutlineColor

◆ getShadowColor

◆ getShadowFeather

◆ getShadowOffset

◆ getText

◆ getTextAlignment

◆ getTextBoundingRect

◆ getTextCenterAzimuthAngle

◆ getTextCenterPolarAngle

◆ getTextColor

◆ getTextLayout

◆ getTextOrthoAngleRange

◆ getTextPolarAngleRange

◆ getTextSpanList

◆ getTextVerticalAlignment

◆ getUnderline

◆ getVerticalLayout

◆ getWeight

◆ getZValue

◆ hasOutlineLayerInComplexRender:

◆ isFrameCaption

◆ resetOutlineColorState

◆ resetTextColorState

◆ rotateCaption:

◆ rotateCaption:anchor:

◆ scaleCaption:anchor:

◆ setAnchorPoint:

◆ setBackgroundColor:

◆ setBackgroundRadius:

◆ setBold: