Class Discoverer

java.lang.Object

org.javagi.base.ProxyInstance

org.gnome.gobject.TypeInstance

org.gnome.gobject.GObject

org.freedesktop.gstreamer.pbutils.Discoverer

All Implemented Interfaces:

Proxy

@Generated("org.javagi.JavaGI")
public class Discoverer
extends GObject

The GstDiscoverer is a utility object which allows to get as much information as possible from one or many URIs.

It provides two APIs, allowing usage in blocking or non-blocking mode.

The blocking mode just requires calling gst_discoverer_discover_uri() with the URI one wishes to discover.

The non-blocking mode requires a running GMainLoop iterating a GMainContext, where one connects to the various signals, appends the URIs to be processed (through gst_discoverer_discover_uri_async()) and then asks for the discovery to begin (through gst_discoverer_start()). By default this will use the GLib default main context unless you have set a custom context using g_main_context_push_thread_default().

All the information is returned in a GstDiscovererInfo structure.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Discoverer.Builder<B extends Discoverer.Builder<B>>	Inner class implementing a builder pattern to construct a GObject with properties.
static interface	Discoverer.DiscoveredCallback	Functional interface declaration of the DiscoveredCallback callback.
static class	Discoverer.DiscovererClass
static interface	Discoverer.FinishedCallback	Functional interface declaration of the FinishedCallback callback.
static interface	Discoverer.LoadSerializedInfoCallback	Functional interface declaration of the LoadSerializedInfoCallback callback.
static interface	Discoverer.SourceSetupCallback	Functional interface declaration of the SourceSetupCallback callback.
static interface	Discoverer.StartingCallback	Functional interface declaration of the StartingCallback callback.

Nested classes/interfaces inherited from class GObject

GObject.NotifyCallback, GObject.ObjectClass

Constructor Summary

Constructors

Constructor	Description
Discoverer()	Create a new Discoverer.
Discoverer(MemorySegment address)	Create a Discoverer instance for the provided memory address.
Discoverer(ClockTime timeout)	Creates a new GstDiscoverer with the provided timeout.

Method Summary

Modifier and Type	Method	Description
protected Discoverer	asParent()	Return this instance as if it were its parent type.
static Discoverer.Builder<? extends Discoverer.Builder>	builder()	A Discoverer.Builder object constructs a Discoverer with the specified properties.
protected void	discovered(DiscovererInfo info, GError err)
DiscovererInfo	discoverUri(String uri)	Synchronously discovers the given uri.
boolean	discoverUriAsync(String uri)	Appends the given uri to the list of URIs to discoverer.
void	emitDiscovered(@Nullable DiscovererInfo info, @Nullable GError error)	Emits the "discovered" signal.
void	emitFinished()	Emits the "finished" signal.
DiscovererInfo	emitLoadSerializedInfo(String uri)	Emits the "load-serialized-info" signal.
void	emitSourceSetup(@Nullable Element source)	Emits the "source-setup" signal.
void	emitStarting()	Emits the "starting" signal.
protected void	finished()
static MemoryLayout	getMemoryLayout()	The memory layout of the native struct.
static @Nullable Type	getType()	Get the GType of the Discoverer class.
protected DiscovererInfo	loadSerializeInfo(String uri)	Loads the serialized info from the given uri.
SignalConnection<Discoverer.DiscoveredCallback>	onDiscovered(Discoverer.DiscoveredCallback handler)	Will be emitted in async mode when all information on a URI could be discovered, or an error occurred.
SignalConnection<Discoverer.FinishedCallback>	onFinished(Discoverer.FinishedCallback handler)	Will be emitted in async mode when all pending URIs have been processed.
SignalConnection<Discoverer.LoadSerializedInfoCallback>	onLoadSerializedInfo(Discoverer.LoadSerializedInfoCallback handler)	Retrieves information about a URI from and external source of information, like a cache file.
SignalConnection<Discoverer.SourceSetupCallback>	onSourceSetup(Discoverer.SourceSetupCallback handler)	This signal is emitted after the source element has been created for, so the URI being discovered, so it can be configured by setting additional properties (e.g. set a proxy server for an http source, or set the device and read speed for an audio cd source).
SignalConnection<Discoverer.StartingCallback>	onStarting(Discoverer.StartingCallback handler)	Will be emitted when the discover starts analyzing the pending URIs
protected void	sourceSetup(Element source)
void	start()	Allow asynchronous discovering of URIs to take place.
protected void	starting()
void	stop()	Stop the discovery of any pending URIs and clears the list of pending URIS (if any).

Methods inherited from class 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, ref, refSink, removeToggleRef, removeWeakPointer, replaceData, replaceQdata, runDispose, set, setData, setDataFull, setProperty, setProperty, setProperty, setQdata, setQdataFull, setv, stealData, stealQdata, takeRef, thawNotify, unref, watchClosure, weakRef, weakUnref, withProperties

Methods inherited from class TypeInstance

callParent, callParent, cast, getPrivate, readGClass, writeGClass

Methods inherited from class ProxyInstance

equals, handle, hashCode

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Discoverer

