Package org.freedesktop.gstreamer.gst

Class Allocator

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

All Implemented Interfaces:

Proxy

Direct Known Subclasses:

Allocator.Allocator$Impl

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

Memory is usually created by allocators with a gst_allocator_alloc() method call. When null is used as the allocator, the default allocator will be used.

New allocators can be registered with gst_allocator_register(). Allocators are identified by name and can be retrieved with gst_allocator_find(). gst_allocator_set_default() can be used to change the default allocator.

New memory can be created with gst_memory_new_wrapped() that wraps the memory allocated elsewhere.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Allocator.Allocator$Impl	The Allocator$Impl type represents a native instance of the abstract Allocator class.
static class	Allocator.AllocatorClass	The GstAllocator is used to create new memory.
static class	Allocator.Builder<B extends Allocator.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.

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

Method Summary

Modifier and Type	Method	Description
@Nullable Memory	alloc(long size, @Nullable AllocationParams params)	Use this Allocator to allocate a new memory block with memory that is at least size big.
protected Allocator	asParent()	Returns this instance as if it were its parent type.
static @Nullable Allocator	find(@Nullable String name)	Find a previously registered allocator with name. When name is null, the default allocator will be returned.
void	free(Memory memory)	Free memory that was previously allocated with gst_allocator_alloc().
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the Allocator class
static void	register(String name, Allocator allocator)	Registers the memory allocator with name.
void	setDefault()	Set the default allocator.

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

builder

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

Allocator

public Allocator(MemorySegment address)

Create a Allocator proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Allocator

public Allocator()

Creates a new Allocator.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Allocator class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected Allocator 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

find

public static @Nullable Allocator find(@Nullable String name)

Find a previously registered allocator with name. When name is null, the default allocator will be returned.

Parameters:

name - the name of the allocator

Returns:

a GstAllocator or null when the allocator with name was not registered.

register

public static void register(String name,
 Allocator allocator)

Registers the memory allocator with name.

Parameters:

name - the name of the allocator

allocator - GstAllocator

alloc

public @Nullable Memory alloc(long size,
 @Nullable AllocationParams params)

Use this Allocator to allocate a new memory block with memory that is at least size big.

The optional params can specify the prefix and padding for the memory. If null is passed, no flags, no extra prefix/padding and a default alignment is used.

The prefix/padding will be filled with 0 if flags contains GST_MEMORY_FLAG_ZERO_PREFIXED and GST_MEMORY_FLAG_ZERO_PADDED respectively.

When this Allocator is null, the default allocator will be used.

The alignment in params is given as a bitmask so that align + 1 equals the amount of bytes to align to. For example, to align to 8 bytes, use an alignment of 7.

Parameters:

size - size of the visible memory area

params - optional parameters

Returns:

a new GstMemory.

free

public void free(Memory memory)

Free memory that was previously allocated with gst_allocator_alloc().

Parameters:

memory - the memory to free

setDefault

public void setDefault()

Set the default allocator.