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

类 NvsTimeline 继承关系图:

Public 成员函数
	constructor ()

	getVideoRes ()
	获取视频资源更多...

	getAudioRes ()
	获取音频资源更多...

	getDuration ()
	获取时间线时长更多...

	appendVideoTrack ()
	附加视频轨道更多...

	appendAudioTrack ()
	添加音频轨道更多...

	insertVideoTrack (insertPoint)
	插入视频轨道更多...

	insertAudioTrack (insertPoint)
	插入音频轨道更多...

	removeVideoTrack (trackIndex)
	删除视频轨道更多...

	removeAudioTrack (trackIndex)
	删除音频轨道更多...

	videoTrackCount ()
	获取视频轨道计数更多...

	audioTrackCount ()
	获取音频轨道计数更多...

	getVideoTrackByIndex (trackIndex)
	根据索引，获取视频轨道更多...

	getAudioTrackByIndex (trackIndex)
	根据索引，获取音频轨道更多...

	changeVideoSize (videoWidth, videoHeight)
	改变视频大小更多...

	changeVideoSize2 (videoWidth, videoHeight)
	改变视频大小更多...

	getFirstCaption ()
	获取第一个字幕更多...

	getLastCaption ()
	获取最后一个字幕更多...

	getPrevCaption (caption)
	获取上一个字幕更多...

	getNextCaption (caption)
	获取下一个字幕更多...

	getCaptionsByTimelinePosition (timelinePos)
	根据时间线位置获取字幕更多...

	addCaption (captionText, inPoint, duration, captionStylePackageId, isPanoramic)
	添加字幕更多...

	addModularCaption (captionText, inPoint, duration)
	添加模块化字幕更多...

	removeCaption (caption)
	删除字幕更多...

	getFirstCompoundCaption ()
	获取第一个复合字幕更多...

	getLastCompoundCaption ()
	获取时间线上最后一个复合字幕更多...

	getPrevCompoundCaption (caption)
	获取上一个复合字幕更多...

	getNextCompoundCaption (caption)
	获取下一个复合字幕更多...

	getCompoundCaptionsByTimelinePosition (timelinePos)
	根据时间线位置，获取复合字幕更多...

	addCompoundCaption (inPoint, duration, compoundCaptionPackageId)
	添加复合字幕更多...

	removeCompoundCaption (caption)
	删除复合字幕更多...

	getFirstAnimatedSticker ()
	获取第一个动画贴纸更多...

	getLastAnimatedSticker ()
	获取最后一个动画贴纸更多...

	getPrevAnimatedSticker (animatedSticker)
	获取上一个动画贴纸更多...

	getNextAnimatedSticker (animatedSticker)
	获取下一个动画贴纸更多...

	getAnimatedStickersByTimelinePosition (timelinePos)
	根据时间线位置获取动画贴纸更多...

	addAnimatedSticker (inPoint, duration, animatedStickerPackageId, isPanoramic, isCustom, customImagePath)
	添加动画贴纸更多...

	removeAnimatedSticker (animatedSticker)
	删除动画贴纸更多...

	getFirstTimelineVideoFx ()
	获取第一个时间线视频特效更多...

	getLastTimelineVideoFx ()
	获取最后时间线视频特效更多...

	getPrevTimelineVideoFx (timelineVideoFx)
	获取前一个时间线视频特效更多...

	getNextTimelineVideoFx (timelineVideoFx)
	获取下一个时间线视频特效更多...

	getTimelineVideoFxByTimelinePosition (timelinePos)
	根据时间线位置获取时间线视频特效更多...

	addBuiltinTimelineVideoFx (inPoint, duration, videoFxName)
	添加内置时间线视频特效更多...

	addPackagedTimelineVideoFx (inPoint, duration, videoFxPackageId)
	添加包时间线视频特效更多...

	removeTimelineVideoFx (timelineVideoFx)
	删除时间线视频特效更多...

	getCurrentThemeId ()
	获取当前主题ID 更多...

	applyTheme (themeId)
	应用主题更多...

	applyThemeTemplate (templateId)
	应用自适应持续时间模板。更多...

	removeCurrentTheme ()
	删除当前主题更多...

	setThemeTitleCaptionText (text)
	设置主题标题字幕文本更多...

	setThemeTrailerCaptionText (text)
	设置主题预报字幕文本更多...

	setThemeMusicVolumeGain (leftVolumeGain, rightVolumeGain)
	设置主题音乐音量增益更多...

	getThemeMusicVolumeGain ()
	获取主题音乐音量增益更多...

	setPlaybackRateControl (playbackRateControlRegions)
	设置播放速率控制更多...

	addWatermark (filePath, displayWidth, displayHeight, opacity, position, marginX, marginY)
	添加水印更多...

	addWatermark2 (sceneWidth, sceneHeight, imageName, imgWidth, imgHeight, tx, ty, dirPath, opacity)
	添加水印更多...

	deleteWatermark ()
	删除水印更多...

	setWatermarkOpacity (opacity)
	设置水印透明度更多...

	getWatermarkInfo ()
	获取水印信息更多...

	setMaxAudioStreamSupportedOnVideoTrack (maxStream)
	设置视频轨道支持的最大音频流更多...

	getMaxAudioStreamSupportedOnVideoTrack ()
	获得视频轨道支持的最大音频流更多...

	enableRenderOrderByZValue (enable)
	使用 Z 值作为渲染顺序。注意：有时间轴字幕、复合字幕、模块字幕、动画贴纸和时间轴过滤器如果同一类型的 Z 值相同，则与未启用该属性的排序方法相同如果 Z 值的不同类型相同，顺序为：时间线滤镜>动画贴纸>时间线标题（包括模块标题）>复合标题。更多...

	isRenderOrderByZValueEnabled ()
	是否开启使用 Z 值作为渲染顺序。更多...

	setVolumeGain (leftVolumeGain, rightVolumeGain)
	设置音量。更多...

	getVolumeGain ()
	获取音量信息。更多...

	getCreationFlags ()
	获取时间线标识。更多...

	getCaptionsBoundingVerticesRecursively (boundingType, timelinePosition)
	获取时间线某一位置所有字幕边框的顶点位置信息。更多...

	getVideoClipBoundingVerticesRecursively (timelinePosition)
	获取时间线某一位置所有字幕边框的顶点位置信息。更多...

