Package org.freedesktop.gstreamer.gst

Class Stream

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

All Implemented Interfaces:

Proxy

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

A high-level object representing a single stream. It might be backed, or not, by an actual flow of data in a pipeline (GstPad).

A GstStream does not care about data changes (such as decoding, encoding, parsing,...) as long as the underlying data flow corresponds to the same high-level flow (ex: a certain audio track).

A GstStream contains all the information pertinent to a stream, such as stream-id, tags, caps, type, ...

Elements can subclass a GstStream for internal usage (to contain information pertinent to streams of data).

Since:

1.10

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Stream.Builder<B extends Stream.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static class	Stream.StreamClass	GstStream class structure

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
Stream()	Creates a new Stream.
Stream(@Nullable String streamId, @Nullable Caps caps, Set<StreamType> type, Set<StreamFlags> flags)	Create a new GstStream for the given streamId, caps, type and flags
Stream(@Nullable String streamId, @Nullable Caps caps, StreamType type, StreamFlags... flags)	Create a new GstStream for the given streamId, caps, type and flags
Stream(MemorySegment address)	Create a Stream proxy instance for the provided memory address.

Method Summary

Modifier and Type	Method	Description
protected Stream	asParent()	Returns this instance as if it were its parent type.
static Stream.Builder<? extends Stream.Builder>	builder()	A Stream.Builder object constructs a Stream with the specified properties.
@Nullable Caps	getCaps()	Retrieve the caps for stream, if any
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
Set<StreamFlags>	getStreamFlags()	Retrieve the current stream flags for this Stream
@Nullable String	getStreamId()	Returns the stream ID of stream.
Set<StreamType>	getStreamType()	Retrieve the stream type for this Stream
@Nullable TagList	getTags()	Retrieve the tags for stream, if any
static @Nullable Type	getType()	Get the GType of the Stream class
void	setCaps(@Nullable Caps caps)	Set the caps for the GstStream
void	setStreamFlags(Set<StreamFlags> flags)	Set the flags for the stream.
void	setStreamFlags(StreamFlags... flags)	Set the flags for the stream.
void	setStreamType(Set<StreamType> streamType)	Set the stream type of this Stream
void	setStreamType(StreamType... streamType)	Set the stream type of this Stream
void	setTags(@Nullable TagList tags)	Set the tags for the GstStream

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, 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

Stream

public Stream(MemorySegment address)

Create a Stream proxy instance for the provided memory address.

Parameters:

address - the memory address of the native object

Stream

public Stream(@Nullable String streamId,
 @Nullable Caps caps,
 Set<StreamType> type,
 Set<StreamFlags> flags)

Create a new GstStream for the given streamId, caps, type and flags

Parameters:

streamId - the id for the new stream. If null, a new one will be automatically generated

caps - the GstCaps of the stream

type - the GstStreamType of the stream

flags - the GstStreamFlags of the stream

Since:

1.10

Stream

public Stream(@Nullable String streamId,
 @Nullable Caps caps,
 StreamType type,
 StreamFlags... flags)

Create a new GstStream for the given streamId, caps, type and flags

Parameters:

streamId - the id for the new stream. If null, a new one will be automatically generated

caps - the GstCaps of the stream

type - the GstStreamType of the stream

flags - the GstStreamFlags of the stream

Since:

1.10

Stream

public Stream()

Creates a new Stream.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Stream class

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

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

getCaps

public @Nullable Caps getCaps()

Retrieve the caps for stream, if any

Returns:

The GstCaps for this Stream

Since:

1.10

getStreamFlags

public Set<StreamFlags> getStreamFlags()

Retrieve the current stream flags for this Stream

Returns:

The GstStreamFlags for this Stream

Since:

1.10

getStreamId

public @Nullable String getStreamId()

Returns the stream ID of stream.

Returns:

the stream ID of stream. Only valid during the lifetime of stream.

Since:

1.10

getStreamType

public Set<StreamType> getStreamType()

Retrieve the stream type for this Stream

Returns:

The GstStreamType for this Stream

Since:

1.10

getTags

public @Nullable TagList getTags()

Retrieve the tags for stream, if any

Returns:

The GstTagList for this Stream

Since:

1.10

setCaps

public void setCaps(@Nullable Caps caps)

Set the caps for the GstStream

Parameters:

caps - a GstCaps

Since:

1.10

setStreamFlags

public void setStreamFlags(Set<StreamFlags> flags)

Set the flags for the stream.

Parameters:

flags - the flags to set on this Stream

Since:

1.10

setStreamFlags

public void setStreamFlags(StreamFlags... flags)

Set the flags for the stream.

Parameters:

flags - the flags to set on this Stream

Since:

1.10

setStreamType

public void setStreamType(Set<StreamType> streamType)

Set the stream type of this Stream

Parameters:

streamType - the type to set on this Stream

Since:

1.10

setStreamType

public void setStreamType(StreamType... streamType)

Set the stream type of this Stream

Parameters:

streamType - the type to set on this Stream

Since:

1.10

setTags

public void setTags(@Nullable TagList tags)

Set the tags for the GstStream

Parameters:

tags - a GstTagList

Since:

1.10

builder

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

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

Returns:

the builder object