MeiCam SDK For iOS  3.10.0
Instance Methods | Properties | List of all members
NvsCompoundCaption Class Reference

#import <NvsCompoundCaption.h>

Inheritance diagram for NvsCompoundCaption:
NvsFx NvsObject NvsCaptureCompoundCaption NvsClipCompoundCaption NvsTimelineCompoundCaption NvsTrackCompoundCaption

Instance Methods

(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...
 
(NvsColor- getTextColor:
 Gets the color value of the caption. 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) - 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...
 
(NvsColor- 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...
 
(NvsColor- 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) - setWeight:captionIndex:
 Sets caption weight. More...
 
(int) - getWeight:
 Gets the caption weight. 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 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) - 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

NSString * captionStylePackageId
 The package ID of the caption style. More...
 
NSInteger captionCount
 Gets number of sub-cpations in this compound caption. More...
 
- Properties inherited from NvsFx
NvsFxDescriptiondescription
 Special effect description. More...
 

Method Documentation

◆ findKeyframeTime:time:flags:

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

Get key frame at a specified time point.

Parameters
fxParamThe type of custom data parameter for the effect.
timetime point (In microseconds).
flagsflag 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

Implements NvsFx.

◆ getAnchorPoint

- (CGPoint) getAnchorPoint

Gets caption anchor.

Returns
Returns caption anchor.
See also
setAnchorPoint

◆ getBackgroundColor:

- (NvsColor) getBackgroundColor: (int)  captionIndex

Get the current text background color value.

Parameters
captionIndexcaption index
Returns
Returns the NvsColor object representing the current background color.
See also
setBackgroundColor
Since
3.1.3

◆ getBold:

- (BOOL) getBold: (int)  captionIndex

Gets the state whether the caption font is bold.

Parameters
captionIndexcaption 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:

◆ getCaptionBoundingVertices:boundingType:

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

Gets the transformed vertices position of the original caption bounding.

Parameters
captionIndexCaption index to get vertices positions
boundingTypeBounding 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: (NvsBoundingType boundingType

Gets the transformed vertices position of the original compound caption bounding.

Parameters
boundingTypeBounding 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
fxParamThe type of data parameter for the caption.
Returns
return control point data.NvsControlPointPair对象
See also
setControlPoint: controlPointPair
Since
3.2.1

◆ getDrawOutline:

- (BOOL) getDrawOutline: (int)  captionIndex

Gets the caption stroke status.

Parameters
captionIndexcaption index
Returns
Returns boolean value, true means it is stroked, and false means it is not stroked.
Since
3.1.3
See also
setDrawOutline

◆ getFontFamily:

- (NSString *) getFontFamily: (NSInteger)  captionIndex

Get the name of caption font.

Parameters
captionIndexcaption 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
captionIndexcaption index
Returns
Returns the caption italic.

◆ getOpacity

- (float) getOpacity

Get the caption opacity.

Returns
Return the opacity.
See also
- setOpacity:

◆ getOutlineColor:

- (NvsColor) getOutlineColor: (int)  captionIndex

Gets the color value of the current caption stroke.

Parameters
captionIndexcaption index
Returns
Returns the NvsColor object representing the color of the resulting caption stroke.
Since
3.1.3
See also
setOutlineColor

◆ getOutlineWidth:

- (float) getOutlineWidth: (int)  captionIndex

Gets the width of the current caption stroke.

Parameters
captionIndexcaption index
Returns
Returns the width value of the obtained caption stroke.
Since
3.1.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
captionIndexcaption index to get text
Returns
Returns caption text.
See also
setText

◆ getTextColor:

- (NvsColor) getTextColor: (NSInteger)  captionIndex

Gets the color value of the caption.

Parameters
captionIndexcaption index to get text color
Returns
Return NvsColor object which is the text color
See also
setTextColor

◆ getWeight:

- (int) getWeight: (int)  captionIndex

Gets the caption weight.

Parameters
captionIndexcaption 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
fxParamThe type of custom data parameter for the effect.
Returns
Return exist or not.

Implements NvsFx.

◆ removeAllKeyframe:

- (bool) removeAllKeyframe: (NSString *)  fxParam

Remove all key frames from key frame list.

Parameters
fxParamThe type of custom data parameter for the effect.
Returns
Return success or not

Implements NvsFx.

◆ removeKeyframeAtTime:time:

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

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

Parameters
fxParamThe type of custom data parameter for the effect.
timetime point (In microseconds).
Returns
Return success or not

Implements NvsFx.

◆ rotateCaption:anchor:

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

Rotates captions.

Parameters
angleAngle of caption rotation.
anchorAnchor of caption rotation.

◆ rotateCaptionAroundCenter:boundingType:

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

Rotates caption around center of the bounding.

Parameters
angleAngle of rotation, in degree
boundingTypeBounding type to calculate center point. Please refer to Bounding Type

◆ scaleCaption:anchor:

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

Zooms caption.

Parameters
scaleFactorCaption scaling factor.
anchorCaption zoom anchor.

◆ setAnchorPoint:

- (void) setAnchorPoint: (CGPoint)  anchor

Sets caption anchor.

Parameters
anchorAnchor.
See also
- getAnchorPoint

◆ setBackgroundColor:captionIndex:

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

Set text background color.

Parameters
backgroundColorBackground color value.
captionIndexcaption index
See also
getBackgroundColor
Since
3.1.3

◆ setBold:captionIndex:

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

Sets whether the caption font is bold.

Parameters
captionIndexcaption index
boldIndicates whether the caption font is bold.YES means it is bold, NO means it is not.
See also
- getBold:

◆ setCaptionTranslation:

- (void) setCaptionTranslation: (CGPoint)  translation

Sets the amount of caption translation.

Parameters
translationThe 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
fxParamThe type of data parameter for the caption.
controlPointPaircontrol point pair.
See also
getControlPoint
Since
3.2.1

◆ setCurrentKeyFrameTime:

- (void) setCurrentKeyFrameTime: (int64_t)  time

Set the compound caption KeyFrameTime.

See also
setCurrentKeyFrameTime
Since
3.2.1

◆ setDrawOutline:captionIndex:

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

Sets caption stroke.

Parameters
drawOutlineWhether to stroke the captions. True means it strokes the caption. False means it does not stroke the edges.
captionIndexcaption index to set text
Since
3.1.3
See also
getDrawOutline

◆ setFontFamily:family:

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

Sets caption font family.

Parameters
captionIndexcaption index to set font family
familyCaption 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
italicthe value to set italic.
captionIndexcaption index

◆ setOpacity:

- (void) setOpacity: (float)  opacity

Set the caption opacity.

Parameters
opacityThe opacity of caption
See also
- getOpacity

◆ setOutlineColor:captionIndex:

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

Sets the color of the caption stroke.

Parameters
outlineColorCaption stroke color value.
captionIndexcaption index
Since
3.1.3
See also
getOutlineColor

◆ setOutlineWidth:captionIndex:

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

Sets the width of the caption stroke.

Parameters
outlineWidthThe width of the caption stroke.
captionIndexcaption index
Since
3.1.3
See also
getOutlineWidth

◆ setRotationZ:

- (void) setRotationZ: (float)  angle

Sets the rotation angle for the caption.

Parameters
angleRotation angle.
See also
- getRotationZ

◆ setScaleX:

- (void) setScaleX: (float)  scale

Sets horizontal scaling factor for caption.

Parameters
scaleHorizontal scaling factor.
See also
- getScaleX
setScaleY

◆ setScaleY:

- (void) setScaleY: (float)  scale

Sets vertical scaling factor for captions.

Parameters
scaleVertical scaling factor.
See also
- getScaleY
setScaleX

◆ setText:text:

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

Sets caption text.

Parameters
captionIndexcaption index to set text
textCaption text
See also
getText

◆ setTextColor:textColor:

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

Sets caption text color.

Parameters
captionIndexcaption index to set text color
textColorCaption text color value.
See also
getTextColor

◆ setWeight:captionIndex:

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

Sets caption weight.

Parameters
weightthe value in opentype weight integer.
captionIndexcaption index
See also
- getWeight:

◆ setZValue:

- (void) setZValue: (float)  value

Sets caption Z value.

Parameters
valueZ value

◆ translateCaption:

- (void) translateCaption: (CGPoint)  translationOffset

Translate caption.

Parameters
translationOffsetHorizontal 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.


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