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

Video transition is a effect of switching between clips. More...

#import <NvsVideoEffectTransition.h>

Inheritance diagram for NvsVideoEffectTransition:
NvsEffect

Instance Methods

(void) - setVideoTransitionDuration:
 Sets video transition duration. More...
 
(int64_t) - getVideoTransitionDuration
 Gets video transition duration. 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

NvsVideoEffectTransitionType type
 The type of the video transition. More...
 
NSString * builtinName
 The name of the built-in video transition. If it's not a built-in video transition, return nil. More...
 
NSString * packageId
 The ID of the resource package video transition. If it's not a resource package video transition, return nil. More...
 
- Properties inherited from NvsEffect
NvsEffectDescriptiondescription
 

Detailed Description

Video transition is a effect of switching between clips.

There are multiple clips on the track. The transition is the transition effect from one video clip to another, and no video transitions can be added between clips with gaps. Currently it supports multiple video transitions including fade, turning, swap, stretch in, page curl, lens flare, star, dip to black, dip to white,push to right, push to top, upper left into.
Each video transition can be set and retrieved via video track (NvsVideoTrack). The default transition is fade.

Warning
In the NvsVideoTransition class, all public APIs are used in the UI thread! ! !

Method Documentation

◆ getVideoTransitionDuration

- (int64_t) getVideoTransitionDuration

Gets video transition duration.

Returns
Returns the video transition duration.
Since
2.20.0

◆ setVideoTransitionDuration:

- (void) setVideoTransitionDuration: (int64_t)  duration

Sets video transition duration.

Parameters
durationVideo transition duration
scaleModeVideo transition duration scale mode
Since
2.20.0

Property Documentation

◆ builtinName

- (NSString*) builtinName
readatomicassign

The name of the built-in video transition. If it's not a built-in video transition, return nil.

◆ packageId

- (NSString*) packageId
readatomicassign

The ID of the resource package video transition. If it's not a resource package video transition, return nil.

◆ type

- (NvsVideoEffectTransitionType) type
readatomicassign

The type of the video transition.


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