GstUriHandler

Gst.URIHandler

Gst.URIHandler.prototype.get_protocols

function Gst.URIHandler.prototype.get_protocols(): {
    // javascript wrapper for 'gst_uri_handler_get_protocols'
}

Gets the list of protocols supported by handler. This list may not be modified.

Gst.URIHandler.prototype.get_uri

function Gst.URIHandler.prototype.get_uri(): {
    // javascript wrapper for 'gst_uri_handler_get_uri'
}

Gets the currently handled URI.

Gst.URIHandler.prototype.get_uri_type

function Gst.URIHandler.prototype.get_uri_type(): {
    // javascript wrapper for 'gst_uri_handler_get_uri_type'
}

Gets the type of the given URI handler

Gst.URIHandler.prototype.set_uri

function Gst.URIHandler.prototype.set_uri(uri: String): {
    // javascript wrapper for 'gst_uri_handler_set_uri'
}

Tries to set the URI of the given handler.

vfunc_get_uri

function vfunc_get_uri(handler: Gst.URIHandler): {
    // javascript implementation of the 'get_uri' virtual method
}

Method to return the URI currently handled by the element.

vfunc_set_uri

function vfunc_set_uri(handler: Gst.URIHandler, uri: String): {
    // javascript implementation of the 'set_uri' virtual method
}

Method to set a new URI.

Gst.Uri

Gst.Uri.prototype.new

function Gst.Uri.prototype.new(scheme: String, userinfo: String, host: String, port: Number, path: String, query: String, fragment: String): {
    // javascript wrapper for 'gst_uri_new'
}

Creates a new Gst.Uri object with the given URI parts. The path and query strings will be broken down into their elements. All strings should not be escaped except where indicated.

Since : 1.6

Gst.Uri.prototype.append_path

function Gst.Uri.prototype.append_path(relative_path: String): {
    // javascript wrapper for 'gst_uri_append_path'
}

Append a path onto the end of the path in the URI. The path is not normalized, call Gst.Uri.prototype.normalize() to normalize the path.

Since : 1.6

Gst.Uri.prototype.append_path_segment

function Gst.Uri.prototype.append_path_segment(path_segment: String): {
    // javascript wrapper for 'gst_uri_append_path_segment'
}

Append a single path segment onto the end of the URI path.

Since : 1.6

Gst.Uri.prototype.copy

function Gst.Uri.prototype.copy(): {
    // javascript wrapper for 'gst_uri_copy'
}

Create a new Gst.Uri object with the same data as this Gst.Uri object. If uri is null then returns null.

Since : 1.6

Gst.Uri.prototype.equal

function Gst.Uri.prototype.equal(second: Gst.Uri): {
    // javascript wrapper for 'gst_uri_equal'
}

Compares two Gst.Uri objects to see if they represent the same normalized URI.

Since : 1.6

Gst.Uri.prototype.from_string_with_base

function Gst.Uri.prototype.from_string_with_base(uri: String): {
    // javascript wrapper for 'gst_uri_from_string_with_base'
}

Like Gst.prototype.uri_from_string but also joins with a base URI.

Since : 1.6

Gst.Uri.prototype.get_fragment

function Gst.Uri.prototype.get_fragment(): {
    // javascript wrapper for 'gst_uri_get_fragment'
}

Get the fragment name from the URI or null if it doesn't exist. If uri is null then returns null.

Since : 1.6

Gst.Uri.prototype.get_host

function Gst.Uri.prototype.get_host(): {
    // javascript wrapper for 'gst_uri_get_host'
}

Get the host name from the URI or null if it doesn't exist. If uri is null then returns null.

Since : 1.6

Gst.Uri.prototype.get_media_fragment_table

function Gst.Uri.prototype.get_media_fragment_table(): {
    // javascript wrapper for 'gst_uri_get_media_fragment_table'
}

Get the media fragment table from the URI, as defined by "Media Fragments URI 1.0". Hash table returned by this API is a list of "key-value" pairs, and the each pair is generated by splitting "URI fragment" per "&" sub-delims, then "key" and "value" are split by "=" sub-delims. The "key" returned by this API may be undefined keyword by standard. A value may be null to indicate that the key should appear in the fragment string in the URI, but does not have a value. Free the returned GHashTable (not introspectable) with GLib.prototype.hash_table_unref() when it is no longer required. Modifying this hash table does not affect the fragment in the URI.

See more about Media Fragments URI 1.0 (W3C) at https://www.w3.org/TR/media-frags/

Since : 1.12

Gst.Uri.prototype.get_path

