实时音视频 SPARKRTC-流对象（Stream）:getVideoSnapshot

时间：2024-09-26 12:51:29

实时音视频 SPARKRTC 接口参考

getVideoSnapshot(resolutionId?: string,format?: string, encoderOptions?: number): string

【功能说明】

获取视频截图

【请求参数】

resolutionId：可选，string类型。双流场景，指定需要截图的视频分辨率Id，resolutionId可通过接口getStreamInfo 获取。如果不传resolutionId，则默认对分辨率最高的视频流截图。
format：可选，string类型。表示截图的格式，可填‘jpeg’、‘webp’、'png'。如果不传format，则默认使用png格式截图。
encoderOptions：可选，number类型。format填‘jpeg’或者‘webp’时生效，表示图片质量，值范围【0,1】，默认值为1。

【返回参数】

string类型，表示视频截图对象的url，当视频未播放，或者resolutionId错误时，返回的string为空。