Package org.freedesktop.gstreamer.gst

Class Device

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.freedesktop.gstreamer.gst.GstObject

org.freedesktop.gstreamer.gst.Device

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

Device.DeviceImpl

@Generated("io.github.jwharm.JavaGI")
public abstract class Device
extends GstObject

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

GstDevice are created by GstDeviceProvider objects which can be aggregated by GstDeviceMonitor objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Device.Builder<B extends Device.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	Device.DeviceClass	The class structure for a GstDevice object.
static class	Device.DeviceImpl	The DeviceImpl type represents a native instance of the abstract Device class.
static interface	Device.RemovedCallback	Functional interface declaration of the RemovedCallback callback.

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

GstObject.DeepNotifyCallback, GstObject.ObjectClass, GstObject.ObjectImpl

Nested classes/interfaces inherited from class org.gnome.gobject.InitiallyUnowned

InitiallyUnowned.InitiallyUnownedClass

Nested classes/interfaces inherited from class org.gnome.gobject.GObject

GObject.NotifyCallback

Constructor Summary

Constructors

Constructor	Description
Device(MemorySegment address)	Create a Device proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected Device	asParent()	Returns this instance as if it were its parent type.
static Device.Builder<? extends Device.Builder>	builder()	A Device.Builder object constructs a Device with the specified properties.
Element	createElement(@Nullable String name)	Creates the element with all of the required parameters set to use this device.
void	emitRemoved()
Caps	getCaps()	Getter for the GstCaps that this device supports.
String	getDeviceClass()	Gets the "class" of a device.
String	getDisplayName()	Gets the user-friendly name of the device.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
Structure	getProperties()	Gets the extra properties of a device.
static Type	getType()	Get the GType of the Device class
boolean	hasClasses(String classes)	Check if this Device matches all of the given classes
boolean	hasClassesv(String[] classes)	Check if factory matches all of the given classes
SignalConnection<Device.RemovedCallback>	onRemoved(Device.RemovedCallback handler)
boolean	reconfigureElement(Element element)	Tries to reconfigure an existing element to use the device.

Methods inherited from class org.freedesktop.gstreamer.gst.GstObject

addControlBinding, checkUniqueness, deepNotify, defaultDeepNotify, defaultError, emitDeepNotify, getControlBinding, getControlRate, getGValueArray, getName, getParent, getPathString, getValue, getValueArray, hasActiveControlBindings, hasAncestor, hasAsAncestor, hasAsParent, onDeepNotify, ref, refSink, removeControlBinding, replace, setControlBindingDisabled, setControlBindingsDisabled, setControlRate, setName, setParent, suggestNextSync, syncValues, unparent, unref

Methods inherited from class org.gnome.gobject.GObject

addToggleRef, addWeakPointer, bindProperty, bindProperty, bindProperty, bindPropertyFull, bindPropertyFull, bindPropertyWithClosures, bindPropertyWithClosures, compatControl, connect, connect, connect, constructed, disconnect, dispatchPropertiesChanged, dispose, dupData, dupQdata, emit, emitNotify, finalize_, forceFloating, freezeNotify, get, getData, getProperty, getProperty, getProperty, getQdata, getv, interfaceFindProperty, interfaceInstallProperty, interfaceListProperties, isFloating, newInstance, newInstance, newInstance, newInstance, newv, notify_, notify_, notifyByPspec, onNotify, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class org.gnome.gobject.TypeInstance

callParent, callParent, getPrivate, readGClass, writeGClass

Methods inherited from class io.github.jwharm.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

Device

public Device(MemorySegment address)

Create a Device proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Method Details

getType

public static Type getType()

Get the GType of the Device class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected Device asParent()

Returns this instance as if it were its parent type. This is mostly synonymous to the Java super keyword, but will set the native typeclass function pointers to the parent type. When overriding a native virtual method in Java, "chaining up" with super.methodName() doesn't work, because it invokes the overridden function pointer again. To chain up, call asParent().methodName(). This will call the native function pointer of this virtual method in the typeclass of the parent type.

Overrides:

asParent in class GstObject

createElement

public Element createElement(@Nullable
 @Nullable 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 GstElement configured to use this device

getCaps

public Caps getCaps()

Getter for the GstCaps that this device supports.

Returns:

The GstCaps supported by this device. Unref with gst_caps_unref() when done.

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 GstDeviceProvider that produced this device.

Returns:

The device class. Free with g_free() after use.

getDisplayName

public String getDisplayName()

Gets the user-friendly name of the device.

Returns:

The device name. Free with g_free() after use.

getProperties

public Structure getProperties()

Gets the extra properties of a device.

Returns:

The extra properties or null when there are none. Free with gst_structure_free() after use.

hasClasses

public boolean hasClasses(String classes)

Check if this 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 this Device matches.

hasClassesv

public boolean hasClassesv(String[] classes)

Check if factory matches all of the given classes

Parameters:

classes - a null terminated array of classes to match, only match if all classes are matched

Returns:

true if this 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 gst_device_create_element().

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

Parameters:

element - a GstElement

Returns:

true if the element could be reconfigured to use this device, false otherwise.

onRemoved

public SignalConnection<Device.RemovedCallback> onRemoved(Device.RemovedCallback handler)

See Also:

• Device.RemovedCallback.run()

emitRemoved

public void emitRemoved()

builder

public static Device.Builder<? extends Device.Builder> builder()

A Device.Builder object constructs a Device with the specified properties. Use the various set...() methods to set properties, and finish construction with Device.Builder.build().