GstParamSpec

GstParamSpecArray

GParamSpec
    ╰──GstParamSpecArray

GstParamSpecFraction

GParamSpec
    ╰──GstParamSpecFraction

gst_param_spec_array

GParamSpec *
gst_param_spec_array (const gchar * name,
                      const gchar * nick,
                      const gchar * blurb,
                      GParamSpec * element_spec,
                      GParamFlags flags)

This function creates a GstArray GParamSpec for use by objects/elements that want to expose properties of GstArray type. This function is typically * used in connection with g_object_class_install_property in a GObjects's instance_init function.

Since : 1.14

gst_param_spec_fraction

GParamSpec *
gst_param_spec_fraction (const gchar * name,
                         const gchar * nick,
                         const gchar * blurb,
                         gint min_num,
                         gint min_denom,
                         gint max_num,
                         gint max_denom,
                         gint default_num,
                         gint default_denom,
                         GParamFlags flags)

This function creates a fraction GParamSpec for use by objects/elements that want to expose properties of fraction type. This function is typically used in connection with g_object_class_install_property in a GObjects's instance_init function.

gst_param_spec_get_kind

const GstStructure *
gst_param_spec_get_kind (GParamSpec * pspec)

Returns the semantic kind previously set on pspec with gst_param_spec_set_kind.

Since : 1.30

gst_param_spec_set_kind

gst_param_spec_set_kind (GParamSpec * pspec,
                         GstStructure * kind)

Tags pspec with a semantic kind. The structure name says what the property is (e.g. GST_PROP_KIND_LOCATION) and its fields refine it, for example:

location, subtype=(string)path, mimetypes=(string){image/png,image/jpeg}

A kind can only be set once: it cannot be replaced or cleared afterwards.

Since : 1.30

GST_IS_PARAM_SPEC_ARRAY_LIST

#define GST_IS_PARAM_SPEC_ARRAY_LIST(pspec) (G_TYPE_CHECK_INSTANCE_TYPE ((pspec), GST_TYPE_PARAM_ARRAY_LIST))

GST_PARAM_SPEC_ARRAY_LIST

#define GST_PARAM_SPEC_ARRAY_LIST(pspec)    (G_TYPE_CHECK_INSTANCE_CAST ((pspec), GST_TYPE_PARAM_ARRAY_LIST, GstParamSpecArray))

GST_PARAM_CONDITIONALLY_AVAILABLE

#define GST_PARAM_CONDITIONALLY_AVAILABLE  (1 << (G_PARAM_USER_SHIFT + 6))

Use this flag on GObject properties of GstObject to indicate that they might not be available depending on environment such as OS, device, etc, so such properties will be installed conditionally only if the GstObject is able to support it.

Since : 1.18

GST_PARAM_CONTROLLABLE

#define GST_PARAM_CONTROLLABLE	(1 << (G_PARAM_USER_SHIFT + 1))

Use this flag on GObject properties to signal they can make sense to be. controlled over time. This hint is used by the GstController.

GST_PARAM_DOC_SHOW_DEFAULT

#define GST_PARAM_DOC_SHOW_DEFAULT  (1 << (G_PARAM_USER_SHIFT + 5))

Use this flag on GObject properties of GstObject to indicate that during gst-inspect and friends, the default value should be used as default instead of the current value.

Since : 1.18

GST_PARAM_MUTABLE_PAUSED

#define GST_PARAM_MUTABLE_PAUSED  (1 << (G_PARAM_USER_SHIFT + 3))

Use this flag on GObject properties of GstElements to indicate that they can be changed when the element is in the PAUSED or lower state. This flag implies GST_PARAM_MUTABLE_READY.

GST_PARAM_MUTABLE_PLAYING

#define GST_PARAM_MUTABLE_PLAYING  (1 << (G_PARAM_USER_SHIFT + 4))

Use this flag on GObject properties of GstElements to indicate that they can be changed when the element is in the PLAYING or lower state. This flag implies GST_PARAM_MUTABLE_PAUSED.

