Effect SDK context class. More...
#import <NvsEffectSdkContext.h>
Inheritance diagram for NvsEffectSdkContext:
Class Methods | |
| (BOOL) | + verifySdkLicenseFile: |
| Verifies the SDK license. Note: This interface must be called before the NvsStreamingContext is initialized. More... | |
| (NvsEffectSdkContext *) | + sharedInstance: |
| Gets the unique instance of the effect sdk context. More... | |
| (void) | + destroyInstance |
| Destroys the effect sdk context instance. More... | |
| (int) | + hasARModule |
| Checks if the current SDK contains an AR module. More... | |
| (BOOL) | + initHumanDetection:licenseFilePath:features: |
| Initializes the human body detection mechanism. More... | |
| (BOOL) | + initHumanDetectionExt:licenseFilePath:features: |
| Human detection initialization extension. More... | |
| (BOOL) | + setupHumanDetectionData:dataFilePath: |
| Setup human detection data package. More... | |
| (void) | + closeHumanDetection |
| Turns off the human detection mechanism. More... | |
| (void) | + getSdkVersion:minorVersion:revisionNumber: |
| Gets the version information of Meishe SDK. More... | |
Properties | |
| NvsAssetPackageManager * | assetPackageManager |
| Asset package manager. More... | |
Detailed Description
Effect SDK context class.
Method Documentation
◆ closeHumanDetection
| + (void) closeHumanDetection |
Turns off the human detection mechanism.
- Since
- 2.5.0
◆ createAnimatedSticker:duration:isPanoramic:packageId:aspectRatio:
| - (NvsVideoEffectAnimatedSticker *) createAnimatedSticker: | (int64_t) | inPoint | |
| duration: | (int64_t) | duration | |
| isPanoramic: | (bool) | isPanoramic | |
| packageId: | (NSString *) | packageId | |
| aspectRatio: | (NvsEffectRational) | aspectRatio | |
Creates animated sticker object.
- Parameters
-
inPoint In point of sticker duration Duration of sticker isPanoramic Whether panoramic sticker animatedStickerId Animated sticker package id. aspectRatio The aspect ratio of animated sticker.
- Returns
- Returns the created animated sticker object.
◆ createCaption:inPoint:duration:captionStylePackageId:aspectRatio:
| - (NvsVideoEffectCaption *) createCaption: | (NSString *) | captionText | |
| inPoint: | (int64_t) | inPoint | |
| duration: | (int64_t) | duration | |
| captionStylePackageId: | (NSString *) | captionStylePackageId | |
| aspectRatio: | (NvsEffectRational) | aspectRatio | |
Create caption.
- Parameters
-
captionText Text of caption inPoint The in point of the caption (in microseconds) duration Caption display duration (in microseconds) captionStylePackageId Caption style package Id.If it does not exist, you can pass an empty string or null. aspectRatio The aspect ratio of caption
- Returns
- Returns the NvsTimelineCaption object.
It will return null in the following situations:
1. No caption function authorization;
2. If inPoint is less than 0 or greater than or equal to the current timeline duration, or duration is not greater than 0.
- Since
- 2.20.0
◆ createCompoundCaption:duration:packageId:aspectRatio:
| - (NvsVideoEffectCompoundCaption *) createCompoundCaption: | (int64_t) | inPoint | |
| duration: | (int64_t) | duration | |
| packageId: | (NSString *) | packageId | |
| aspectRatio: | (NvsEffectRational) | aspectRatio | |
Creates compound caption object.
- Parameters
-
inPoint In point of caption duration Duration of caption packageId caption package id. aspectRatio The aspect ratio of caption
- Returns
- Returns the created compound caption object.
◆ createCustomAnimatedSticker:duration:isPanoramic:packageId:customImageFilePath:aspectRatio:
| - (NvsVideoEffectAnimatedSticker *) createCustomAnimatedSticker: | (int64_t) | inPoint | |
| duration: | (int64_t) | duration | |
| isPanoramic: | (bool) | isPanoramic | |
| packageId: | (NSString *) | packageId | |
| customImageFilePath: | (NSString *) | customImageFilePath | |
| aspectRatio: | (NvsEffectRational) | aspectRatio | |
Creates custom animated sticker object.
- Parameters
-
inPoint In point of sticker duration Duration of sticker isPanoramic Whether panoramic sticker animatedStickerId Animated sticker package id. customImageFilePath Custom sticker image file path. aspectRatio The aspect ratio of animated sticker.
- Returns
- Returns the created animated sticker object.
◆ createEffectRenderCore
| - (NvsEffectRenderCore *) createEffectRenderCore |
Creates a special effect rendering object.
- Returns
- Returns the created effect rendering object.
◆ createModularCaption:inPoint:duration:aspectRatio:
| - (NvsVideoEffectCaption *) createModularCaption: | (NSString *) | captionText | |
| inPoint: | (int64_t) | inPoint | |
| duration: | (int64_t) | duration | |
| aspectRatio: | (NvsEffectRational) | aspectRatio | |
Add a modular caption on the timeline.
- Parameters
-
captionText Text of caption inPoint The in point of the caption on the timeline (in microseconds) duration Caption display duration (in microseconds) aspectRatio The aspect ratio of caption
- Returns
- Returns the NvsTimelineCaption object.
It will return null in the following situations:
1. No caption function authorization;
2. If inPoint is less than 0 or greater than or equal to the current timeline duration, or duration is not greater than 0.
- Since
- 2.20.0
◆ createPanoramicCaption:inPoint:duration:captionStylePackageId:aspectRatio:
| - (NvsVideoEffectCaption *) createPanoramicCaption: | (NSString *) | captionText | |
| inPoint: | (int64_t) | inPoint | |
| duration: | (int64_t) | duration | |
| captionStylePackageId: | (NSString *) | captionStylePackageId | |
| aspectRatio: | (NvsEffectRational) | aspectRatio | |
Add a panorama caption on the timeline.
- Parameters
-
captionText Text of caption inPoint The in point of the caption on the timeline (in microseconds) duration Caption display duration (in microseconds) captionStylePackageId Caption style package Id.If it does not exist, you can pass an empty string or null. aspectRatio The aspect ratio of caption
- Returns
- Returns the NvsTimelineCaption object.
It will return null in the following situations:
1. No caption function authorization;
2. If inPoint is less than 0 or greater than or equal to the current timeline duration, or duration is not greater than 0.
- Since
- 2.20.0
◆ createVideoEffect:aspectRatio:
| - (NvsVideoEffect *) createVideoEffect: | (NSString *) | effectId | |
| aspectRatio: | (NvsEffectRational) | aspectRatio | |
Creates a special effect object.
- Parameters
-
effectId Special effects ID. For build-in video effects, it is the name of the effect. If it is a resource package effect, it is the resource package ID. aspectRatio Aspect ratio
- Returns
- Returns the created special effect object.
◆ createVideoEffect:aspectRatio:realTime:
| - (NvsVideoEffect *) createVideoEffect: | (NSString *) | effectId | |
| aspectRatio: | (NvsEffectRational) | aspectRatio | |
| realTime: | (BOOL) | realTime | |
Creates a special effect object.
- Parameters
-
effectId Special effects ID. For build-in video effects, it is the name of the effect. If it is a resource package effect, it is the resource package ID. aspectRatio Aspect ratio realTime realTime mode
- Returns
- Returns the created special effect object.
◆ createVideoTransition:aspectRatio:
| - (NvsVideoEffectTransition *) createVideoTransition: | (NSString *) | transitionId | |
| aspectRatio: | (NvsEffectRational) | aspectRatio | |
Creates a special transition object.
- Parameters
-
effectId Special transitions ID. For build-in video transitions, it is the name of the effect. If it is a resource package transition, it is the resource package ID. aspectRatio Aspect ratio realTime realTime mode
- Returns
- Returns the created special transition object.
◆ destroyInstance
| + (void) destroyInstance |
Destroys the effect sdk context instance.
- See also
- + sharedInstance:
◆ getAllBuiltinVideoFxNames
| - (NSArray *) getAllBuiltinVideoFxNames |
Gets a list of all build-in video effects' names.
- Returns
- Returns an array object containing all the build-in video effects' names.
◆ getSdkVersion:minorVersion:revisionNumber:
| + (void) getSdkVersion: | (int *) | majorVersion | |
| minorVersion: | (int *) | minorVersion | |
| revisionNumber: | (int *) | revisionNumber | |
Gets the version information of Meishe SDK.
- Parameters
-
majorVersion Major version number minorVersion Minor version number revisionNumber Revision number
- Since
- 2.23.0
◆ hasARModule
| + (int) hasARModule |
Checks if the current SDK contains an AR module.
- Returns
- Returns value of 0 means that no AR module exists, and a value greater than 0 means that the AR module exists.
- Since
- 2.5.0
◆ initHumanDetection:licenseFilePath:features:
| + (BOOL) initHumanDetection: | (NSString *) | modelFilePath | |
| licenseFilePath: | (NSString *) | licenseFilePath | |
| features: | (int) | features | |
Initializes the human body detection mechanism.
- Parameters
-
modelFilePath The file path of the face model licenseFilePath The file path of license features Human detection feature flag field. Please refer to Human detection feature
- Returns
- The return value indicates whether it is successful
- Since
- 2.5.0
◆ initHumanDetectionExt:licenseFilePath:features:
| + (BOOL) initHumanDetectionExt: | (NSString *) | modelFilePath | |
| licenseFilePath: | (NSString *) | licenseFilePath | |
| features: | (int) | features | |
Human detection initialization extension.
- Parameters
-
modelFilePath Path of the model file licenseFilePath Path of the license file features human detection flag field. Please refer to Flag of human detection.
- Since
- 2.17.1
◆ registerFontByFilePath:
| - (NSString *) registerFontByFilePath: | (NSString *) | filePath |
Register fonts according to file path.
- Returns
- Returns the fontfamily of the font. If the file path is empty or the registration fails, it returns an empty string. If the context does not exist, it returns nil.
- Since
- 2.23.0
◆ setupHumanDetectionData:dataFilePath:
| + (BOOL) setupHumanDetectionData: | (int) | dataType | |
| dataFilePath: | (NSString *) | dataFilePath | |
Setup human detection data package.
- Parameters
-
dataType Human detection data package type.Please refer toHuman detection data packet type. dataFilePath The file path of data
- Returns
- The return value indicates whether it is successful.
- Since
- 2.6.0
◆ sharedInstance:
| + (NvsEffectSdkContext *) sharedInstance: | (NvsEffectSdkContextFlag) | flags |
Gets the unique instance of the effect sdk context.
- Returns
- Returns the instance of the effect sdk context.
- See also
- + destroyInstance
◆ UnregisterFontByFilePath:
| - (void) UnregisterFontByFilePath: | (NSString *) | filePath |
Unregister fonts according to file path.
- Since
- 2.23.0
◆ verifySdkLicenseFile:
| + (BOOL) verifySdkLicenseFile: | (NSString *) | sdkLicenseFilePath |
Verifies the SDK license. Note: This interface must be called before the NvsStreamingContext is initialized.
- Parameters
-
sdkLicenseFilePath SDK license file path
- Returns
- Returns BOOL value. YES indicates that the license verification is successful, and NO indicates that the verification fails. If the verification fails, a subsequent watermark will appear in video preview and generated videos.
Property Documentation
◆ assetPackageManager
|
readatomicassign |
Asset package manager.
The documentation for this class was generated from the following file:
- include/sdkcore/ios/NvsEffectSdkContext.h
