Package edu.wpi.first.cscore.raw

Class RawSource

java.lang.Object

edu.wpi.first.cscore.VideoSource

edu.wpi.first.cscore.ImageSource

edu.wpi.first.cscore.raw.RawSource

All Implemented Interfaces:

AutoCloseable

public class RawSource
extends ImageSource

A source for user code to provide video frames as raw bytes.

This is a complex API, most cases should use CvSource.

Nested Class Summary

Nested classes/interfaces inherited from class edu.wpi.first.cscore.VideoSource

VideoSource.ConnectionStrategy, VideoSource.Kind

Field Summary

Fields inherited from class edu.wpi.first.cscore.VideoSource

m_handle

Constructor Summary

Constructors

Constructor	Description
RawSource(String name, VideoMode mode)	Create a raw frame source.
RawSource(String name, PixelFormat pixelFormat, int width, int height, int fps)	Create a raw frame source.

Method Summary

Modifier and Type	Method	Description
protected void	putFrame(long data, int size, int width, int height, int stride, PixelFormat pixelFormat)	Put a raw image and notify sinks.
void	putFrame(RawFrame image)	Put a raw image and notify sinks.
void	putFrame(ByteBuffer data, int width, int height, int stride, PixelFormat pixelFormat)	Put a raw image and notify sinks.

Methods inherited from class edu.wpi.first.cscore.ImageSource

createBooleanProperty, createIntegerProperty, createProperty, createStringProperty, notifyError, setConnected, setDescription, setEnumPropertyChoices

Methods inherited from class edu.wpi.first.cscore.VideoSource

close, enumerateProperties, enumerateSinks, enumerateSources, enumerateVideoModes, equals, getActualDataRate, getActualFPS, getConfigJson, getDescription, getHandle, getKind, getKindFromInt, getLastFrameTime, getName, getProperty, getVideoMode, hashCode, isConnected, isEnabled, isValid, setConfigJson, setConnectionStrategy, setFPS, setPixelFormat, setResolution, setVideoMode, setVideoMode

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

RawSource

public RawSource(String name, VideoMode mode)

Create a raw frame source.

Parameters:

name - Source name (arbitrary unique identifier)

mode - Video mode being generated

RawSource

public RawSource(String name, PixelFormat pixelFormat, int width, int height, int fps)

Create a raw frame source.

Parameters:

name - Source name (arbitrary unique identifier)

pixelFormat - Pixel format

width - width

height - height

fps - fps

Method Details

putFrame

public void putFrame(RawFrame image)

Put a raw image and notify sinks.

Parameters:

image - raw frame image

putFrame

protected void putFrame(long data, int size, int width, int height, int stride, PixelFormat pixelFormat)

Put a raw image and notify sinks.

Parameters:

data - raw frame native data pointer

size - total size in bytes

width - frame width

height - frame height

stride - size of each row in bytes

pixelFormat - pixel format

putFrame

public void putFrame(ByteBuffer data, int width, int height, int stride, PixelFormat pixelFormat)

Put a raw image and notify sinks.

Parameters:

data - raw frame native ByteBuffer

width - frame width

height - frame height

stride - size of each row in bytes

pixelFormat - pixel format