跳转至
本 SDK 仅适用于过去 3 年内发布的设备。我们定期优化和更新 SDK，以确保兼容性和性能。对于超过 3 年的旧设备，我们不保证兼容性，也不会提供技术支持。

# 预览

预览模块实现了实时播放设备捕获的视频流的功能，包括设备视频流的实时预览、实时音频的播放控制、视频色彩参数控制等。

### 接口概览

接口名称 | 功能描述
--- | ---
`NET_SDK_LivePlay` | 实时预览。
`NET_SDK_OpenSound` | 开启实时预览的声音。
`NET_SDK_Volume` | 调节实时预览的音量。
`NET_SDK_CloseSound` | 关闭实时预览的声音。
`NET_SDK_StopLivePlay` | 关闭实时预览。
`NET_SDK_SetLiveDataCallBack` | 设置预览回调。
`NET_SDK_SetYUVCallBack` | 设置预览解码后 YUV 数据回调。

Note

接口详细参数见接口定义部分

### 流程说明

    ---
    title: 预览
    ---

    flowchart TD
        A(设备SDK初始化<br><strong>NET_SDK_Init</strong>)
        B(用户注册设备<br><strong>NET_SDK_Login</strong>或<br><strong>NET_SDK_LoginEx</strong>)

        subgraph 声音控制
            S0(打开声音<br><strong>NET_SDK_OpenSound</strong>)
            S1(调节音量<br><strong>NET_SDK_Volume</strong>)
            S2(关闭声音<br><strong>NET_SDK_CloseSound</strong>)
            S0 --> S1 --> S2
        end
        style 声音控制 fill:#e7b13387,stroke:#f66,stroke-width:2px,stroke-dasharray: 5
        C(停止预览<br><strong>NET_SDK_StopLivePlay</strong>)
        E(注销设备<br><strong>NET_SDK_Logout</strong>)
        F(释放SDK资源<br><strong>NET_SDK_Cleanup</strong>)

        A --> B --> 声音控制 --> C --> E --> F

Note

虚线框中的模块为：在独占声卡模式下对预览现场声音的控制，包括打开声音、调节音量以及关闭声音。

Warning

在Windows之外的系统上，视频流的播放需要自行实现，可使用接口`NET_SDK_SetLiveDataCallBack`或者`NET_SDK_SetYUVCallBack`设置视频流数据回调，在回调函数中自行实现视频流的播放。

### 相关说明

- 示例代码中只包含在预览状态下开关声音，未包含调节音量的示例，可以参考`NET_SDK_Volume`接口的说明自行实现对预览时音量大小的控制。

- 当`NET_SDK_LivePlay`的返回值为-1 时表示失败，其他值为播放句柄。

错误码