MeiCam SDK For Web  3.12.1
Classes | Functions | Variables
NvStreamingSdk.js File Reference

Doc of SDK WEB APPLICATION. More...

Classes

class  NvsEventEmitter
 event emitter More...
 
class  NvsSdkVersion
 sdk version More...
 
class  NvsRational
 rational More...
 
class  NvsVideoResolution
 video resolution More...
 
class  NvsAudioResolution
 audio resolution More...
 
class  NvsLiveWindow
 liveWindow video preview window More...
 
class  NvsVectorFloat
 vector contains float type values More...
 
class  NvsVectorVal
 vector contains object type values More...
 
class  NvsAIToningInfo
 AI toning info. More...
 
class  NvsStreamingContext
 Streaming context：The streaming context class(NvsStreamingContext) can be refered to as the entry point of the whole SDK framework. In the process of development, NvsStreamingContext provides the static sharedInstance interface, which is the only instance to create streaming context. Through this instantce object, we can turn on the recording device to record videos, adding effects to capture videos, set various parameters for recording, which include autofocus, automatic exposure adjustment, swtiching on/off of the light supplement and so on. Meanwhile, this instance can also create timelines, connecting timelines to real-time preview windows to view the recorded videos in real-time. When the whole video has been produced completely, please destroy the instances of streaming context. When recording with special effects or adding resources packages (recording effects package, scene resources package and so on), one has to first install the package and obtain packageID after installation. For built-in special effects, one only needs to obtain the name of the effect in order to use them. In the SDK, users need to adopt the full pathway when importing resources or authorizations. More...
 
class  NvsProjObj
 project object More...
 
class  NvsCaptionBoundingVerticesInfo
 Caption bounding vertices information. More...
 
class  NvsClipBoundingVerticesInfo
 Video clip bounding vertices information. More...
 
class  NvsTimeline
 Timeline class: edit the timeline entity of the scene. The timeline is composed of tracks and can be regarded as a collection of a series of audio and video tracks. Multiple video tracks and audio tracks can be added or removed on the timeline. Multiple tracks are superimposed and synthesized with each other. When editing a video, you can also add timeline subtitles, themes and corresponding animation stickers as needed to make a beautiful video. In addition, the added material resource package (theme package, animation sticker package, subtitle style package, timeline special effect package, etc.) must be installed first. After successful installation, the packageid can be used, while the built-in timeline special effect (builtin) only needs to obtain the special effect name. More...
 
class  NvsTrack
 Track class: track, a structure that holds segments. Tracks can be regarded as a collection of clips, which are divided into audio track and video track. After you create a timeline instance, you can add or remove multiple tracks. On each track, you can add multiple video and audio clips to edit, set the volume of the clips, or remove and move the position. More...
 
class  NvsVideoTrack
 Video track,the collection of video clips. A video track is an entity that holds video clips, and users can add, insert, and delete multiple video clips. The video track continues to expand as the clip increases, and video transitions can be inserted between clips. When adding a package transition, users need to install it and get the packageID returned as the handle of the transition. For built-in transition, their names are regarded as handle. Note: The index of the video clip starts from 0. More...
 
class  NvsAudioTrack
 Audio track, a collection of audio clips. An audio track is an entity that holds audio clips. Each audio track can add or remove multiple audio clips. When playing one audio clip to another, you need to set the audio transition to facilitate the transition. Note: for a series of interfaces of audio track and the meaning of its parameters, please refer to the corresponding interface of Nvsvideotrack. More...
 
class  NvsClip
 Specific description of clips and audio and video files. Clip is an entity containing audio and video content. It is a description of video and audio files. It is divided into audio clip and video clip. It defines the common attributes and behaviors of different types of clips, that is, the derived audio clips and video clips can modify their clipping entry and exit points, left and right channels, playback speed, etc. In the SDK framework, corresponding audio clips and video clips can be added on the track. More...
 
class  NvsVideoClip
 Video clip, description of video file. The video clip source can be video or image. Each video clip can modify its trim in point, trim out point and playback speed, and can also set panning and scanning. When editing a video, you can add or insert multiple video effects according to different types of effects (built-in effects, wrapped effects, beauty effects). When adding resource pack effects, you have to install them first. After the installation is successful, you can use them only by obtaining the packageid, while builtin only needs to obtain the name of the effect. More...
 