GST_PARAM_MUTABLE_READY

#define GST_PARAM_MUTABLE_READY  (1 << (G_PARAM_USER_SHIFT + 2))

Use this flag on GObject properties of GstElements to indicate that they can be changed when the element is in the READY or lower state.

GST_PARAM_UNTRUSTED_SENSITIVE

#define GST_PARAM_UNTRUSTED_SENSITIVE  (1 << (G_PARAM_USER_SHIFT + 7))

Use this flag on GObject properties whose value can make the element reach outside its media processing: read or write a file, open a network connection, select a device or IPC endpoint, load a plugin or library, or run externally supplied code (shader or script source). Setting such a property from data that comes from an untrusted source (for example a serialized pipeline or project file that was downloaded or received from a third party) is a security risk.

Consumers that build pipelines from untrusted descriptions can ask gst_parse_launch_full to refuse these properties with GST_PARSE_FLAG_NO_UNTRUSTED.

This flag only takes effect on elements whose class is also marked with gst_element_class_mark_as_untrusted_aware: an unmarked element is never instantiated from an untrusted description in the first place, so an element that sets this flag on a property must also mark its class.

Since : 1.30

GST_PARAM_USER_SHIFT

#define GST_PARAM_USER_SHIFT	(1 << (G_PARAM_USER_SHIFT + 8))

Bits based on GST_PARAM_USER_SHIFT can be used by 3rd party applications.

GST_PROP_KIND_BITRATE

#define GST_PROP_KIND_BITRATE "bitrate"

Kind name for properties describing a bitrate. The GST_PROP_KIND_FIELD_UNIT field gives the unit of the value; bits per second when absent.

Since : 1.30

GST_PROP_KIND_COLOR

#define GST_PROP_KIND_COLOR "color"

Kind name for properties describing a color.

Since : 1.30

GST_PROP_KIND_FIELD_EXTENSIONS

#define GST_PROP_KIND_FIELD_EXTENSIONS "extensions"

Kind field listing the file extensions the resource is expected to have, without the leading dot, e.g. onnx. Either a string or a GstValueList of strings, so readers must check the value type: gst_structure_get_string returns NULL for a list. Meant as a filter hint for file choosers, not as a restriction enforced by the element.

Since : 1.30

GST_PROP_KIND_FIELD_MIMETYPES

#define GST_PROP_KIND_FIELD_MIMETYPES "mimetypes"

Kind field listing the media types the resource is expected to hold, e.g. image/png. Either a string or a GstValueList of strings, so readers must check the value type: gst_structure_get_string returns NULL for a list.

Since : 1.30

GST_PROP_KIND_FIELD_SUBTYPE

#define GST_PROP_KIND_FIELD_SUBTYPE "subtype"

Kind field (string) refining how the value is encoded, e.g. GST_PROP_KIND_SUBTYPE_PATH.

Since : 1.30

GST_PROP_KIND_FIELD_UNIT

#define GST_PROP_KIND_FIELD_UNIT "unit"

Kind field (string) giving the unit of a numeric value, e.g. GST_PROP_KIND_UNIT_KILOBITS_PER_SEC.

Since : 1.30

GST_PROP_KIND_FONT

#define GST_PROP_KIND_FONT "font"

Kind name for properties describing a font.

Since : 1.30

GST_PROP_KIND_LOCATION

#define GST_PROP_KIND_LOCATION "location"

Kind name for properties naming a resource to be opened, read or written. The GST_PROP_KIND_FIELD_SUBTYPE field says how the resource is addressed.

Since : 1.30

GST_PROP_KIND_NETWORK

#define GST_PROP_KIND_NETWORK "network"

Kind name for properties naming a network endpoint.

Since : 1.30

GST_PROP_KIND_SECURITY

#define GST_PROP_KIND_SECURITY "security"

Kind name for properties holding a credential.

Since : 1.30

GST_PROP_KIND_SUBTYPE_ARGB

#define GST_PROP_KIND_SUBTYPE_ARGB "argb"

