MeiCam SDK For Web  3.15.1
Class Hierarchy
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 1234]
 CNveARSceneManipulateARScene manipulate
 CNveARSceneRendererARScene builtin fx compound renderer By internally downloading and initializing face models, and managing the installation of asset packages, the logic of appling beauty, shape, and makeup is simplified. It also provides starting camera media stream, external input media stream, output media stream, and IndexedDB caching internally. Just configure parameters while initializing, and then set the asset packages' url or other parameters to get the results of beauty, shape, and makeup rendering conveniently
 CNveAssetPackageManagerThe 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
 CNveCaptionSpanLayout attributes class
 CNveColorCustom color class In the SDK, the NveColor class attributes, namely r, g, b and a, range [0, 1] instead of [0, 255]
 CNveEffectContextEffect context Effect context is the entry to effect SDK framework, nveGetEffectContextInstance() used to get the unique effect context instance
 CNveEffectInstanceEffect instance
 CNveAnimatedStickerAnimated sticker class.Animation sticker is a landscaping effect used in video editing to produce animated effects. Users can add and adjust various properties of the stickers through various APIs, such as position, size, display time, and so on
 CNveCaptionCaptions are custom text superimposed on the video. You can add and adjust the caption position. After adding caption, you can also set styles, including font size, color, shadow, stroke, etc
 CNveCompoundCaptionCompound caption. 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 and adjust the captions position. User can also set its properties such as font family, text color, etc
 CNveVideoTransitionThere 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. The default transition is fade
 CNveMotionParametersMotion parameter information
 CNvePointFTwo dimensional coordinates point, parameter type is double or float
 CNveRationalRational
 CNveRectFRectangular
 CNveRenderTaskRender task
 CNveVectorValVector contains object type values
 CNveVolumeVolume
 CNvsAIToningInfoAI toning info
 CNvsARSceneManipulateARScene manipulate
 CNvsAssetPackageManagerThe 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
 CNvsAssetPackageParticleDescParserParticle effect package parsing class
 CNvsAudioFileWriterAudio file writer
 CNvsAudioResolutionAudio resolution
 CNvsAudioStreamInfoAudio stream information
 CNvsAVFileInfoAudio and video file information
 CNvsCaptionBoundingVerticesInfoCaption bounding vertices information
 CNvsCaptionSpanLayout attributes class
 CNvsClipBoundingVerticesInfoVideo clip bounding vertices information
 CNvsColorCustom color class In the SDK, the NvsColor class attributes, namely r, g, b and a, range [0, 1] instead of [0, 255]
 CNvsCurveInfoCurve information class
 CNvsEmitterCurveInfoEmitter curve information class
 CNvsEventEmitterEvent emitter
 CNvsFaceInfoFace info
 CNvsFxDescriptionEffect 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
 CNvsKeyframeParamInfoKeyframe ParamInfo
 CNvsLiveWindowLiveWindow video preview window
 CNvsMotionParametersMotion parameter information
 CNvsPanAndScanPan and scan
 CNvsParamInfoObjectFx parameter information
 CNvsParticleEmitterDescParticle Emitter
 CNvsParticleSystemContextParticle 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
 CNvsPlaybackRateControlRegionPlayback rate control region information
 CNvsPointFTwo dimensional coordinates point, parameter type is double or float
 CNvsProjObjProject object
 CNvsClipSpecific 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
 CNvsAudioClipAudio 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
 CNvsVideoClipVideo 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
 CNvsFxSpecial 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
 CNvsAnimatedStickerAnimated 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
 CNvsClipAnimatedStickerClip animated sticker
 CNvsTimelineAnimatedStickerTimeline animated sticker class
 CNvsTrackAnimatedStickerTrack animated sticker
 CNvsAudioFxAudio 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
 CNvsAudioTransition音频转场,音频片段间切换的特效。一般通过音频轨道(Audio Track)来设置和获取音频转场。目前默认音频转场是淡入淡出转场(fade)。
 CNvsCaptionTimeline 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
 CNvsClipCaptionClip caption
 CNvsTimelineCaptionTimeline captions.
 CNvsTrackCaptionTrack captions
 CNvsCompoundCaptionTimeline 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
 CNvsClipCompoundCaptionClip compound caption
 CNvsTimelineCompoundCaptionTimeline compound caption
 CNvsTrackCompoundCaptionTrack compound caption
 CNvsTimelineVideoFxTimeline 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
 CNvsTrackVideoFxTrack videoFx
 CNvsVideoFxVideo effects
 CNvsVideoTransitionThere 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
 CNvsTimelineTimeline 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
 CNvsTrackTrack 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
 CNvsAudioTrackAudio 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
 CNvsVideoTrackVideo 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
 CNvsRationalRational
 CNvsRectFRectangular
 CNvsRegionInfoRegion information
 CNvsSdkVersionSdk version
 CNvsStreamingContextStreaming 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
 CNvsTemplateCaptionDescSubtitle information corresponding to footage in template resource package
 CNvsTemplateCompoundCaptionDescAll combined caption contained in the footstage in the template resource package
 CNvsTemplateCompoundCaptionItemDescCombined caption contained in the footstage in the template resource package
 CNvsTemplateFootageCorrespondingClipInfoCombined clip contained in the footstage in the template resource package
 CNvsTemplateFootageDescFootage information of template package(TEIMPLATE_FOOTAGE_TYPE)
 CNvsTimeFollowCaptionTime follow caption
 CNvsTimeFollowCaptionInfoTime follow caption information
 CNvsTimeFollowCaptionWordTime follow caption word
 CNvsTranslationInfoTranslation information class
 CNvsVectorFloatVector contains float type values
 CNvsVectorValVector contains object type values
 CNvsVideoCodecInfoVideo codec information
 CNvsVideoResolutionVideo resolution
 CNvsVideoStreamInfoVideo stream information
 CNvsVolumeVolume
 CNvsWatermarkInfoWatermark information
 CNvsXmlStreamReaderXML stream reader
 CNvsXmlStreamWriterXML stream writer