Public 成员函数继承自 NvsProjObj
	constructor ()

	setInternalObject (obj)
	设置内置对象更多...

	getInternalObject ()
	获取内置对象更多...

	setTemplateAttachment (key, value)
	设置模板附件更多...

	getTemplateAttachment (key)
	根据键，获取模板属性值更多...

详细描述

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

参见: NvsProjObj

成员函数说明

◆ addAnimatedSticker()

NvsTimeline::addAnimatedSticker	(	inPoint,
		duration,
		animatedStickerPackageId,
		isPanoramic,
		isCustom,
		customImagePath
	)

inline

添加动画贴纸

参数

{Number}	inPoint 入点
{Number}	duration 持续时间
{String}	animatedStickerPackageId 动画贴纸包ID
{Boolean}	isPanoramic 是否是全景
{Boolean}	isCustom 是否自定制
{String}	customImagePath 自定制图片路径

返回

{NvsTimelineAnimatedSticker} 返回 NvsTimelineAnimatedSticker 对象。它会在以下情况下返回 null：

无动画贴纸功能授权；
animatedStickerPackageId 为空或null；
动画贴纸没有安装成功；
如果 inPoint 小于 0 或大于等于当前时间线持续时间，或者持续时间不大于 0。

◆ addBuiltinTimelineVideoFx()

NvsTimeline::addBuiltinTimelineVideoFx	(	inPoint,
		duration,
		videoFxName
	)

inline

添加内置时间线视频特效

参数

{Number}	inPoint 入点
{Number}	duration 持续时间
{String}	videoFxName 视频特效名字

返回

