org.freedesktop.gstreamer.device

Class DeviceProvider

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.DeviceProvider

All Implemented Interfaces:

AutoCloseable

public class DeviceProvider
extends GstObject

A device provider.

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

A DeviceProvider subclass is provided by a plugin that handles devices if there is a way to programatically list connected devices. It can also optionally provide updates to the list of connected devices.

Each DeviceProvider subclass is a singleton, a plugin should normally provide a single subclass for all devices.

Applications would normally use a DeviceMonitor to monitor devices from all relevant providers.

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
boolean	canMonitor() Whether the provider can monitor.
Bus	getBus() Get the Bus of this DeviceProvider
List<Device>	getDevices() Gets a list of Device that this provider understands.
DeviceProviderFactory	getFactory() Retrieves the factory that was used to create this device provider.
boolean	start() Starts providering the devices.
void	stop() Decreases the use-count by one.

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

canMonitor

public boolean canMonitor()

Whether the provider can monitor.

Returns:

true if the provider can monitor

getBus

public Bus getBus()

Get the Bus of this DeviceProvider

Returns:

bus

getDevices

public List<Device> getDevices()

Gets a list of Device that this provider understands. This may actually probe the hardware if the provider is not currently started.

Returns:

device list

getFactory

public DeviceProviderFactory getFactory()

Retrieves the factory that was used to create this device provider.

Returns:

the DeviceProviderFactory used for creating this device provider.

start

public boolean start()

Starts providering the devices. This will cause GST_MESSAGE_DEVICE_ADDED and GST_MESSAGE_DEVICE_REMOVED messages to be posted on the provider's bus when devices are added or removed from the system.

Since the DeviceProvider is a singleton, start may already have been called by another user of the object, stop() needs to be called the same number of times.

Returns:

true if the device providering could be started.

stop

public void stop()

Decreases the use-count by one. If the use count reaches zero, this DeviceProvider will stop providering the devices. This needs to be called the same number of times that start() was called.