Next: , Previous: GstFilter, Up: Top

14 GstFormat

Dynamically register new data formats

14.1 Overview

GstFormats functions are used to register a new format to the gstreamer core. Formats can be used to perform seeking or conversions/query operations.

14.2 Usage

— Function: gst-format-get-name (self <gst-format*>)   (ret mchars)

Get a printable name for the given format. Do not modify or free.

format
a <gst-format>
ret
a reference to the static name of the format or NULL if the format is unknown.
— Function: gst-format-to-quark (self <gst-format*>)   (ret unsigned-int)

Get the unique quark for the given format.

format
a <gst-format>
ret
the quark associated with the format or 0 if the format is unknown.
— Function: gst-format-register (nick mchars) (description mchars)   (ret <gst-format>)

Create a new GstFormat based on the nick or return an already registered format with that nick.

nick
The nick of the new format
description
The description of the new format
ret
A new GstFormat or an already registered format with the same nick. MT safe.
— Function: gst-format-get-by-nick (nick mchars)   (ret <gst-format>)

Return the format registered with the given nick.

nick
The nick of the format
ret
The format with nick or GST_FORMAT_UNDEFINED if the format was not registered.
— Function: gst-formats-contains (self <gst-format*>) (format <gst-format>)   (ret bool)

See if the given format is inside the format array.

formats
The format array to search
format
the format to find
ret
TRUE if the format is found inside the array
— Function: gst-format-get-details (format <gst-format>)   (ret <gst-format-definition*>)

Get details about the given format.

format
The format to get details of
ret
The <gst-format-definition> for format or NULL on failure. MT safe.
— Function: gst-format-iterate-definitions   (ret <gst-iterator*>)

Iterate all the registered formats. The format definition is read only.

ret
A GstIterator of <gst-format-definition>.