# 本地截图 (/zh-CN/realtime-media/local-server-recording/build/configure-recording-output/screen-capture/java) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). ## 功能简介 [#功能简介-1] 在实时音视频互动中对接收到的远端视频进行截取,可以实现对直播画面进行内容审核,以确保内容合法合规。 声网本地服务端 SDK 支持在单流和合流录制下,对远端视频进行截图;也支持只截图不录制。支持的截图格式包括: - H.264/H.265 编码帧:以原始编码格式回调视频帧数据 - YUV 格式帧:以 YUV 编码格式回调视频帧数据 - JPG 格式帧:以 JPG 编码格式回调视频帧数据 - JPG 文件:将截图保存为 JPG 文件到指定目录 本文介绍如何使用本地服务端录制 SDK 在你的项目中实现截图功能。 ## 前提条件 [#前提条件-1] 开始前,请确保你已经参考[开始录制音视频](/zh-CN/realtime-media/local-server-recording/get-started/start-recording)在项目中集成了录制 SDK 并了解实现录制的基础逻辑和 API 时序。 ## 实现方法 [#实现方法-1] 本地截图功能的实现逻辑如下: 1. 完成录制实例初始化后,调用 `enableRecorderVideoFrameCapture` 开启和关闭截图功能: ```java public int enableRecorderVideoFrameCapture(boolean enable, RecorderVideoFrameCaptureConfig config) ``` 2. 加入频道后,通过 `IRecorderVideoFrameObserver` 接口接收各类型的视频帧回调,获取截取的视频数据: ```java public class VideoFrameObserver implements IRecorderVideoFrameObserver { // YUV 数据回调 @Override public void onYuvFrameCaptured(String channelId, String userId, VideoFrame frame) { // 处理 YUV 视频帧 } // H.264/H.265、JPG 帧数据回调 @Override public void onEncodedFrameReceived(String channelId, String userId, byte[] imageBuffer, EncodedVideoFrameInfo info) { // 处理编码后的视频帧 } // JPG 文件保存回调 @Override public void onJPGFileSaved(String channelId, String userId, String filename) { // JPG 文件保存成功 } } ``` 具体实现步骤如下。 ### 配置并开启视频帧截图 [#配置并开启视频帧截图-1] 首先调用 `enableRecorderVideoFrameCapture` 开启视频帧截图。你需要在该方法中配置一个 `RecorderVideoFrameCaptureConfig` 对象,设置你想要截取的视频帧格式、截图时间间隔等配置项。 ```java // 创建 observer 来接收视频帧 VideoFrameObserver videoFrameObserver = new VideoFrameObserver(); RecorderVideoFrameCaptureConfig videoFrameCaptureConfig = new RecorderVideoFrameCaptureConfig(); // 设置截图类型 videoFrameCaptureConfig.setVideoFrameType(Constants.VideoFrameCaptureType.VIDEO_FORMAT_JPG_FRAME_TYPE); // JPG 帧和 JPG 文件支持设置截图时间间隔 videoFrameCaptureConfig.setJpgCaptureIntervalInSec(5); // JPG 文件需要设置 JPG 文件的保存路径 videoFrameCaptureConfig.setJpgFileStorePath("/path/to/save/jpg/files/"); // 设置 observer videoFrameCaptureConfig.setObserver(videoFrameObserver); // 调用 enableRecorderVideoFrameCapture 开启视频帧截图 agoraMediaRtcRecorder.enableRecorderVideoFrameCapture(true, videoFrameCaptureConfig); ``` SDK 支持截取 H.264/H.265 编码帧、YUV 格式帧、JPG 格式帧和 JPG 文件。各类型视频帧的 `RecorderVideoFrameCaptureConfig` 对象设置如下: ```java tab="H.264/H.265 编码帧" tabGroup="video-format" videoFrameCaptureConfig.setVideoFrameType(Constants.VideoFrameCaptureType.VIDEO_FORMAT_ENCODED_FRAME_TYPE); ``` ```java tab="YUV 格式帧" tabGroup="video-format" videoFrameCaptureConfig.setVideoFrameType(Constants.VideoFrameCaptureType.VIDEO_FORMAT_YUV_FRAME_TYPE); ``` ```java tab="JPG 格式帧" tabGroup="video-format" videoFrameCaptureConfig.setVideoFrameType(Constants.VideoFrameCaptureType.VIDEO_FORMAT_JPG_FRAME_TYPE); videoFrameCaptureConfig.setJpgCaptureIntervalInSec(3); // 每 3 秒截图一次 ``` ```java tab="JPG 文件" tabGroup="video-format" videoFrameCaptureConfig.setVideoFrameType(Constants.VideoFrameCaptureType.VIDEO_FORMAT_JPG_FILE_TYPE); videoFrameCaptureConfig.setJpgCaptureIntervalInSec(10); // 每 10 秒保存一张图片 videoFrameCaptureConfig.setJpgFileStorePath("/tmp/screenshots/"); // 确保目录存在且可写 ``` ### 获取截取的视频帧 [#获取截取的视频帧-1] 加入频道后,你就可以在 [`IRecorderVideoFrameObserver`](/zh-CN/api-reference/local-server-recording/java/irecordervideoframeobserver) 接口类中,通过各视频帧格式对应的回调来接收截图数据: ```java public class VideoFrameObserver implements IRecorderVideoFrameObserver { // YUV 数据回调 @Override public void onYuvFrameCaptured(String channelId, String userId, VideoFrame frame) { // 处理 YUV 视频帧 System.out.println("收到 YUV 帧: 频道 " + channelId + ", 用户 " + userId); // 可以获取帧的详细信息 System.out.println("帧时间戳: " + frame.getTimeStamp()); } // H.264/H.265、JPG 帧数据回调 @Override public void onEncodedFrameReceived(String channelId, String userId, byte[] imageBuffer, EncodedVideoFrameInfo info) { // 处理编码后的视频帧 System.out.println("收到编码帧: 频道 " + channelId + ", 用户 " + userId + ", 数据长度 " + imageBuffer.length); // 可以在这里处理图像数据,比如保存到文件或进行内容分析 // processImageData(imageBuffer); } // JPG 文件保存回调 @Override public void onJPGFileSaved(String channelId, String userId, String filename) { // JPG 文件保存成功 System.out.println("JPG 文件已保存: 频道 " + channelId + ", 用户 " + userId + ", 文件路径 " + filename); } } ``` ### 停止视频帧截图 [#停止视频帧截图-1] 当不再需要截图功能时,再次调用 `enableRecorderVideoFrameCapture` 并将 `enable` 参数设置为 `false`: ```java // 停止截图功能 agoraMediaRtcRecorder.enableRecorderVideoFrameCapture(false, videoFrameCaptureConfig); ``` ## 开发注意事项 [#开发注意事项-1] ### 视频订阅选项设置 [#视频订阅选项设置-1] 在使用截图功能时,当截图格式设置为 YUV、JPG 帧或 JPG 文件时,在调用 [`subscribeVideo`](/zh-CN/api-reference/local-server-recording/java/agoramediartcrecorder.java#subscribevideo) 或 [`subscribeAllVideo`](/zh-CN/api-reference/local-server-recording/java/agoramediartcrecorder.java#subscribeallvideo) 时,需要将 `VideoSubscriptionOptions.encodedFrameOnly` 设置为 `false`(默认值为 `false`)。 ```java VideoSubscriptionOptions options = new VideoSubscriptionOptions(); options.setEncodedFrameOnly(false); // 确保设置为 false options.setType(Constants.VideoStreamType.VIDEO_STREAM_HIGH); agoraMediaRtcRecorder.subscribeAllVideo(options); ``` ### 录制与截图独立 [#录制与截图独立-1] SDK 支持只截图不录制视频。是否录制通过 `startRecording` 方法控制,不影响截图的实现。 ## API 参考 [#api-参考-1] - [`enableRecorderVideoFrameCapture`](/zh-CN/api-reference/local-server-recording/java/agoramediartcrecorder.java#enablerecordervideoframecapture) - [`RecorderVideoFrameCaptureConfig`](/zh-CN/api-reference/local-server-recording/java/struct#recordervideoframecaptureconfig) - [`IRecorderVideoFrameObserver`](/zh-CN/api-reference/local-server-recording/java/irecordervideoframeobserver) - [`VideoFrameCaptureType`](/zh-CN/api-reference/local-server-recording/java/enum#videoframecapturetype)