boofcv.io.VideoCallBack Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of boofcv-io Show documentation

BoofCV is an open source Java library for real-time computer vision and robotics applications.

There is a newer version: 1.1.7

/*
 * Copyright (c) 2021, Peter Abeles. All Rights Reserved.
 *
 * This file is part of BoofCV (http://boofcv.org).
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package boofcv.io;

import boofcv.struct.image.ImageBase;
import boofcv.struct.image.ImageType;

/**
 * Callback for video streams.
 *
 * @author Peter Abeles
 */
public interface VideoCallBack> {

	/**
	 * Called when the camera has been initialized and the image properties are known.
	 */
	public void init( int width , int height , ImageType imageType );

	/**
	 * Passes in the next frame in the sequence. Time in this function should be minimized to avoid causing a
	 * back log in the video image buffer.
	 *
	 * @param frame New image frame in BoofCV image format.
	 * @param sourceData Platform specific image data.
	 * @param timeStamp Time the video frame was collected.
	 */
	public void nextFrame( T frame , Object sourceData , long timeStamp );

	/**
	 * Called when the video stream has stopped.
	 */
	public void stopped();

	/**
	 * Used to inform the video stream if a request has been made to stop processing the video sequence.
	 * This function is checked after each call to {@link #nextFrame(boofcv.struct.image.ImageBase,Object, long)}.
	 *
	 * @return true if a request has been made to stop the steam
	 */
	public boolean stopRequested();

}