au.edu.jcu.v4l4j

Class ControlList

java.lang.Object

au.edu.jcu.v4l4j.ControlList

public class ControlList
extends Object

Objects of this class encapsulate a list of video source Control. This class can not be directly instantiated. Instead, to retrieve a list of controls from a VideoDevice, use its getControlList() method. Once the control list and associated controls are no longer needed, they must be released by calling releaseControlList(). After that, neither the list nor the controls themselves must be used. If any attempt to use them is made, a StateException will be raised.

Author:

gilles

Method Summary

Modifier and Type	Method and Description
Control	getControl(String n) This method returns a control given its name.
List<Control>	getList() This method returns a list of Controls
Hashtable<String,Control>	getTable() This method returns a map of control names and controls

Methods inherited from class java.lang.Object

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

Method Detail

getTable

public Hashtable<String,Control> getTable()

This method returns a map of control names and controls

Returns:

a map of control names and controls

Throws:

StateException - if this control list has been released and must not be used anymore

getList

public List<Control> getList()

This method returns a list of Controls

Returns:

a list of Controls

Throws:

StateException - if this control list has been released and must not be used anymore

getControl

public Control getControl(String n)

This method returns a control given its name.

Returns:

the control matching the given name, null otherwise

Throws:

StateException - if this control list has been released and must not be used anymore