function Gst.Uri.prototype.get_path(): {
    // javascript wrapper for 'gst_uri_get_path'
}

Extract the path string from the URI object.

Since : 1.6

Gst.Uri.prototype.get_path_segments

function Gst.Uri.prototype.get_path_segments(): {
    // javascript wrapper for 'gst_uri_get_path_segments'
}

Get a list of path segments from the URI.

Since : 1.6

Gst.Uri.prototype.get_path_string

function Gst.Uri.prototype.get_path_string(): {
    // javascript wrapper for 'gst_uri_get_path_string'
}

Extract the path string from the URI object as a percent encoded URI path.

Since : 1.6

Gst.Uri.prototype.get_port

function Gst.Uri.prototype.get_port(): {
    // javascript wrapper for 'gst_uri_get_port'
}

Get the port number from the URI or Gst.URI_NO_PORT if it doesn't exist. If uri is null then returns Gst.URI_NO_PORT.

Since : 1.6

Gst.Uri.prototype.get_query_keys

function Gst.Uri.prototype.get_query_keys(): {
    // javascript wrapper for 'gst_uri_get_query_keys'
}

Get a list of the query keys from the URI.

Since : 1.6

Gst.Uri.prototype.get_query_string

function Gst.Uri.prototype.get_query_string(): {
    // javascript wrapper for 'gst_uri_get_query_string'
}

Get a percent encoded URI query string from the uri.

Since : 1.6

Gst.Uri.prototype.get_query_string_ordered

function Gst.Uri.prototype.get_query_string_ordered(keys: [ String ]): {
    // javascript wrapper for 'gst_uri_get_query_string_ordered'
}

Get a percent encoded URI query string from the uri, with query parameters in the order provided by the keys list. Only parameter keys in the list will be added to the resulting URI string. This method can be used by retrieving the keys with Gst.Uri.prototype.get_query_keys and then sorting the list, for example.

Since : 1.24

Gst.Uri.prototype.get_query_table

function Gst.Uri.prototype.get_query_table(): {
    // javascript wrapper for 'gst_uri_get_query_table'
}

Get the query table from the URI. Keys and values in the table are freed with g_free when they are deleted. A value may be null to indicate that the key should appear in the query string in the URI, but does not have a value. Free the returned GHashTable (not introspectable) with GLib.prototype.hash_table_unref() when it is no longer required. Modifying this hash table will modify the query in the URI.

Since : 1.6

Gst.Uri.prototype.get_query_value

function Gst.Uri.prototype.get_query_value(query_key: String): {
    // javascript wrapper for 'gst_uri_get_query_value'
}

Get the value associated with the query_key key. Will return null if the key has no value or if the key does not exist in the URI query table. Because null is returned for both missing keys and keys with no value, you should use Gst.Uri.prototype.query_has_key to determine if a key is present in the URI query.

Since : 1.6

Gst.Uri.prototype.get_scheme

function Gst.Uri.prototype.get_scheme(): {
    // javascript wrapper for 'gst_uri_get_scheme'
}

Get the scheme name from the URI or null if it doesn't exist. If uri is null then returns null.

Gst.Uri.prototype.get_userinfo

function Gst.Uri.prototype.get_userinfo(): {
    // javascript wrapper for 'gst_uri_get_userinfo'
}

Get the userinfo (usually in the form "username:password") from the URI or null if it doesn't exist. If uri is null then returns null.

Since : 1.6

Gst.Uri.prototype.is_normalized

function Gst.Uri.prototype.is_normalized(): {
    // javascript wrapper for 'gst_uri_is_normalized'
}

Tests the uri to see if it is normalized. A null uri is considered to be normalized.

Since : 1.6

Gst.Uri.prototype.is_writable

function Gst.Uri.prototype.is_writable(): {
    // javascript wrapper for 'gst_uri_is_writable'
}

Check if it is safe to write to this Gst.Uri.

Check if the refcount of uri is exactly 1, meaning that no other reference exists to the Gst.Uri and that the Gst.Uri is therefore writable.

Modification of a Gst.Uri should only be done after verifying that it is writable.

Since : 1.6

Gst.Uri.prototype.join

function Gst.Uri.prototype.join(ref_uri: Gst.Uri): {
    // javascript wrapper for 'gst_uri_join'
}

Join a reference URI onto a base URI using the method from RFC 3986. If either URI is null then the other URI will be returned with the ref count increased.

Since : 1.6

Gst.Uri.prototype.make_writable

function Gst.Uri.prototype.make_writable(): {
    // javascript wrapper for 'gst_uri_make_writable'
}

Make the Gst.Uri writable.