class  NvsAudioClip
 Audio clip, description of audio file. You can also modify the trim in point and out point of audio clip, insert and remove multiple audio special effects, as well as the playback speed. More...
 
class  NvsPanAndScan
 pan and scan More...
 
class  NvsVolume
 volume More...
 
class  NvsColor
 Custom color class In the SDK, the NvsColor class attributes, namely r, g, b and a, range [0, 1] instead of [0, 255]. More...
 
class  NvsPointF
 Two dimensional coordinates point, parameter type is double or float. More...
 
class  NvsRectF
 rectangular More...
 
class  NvsWatermarkInfo
 watermark information More...
 
class  NvsAssetPackageManager
 The asset package manager manages the asset packages in the video scene. During the development of SDK, the asset package manager uniformly installs, upgrades and uninstalls various stunt asset packages needed, including captions, animated stickers, etc. When installing, upgrading and uninstalling, there will be corresponding error prompt types in case of errors, so as to quickly locate and solve the errors. More...
 
class  NvsRegionInfo
 region information More...
 
class  NvsKeyframeParamInfo
 Keyframe ParamInfo. More...
 
class  NvsFx
 Special effects. Special effects are the base classes of different types of special effects such as video FX, audio FX, audio transition and video transition. In the SDK framework, special effects are a key part. Each different type of special effects derived from nvsfx can be added, removed and obtained through clip instances, timeline instances or track instances. At the same time, different API interfaces are provided in the special effect class to set and obtain the special effect parameter types. More...
 
class  NvsTimelineVideoFx
 Timeline video effects timeline video effects are video effects that act on timeline instances. Timeline video effects are divided into three types: built-in effects, package effects and custom effects. The built-in special effects are integrated inside the SDK and can be used directly without authorization. Package special effect is to integrate special effect resources into special effect packages. Each special effect package has its one-to-one corresponding authorization file, and must be installed before use. For details, please refer to material package installation. Custom special effect is a special effect timeline realized by users through writing code. The video special effect package includes special effect entry and exit points. Through entry and exit points, we can specify the position and length of the special effect on the timeline, and the entry point should be less than the exit point, The unit is microseconds. Timeline video effects allow superposition, and the rendering order is controlled by the preset Z value. More...
 
class  NvsCaptionSpan
 layout attributes class More...
 
class  NvsCaption
 Timeline subtitles are custom text superimposed on the video. When editing video, you can add and remove timeline subtitles and adjust the subtitle position. After adding subtitles, you can also set styles, including font size, color, shadow, stroke, etc. More...
 
class  NvsTimelineCaption
 Timeline captions.. More...
 
class  NvsMotionParameters
 Motion parameter information. More...
 
class  NvsCompoundCaption
 Timeline compound caption. Timeline 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 timeline compound captions and adjust the captions position. User can also set its properties such as font family, text color, etc. More...
 
class  NvsTimelineCompoundCaption
 Timeline compound caption. More...
 
class  NvsAnimatedSticker
 Animated sticker class.Animation sticker is a landscaping effect used in video editing to produce animated effects. Users can add and remove animated stickers from the timeline, as well as adjust various properties of the stickers through various APIs, such as position, size, display time, and so on. More...
 
class  NvsTimelineAnimatedSticker
 Timeline animated sticker class. More...
 
class  NvsVideoTransition
 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. More...
 
class  NvsAudioTransition
 音频转场,音频片段间切换的特效。一般通过音频轨道(Audio Track)来设置和获取音频转场。目前默认音频转场是淡入淡出转场(fade)。 More...
 
class  NvsVideoFx
 Video effects. More...
 
class  NvsAudioFx
 Audio effects.Audio effects are effects that are superimposed on an audio clip which can change the tone and rate of the audio clip. After getting an audio clip object instance, users can add or remove multiple audio effects as needed. More...
 
class  NvsParamInfoObject
 Fx parameter information. More...
 
class  NvsTranslationInfo
 Translation information class. More...
 
class  NvsFxDescription
 Effect parameter description class. A variety of different parameter types of effect are set during capturing and editing. The effect parameter description class is used to obtain various effect parameter values. More...
 
class  NvsCurveInfo
 Curve information class. More...
 
class  NvsEmitterCurveInfo
 Emitter curve information class. More...
 
class  NvsParticleSystemContext
 Particle effect context The particle system is composed of several particle emitters and sub-emitters. The particle emitter emits particles over time, and the sub-emitter emits particles from the particles emitted by the particle emitter. More...
 
