流媒体上下文：流媒体上下文类可视作整个SDK框架的入口。开发过程中，NvsStreamingContext提供了静态sharedInstance接口创建流媒体上下文的唯一实例。通过这个实例对象，我们可以开启采集设备录制视频，添加采集视频特效，设置拍摄时的各项参数，包括自动聚焦，自动曝光调节，开关换补光灯等。同时还能够创建时间线，并将时间线与实时预览窗口连接起来，实时预览播放已经拍摄完成的视频。整个视频制作完成后，要销毁流媒体上下文的对象实例。带特效拍摄时，添加素材资源包(采集特效包，场景资源包等)，都得先安装，安装成功后获取packageId才能使用，而内建采集特效(builtin)只需获取特效名称即可使用。sdk接口中凡是需要传入资源、授权等文件路径时一定是全路径。更多...

Public 成员函数
	constructor ()

get	onStreamingEngineStateChanged ()
	流媒体引擎的状态变化更多...

set	onStreamingEngineStateChanged (fun)

get	onSeekingTimelinePosition ()

set	onSeekingTimelinePosition (fun)

	streamingEngineReadyForTimelineModification ()
	流媒体引擎准备好时间线修改更多...

	lastSeekingFinished ()

	verifySdkLicenseFile (requestUrl, type='')
	验证SDK许可文件更多...

	verifySdkLicenseFileWithExtraUserData (requestUrl, extraUserData)
	使用扩展用户数据验证SDK许可文件更多...

	getSdkVersion ()
	获取SDK版本号更多...

	createTimeline (videoRes, fps, audioRes, flags=0)
	创建时间线更多...

	createTemplateTimeline (templateId, templateFootages, flags=0)
	根据模板ID，创建模板时间线更多...

	createEmptyTemplateTimeline (videoRes, fps, audioRes, templateId, flags=0)
	创建空模板时间线更多...

	loadProject (projectId, resourceDir, flags=0)
	返回新建建时间线对象更多...

	removeTimeline (timeline)
	删除时间线更多...

	createLiveWindow (canvasId)
	根据画板ID，创建流媒体浏览窗口更多...

	removeLiveWindow (liveWindow)
	删除流媒体浏览窗口更多...

	connectTimelineWithLiveWindow (timeline, liveWindow)
	连接时间线到流媒体窗口更多...

	disconnectLiveWindow (liveWindow)
	将时间线与 LiveWindow 断开。更多...

	seekTimeline (timeline, timestamp, videoSizeMode, flags)
	定位某一时间戳的图像更多...

	seekTimelineWithProxyScale (timeline, timestamp, proxyScale, flags)
	定位某一时间戳的图像更多...

	playbackTimeline (timeline, startTime, endTime, videoSizeMode, preload, flags)
	播放时间线更多...

	playbackTimelineWithProxyScale (timeline, startTime, endTime, proxyScale, preload, flags)
	使用代理缩放播放时间线更多...

	stop ()
	流媒体上下文停止更多...

	getTimelineCurrentPosition (timeline)
	获取当前时间线位置更多...

	getStreamingEngineState ()
	获取流媒体引擎状态更多...

	getAssetPackageManager ()
	获取资源包管理器更多...

	getAVFileInfo (avFilePath, extraFlag)
	获取音视频文件信息更多...

	getLocalAVFileIcon (localAVFilePath, timestamp, iconFetched)
	启动一个获取本地视频文件缩略图的任务更多...

	getLocalAVFileIconFromCache (localAVFilePath, timestamp)
	从缓存中获取本地文件的缩略图更多...

	getLocalAVFileThumbnail (localAVFilePath, timestamp, bypassCache, thumbnailFetched)
	启动一个获取本地视频文件图标的任务更多...

	cancelLocalAVFileIconFetchingTask (iconFetchingTaskId)
	通过任务ID取消获取本地文件缩略图的任务更多...

	clearLocalAVFileIconCache ()
	清除所有本地文件的缩略图缓存

	getLocalAVFileWaveformData (localAVFilePath, sampleCountPerGroup, startGroupIndex, groupCount, waveformDataFetched)
	启动一个获取本地文件音频波形的任务更多...

	cancelLocalAVFileWaveformDataFetchingFetchingTask (waveformDataFetchingTaskId)
	通过任务ID取消获取本地文件波形的任务更多...

	clearLocalAVFileWaveformDataCache ()
	清除所有本地文件的波形缓存

	registerLocalFile (file)
	注册本地文件对象更多...

	unregisterLocalFile (localFileId)
	通过文件ID注销本地文件更多...

	registerFontByFilePath (fontFilePath)
	根据文件路径注册字体更多...

	getFontCompoundFamilyNameByFilePath (fontFilePath)
	获取字体文件的组合字族名称更多...

	grabImageFromTimeline (timeline, timestamp, proxyScale, flags)
	从时间轴抓取图像更多...

	setAudioOutputDeviceVolume (volume)
	设置音频输出设备音量更多...

	setMaxVideoFileReaderCount (count)
	设置最大的视频文件读取器数量更多...

	getMaxVideoFileReaderCount ()
	获取最大的视频文件读取器数量更多...

	setMaxImageReaderCount (count)
	设置最大的图片读取器数量更多...

	getMaxImageReaderCount ()
	获取最大的图片读取器数量更多...

	setMaxVideoDecodingThreadCount (count)
	设置最大视频解码线程数更多...

	functionalityAuthorised (sdkFunctionName)
	功能授权更多...

	setUseChineseLanguageOnly (useChineseLanguageOnly)
	设置只使用中文更多...

	isUseChineseLanguageOnly ()
	是否仅仅使用中文更多...

	initHumanDetection (modelFilePath, licenseFilePath, features)
	初始化人体检测机制，只需要初始化一次更多...

	initHumanDetectionExt (modelFilePath, licenseFilePath, features)
	初始化人体检测扩展机制，必须先调用initHumanDetection 更多...

	setupHumanDetectionData (dataType, dataFilePath)
	初始化人体检测相关数据包更多...

	closeHumanDetection ()
	关闭人体检测更多...

	calcDurationAfterCurvesVariableSpeed (curvesString)
	曲线变速后计算持续时间。更多...

	clearCachedResources ()
	清除缓存的资源。更多...

	preloadEffectResources ()
	预加载效果资源更多...

	notifyUpdateToWebReader (webAVFilePath)
	通知更新到网络阅读器更多...

	enableAudioVUMeter (enable)
	启用音频 VU 表更多...

	setDefaultCaptionFade (fade)
	是否开启字幕默认淡入淡出效果更多...

	isDefaultCaptionFade ()
	字幕默认淡入淡出效果是否已经开启更多...

	isDecoderConfigSupported (codecType, codecAcceleration)
	解码器是否支持此视频格式更多...

	getAutoToneParameters (imageData, width, height, isRawImage)
	获取自动音调参数更多...

