Package org.freedesktop.gstreamer.gst

Class StreamCollection

java.lang.Object

io.github.jwharm.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.gnome.gobject.InitiallyUnowned

org.freedesktop.gstreamer.gst.GstObject

org.freedesktop.gstreamer.gst.StreamCollection

All Implemented Interfaces:

Proxy

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

A collection of GstStream that are available.

A GstStreamCollection will be provided by elements that can make those streams available. Applications can use the collection to show the user what streams are available by using getStream(int)()

Once posted, a GstStreamCollection is immutable. Updates are made by sending a new GstStreamCollection message, which may or may not share some of the GstStream objects from the collection it replaces. The receiver can check the sender of a stream collection message to know which collection is obsoleted.

Several elements in a pipeline can provide GstStreamCollection.

Applications can activate streams from a collection by using the GST_EVENT_SELECT_STREAMS event on a pipeline, bin or element.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StreamCollection.Builder<B extends StreamCollection.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	StreamCollection.StreamCollectionClass	GstStreamCollection class structure
static interface	StreamCollection.StreamNotifyCallback	Functional interface declaration of the StreamNotifyCallback callback.

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

GstObject.DeepNotifyCallback, GstObject.ObjectClass, GstObject.ObjectImpl

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
StreamCollection()	Calls StreamCollection(java.lang.String) with upstreamId = null
StreamCollection(@Nullable String upstreamId)	Create a new GstStreamCollection.
StreamCollection(MemorySegment address)	Create a StreamCollection proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
boolean	addStream(Stream stream)	Add the given stream to the this StreamCollection.
protected StreamCollection	asParent()	Returns this instance as if it were its parent type.
static StreamCollection.Builder<? extends StreamCollection.Builder>	builder()	A StreamCollection.Builder object constructs a StreamCollection with the specified properties.
void	emitStreamNotify(@Nullable String detail, Stream propStream, ParamSpec prop)	Emits the "stream-notify" signal.
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
int	getSize()	Get the number of streams this collection contains
Stream	getStream(int index)	Retrieve the GstStream with index index from the collection.
static Type	getType()	Get the GType of the StreamCollection class
String	getUpstreamId()	Returns the upstream id of the this StreamCollection.
SignalConnection<StreamCollection.StreamNotifyCallback>	onStreamNotify(@Nullable String detail, StreamCollection.StreamNotifyCallback handler)	The stream notify signal is used to be notified of property changes to streams within the collection.
protected void	streamNotify(Stream stream, ParamSpec pspec)	default signal handler for the stream-notify signal

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.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, getPrivate, readGClass, writeGClass

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

StreamCollection

public StreamCollection(MemorySegment address)

Create a StreamCollection proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

StreamCollection

public StreamCollection(@Nullable
 @Nullable String upstreamId)

Create a new GstStreamCollection.

Parameters:

upstreamId - The stream id of the parent stream

StreamCollection

public StreamCollection()

Calls StreamCollection(java.lang.String) with upstreamId = null

Method Details

getType

public static Type getType()

Get the GType of the StreamCollection class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

addStream

public boolean addStream(Stream stream)

Add the given stream to the this StreamCollection.

Parameters:

stream - the GstStream to add

Returns:

true if the stream was properly added, else false

getSize

public int getSize()

Get the number of streams this collection contains

Returns:

The number of streams that this StreamCollection contains

getStream

public Stream getStream(int index)

Retrieve the GstStream with index index from the collection.

The caller should not modify the returned GstStream

Parameters:

index - Index of the stream to retrieve

Returns:

A GstStream

getUpstreamId

public String getUpstreamId()

Returns the upstream id of the this StreamCollection.

Returns:

The upstream id

streamNotify

protected void streamNotify(Stream stream,
 ParamSpec pspec)

default signal handler for the stream-notify signal

onStreamNotify

public SignalConnection<StreamCollection.StreamNotifyCallback> onStreamNotify(@Nullable
 @Nullable String detail,
 StreamCollection.StreamNotifyCallback handler)

The stream notify signal is used to be notified of property changes to streams within the collection.

Parameters:

detail - the signal detail

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• StreamCollection.StreamNotifyCallback.run(org.freedesktop.gstreamer.gst.Stream, org.gnome.gobject.ParamSpec)

emitStreamNotify

public void emitStreamNotify(@Nullable
 @Nullable String detail,
 Stream propStream,
 ParamSpec prop)

Emits the "stream-notify" signal. See onStreamNotify(java.lang.String, org.freedesktop.gstreamer.gst.StreamCollection.StreamNotifyCallback).

builder

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

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