class  NvsARSceneManipulate
 ARScene manipulate. More...
 
class  NvsParticleEmitterDesc
 Particle Emitter. More...
 
class  NvsAssetPackageParticleDescParser
 Particle effect package parsing class. More...
 
class  NvsVideoCodecInfo
 Video codec information. More...
 
class  NvsVideoStreamInfo
 Video stream information. More...
 
class  NvsAudioStreamInfo
 Audio stream information. More...
 
class  NvsAVFileInfo
 Audio and video file information. More...
 
class  NvsPlaybackRateControlRegion
 Playback rate control region information. More...
 
class  NvsXmlStreamWriter
 XML stream writer. More...
 
class  NvsXmlStreamReader
 XML stream reader. More...
 
class  NvsAudioFileWriter
 Audio file writer. More...
 
class  NvsTemplateFootageCorrespondingClipInfo
 combined clip contained in the footstage in the template resource package More...
 
class  NvsTemplateFootageDesc
 footage information of template package(TEIMPLATE_FOOTAGE_TYPE) More...
 
class  NvsTemplateCaptionDesc
 Subtitle information corresponding to footage in template resource package. More...
 
class  NvsTemplateCompoundCaptionItemDesc
 combined caption contained in the footstage in the template resource package More...
 
class  NvsTemplateCompoundCaptionDesc
 All combined caption contained in the footstage in the template resource package. More...
 
class  NvsTrackVideoFx
 Track videoFx. More...
 
class  NvsTrackCaption
 Track captions. More...
 
class  NvsTrackCompoundCaption
 Track compound caption. More...
 
class  NvsTrackAnimatedSticker
 Track animated sticker class. More...
 
class  NvsClipCaption
 Clip caption. More...
 
class  NvsClipCompoundCaption
 Clip compound caption. More...
 
class  NvsClipAnimatedSticker
 Clip animated sticker. More...
 

Functions

function nvsResumeAudioContext ()
 resume audio context More...
 
function nvsResumeAudioContextWithPromise ()
 resume AudioContext with Promise More...
 
function nvsGetStreamingContextInstance ()
 get instance of streaming context More...
 
function nvsSetModule (module)
 
function nvsSetFS (fs)
 
function nvsInitClasses ()
 

Variables

var Module = typeof Module !== 'undefined' ? Module : {}
 
var FS = typeof FS !== 'undefined' ? FS : {}
 
const NvsStreamingSdkFuncVideoFx = 'videoFx'
 videoFx
 
const NvsStreamingSdkFuncAnimatedSticker = 'animatedSticker'
 animatedSticker
 
const NvsStreamingSdkFuncMusic = 'music'
 music
 
const NvsStreamingSdkFuncCaption = 'caption'
 caption
 
const NvsStreamingSdkFuncVideoFxExtension = 'videoFxExtension'
 videoFxExtension
 
const NvsStreamingSdkFuncVideoTransition = 'videoTransition'
 videoTransition
 
const NvsStreamingSdkFuncTheme = 'theme'
 theme
 
const NvsStreamingSdkFuncParticleVideoFx = 'particleVideoFx'
 particleVideoFx
 
const NvsStreamingSdkFuncTemplate = 'template'
 template
 
const NvsStreamingSdkFuncUseTemplate = 'useTemplate'
 useTemplate
 
const NvsStreamingSdkFuncVideoTransitionExtension = 'videoTransitionExtension'
 videoTransitionExtension
 
const NvsStreamingSdkFuncChangeSpeed = 'changeSpeed'
 changeSpeed
 
const NvsStreamingSdkFuncClipSplit = 'clipSplit'
 clipSplit
 
const NvsStreamingSdkFuncVideoColorAdjust = 'videoColorAdjust'
 videoColorAdjust
 
const NvsStreamingSdkFuncCaptionStyleSetting = 'captionStyleSetting'
 captionStyleSetting
 
const nvsEventEmitter = new NvsEventEmitter()
 eventEmitter
 
const streamingEngineStateStopped = 'streamingEngineStateStopped'
 streamingEngineStateStopped
 
const seekingTimelinePositionArrived = 'seekingTimelinePositionArrived'
 seekingTimelinePositionArrived
 
const NvsLiveWindowFillModeEnum
 fill mode enum of Live window More...
 
