001/**
002 * Copyright (c) 2011, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.demos.campusview;
031
032import java.io.File;
033
034/**
035 * Interface describing a delegate for the capture controls.
036 * 
037 * @author David Dupplaw (dpd@ecs.soton.ac.uk)
038 * @author Jonathon Hare (jsh2@ecs.soton.ac.uk)
039 */
040public interface CaptureControlsDelegate 
041{
042        // Batch controls
043        /**
044         * start a new batch
045         * @param dir
046         * @param md
047         * @param capturer
048         * @param type
049         */
050        public void startBatch( File dir, File md, String capturer, String type );
051        
052        /**
053         * Stop the current batch
054         */
055        public void stopBatch();
056        
057        // capture controls
058        /**
059         * take a snapshot
060         */
061        public void snapshot();
062        
063        /**
064         * Start recording
065         * @param rateSeconds
066         */
067        public void startRecording( int rateSeconds );
068        
069        /**
070         * Stop recording 
071         */
072        public void stopRecording();
073        
074        // configuration controls
075        /**
076         * Update the settings
077         * @param capWidth
078         * @param capHeight
079         * @param capRate
080         */
081        public void updateCaptureSettings(int capWidth, int capHeight, double capRate);
082}