{NvsTimelineVideoFx} 返回 NvsTimelineVideoFx 对象它会在以下情况下返回 null：

videoFxName为空或null；
fx中没有内置videoFxName；
如果 inPoint 小于 0 或者大于等于当前时间线持续时间，或者持续时间不大于 0。

◆ addCaption()

NvsTimeline::addCaption	(	captionText,
		inPoint,
		duration,
		captionStylePackageId,
		isPanoramic
	)

inline

添加字幕

参数

{String}	captionText 字幕文本
{Number}	inPoint 入点
{Number}	duration 持续时间
{String}	captionStylePackageId 字幕风格包ID
{Boolean}	isPanoramic 是否是全景

返回

{NvsTimelineCaption} 返回 NvsTimelineCaption 对象。在以下情况下会返回null：

无字幕功能授权；
如果 inPoint 小于 0 或者大于等于当前时间线持续时间，或者持续时间不大于 0。

◆ addCompoundCaption()

NvsTimeline::addCompoundCaption	(	inPoint,
		duration,
		compoundCaptionPackageId
	)

inline

添加复合字幕

参数

{Number}	inPoint 入点
{Number}	duration 持续时间
{String}	compoundCaptionPackageId 组合字幕包ID

返回: {NvsTimelineCompoundCaption}

◆ addModularCaption()

NvsTimeline::addModularCaption	(	captionText,
		inPoint,
		duration
	)

inline

添加模块化字幕

参数

{String}	captionText 字幕文本
{Number}	inPoint 入点
{Number}	duration 持续时间

返回

{NvsTimelineCaption} 返回 NvsTimelineCaption 对象。它会在以下情况下返回 null： 1、无字幕功能授权；

如果 inPoint 小于 0 或者大于等于当前时间线持续时间，或者持续时间不大于 0。

◆ addPackagedTimelineVideoFx()

NvsTimeline::addPackagedTimelineVideoFx	(	inPoint,
		duration,
		videoFxPackageId
	)

inline

添加包时间线视频特效

参数

{Number}	inPoint 入点
{Number}	duration 持续时间
{String}	videoFxPackageId 视频特效包ID

返回

{NvsTimelineVideoFx} 返回 NvsTimelineVideoFx 对象它会在以下情况下返回 null：

无时间轴视频效果功能授权，如果是粒子效果，可能没有粒子效果功能授权；
videoFxPackageId 为空或 null；
videoFxPackage 没有安装成功；
如果 inPoint 小于 0 或大于等于当前时间线持续时间，或者持续时间不大于 0。

◆ addWatermark()

NvsTimeline::addWatermark	(	filePath,
		displayWidth,
		displayHeight,
		opacity,
		position,
		marginX,
		marginY
	)

inline

添加水印

参数

{String}	filePath 水印文件的路径必须是 .PNG 或 .JPG 或 .CAF 文件。
{Number}	displayWidth 时间线中显示的水印宽度。如果为 0，则使用图像文件的宽度。
{Number}	displayHeight 时间线中显示的水印高度。如果为 0，则使用图像文件的高度。
{Number}	opacity 水印不透明度，范围为[0,1]
{Number}	position 水印的位置
{Number}	marginX 水印在水平方向的边距
{Number}	marginY 水印在垂直方向的边距

返回: {}

◆ addWatermark2()

NvsTimeline::addWatermark2	(	sceneWidth,
		sceneHeight,
		imageName,
		imgWidth,
		imgHeight,
		tx,
		ty,
		dirPath,
		opacity
	)

inline

添加水印

参数

{Number}	sceneWidth
{Number}	sceneHeight
{String}	imageName
{Number}	imgWidth
{Number}	imgHeight
{Number}	tx
{Number}	ty
{String}	dirPath
{Number}	opacity

返回: {}

◆ appendAudioTrack()

NvsTimeline::appendAudioTrack ( )

inline

添加音频轨道

返回: {NvsAudioTrack} 返回附加的 NvsAudioTrack 对象。添加多个音轨时，由于多音轨授权，可能会返回null。该接口会导致流媒体引擎状态跳转到停止引擎状态。