const NvsVideoPreviewSizeModeEnum
 size mode enum of video preview More...
 
const NvsSeekFlagEnum
 Seek flag enum. More...
 
const NvsPlaybackFlagEnum
 Playback flag enum. More...
 
const NvsStreamingEngineStateEnum
 status enum of streaming engine More...
 
const NvsAssetPackageTypeEnum
 Asset package type enum. More...
 
const NvsAssetPackageStatusEnum
 Asset package status enum. More...
 
const NvsTrackTypeEnum
 Track type enum. More...
 
const NvsClipTypeEnum
 Clip type enum. More...
 
const NvsVideoClipTypeEnum
 Video clip type enum. More...
 
const NvsVideoClipMotionModeEnum
 Motion mode enum of video clip. More...
 
const NvsVideoClipExtraRotationEnum
 Extra rotation enum of video clip. More...
 
const NvsVideoClipBackgroundModeEnum
 Background mode enum of video clip. More...
 
const NvsVideoFxTypeEnum
 Video fx type enum. More...
 
const NvsVideoTransitionTypeEnum
 Video transition type enum. More...
 
const NvsCaptionTextAlignmentEnum
 Caption text alignment enum. More...
 
const NvsCaptionTextBoundingTypeEnum
 Caption text bounding type enum. More...
 
const NvsCaptionLetterSpacingTypeEnum
 Caption letter spacing type enum. More...
 
const NvsHumanDetectionFeatureEnum
 The enum of human detection. More...
 
const NvsKeyFrameFindModeEnum
 Find mode enum of key frame. More...
 
const NvsClipWrapModeEnum
 Clip wrap mode enum. More...
 
const NvsTimelineAspectRatioEnum
 Timeline aspect ratio enum. More...
 
const NvsHumanDetectionDataTypeEnum
 Data type enum of human detection. More...
 
const NvsCreateTimelineFlagEnum
 Timeline creation flag enum. More...
 
const NvsBlendingMode
 Blending Mode. More...
 
const NvsParticleTypeEnum
 Particle Type. More...
 
const NvsEmitterPlaceEnum
 Emitter Place. More...
 
const NvsFootageTypeEnum
 Footage type of template. More...
 
const TEMPLATE_KEY_REPLACE_ID = 'MSTemplate-ReplaceId'
 
const TEMPLATE_KEY_FOOTAGE_ID = 'MSTemplate-FootageId'
 
const TEMPLATE_KEY_FOOTAGE_TAGS = 'MSTemplate-FootageTags'
 
const NvsRawFilterProcessesMode
 Raw filter processing mode. More...
 
const NvsAssetPackageErrorEnum
 Asset package error enum. More...
 

Detailed Description

Doc of SDK WEB APPLICATION.

Version
3.12.1
Copyright
Meishe Co., Ltd.

Function Documentation

◆ nvsGetStreamingContextInstance()

function nvsGetStreamingContextInstance ( )

get instance of streaming context

Returns
{NvsStreamingContext} engine object of streaming

◆ nvsResumeAudioContext()

function nvsResumeAudioContext ( )

resume audio context

Returns
{Void}

◆ nvsResumeAudioContextWithPromise()

function nvsResumeAudioContextWithPromise ( )

resume AudioContext with Promise

Returns
{Promise}

Variable Documentation

◆ NvsAssetPackageErrorEnum

const NvsAssetPackageErrorEnum
Initial value:
= Object.freeze({
"NoError" : 0,
"NameError" : 1,
"AlreadyInstalledError" : 2,
"WorkingInProgress" : 3,
"NotInstalledError" : 4,
"ImproperStatusError" : 5,
"DecompressionError" : 6,
"InvalidPackageError" : 7,
"AssetTypeError" : 8,
"PermissionError" : 9,
"MetaContentError" : 10,
"SdkVersionError" : 11,
"UpgradeVersionError" : 12,
"IOError" : 13,
"ResourceError" : 14})

Asset package error enum.

Note
NoError No error
NameError Name error
AlreadyInstalledError Already installed
WorkingInProgress Working in progress
NotInstalledError Not installed error
ImproperStatusError Improper status error
DecompressionError Decompression error
InvalidPackageError Invalid package error
AssetTypeError Asset type error
PermissionError Permission error
MetaContentError Meta content error
SdkVersionError Sdk version error
UpgradeVersionError Upgrade version error
IOError IO error
ResourceError Resource error

