![]() |
![]() |
![]() |
GUPnP DLNA Reference Manual | ![]() |
---|---|---|---|---|
Top | Description | Object Hierarchy | Properties | Signals |
GUPnPDLNADiscovererGUPnPDLNADiscoverer — Utility API for discovering DLNA profile/mime type and other metadata for given media. |
GUPnPDLNADiscoverer; GUPnPDLNADiscoverer * gupnp_dlna_discoverer_new (GstClockTime timeout
,gboolean relaxed_mode
,gboolean extended_mode
); #define gupnp_dlna_discoverer_start (discoverer) #define gupnp_dlna_discoverer_stop (discoverer) gboolean gupnp_dlna_discoverer_discover_uri (GUPnPDLNADiscoverer *discoverer
,const gchar *uri
); GUPnPDLNAInformation * gupnp_dlna_discoverer_discover_uri_sync (GUPnPDLNADiscoverer *discoverer
,const gchar *uri
,GError **err
); GUPnPDLNAProfile * gupnp_dlna_discoverer_get_profile (GUPnPDLNADiscoverer *self
,const gchar *name
); const GList * gupnp_dlna_discoverer_list_profiles (GUPnPDLNADiscoverer *self
); gboolean gupnp_dlna_discoverer_get_relaxed_mode (GUPnPDLNADiscoverer *self
); gboolean gupnp_dlna_discoverer_get_extended_mode (GUPnPDLNADiscoverer *self
);
"extended-mode" gboolean : Read / Write / Construct Only "relaxed-mode" gboolean : Read / Write / Construct Only
The GUPnPDLNADiscoverer object provides a light-weight wrapper over the GstDiscoverer API. The latter provides a simple interface to discover media metadata given a URI. GUPnPDLNADiscoverer extends this API to also provide a DLNA profile name and mime type for the media.
The API provided corresponds very closely to the API provided by GstDiscoverer - both synchronous and asynchronous discovery of metadata are possible.
The asynchronous mode requires a running GMainLoop in the default GMainContext, where one connects to the various signals, appends the URIs to be processed and then asks for the discovery to begin.
typedef struct _GUPnPDLNADiscoverer GUPnPDLNADiscoverer;
The top-level object used to for metadata extraction.
GUPnPDLNADiscoverer * gupnp_dlna_discoverer_new (GstClockTime timeout
,gboolean relaxed_mode
,gboolean extended_mode
);
Creates a new GUPnPDLNADiscoverer object with the given default timeout value.
|
default discovery timeout, in nanoseconds |
|
set to TRUE, to enable relaxed mode support. FALSE otherwise |
|
set to TRUE, to enable extended mode support. FALSE otherwise |
Returns : |
A new GUPnPDLNADiscoverer object. |
#define gupnp_dlna_discoverer_start(discoverer)
Allows asynchronous discovery of URIs to begin.
|
GUPnPDLNADiscoverer object to start discovery on |
#define gupnp_dlna_discoverer_stop(discoverer)
Stops asynchronous discovery of URIs.
|
GUPnPDLNADiscoverer object to stop discovery on |
gboolean gupnp_dlna_discoverer_discover_uri (GUPnPDLNADiscoverer *discoverer
,const gchar *uri
);
Queues uri
for metadata discovery. When discovery is completed, the
"discovered" signal is emitted on discoverer
.
|
GUPnPDLNADiscoverer object to use for discovery |
|
URI to gather metadata for |
Returns : |
TRUE if uri was successfully queued, FALSE otherwise. |
GUPnPDLNAInformation * gupnp_dlna_discoverer_discover_uri_sync (GUPnPDLNADiscoverer *discoverer
,const gchar *uri
,GError **err
);
Synchronously gathers metadata for uri
.
|
GUPnPDLNADiscoverer object to use for discovery |
|
URI to gather metadata for |
|
contains details of the error if discovery fails, else is NULL |
Returns : |
a GUPnPDLNAInformation with the metadata for uri
on success, NULL otherwise. [transfer full]
|
GUPnPDLNAProfile * gupnp_dlna_discoverer_get_profile (GUPnPDLNADiscoverer *self
,const gchar *name
);
Given name
, this finds the corresponding DLNA profile information (stored
as a GUPnPDLNAProfile).
|
The GUPnPDLNADiscoverer object |
|
The name of the DLNA profile to be retrieved |
Returns : |
a GUPnPDLNAProfile on success, NULL otherwise. [transfer full] |
const GList * gupnp_dlna_discoverer_list_profiles (GUPnPDLNADiscoverer *self
);
Retuns a list of the all the DLNA profiles supported by self
.
|
The GUPnPDLNADiscoverer whose profile list is required |
Returns : |
a GList of GUPnPDLNAProfile on success, NULL otherwise. [transfer none][element-type GUPnPDLNAProfile] |
gboolean gupnp_dlna_discoverer_get_relaxed_mode
(GUPnPDLNADiscoverer *self
);
|
The GUPnPDLNADiscoverer object |
Returns : |
true if relaxed mode is set and false otherwise |
gboolean gupnp_dlna_discoverer_get_extended_mode
(GUPnPDLNADiscoverer *self
);
|
The GUPnPDLNADiscoverer object |
Returns : |
true if application is using extended mode and false otherwise |
"extended-mode"
property"extended-mode" gboolean : Read / Write / Construct Only
Indicates support for profiles that are not part of the DLNA specification.
Default value: FALSE
"relaxed-mode"
property"relaxed-mode" gboolean : Read / Write / Construct Only
Indicates that profile matching shouldbe strictly compliant with the DLNA specification.
Default value: FALSE
"done"
signalvoid user_function (GUPnPDLNADiscoverer *discoverer,
GUPnPDLNAInformation *dlna,
GError *err,
gpointer user_data) : Run Last
Will be emitted when all information on a URI could be discovered.
The reciever must unref dlna
with when done using it.
|
the GUPnPDLNADiscoverer |
|
the results as GUPnPDLNAInformation |
|
contains details of the error if discovery fails, else is NULL |
|
user data set when the signal handler was connected. |