Checks if uri is writable, and if so the original object is returned. If not, then a writable copy is made and returned. This gives away the reference to uri and returns a reference to the new Gst.Uri. If uri is null then null is returned.

Since : 1.6

Gst.Uri.prototype.new_with_base

function Gst.Uri.prototype.new_with_base(scheme: String, userinfo: String, host: String, port: Number, path: String, query: String, fragment: String): {
    // javascript wrapper for 'gst_uri_new_with_base'
}

Like Gst.Uri.prototype.new, but joins the new URI onto a base URI.

Since : 1.6

Gst.Uri.prototype.normalize

function Gst.Uri.prototype.normalize(): {
    // javascript wrapper for 'gst_uri_normalize'
}

Normalization will remove extra path segments ("." and "..") from the URI. It will also convert the scheme and host name to lower case and any percent-encoded values to uppercase.

The Gst.Uri object must be writable. Check with Gst.Uri.prototype.is_writable or use Gst.Uri.prototype.make_writable first.

Since : 1.6

Gst.Uri.prototype.query_has_key

function Gst.Uri.prototype.query_has_key(query_key: String): {
    // javascript wrapper for 'gst_uri_query_has_key'
}

Check if there is a query table entry for the query_key key.

Since : 1.6

Gst.Uri.prototype.ref

function Gst.Uri.prototype.ref(): {
    // javascript wrapper for 'gst_uri_ref'
}

Add a reference to this Gst.Uri object. See gst_mini_object_ref (not introspectable) for further info.

Since : 1.6

Gst.Uri.prototype.remove_query_key

function Gst.Uri.prototype.remove_query_key(query_key: String): {
    // javascript wrapper for 'gst_uri_remove_query_key'
}

Remove an entry from the query table by key.

Since : 1.6

Gst.Uri.prototype.set_fragment

function Gst.Uri.prototype.set_fragment(fragment: String): {
    // javascript wrapper for 'gst_uri_set_fragment'
}

Sets the fragment string in the URI. Use a value of null in fragment to unset the fragment string.

Since : 1.6

Gst.Uri.prototype.set_host

function Gst.Uri.prototype.set_host(host: String): {
    // javascript wrapper for 'gst_uri_set_host'
}

Set or unset the host for the URI.

Since : 1.6

Gst.Uri.prototype.set_path

function Gst.Uri.prototype.set_path(path: String): {
    // javascript wrapper for 'gst_uri_set_path'
}

Sets or unsets the path in the URI.

Since : 1.6

Gst.Uri.prototype.set_path_segments

function Gst.Uri.prototype.set_path_segments(path_segments: [ String ]): {
    // javascript wrapper for 'gst_uri_set_path_segments'
}

Replace the path segments list in the URI.

Since : 1.6

Gst.Uri.prototype.set_path_string

function Gst.Uri.prototype.set_path_string(path: String): {
    // javascript wrapper for 'gst_uri_set_path_string'
}

Sets or unsets the path in the URI.

Since : 1.6

Gst.Uri.prototype.set_port

function Gst.Uri.prototype.set_port(port: Number): {
    // javascript wrapper for 'gst_uri_set_port'
}

Set or unset the port number for the URI.

Since : 1.6

Gst.Uri.prototype.set_query_string

function Gst.Uri.prototype.set_query_string(query: String): {
    // javascript wrapper for 'gst_uri_set_query_string'
}

Sets or unsets the query table in the URI.

Since : 1.6

Gst.Uri.prototype.set_query_table

function Gst.Uri.prototype.set_query_table(query_table: GHashTable (not introspectable)): {
    // javascript wrapper for 'gst_uri_set_query_table'
}

Set the query table to use in the URI. The old table is unreferenced and a reference to the new one is used instead. A value if null for query_table will remove the query string from the URI.

Since : 1.6

Gst.Uri.prototype.set_query_value

function Gst.Uri.prototype.set_query_value(query_key: String, query_value: String): {
    // javascript wrapper for 'gst_uri_set_query_value'
}

This inserts or replaces a key in the query table. A query_value of null indicates that the key has no associated value, but will still be present in the query string.

Since : 1.6

Gst.Uri.prototype.set_scheme

function Gst.Uri.prototype.set_scheme(scheme: String): {
    // javascript wrapper for 'gst_uri_set_scheme'
}

Set or unset the scheme for the URI.

Since : 1.6

Gst.Uri.prototype.set_userinfo

function Gst.Uri.prototype.set_userinfo(userinfo: String): {
    // javascript wrapper for 'gst_uri_set_userinfo'
}

Set or unset the user information for the URI.

Since : 1.6

Gst.Uri.prototype.to_string

