#import <NvsVideoEffectCompoundCaption.h>

Inheritance diagram for NvsVideoEffectCompoundCaption:

Instance Methods
(int64_t)	- changeInPoint:
	Changes the in-point of the caption. More...

(int64_t)	- changeOutPoint:
	Changes the out-point of the caption. More...

(void)	- movePosition:
	Changes the display position of the caption (the in and out points are offset from the offset value at the same time). More...

(void)	- setText:text:
	Sets caption text. More...

(NSString *)	- getText:
	Get caption text. More...

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

(NSString *)	- getFontFamily:
	Get the name of caption font. More...

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

(NvsEffectColor)	- getTextColor:
	Gets the color value of the caption. More...

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

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

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

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

(void)	- translateCaption:
	Translate caption. More...

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

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

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

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

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

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

(void)	- scaleCaption:anchor:
	Zooms caption. More...

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

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

(void)	- rotateCaption:anchor:
	Rotates captions. More...

(void)	- rotateCaptionAroundCenter:boundingType:
	Rotates caption around center of the bounding. More...

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

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

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

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

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

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

(void)	- setVideoResolution:
	Set the Compound Caption's video resolution. More...

(void)	- setDrawOutline:captionIndex:
	Sets caption stroke. More...

(BOOL)	- getDrawOutline:
	Gets the caption stroke status. More...

(void)	- setOutlineColor:captionIndex:
	Sets the color of the caption stroke. More...

(NvsEffectColor)	- getOutlineColor:
	Gets the color value of the current caption stroke. More...

(void)	- setOutlineWidth:captionIndex:
	Sets the width of the caption stroke. More...

(float)	- getOutlineWidth:
	Gets the width of the current caption stroke. More...

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

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

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

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

(void)	- setItalic:captionIndex:
	Sets caption italic. More...

(BOOL)	- getItalic:
	Gets the caption italic. More...

(void)	- setCurrentKeyFrameTime:
	Set the compound 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)	- 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...

Instance Methods inherited from NvsEffect
(void)	- setIntVal:val:
	Sets effect parameter of integer type. More...

(int)	- getIntVal:
	Get effect parameter of integer type. More...

(void)	- setFloatVal:val:
	Sets effect parameter of float type. More...

(double)	- getFloatVal:
	Gets effect parameter of float type. More...

(void)	- setBooleanVal:val:
	Sets effect parameter of BOOL type. More...

(BOOL)	- getBooleanVal:
	Gets effect parameter of BOOL type. More...

(void)	- setStringVal:val:
	Sets effect parameter of string type. More...

(NSString *)	- getStringVal:
	Gets effect parameter of string value. More...

(void)	- setColorVal:val:
	Sets effect parameter of color type. More...

(NvsEffectColor)	- getColorVal:
	Gets effect parameter of color value. More...

(void)	- setPosition2DVal:val:
	Sets effect parameter of 2D coordinates type. More...

(NvsEffectPosition2D)	- getPosition2DVal:
	Gets effect parameter of 2D coordinates value. More...

(void)	- setPosition3DVal:val:
	Sets effect parameter of 3D coordinates type. More...

(NvsEffectPosition3D)	- getPosition3DVal:
	Gets effect parameter of 3D coordinates value. More...

(void)	- setMenuVal:val:
	Sets effect parameter of menu type. More...

(NSString *)	- getMenuVal:
	Gets effect parameter of menu value. More...

(void)	- setArbDataVal:val:
	Sets the effect parameter of custom type. More...

(NvsArbitraryData *)	- getArbDataVal:
	Gets the effect parameter of custom type. 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)	- 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 filter intensity. More...

(float)	- getFilterIntensity
	Gets the filter intensity. More...

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

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

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

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

(void)	- setIgnoreBackground:
	Sets whether the regional filter ignore Background. More...

(BOOL)	- getIgnoreBackground
	Gets whether the regional filter ignores Background. More...

(void)	- setInverseRegion:
	Sets whether the regional filter inverse region. More...

(BOOL)	- getInverseRegion
	Gets whether the regional filter inverse region. More...

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

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

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

(void)	- setRegionInfo:
	Sets the region of this regional filter. More...

(void)	- setRegionInfoAtTime:time:
	Sets the region of this regional filter at certain time. More...

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

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

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

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

(NvsParticleSystemContext *)	- getParticleSystemContext
	Gets the particle effect context. More...

(NvsPaintingEffectContext *)	- getPaintingEffectContext
	Gets the particle effect context. More...

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

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

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

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

(void)	- clearExprVarCtx
	Clears the value of all parameters defined in the expression and sets it to the default value of 0. More...

Properties
NSInteger	captionCount
	Gets number of sub-cpations in this compound caption. More...

int64_t	inPoint
	The in point of the caption on the timeline(in microseconds) More...

