Track compound caption. More...
#import <NvsTrackCompoundCaption.h>
Inheritance diagram for NvsTrackCompoundCaption:
Instance Methods | |
| (int64_t) | - changeInPoint: |
| Changes the in-point of the caption on the track. More... | |
| (int64_t) | - changeOutPoint: |
| Changes the out-point of the caption on the track. More... | |
| (void) | - movePosition: |
| Changes the display position of the caption on the track (the in and out points are offset from the offset value at the same time). More... | |
 Instance Methods inherited from NvsCompoundCaption | |
| (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 | |
| BOOL | clipAffinityEnabled |
| Sets whether to turn on affinity between the caption and video clip. 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... | |
| Properties inherited from NvsCompoundCaption | |
| 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... | |
Detailed Description
Track compound caption.
Track compound captions are compound caption that is superimposed on the video, each compound caption may composed of several sub-captions. When editing a video, users can add or remove track compound captions and adjust the captions position. User can also set its properties such as font family, text color, etc.
- Warning
- In the NvsTrackCompoundCaption class, all public APIs should be used in the UI thread!!!
- Since
- 2.20.0
Method Documentation
◆ changeInPoint:
| - (int64_t) changeInPoint: | (int64_t) | newInPoint |
Changes the in-point of the caption on the track.
- Parameters
-
newInPoint The new in-point of the caption on the track (in microseconds).
- Returns
- Returns the in-point of the caption on the track (in microseconds).
- See also
- changeOutPoint
- getInPoint
- movePosition
◆ changeOutPoint:
| - (int64_t) changeOutPoint: | (int64_t) | newOutPoint |
Changes the out-point of the caption on the track.
- Parameters
-
newOutPoint The new out-point of the caption on the track (in microseconds).
- Returns
- Returns the out-point of the caption on the track (in microseconds).
- See also
- changeInPoint
- getOutPoint
- movePosition
◆ movePosition:
| - (void) movePosition: | (int64_t) | offset |
Changes the display position of the caption on the track (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
Property Documentation
◆ clipAffinityEnabled
|
readwritenonatomicassign |
Sets whether to turn on affinity between the caption and video clip.
- Parameters
-
enable Whether to turn on affinity between the caption and video clip
◆ inPoint
|
readatomicassign |
The in point of the caption on the timeline(in microseconds)
◆ 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/NvsTrackCompoundCaption.h
