IPcam Spring Boot Starter Quickstart Guide

This README.md describes how to quickly configure and use the launcher and provides a few common methods as a demonstration, other methods can be seen in the specific code

Development Environment

JDK                   1.8.0_202
Maven               3.5.4
Spring Boot       2.3.4.RELEASE
SDK                  Library

Quick Start Example

1、Add the dependency to the pom.xml

<dependency>
    <groupId>com.github.echils</groupId>
    <artifactId>ipcam-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

2、Extract the Library to a custom directory (take the /data directory as an example), and then add dynamic library management (take linux as an example)

vim /etc/profile

# Add the following parameters, modify the path according to the actual situation, and then save and exit
export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/data/hikvision/linux:/data/xmeye/linux

source /etc/profile && ldconfig

3、Implement the interface {@link ICameraSupplier } and add it to the Spring container

@Component
public class DefaultCameraSupplier implements ICameraSupplier<String> {

    @Autowired
    private CameraMapper cameraMapper;
    
    /**
     * Search the database or configuration file through identification to find the basic information of the camera,
     * and package it into NetworkCamera {@link NetworkCamera}
     *
     * @param identification the unique identification of the camera
     * @return {@link NetworkCamera}
     */
    @Override
    public NetworkCamera apply(String identification) {

        Optional<Camera> optionalCamera =cameraMapper.findById(identification);
        
        if (!optionalCamera.isPresent()) {
            throw new NotFoundException();   
        }
        
        Camera camera = optionalCamera.get();
        NetworkCamera networkCamera = new NetworkCamera();
        networkCamera.setIp(camera.getIp());
        networkCamera.setPort(camera.getPort());
        networkCamera.setUsername(camera.getUsername());
        networkCamera.setPassword(camera.getPassword());
        networkCamera.setDriverType(CameraDriver.HIKVISION);

        return networkCamera;
    }

}

4、Autowired the pool {@link CameraConnectionPool} in your service

@Service
public class Test {

    @Autowired
    private CameraConnectionPool<String> cameraConnectionPool;

    private static final String IDENTIFICATION = "Test";
    
    public void invoke(){
       ICameraConnection connection = null;
       try {
           connection = cameraConnectionPool.borrowObject(IDENTIFICATION);
           List<String> channels = connection.getChannels();
           for (String channel : channels) {
               System.out.println(channel);
           }
       }catch (RuntimeException e) {
           throw new CameraRuntimeException();
       } finally {
           if (connection != null && connection.isConnected()) {
               cameraConnectionPool.returnObject(IDENTIFICATION, connection);
           }
       } 
    }
    
}

More Usage Samples

Demo: ipcam-quickstart-sample

laiguorong/ipcam-spring-boot-starter