com.github.sarxos.webcam.WebcamDiscoverySupport Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of webcam-capture Show documentation

This library allows you to use your PC webcam, IP or network cameras directly from Java. It's compatible with most operating systems (Windows, Linux, MacOS).

The newest version!

package com.github.sarxos.webcam;

/**
 * This interface should be implemented by all webcam drivers which would like to support webcam
 * devices discovery mechanism.
 *
 * @author Bartosz Firyn (SarXos)
 */
public interface WebcamDiscoverySupport {

	/**
	 * Default webcam discovery scan interval in milliseconds.
	 */
	public static final long DEFAULT_SCAN_INTERVAL = 3000;

	/**
	 * Get interval between next discovery scans. Time interval is given in milliseconds.
	 *
	 * @return Time interval between next scans
	 */
	long getScanInterval();

	/**
	 * Check if scan is possible. In some cases, even if driver support devices discovery, there can
	 * be a situation when due to various factors, scan cannot be executed (e.g. devices are busy,
	 * network is unavailable, devices registry not responding, etc). In general this method should
	 * return true.
	 *
	 * @return True if scan possible, false otherwise
	 */
	boolean isScanPossible();
}