int64_t	outPoint
	The out point of the caption on the timeline (in microseconds) More...

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

Properties inherited from NvsEffect
NvsEffectDescription *	description

Method Documentation

◆ changeInPoint:

- (int64_t) changeInPoint: (int64_t) newInPoint

Changes the in-point of the caption.

Parameters

newInPoint The new in-point of the caption (in microseconds).

Returns: Returns the in-point of the caption (in microseconds).

See also: changeOutPoint; getInPoint; movePosition

◆ changeOutPoint:

- (int64_t) changeOutPoint: (int64_t) newOutPoint

Changes the out-point of the caption.

Parameters

newOutPoint The new out-point of the caption (in microseconds).

Returns: Returns the out-point of the caption (in microseconds).

See also: changeInPoint; getOutPoint; movePosition

◆ findKeyframeTime:time:flags:

- (int64_t) findKeyframeTime:	(NSString *)	fxParam
time:	(int64_t)	time
flags:	(int)	flags

Get key frame at a specified time point.

Parameters

fxParam	The type of custom data parameter for the effect.
time	time point (In microseconds).
flags	flag of finding mode, Please refer to [KEY_FRAME_FIND_MODE].

Returns: Return key frame time point near the specified time point, If there is no key frame near this time point, return - 1

Since: 3.7.3

Implements NvsEffect.

◆ getAnchorPoint

- (CGPoint) getAnchorPoint

Gets caption anchor.

Returns: Returns caption anchor.

See also: setAnchorPoint

◆ getBackgroundColor:

- (NvsEffectColor) getBackgroundColor: (int) captionIndex

Get the current text background color value.

Parameters

captionIndex caption index

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

See also: setBackgroundColor

Since: 3.7.3

◆ getBold:

- (BOOL) getBold: (int) captionIndex

Gets the state whether the caption font is bold.

Parameters

captionIndex caption index

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

See also: setBold: captionIndex:

Since: 3.7.3

◆ getCaptionBoundingVertices:boundingType:

- (NSArray *) getCaptionBoundingVertices:	(NSInteger)	captionIndex
boundingType:	(NvsEffectBoundingType)	boundingType

Gets the transformed vertices position of the original caption bounding.

Parameters

captionIndex	Caption index to get vertices positions
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.

◆ getCaptionTranslation

- (CGPoint) getCaptionTranslation

Gets the amount of caption translation.

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

See also: setCaptionTranslation

◆ getCompoundBoundingVertices:

- (NSArray *) getCompoundBoundingVertices: (NvsEffectBoundingType) boundingType

Gets the transformed vertices position of the original compound 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.

◆ 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.NvsControlPointPair对象

See also: setControlPoint: controlPointPair

Since: 3.7.3

◆ getDrawOutline:

- (BOOL) getDrawOutline: (int) captionIndex

Gets the caption stroke status.

Parameters

captionIndex caption index

Returns: Returns boolean value, true means it is stroked, and false means it is not stroked.

Since: 3.7.3

See also: setDrawOutline

◆ getFontFamily:

- (NSString *) getFontFamily: (NSInteger) captionIndex

Get the name of caption font.

Parameters

captionIndex caption index to get font family

Returns: Returns the name of caption font.

See also: setFontFamily

◆ getItalic:

- (BOOL) getItalic: (int) captionIndex

Gets the caption italic.

Parameters

captionIndex caption index

Returns: Returns the caption italic.

Since: 3.7.3

◆ getOpacity

- (float) getOpacity

Get the caption opacity.

Returns: Return the opacity.

See also: - setOpacity:

◆ getOutlineColor:

- (NvsEffectColor) getOutlineColor: (int) captionIndex

Gets the color value of the current caption stroke.

Parameters

captionIndex caption index

Returns: Returns the NvsEffectColor object representing the color of the resulting caption stroke.

Since: 3.7.3

See also: setOutlineColor

◆ getOutlineWidth:

- (float) getOutlineWidth: (int) captionIndex

Gets the width of the current caption stroke.

Parameters

captionIndex caption index

Returns: Returns the width value of the obtained caption stroke.

Since: 3.7.3

See also: setOutlineWidth

◆ getRotationZ

- (float) getRotationZ

Gets caption rotation angle.

Returns: Returns caption rotation angle.

See also: setRotationZ

◆ getScaleX

- (float) getScaleX

Gets caption horizontal scaling factor.

Returns: Returns caption horizontal scaling factor.

See also: setScaleX; - getScaleY

◆ getScaleY

- (float) getScaleY

Gets caption vertical scaling factor.

Returns: Returns caption vertical scaling factor.

See also: setScaleY; - getScaleX

◆ getText:

- (NSString *) getText: (NSInteger) captionIndex

Get caption text.

Parameters

captionIndex caption index to get text

Returns: Returns caption text.

See also: setText