◆ appendVideoTrack()

NvsTimeline::appendVideoTrack ( )

inline

附加视频轨道

返回: {NvsVideoTrack} 返回附加的 NvsVideoTrack 对象。添加多个视频轨道时，由于多视频轨道授权，可能会返回null。该接口会导致流媒体引擎状态跳转到停止引擎状态。

◆ applyTheme()

NvsTimeline::applyTheme ( themeId )

inline

应用主题

参数

{String} themeId 主题ID

返回: {Boolean} 确定主题是否应用成功。如果返回YES，则主题使用成功，NO 表示相反。它会在以下情况下返回 NO： 1.无主题功能授权； 2.主题包安装失败； 3.时间线上没有视频轨道。

◆ applyThemeTemplate()

NvsTimeline::applyThemeTemplate ( templateId )

inline

应用自适应持续时间模板。

参数

{String} templateId 唯一标识id

返回: {Boolean} 应用自适应持续时间模板。

◆ audioTrackCount()

NvsTimeline::audioTrackCount ( )

inline

获取音频轨道计数

返回: {Number} 返回音轨的计数。

◆ changeVideoSize()

NvsTimeline::changeVideoSize	(	videoWidth,
		videoHeight
	)

inline

改变视频大小

参数

{Number}	videoWidth 视频宽度
{Number}	videoHeight 视频高度

返回: {Boolean} 返回YES表示修改成功，NO表示修改失败。如果传入的width或height小于0或width不是4的倍数且height不是2的倍数，返回false。

◆ changeVideoSize2()

NvsTimeline::changeVideoSize2	(	videoWidth,
		videoHeight
	)

inline

改变视频大小

参数

{Number}	videoWidth 视频宽度
{Number}	videoHeight 视频高度

返回: {Boolean} 返回YES表示修改成功，NO表示修改失败。如果传入的width或height小于0或width不是4的倍数且height不是2的倍数，返回false。

◆ constructor()

NvsTimeline::constructor ( )

inline

@constructor

◆ deleteWatermark()

NvsTimeline::deleteWatermark ( )

inline

删除水印

返回: {}

◆ enableRenderOrderByZValue()

NvsTimeline::enableRenderOrderByZValue ( enable )

inline

使用 Z 值作为渲染顺序。注意：有时间轴字幕、复合字幕、模块字幕、动画贴纸和时间轴过滤器如果同一类型的 Z 值相同，则与未启用该属性的排序方法相同如果 Z 值的不同类型相同，顺序为：时间线滤镜>动画贴纸>时间线标题（包括模块标题）>复合标题。

参数

{Boolean} enable 启用与否

返回: {}

◆ getAnimatedStickersByTimelinePosition()

NvsTimeline::getAnimatedStickersByTimelinePosition ( timelinePos )

inline

根据时间线位置获取动画贴纸

参数

{Number} timelinePos 时间线位置

返回: {NvsVectorVal<NvsTimelineAnimatedSticker>} 返回一个包含当前位置动画贴纸对象的列表得到的动画贴纸列表排序规则如下： 1.添加时入点不同，动画贴图按入点顺序排列； 2.添加时，入点相同，按添加动画贴的顺序排列。

◆ getAudioRes()

NvsTimeline::getAudioRes ( )

inline

获取音频资源

返回: {NvsVideoResolution} 返回 NvsVideoResolution 对象

◆ getAudioTrackByIndex()

NvsTimeline::getAudioTrackByIndex ( trackIndex )

inline

根据索引，获取音频轨道

参数

{Number} trackIndex 轨道索引

返回: {NvsAudioTrack} 获取带有轨道索引的音轨。返回 NvsAudioTrack 对象。如果 trackIndex 小于 0 或大于等于当前轨道号，则返回 null。

◆ getCaptionsBoundingVerticesRecursively()

NvsTimeline::getCaptionsBoundingVerticesRecursively	(	boundingType,
		timelinePosition
	)

inline

获取时间线某一位置所有字幕边框的顶点位置信息。

