Package org.freedesktop.gstreamer.gst

Class DeviceProvider.DeviceProviderClass

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeClass

org.gnome.gobject.GObject.ObjectClass

org.gnome.gobject.InitiallyUnowned.InitiallyUnownedClass

org.freedesktop.gstreamer.gst.GstObject.ObjectClass

org.freedesktop.gstreamer.gst.DeviceProvider.DeviceProviderClass

All Implemented Interfaces:

Proxy

Enclosing class:

DeviceProvider

public static class DeviceProvider.DeviceProviderClass
extends GstObject.ObjectClass

The structure of the base GstDeviceProviderClass

Constructor Summary

Constructors

Constructor	Description
DeviceProviderClass()	Allocate a new DeviceProviderClass.
DeviceProviderClass(Arena arena)	Allocate a new DeviceProviderClass.
DeviceProviderClass(MemorySegment address)	Create a DeviceProviderClass proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
void	addMetadata(String key, String value)	Set key with value as metadata in this DeviceProviderClass.
void	addStaticMetadata(String key, String value)	Set key with value as metadata in this DeviceProviderClass.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
String	getMetadata(String key)	Get metadata with key in this DeviceProviderClass.
void	overrideProbe(Arena arena, Method method)	Override virtual method probe.
void	overrideStart(Arena arena, Method method)	Override virtual method start.
void	overrideStop(Arena arena, Method method)	Override virtual method stop.
DeviceProviderFactory	readFactory()	Read the value of the field factory.
MemorySegment	readMetadata()	Read the value of the field metadata.
void	setMetadata(String longname, String classification, String description, String author)	Sets the detailed information for a GstDeviceProviderClass.
void	setStaticMetadata(String longname, String classification, String description, String author)	Sets the detailed information for a GstDeviceProviderClass.
void	writeFactory(DeviceProviderFactory factory)	Write a value in the field factory.
void	writeMetadata(MemorySegment metadata)	Write a value in the field metadata.

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

overrideDeepNotify, readPathStringSeparator, writePathStringSeparator

Methods inherited from class org.gnome.gobject.GObject.ObjectClass

findProperty, installProperties, installProperty, listProperties, overrideConstructed, overrideConstructor, overrideDispatchPropertiesChanged, overrideDispose, overrideFinalize, overrideGetProperty, overrideNotify, overrideProperty, overrideSetProperty, readFlags, readNConstructProperties, readNPspecs, readPdummy, readPspecs, writeFlags, writeNConstructProperties, writeNPspecs, writePdummy, writePspecs

Methods inherited from class org.gnome.gobject.TypeClass

addPrivate, adjustPrivateOffset, getInstancePrivateOffset, getPrivate, peek, peekParent, peekStatic, readGType, ref, unref, unrefUncached, writeGType

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

DeviceProviderClass

public DeviceProviderClass(MemorySegment address)

Create a DeviceProviderClass proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

DeviceProviderClass

public DeviceProviderClass(Arena arena)

Allocate a new DeviceProviderClass.

Parameters:

arena - to control the memory allocation scope

DeviceProviderClass

public DeviceProviderClass()

Allocate a new DeviceProviderClass. The memory is allocated with Arena.ofAuto().

Method Details

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

readFactory

public DeviceProviderFactory readFactory()

Read the value of the field factory.

Returns:

The value of the field factory

writeFactory

public void writeFactory(DeviceProviderFactory factory)

Write a value in the field factory.

Parameters:

factory - The new value for the field factory

overrideProbe

public void overrideProbe(Arena arena,
 Method method)

Override virtual method probe.

Parameters:

method - the method to invoke

overrideStart

public void overrideStart(Arena arena,
 Method method)

Override virtual method start.

Parameters:

method - the method to invoke

overrideStop

public void overrideStop(Arena arena,
 Method method)

Override virtual method stop.

Parameters:

method - the method to invoke

readMetadata

public MemorySegment readMetadata()

Read the value of the field metadata.

Returns:

The value of the field metadata

writeMetadata

public void writeMetadata(MemorySegment metadata)

Write a value in the field metadata.

Parameters:

metadata - The new value for the field metadata

addMetadata

public void addMetadata(String key,
 String value)

Set key with value as metadata in this DeviceProviderClass.

Parameters:

key - the key to set

value - the value to set

addStaticMetadata

public void addStaticMetadata(String key,
 String value)

Set key with value as metadata in this DeviceProviderClass.

Same as gst_device_provider_class_add_metadata(), but value must be a static string or an inlined string, as it will not be copied. (GStreamer plugins will be made resident once loaded, so this function can be used even from dynamically loaded plugins.)

Parameters:

key - the key to set

value - the value to set

getMetadata

public String getMetadata(String key)

Get metadata with key in this DeviceProviderClass.

Parameters:

key - the key to get

Returns:

the metadata for key.

setMetadata

public void setMetadata(String longname,
 String classification,
 String description,
 String author)

Sets the detailed information for a GstDeviceProviderClass.

This function is for use in _class_init functions only.

Parameters:

longname - The long English name of the device provider. E.g. "File Sink"

classification - String describing the type of device provider, as an unordered list separated with slashes ('/'). See draft-klass.txt of the design docs for more details and common types. E.g: "Sink/File"

description - Sentence describing the purpose of the device provider. E.g: "Write stream to a file"

author - Name and contact details of the author(s). Use \\n to separate multiple author metadata. E.g: "Joe Bloggs <joe.blogs at foo.com>"

setStaticMetadata

public void setStaticMetadata(String longname,
 String classification,
 String description,
 String author)

Sets the detailed information for a GstDeviceProviderClass.

This function is for use in _class_init functions only.

Same as gst_device_provider_class_set_metadata(), but longname, classification, description, and author must be static strings or inlined strings, as they will not be copied. (GStreamer plugins will be made resident once loaded, so this function can be used even from dynamically loaded plugins.)

Parameters:

longname - The long English name of the element. E.g. "File Sink"

classification - String describing the type of element, as an unordered list separated with slashes ('/'). See draft-klass.txt of the design docs for more details and common types. E.g: "Sink/File"

description - Sentence describing the purpose of the element. E.g: "Write stream to a file"

author - Name and contact details of the author(s). Use \\n to separate multiple author metadata. E.g: "Joe Bloggs <joe.blogs at foo.com>"