美摄Web端SDK  3.12.1
类列表
这里列出了所有类、结构、联合以及接口定义等,并附带简要说明:
 CNveAnimatedSticker动画贴纸类。动画贴纸是视频编辑时使用的一种美化特效,可以产生动画效果。用户可以添加和修改动画贴纸,通过各种API调整贴纸的各种属性,如位置、大小、显示时间等等。
 CNveARSceneManipulateARScene 操作。
 CNveARSceneRendererARScene内建特效的快捷渲染类 通过内部下载初始化人脸模型,内部下载管理安装美妆、美型等资源包的方式,简化美颜美型美妆以及整妆包的使用逻辑, 同时内部还提供启动摄像头媒体流采集,外部输入媒体流,输出媒体流的多种形式,IndexedDB缓存机制, 只需要初始化配置好相应的参数,然后设置特效包地址等参数即可快速得到美颜美型美妆等渲染结果。
 CNveAssetPackageManager资源包管理器,管理视频场景中的资源包。 在SDK开发过中,资源包管理器统一对需要的各种特技资源包,包括字幕、动画贴纸等进行相应的安装,升级,卸载等操作。 在安装,升级,卸载时,出现差错都会有相应的错误提示类型,以便快速定位和解决错误。
 CNveCaption字幕是叠加在视频上的自定义文本。您可以添加并调整字幕位置。添加字幕后,还可以设置样式,包括字体大小、颜色、阴影、描边等。
 CNveCaptionSpan字幕layout属性类
 CNveColor自定义颜色类 SDK中,NveColor类属性r,g,b,a取值范围是[0,1],而非[0,255]。
 CNveCompoundCaption复合字幕。复合字幕是视频上叠加的组合型文字,每个复合字幕包含若干个子字幕。编辑视频时,可以添加并对字幕位置进行调整处理,还可以对字体,颜色属性进行修改。
 CNveEffectContext特效上下文 特效上下文类可视作Effect SDK框架的入口,可以通过nveGetEffectContextInstance()获取全局唯一的实例对象。
 CNveEffectInstance特效实例
 CNveMotionParameters运动参数
 CNvePointF二维坐标点结构。 参数类型为双精度浮点数。
 CNveRational比例值
 CNveRectF矩形类
 CNveRenderTask渲染任务
 CNveVectorVal对象类型数组
 CNveVideoTransition视频转场,片段间切换的特效。轨道上有多个片段,转场是从一个视频片段播放到另一个视频片段的衔接过渡效果,而在有间隙的片段之间不能添加视频转场。目前支持多种视频转场, 包括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(斜推)。每种视频转场都可通过视频轨道来设置和获取。默认转场是Fade(淡入淡出)。
 CNveVolume音量类,设置音量的左右声道
 CNvsAIToningInfoAI调色信息
 CNvsAnimatedSticker动画贴纸类。动画贴纸是视频编辑时使用的一种美化特效,可以产生动画效果。 用户可以在时间线上添加和移除动画贴纸,也可以通过各种API调整贴纸的各种属性,如位置、大小、显示时间等等。
 CNvsARSceneManipulateARScene 操作。
 CNvsAssetPackageManager资源包管理器,管理视频场景中的资源包。 在SDK开发过中,资源包管理器统一对需要的各种特技资源包,包括字幕、动画贴纸等进行相应的安装,升级,卸载等操作。 在安装,升级,卸载时,出现差错都会有相应的错误提示类型,以便快速定位和解决错误。
 CNvsAssetPackageParticleDescParser粒子特效包解析类
 CNvsAudioClip音频片段,对音频文件的描述。音频片段既可以修改其裁剪入点和出点,播放速度等,还可以添加、插入、移除以及获取多个音频特效。
 CNvsAudioFileWriter音频文件写入器
 CNvsAudioFx音频特效。音频特效是叠加显示在音频片段上的特效,可以改变音频片段的声调和速率。获取音频片段(Audio Clip)对象实例后,根据需要来添加或者移除多个音频特效。
 CNvsAudioResolution音频解析度
 CNvsAudioStreamInfo音频流信息
 CNvsAudioTrack音频轨道,音频片段的集合。音频轨道是容纳音频片段的实体。每条音频轨道可以添加或者移除多个音频片段。一个音频片段播放到另一个音频片段时,需要进行音频转场设置,以便过渡衔接。注:对于音频轨道的一系列接口及所其属参数含义,请参照视频轨道NvsVideoTrack的对应接口来对照理解。
 CNvsAudioTransition音频转场,音频片段间切换的特效。一般通过音频轨道(Audio Track)来设置和获取音频转场。目前默认音频转场是淡入淡出转场(fade)。
 CNvsAVFileInfo音视频文件信息。显示音视频文件的信息,包括音视频文件的时长,数据速率,像素横纵比,音视频流数目等。
 CNvsCaption时间线字幕是叠加在视频上的自定义文本。编辑视频时,您可以添加和删除时间线字幕并调整字幕位置。添加字幕后,还可以设置样式,包括字体大小、颜色、阴影、描边等。
 CNvsCaptionBoundingVerticesInfo字幕的原始包围矩形的顶点位置信息类
 CNvsCaptionSpan字幕layout属性类
 CNvsClip片段,音视频文件的具体描述。片段是容纳音视频内容的实体,是对视频、音频文件的描述,分为音频片段(Audio Clip)和视频片段(Video Clip)。它定义了不同类型片段所拥有的共同属性和行为, 即派生的音频片段和和视频片段可根据需要修改各自的裁剪出入点,左右声道,播放速度等。在SDK框架中,在轨道(Track)上可添加相应的音频片段和视频片段。
 CNvsClipAnimatedSticker片段动画贴纸
 CNvsClipBoundingVerticesInfo视频片段的原始包围矩形的顶点位置信息类
 CNvsClipCaption片段字幕
 CNvsClipCompoundCaption片段组合字幕
 CNvsColor自定义颜色类 SDK中,NvsColor类属性r,g,b,a取值范围是[0,1],而非[0,255]。
 CNvsCompoundCaption时间线复合字幕。时间线复合字幕是视频上叠加的组合型文字,每个复合字幕包含若干个子字幕。编辑视频时,可以添加和移除时间线复合字幕,并对字幕位置进行调整处理,还可以对字体,颜色属性进行修改。
 CNvsCurveInfo曲线信息类
 CNvsEmitterCurveInfo粒子发射器曲线信息类
 CNvsEventEmitter事件发射器
 CNvsFx特效类。特效类是视频特效(Video Fx),音频特效(Audio Fx),音频转场(Audio Transition),视频转场(Video Transition)等不同类型特效的基类。 在SDK框架中,特效是很关键的一部分,派生自NvsFx的每种不同类型的特效,或通过片段实例,或时间线实例,或轨道实例来添加,移除和获取。 同时,特效类中提供了不同的API接口来设置和获取特效参数类型。\
 CNvsFxDescription特效参数描述类。在视频拍摄和编辑时会设置各种不同参数类型的特效,特效参数描述类就是专门用来获取各种特效参数值的,以便查看和了解。
 CNvsKeyframeParamInfo关键帧参数类
 CNvsLiveWindow视频预览窗口
 CNvsMotionParameters运动参数
 CNvsPanAndScan遥感扫描类
 CNvsParamInfoObject参数信息对象类
 CNvsParticleEmitterDesc粒子发生器描述文件类。包含该粒子发生器放置的位置以及其子粒子发生器名称列表
 CNvsParticleSystemContext粒子特效上下文 粒子系统的由若干粒子发生器和子粒子发生器构成。粒子发生器会随着时间推移不断发射出粒子,而子粒子发生器则会在粒子发生器发射出的粒子上面发射出粒子。
 CNvsPlaybackRateControlRegion播放速率控制区域
 CNvsPointF二维坐标点结构。 参数类型为双精度浮点数。
 CNvsProjObj工程对象
 CNvsRational比例值
 CNvsRectF矩形类
 CNvsRegionInfo区域信息类
 CNvsSdkVersionSDK版本号
 CNvsStreamingContext流媒体上下文:流媒体上下文类可视作整个SDK框架的入口。开发过程中,NvsStreamingContext提供了静态sharedInstance接口创建流媒体上下文的唯一实例。 通过这个实例对象,我们可以开启采集设备录制视频,添加采集视频特效,设置拍摄时的各项参数,包括自动聚焦,自动曝光调节, 开关换补光灯等。同时还能够创建时间线,并将时间线与实时预览窗口连接起来,实时预览播放已经拍摄完成的视频。整个视频制作完成后,要销毁流媒体上下文的对象实例。 带特效拍摄时,添加素材资源包(采集特效包,场景资源包等),都得先安装,安装成功后获取packageId才能使用,而内建采集特效(builtin)只需获取特效名称即可使用。sdk接口中凡是需要传入资源、授权等文件路径时一定是全路径。
 CNvsTemplateCaptionDesc模板资源包里footage对应的字幕信息
 CNvsTemplateCompoundCaptionDesc模板资源包里footage包含的全部组合字幕信息
 CNvsTemplateCompoundCaptionItemDesc模板资源包里footage对应的组合字幕信息
 CNvsTemplateFootageCorrespondingClipInfo模板资源包里footage对应的片段信息
 CNvsTemplateFootageDesc模板资源包里footage信息(TEIMPLATE_FOOTAGE_TYPE)
 CNvsTimeline时间线类:编辑场景的时间轴实体,时间线由轨道组成,可视作一系列音视频轨道的集合。在时间线上可添加或者移除多条视频轨道和音轨轨道,多条轨道之间是相互叠加合成的关系。 当编辑视频时,根据需要还会添加上时间线字幕,主题以及相应的动画贴纸,以制作出美观的视频。另外,添加素材资源包(主题包,动画贴纸包,字幕样式包,时间线特效包等), 都得先安装,安装成功后获取packageId才能使用,而内建时间线特效(builtin)只需获取特效名称即可使用。
 CNvsTimelineAnimatedSticker时间线动画贴纸类。
 CNvsTimelineCaption时间线字幕是视频上叠加的自定义文字。编辑视频时,可以添加和移除时间线字幕,并对字幕位置进行调整处理。添加完字幕,还可以进行样式设置,包括字体大小,颜色,阴影,描边等。
 CNvsTimelineCompoundCaption时间线复合字幕。
 CNvsTimelineVideoFx时间线视频特效 时间线视频特效是作用于时间线实例上的视频特效。 时间线视频特效分为內建特效、包裹特效和自定义特效三种类型。 內建特效是集成在sdk内部的,不需要授权即可直接使用。包裹特效是将特效资源整合成了特效包,每个特效包都有其一一对应的授权文件,并且要先安装再使用,具体情况请参见素材包安装 自定义特效是用户通过编写代码实现的特效 时间线视频特效包含特效入点和出点,通过入点和出点我们可以指定特效作用于时间线的位置和长度,入点要小于出点,单位为微秒。 时间线视频特效允许叠加,渲染顺序通过预设Z值控制。
 CNvsTrack轨道类:轨道,容纳片段的结构。轨道可视作片段的集合,分为音频轨道(Audio Track)和视频轨道(Video Track)。创建时间线实例后,可添加或移除多条轨道。在每一条轨道上,可以添加多个要编辑的视音频片段,并对片段进行音量设置,也可以进行移除和位置移动。
 CNvsTrackAnimatedSticker轨道动画贴纸类。
 CNvsTrackCaption字幕轨道
 CNvsTrackCompoundCaption跟踪复合字幕。
 CNvsTrackVideoFx视频特效轨道
 CNvsTranslationInfo翻译信息类
 CNvsVectorFloat浮点类型数组
 CNvsVectorVal对象类型数组
 CNvsVideoClip视频片段,对视频文件的描述。视频片段源可以是视频或者图片。每个视频片段可以修改其裁剪入点、裁剪出点以及播放速度,也可以设置摇摄和扫描。编辑视频时,可以按特效类型的不同(内建特效,包裹式特效,美颜特效)添加或者插入多个视频特效。 添加资源包特效时,都得先安装,安装成功后获取packageId才能使用,而内建特效(builtin)只需获取特效名称即可使用。
 CNvsVideoCodecInfo视频编码信息
 CNvsVideoFx视频特效。视频特效是显示在视频片段上的特效,能够改变视频图像整体或者局部的颜色、亮度、透明度等,使视频显示出特殊的效果。在视频片段(Video Clip)上,可以添加、移除、获取多个视频特效。
 CNvsVideoResolution视频分辨率
 CNvsVideoStreamInfo视频流信息
 CNvsVideoTrack视频轨道类:视频片段的集合。视频轨道是容纳视频片段的实体,可以添加、插入、删移多个视频片段。视频轨道随着片段的增加不断延展,而片段与片段之间可进行视频转场设置。 添加包裹转场时,都得先安装,安装成功后获取packageId才能使用,而内建转场(builtin)只需获取转场名称即可使用。 注:视频片段的索引都是从0开始。
 CNvsVideoTransition视频转场,片段间切换的特效。轨道上有多个片段,转场是从一个视频片段播放到另一个视频片段的衔接过渡效果,而在有间隙的片段之间不能添加视频转场。目前支持多种视频转场, 包括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(斜推)。每种视频转场都可通过视频轨道(NvsVideoTrack)来设置和获取。默认转场是Fade(淡入淡出)。
 CNvsVolume音量类,设置音量的左右声道
 CNvsWatermarkInfo水印信息类
 CNvsXmlStreamReader读XML流
 CNvsXmlStreamWriterXML流书写类