Class: NvsTimeline

NvsTimeline()

时间线类：编辑场景的时间轴实体，时间线由轨道组成，可视作一系列音视频轨道的集合。在时间线上可添加或者移除多条视频轨道和音轨轨道，多条轨道之间是相互叠加合成的关系。 当编辑视频时，根据需要还会添加上时间线字幕，主题以及相应的动画贴纸，以制作出美观的视频。另外，添加素材资源包(主题包，动画贴纸包，字幕样式包，时间线特效包等)， 都得先安装，安装成功后获取packageId才能使用，而内建时间线特效(builtin)只需获取特效名称即可使用。

Constructor

new NvsTimeline()

Source:

Extends

Methods

addAnimatedSticker(inPoint, duration, animatedStickerPackageId, isPanoramic, isCustom, customImagePath) → {Num}

添加动画贴纸
Parameters:
Name Type Description
inPoint 入点
duration 持续时间
animatedStickerPackageId 动画贴纸包ID
isPanoramic 是否是全景
isCustom 是否自定制
customImagePath 自定制图片路径
Source:
Returns:
Type
Num

addBuiltinTimelineVideoFx(inPoint, duration, videoFxName) → {Num}

添加内置时间线视频特效
Parameters:
Name Type Description
inPoint 入点
duration 持续时间
videoFxName 视频特效名字
Source:
Returns:
Type
Num

addCaption(captionText, inPoint, duration, captionStylePackageId, isPanoramic) → {Num}

添加字幕
Parameters:
Name Type Description
captionText 字幕文本
inPoint 入点
duration 持续时间
captionStylePackageId 字幕风格包ID
isPanoramic 是否是全景
Source:
Returns:
Type
Num

addCompoundCaption(inPoint, duration, compoundCaptionPackageId) → {Num}

添加复合字幕
Parameters:
Name Type Description
inPoint 入点
duration 持续时间
compoundCaptionPackageId 组合字幕包ID
Source:
Returns:
Type
Num

addModularCaption(captionText, inPoint, duration) → {Num}

添加模块化字幕
Parameters:
Name Type Description
captionText 字幕文本
inPoint 入点
duration 持续时间
Source:
Returns:
Type
Num

addPackagedTimelineVideoFx(inPoint, duration, videoFxPackageId) → {Num}

添加包时间线视频特效
Parameters:
Name Type Description
inPoint 入点
duration 持续时间
videoFxPackageId 视频特效包ID
Source:
Returns:
Type
Num

addWatermark(filePath, displayWidth, displayHeight, opacity, position, marginX, marginY) → {Num}

添加水印
Parameters:
Name Type Description
filePath 文件路径
displayWidth 显示宽度
displayHeight 显示高度
opacity 不透明度
position 位置
marginX X边界
marginY Y边界
Source:
Returns:
Type
Num

addWatermark2(sceneWidth, sceneHeight, imageName, imgWidth, imgHeight, tx, ty, dirPath, opacity) → {Num}

添加水印
Parameters:
Name Type Description
sceneWidth
sceneHeight
imageName
imgWidth
imgHeight
tx
ty
dirPath
opacity
Source:
Returns:
Type
Num

appendAudioTrack() → {Num}

添加音频轨道
Source:
Returns:
Type
Num

appendVideoTrack() → {Num}

附加视频轨道
Source:
Returns:
Type
Num

applyTheme(themeId) → {Num}

应用主题
Parameters:
Name Type Description
themeId 主题ID
Source:
Returns:
Type
Num

audioTrackCount() → {Num}

获取音频轨道计数
Source:
Returns:
Type
Num

changeVideoSize(videoWidth, videoHeight) → {Num}

改变视频大小
Parameters:
Name Type Description
videoWidth 视频宽度
videoHeight 视频高度
Source:
Returns:
Type
Num

changeVideoSize2(videoWidth, videoHeight) → {Num}

改变视频大小
Parameters:
Name Type Description
videoWidth 视频宽度
videoHeight 视频高度
Source:
Returns:
Type
Num

