|
MeiCam SDK For iOS
3.14.4
|
#import <NvsCompoundCaption.h>
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 | |
| NvsFxDescription * | description |
| Special effect description. More... | |
| - (int64_t) findKeyframeTime: | (NSString *) | fxParam | |
| time: | (int64_t) | time | |
| flags: | (int) | flags | |
Get key frame at a specified time point.
| 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]. |
Implements NvsFx.
| - (CGPoint) getAnchorPoint |
Gets caption anchor.
| - (NvsColor) getBackgroundColor: | (int) | captionIndex |
Get the current text background color value.
| captionIndex | caption index |
| - (BOOL) getBold: | (int) | captionIndex |
Gets the state whether the caption font is bold.
| captionIndex | caption index |
| - (NSArray *) getCaptionBoundingVertices: | (NSInteger) | captionIndex | |
| boundingType: | (NvsBoundingType) | boundingType | |
Gets the transformed vertices position of the original caption bounding.
| captionIndex | Caption index to get vertices positions |
| boundingType | Bounding type. Please refer to Bounding Type |
| - (CGPoint) getCaptionTranslation |
Gets the amount of caption translation.
| - (NSArray *) getCompoundBoundingVertices: | (NvsBoundingType) | boundingType |
Gets the transformed vertices position of the original compound caption bounding.
| boundingType | Bounding type. Please refer to Bounding Type |
| - (NvsControlPointPair*) getControlPoint: | (NSString *) | fxParam |
Get the caption's key frame control point pair.
| fxParam | The type of data parameter for the caption. |
| - (BOOL) getDrawOutline: | (int) | captionIndex |
Gets the caption stroke status.
| captionIndex | caption index |
| - (NSString *) getFontFamily: | (NSInteger) | captionIndex |
Get the name of caption font.
| captionIndex | caption index to get font family |
| - (BOOL) getItalic: | (int) | captionIndex |
Gets the caption italic.
| captionIndex | caption index |
| - (float) getOpacity |
| - (NvsColor) getOutlineColor: | (int) | captionIndex |
Gets the color value of the current caption stroke.
| captionIndex | caption index |
| - (float) getOutlineWidth: | (int) | captionIndex |
Gets the width of the current caption stroke.
| captionIndex | caption index |
| - (float) getRotationZ |
Gets caption rotation angle.
| - (float) getScaleX |
Gets caption horizontal scaling factor.
| - (float) getScaleY |
Gets caption vertical scaling factor.
| - (NSString *) getText: | (NSInteger) | captionIndex |
Get caption text.
| captionIndex | caption index to get text |
| - (NvsColor) getTextColor: | (NSInteger) | captionIndex |
Gets the color value of the caption.
| captionIndex | caption index to get text color |
| - (int) getWeight: | (int) | captionIndex |
Gets the caption weight.
| captionIndex | caption index |
| - (float) getZValue |
Gets caption Z value.
| - (bool) hasKeyframeList: | (NSString *) | fxParam |
Check whether the parameter has key frame list or not.
| fxParam | The type of custom data parameter for the effect. |
Implements NvsFx.
| - (bool) removeAllKeyframe: | (NSString *) | fxParam |
Remove all key frames from key frame list.
| fxParam | The type of custom data parameter for the effect. |
Implements NvsFx.
| - (bool) removeKeyframeAtTime: | (NSString *) | fxParam | |
| time: | (int64_t) | time | |
Remove key frame at a specified time point from key frame list.
| fxParam | The type of custom data parameter for the effect. |
| time | time point (In microseconds). |
Implements NvsFx.
| - (void) rotateCaption: | (float) | angle | |
| anchor: | (CGPoint) | anchor | |
Rotates captions.
| angle | Angle of caption rotation. |
| anchor | Anchor of caption rotation. |
| - (void) rotateCaptionAroundCenter: | (float) | angle | |
| boundingType: | (NvsBoundingType) | boundingType | |
Rotates caption around center of the bounding.
| angle | Angle of rotation, in degree |
| boundingType | Bounding type to calculate center point. Please refer to Bounding Type |
| - (void) scaleCaption: | (float) | scaleFactor | |
| anchor: | (CGPoint) | anchor | |
Zooms caption.
| scaleFactor | Caption scaling factor. |
| anchor | Caption zoom anchor. |
| - (void) setAnchorPoint: | (CGPoint) | anchor |
| - (void) setBackgroundColor: | (NvsColor) | backgroundColor | |
| captionIndex: | (int) | captionIndex | |
Set text background color.
| backgroundColor | Background color value. |
| captionIndex | caption index |
| - (void) setBold: | (BOOL) | bold | |
| captionIndex: | (int) | captionIndex | |
Sets whether the caption font is bold.
| captionIndex | caption index |
| bold | Indicates whether the caption font is bold.YES means it is bold, NO means it is not. |
| - (void) setCaptionTranslation: | (CGPoint) | translation |
Sets the amount of caption translation.
| translation | The horizontal and vertical translation of the caption. |
| - (bool) setControlPoint: | (NSString *) | fxParam | |
| controlPointPair: | (NvsControlPointPair *) | controlPointPair | |
Set the caption's control point pair.
| fxParam | The type of data parameter for the caption. |
| controlPointPair | control point pair. |
| - (void) setCurrentKeyFrameTime: | (int64_t) | time |
Set the compound caption KeyFrameTime.
| - (void) setDrawOutline: | (BOOL) | drawOutline | |
| captionIndex: | (int) | captionIndex | |
Sets caption stroke.
| 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 |
| - (void) setFontFamily: | (NSInteger) | captionIndex | |
| family: | (NSString *) | family | |
Sets caption font family.
| 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 |
| - (void) setItalic: | (BOOL) | italic | |
| captionIndex: | (int) | captionIndex | |
Sets caption italic.
| italic | the value to set italic. |
| captionIndex | caption index |
| - (void) setOpacity: | (float) | opacity |
| - (void) setOutlineColor: | (NvsColor) | outlineColor | |
| captionIndex: | (int) | captionIndex | |
Sets the color of the caption stroke.
| outlineColor | Caption stroke color value. |
| captionIndex | caption index |
| - (void) setOutlineWidth: | (float) | outlineWidth | |
| captionIndex: | (int) | captionIndex | |
Sets the width of the caption stroke.
| outlineWidth | The width of the caption stroke. |
| captionIndex | caption index |
| - (void) setRotationZ: | (float) | angle |
| - (void) setScaleX: | (float) | scale |
Sets horizontal scaling factor for caption.
| scale | Horizontal scaling factor. |
| - (void) setScaleY: | (float) | scale |
Sets vertical scaling factor for captions.
| scale | Vertical scaling factor. |
| - (void) setText: | (NSInteger) | captionIndex | |
| text: | (NSString *) | text | |
Sets caption text.
| captionIndex | caption index to set text |
| text | Caption text |
| - (void) setTextColor: | (NSInteger) | captionIndex | |
| textColor: | (const NvsColor *) | textColor | |
Sets caption text color.
| captionIndex | caption index to set text color |
| textColor | Caption text color value. |
| - (void) setWeight: | (int) | weight | |
| captionIndex: | (int) | captionIndex | |
Sets caption weight.
| weight | the value in opentype weight integer. |
| captionIndex | caption index |
| - (void) setZValue: | (float) | value |
Sets caption Z value.
| value | Z value |
| - (void) translateCaption: | (CGPoint) | translationOffset |
Translate caption.
| translationOffset | Horizontal and vertical offset values for caption. |
|
readatomicassign |
Gets number of sub-cpations in this compound caption.
|
readatomicassign |
The package ID of the caption style.
1.8.18