A color packed as 0xAARRGGBB in an integer property. Use as GST_PROP_KIND_FIELD_SUBTYPE of GST_PROP_KIND_COLOR.

Since : 1.30

GST_PROP_KIND_SUBTYPE_DESC

#define GST_PROP_KIND_SUBTYPE_DESC "desc"

A Pango font description, e.g. Sans Bold 12. Use as GST_PROP_KIND_FIELD_SUBTYPE of GST_PROP_KIND_FONT.

Since : 1.30

GST_PROP_KIND_SUBTYPE_DIRECTORY

#define GST_PROP_KIND_SUBTYPE_DIRECTORY "directory"

A filesystem path naming a directory rather than a file. Use as GST_PROP_KIND_FIELD_SUBTYPE of GST_PROP_KIND_LOCATION.

Since : 1.30

GST_PROP_KIND_SUBTYPE_HOSTNAME

#define GST_PROP_KIND_SUBTYPE_HOSTNAME "hostname"

A host name, IP address or network interface. Use as GST_PROP_KIND_FIELD_SUBTYPE of GST_PROP_KIND_NETWORK.

Since : 1.30

GST_PROP_KIND_SUBTYPE_PASSWORD

#define GST_PROP_KIND_SUBTYPE_PASSWORD "password"

A password, token or other credential. Editors should mask it, and tooling should keep it out of logs and pipeline dumps. Use as GST_PROP_KIND_FIELD_SUBTYPE of GST_PROP_KIND_SECURITY.

Since : 1.30

GST_PROP_KIND_SUBTYPE_PATH

#define GST_PROP_KIND_SUBTYPE_PATH "path"

A resource addressed by a filesystem path, absolute or relative. Use as GST_PROP_KIND_FIELD_SUBTYPE of GST_PROP_KIND_LOCATION.

Since : 1.30

GST_PROP_KIND_SUBTYPE_PATTERN

#define GST_PROP_KIND_SUBTYPE_PATTERN "pattern"

A printf-style pattern expanded into filesystem paths, as used by multifilesink and splitmuxsink (e.g. video%05d.mp4). Distinct from GST_PROP_KIND_SUBTYPE_PATH because picking a single existing file yields a pattern that matches only itself. Use as GST_PROP_KIND_FIELD_SUBTYPE of GST_PROP_KIND_LOCATION.

Since : 1.30

GST_PROP_KIND_SUBTYPE_URI

#define GST_PROP_KIND_SUBTYPE_URI "uri"

A resource addressed by a URI, e.g. scheme://.... Whether the URI is local or remote depends on the value set at runtime, so it is not part of the hint. Use as GST_PROP_KIND_FIELD_SUBTYPE of GST_PROP_KIND_LOCATION.

Since : 1.30

GST_PROP_KIND_UNIT_BITS_PER_SEC

#define GST_PROP_KIND_UNIT_BITS_PER_SEC "bits-per-sec"

Bits per second. Use as GST_PROP_KIND_FIELD_UNIT of GST_PROP_KIND_BITRATE.

Since : 1.30

GST_PROP_KIND_UNIT_BYTES_PER_SEC

#define GST_PROP_KIND_UNIT_BYTES_PER_SEC "bytes-per-sec"

Bytes per second. Use as GST_PROP_KIND_FIELD_UNIT of GST_PROP_KIND_BITRATE.

Since : 1.30

GST_PROP_KIND_UNIT_KILOBITS_PER_SEC

#define GST_PROP_KIND_UNIT_KILOBITS_PER_SEC "kilobits-per-sec"

Kilobits per second (1000 bits per second). Use as GST_PROP_KIND_FIELD_UNIT of GST_PROP_KIND_BITRATE.

Since : 1.30

GST_TYPE_PARAM_ARRAY_LIST

#define GST_TYPE_PARAM_ARRAY_LIST           (gst_param_spec_array_get_type ())

GST_TYPE_PARAM_FRACTION

#define GST_TYPE_PARAM_FRACTION           (gst_param_spec_fraction_get_type ())