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 */
030/**
031 * 
032 */
033package org.openimaj.video;
034
035/**
036 *      A listener interface for objects that want to know about the state
037 *      of a video display.
038 *
039 *      @author David Dupplaw (dpd@ecs.soton.ac.uk)
040 *  @created 27 Jul 2011
041 *      
042 */
043public interface VideoDisplayStateListener
044{
045        /**
046         *      Called when the video display is stopped.
047         *      @param v The video display that was stopped.
048         */
049        public void videoStopped( VideoDisplay<?> v );
050        
051        /**
052         *      Called when the video display is set to play.
053         *      @param v The video display that was set to play.
054         */
055        public void videoPlaying( VideoDisplay<?> v );
056        
057        /**
058         *      Called when the video display is paused.
059         *      @param v The video display that was paused.
060         */
061        public void videoPaused( VideoDisplay<?> v );
062        
063        /**
064         *      Called when the video display's state changes.
065         * 
066         *      @param mode The mode the video display changed to
067         *      @param v The video display whose state changed.
068         */
069        public void videoStateChanged( VideoDisplay.Mode mode, VideoDisplay<?> v );
070}