Video effect. More...
#import <NvsVideoEffect.h>
Inheritance diagram for NvsVideoEffect:
Instance Methods | |
| (int64_t) | - changeInPoint: |
| Changes the in-point of the fx on the Clip. More... | |
| (int64_t) | - changeOutPoint: |
| Changes the out-point of the fx on the Clip. 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) | - 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 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 | |
| NvsVideoEffectType | type |
| The type of the video effect. More... | |
| NSString * | builtinName |
| The name of the built-in video effect. If it's not a built-in video effect, return nil. More... | |
| NSString * | packageId |
| The ID of the resource package video effect. If it's not a resource package video effect, return nil. More... | |
| Properties inherited from NvsEffect | |
| NvsEffectDescription * | description |
Detailed Description
Video effect.
The video effect can change the overall or partial color, brightness, transparency, etc. of the video image, so that the video can show a special effect.
- Warning
- In the NvsVideoEffect class, all public APIs are used in the UI thread! ! !
Method Documentation
◆ changeInPoint:
| - (int64_t) changeInPoint: | (int64_t) | newInPoint |
Changes the in-point of the fx on the Clip.
- Parameters
-
newInPoint The new in-point of the fx on the timeline (in microseconds).
- Returns
- Returns the in-point of the fx on the Clip (in microseconds).
- 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
- changeOutPoint
- getInPoint
- movePosition
- Since
- 3.0.1
◆ changeOutPoint:
| - (int64_t) changeOutPoint: | (int64_t) | newOutPoint |
Changes the out-point of the fx on the Clip.
- Parameters
-
newOutPoint The new out-point of the fx on the Clip (in microseconds).
- Returns
- Returns the out-point of the fx on the Clip (in microseconds).
- Warning
- This interface will cause the streaming engine state to jump to the engine stop state. For details, please refer to [Engine Change].(Engine of Changing).
- See also
- changeInPoint
- getOutPoint
- movePosition
- Since
- 3.0.1
Property Documentation
◆ builtinName
|
readatomicassign |
The name of the built-in video effect. If it's not a built-in video effect, return nil.
◆ packageId
|
readatomicassign |
The ID of the resource package video effect. If it's not a resource package video effect, return nil.
◆ type
|
readatomicassign |
The type of the video effect.
The documentation for this class was generated from the following file:
- include/sdkcore/ios/NvsVideoEffect.h