参数

{NvsCaptionTextBoundingTypeEnum}	boundingType 边框类型
{Number}	timelinePosition 时间线位置

返回: {NvsVectorVal<NvsCaptionBoundingVerticesInfo>} NvsCaptionBoundingVerticesInfo信息的集合。

◆ getCaptionsByTimelinePosition()

NvsTimeline::getCaptionsByTimelinePosition ( timelinePos )

inline

根据时间线位置获取字幕

参数

{Number} timelinePos 时间线位置

返回: {NvsVectorVal<NvsTimelineCaption>} 返回当前位置的字幕数组列表。得到的字幕列表排序规则如下： 1.添加时，入点不同，字幕按入点顺序排列； 2.添加时，入点相同，字幕按照添加字幕的顺序排列。

◆ getCompoundCaptionsByTimelinePosition()

NvsTimeline::getCompoundCaptionsByTimelinePosition ( timelinePos )

inline

根据时间线位置，获取复合字幕

参数

{Number} timelinePos 时间线位置

返回: {NvsVectorVal<NvsTimelineCompoundCaption>} 返回当前位置的复合字幕列表。获取到的字幕列表排序规则如下： 1.如果入点不同，字幕按入点排序； 2.如果入点相同，则字幕按照添加复合字幕的顺序排列。

◆ getCreationFlags()

NvsTimeline::getCreationFlags ( )

inline

获取时间线标识。

返回: {Number} 时间线标识。

◆ getCurrentThemeId()

NvsTimeline::getCurrentThemeId ( )

inline

获取当前主题ID

返回: {String} 当前主题 id，如果没有主题，则返回空字符串。

◆ getDuration()

NvsTimeline::getDuration ( )

inline

获取时间线时长

返回: {Number} 返回时间线的持续时间（以微秒为单位）。

◆ getFirstAnimatedSticker()

NvsTimeline::getFirstAnimatedSticker ( )

inline

获取第一个动画贴纸

返回: {NvsTimelineAnimatedSticker} 返回获取到的 NvsTimelineAnimatedSticker 对象。

◆ getFirstCaption()

NvsTimeline::getFirstCaption ( )

inline

获取第一个字幕

返回: {NvsTimelineCaption} 返回 NvsTimelineCaption 对象。

◆ getFirstCompoundCaption()

NvsTimeline::getFirstCompoundCaption ( )

inline

获取第一个复合字幕

返回: {NvsTimelineCompoundCaption} 返回复合字幕对象。

◆ getFirstTimelineVideoFx()

NvsTimeline::getFirstTimelineVideoFx ( )

inline

获取第一个时间线视频特效

返回: {NvsTimelineVideoFx} 返回获取的 NvsTimelineVideoFx 对象。

◆ getLastAnimatedSticker()

NvsTimeline::getLastAnimatedSticker ( )

inline

获取最后一个动画贴纸

返回: {NvsTimelineAnimatedSticker} 返回获取到的 NvsTimelineAnimatedSticker 对象。

◆ getLastCaption()

NvsTimeline::getLastCaption ( )

inline

获取最后一个字幕

返回: {NvsTimelineCaption} 返回 NvsTimelineCaption 对象。

◆ getLastCompoundCaption()

NvsTimeline::getLastCompoundCaption ( )

inline

获取时间线上最后一个复合字幕

返回: {NvsTimelineCompoundCaption} 返回复合字幕对象。

◆ getLastTimelineVideoFx()

NvsTimeline::getLastTimelineVideoFx ( )

inline

获取最后时间线视频特效

返回: {NvsTimelineVideoFx} 返回获取的 NvsTimelineVideoFx 对象。

◆ getMaxAudioStreamSupportedOnVideoTrack()

NvsTimeline::getMaxAudioStreamSupportedOnVideoTrack ( )

inline

获得视频轨道支持的最大音频流

返回: {Number}

◆ getNextAnimatedSticker()

NvsTimeline::getNextAnimatedSticker ( animatedSticker )

inline