deleteWatermark() → {Num}

删除水印
Source:
Returns:
Type
Num

getAnimatedStickersByTimelinePosition(timelinePos) → {Num}

根据时间线位置获取动画贴纸
Parameters:
Name Type Description
timelinePos 时间线位置
Source:
Returns:
Type
Num

getAudioRes() → {Num}

获取音频资源
Source:
Returns:
Type
Num

getAudioTrackByIndex(trackIndex) → {Num}

根据索引，获取音频轨道
Parameters:
Name Type Description
trackIndex 轨道索引
Source:
Returns:
Type
Num

getCaptionsByTimelinePosition(timelinePos) → {Num}

根据时间线位置获取字幕
Parameters:
Name Type Description
timelinePos 时间线位置
Source:
Returns:
Type
Num

getCompoundCaptionsByTimelinePosition(timelinePos) → {Num}

根据时间线位置，获取复合字幕
Parameters:
Name Type Description
timelinePos 时间线位置
Source:
Returns:
Type
Num

getCurrentThemeId() → {Num}

获取当前主题ID
Source:
Returns:
Type
Num

getDuration() → {Num}

获取时间线时长
Source:
Returns:
Type
Num

getFirstAnimatedSticker() → {Num}

获取第一个动画贴纸
Source:
Returns:
Type
Num

getFirstCaption() → {Num}

获取第一个字幕
Source:
Returns:
Type
Num

getFirstCompoundCaption() → {Num}

获取第一个复合字幕
Source:
Returns:
Type
Num

getFirstTimelineVideoFx() → {Num}

获取第一个时间线视频特效
Source:
Returns:
Type
Num

getInternalObject() → {Num}

获取内置对象
Overrides:
Source:
Returns:
Type
Num

getLastAnimatedSticker() → {Num}

获取最后一个动画贴纸
Source:
Returns:
Type
Num

getLastCaption() → {Num}

获取最后一个字幕
Source:
Returns:
Type
Num

getLastCompoundCaption() → {Num}

获取最后一个复合字幕
Source:
Returns:
Type
Num

getLastTimelineVideoFx() → {Num}

获取最后时间线视频特效
Source:
Returns:
Type
Num

getMaxAudioStreamSupportedOnVideoTrack() → {Num}

获得视频轨道支持的最大音频流
Source:
Returns:
Type
Num

getNextAnimatedSticker(animatedSticker) → {Num}

获取下一个动画贴纸
Parameters:
Name Type Description
animatedSticker 动画贴纸对象
Source:
Returns:
Type
Num

getNextCaption(caption) → {Num}

获取下一个字幕
Parameters:
Name Type Description
caption 字幕
Source:
Returns:
Type
Num

getNextCompoundCaption(caption) → {Num}

获取下一个复合字幕
Parameters:
Name Type Description
caption 字幕对象
Source:
Returns:
Type
Num

getNextTimelineVideoFx(timelineVideoFx) → {Num}

获取下一个时间线视频特效
Parameters:
Name Type Description
timelineVideoFx 时间线视频特效
Source:
Returns:
Type
Num

getPrevAnimatedSticker(animatedSticker) → {Num}

获取上一个动画贴纸
Parameters:
Name Type Description
animatedSticker 动画贴纸
Source:
Returns:
Type
Num

getPrevCaption(caption) → {Num}

获取上一个字幕
Parameters:
Name Type Description
caption 字幕
Source:
Returns:
Type
Num

getPrevCompoundCaption(caption) → {Num}

获取上一个复合字幕
Parameters:
Name Type Description
caption 字幕对象
Source:
Returns:
Type
Num

getPrevTimelineVideoFx(timelineVideoFx) → {Num}

获取前一个时间线视频特效
Parameters:
Name Type Description
timelineVideoFx 时间线视频特效
Source:
Returns:
Type
Num

getTemplateAttachment(key) → {Num}