◆ getTextColor:

- (NvsEffectColor) getTextColor: (NSInteger) captionIndex

Gets the color value of the caption.

Parameters

captionIndex caption index to get text color

Returns: Return NvsEffectColor object which is the text color

See also: setTextColor

◆ getWeight:

- (int) getWeight: (int) captionIndex

Gets the caption weight.

Parameters

captionIndex caption index

Returns: Returns the caption weight.

See also: setWeight: captionIndex:

◆ getZValue

- (float) getZValue

Gets caption Z value.

Returns: Returns caption Z value.

◆ hasKeyframeList:

- (bool) hasKeyframeList: (NSString *) fxParam

Check whether the parameter has key frame list or not.

Parameters

fxParam The type of custom data parameter for the effect.

Returns: Return exist or not.

Since: 3.7.3

Implements NvsEffect.

◆ movePosition:

- (void) movePosition: (int64_t) offset

Changes the display position of the caption (the in and out points are offset from the offset value at the same time).

Parameters

offset Offset value for in and out points changes (in microseconds).

See also: changeInPoint; changeOutPoint

◆ removeAllKeyframe:

- (bool) removeAllKeyframe: (NSString *) fxParam

Remove all key frames from key frame list.

Parameters

fxParam The type of custom data parameter for the effect.

Returns: Return success or not

Since: 3.7.3

Implements NvsEffect.

◆ removeKeyframeAtTime:time:

- (bool) removeKeyframeAtTime:	(NSString *)	fxParam
time:	(int64_t)	time

Remove key frame at a specified time point from key frame list.

Parameters

fxParam	The type of custom data parameter for the effect.
time	time point (In microseconds).

Returns: Return success or not

Since: 3.7.3

Implements NvsEffect.

◆ rotateCaption:anchor:

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

Rotates captions.

Parameters

angle	Angle of caption rotation.
anchor	Anchor of caption rotation.

◆ rotateCaptionAroundCenter:boundingType:

- (void) rotateCaptionAroundCenter:	(float)	angle
boundingType:	(NvsEffectBoundingType)	boundingType

Rotates caption around center of the bounding.

Parameters

angle	Angle of rotation, in degree
boundingType	Bounding type to calculate center point. Please refer to Bounding Type

◆ scaleCaption:anchor:

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

Zooms caption.

Parameters

scaleFactor	Caption scaling factor.
anchor	Caption zoom anchor.

◆ setAnchorPoint:

- (void) setAnchorPoint: (CGPoint) anchor

Sets caption anchor.

Parameters

anchor Anchor.

See also: - getAnchorPoint

◆ setBackgroundColor:captionIndex:

- (void) setBackgroundColor:	(NvsEffectColor)	backgroundColor
captionIndex:	(int)	captionIndex

Set text background color.

Parameters

backgroundColor	Background color value.
captionIndex	caption index

See also: getBackgroundColor

Since: 3.7.3

◆ setBold:captionIndex:

- (void) setBold:	(BOOL)	bold
captionIndex:	(int)	captionIndex

Sets whether the caption font is bold.

Parameters

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

See also: - getBold:

Since: 3.7.3

◆ setCaptionTranslation:

- (void) setCaptionTranslation: (CGPoint) translation

Sets the amount of caption translation.

Parameters

translation The horizontal and vertical translation of the caption.

See also: - getCaptionTranslation

◆ 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.

See also: getControlPoint

Since: 3.7.3

◆ setCurrentKeyFrameTime:

- (void) setCurrentKeyFrameTime: (int64_t) time

Set the compound caption KeyFrameTime.

See also: setCurrentKeyFrameTime

Since: 3.7.3

◆ setDrawOutline:captionIndex:

- (void) setDrawOutline:	(BOOL)	drawOutline
captionIndex:	(int)	captionIndex

Sets caption stroke.

Parameters

drawOutline	Whether to stroke the captions. True means it strokes the caption. False means it does not stroke the edges.
captionIndex	caption index to set text

Since: 3.7.3

See also: getDrawOutline

◆ setFontFamily:family:

- (void) setFontFamily:	(NSInteger)	captionIndex
family:	(NSString *)	family

Sets caption font family.

Parameters

captionIndex	caption index to set font family
family	Caption font family name. It will be set to default font if family is an empty string

See also: getFontFamily

◆ setItalic:captionIndex:

- (void) setItalic:	(BOOL)	italic
captionIndex:	(int)	captionIndex

Sets caption italic.

Parameters

italic	the value to set italic.
captionIndex	caption index

◆ setOpacity:

- (void) setOpacity: (float) opacity

Set the caption opacity.

Parameters

opacity The opacity of caption

See also: - getOpacity

◆ setOutlineColor:captionIndex:

- (void) setOutlineColor:	(NvsEffectColor)	outlineColor
captionIndex:	(int)	captionIndex