◆ NvsAssetPackageStatusEnum

const NvsAssetPackageStatusEnum
Initial value:
= Object.freeze({
NotInstalled: 0,
Installing: 1,
Ready: 2,
Upgrading: 3,
})

Asset package status enum.

Note
NotInstalled Not installed
Installing Installing
Ready Ready
Upgrading Upgrading

◆ NvsAssetPackageTypeEnum

const NvsAssetPackageTypeEnum
Initial value:
= Object.freeze({
VideoFx: 0,
VideoTransition: 1,
CaptionStyle: 2,
AnimatedSticker: 3,
ARScene: 6,
CompoundCaption: 7,
CaptionContext: 8,
CaptionRenderer: 9,
CaptionAnimation: 10,
CaptionInAnimation: 11,
CaptionOutAnimation: 12,
Template: 13,
AvatarModel: 14,
AvatarMaterial: 15,
AnimatedStickerAnimation: 16,
AnimatedStickerInAnimation: 17,
AnimatedStickerOutAnimation: 18,
Makeup: 19,
FaceMesh: 20,
Warp: 21,
Project: 22
})

Asset package type enum.

Note
VideoFx Video Fx Type
VideoTransition Video Transition Type
CaptionStyle Caption Style Type
AnimatedSticker Animated Sticker Type
ARScene AR Scene Type
CompoundCaption Compound caption type
CaptionContext Modular caption context type
CaptionRenderer Modular caption renderer type
CaptionAnimation Modular caption animation type
CaptionInAnimation Modular caption in-animation type
CaptionOutAnimation Modular caption out-animation type
Template Template type
AvatarModel Avatar model type
AvatarMaterial Avatar material type
AnimatedStickerAnimation Animated sticker animation type
AnimatedStickerInAnimation Animated sticker in-animation type
AnimatedStickerOutAnimation Animated sticker out-animation type
Makeup Makeup type
FaceMesh Face mesh type
Warp Warp type
Project Project type

◆ NvsBlendingMode

const NvsBlendingMode
Initial value:
= Object.freeze({
BLENDING_MODE_NORMAL: 0,
BLENDING_MODE_MULTIPLY: 1,
BLENDING_MODE_SUBTRACT: 2,
BLENDING_MODE_SCREEN: 3,
BLENDING_MODE_ADD: 4,
BLENDING_MODE_EXCLUSION: 5,
BLENDING_MODE_DARKEN: 6,
BLENDING_MODE_BURN: 7,
BLENDING_MODE_LINEARBURN: 8,
BLENDING_MODE_LIGHTEN: 9,
BLENDING_MODE_DODGE: 10,
BLENDING_MODE_OVERLAY: 11,
BLENDING_MODE_SOFTLIGHT: 12,
BLENDING_MODE_HARDLIGHT: 13,
BLENDING_MODE_VIVIDLIGHT: 14,
BLENDING_MODE_PINLIGHT: 15,
BLENDING_MODE_LINEARLIGHT: 16,
BLENDING_MODE_HARDMIX: 17,
BLENDING_MODE_DIFFERENCE: 18,
})

Blending Mode.

Note
BLENDING_MODE_NORMAL Normal mode
BLENDING_MODE_MULTIPLY Multiplay mode
BLENDING_MODE_SUBTRACT Subtract mode
BLENDING_MODE_SCREEN Screen mode
BLENDING_MODE_ADD Add mode
BLENDING_MODE_EXCLUSION Exclusion mode
BLENDING_MODE_DARKEN Darken mode
BLENDING_MODE_BURN Burn mode
BLENDING_MODE_LINEARBURN Linear Burn mode
BLENDING_MODE_LIGHTEN Lighten mode
BLENDING_MODE_DODGE Dodge mode
BLENDING_MODE_OVERLAY Overlay mode
BLENDING_MODE_SOFTLIGHT SoftLight mode
BLENDING_MODE_HARDLIGHT HardLight mode
BLENDING_MODE_VIVIDLIGHT VividLight mode
BLENDING_MODE_PINLIGHT PinLight mode
BLENDING_MODE_LINEARLIGHT LinearLight mode
BLENDING_MODE_HARDMIX HardMix mode
BLENDING_MODE_DIFFERENCE Difference mode

◆ NvsCaptionLetterSpacingTypeEnum