public Discoverer(MemorySegment address)

Create a Discoverer instance for the provided memory address.

Parameters:

address - the memory address of the native object

Discoverer

public Discoverer(ClockTime timeout)
           throws GErrorException

Creates a new GstDiscoverer with the provided timeout.

Parameters:

timeout - timeout per file, in nanoseconds. Allowed are values between one second (GST_SECOND) and one hour (3600 * GST_SECOND)

Throws:

GErrorException - see GError

Discoverer

public Discoverer()

Create a new Discoverer.

Method Details

getType

public static @Nullable Type getType()

Get the GType of the Discoverer class.

Returns:

the GType

getMemoryLayout

public static MemoryLayout getMemoryLayout()

The memory layout of the native struct.

Returns:

the memory layout

asParent

protected Discoverer asParent()

Return this instance as if it were its parent type. Comparable to the Java super keyword, but ensures the parent typeclass is also used in native code.

Overrides:

asParent in class GObject

Returns:

the instance as if it were its parent type

discoverUri

public DiscovererInfo discoverUri(String uri)
                           throws GErrorException

Synchronously discovers the given uri.

A copy of uri will be made internally, so the caller can safely g_free() afterwards.

Parameters:

uri - The URI to run on.

Returns:

the result of the scanning. Can be null if an error occurred.

Throws:

GErrorException - see GError

discoverUriAsync

public boolean discoverUriAsync(String uri)

Appends the given uri to the list of URIs to discoverer. The actual discovery of the uri will only take place if gst_discoverer_start() has been called.

A copy of uri will be made internally, so the caller can safely g_free() afterwards.

Parameters:

uri - the URI to add.

Returns:

true if the uri was successfully appended to the list of pending uris, else false

start

public void start()

Allow asynchronous discovering of URIs to take place. A GMainLoop must be available for GstDiscoverer to properly work in asynchronous mode.

stop

public void stop()

Stop the discovery of any pending URIs and clears the list of pending URIS (if any).

discovered

protected void discovered(DiscovererInfo info,
 GError err)

finished

protected void finished()

loadSerializeInfo

protected DiscovererInfo loadSerializeInfo(String uri)

Loads the serialized info from the given uri.

Parameters:

uri - the uri to load the info from

Returns:

the GstDiscovererInfo or null if it could not be loaded

Since:

1.24

sourceSetup

protected void sourceSetup(Element source)

starting

protected void starting()

onDiscovered

public SignalConnection<Discoverer.DiscoveredCallback> onDiscovered(Discoverer.DiscoveredCallback handler)

Will be emitted in async mode when all information on a URI could be discovered, or an error occurred.

When an error occurs, info might still contain some partial information, depending on the circumstances of the error.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Discoverer.DiscoveredCallback.run(DiscovererInfo, GError)

emitDiscovered

public void emitDiscovered(@Nullable DiscovererInfo info,
 @Nullable GError error)

Emits the "discovered" signal. See onDiscovered(Discoverer.DiscoveredCallback).

onFinished

public SignalConnection<Discoverer.FinishedCallback> onFinished(Discoverer.FinishedCallback handler)

Will be emitted in async mode when all pending URIs have been processed.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Discoverer.FinishedCallback.run()

emitFinished

public void emitFinished()

Emits the "finished" signal. See onFinished(Discoverer.FinishedCallback).

onLoadSerializedInfo

public SignalConnection<Discoverer.LoadSerializedInfoCallback> onLoadSerializedInfo(Discoverer.LoadSerializedInfoCallback handler)

Retrieves information about a URI from and external source of information, like a cache file. This is used by the discoverer to speed up the discovery.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

Since:

1.24

See Also:

• Discoverer.LoadSerializedInfoCallback.run(String)

emitLoadSerializedInfo

public DiscovererInfo emitLoadSerializedInfo(String uri)

Emits the "load-serialized-info" signal. See onLoadSerializedInfo(Discoverer.LoadSerializedInfoCallback).

onSourceSetup

public SignalConnection<Discoverer.SourceSetupCallback> onSourceSetup(Discoverer.SourceSetupCallback handler)

This signal is emitted after the source element has been created for, so the URI being discovered, so it can be configured by setting additional properties (e.g. set a proxy server for an http source, or set the device and read speed for an audio cd source).

This signal is usually emitted from the context of a GStreamer streaming thread.

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Discoverer.SourceSetupCallback.run(Element)

emitSourceSetup

public void emitSourceSetup(@Nullable Element source)

Emits the "source-setup" signal. See onSourceSetup(Discoverer.SourceSetupCallback).

onStarting

public SignalConnection<Discoverer.StartingCallback> onStarting(Discoverer.StartingCallback handler)

Will be emitted when the discover starts analyzing the pending URIs

Parameters:

handler - the signal handler

Returns:

a signal handler ID to keep track of the signal connection

See Also:

• Discoverer.StartingCallback.run()

emitStarting

public void emitStarting()

Emits the "starting" signal. See onStarting(Discoverer.StartingCallback).

builder

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

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

Returns:

the builder object