Sets the color of the caption stroke.

Parameters

outlineColor	Caption stroke color value.
captionIndex	caption index

Since: 3.7.3

See also: getOutlineColor

◆ setOutlineWidth:captionIndex:

- (void) setOutlineWidth:	(float)	outlineWidth
captionIndex:	(int)	captionIndex

Sets the width of the caption stroke.

Parameters

outlineWidth	The width of the caption stroke.
captionIndex	caption index

Since: 3.7.3

See also: getOutlineWidth

◆ setRotationZ:

- (void) setRotationZ: (float) angle

Sets the rotation angle for the caption.

Parameters

angle Rotation angle.

See also: - getRotationZ

◆ setScaleX:

- (void) setScaleX: (float) scale

Sets horizontal scaling factor for caption.

Parameters

scale Horizontal scaling factor.

See also: - getScaleX; setScaleY

◆ setScaleY:

- (void) setScaleY: (float) scale

Sets vertical scaling factor for captions.

Parameters

scale Vertical scaling factor.

See also: - getScaleY; setScaleX

◆ setText:text:

- (void) setText:	(NSInteger)	captionIndex
text:	(NSString *)	text

Sets caption text.

Parameters

captionIndex	caption index to set text
text	Caption text

See also: getText

◆ setTextColor:textColor:

- (void) setTextColor:	(NSInteger)	captionIndex
textColor:	(const NvsEffectColor *)	textColor

Sets caption text color.

Parameters

captionIndex	caption index to set text color
textColor	Caption text color value.

See also: getTextColor

◆ setVideoResolution:

- (void) setVideoResolution: (NvsEffectVideoResolution *) resolution

Set the Compound Caption's video resolution.

Parameters

resolution The Compound Caption's video resolution

Since: 2.20.0

◆ setWeight:captionIndex:

- (void) setWeight:	(int)	weight
captionIndex:	(int)	captionIndex

Sets caption weight.

Parameters

weight	the value in opentype weight integer.
captionIndex	caption index

See also: - getWeight:

◆ setZValue:

- (void) setZValue: (float) value

Sets caption Z value.

Parameters

value Z value

◆ translateCaption:

- (void) translateCaption: (CGPoint) translationOffset

Translate caption.

Parameters

translationOffset Horizontal and vertical offset values for caption.

See also: setCaptionTranslation; - getCaptionTranslation

Property Documentation

◆ captionCount

- (NSInteger) captionCount

readatomicassign

Gets number of sub-cpations in this compound caption.

Returns: Returns number of sub-cpations

◆ captionStylePackageId

- (NSString*) captionStylePackageId

readatomicassign

The package ID of the caption style.

◆ inPoint

- (int64_t) inPoint

readatomicassign

The in point of the caption on the timeline(in microseconds)

◆ outPoint

- (int64_t) outPoint

readatomicassign

The out point of the caption on the timeline (in microseconds)

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

include/sdkcore/ios/NvsVideoEffectCompoundCaption.h

Instance Methods

Properties

Method Documentation

◆ changeInPoint:

◆ changeOutPoint:

◆ findKeyframeTime:time:flags:

◆ getAnchorPoint

◆ getBackgroundColor:

◆ getBold:

◆ getCaptionBoundingVertices:boundingType:

◆ getCaptionTranslation

◆ getCompoundBoundingVertices:

◆ getControlPoint:

◆ getDrawOutline:

◆ getFontFamily:

◆ getItalic:

◆ getOpacity

◆ getOutlineColor:

◆ getOutlineWidth:

◆ getRotationZ

◆ getScaleX

◆ getScaleY

◆ getText:

◆ getTextColor:

◆ getWeight:

◆ getZValue

◆ hasKeyframeList:

◆ movePosition:

◆ removeAllKeyframe:

◆ removeKeyframeAtTime:time:

◆ rotateCaption:anchor:

◆ rotateCaptionAroundCenter:boundingType:

◆ scaleCaption:anchor:

◆ setAnchorPoint:

◆ setBackgroundColor:captionIndex:

◆ setBold:captionIndex:

◆ setCaptionTranslation:

◆ setControlPoint:controlPointPair:

◆ setCurrentKeyFrameTime:

◆ setDrawOutline:captionIndex:

◆ setFontFamily:family:

◆ setItalic:captionIndex:

◆ setOpacity:

◆ setOutlineColor:captionIndex:

◆ setOutlineWidth:captionIndex:

◆ setRotationZ:

◆ setScaleX:

◆ setScaleY:

◆ setText:text:

◆ setTextColor:textColor:

◆ setVideoResolution:

◆ setWeight:captionIndex:

◆ setZValue:

◆ translateCaption:

Property Documentation

◆ captionCount

◆ captionStylePackageId

◆ inPoint

◆ outPoint