Struct gstreamer_pbutils::Discoverer

pub struct Discoverer { /* private fields */ }

The Discoverer 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 discover_uri() with the URI one wishes to discover.

The non-blocking mode requires a running glib::MainLoop iterating a glib::MainContext, where one connects to the various signals, appends the URIs to be processed (through discover_uri_async()) and then asks for the discovery to begin (through start()). By default this will use the GLib default main context unless you have set a custom context using [glib::MainContext::push_thread_default()][crate::glib::MainContext::push_thread_default()].

All the information is returned in a DiscovererInfo structure.

Properties

timeout

The duration (in nanoseconds) after which the discovery of an individual URI will timeout.

If the discovery of a URI times out, the DiscovererResult::Timeout will be set on the result flags.

Readable | Writeable | Construct

use-cache

Readable | Writeable | Construct

Signals

discovered

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.

finished

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

load-serialized-info

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.

source-setup

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.

starting

Will be emitted when the discover starts analyzing the pending URIs

Implements

[trait@glib::ObjectExt]

Implementations

impl Discoverer

pub fn new(timeout: ClockTime) -> Result<Discoverer, Error>

Creates a new Discoverer with the provided timeout.

timeout

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

Returns

The new Discoverer. If an error occurred when creating the discoverer, err will be set accordingly and None will be returned. If err is set, the caller must free it when no longer needed using g_error_free().

pub fn discover_uri(&self, uri: &str) -> Result<DiscovererInfo, Error>

Synchronously discovers the given uri.

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

uri

The URI to run on.

Returns

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

pub fn discover_uri_async(&self, uri: &str) -> Result<(), BoolError>

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

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

uri

the URI to add.

Returns

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

pub fn start(&self)

Allow asynchronous discovering of URIs to take place. A glib::MainLoop must be available for Discoverer to properly work in asynchronous mode.

pub fn stop(&self)

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

pub fn uses_cache(&self) -> bool

pub fn set_use_cache(&self, use_cache: bool)

pub fn connect_discovered<F: Fn(&Self, &DiscovererInfo, Option<&Error>) + Send + Sync + 'static>( &self, f: F ) -> SignalHandlerId

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.

info

the results DiscovererInfo

error

glib::Error, which will be non-NULL if an error occurred during discovery. You must not free this glib::Error, it will be freed by the discoverer.

pub fn connect_finished<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F ) -> SignalHandlerId

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

pub fn connect_load_serialized_info<F: Fn(&Self, &str) -> Option<DiscovererInfo> + Send + Sync + 'static>( &self, f: F ) -> SignalHandlerId

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.

uri

THe URI to load the serialized info for

Returns

The DiscovererInfo representing uri, or None if no information

pub fn connect_source_setup<F: Fn(&Self, &Element) + Send + Sync + 'static>( &self, f: F ) -> SignalHandlerId

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.

source

source element

pub fn connect_starting<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F ) -> SignalHandlerId

Will be emitted when the discover starts analyzing the pending URIs

pub fn connect_use_cache_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F ) -> SignalHandlerId

impl Discoverer

pub fn set_timeout(&self, timeout: ClockTime)

The duration (in nanoseconds) after which the discovery of an individual URI will timeout.

If the discovery of a URI times out, the DiscovererResult::Timeout will be set on the result flags.

pub fn timeout(&self) -> ClockTime

The duration (in nanoseconds) after which the discovery of an individual URI will timeout.

If the discovery of a URI times out, the DiscovererResult::Timeout will be set on the result flags.

pub fn connect_timeout_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F ) -> SignalHandlerId

Trait Implementations

impl Clone for Discoverer

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Discoverer

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl HasParamSpec for Discoverer

type ParamSpec = ParamSpecObject

type SetValue = Discoverer

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str) -> ParamSpecObjectBuilder<'_, Discoverer>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for Discoverer

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Discoverer

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for Discoverer

type Parent = Object

impl<OT: ObjectType> PartialEq<OT> for Discoverer

fn eq(&self, other: &OT) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for Discoverer

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for Discoverer

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for Discoverer

impl Send for Discoverer

impl Sync for Discoverer