Interface PadEventFullFunction

All Superinterfaces:

FunctionPointer

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
@Generated("org.javagi.JavaGI")
public interface PadEventFullFunction
extends FunctionPointer

Functional interface declaration of the PadEventFullFunction callback.

See Also:

• run(Pad, GstObject, Event)

Method Summary

Modifier and Type	Method	Description
FlowReturn	run(Pad pad, @Nullable GstObject parent, Event event)	Function signature to handle an event for the pad.
default MemorySegment	toCallback(Arena arena)	Creates a native function pointer to the upcall(MemorySegment, MemorySegment, MemorySegment) method.
default int	upcall(MemorySegment pad, MemorySegment parent, MemorySegment event)	The upcall method is called from native code.

Method Details

run

FlowReturn run(Pad pad,
 @Nullable GstObject parent,
 Event event)

Function signature to handle an event for the pad.

This variant is for specific elements that will take into account the last downstream flow return (from a pad push), in which case they can return it.

Parameters:

pad - the GstPad to handle the event.

parent - the parent of pad. If the GST_PAD_FLAG_NEED_PARENT flag is set, parent is guaranteed to be not-null and remain valid during the execution of this function.

event - the GstEvent to handle.

Returns:

FlowReturn.OK if the event was handled properly, or any other GstFlowReturn dependent on downstream state.

Since:

1.8

upcall

default int upcall(MemorySegment pad,
 MemorySegment parent,
 MemorySegment event)

The upcall method is called from native code. The parameters are marshaled and run(Pad, GstObject, Event) is executed.

toCallback

default MemorySegment toCallback(Arena arena)

Creates a native function pointer to the upcall(MemorySegment, MemorySegment, MemorySegment) method.

Specified by:

toCallback in interface FunctionPointer

Parameters:

arena - the arena in which the function pointer is allocated

Returns:

the native function pointer