Package edu.wpi.first.cscore

Class VideoEvent

java.lang.Object

edu.wpi.first.cscore.VideoEvent

public class VideoEvent
extends Object

Video event.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	VideoEvent.Kind	VideoEvent kind.

Field Summary

Fields

Modifier and Type	Field	Description
VideoEvent.Kind	kind	The video event kind.
int	listener	Listener that was triggered.
VideoMode	mode	New source video mode.
String	name	Source/sink/property name.
int	propertyHandle	Source property handle.
VideoProperty.Kind	propertyKind	Source property kind.
int	sinkHandle	The sink handle.
int	sourceHandle	The source handle.
int	value	Event value.
String	valueStr	Event value as a string.

Method Summary

Modifier and Type	Method	Description
static VideoEvent.Kind	getKindFromInt(int kind)	Convert from the numerical representation of kind to an enum type.
VideoProperty	getProperty()	Returns the property associated with the event (if any).
VideoSink	getSink()	Returns the sink associated with the event (if any).
VideoSource	getSource()	Returns the source associated with the event (if any).

Methods inherited from class java.lang.Object

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

Field Details

kind

public VideoEvent.Kind kind

The video event kind.

sourceHandle

public int sourceHandle

The source handle.

Valid for kSource* and kSink* respectively.

sinkHandle

public int sinkHandle

The sink handle.

name

public String name

Source/sink/property name.

mode

public VideoMode mode

New source video mode.

propertyHandle

public int propertyHandle

Source property handle.

propertyKind

public VideoProperty.Kind propertyKind

Source property kind.

value

public int value

Event value.

valueStr

public String valueStr

Event value as a string.

listener

public int listener

Listener that was triggered.

Method Details

getKindFromInt

public static VideoEvent.Kind getKindFromInt(int kind)

Convert from the numerical representation of kind to an enum type.

Parameters:

kind - The numerical representation of kind

Returns:

The kind

getSource

public VideoSource getSource()

Returns the source associated with the event (if any).

Returns:

The source associated with the event (if any).

getSink

public VideoSink getSink()

Returns the sink associated with the event (if any).

Returns:

The sink associated with the event (if any).

getProperty

public VideoProperty getProperty()

Returns the property associated with the event (if any).

Returns:

The property associated with the event (if any).