根据键，获取模板属性值
Parameters:
Name Type Description
key 键
Overrides:
Source:
Returns:
Type
Num

getThemeMusicVolumeGain() → {Num}

获取主题音乐音量增益
Source:
Returns:
Type
Num

getTimelineVideoFxByTimelinePosition(timelinePos) → {Num}

根据时间线位置获取时间线视频特效
Parameters:
Name Type Description
timelinePos 时间线位置
Source:
Returns:
Type
Num

getVideoRes() → {Num}

获取视频资源
Source:
Returns:
Type
Num

getVideoTrackByIndex(trackIndex) → {Num}

根据索引，获取视频轨道
Parameters:
Name Type Description
trackIndex 轨道索引
Source:
Returns:
Type
Num

getWatermarkInfo() → {Num}

获取水印信息
Source:
Returns:
Type
Num

insertAudioTrack(insertPoint) → {Num}

插入音频轨道
Parameters:
Name Type Description
insertPoint 插入点
Source:
Returns:
Type
Num

insertVideoTrack(insertPoint) → {Num}

插入视频轨道
Parameters:
Name Type Description
insertPoint 插入点
Source:
Returns:
Type
Num

removeAnimatedSticker(animatedSticker) → {Num}

删除动画贴纸
Parameters:
Name Type Description
animatedSticker 动画贴纸
Source:
Returns:
Type
Num

removeAudioTrack(trackIndex) → {Num}

删除音频轨道
Parameters:
Name Type Description
trackIndex 轨道索引
Source:
Returns:
Type
Num

removeCaption(caption) → {Num}

删除字幕
Parameters:
Name Type Description
caption 字幕对象
Source:
Returns:
Type
Num

removeCompoundCaption(caption) → {Num}

删除复合字幕
Parameters:
Name Type Description
caption 字幕对象
Source:
Returns:
Type
Num

removeCurrentTheme() → {Num}

删除当前主题
Source:
Returns:
Type
Num

removeTimelineVideoFx(timelineVideoFx) → {Num}

删除时间线视频特效
Parameters:
Name Type Description
timelineVideoFx 时间线视频特效
Source:
Returns:
Type
Num

removeVideoTrack(trackIndex) → {Num}

删除视频轨道
Parameters:
Name Type Description
trackIndex 轨道索引
Source:
Returns:
Type
Num

setInternalObject(obj) → {Num}

设置内置对象
Parameters:
Name Type Description
obj
Overrides:
Source:
Returns:
Type
Num

setMaxAudioStreamSupportedOnVideoTrack(maxStream) → {Num}

设置视频轨道支持的最大音频流
Parameters:
Name Type Description
maxStream 最大流数量
Source:
Returns:
Type
Num

setPlaybackRateControl(playbackRateControlRegions) → {Num}

设置播放速率控制
Parameters:
Name Type Description
playbackRateControlRegions 播放速率控制区域
Source:
Returns:
Type
Num

setTemplateAttachment(key, value) → {Num}

设置模板附件
Parameters:
Name Type Description
key 键
value 值
Overrides:
Source:
Returns:
Type
Num

setThemeMusicVolumeGain(leftVolumeGain, rightVolumeGain) → {Num}

设置主题音乐音量增益
Parameters:
Name Type Description
leftVolumeGain 左音量增益
rightVolumeGain 右音量增益
Source:
Returns:
Type
Num

setThemeTitleCaptionText(text) → {Num}

设置主题标题字幕文本
Parameters:
Name Type Description
text 文本
Source:
Returns:
Type
Num

setThemeTrailerCaptionText(text) → {Num}

设置主题预报字幕文本
Parameters:
Name Type Description
text 文本
Source:
Returns:
Type
Num

setWatermarkOpacity(opacity) → {Num}

设置水印透明度
Parameters:
Name Type Description
opacity 不透明度
Source:
Returns:
Type
Num

videoTrackCount() → {Num}

获取视频轨道计数
Source:
Returns:
Type
Num