Package edu.wpi.first.cscore
Class ImageSink
- java.lang.Object
-
- edu.wpi.first.cscore.VideoSink
-
- edu.wpi.first.cscore.ImageSink
-
- All Implemented Interfaces:
AutoCloseable
public abstract class ImageSink extends VideoSink
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class edu.wpi.first.cscore.VideoSink
VideoSink.Kind
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
ImageSink(int handle)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getError()
Get error string.void
setDescription(String description)
Set sink description.void
setEnabled(boolean enabled)
Enable or disable getting new frames.-
Methods inherited from class edu.wpi.first.cscore.VideoSink
close, enumerateProperties, enumerateSinks, equals, getConfigJson, getDescription, getHandle, getKind, getKindFromInt, getName, getProperty, getSource, getSourceProperty, hashCode, isValid, setConfigJson, setSource
-
-
-
-
Constructor Detail
-
ImageSink
protected ImageSink(int handle)
-
-
Method Detail
-
setDescription
public void setDescription(String description)
Set sink description.- Parameters:
description
- Description
-
getError
public String getError()
Get error string. Call this if WaitForFrame() returns 0 to determine what the error is.- Returns:
- Error string.
-
setEnabled
public void setEnabled(boolean enabled)
Enable or disable getting new frames. Disabling will cause processFrame (for callback-based CvSinks) to not be called and WaitForFrame() to not return. This can be used to save processor resources when frames are not needed.- Parameters:
enabled
- Enable to get new frames.
-
-