function Gst.Uri.prototype.to_string(): {
    // javascript wrapper for 'gst_uri_to_string'
}

Convert the URI to a string.

Returns the URI as held in this object as a String* nul-terminated string. The caller should GLib.prototype.free the string once they are finished with it. The string is put together as described in RFC 3986.

Since : 1.6

Gst.Uri.prototype.to_string_with_keys

function Gst.Uri.prototype.to_string_with_keys(keys: [ String ]): {
    // javascript wrapper for 'gst_uri_to_string_with_keys'
}

Convert the URI to a string, with the query arguments in a specific order. Only the keys in the keys list will be added to the resulting string.

Returns the URI as held in this object as a String* nul-terminated string. The caller should GLib.prototype.free the string once they are finished with it. The string is put together as described in RFC 3986.

Since : 1.24

Gst.Uri.prototype.unref

function Gst.Uri.prototype.unref(): {
    // javascript wrapper for 'gst_uri_unref'
}

Decrement the reference count to this Gst.Uri object.

If the reference count drops to 0 then finalize this object.

See gst_mini_object_unref (not introspectable) for further info.

Since : 1.6

Gst.prototype.uri_construct

function Gst.prototype.uri_construct(protocol: String, location: String): {
    // javascript wrapper for 'gst_uri_construct'
}

Constructs a URI for a given valid protocol and location.

Free-function: g_free

deprecated : Use GstURI instead.

Gst.prototype.uri_from_string

function Gst.prototype.uri_from_string(uri: String): {
    // javascript wrapper for 'gst_uri_from_string'
}

Parses a URI string into a new Gst.Uri object. Will return NULL if the URI cannot be parsed.

Since : 1.6

Gst.prototype.uri_from_string_escaped

function Gst.prototype.uri_from_string_escaped(uri: String): {
    // javascript wrapper for 'gst_uri_from_string_escaped'
}

Parses a URI string into a new Gst.Uri object. Will return NULL if the URI cannot be parsed. This is identical to Gst.prototype.uri_from_string except that the userinfo and fragment components of the URI will not be unescaped while parsing.

Use this when you need to extract a username and password from the userinfo such as https://user:password@example.com since either may contain a URI-escaped ':' character. Gst.prototype.uri_from_string will unescape the entire userinfo component, which will make it impossible to know which ':' delineates the username and password.

The same applies to the fragment component of the URI, such as https://example.com/path#fragment which may contain a URI-escaped '#'.

Since : 1.18

Gst.prototype.uri_get_location

function Gst.prototype.uri_get_location(uri: String): {
    // javascript wrapper for 'gst_uri_get_location'
}

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 GLib.prototype.free.

Free-function: g_free

Gst.prototype.uri_get_protocol

function Gst.prototype.uri_get_protocol(uri: String): {
    // javascript wrapper for 'gst_uri_get_protocol'
}

Extracts the protocol out of a given valid URI. The returned string must be freed using GLib.prototype.free.

Gst.prototype.uri_has_protocol

function Gst.prototype.uri_has_protocol(uri: String, protocol: String): {
    // javascript wrapper for 'gst_uri_has_protocol'
}

Checks if the protocol of a given valid URI matches protocol.

Gst.prototype.uri_is_valid

function Gst.prototype.uri_is_valid(uri: String): {
    // javascript wrapper for 'gst_uri_is_valid'
}

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.

Gst.prototype.uri_join_strings

function Gst.prototype.uri_join_strings(base_uri: String, ref_uri: String): {
    // javascript wrapper for 'gst_uri_join_strings'
}

This is a convenience function to join two URI strings and return the result. The returned string should be GLib.prototype.free'd after use.

Since : 1.6

Gst.prototype.uri_protocol_is_supported

function Gst.prototype.uri_protocol_is_supported(type: Gst.URIType, protocol: String): {
    // javascript wrapper for 'gst_uri_protocol_is_supported'
}

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.prototype.make_from_uri is guaranteed to work.

Gst.prototype.uri_protocol_is_valid

function Gst.prototype.uri_protocol_is_valid(protocol: String): {
    // javascript wrapper for 'gst_uri_protocol_is_valid'
}

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.

Gst.prototype.filename_to_uri

function Gst.prototype.filename_to_uri(filename: filename): {
    // javascript wrapper for 'gst_filename_to_uri'
}

Similar to GLib.prototype.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.

On Windows filename should be in UTF-8 encoding.

Gst.URIError

Different URI-related errors that can occur.

Gst.URIType

The different types of URI direction.

Gst.URI_NO_PORT

Value for Gst.Uri.port to indicate no port number.