详细描述

流媒体上下文：流媒体上下文类可视作整个SDK框架的入口。开发过程中，NvsStreamingContext提供了静态sharedInstance接口创建流媒体上下文的唯一实例。通过这个实例对象，我们可以开启采集设备录制视频，添加采集视频特效，设置拍摄时的各项参数，包括自动聚焦，自动曝光调节，开关换补光灯等。同时还能够创建时间线，并将时间线与实时预览窗口连接起来，实时预览播放已经拍摄完成的视频。整个视频制作完成后，要销毁流媒体上下文的对象实例。带特效拍摄时，添加素材资源包(采集特效包，场景资源包等)，都得先安装，安装成功后获取packageId才能使用，而内建采集特效(builtin)只需获取特效名称即可使用。sdk接口中凡是需要传入资源、授权等文件路径时一定是全路径。

成员函数说明

◆ calcDurationAfterCurvesVariableSpeed()

NvsStreamingContext::calcDurationAfterCurvesVariableSpeed ( curvesString )

inline

曲线变速后计算持续时间。

参数

curvesString 曲线字符串。

返回: {Number} 时长

◆ cancelLocalAVFileIconFetchingTask()

NvsStreamingContext::cancelLocalAVFileIconFetchingTask ( iconFetchingTaskId )

inline

通过任务ID取消获取本地文件缩略图的任务

参数

{Number} iconFetchingTaskId 任务ID

◆ cancelLocalAVFileWaveformDataFetchingFetchingTask()

NvsStreamingContext::cancelLocalAVFileWaveformDataFetchingFetchingTask ( waveformDataFetchingTaskId )

inline

