|
美摄Web端SDK
3.14.2
|
流媒体上下文:流媒体上下文类可视作整个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 断开。 更多... | |
| setTimelineScaleForSeek (timeline, secondsPerPixel) | |
| 设置时间线的比例尺(单位是秒/像素)以便进行scrubbing检测。 使用者应该在每个设置了NvsSeekFlagEnum.AllowFastScrubbing标志的seek操作之前调用此方法。 更多... | |
| 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) | |
| 获取自动音调参数 更多... | |
| initInternalResources () | |
流媒体上下文:流媒体上下文类可视作整个SDK框架的入口。开发过程中,NvsStreamingContext提供了静态sharedInstance接口创建流媒体上下文的唯一实例。 通过这个实例对象,我们可以开启采集设备录制视频,添加采集视频特效,设置拍摄时的各项参数,包括自动聚焦,自动曝光调节, 开关换补光灯等。同时还能够创建时间线,并将时间线与实时预览窗口连接起来,实时预览播放已经拍摄完成的视频。整个视频制作完成后,要销毁流媒体上下文的对象实例。 带特效拍摄时,添加素材资源包(采集特效包,场景资源包等),都得先安装,安装成功后获取packageId才能使用,而内建采集特效(builtin)只需获取特效名称即可使用。sdk接口中凡是需要传入资源、授权等文件路径时一定是全路径。
|
inline |
曲线变速后计算持续时间。
| curvesString | 曲线字符串。 |
|
inline |
通过任务ID取消获取本地文件缩略图的任务
| {Number} | iconFetchingTaskId 任务ID |
|
inline |
通过任务ID取消获取本地文件波形的任务
| {Number} | waveformDataFetchingTaskId 任务ID |
|
inline |
清除缓存的资源。
|
inline |
关闭人体检测
|
inline |
连接时间线到流媒体窗口
| {NvsTimeline} | timeline 时间线 |
| {NvsLiveWindow} | liveWindow 预览窗口 |
|
inline |
@constructor
|
inline |
创建空模板时间线
| {NvsVideoResolution} | videoRes 视频解析度 |
| {NvsRational} | fps 视频帧率 |
| {NvsAudioResolution} | audioRes 音频解析度 |
| {String} | templateId 模板ID |
| {Number} | flags 标识 |
|
inline |
|
inline |
根据模板ID,创建模板时间线
| {String} | templateId 模板ID |
| {{NvsVectorVal<>} | templateFootages 模板素材 |
| {Number} | flags 标识 |
|
inline |
创建时间线
| {NvsVideoResolution} | videoRes 视频解析度 |
| {NvsRational} | fps 视频帧率 |
| {NvsAudioResolution} | audioRes 音频解析度 |
| {Number} | flags 标识 |
|
inline |
将时间线与 LiveWindow 断开。
| {NvsLiveWindow} | liveWindow 预览窗口 |
|
inline |
启用音频 VU 表
| {Boolean} | enable 是否开启 |
|
inline |
功能授权
| {String} | sdkFunctionName 函数名 |
|
inline |
获取资源包管理器
|
inline |
获取自动音调参数
| {ImageData} | imageData 图片数据 |
| {Number} | width 宽度 |
| {Number} | height 高度 |
| {Boolean} | isRawImage 是否原始图片 |
|
inline |
获取音视频文件信息
| {String} | avFilePath 音视频文件路径 |
| {Number} | extraFlag 扩展标记 |
|
inline |
获取字体文件的组合字族名称
| {String} | fontFilePath 字体文件路径 |
|
inline |
启动一个获取本地视频文件缩略图的任务
| {String} | localAVFilePath 本地文件地址,例如:/localmedia/test.mp4.weblocal |
| {Number} | timestamp 获取缩略图的时间戳,单位为微秒 |
| {Function} | iconFetched 获取成功的回调函数,回调函数中包含以下参数: imageData: 当前任务获取到的ImageData对象 localAVFilePath: 当前任务对应的本地文件地址 timestamp: 当前任务对应的时间戳,单位为微秒 |
|
inline |
从缓存中获取本地文件的缩略图
| {String} | localAVFilePath 本地文件地址,例如:/localmedia/test.mp4.weblocal |
| {Number} | timestamp 获取缩略图的时间戳,单位为微秒 |
|
inline |
启动一个获取本地视频文件图标的任务
| {String} | localAVFilePath 本地文件地址,例如:/localmedia/test.mp4.weblocal |
| {Number} | timestamp 获取缩略图的时间戳,单位为微秒,如果设置-1,则按照sdk默认的规则获取 |
| {Boolean} | bypassCache 是否绕过缓存获取 |
| {Function} | thumbnailFetched 获取成功的回调函数,回调函数中包含以下参数: imageData: 当前任务获取到的ImageData对象 localAVFilePath: 当前任务对应的本地文件地址 timestamp: 当前任务对应的时间戳,单位为微秒 |
|
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: 当前任务开始的波形数据组索引 |
|
inline |
获取最大的图片读取器数量
|
inline |
获取最大的视频文件读取器数量
|
inline |
获取SDK版本号
|
inline |
获取流媒体引擎状态
|
inline |
获取当前时间线位置
| {NvsTimeline} | timeline 时间线 |
|
inline |
从时间轴抓取图像
| {NvsTimeline} | timeline 时间线 |
| {Number} | timestamp 时间戳 |
| {NvsRational} | proxyScale 缩放代理 |
| {Number} | flags 标记 |
|
inline |
初始化人体检测机制,只需要初始化一次
| {String} | modelFilePath 模型文件路径 |
| {String} | licenseFilePath 授权文件路径 |
| {Number} | features 人体检测特征标志字段,参看NvsHumanDetectionFeatureEnum |
|
inline |
初始化人体检测扩展机制,必须先调用initHumanDetection
| {String} | modelFilePath 模型文件路径 |
| {String} | licenseFilePath 授权文件路径 |
| {Number} | features 人体检测特征标志字段,参看NvsHumanDetectionFeatureEnum |
|
inline |
解码器是否支持此视频格式
|
inline |
字幕默认淡入淡出效果是否已经开启
|
inline |
是否仅仅使用中文
|
inline |
返回新建建时间线对象
| {String} | projectId 项目唯一标识,必须先安装项目 |
| {String} | resourceDir 项目素材库的资源目录 |
| {Number} | flags 用于新建时间线的特殊标志。如无特殊要求请输入0。请参考 create timeline flag. |
|
inline |
通知更新到网络阅读器
| {String} | webAVFilePath 网页音视频文件路径 |
|
inline |
|
inline |
流媒体引擎的状态变化
|
inline |
播放时间线
| {NvsTimeline} | timeline 时间线 |
| {Number} | startTime 开始时间 |
| {Number} | endTime 结束时间 |
| Number{} | videoSizeMode 视频大小模式 |
| {Boolean} | preload 预载 |
| {Number} | flags 标识 |
|
inline |
使用代理缩放播放时间线
| {NvsTimeline} | timeline 时间线 |
| {Number} | startTime 开始时间 |
| {Number} | endTime 结束时间 |
| {NvsRational} | proxyScale 缩放代理 |
| {Boolean} | preload 预载 |
| {Number} | flags 标识 |
|
inline |
预加载效果资源
|
inline |
根据文件路径注册字体
| {String} | fontFilePath 字体文件路径 |
|
inline |
注册本地文件对象
| {File} | file 需要注册的本地文件对象 |
|
inline |
删除流媒体浏览窗口
| {NvsLiveWindow} | liveWindow 流媒体预览窗口 |
|
inline |
删除时间线
| {NvsTimeline} | timeline 时间线 |
|
inline |
定位某一时间戳的图像
| {NvsTimeline} | timeline 时间线 |
| {Number} | timestamp 时间戳(单位微秒)。timestamp取值范围在[0,timeline.duration - 1]。传入其他值无效,seekTimeline会返回false,导致无法开启定位。 |
| {Number} | videoSizeMode 图像预览模式。请参见视频大小预览模式 |
| {Number} | flags 引擎定位的特殊标志。具体参见引擎定位标识 |
|
inline |
定位某一时间戳的图像
| {NvsTimeline} | timeline 时间线 |
| {Number} | timestamp 时间戳(单位微秒)。timestamp取值范围在[0,timeline.duration - 1]。传入其他值无效,seekTimeline会返回false,导致无法开启定位。 |
| {NvsRational} | proxyScale 代理缩放比例,是指以timeline分辨率的几分之几渲染画面 |
| {Number} | flags 引擎定位的特殊标志。具体参见引擎定位标识 |
|
inline |
设置音频输出设备音量
| {Number} | volume 对设备设置新音量, 取值范围[0, 1] |
|
inline |
是否开启字幕默认淡入淡出效果
| {Boolean} | fade 是否开启 |
|
inline |
设置最大的图片读取器数量
| {Number} | count 最大的图片读取器数量 |
|
inline |
设置最大视频解码线程数
| {Number} | count 计数 |
|
inline |
设置最大的视频文件读取器数量
| {Number} | count 最大的视频文件读取器数量 |
|
inline |
设置时间线的比例尺(单位是秒/像素)以便进行scrubbing检测。 使用者应该在每个设置了NvsSeekFlagEnum.AllowFastScrubbing标志的seek操作之前调用此方法。
| {NvsLiveWindow} | timeline 时间线 |
| {Number} | secondsPerPixel 比例尺(单位是秒/像素) |
|
inline |
初始化人体检测相关数据包
| {Number} | dataType 人体检测数据包类型,参看NvsHumanDetectionDataTypeEnum |
| {String} | dataFilePath 数据文件路径 |
|
inline |
设置只使用中文
| {Boolean} | useChineseLanguageOnly 只使用中文 |
|
inline |
流媒体上下文停止
|
inline |
流媒体引擎准备好时间线修改
|
inline |
通过文件ID注销本地文件
| {String} | localFileId 文件ID |
|
inline |
验证SDK许可文件
| {String} | requestUrl 请求url |
| {String} | type 类型 |
|
inline |
使用扩展用户数据验证SDK许可文件
| {String} | requestUrl 请求的url |
| {} | extraUserData 扩展用户数据 |