const NvsCaptionLetterSpacingTypeEnum
Initial value:
= Object.freeze({
Percentage: 0,
Absolute: 1,
})

Caption letter spacing type enum.

Note
Percentage Percentage
Absolute Absolute

◆ NvsCaptionTextAlignmentEnum

const NvsCaptionTextAlignmentEnum
Initial value:
= Object.freeze({
Left: 0,
Center: 1,
Right: 2,
Top: 3,
Bottom: 4,
VCenter: 5,
})

Caption text alignment enum.

Note
Left Left alignment
Center Horizontal center alignment
Right Right alignment
Top Top alignment
Bottom Bottom alignment
VCenter Vertical center alignment

◆ NvsCaptionTextBoundingTypeEnum

const NvsCaptionTextBoundingTypeEnum
Initial value:
= Object.freeze({
Text: 0,
TextFrame: 1,
Frame: 2,
TextOriginFrame: 3,
})

Caption text bounding type enum.

Note
Text The actual text bounding
TextFrame Text frame bounding
Frame The whole bounding including decoration
TextOriginFrame The origin text frame bounding

◆ NvsClipTypeEnum

const NvsClipTypeEnum
Initial value:
= Object.freeze({
Video: 0,
Audio: 1,
})

Clip type enum.

Note
Video Video
Audio Audio

◆ NvsClipWrapModeEnum

const NvsClipWrapModeEnum
Initial value:
= Object.freeze({
RepeatLastFrame: 0,
RepeatFirstFrame: 1,
Repeat: 2,
})

Clip wrap mode enum.

Note
RepeatLastFrame Repeat the last frame
RepeatFirstFrame Repeat the first frame
Repeat Repeat

◆ NvsCreateTimelineFlagEnum

const NvsCreateTimelineFlagEnum
Initial value:
= Object.freeze({
LongestDurationConsiderAllTracks: 1,
SyncAudioVideoTrasitionInVideoTrack: 2,
UseMipmap: 4,
VariantImageSize: 8,
DontAddDefaultVideoTransition: 16,
ForceAudioSampleFormatUsed: 32,
Template: 64,
Orphan: 128,
ForceTimelineSizeUsed: 256,
RecordingUserOperation: 512
})

Timeline creation flag enum.

Note
LongestDurationConsiderAllTracks Timeline's longest duration consider all tracks
SyncAudioVideoTrasitionInVideoTrack Sync audio transition and video transiton on video track
UseMipmap Use mipmap anti-aliasing
VariantImageSize Automatically adapt timeline resolution when add images
DontAddDefaultVideoTransition Do not add a default video transition
ForceAudioSampleFormatUsed Force using audio format of audio resolution
Template Template timeline
Orphan Orphan timeline flag, destroy the timeline after its parent timeline destroyed
ForceTimelineSizeUsed Forced use of timeline resolution in automatically adapt timeline resolution model
RecordingUserOperation Recording user operation

◆ NvsEmitterPlaceEnum

const NvsEmitterPlaceEnum
Initial value:
= Object.freeze({
EMITTER_PLACE_LEFT: 0,
EMITTER_PLACE_RIGHT: 1,
EMITTER_PLACE_TOP: 2,
EMITTER_PLACE_BOTTOM: 3,
EMITTER_PLACE_CENTER: 4,
})

Emitter Place.

Note
EMITTER_PLACE_LEFT left
EMITTER_PLACE_RIGHT right
EMITTER_PLACE_TOP top
EMITTER_PLACE_BOTTOM bottom
EMITTER_PLACE_CENTER center

◆ NvsFootageTypeEnum

const NvsFootageTypeEnum
Initial value:
= Object.freeze({
VideoImage: 0,
Video: 1,
Image: 2,
Audio: 3,
})

Footage type of template.

Note
VideoImage Video or image
Video Video
Image Image
Audio Audio

◆ NvsHumanDetectionDataTypeEnum

const NvsHumanDetectionDataTypeEnum
Initial value:
= Object.freeze({
FakeFace: 0,
Makeup: 1,
SkinColor: 2,
PE106: 3,
PE240: 4,
CustomAvatar: 5,
Makeup2: 6,
FaceCommon: 7,
AdvancedBeauty: 8,
})

Data type enum of human detection.

Note
FakeFace Fake face
Makeup Makeup
SkinColor Skin color
PE106 PE106
PE240 PE240
CustomAvatar Custom avatar
Makeup2 Makeup2
FaceCommon Face common
AdvancedBeauty Advanced beauty

