001package com.github.sarxos.webcam;
002
003/**
004 * This interface should be implemented by all webcam drivers which would like
005 * to support webcam devices discovery mechanism.
006 * 
007 * @author Bartosz Firyn (SarXos)
008 */
009public interface WebcamDiscoverySupport {
010
011        /**
012         * Get interval between next discovery scans. Time interval is given in
013         * milliseconds.
014         * 
015         * @return Time interval between next scans
016         */
017        long getScanInterval();
018
019        /**
020         * Check if scan is possible. In some cases, even if driver support devices
021         * discovery, there can be a situation when due to various factors, scan
022         * cannot be executed (e.g. devices are busy, network is unavailable,
023         * devices registry not responding, etc). In general this method should
024         * return true.
025         * 
026         * @return True if scan possible, false otherwise
027         */
028        boolean isScanPossible();
029}