Package org.freedesktop.gstreamer.gst

Class DeviceProviderFactory

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.freedesktop.gstreamer.gst.GstObject

org.freedesktop.gstreamer.gst.PluginFeature

org.freedesktop.gstreamer.gst.DeviceProviderFactory

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class DeviceProviderFactory
extends PluginFeature

GstDeviceProviderFactory is used to create instances of device providers. A GstDeviceProviderfactory can be added to a GstPlugin as it is also a GstPluginFeature.

Use the gst_device_provider_factory_find() and gst_device_provider_factory_get() functions to create device provider instances or use gst_device_provider_factory_get_by_name() as a convenient shortcut.

Since:

1.4

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeviceProviderFactory.Builder<B extends DeviceProviderFactory.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	DeviceProviderFactory.DeviceProviderFactoryClass	The opaque GstDeviceProviderFactoryClass data structure.

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

PluginFeature.PluginFeature$Impl, PluginFeature.PluginFeatureClass

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

GstObject.DeepNotifyCallback, GstObject.Object$Impl, GstObject.ObjectClass

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
DeviceProviderFactory()	Creates a new DeviceProviderFactory.
DeviceProviderFactory(MemorySegment address)	Create a DeviceProviderFactory proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected DeviceProviderFactory	asParent()	Returns this instance as if it were its parent type.
static DeviceProviderFactory.Builder<? extends DeviceProviderFactory.Builder>	builder()	A DeviceProviderFactory.Builder object constructs a DeviceProviderFactory with the specified properties.
static @Nullable DeviceProviderFactory	find(String name)	Search for an device provider factory of the given name.
@Nullable DeviceProvider	get()	Returns the device provider of the type defined by the given device providerfactory.
static @Nullable DeviceProvider	getByName(String factoryname)	Returns the device provider of the type defined by the given device provider factory.
Type	getDeviceProviderType()	Get the GType for device providers managed by this factory.
@Nullable String	getMetadata(String key)	Get the metadata on this DeviceProviderFactory with key.
@Nullable String @Nullable []	getMetadataKeys()	Get the available keys for the metadata on factory.
static @Nullable Type	getType()	Get the GType of the DeviceProviderFactory class
boolean	hasClasses(@Nullable String classes)	Check if this DeviceProviderFactory matches all of the given classes
boolean	hasClassesv(@Nullable String @Nullable [] classes)	Check if this DeviceProviderFactory matches all of the given classes
static List<DeviceProviderFactory>	listGetDeviceProviders(Rank minrank)	Get a list of factories with a rank greater or equal to minrank. The list of factories is returned by decreasing rank.

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

checkVersion, getPlugin, getPluginName, getRank, listCopy, listDebug, listFree, load, rankCompareFunc, setRank

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

addControlBinding, checkUniqueness, deepNotify, defaultDeepNotify, defaultError, emitDeepNotify, getControlBinding, getControlRate, getGValueArray, getMemoryLayout, 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, 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, cast, getPrivate, readGClass, writeGClass

Methods inherited from class org.javagi.base.ProxyInstance

equals, handle, hashCode

Methods inherited from class java.lang.Object

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

Constructor Details

DeviceProviderFactory

public DeviceProviderFactory(MemorySegment address)

Create a DeviceProviderFactory proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

DeviceProviderFactory

public DeviceProviderFactory()

Creates a new DeviceProviderFactory.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the DeviceProviderFactory class

Returns:

the GType

asParent

protected DeviceProviderFactory 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 PluginFeature

find

public static @Nullable DeviceProviderFactory find(String name)

Search for an device provider factory of the given name. Refs the returned device provider factory; caller is responsible for unreffing.

Parameters:

name - name of factory to find

Returns:

GstDeviceProviderFactory if found, null otherwise

Since:

1.4

getByName

public static @Nullable DeviceProvider getByName(String factoryname)

Returns the device provider of the type defined by the given device provider factory.

Parameters:

factoryname - a named factory to instantiate

Returns:

a GstDeviceProvider or null if unable to create device provider

Since:

1.4

listGetDeviceProviders

public static List<DeviceProviderFactory> listGetDeviceProviders(Rank minrank)

Get a list of factories with a rank greater or equal to minrank. The list of factories is returned by decreasing rank.

Parameters:

minrank - Minimum rank

Returns:

a GList of GstDeviceProviderFactory device providers. Use gst_plugin_feature_list_free() after usage.

Since:

1.4

get

public @Nullable DeviceProvider get()

Returns the device provider of the type defined by the given device providerfactory.

Returns:

the GstDeviceProvider or null if the device provider couldn't be created

Since:

1.4

getDeviceProviderType

public Type getDeviceProviderType()

Get the GType for device providers managed by this factory. The type can only be retrieved if the device provider factory is loaded, which can be assured with gst_plugin_feature_load().

Returns:

the GType for device providers managed by this factory.

Since:

1.4

getMetadata

public @Nullable String getMetadata(String key)

Get the metadata on this DeviceProviderFactory with key.

Parameters:

key - a key

Returns:

the metadata with key on this DeviceProviderFactory or null when there was no metadata with the given key.

Since:

1.4

getMetadataKeys

public @Nullable String @Nullable [] getMetadataKeys()

Get the available keys for the metadata on factory.

Returns:

a null-terminated array of key strings, or null when there is no metadata. Free with g_strfreev() when no longer needed.

Since:

1.4

hasClasses

public boolean hasClasses(@Nullable String classes)

Check if this DeviceProviderFactory matches all of the given classes

Parameters:

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

Returns:

true if this DeviceProviderFactory matches or if classes is null.

Since:

1.4

hasClassesv

public boolean hasClassesv(@Nullable String @Nullable [] classes)

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

Since:

1.4

builder

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

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

Returns:

the builder object