◆ NvsHumanDetectionFeatureEnum

const NvsHumanDetectionFeatureEnum
Initial value:
= Object.freeze({
FaceLandmark: 0x00000001,
FaceAction: 0x00000002,
AvatarExpression: 0x00000004,
VideoMode: 0x00000008,
ImageMode: 0x00000010,
SemiImageMode: 0x00008000,
MultiThread: 0x00000020,
SingleThread: 0x00000040,
Extra: 0x00000080,
SegmentationBackground: 0x00000100,
HandLandmark: 0x00000200,
HandAction: 0x00000400,
HandBone: 0x00000800,
EyeballLandmark: 0x00001000,
MultiDetect: 0x00002000,
SegmentationSky: 0x00004000,
SegmentationHalfBody: 0x00010000,
FaceAttr: 0x00020000,
FaceAttrShape: 0x00040000
})

The enum of human detection.

Note
0x00000001 Landmarks on human face
0x00000002 Actions of human face
0x00000004 Avatar Expressions of human face
0x00000008 Video detection mode
0x00000010 Image detection mode
0x00008000 Semi-image detection mode
0x00000020 Multi thread detection
0x00000040 Single thread detection
0x00000080 Extra features of human face
0x00000100 Background segmentation
0x00000200 Hand landmarks
0x00000400 Hand actions
0x00000800 Bone landmarks of hand
0x00001000 Eyeball landmarks
0x00002000 Multiple detect, say multiple rois detection
0x00004000 Sky segmentation
0x00010000 Half body segmentation
0x00020000 Base face attributes
0x00040000 Face shape attribute

◆ NvsKeyFrameFindModeEnum

const NvsKeyFrameFindModeEnum
Initial value:
= Object.freeze({
Before: 1,
After: 2,
})

Find mode enum of key frame.

Note
Before Before
After After

◆ NvsLiveWindowFillModeEnum

const NvsLiveWindowFillModeEnum
Initial value:
= Object.freeze({
PreserveAspectCrop: 0,
PreserveAspectFit: 1,
Stretch: 2,
})

fill mode enum of Live window

Note
0 Preserve aspect crop
1 Preserve aspect fit
2 Stretch

◆ NvsParticleTypeEnum

const NvsParticleTypeEnum
Initial value:
= Object.freeze({
PARTICLE_TYPE_NORMAL: 0,
PARTICLE_TYPE_TOUCH: 1,
PARTICLE_TYPE_GESTURE: 2,
PARTICLE_TYPE_EYE: 3,
PARTICLE_TYPE_MOUTH: 4,
})

Particle Type.

Note
PARTICLE_TYPE_NORMAL Particle effect without interaction
PARTICLE_TYPE_TOUCH Particle effect controlled by touch screen
PARTICLE_TYPE_GESTURE Particle effect controlled by gesture
PARTICLE_TYPE_EYE Particle effect controlled by eye
PARTICLE_TYPE_MOUTH Particle effect controlled by mouth

◆ NvsPlaybackFlagEnum

const NvsPlaybackFlagEnum
Initial value:
= Object.freeze({
IgnoreTiming: 1,
LowPipelineSize: 8,
DisableFixedPrerollTime: 16,
BuddyHostVideoFrame: 32,
BuddyHostOriginVideoFrame: 2048,
UseMipmap: 8192,
DisableVideo: 1 << 15
})

Playback flag enum.

Note
IgnoreTiming Ignore timing
LowPipelineSize Low pipeline size
DisableFixedPrerollTime Disable fixed preroll time
BuddyHostVideoFrame Buddy host video frame, used for face detection normally
BuddyHostOriginVideoFrame Buddy host origin video frame, used for face detection normally
UseMipmap Use mipmap
DisableVideo Disable video

◆ NvsRawFilterProcessesMode

const NvsRawFilterProcessesMode
Initial value:
= Object.freeze({
None: 0,
VarSize: 1,
VarSizeWithFillModeUsed: 2,
})

Raw filter processing mode.

Note
None Default mode, all Raw filters have consistent input and output sizes, and are finally adapted to the timeline size according to the set fill mode.
VarSize The output size of all Raw filters is based on the actual output size of the filters, and finally, the fill mode is used to adapt to the size of the timeline.
VarSizeWithFillModeUsed The output size of all Raw filters is based on the actual output size of the filters, and finally adapted to the size of the timeline according to the set fill mode.