通过任务ID取消获取本地文件波形的任务

参数

{Number} waveformDataFetchingTaskId 任务ID

◆ clearCachedResources()

NvsStreamingContext::clearCachedResources ( )

inline

清除缓存的资源。

返回: {}

◆ closeHumanDetection()

NvsStreamingContext::closeHumanDetection ( )

inline

关闭人体检测

返回: {}

◆ connectTimelineWithLiveWindow()

NvsStreamingContext::connectTimelineWithLiveWindow	(	timeline,
		liveWindow
	)

inline

连接时间线到流媒体窗口

参数

{NvsTimeline}	timeline 时间线
{NvsLiveWindow}	liveWindow 预览窗口

返回: {Boolean} 返回布尔值。 YES 表示连接成功，NO 表示相反。

◆ constructor()

NvsStreamingContext::constructor ( )

inline

@constructor

◆ createEmptyTemplateTimeline()

NvsStreamingContext::createEmptyTemplateTimeline	(	videoRes,
		fps,
		audioRes,
		templateId,
		flags = `0`
	)

inline

创建空模板时间线

参数

{NvsVideoResolution}	videoRes 视频解析度
{NvsRational}	fps 视频帧率
{NvsAudioResolution}	audioRes 音频解析度
{String}	templateId 模板ID
{Number}	flags 标识

返回: {NvsTimeline} 时间线对象

◆ createLiveWindow()

NvsStreamingContext::createLiveWindow ( canvasId )

inline

根据画板ID，创建流媒体浏览窗口

参数

{String} canvasId 画板ID

返回: {NvsLiveWindow} 流媒体预览窗口

◆ createTemplateTimeline()

NvsStreamingContext::createTemplateTimeline	(	templateId,
		templateFootages,
		flags = `0`
	)

inline

根据模板ID，创建模板时间线

参数

