URIHandlerIF

The URIHandler is an interface that is implemented by Source and Sink #GstElement to simplify then handling of URI.

An application can use the following functions to quickly get an element that handles the given URI for reading or writing (gst_element_make_from_uri()).

Source and Sink plugins should implement this interface when possible.

interface URIHandlerIF {

GstURIHandler* getURIHandlerStruct();

void* getStruct();

string[] getProtocols();

string getUri();

GstURIType getUriType();

bool setUri(string uri);

static string filenameToUri(string filename);

static string uriConstruct(string protocol, string location);

static GQuark uriErrorQuark();

static string uriGetLocation(string uri);

static string uriGetProtocol(string uri);

static bool uriHasProtocol(string uri, string protocol);

static bool uriIsValid(string uri);

static bool uriProtocolIsSupported(GstURIType type, string protocol);

static bool uriProtocolIsValid(string protocol);

}

Members

Functions

getProtocols string[] getProtocols(): Gets the list of protocols supported by @handler. This list may not be modified.
getStruct void* getStruct(): the main Gtk struct as a void*
getURIHandlerStruct GstURIHandler* getURIHandlerStruct(): Get the main Gtk struct
getUri string getUri(): Gets the currently handled URI.
getUriType GstURIType getUriType(): Gets the type of the given URI handler
setUri bool setUri(string uri): Tries to set the URI of the given handler.

Static functions

filenameToUri string filenameToUri(string filename): Similar to g_filename_to_uri(), but attempts to handle relative file paths as well. Before converting @filename into an URI, it will be prefixed by the current working directory if it is a relative path, and then the path will be canonicalised so that it doesn't contain any './' or '../' segments.
uriConstruct string uriConstruct(string protocol, string location): Constructs a URI for a given valid protocol and location.
uriErrorQuark GQuark uriErrorQuark(): Undocumented in source.
uriGetLocation string uriGetLocation(string uri): Extracts the location out of a given valid URI, ie. the protocol and "://" are stripped from the URI, which means that the location returned includes the hostname if one is specified. The returned string must be freed using g_free().
uriGetProtocol string uriGetProtocol(string uri): Extracts the protocol out of a given valid URI. The returned string must be freed using g_free().
uriHasProtocol bool uriHasProtocol(string uri, string protocol): Checks if the protocol of a given valid URI matches @protocol.
uriIsValid bool uriIsValid(string uri): Tests if the given string is a valid URI identifier. URIs start with a valid scheme followed by ":" and maybe a string identifying the location.
uriProtocolIsSupported bool uriProtocolIsSupported(GstURIType type, string protocol): Checks if an element exists that supports the given URI protocol. Note that a positive return value does not imply that a subsequent call to gst_element_make_from_uri() is guaranteed to work.
uriProtocolIsValid bool uriProtocolIsValid(string protocol): Tests if the given string is a valid protocol identifier. Protocols must consist of alphanumeric characters, '+', '-' and '.' and must start with a alphabetic character. See RFC 3986 Section 3.1.

URIHandlerIF

Members

Functions

Static functions

Meta

Source