Package org.freedesktop.gstreamer.gst

Class PluginDesc

java.lang.Object

org.javagi.base.ProxyInstance

org.freedesktop.gstreamer.gst.PluginDesc

All Implemented Interfaces:

Proxy

@Generated("io.github.jwharm.JavaGI")
public class PluginDesc
extends ProxyInstance

A plugin should export a variable of this type called plugin_desc. The plugin loader will use the data provided there to initialize the plugin.

The licence parameter must be one of: LGPL, GPL, QPL, GPL/QPL, MPL, BSD, MIT/X11, Proprietary, unknown.

Constructor Summary

Constructors

Constructor	Description
PluginDesc()	Allocate a new PluginDesc.
PluginDesc(int majorVersion, int minorVersion, String name, String description, PluginInitFunc pluginInit, String version, String license, String source, String package_, String origin, String releaseDatetime)	Allocate a new PluginDesc with the fields set to the provided values.
PluginDesc(int majorVersion, int minorVersion, String name, String description, PluginInitFunc pluginInit, String version, String license, String source, String package_, String origin, String releaseDatetime, Arena arena)	Allocate a new PluginDesc with the fields set to the provided values.
PluginDesc(Arena arena)	Allocate a new PluginDesc.
PluginDesc(MemorySegment address)	Create a PluginDesc proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
String	readDescription()	Read the value of the field description.
String	readLicense()	Read the value of the field license.
int	readMajorVersion()	Read the value of the field major_version.
int	readMinorVersion()	Read the value of the field minor_version.
String	readName()	Read the value of the field name.
String	readOrigin()	Read the value of the field origin.
String	readPackage()	Read the value of the field package.
@Nullable PluginInitFunc	readPluginInit()	Read the value of the field plugin_init.
String	readReleaseDatetime()	Read the value of the field release_datetime.
String	readSource()	Read the value of the field source.
String	readVersion()	Read the value of the field version.
void	writeDescription(String description, Arena _arena)	Write a value in the field description.
void	writeLicense(String license, Arena _arena)	Write a value in the field license.
void	writeMajorVersion(int majorVersion)	Write a value in the field major_version.
void	writeMinorVersion(int minorVersion)	Write a value in the field minor_version.
void	writeName(String name, Arena _arena)	Write a value in the field name.
void	writeOrigin(String origin, Arena _arena)	Write a value in the field origin.
void	writePackage(String package_, Arena _arena)	Write a value in the field package.
void	writePluginInit(@Nullable PluginInitFunc pluginInit, Arena _arena)	Write a value in the field plugin_init.
void	writeReleaseDatetime(String releaseDatetime, Arena _arena)	Write a value in the field release_datetime.
void	writeSource(String source, Arena _arena)	Write a value in the field source.
void	writeVersion(String version, Arena _arena)	Write a value in the field version.

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

PluginDesc

public PluginDesc(MemorySegment address)

Create a PluginDesc proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

PluginDesc

public PluginDesc(Arena arena)

Allocate a new PluginDesc.

Parameters:

arena - to control the memory allocation scope

PluginDesc

public PluginDesc()

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

PluginDesc

public PluginDesc(int majorVersion,
 int minorVersion,
 String name,
 String description,
 PluginInitFunc pluginInit,
 String version,
 String license,
 String source,
 String package_,
 String origin,
 String releaseDatetime,
 Arena arena)

Allocate a new PluginDesc with the fields set to the provided values.

Parameters:

majorVersion - value for the field majorVersion

minorVersion - value for the field minorVersion

name - value for the field name

description - value for the field description

pluginInit - value for the field pluginInit

version - value for the field version

license - value for the field license

source - value for the field source

package_ - value for the field package_

origin - value for the field origin

releaseDatetime - value for the field releaseDatetime

arena - to control the memory allocation scope

PluginDesc

public PluginDesc(int majorVersion,
 int minorVersion,
 String name,
 String description,
 PluginInitFunc pluginInit,
 String version,
 String license,
 String source,
 String package_,
 String origin,
 String releaseDatetime)

Allocate a new PluginDesc with the fields set to the provided values. The memory is allocated with Arena.ofAuto().

Parameters:

majorVersion - value for the field majorVersion

minorVersion - value for the field minorVersion

name - value for the field name

description - value for the field description

pluginInit - value for the field pluginInit

version - value for the field version

license - value for the field license

source - value for the field source

package_ - value for the field package_

origin - value for the field origin

releaseDatetime - value for the field releaseDatetime

Method Details

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

readMajorVersion

public int readMajorVersion()

Read the value of the field major_version.

Returns:

The value of the field major_version

writeMajorVersion

public void writeMajorVersion(int majorVersion)

Write a value in the field major_version.

Parameters:

majorVersion - The new value for the field major_version

readMinorVersion

public int readMinorVersion()

Read the value of the field minor_version.

Returns:

The value of the field minor_version

writeMinorVersion

public void writeMinorVersion(int minorVersion)

Write a value in the field minor_version.

Parameters:

minorVersion - The new value for the field minor_version

readName

public String readName()

Read the value of the field name.

Returns:

The value of the field name

writeName

public void writeName(String name,
 Arena _arena)

Write a value in the field name.

Parameters:

name - The new value for the field name

_arena - to control the memory allocation scope

readDescription

public String readDescription()

Read the value of the field description.

Returns:

The value of the field description

writeDescription

public void writeDescription(String description,
 Arena _arena)

Write a value in the field description.

Parameters:

description - The new value for the field description

_arena - to control the memory allocation scope

readPluginInit

public @Nullable PluginInitFunc readPluginInit()

Read the value of the field plugin_init.

Returns:

The value of the field plugin_init

writePluginInit

public void writePluginInit(@Nullable PluginInitFunc pluginInit,
 Arena _arena)

Write a value in the field plugin_init.

Parameters:

pluginInit - The new value for the field plugin_init

_arena - to control the memory allocation scope

readVersion

public String readVersion()

Read the value of the field version.

Returns:

The value of the field version

writeVersion

public void writeVersion(String version,
 Arena _arena)

Write a value in the field version.

Parameters:

version - The new value for the field version

_arena - to control the memory allocation scope

readLicense

public String readLicense()

Read the value of the field license.

Returns:

The value of the field license

writeLicense

public void writeLicense(String license,
 Arena _arena)

Write a value in the field license.

Parameters:

license - The new value for the field license

_arena - to control the memory allocation scope

readSource

public String readSource()

Read the value of the field source.

Returns:

The value of the field source

writeSource

public void writeSource(String source,
 Arena _arena)

Write a value in the field source.

Parameters:

source - The new value for the field source

_arena - to control the memory allocation scope

readPackage

public String readPackage()

Read the value of the field package.

Returns:

The value of the field package

writePackage

public void writePackage(String package_,
 Arena _arena)

Write a value in the field package.

Parameters:

package_ - The new value for the field package

_arena - to control the memory allocation scope

readOrigin

public String readOrigin()

Read the value of the field origin.

Returns:

The value of the field origin

writeOrigin

public void writeOrigin(String origin,
 Arena _arena)

Write a value in the field origin.

Parameters:

origin - The new value for the field origin

_arena - to control the memory allocation scope

readReleaseDatetime

public String readReleaseDatetime()

Read the value of the field release_datetime.

Returns:

The value of the field release_datetime

writeReleaseDatetime

public void writeReleaseDatetime(String releaseDatetime,
 Arena _arena)

Write a value in the field release_datetime.

Parameters:

releaseDatetime - The new value for the field release_datetime

_arena - to control the memory allocation scope