【亲测免费】 ONVIF-Java 技术使用文档

ONVIF-Java 技术使用文档

ONVIF（Open Network Video Interface Forum）是一个开放的行业论坛，旨在提供并推广标准化接口，以实现基于IP的物理安全产品的有效互操作性。本文档将指导您如何安装、使用ONVIF-Java库，并详细解释其API的运用方法。

安装指南

Maven 用户

在您的pom.xml文件中添加以下依赖：

<dependency>
  <groupId>be.teletask.onvif</groupId>
  <artifactId>onvif</artifactId>
  <version>1.0.0</version>
</dependency>

Gradle 用户

在您的build.gradle文件中的dependencies块加入：

implementation 'be.teletask.onvif:onvif:1.0.0'

或者，您可以直接下载最新版本的JAR包并将其包含到您的项目类路径中。

项目的使用说明

发现设备

ONVIF-Java支持通过WS-Discovery和UPnP两种协议来发现网络上的ONVIF兼容设备。以下代码示例展示如何开始设备发现过程：

DiscoveryManager manager = new DiscoveryManager();
manager.setDiscoveryTimeout(10000);
manager.discover(new DiscoveryListener() {
    @Override
    public void onDiscoveryStarted() {
        System.out.println("发现开始");
    }

    @Override
    public void onDevicesFound(List<Device> devices) {
        for (Device device : devices)
            System.out.println("找到的设备: " + device.getHostName());
    }
});

使用ONVIF服务

一旦设备被发现，可以使用OnvifManager与其进行交互：

OnvifManager onvifManager = new OnvifManager();
onvifManager.setOnvifResponseListener(this);
OnvifDevice device = new OnvifDevice("设备IP地址", "用户名", "密码");

// 获取设备服务信息
onvifManager.getServices(device, new OnvifServicesListener() {
    @Override
    public void onServicesReceived(OnvifDevice onvifDevice, OnvifServices services) {
        // 处理服务信息
    }
});

// 示例：获取媒体配置文件
onvifManager.getMediaProfiles(device, new OnvifMediaProfilesListener() {
    @Override
    public void onMediaProfilesReceived(OnvifDevice device, List<OnvifMediaProfile> mediaProfiles) {
        // 处理媒体配置文件
    }
});

Android特别注意事项

对于Android应用，需要开启WiFi的多播接收权限，以确保能够发现设备：

private void acquireMulticastLock() {
    WifiManager wifiManager = (WifiManager) getSystemService(Context.WIFI_SERVICE);
    if (wifiManager != null) {
        WifiManager.MulticastLock multicastLock = wifiManager.createMulticastLock("ONVIF_multicast_lock");
        multicastLock.acquire();
    }
}

// 不要忘记在不再需要时释放锁：
// multicastLock.release();

API使用文档摘要

• 服务信息: 使用getServices获取设备提供的ONVIF服务。
• 设备信息: getDeviceInformation来获得制造商、序列号等基本信息。
• 媒体配置: getMediaProfiles列出所有预配置或动态配置的媒体配置文件。
• 流媒体URI: 通过getMediaStreamURI获取直接用于播放的流媒体地址。
• 自定义请求: 实现OnvifRequest接口发送特定于应用场景的请求。

ONVIF-Java库提供了灵活且强大的功能，适用于多种安防监控场景，特别是与IP摄像机的集成。遵循上述指南，开发者能够轻松地集成ONVIF设备至其应用程序之中。