| Top | |
|
|
|
| void | discovered | Run Last |
| void | finished | Run Last |
| void | source-setup | Run Last |
| void | starting | Run Last |
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.
GstDiscoverer * gst_discoverer_new (GstClockTime timeout,GError **err);
Creates a new GstDiscoverer with the provided timeout.
timeout |
timeout per file, in nanoseconds. Allowed are values between one second (GST_SECOND) and one hour (3600 * GST_SECOND) |
|
err |
The new GstDiscoverer.
If an error occurred when creating the discoverer, err
will be set
accordingly and NULL will be returned. If err
is set, the caller must
free it when no longer needed using g_error_free().
[transfer full]
void
gst_discoverer_start (GstDiscoverer *discoverer);
Allow asynchronous discovering of URIs to take place. A GMainLoop must be available for GstDiscoverer to properly work in asynchronous mode.
void
gst_discoverer_stop (GstDiscoverer *discoverer);
Stop the discovery of any pending URIs and clears the list of pending URIS (if any).
GstDiscovererInfo * gst_discoverer_discover_uri (GstDiscoverer *discoverer,const gchar *uri,GError **err);
Synchronously discovers the given uri
.
A copy of uri
will be made internally, so the caller can safely g_free()
afterwards.
gboolean gst_discoverer_discover_uri_async (GstDiscoverer *discoverer,const gchar *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.
GstClockTime
gst_discoverer_info_get_duration (const GstDiscovererInfo *info);
const GstStructure *
gst_discoverer_info_get_misc (const GstDiscovererInfo *info);
gst_discoverer_info_get_misc is deprecated and should not be used in newly-written code.
This functions is deprecated since version 1.4, use gst_discoverer_info_get_missing_elements_installer_details
Miscellaneous information stored as a GstStructure
(for example: information about missing plugins). If you wish to use the
GstStructure after the life-time of info
, you will need to copy it.
[transfer none]
GstDiscovererResult
gst_discoverer_info_get_result (const GstDiscovererInfo *info);
GstDiscovererStreamInfo *
gst_discoverer_info_get_stream_info (GstDiscovererInfo *info);
the structure (or topology) of the URI as a
GstDiscovererStreamInfo.
This structure can be traversed to see the original hierarchy. Unref with
gst_discoverer_stream_info_unref() after usage.
[transfer full]
GList *
gst_discoverer_info_get_stream_list (GstDiscovererInfo *info);
the list of
all streams contained in the info. Free after usage
with gst_discoverer_stream_info_list_free().
[transfer full][element-type GstPbutils.DiscovererStreamInfo]
const GstTagList *
gst_discoverer_info_get_tags (const GstDiscovererInfo *info);
const GstToc *
gst_discoverer_info_get_toc (const GstDiscovererInfo *info);
const gchar *
gst_discoverer_info_get_uri (const GstDiscovererInfo *info);
gboolean
gst_discoverer_info_get_seekable (const GstDiscovererInfo *info);
#define gst_discoverer_info_ref(info) (g_object_ref((GObject*)info))
Increments the reference count of info
.
#define gst_discoverer_info_unref(info) (g_object_unref((GObject*)info))
Decrements the reference count of info
.
GVariant * gst_discoverer_info_to_variant (GstDiscovererInfo *info,GstDiscovererSerializeFlags flags);
Serializes info
to a GVariant that can be parsed again
through gst_discoverer_info_from_variant().
Note that any GstToc (s) that might have been discovered will not be serialized for now.
info |
||
flags |
A combination of GstDiscovererSerializeFlags to specify what needs to be serialized. |
Since: 1.6
GstDiscovererInfo *
gst_discoverer_info_from_variant (GVariant *variant);
Parses a GVariant as produced by gst_discoverer_info_to_variant()
back to a GstDiscovererInfo.
Since: 1.6
GstCaps *
gst_discoverer_stream_info_get_caps (GstDiscovererStreamInfo *info);
const GstStructure *
gst_discoverer_stream_info_get_misc (GstDiscovererStreamInfo *info);
gst_discoverer_stream_info_get_misc is deprecated and should not be used in newly-written code.
This functions is deprecated since version 1.4, use gst_discoverer_info_get_missing_elements_installer_details
additional information regarding the stream (for
example codec version, profile, etc..). If you wish to use the GstStructure
after the life-time of info
you will need to copy it.
[transfer none]
GstDiscovererStreamInfo *
gst_discoverer_stream_info_get_next (GstDiscovererStreamInfo *info);
the next GstDiscovererStreamInfo in a chain. NULL
for final streams.
Unref with gst_discoverer_stream_info_unref after usage.
[transfer full]
GstDiscovererStreamInfo *
gst_discoverer_stream_info_get_previous
(GstDiscovererStreamInfo *info);
the previous GstDiscovererStreamInfo in a chain.
NULL for starting points. Unref with gst_discoverer_stream_info_unref
after usage.
[transfer full]
const GstTagList *
gst_discoverer_stream_info_get_tags (GstDiscovererStreamInfo *info);
const GstToc *
gst_discoverer_stream_info_get_toc (GstDiscovererStreamInfo *info);
const gchar *
gst_discoverer_stream_info_get_stream_id
(GstDiscovererStreamInfo *info);
#define gst_discoverer_stream_info_ref(info) ((GstDiscovererStreamInfo*) g_object_ref((GObject*) info))
Increments the reference count of info
.
#define gst_discoverer_stream_info_unref(info) (g_object_unref((GObject*) info))
Decrements the reference count of info
.
void
gst_discoverer_stream_info_list_free (GList *infos);
Decrements the reference count of all contained GstDiscovererStreamInfo and fress the GList.
const gchar *
gst_discoverer_stream_info_get_stream_type_nick
(GstDiscovererStreamInfo *info);
const gchar **
gst_discoverer_info_get_missing_elements_installer_details
(const GstDiscovererInfo *info);
Get the installer details for missing elements
An array of strings
containing informations about how to install the various missing elements
for info
to be usable. If you wish to use the strings after the life-time
of info
, you will need to copy them.
[transfer none][array zero-terminated=1]
Since: 1.4
GList *
gst_discoverer_info_get_audio_streams (GstDiscovererInfo *info);
Finds all the GstDiscovererAudioInfo contained in info
A GList of
matching GstDiscovererStreamInfo. The caller should free it with
gst_discoverer_stream_info_list_free().
[transfer full][element-type GstPbutils.DiscovererStreamInfo]
GList *
gst_discoverer_info_get_container_streams
(GstDiscovererInfo *info);
Finds all the GstDiscovererContainerInfo contained in info
A GList of
matching GstDiscovererStreamInfo. The caller should free it with
gst_discoverer_stream_info_list_free().
[transfer full][element-type GstPbutils.DiscovererStreamInfo]
GList * gst_discoverer_info_get_streams (GstDiscovererInfo *info,GType streamtype);
Finds the GstDiscovererStreamInfo contained in info
that match the
given streamtype
.
A GList of
matching GstDiscovererStreamInfo. The caller should free it with
gst_discoverer_stream_info_list_free().
[transfer full][element-type GstPbutils.DiscovererStreamInfo]
GList *
gst_discoverer_info_get_subtitle_streams
(GstDiscovererInfo *info);
Finds all the GstDiscovererSubtitleInfo contained in info
A GList of
matching GstDiscovererStreamInfo. The caller should free it with
gst_discoverer_stream_info_list_free().
[transfer full][element-type GstPbutils.DiscovererStreamInfo]
GList *
gst_discoverer_info_get_video_streams (GstDiscovererInfo *info);
Finds all the GstDiscovererVideoInfo contained in info
A GList of
matching GstDiscovererStreamInfo. The caller should free it with
gst_discoverer_stream_info_list_free().
[transfer full][element-type GstPbutils.DiscovererStreamInfo]
guint
gst_discoverer_audio_info_get_bitrate (const GstDiscovererAudioInfo *info);
guint
gst_discoverer_audio_info_get_channels
(const GstDiscovererAudioInfo *info);
guint
gst_discoverer_audio_info_get_depth (const GstDiscovererAudioInfo *info);
const gchar *
gst_discoverer_audio_info_get_language
(const GstDiscovererAudioInfo *info);
guint
gst_discoverer_audio_info_get_max_bitrate
(const GstDiscovererAudioInfo *info);
guint
gst_discoverer_audio_info_get_sample_rate
(const GstDiscovererAudioInfo *info);
GList *
gst_discoverer_container_info_get_streams
(GstDiscovererContainerInfo *info);
the list of
GstDiscovererStreamInfo this container stream offers.
Free with gst_discoverer_stream_info_list_free() after usage.
[transfer full][element-type GstPbutils.DiscovererStreamInfo]
const gchar *
gst_discoverer_subtitle_info_get_language
(const GstDiscovererSubtitleInfo *info);
guint
gst_discoverer_video_info_get_bitrate (const GstDiscovererVideoInfo *info);
guint
gst_discoverer_video_info_get_depth (const GstDiscovererVideoInfo *info);
guint
gst_discoverer_video_info_get_framerate_denom
(const GstDiscovererVideoInfo *info);
guint
gst_discoverer_video_info_get_framerate_num
(const GstDiscovererVideoInfo *info);
guint
gst_discoverer_video_info_get_height (const GstDiscovererVideoInfo *info);
gboolean
gst_discoverer_video_info_is_interlaced
(const GstDiscovererVideoInfo *info);
gboolean
gst_discoverer_video_info_is_image (const GstDiscovererVideoInfo *info);
guint
gst_discoverer_video_info_get_max_bitrate
(const GstDiscovererVideoInfo *info);
guint
gst_discoverer_video_info_get_par_denom
(const GstDiscovererVideoInfo *info);
guint
gst_discoverer_video_info_get_par_num (const GstDiscovererVideoInfo *info);
guint
gst_discoverer_video_info_get_width (const GstDiscovererVideoInfo *info);
typedef struct _GstDiscovererInfo GstDiscovererInfo;
Structure containing the information of a URI analyzed by GstDiscoverer.
Result values for the discovery process.
You can use these flags to control what is serialized by
gst_discoverer_info_to_variant()
|
Serialize only basic information, excluding caps, tags and miscellaneous information |
||
|
Serialize the caps for each stream |
||
|
Serialize the tags for each stream |
||
|
Serialize miscellaneous information for each stream |
||
|
Serialize all the available info, including caps, tags and miscellaneous information |
Since: 1.6
typedef struct _GstDiscovererStreamInfo GstDiscovererStreamInfo;
Base structure for information concerning a media stream. Depending on the stream type, one can find more media-specific information in GstDiscovererAudioInfo, GstDiscovererVideoInfo, and GstDiscovererContainerInfo.
The GstDiscovererStreamInfo represents the topology of the stream. Siblings
can be iterated over with gst_discoverer_stream_info_get_next() and
gst_discoverer_stream_info_get_previous(). Children (sub-streams) of a
stream can be accessed using the GstDiscovererContainerInfo API.
As a simple example, if you run GstDiscoverer on an AVI file with one audio and one video stream, you will get a GstDiscovererContainerInfo corresponding to the AVI container, which in turn will have a GstDiscovererAudioInfo sub-stream and a GstDiscovererVideoInfo sub-stream for the audio and video streams respectively.
typedef struct _GstDiscovererContainerInfo GstDiscovererContainerInfo;
GstDiscovererStreamInfo specific to container streams.
typedef struct _GstDiscovererAudioInfo GstDiscovererAudioInfo;
GstDiscovererStreamInfo specific to audio streams.
typedef struct _GstDiscovererVideoInfo GstDiscovererVideoInfo;
GstDiscovererStreamInfo specific to video streams (this includes images).
typedef struct _GstDiscovererSubtitleInfo GstDiscovererSubtitleInfo;
GstDiscovererStreamInfo specific to subtitle streams (this includes text and image based ones).
“timeout” property“timeout” guint64
The duration (in nanoseconds) after which the discovery of an individual URI will timeout.
If the discovery of a URI times out, the GST_DISCOVERER_TIMEOUT will be
set on the result flags.
Flags: Read / Write / Construct
Allowed values: [1000000000,3600000000000]
Default value: 15000000000
“discovered” signalvoid user_function (GstDiscoverer *discoverer, GstDiscovererInfo *info, GError *error, gpointer user_data)
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.
discoverer |
the GstDiscoverer |
|
info |
the results GstDiscovererInfo |
|
error |
GError, which will be non-NULL if an error occurred during discovery. You must not free this GError, it will be freed by the discoverer. |
[type GLib.Error] |
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“finished” signalvoid user_function (GstDiscoverer *discoverer, gpointer user_data)
Will be emitted in async mode when all pending URIs have been processed.
discoverer |
the GstDiscoverer |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“source-setup” signalvoid user_function (GstDiscoverer *discoverer, GstElement *source, gpointer user_data)
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.
discoverer |
the GstDiscoverer |
|
source |
source element |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last
“starting” signalvoid user_function (GstDiscoverer *discoverer, gpointer user_data)
Will be emitted when the discover starts analyzing the pending URIs
discoverer |
the GstDiscoverer |
|
user_data |
user data set when the signal handler was connected. |
Flags: Run Last