◆ NvsSeekFlagEnum

const NvsSeekFlagEnum
Initial value:
= Object.freeze({
ShowCaptionPoster: 2,
ShowAnimatedStickerPoster: 4,
BuddyHostVideoFrame: 16,
WebReaderPrefetchForSeek: 32,
BuddyHostOriginVideoFrame: 256,
UseMipmap: 512
})

Seek flag enum.

Note
ShowCaptionPoster Show animated sticker poster
ShowAnimatedStickerPoster Show caption poster
BuddyHostVideoFrame Buddy host video frame, used for face detection normally
WebReaderPrefetchForSeek Web reader prefetch for seek
BuddyHostOriginVideoFrame Buddy host origin video frame, used for face detection normally
UseMipmap Use mipmap

◆ NvsStreamingEngineStateEnum

const NvsStreamingEngineStateEnum
Initial value:
= Object.freeze({
StreamingEngineStateStopped: 0,
StreamingEngineStatePlayback: 3,
StreamingEngineStateSeeking: 4
})

status enum of streaming engine

Note
StreamingEngineStateStopped Stopped state
StreamingEngineStatePlayback Playback state
StreamingEngineStateSeeking Seeking state

◆ NvsTimelineAspectRatioEnum

const NvsTimelineAspectRatioEnum
Initial value:
= Object.freeze({
'16v9': 1,
'1v1': 2,
'9v16': 4,
'4v3': 8,
'3v4': 16,
'18v9': 32,
'9v18': 64,
'21v9': 512,
'9v21': 1024,
})

Timeline aspect ratio enum.

Note
16v9 16:9
1v1 1:1
9v16 9:16
4v3 4:3
3v4 3:4
18v9 18:9
9v18 9:18
21v9 21:9
9v21 9:21

◆ NvsTrackTypeEnum

const NvsTrackTypeEnum
Initial value:
= Object.freeze({
Video: 0,
Audio: 1,
})

Track type enum.

Note
Video Video
Audio Audio

◆ NvsVideoClipBackgroundModeEnum

const NvsVideoClipBackgroundModeEnum
Initial value:
= Object.freeze({
ColorSolid: 0,
Blur: 1,
})

Background mode enum of video clip.

Note
ColorSolid Solid color
Blur Blur

◆ NvsVideoClipExtraRotationEnum

const NvsVideoClipExtraRotationEnum
Initial value:
= Object.freeze({
Rotation0: 0,
Rotation90: 1,
Rotation180: 2,
Rotation270: 3,
})

Extra rotation enum of video clip.

Note
Rotation0 Rotation 0°
Rotation90 Rotation 90°
Rotation180 Rotation 180°
Rotation270 Rotation 270°

◆ NvsVideoClipMotionModeEnum

const NvsVideoClipMotionModeEnum
Initial value:
= Object.freeze({
LetterBoxZoomIn: 0,
LetterBoxZoomOut: 1,
Image_ROI: 2,
})

Motion mode enum of video clip.

Note
LetterBoxZoomIn Letter box zoom in
LetterBoxZoomOut Letter box zoom out
Image_ROI The image clip's ROI(Region Of Interesting)

◆ NvsVideoClipTypeEnum

const NvsVideoClipTypeEnum
Initial value:
= Object.freeze({
AV: 0,
Image: 1,
})

Video clip type enum.

Note
AV Video
Image Image

◆ NvsVideoFxTypeEnum

const NvsVideoFxTypeEnum
Initial value:
= Object.freeze({
Builtin: 0,
Package: 1,
Custom: 2,
})

Video fx type enum.

Note
Builtin Builtin type
Package Package type
Custom Custom type

◆ NvsVideoPreviewSizeModeEnum

const NvsVideoPreviewSizeModeEnum
Initial value:
= Object.freeze({
FullSize: 0,
LiveWindowSize: 1,
})

size mode enum of video preview

Note
FullSize Full size
LiveWindowSize Live window size

◆ NvsVideoTransitionTypeEnum

const NvsVideoTransitionTypeEnum
Initial value:
= Object.freeze({
Builtin: 0,
Package: 1,
})

Video transition type enum.

Note
Builtin Builtin type
Package Package type
Generated by doxygen 1.9.1