获取下一个动画贴纸

参数

{NvsTimelineAnimatedSticker} animatedSticker 动画贴纸对象

返回: {NvsTimelineAnimatedSticker} 返回获取到的 NvsTimelineAnimatedSticker 对象。

◆ getNextCaption()

NvsTimeline::getNextCaption ( caption )

inline

获取下一个字幕

参数

{NvsTimelineCaption} caption 字幕

返回: {NvsTimelineCaption} 返回 NvsTimelineCaption 对象。

◆ getNextCompoundCaption()

NvsTimeline::getNextCompoundCaption ( caption )

inline

获取下一个复合字幕

参数

{NvsTimelineCompoundCaption} caption 字幕对象

返回: {NvsTimelineCompoundCaption} 返回复合字幕对象。

◆ getNextTimelineVideoFx()

NvsTimeline::getNextTimelineVideoFx ( timelineVideoFx )

inline

获取下一个时间线视频特效

参数

{NvsTimelineVideoFx} timelineVideoFx 时间线视频特效

返回: {NvsTimelineVideoFx} 返回获取的 NvsTimelineVideoFx 对象。

◆ getPrevAnimatedSticker()

NvsTimeline::getPrevAnimatedSticker ( animatedSticker )

inline

获取上一个动画贴纸

参数

{NvsTimelineAnimatedSticker} animatedSticker 动画贴纸

返回: {NvsTimelineAnimatedSticker} 获取时间线上的最后一个动画贴纸。

◆ getPrevCaption()

NvsTimeline::getPrevCaption ( caption )

inline

获取上一个字幕

参数

{NvsTimelineCaption} caption 字幕

返回: {NvsTimelineCaption} 返回 NvsTimelineCaption 对象。

◆ getPrevCompoundCaption()

NvsTimeline::getPrevCompoundCaption ( caption )

inline

获取上一个复合字幕

参数

{NvsTimelineCompoundCaption} caption 字幕对象

返回: {NvsTimelineCompoundCaption} 返回复合字幕对象。

◆ getPrevTimelineVideoFx()

NvsTimeline::getPrevTimelineVideoFx ( timelineVideoFx )

inline

获取前一个时间线视频特效

参数

{NvsTimelineVideoFx} timelineVideoFx 时间线视频特效

返回: {NvsTimelineVideoFx} 返回获取的 NvsTimelineVideoFx 对象。

◆ getThemeMusicVolumeGain()

NvsTimeline::getThemeMusicVolumeGain ( )

inline

获取主题音乐音量增益

返回: {NvsVolume} 返回 NvsVolume 对象。

◆ getTimelineVideoFxByTimelinePosition()

NvsTimeline::getTimelineVideoFxByTimelinePosition ( timelinePos )

inline

根据时间线位置获取时间线视频特效

参数

{Number} timelinePos 时间线位置

返回: {NvsVectorVal<NvsTimelineVideoFx>} 返回当前位置的时间线视频效果列表。获取的时间线视频效果排序规则如下： 1.添加时，入点不同，按入点顺序排列； 2.添加时，入点相同，按照添加时间线视频特效的顺序排列。

◆ getVideoClipBoundingVerticesRecursively()

NvsTimeline::getVideoClipBoundingVerticesRecursively ( timelinePosition )

inline

获取时间线某一位置所有字幕边框的顶点位置信息。

参数

{Number} timelinePosition 时间线位置

返回: {NvsVectorVal<NvsClipBoundingVerticesInfo>} NvsClipBoundingVerticesInfo信息的集合。

◆ getVideoRes()

NvsTimeline::getVideoRes ( )

inline

获取视频资源

返回: {NvsVideoResolution} 返回 NvsVideoResolution 对象

◆ getVideoTrackByIndex()

NvsTimeline::getVideoTrackByIndex ( trackIndex )

inline

根据索引，获取视频轨道

参数

{Number} trackIndex 轨道索引

返回: {NvsVideoTrack} 返回 NvsVideoTrack 对象。如果 trackIndex 小于 0 或大于等于当前轨道号，则返回 null。