{String}	templateId 模板ID
{{NvsVectorVal<>}	templateFootages 模板素材
{Number}	flags 标识

返回: {NvsTimeline} 时间线对象

◆ createTimeline()

NvsStreamingContext::createTimeline	(	videoRes,
		fps,
		audioRes,
		flags = `0`
	)

inline

创建时间线

参数

{NvsVideoResolution}	videoRes 视频解析度
{NvsRational}	fps 视频帧率
{NvsAudioResolution}	audioRes 音频解析度
{Number}	flags 标识

返回: {NvsTimeline} 时间线对象

◆ disconnectLiveWindow()

NvsStreamingContext::disconnectLiveWindow ( liveWindow )

inline

将时间线与 LiveWindow 断开。

参数

{NvsLiveWindow} liveWindow 预览窗口

返回: {}

◆ enableAudioVUMeter()

NvsStreamingContext::enableAudioVUMeter ( enable )

inline

启用音频 VU 表

参数

{Boolean} enable 是否开启

返回: {}

◆ functionalityAuthorised()

NvsStreamingContext::functionalityAuthorised ( sdkFunctionName )

inline

功能授权

参数

{String} sdkFunctionName 函数名

返回: {Boolean} 返回一个 BOOL 值。 YES表示授权验证成功，NO表示验证失败。

◆ getAssetPackageManager()

NvsStreamingContext::getAssetPackageManager ( )

inline

获取资源包管理器

返回: {NvsAssetPackageManager} 返回资源包管理器对象。

◆ getAutoToneParameters()

NvsStreamingContext::getAutoToneParameters	(	imageData,
		width,
		height,
		isRawImage
	)

inline

获取自动音调参数

参数

{ImageData}	imageData 图片数据
{Number}	width 宽度
{Number}	height 高度
{Boolean}	isRawImage 是否原始图片

返回: {NvsAIToningInfo}

◆ getAVFileInfo()

NvsStreamingContext::getAVFileInfo	(	avFilePath,
		extraFlag
	)

inline

获取音视频文件信息

参数

{String}	avFilePath 音视频文件路径
{Number}	extraFlag 扩展标记

返回: {NvsAVFileInfo} 返回音视频文件信息对象，不支持文件格式返回null

◆ getFontCompoundFamilyNameByFilePath()

NvsStreamingContext::getFontCompoundFamilyNameByFilePath ( fontFilePath )

inline

获取字体文件的组合字族名称

参数

{String} fontFilePath 字体文件路径

返回: {String} 字体文件的组合字族名称

◆ getLocalAVFileIcon()

NvsStreamingContext::getLocalAVFileIcon	(	localAVFilePath,
		timestamp,
		iconFetched
	)

inline

启动一个获取本地视频文件缩略图的任务

参数

{String}	localAVFilePath 本地文件地址，例如：/localmedia/test.mp4.weblocal
{Number}	timestamp 获取缩略图的时间戳，单位为微秒
{Function}	iconFetched 获取成功的回调函数，回调函数中包含以下参数: imageData: 当前任务获取到的ImageData对象 localAVFilePath: 当前任务对应的本地文件地址 timestamp: 当前任务对应的时间戳，单位为微秒

返回: {Number} 返回当前任务的ID，如果返回0，表示启动任务失败

◆ getLocalAVFileIconFromCache()

NvsStreamingContext::getLocalAVFileIconFromCache	(	localAVFilePath,
		timestamp
	)

inline

从缓存中获取本地文件的缩略图

参数

{String}	localAVFilePath 本地文件地址，例如：/localmedia/test.mp4.weblocal
{Number}	timestamp 获取缩略图的时间戳，单位为微秒

返回: {ImageData} 获取到的ImageData对象

◆ getLocalAVFileThumbnail()

NvsStreamingContext::getLocalAVFileThumbnail	(	localAVFilePath,
		timestamp,
		bypassCache,
		thumbnailFetched
	)

inline

启动一个获取本地视频文件图标的任务

参数

{String}	localAVFilePath 本地文件地址，例如：/localmedia/test.mp4.weblocal
{Number}	timestamp 获取缩略图的时间戳，单位为微秒，如果设置-1，则按照sdk默认的规则获取
{Boolean}	bypassCache 是否绕过缓存获取
{Function}	thumbnailFetched 获取成功的回调函数，回调函数中包含以下参数: imageData: 当前任务获取到的ImageData对象 localAVFilePath: 当前任务对应的本地文件地址 timestamp: 当前任务对应的时间戳，单位为微秒

返回: {Number} 返回当前任务的ID，如果返回0，表示启动任务失败

◆ getLocalAVFileWaveformData()

NvsStreamingContext::getLocalAVFileWaveformData	(	localAVFilePath,
		sampleCountPerGroup,
		startGroupIndex,
		groupCount,
		waveformDataFetched
	)

inline

启动一个获取本地文件音频波形的任务

参数

{String}	localAVFilePath 本地文件地址，例如：/localmedia/test.mp4.weblocal
{Number}	sampleCountPerGroup 每组数据中包含的音频采样数量，每组数据包含波形的最小值和最大值
{Number}	startGroupIndex 开始的波形数据组索引
{Number}	groupCount 获取多少组波形数据，如果设置为-1，则表示获取到文件结尾
{Function}	waveformDataFetched 获取成功的回调函数，回调函数中包含以下参数: leftChannelData: 左声道波形的Float32Array数据类型对象，包含多组波形的最小值和最大值 rightChannelData: 右声道波形的Float32Array数据类型对象，包含多组波形的最小值和最大值 localAVFilePath: 本地文件地址，例如：/localmedia/test.mp4.weblocal sampleCountPerGroup: 当前任务每组数据中包含的音频采样数量 startGroupIndex: 当前任务开始的波形数据组索引

返回: {Number} 返回当前任务的ID，如果返回0，表示启动任务失败

◆ getMaxImageReaderCount()

NvsStreamingContext::getMaxImageReaderCount ( )

inline

获取最大的图片读取器数量

返回: {Number} 最大的图片读取器数量

◆ getMaxVideoFileReaderCount()

NvsStreamingContext::getMaxVideoFileReaderCount ( )

inline

获取最大的视频文件读取器数量

返回: {Number} 最大的视频文件读取器数量

◆ getSdkVersion()

NvsStreamingContext::getSdkVersion ( )

inline

获取SDK版本号

返回: {NvsSdkVersion} SDK版本号

◆ getStreamingEngineState()

NvsStreamingContext::getStreamingEngineState ( )

inline

获取流媒体引擎状态

返回: {Number} 返回流媒体引擎的状态。

◆ getTimelineCurrentPosition()

NvsStreamingContext::getTimelineCurrentPosition ( timeline )

inline

获取当前时间线位置

参数

{NvsTimeline} timeline 时间线

返回: {Number} 返回时间线的当前位置

◆ grabImageFromTimeline()

NvsStreamingContext::grabImageFromTimeline	(	timeline,
		timestamp,
		proxyScale,
		flags
	)

inline

从时间轴抓取图像

参数

{NvsTimeline}	timeline 时间线
{Number}	timestamp 时间戳
{NvsRational}	proxyScale 缩放代理
{Number}	flags 标记

返回: {UIImage} 返回图像帧的Bitmap对象对应的时间戳，如果抓帧失败返回null。

◆ initHumanDetection()

NvsStreamingContext::initHumanDetection	(	modelFilePath,
		licenseFilePath,
		features
	)

inline

初始化人体检测机制，只需要初始化一次

参数

{String}	modelFilePath 模型文件路径
{String}	licenseFilePath 授权文件路径
{Number}	features 人体检测特征标志字段，参看NvsHumanDetectionFeatureEnum

返回: {Boolean} 返回一个值，表示它是否成功。

参见: NvsStreamingContext#initHumanDetectionExt NvsStreamingContext#closeHumanDetection

◆ initHumanDetectionExt()

NvsStreamingContext::initHumanDetectionExt	(	modelFilePath,
		licenseFilePath,
		features
	)

inline

初始化人体检测扩展机制，必须先调用initHumanDetection

参数

{String}	modelFilePath 模型文件路径
{String}	licenseFilePath 授权文件路径
{Number}	features 人体检测特征标志字段，参看NvsHumanDetectionFeatureEnum

返回: {Boolean} 返回一个值，表示它是否成功。

参见: NvsStreamingContext#initHumanDetection NvsStreamingContext#setupHumanDetectionData

◆ isDecoderConfigSupported()

NvsStreamingContext::isDecoderConfigSupported	(	codecType,
		codecAcceleration
	)

inline

解码器是否支持此视频格式

返回: {Boolean} 是否支持

◆ isDefaultCaptionFade()

NvsStreamingContext::isDefaultCaptionFade ( )

inline

字幕默认淡入淡出效果是否已经开启

返回: {Boolean} 是否已经开启

◆ isUseChineseLanguageOnly()

NvsStreamingContext::isUseChineseLanguageOnly ( )

inline

是否仅仅使用中文

返回: {Boolean}

◆ loadProject()

NvsStreamingContext::loadProject	(	projectId,
		resourceDir,
		flags = `0`
	)

inline

返回新建建时间线对象

参数

{String}	projectId 项目唯一标识，必须先安装项目
{String}	resourceDir 项目素材库的资源目录
{Number}	flags 用于新建时间线的特殊标志。如无特殊要求请输入0。请参考 create timeline flag.

返回: {NvsTimeline} 返回新建的时间线对象

◆ notifyUpdateToWebReader()

NvsStreamingContext::notifyUpdateToWebReader ( webAVFilePath )

inline

通知更新到网络阅读器

参数

{String} webAVFilePath 网页音视频文件路径

返回: {Boolean}

◆ onSeekingTimelinePosition()

get NvsStreamingContext::onSeekingTimelinePosition ( )

inline

返回: {Object}

◆ onStreamingEngineStateChanged()

get NvsStreamingContext::onStreamingEngineStateChanged ( )

inline

流媒体引擎的状态变化

返回: {Object}

◆ playbackTimeline()

NvsStreamingContext::playbackTimeline	(	timeline,
		startTime,
		endTime,
		videoSizeMode,
		preload,
		flags
	)

inline

播放时间线

参数

{NvsTimeline}	timeline 时间线
{Number}	startTime 开始时间
{Number}	endTime 结束时间
Number{}	videoSizeMode 视频大小模式
{Boolean}	preload 预载
{Number}	flags 标识

返回: {Boolean} 返回一个布尔值。注意：时间线播放是一个异步操作，如果可以开启时间线播放则返回true。

◆ playbackTimelineWithProxyScale()

NvsStreamingContext::playbackTimelineWithProxyScale	(	timeline,
		startTime,
		endTime,
		proxyScale,
		preload,
		flags
	)

inline

使用代理缩放播放时间线

参数

{NvsTimeline}	timeline 时间线
{Number}	startTime 开始时间
{Number}	endTime 结束时间
{NvsRational}	proxyScale 缩放代理
{Boolean}	preload 预载
{Number}	flags 标识

返回: {Boolean} 返回布尔值。注意：时间线播放是异步操作。返回 YES 将开始时间线播放，而 NO 则不会。

◆ preloadEffectResources()

NvsStreamingContext::preloadEffectResources ( )

inline

预加载效果资源

返回: {Boolean}

◆ registerFontByFilePath()

NvsStreamingContext::registerFontByFilePath ( fontFilePath )

inline

根据文件路径注册字体

参数

{String} fontFilePath 字体文件路径

返回: {String} 返回字体文件的 fontFamily 信息。

◆ registerLocalFile()

NvsStreamingContext::registerLocalFile ( file )

inline

注册本地文件对象

参数

{File} file 需要注册的本地文件对象

返回: {String} 返回注册的文件ID，非空代表成功

◆ removeLiveWindow()

NvsStreamingContext::removeLiveWindow ( liveWindow )

inline

删除流媒体浏览窗口

参数

{NvsLiveWindow} liveWindow 流媒体预览窗口

返回: {}

◆ removeTimeline()

NvsStreamingContext::removeTimeline ( timeline )

inline

删除时间线

参数

{NvsTimeline} timeline 时间线

返回: {Boolean} 返回一个布尔值。 true 表示成功删除，false 表示失败。

◆ seekTimeline()

NvsStreamingContext::seekTimeline	(	timeline,
		timestamp,
		videoSizeMode,
		flags
	)

inline

定位某一时间戳的图像

参数

{NvsTimeline}	timeline 时间线
{Number}	timestamp 时间戳（单位微秒）。timestamp取值范围在[0,timeline.duration - 1]。传入其他值无效，seekTimeline会返回false,导致无法开启定位。
{Number}	videoSizeMode 图像预览模式。请参见视频大小预览模式
{Number}	flags 引擎定位的特殊标志。具体参见引擎定位标识

返回: {Boolean} 返回布尔值。注意：寻找时间戳是一个异步操作。返回值为YES表示寻找视频启动成功，否则启动失败。

◆ seekTimelineWithProxyScale()

NvsStreamingContext::seekTimelineWithProxyScale	(	timeline,
		timestamp,
		proxyScale,
		flags
	)

inline

定位某一时间戳的图像

参数

{NvsTimeline}	timeline 时间线
{Number}	timestamp 时间戳（单位微秒）。timestamp取值范围在[0,timeline.duration - 1]。传入其他值无效，seekTimeline会返回false,导致无法开启定位。
{NvsRational}	proxyScale 代理缩放比例，是指以timeline分辨率的几分之几渲染画面
{Number}	flags 引擎定位的特殊标志。具体参见引擎定位标识

返回: {Boolean} 返回布尔值。注意：寻找时间戳是一个异步操作。返回值为YES表示寻找视频启动成功，否则启动失败。

◆ setAudioOutputDeviceVolume()

NvsStreamingContext::setAudioOutputDeviceVolume ( volume )

inline

设置音频输出设备音量

参数

{Number} volume 对设备设置新音量, 取值范围[0, 1]

返回: {}

◆ setDefaultCaptionFade()

NvsStreamingContext::setDefaultCaptionFade ( fade )

inline

是否开启字幕默认淡入淡出效果

参数

{Boolean} fade 是否开启

返回: {}

◆ setMaxImageReaderCount()

NvsStreamingContext::setMaxImageReaderCount ( count )

inline

设置最大的图片读取器数量

参数

{Number} count 最大的图片读取器数量

返回: {}

◆ setMaxVideoDecodingThreadCount()

NvsStreamingContext::setMaxVideoDecodingThreadCount ( count )

inline

设置最大视频解码线程数

参数

{Number} count 计数

返回: {}

◆ setMaxVideoFileReaderCount()

NvsStreamingContext::setMaxVideoFileReaderCount ( count )

inline

设置最大的视频文件读取器数量

参数

{Number} count 最大的视频文件读取器数量

返回: {}

◆ setupHumanDetectionData()

NvsStreamingContext::setupHumanDetectionData	(	dataType,
		dataFilePath
	)

inline

初始化人体检测相关数据包

参数

{Number}	dataType 人体检测数据包类型，参看NvsHumanDetectionDataTypeEnum
{String}	dataFilePath 数据文件路径

返回: {Boolean} 返回一个值，表示它是否成功。

◆ setUseChineseLanguageOnly()

NvsStreamingContext::setUseChineseLanguageOnly ( useChineseLanguageOnly )

inline

设置只使用中文

参数

{Boolean} useChineseLanguageOnly 只使用中文

返回: {}

◆ stop()

NvsStreamingContext::stop ( )

inline

流媒体上下文停止

返回: {}

◆ streamingEngineReadyForTimelineModification()

NvsStreamingContext::streamingEngineReadyForTimelineModification ( )

inline

流媒体引擎准备好时间线修改

返回: {Promise} Promise

◆ unregisterLocalFile()

NvsStreamingContext::unregisterLocalFile ( localFileId )

inline

通过文件ID注销本地文件

参数

{String} localFileId 文件ID

返回: {Boolean} 返回true代表成功

◆ verifySdkLicenseFile()

NvsStreamingContext::verifySdkLicenseFile	(	requestUrl,
		type = `''`
	)

inline

验证SDK许可文件

参数

{String}	requestUrl 请求url
{String}	type 类型

返回: {Boolean} 返回布尔值。YES表示授权验证成功，NO表示失败。如果验证失败，时间线预览会出现水印。调用此接口后，同时需要实现onWebRequestAuthFinish回调函数，来监听异步返回的鉴权结果。

◆ verifySdkLicenseFileWithExtraUserData()

NvsStreamingContext::verifySdkLicenseFileWithExtraUserData	(	requestUrl,
		extraUserData
	)

inline

使用扩展用户数据验证SDK许可文件

参数

{String}	requestUrl 请求的url
{}	extraUserData 扩展用户数据

返回: {}

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

src/js/NvStreamingSdk.js

Public 成员函数

详细描述

成员函数说明

◆ calcDurationAfterCurvesVariableSpeed()

◆ cancelLocalAVFileIconFetchingTask()

◆ cancelLocalAVFileWaveformDataFetchingFetchingTask()

◆ clearCachedResources()

◆ closeHumanDetection()

◆ connectTimelineWithLiveWindow()

◆ constructor()

◆ createEmptyTemplateTimeline()

◆ createLiveWindow()

◆ createTemplateTimeline()

◆ createTimeline()

◆ disconnectLiveWindow()

◆ enableAudioVUMeter()

◆ functionalityAuthorised()

◆ getAssetPackageManager()

◆ getAutoToneParameters()

◆ getAVFileInfo()

◆ getFontCompoundFamilyNameByFilePath()

◆ getLocalAVFileIcon()

◆ getLocalAVFileIconFromCache()

◆ getLocalAVFileThumbnail()

◆ getLocalAVFileWaveformData()

◆ getMaxImageReaderCount()

◆ getMaxVideoFileReaderCount()

◆ getSdkVersion()

◆ getStreamingEngineState()

◆ getTimelineCurrentPosition()

◆ grabImageFromTimeline()

◆ initHumanDetection()

◆ initHumanDetectionExt()

◆ isDecoderConfigSupported()

◆ isDefaultCaptionFade()

◆ isUseChineseLanguageOnly()

◆ loadProject()

◆ notifyUpdateToWebReader()

◆ onSeekingTimelinePosition()

◆ onStreamingEngineStateChanged()

◆ playbackTimeline()

◆ playbackTimelineWithProxyScale()

◆ preloadEffectResources()

◆ registerFontByFilePath()

◆ registerLocalFile()

◆ removeLiveWindow()

◆ removeTimeline()

◆ seekTimeline()

◆ seekTimelineWithProxyScale()

◆ setAudioOutputDeviceVolume()

◆ setDefaultCaptionFade()

◆ setMaxImageReaderCount()

◆ setMaxVideoDecodingThreadCount()

◆ setMaxVideoFileReaderCount()

◆ setupHumanDetectionData()

◆ setUseChineseLanguageOnly()

◆ stop()

◆ streamingEngineReadyForTimelineModification()

◆ unregisterLocalFile()

◆ verifySdkLicenseFile()

◆ verifySdkLicenseFileWithExtraUserData()