Method TakeSnapshotEx [2/2]

TakeSnapshotEx [2/2]

使用连接 ID 获取指定观测位置的视频截图。

C#

public abstract int TakeSnapshotEx(RtcConnection connection, uint uid, SnapshotConfig config);

该方法用于对指定用户的视频流进行截图，生成一张 JPG 格式的图片，并保存至指定的路径。

调用时机

该方法需要在 JoinChannelEx 后调用。

调用限制

• 该方法是异步操作，调用返回时 SDK 并没有真正获取截图。
• 该方法用于本地视频截图时，是对 ChannelMediaOptions 中指定发布的视频流进行截图。
• 如果用户的视频经过前处理，例如，添加了水印或美颜，生成的截图会包含前处理效果。

相关回调

成功调用该方法后，SDK 会触发 OnSnapshotTaken 回调，报告截图是否成功和获取截图的详情。

参数

connection

Connection 信息。详见 RtcConnection。

uid

用户 ID。如果要对本地用户的视频截图，则设为 0。

config

截图设置，详见 SnapshotConfig。

返回值

• 0: 方法调用成功。
• < 0: 方法调用失败。详见错误码了解详情和解决建议。