◆ getVolumeGain()

NvsTimeline::getVolumeGain ( )

inline

获取音量信息。

返回: {NvsVolume} 返回音量增益对象。

◆ getWatermarkInfo()

NvsTimeline::getWatermarkInfo ( )

inline

获取水印信息

返回: {NvsWatermarkInfo}

◆ insertAudioTrack()

NvsTimeline::insertAudioTrack ( insertPoint )

inline

插入音频轨道

参数

{Number} insertPoint 插入点

返回: {NvsAudioTrack} 返回附加的 NvsAudioTrack 对象。添加多个音轨时，由于多音轨授权，可能会返回null。

◆ insertVideoTrack()

NvsTimeline::insertVideoTrack ( insertPoint )

inline

插入视频轨道

参数

{Number} insertPoint 插入点

返回: {NvsVideoTrack} 返回插入的 NvsVideoTrack 对象。添加多个视频轨道时，由于多视频轨道授权，可能会返回null。该接口会导致流媒体引擎状态跳转到停止引擎状态。

◆ isRenderOrderByZValueEnabled()

NvsTimeline::isRenderOrderByZValueEnabled ( )

inline

是否开启使用 Z 值作为渲染顺序。

返回: {Boolean} 返回 True 表示已开启，否则不开启

◆ removeAnimatedSticker()

NvsTimeline::removeAnimatedSticker ( animatedSticker )

inline

删除动画贴纸

参数

{NvsTimelineAnimatedSticker} animatedSticker 动画贴纸

返回: {NvsTimelineAnimatedSticker} 返回下一个 NvsTimelineAnimatedSticker 对象。

◆ removeAudioTrack()

NvsTimeline::removeAudioTrack ( trackIndex )

inline

删除音频轨道

参数

{Number} trackIndex 轨道索引

返回: {Boolean} 返回一个BOOL值。YES表示删除成功，NO表示失败。如果trackIndex小于0或大于等于当前轨道号，返回NO。

◆ removeCaption()

NvsTimeline::removeCaption ( caption )

inline

删除字幕

参数

{NvsTimelineCaption} caption 字幕对象

返回: {NvsTimelineCaption} 返回下一个 NvsTimelineCaption 对象。

◆ removeCompoundCaption()

NvsTimeline::removeCompoundCaption ( caption )

inline

删除复合字幕

参数

{NvsTimelineCompoundCaption} caption 字幕对象

返回: {NvsTimelineCompoundCaption} 返回下一个复合字幕对象。

◆ removeCurrentTheme()

NvsTimeline::removeCurrentTheme ( )

inline

删除当前主题

返回: {}

◆ removeTimelineVideoFx()

NvsTimeline::removeTimelineVideoFx ( timelineVideoFx )

inline

删除时间线视频特效

参数

{NvsTimelineVideoFx} timelineVideoFx 时间线视频特效

返回: {NvsTimelineVideoFx} 返回已移除的当前时间线视频特效的下一个 NvsTimelineVideoFx 对象。

◆ removeVideoTrack()

NvsTimeline::removeVideoTrack ( trackIndex )

inline

删除视频轨道

参数

{Number} trackIndex 轨道索引

返回: {Boolean} 返回一个布尔值。YES表示删除成功，NO表示失败。如果trackIndex小于0或大于等于当前轨道号，返回NO。

◆ setMaxAudioStreamSupportedOnVideoTrack()

NvsTimeline::setMaxAudioStreamSupportedOnVideoTrack ( maxStream )

inline

设置视频轨道支持的最大音频流

参数

{Number} maxStream 最大流数量

返回: {}

◆ setPlaybackRateControl()

NvsTimeline::setPlaybackRateControl ( playbackRateControlRegions )

inline

设置播放速率控制

参数

{NvsVectorVal} playbackRateControlRegions 播放速率控制区域

返回: {}

◆ setThemeMusicVolumeGain()

NvsTimeline::setThemeMusicVolumeGain	(	leftVolumeGain,
		rightVolumeGain
	)

