org.freedesktop.gstreamer.device

Class Device

java.lang.Object

org.freedesktop.gstreamer.glib.NativeObject

org.freedesktop.gstreamer.glib.RefCountedObject

org.freedesktop.gstreamer.glib.GObject

org.freedesktop.gstreamer.GstObject

org.freedesktop.gstreamer.device.Device

All Implemented Interfaces:

AutoCloseable

public class Device
extends GstObject

Devices are objects representing a device, they contain relevant metadata about the device, such as its class and the GstCaps representing the media types it can produce or handle.

See upstream documentation at https://gstreamer.freedesktop.org/data/doc/gstreamer/stable/gstreamer/html/gstreamer-GstDevice.html

Device objects are created by DeviceProvider objects, which can be aggregated by DeviceMonitor objects.

Nested Class Summary

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.GstObject

GstObject.Handle

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.GObject

GObject.GCallback, GObject.GInterface

Nested classes/interfaces inherited from class org.freedesktop.gstreamer.glib.NativeObject

NativeObject.Initializer, NativeObject.TypeProvider, NativeObject.TypeRegistration<T extends NativeObject>

Field Summary

Fields

Modifier and Type	Field and Description
static String	GTYPE_NAME

Method Summary

Modifier and Type	Method and Description
Element	createElement(String name) Creates the element with all of the required parameters set to use this device.
Caps	getCaps() Get the Caps that this device supports.
String	getDeviceClass() Gets the "class" of a device.
String	getDisplayName() Gets the user-friendly name of the device.
Structure	getProperties() Gets the extra properties of a device.
boolean	hasClasses(String classes) Check if device matches all of the given classes.
boolean	hasClasses(String[] classes) Check if device matches all of the given classes.
boolean	reconfigureElement(Element element) Tries to reconfigure an existing element to use the device.

Methods inherited from class org.freedesktop.gstreamer.GstObject

addControlBinding, getAsString, getControlBinding, getName, getParent, hasActiveControlBindings, removeControlBinding, setAsString, setControlBindingDisabled, setControlBindingsDisabled, setName, suggestNextSync, syncValues, toString

Methods inherited from class org.freedesktop.gstreamer.glib.GObject

addCallback, connect, connect, disconnect, dispose, emit, emit, get, getPropertyDefaultValue, getPropertyMaximumValue, getPropertyMinimumValue, getRefCount, getTypeName, invalidate, listPropertyNames, removeCallback, set

Methods inherited from class org.freedesktop.gstreamer.glib.NativeObject

close, disown, equals, getPointer, getRawPointer, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

GTYPE_NAME

public static final String GTYPE_NAME

See Also:

Constant Field Values

Method Detail

createElement

public Element createElement(String name)

Creates the element with all of the required parameters set to use this device.

Parameters:

name - name of new element, or NULL to automatically create a unique name

Returns:

a new Element configured to use this device.

getCaps

public Caps getCaps()

Get the Caps that this device supports.

Returns:

The Caps supported by this device.

getDeviceClass

public String getDeviceClass()

Gets the "class" of a device. This is a "/" separated list of classes that represent this device. They are a subset of the classes of the DeviceProvider that produced this device.

Returns:

class the device class

getDisplayName

public String getDisplayName()

Gets the user-friendly name of the device.

Returns:

name of the device

hasClasses

public boolean hasClasses(String classes)

Check if device matches all of the given classes.

Parameters:

classes - a "/"-separated list of device classes to match, only match if all classes are matched

Returns:

true if device matches

hasClasses

public boolean hasClasses(String[] classes)

Check if device matches all of the given classes.

Parameters:

classes - an array of classes to match, only match if all classes are matched.

Returns:

true if device matches

reconfigureElement

public boolean reconfigureElement(Element element)

Tries to reconfigure an existing element to use the device. If this function fails, then one must destroy the element and create a new one using createElement(java.lang.String)

Note: This should only be implemented for elements can change their device in the PLAYING state.

Parameters:

element - the element to be configured

Returns:

true if the element could be reconfigured to use this device

getProperties

public Structure getProperties()

Gets the extra properties of a device.

Returns:

The extra properties or NULL when there are none.