Back to Seed Clases

Gst

Classes

Interfaces

Structs

Unions

Enums

Struct Gst.Structure

Import line:	Gst = imports.gi.Gst;
GIR File:	Gst-0.10.gir
C documentation:	GstStructure
Struct :	Structure
	Show / Hide Inherited methods, properties and signals

The GstStructure object. Most fields are private.

Properties
Properties		Defined By
	_gst_reserved : void*	Gst.Structure
	fields : GLib.Array	Gst.Structure
	name : Number	Gst.Structure
	parent_refcount : void*	Gst.Structure
	type : Number	Gst.Structure

Methods / Constructors
Method / Constructor		Defined By
	new Gst.Structure () Create a new Gst.Structure Create a new Gst.Structure
	copy () : Gst.Structure Duplicates a GstStructure and all its fields and values. Duplicates a GstStructure and all its fields and values. Returns: Gst.Structure	Gst.Structure
	fixate_field_boolean (String *field_name, Boolean target) : Boolean Fixates a GstStructure* by changing the given field_name field to the given Fixates a GstStructure by changing the given field_name field to the given Parameters: String field_name Required (not null) Boolean target Required (not null) Returns: Boolean	Gst.Structure
	fixate_field_nearest_double (String *field_name, Number target) : Boolean Fixates a GstStructure* by changing the given field to the nearest double to target that is a subset of the existing field. Fixates a GstStructure by changing the given field to the nearest double to target that is a subset of the existing field. Parameters: String field_name Required (not null) Number target Required (not null) Returns: Boolean	Gst.Structure
	fixate_field_nearest_fraction (String *field_name, Number target_numerator, Number target_denominator) : Boolean Fixates a GstStructure* by changing the given field to the nearest fraction to target_numerator/target_denominator that is a subset of the existing field. Fixates a GstStructure by changing the given field to the nearest fraction to target_numerator/target_denominator that is a subset of the existing field. Parameters: String field_name Required (not null) Number target_numerator Required (not null) Number target_denominator Required (not null) Returns: Boolean	Gst.Structure
	fixate_field_nearest_int (String *field_name, Number target) : Boolean Fixates a GstStructure* by changing the given field to the nearest integer to target that is a subset of the existing field. Fixates a GstStructure by changing the given field to the nearest integer to target that is a subset of the existing field. Parameters: String field_name Required (not null) Number target Required (not null) Returns: Boolean	Gst.Structure
	foreach (Function *func, void *user_data) : Boolean Calls the provided function once for each field in the GstStructure. Calls the provided function once for each field in the GstStructure. The function must not modify the fields. Also see gst_structure_map_in_place(). FALSE otherwise. Parameters: Function (Number field_id, Value value, void *user_data) : Boolean Required (not null) void user_data Required (not null) Returns: Boolean	Gst.Structure
	free () : none Frees a GstStructure and all its fields and values. Frees a GstStructure and all its fields and values. The structure must not have a parent when this function is called. Returns: none	Gst.Structure
	get_boolean (String *fieldname, Object out_values) : Boolean Sets the boolean pointed to by value* corresponding to the value of the given field. Sets the boolean pointed to by value corresponding to the value of the given field. Caller is responsible for making sure the field exists and has the correct type. with fieldname or the existing field did not contain a boolean, this function returns FALSE. Parameters: String fieldname Required (not null) Object out_values Boolean value Returns: Boolean	Gst.Structure
	get_clock_time (String *fieldname, Number value) : Boolean Sets the clock time pointed to by value* corresponding to the clock time of the given field. Sets the clock time pointed to by value corresponding to the clock time of the given field. Caller is responsible for making sure the field exists and has the correct type. with fieldname or the existing field did not contain a GstClockTime, this function returns FALSE. Parameters: String fieldname Required (not null) Number value Required (not null) Returns: Boolean	Gst.Structure
	get_date (String *fieldname, Date value) : Boolean Sets the date pointed to by value* corresponding to the date of the given field. Sets the date pointed to by value corresponding to the date of the given field. Caller is responsible for making sure the field exists and has the correct type. On success value will point to a newly-allocated copy of the date which inconsistent with e.g. gst_structure_get_string() which doesn't return a copy of the string). with fieldname or the existing field did not contain a data, this function returns FALSE. Parameters: String fieldname Required (not null) GLib.Date value Required (not null) Returns: Boolean	Gst.Structure
	get_double (String *fieldname, Object out_values) : Boolean Sets the double pointed to by value* corresponding to the value of the given field. Sets the double pointed to by value corresponding to the value of the given field. Caller is responsible for making sure the field exists and has the correct type. with fieldname or the existing field did not contain a double, this function returns FALSE. Parameters: String fieldname Required (not null) Object out_values Number value Returns: Boolean	Gst.Structure
	get_enum (String *fieldname, Number enumtype, Object out_values) : Boolean Sets the int pointed to by value* corresponding to the value of the given field. Sets the int pointed to by value corresponding to the value of the given field. Caller is responsible for making sure the field exists, has the correct type and that the enumtype is correct. with fieldname or the existing field did not contain an enum of the given type, this function returns FALSE. Parameters: String fieldname Required (not null) Number enumtype Required (not null) Object out_values Number value Returns: Boolean	Gst.Structure
	get_field_type (String *fieldname) : Number Finds the field with the given name, and returns the type of the value it contains. Finds the field with the given name, and returns the type of the value it contains. If the field is not found, G_TYPE_INVALID is returned. Parameters: String fieldname* Required (not null) Returns: Number	Gst.Structure
	get_fourcc (String *fieldname, Object out_values) : Boolean Sets the Fourcc pointed to by value* corresponding to the value of the given field. Sets the Fourcc pointed to by value corresponding to the value of the given field. Caller is responsible for making sure the field exists and has the correct type. with fieldname or the existing field did not contain a fourcc, this function returns FALSE. Parameters: String fieldname Required (not null) Object out_values Number value Returns: Boolean	Gst.Structure
	get_fraction (String *fieldname, Object out_values) : Boolean Sets the integers pointed to by value_numerator* and value_denominator corresponding to the value of the given field. Sets the integers pointed to by value_numerator and value_denominator corresponding to the value of the given field. Caller is responsible for making sure the field exists and has the correct type. with fieldname or the existing field did not contain a GstFraction, this function returns FALSE. Parameters: String fieldname Required (not null) Object out_values Number value_numerator Number value_denominator Returns: Boolean	Gst.Structure
	get_int (String *fieldname, Object out_values) : Boolean Sets the int pointed to by value* corresponding to the value of the given field. Sets the int pointed to by value corresponding to the value of the given field. Caller is responsible for making sure the field exists and has the correct type. with fieldname or the existing field did not contain an int, this function returns FALSE. Parameters: String fieldname Required (not null) Object out_values Number value Returns: Boolean	Gst.Structure
	get_name () : String Get the name of structure as a string. Get the name of structure as a string. Returns: String	Gst.Structure
	get_name_id () : Number Get the name of structure as a GQuark. Get the name of structure as a GQuark. Returns: Number	Gst.Structure
	get_string (String *fieldname) : String Finds the field corresponding to fieldname, and returns the string contained in the field's value. Finds the field corresponding to fieldname, and returns the string contained in the field's value. Caller is responsible for making sure the field exists and has the correct type. The string should not be modified, and remains valid until the next call to a gst_structure_() function with the given structure. or did not contain a string. Parameters: String fieldname Required (not null) Returns: String	Gst.Structure
	get_uint (String *fieldname, Object out_values) : Boolean Sets the uint pointed to by value* corresponding to the value of the given field. Sets the uint pointed to by value corresponding to the value of the given field. Caller is responsible for making sure the field exists and has the correct type. with fieldname or the existing field did not contain a uint, this function returns FALSE. Parameters: String fieldname Required (not null) Object out_values Number value Returns: Boolean	Gst.Structure
	get_value (String *fieldname) : GObject.Value Get the value of the field with name fieldname. Get the value of the field with name fieldname. Parameters: String fieldname* Required (not null) Returns: GObject.Value	Gst.Structure
	has_field (String *fieldname) : Boolean Check if structure* contains a field named fieldname. Check if structure contains a field named fieldname. Parameters: String fieldname Required (not null) Returns: Boolean	Gst.Structure
	has_field_typed (String *fieldname, Number type) : Boolean Check if structure* contains a field named fieldname and with GType type. Check if structure contains a field named fieldname and with GType type. Parameters: String fieldname Required (not null) Number type Required (not null) Returns: Boolean	Gst.Structure
	has_name (String *name) : Boolean Checks if the structure has the given name Checks if the structure has the given name Parameters: String name* Required (not null) Returns: Boolean	Gst.Structure
	id_get_value (Number *field) : GObject.Value Get the value of the field with GQuark field. Get the value of the field with GQuark field. Parameters: Number field* Required (not null) Returns: GObject.Value identifier.	Gst.Structure
	id_has_field (Number *field) : Boolean Check if structure* contains a field named field. Check if structure contains a field named field. Parameters: Number field Required (not null) Returns: Boolean	Gst.Structure
	id_has_field_typed (Number *field, Number type) : Boolean Check if structure* contains a field named field and with GType type. Check if structure contains a field named field and with GType type. Parameters: Number field Required (not null) Number type Required (not null) Returns: Boolean	Gst.Structure
	id_set_value (Number *field, Value value) : none Sets the field with the given GQuark field* to value. Sets the field with the given GQuark field to value. If the field does not exist, it is created. If the field exists, the previous value is replaced and freed. Parameters: Number field Required (not null) GObject.Value value Required (not null) Returns: none	Gst.Structure
	map_in_place (Function *func, void *user_data) : Boolean Calls the provided function once for each field in the GstStructure. Calls the provided function once for each field in the GstStructure. In contrast to gst_structure_foreach(), the function may modify but not delete the fields. The structure must be mutable. FALSE otherwise. Parameters: Function (Number field_id, Value value, void *user_data) : Boolean Required (not null) void user_data Required (not null) Returns: Boolean	Gst.Structure
	n_fields () : Number Get the number of fields in the structure. Get the number of fields in the structure. Returns: Number	Gst.Structure
	nth_field_name (Number *index) : String Get the name of the given field number, counting from 0 onwards. Get the name of the given field number, counting from 0 onwards. Parameters: Number index* Required (not null) Returns: String	Gst.Structure
	remove_all_fields () : none Removes all fields in a GstStructure. Removes all fields in a GstStructure. Returns: none	Gst.Structure
	remove_field (String *fieldname) : none Removes the field with the given name. Removes the field with the given name. If the field with the given name does not exist, the structure is unchanged. Parameters: String fieldname* Required (not null) Returns: none	Gst.Structure
	set_name (String *name) : none Sets the name of the structure to the given name. Sets the name of the structure to the given name. The string provided is copied before being used. It must not be empty, start with a letter and can be followed by letters, numbers and any of "/-_.:". Parameters: String name* Required (not null) Returns: none	Gst.Structure
	set_parent_refcount () : Number Sets the parent_refcount field of GstStructure. Sets the parent_refcount field of GstStructure. This field is used to determine whether a structure is mutable or not. This function should only be called by code implementing parent objects of GstStructure, as described in the MT Refcounting section of the design documents. Returns: Number	Gst.Structure
	set_value (String *fieldname, Value value) : none Sets the field with the given name field* to value. Sets the field with the given name field to value. If the field does not exist, it is created. If the field exists, the previous value is replaced and freed. Parameters: String fieldname Required (not null) GObject.Value value Required (not null) Returns: none	Gst.Structure
	to_string () : String Converts structure to a human-readable string representation. Converts structure to a human-readable string representation. For debugging purposes its easier to do something like this: \|[ GST_LOG ("structure is %" GST_PTR_FORMAT, structure); ]\| This prints the structure in human readble form. usage. Returns: String after	Gst.Structure

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gst Method	Gst.structure_empty_new (String *name) : Gst.Structure Creates a new, empty GstStructure* with the given name.
Gst Method	Gst.structure_from_string (String *string, Array end) : Gst.Structure Creates a GstStructure* from a string representation.
Gst Method	Gst.structure_id_empty_new (Number *quark) : Gst.Structure Creates a new, empty GstStructure* with the given name as a GQuark.
Gst Method	Gst.value_get_structure (Value *value) : Gst.Structure Gets the contents of value*.
Gst Method	Gst.value_set_structure (Value *value, Structure structure) : none Sets the contents of value* to structure.
Gst.Caps Method	append_structure (Structure *structure) : none Appends structure* to caps.
Gst.Caps Method	merge_structure (Structure *structure) : none Appends structure* to caps if its not already expressed by caps.
Gst.Caps Method	get_structure (Number *index) : Gst.Structure Finds the structure in caps* that has the index index, and returns it.
Gst.Event Method	new Gst.Event.custom (EventType *type, Structure structure*) : Gst.Event Create a new Gst.Event
Gst.Event Method	new Gst.Event.navigation (Structure *structure*) : Gst.Event Create a new Gst.Event
Gst.Event Method	get_structure () : Gst.Structure Access the structure of the event.
Gst.Message Method	new Gst.Message.application (Object *src, Structure structure*) : Gst.Message Create a new Gst.Message
Gst.Message Method	new Gst.Message.element (Object *src, Structure structure*) : Gst.Message Create a new Gst.Message
Gst.Message Method	new Gst.Message.custom (MessageType *type, Object src, Structure structure*) : Gst.Message Create a new Gst.Message
Gst.Message Method	get_structure () : Gst.Structure Access the structure of the message.
Gst.Plugin Method	get_cache_data () : Gst.Structure Gets the plugin specific data cache.
Gst.Plugin Method	set_cache_data (Structure *cache_data*) : none Adds plugin specific data to cache.
Gst.Query Method	new Gst.Query.application (QueryType *type, Structure structure*) : Gst.Query Create a new Gst.Query
Gst.Query Method	get_structure () : Gst.Structure Get the structure of a query.
GstAudio Method	GstAudio.fixate_channel_positions (Structure *str*) : GstAudio.AudioChannelPosition Custom fixate function.
GstAudio Method	GstAudio.get_channel_positions (Structure *str) : GstAudio.AudioChannelPosition Retrieves a number of (fixed!) audio channel positions from the provided GstStructure* and returns it as a newly allocated array.
GstAudio Method	GstAudio.set_channel_positions (Structure *str, AudioChannelPosition pos) : none Adds a "channel-positions" field to the given GstStructure, which will represent the channel positions as given in the provided GstAudioChannelPosition* array.
GstAudio Method	GstAudio.set_structure_channel_positions_list (Structure *str, AudioChannelPosition pos, Number num_positions*) : none Sets a (possibly non-fixed) list of possible audio channel positions (given in pos) on the given structure.
GstAudio Method	GstAudio.structure_set_int (Structure *structure, AudioFieldFlag flag*) : none Do not use anymore.
GstInterfaces.Navigation Method	send_event (Structure *structure*) : none
GstRtsp.RTSPExtension Method	parse_sdp (SDPMessage *sdp*, Structure s) : GstRtsp.RTSPResult

Un-official Seed Documentation

Gst

Classes

Interfaces

Structs

Unions

Enums

Struct Gst.Structure