inline

设置主题音乐音量增益

参数

{Number}	leftVolumeGain 左音量增益
{Number}	rightVolumeGain 右音量增益

返回: {}

◆ setThemeTitleCaptionText()

NvsTimeline::setThemeTitleCaptionText ( text )

inline

设置主题标题字幕文本

参数

{String} text 文本

返回: {}

◆ setThemeTrailerCaptionText()

NvsTimeline::setThemeTrailerCaptionText ( text )

inline

设置主题预报字幕文本

参数

{String} text 文本

返回: {}

◆ setVolumeGain()

NvsTimeline::setVolumeGain	(	leftVolumeGain,
		rightVolumeGain
	)

inline

设置音量。

参数

{Number}	leftVolumeGain 左声道音量增益
{Number}	rightVolumeGain 右声道音量增益

返回: {}

◆ setWatermarkOpacity()

NvsTimeline::setWatermarkOpacity ( opacity )

inline

设置水印透明度

参数

{Number} opacity 不透明度

返回: {Boolean} 不透明度，范围是[0,1]

◆ videoTrackCount()

NvsTimeline::videoTrackCount ( )

inline

获取视频轨道计数

返回: {Number} 返回视频轨道的计数。

该类的文档由以下文件生成:

src/js/NvStreamingSdk.js

Public 成员函数

详细描述

成员函数说明

◆ addAnimatedSticker()

◆ addBuiltinTimelineVideoFx()

◆ addCaption()

◆ addCompoundCaption()

◆ addModularCaption()

◆ addPackagedTimelineVideoFx()

◆ addWatermark()

◆ addWatermark2()

◆ appendAudioTrack()

◆ appendVideoTrack()

◆ applyTheme()

◆ applyThemeTemplate()

◆ audioTrackCount()

◆ changeVideoSize()

◆ changeVideoSize2()

◆ constructor()

◆ deleteWatermark()

◆ enableRenderOrderByZValue()

◆ getAnimatedStickersByTimelinePosition()

◆ getAudioRes()

◆ getAudioTrackByIndex()

◆ getCaptionsBoundingVerticesRecursively()

◆ getCaptionsByTimelinePosition()

◆ getCompoundCaptionsByTimelinePosition()

◆ getCreationFlags()

◆ getCurrentThemeId()

◆ getDuration()

◆ getFirstAnimatedSticker()

◆ getFirstCaption()

◆ getFirstCompoundCaption()

◆ getFirstTimelineVideoFx()

◆ getLastAnimatedSticker()

◆ getLastCaption()

◆ getLastCompoundCaption()

◆ getLastTimelineVideoFx()

◆ getMaxAudioStreamSupportedOnVideoTrack()

◆ getNextAnimatedSticker()

◆ getNextCaption()

◆ getNextCompoundCaption()

◆ getNextTimelineVideoFx()

◆ getPrevAnimatedSticker()

◆ getPrevCaption()

◆ getPrevCompoundCaption()

◆ getPrevTimelineVideoFx()

◆ getThemeMusicVolumeGain()

◆ getTimelineVideoFxByTimelinePosition()

◆ getVideoClipBoundingVerticesRecursively()

◆ getVideoRes()

◆ getVideoTrackByIndex()

◆ getVolumeGain()

◆ getWatermarkInfo()

◆ insertAudioTrack()

◆ insertVideoTrack()

◆ isRenderOrderByZValueEnabled()

◆ removeAnimatedSticker()

◆ removeAudioTrack()

◆ removeCaption()

◆ removeCompoundCaption()

◆ removeCurrentTheme()

◆ removeTimelineVideoFx()

◆ removeVideoTrack()

◆ setMaxAudioStreamSupportedOnVideoTrack()

◆ setPlaybackRateControl()

◆ setThemeMusicVolumeGain()

◆ setThemeTitleCaptionText()

◆ setThemeTrailerCaptionText()

◆ setVolumeGain()

◆ setWatermarkOpacity()

◆ videoTrackCount()