Back to Seed Clases

Gst

Classes

Interfaces

Structs

Unions

Enums

Struct Gst.Caps

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

Object describing media types.

Properties
Properties		Defined By
	_gst_reserved : Array	Gst.Caps
	flags : Gst.CapsFlags	Gst.Caps
	refcount : Number	Gst.Caps
	structs : GLib.PtrArray	Gst.Caps
	type : Number	Gst.Caps

Methods / Constructors
Method / Constructor		Defined By
	new Gst.Caps () Create a new Gst.Caps Create a new Gst.Caps
	new Gst.Caps.any () : Gst.Caps Create a new Gst.Caps Create a new Gst.Caps Returns: Gst.Caps
	new Gst.Caps.empty () : Gst.Caps Create a new Gst.Caps Create a new Gst.Caps Returns: Gst.Caps
	append (Caps *caps2) : none Appends the structures contained in caps2 to caps1. Appends the structures contained in caps2 to caps1. The structures in freed. If either caps is ANY, the resulting caps will be ANY. Parameters: Gst.Caps caps2* Required (not null) Returns: none	Gst.Caps
	append_structure (Structure *structure) : none Appends structure* to caps. Appends structure to caps. The structure is not copied; caps becomes the owner of structure. Parameters: Gst.Structure structure Required (not null) Returns: none	Gst.Caps
	can_intersect (Caps *caps2) : Boolean Tries intersecting caps1 and caps2 and reports wheter the result would not be empty Tries intersecting caps1 and caps2 and reports wheter the result would not be empty Parameters: Gst.Caps caps2* Required (not null) Returns: Boolean	Gst.Caps
	copy () : Gst.Caps Creates a new GstCaps as a copy of the old caps. Creates a new GstCaps as a copy of the old caps. The new caps will have a refcount of 1, owned by the caller. The structures are copied as well. Note that this function is the semantic equivalent of a gst_caps_ref() followed by a gst_caps_make_writable(). If you only want to hold on to a reference to the data, you should use gst_caps_ref(). When you are finished with the caps, call gst_caps_unref() on it. Returns: Gst.Caps	Gst.Caps
	copy_nth (Number *nth) : Gst.Caps Creates a new GstCaps* and appends a copy of the nth structure contained in caps. Creates a new GstCaps and appends a copy of the nth structure contained in caps. Parameters: Number nth Required (not null) Returns: Gst.Caps	Gst.Caps
	do_simplify () : Boolean Modifies the given caps inplace into a representation that represents the same set of formats, but in a simpler form. Modifies the given caps inplace into a representation that represents the same set of formats, but in a simpler form. Component structures that are identical are merged. Component structures that have values that can be merged are also merged. Returns: Boolean	Gst.Caps
	get_size () : Number Gets the number of structures contained in caps. Gets the number of structures contained in caps. Returns: Number	Gst.Caps
	get_structure (Number *index) : Gst.Structure Finds the structure in caps* that has the index index, and returns it. Finds the structure in caps that has the index index, and returns it. non-const GstStructure . This is for programming convenience -- the caller should be aware that structures inside a constant GstCaps* should not be modified. However, if you know the caps are writable, either because you have just copied them or made them writable with gst_caps_make_writable(), you may modify the structure returned in the usual way, e.g. with functions like gst_structure_set(). You do not need to free or unref the structure returned, it belongs to the GstCaps. Parameters: Number index Required (not null) Returns: Gst.Structure	Gst.Caps
	intersect (Caps *caps2) : Gst.Caps Creates a new GstCaps* that contains all the formats that are common to both caps1 and caps2. Creates a new GstCaps that contains all the formats that are common to both caps1 and caps2. Parameters: Gst.Caps caps2 Required (not null) Returns: Gst.Caps	Gst.Caps
	is_always_compatible (Caps *caps2) : Boolean A given GstCaps* structure is always compatible with another if every media format that is in the first is also contained in the second. A given GstCaps structure is always compatible with another if every media format that is in the first is also contained in the second. That is, caps1 is a subset of caps2. Parameters: Gst.Caps caps2 Required (not null) Returns: Boolean	Gst.Caps
	is_any () : Boolean Determines if caps represents any media format. Determines if caps represents any media format. Returns: Boolean	Gst.Caps
	is_empty () : Boolean Determines if caps represents no media formats. Determines if caps represents no media formats. Returns: Boolean	Gst.Caps
	is_equal (Caps *caps2) : Boolean Checks if the given caps represent the same set of caps. Checks if the given caps represent the same set of caps. This function does not work reliably if optional properties for caps are included on one caps and omitted on the other. This function deals correctly with passing NULL for any of the caps. Parameters: Gst.Caps caps2* Required (not null) Returns: Boolean	Gst.Caps
	is_equal_fixed (Caps *caps2) : Boolean Tests if two GstCaps* are equal. Tests if two GstCaps are equal. This function only works on fixed GstCaps. Parameters: Gst.Caps caps2 Required (not null) Returns: Boolean	Gst.Caps
	is_fixed () : Boolean Fixed GstCaps describe exactly one format, that is, they have exactly one structure, and each field in the structure describes a fixed type. Fixed GstCaps describe exactly one format, that is, they have exactly one structure, and each field in the structure describes a fixed type. Examples of non-fixed types are GST_TYPE_INT_RANGE and GST_TYPE_LIST. Returns: Boolean	Gst.Caps
	is_subset (Caps *superset) : Boolean Checks if all caps represented by subset* are also represented by superset. Checks if all caps represented by subset are also represented by superset. This function does not work reliably if optional properties for caps are included on one caps and omitted on the other. Parameters: Gst.Caps superset Required (not null) Returns: Boolean	Gst.Caps
	make_writable () : Gst.Caps Returns a writable copy of caps. Returns a writable copy of caps. If there is only one reference count on caps, the caller must be the owner, and so this function will return the caps object unchanged. If on the other hand there is more than one reference on the object, a new caps object will be returned. The caller's reference on caps will be removed, and instead the caller will own a reference to the returned object. In short, this function unrefs the caps in the argument and refs the caps that it returns. Don't access the argument after calling this function. See Returns: Gst.Caps	Gst.Caps
	merge (Caps *caps2) : none Appends the structures contained in caps2 to caps1 if they are not yet expressed by caps1. Appends the structures contained in caps2 to caps1 if they are not yet expressed by caps1. The structures in caps2 are not copied -- they are transferred to caps1, and then caps2 is freed. If either caps is ANY, the resulting caps will be ANY. Parameters: Gst.Caps caps2* Required (not null) Returns: none	Gst.Caps
	merge_structure (Structure *structure) : none Appends structure* to caps if its not already expressed by caps. Appends structure to caps if its not already expressed by caps. The structure is not copied; caps becomes the owner of structure. Parameters: Gst.Structure structure Required (not null) Returns: none	Gst.Caps
	normalize () : Gst.Caps Creates a new GstCaps that represents the same set of formats as Creates a new GstCaps that represents the same set of formats as Returns: Gst.Caps	Gst.Caps
	remove_structure (Number *idx) : none removes the stucture with the given index from the list of structures contained in caps. removes the stucture with the given index from the list of structures contained in caps. Parameters: Number idx* Required (not null) Returns: none	Gst.Caps
	replace (Caps *newcaps) : none Replaces caps with newcaps. Replaces caps with newcaps. Unrefs the GstCaps* in the location pointed to by caps, if applicable, then modifies caps to point to This function does not take any locks so you might want to lock the object owning caps pointer. Parameters: Gst.Caps newcaps Required (not null) Returns: none	Gst.Caps
	save_thyself (Node *parent) : libxml2.Node Serializes a GstCaps* to XML and adds it as a child node of parent. Serializes a GstCaps to XML and adds it as a child node of parent. Parameters: libxml2.Node parent Required (not null) Returns: libxml2.Node	Gst.Caps
	set_value (String *field, Value value) : none Sets the given field* on all structures of caps to the given value. Sets the given field on all structures of caps to the given value. This is a convenience function for calling gst_structure_set_value() on all structures of caps. Parameters: String field Required (not null) GObject.Value value Required (not null) Returns: none	Gst.Caps
	subtract (Caps *subtrahend) : Gst.Caps Subtracts the subtrahend* from the minuend. Subtracts the subtrahend from the minuend. This function does not work reliably if optional properties for caps are included on one caps and omitted on the other. Parameters: Gst.Caps subtrahend Required (not null) Returns: Gst.Caps	Gst.Caps
	to_string () : String Converts caps to a string representation. Converts caps to a string representation. This string representation can be converted back to a GstCaps by gst_caps_from_string(). For debugging purposes its easier to do something like this: \|[ GST_LOG ("caps are %" GST_PTR_FORMAT, caps); ]\| This prints the caps in human readble form. Returns: String	Gst.Caps
	truncate () : none Destructively discard all but the first structure from caps. Destructively discard all but the first structure from caps. Useful when fixating. caps must be writable. Returns: none	Gst.Caps
	union (Caps *caps2) : Gst.Caps Creates a new GstCaps* that contains all the formats that are in either caps1 and caps2. Creates a new GstCaps that contains all the formats that are in either caps1 and caps2. Parameters: Gst.Caps caps2 Required (not null) Returns: Gst.Caps	Gst.Caps

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gst Method	Gst.caps_from_string (String *string) : Gst.Caps Converts caps* from a string representation.
Gst Method	Gst.caps_load_thyself (Node *parent) : Gst.Caps Creates a GstCaps* from its XML serialization.
Gst Method	Gst.type_find_register (Plugin *plugin, String name, Number rank, Function func, Array extensions, Caps possible_caps, void *data, Function data_notify*) : Boolean Registers a new typefind function to be used for typefinding.
Gst Method	Gst.value_get_caps (Value *value) : Gst.Caps Gets the contents of value*.
Gst Method	Gst.value_set_caps (Value *value, Caps caps) : none Sets the contents of value* to caps.
Gst.Buffer Method	get_caps () : Gst.Caps Gets the media type of the buffer.
Gst.Buffer Method	set_caps (Caps *caps*) : none Sets the media type on the buffer.
Gst.Element Method	get_compatible_pad (Pad *pad, Caps caps*) : Gst.Pad Looks for an unlinked pad to which the given pad can link.
Gst.Element Method	link_filtered (Element *dest, Caps filter) : Boolean Links src* to dest using the given caps as filtercaps.
Gst.Element Method	link_pads_filtered (String *srcpadname, Element dest, String destpadname, Caps filter*) : Boolean Links the two named pads of the source and destination elements.
Gst.ElementFactory Method	can_src_caps (Caps *caps*) : Boolean Checks if the factory can source the given capability.
Gst.ElementFactory Method	can_sink_caps (Caps *caps*) : Boolean Checks if the factory can sink the given capability.
Gst.Pad Property	caps : Gst.Caps read only
Gst.Pad Method	alloc_buffer (Number *offset, Number size, Caps caps, Buffer buf) : Gst.FlowReturn Allocates a new, empty buffer optimized to push to pad pad*.
Gst.Pad Method	alloc_buffer_and_set_caps (Number *offset, Number size, Caps caps, Buffer buf) : Gst.FlowReturn In addition to the function gst_pad_alloc_buffer(), this function automatically calls gst_pad_set_caps() when the caps of the newly allocated buffer are different from the pad* caps.
Gst.Pad Method	get_pad_template_caps () : Gst.Caps Gets the capabilities for pad's template.
Gst.Pad Method	get_caps_reffed () : Gst.Caps Gets the capabilities this pad can produce or consume.
Gst.Pad Method	get_caps () : Gst.Caps Gets the capabilities this pad can produce or consume.
Gst.Pad Method	fixate_caps (Caps *caps*) : none Fixate a caps on the given pad.
Gst.Pad Method	accept_caps (Caps *caps*) : Boolean Check if the given pad accepts the caps.
Gst.Pad Method	set_caps (Caps *caps*) : Boolean Sets the capabilities of this pad.
Gst.Pad Method	peer_get_caps_reffed () : Gst.Caps Gets the capabilities of the peer connected to this pad.
Gst.Pad Method	peer_get_caps () : Gst.Caps Gets the capabilities of the peer connected to this pad.
Gst.Pad Method	peer_accept_caps (Caps *caps) : Boolean Check if the peer of pad* accepts caps.
Gst.Pad Method	get_allowed_caps () : Gst.Caps Gets the capabilities of the allowed media types that can flow through The allowed capabilities is calculated as the intersection of the results of calling gst_pad_get_caps() on pad and its peer.
Gst.Pad Method	get_negotiated_caps () : Gst.Caps Gets the capabilities of the media type that currently flows through pad and its peer.
Gst.Pad Method	get_fixed_caps_func () : Gst.Caps A helper function you can use as a GetCaps function that will return the currently negotiated caps or the padtemplate when NULL.
Gst.Pad Method	proxy_getcaps () : Gst.Caps Calls gst_pad_get_allowed_caps() for every other pad belonging to the same element as pad, and returns the intersection of the results.
Gst.Pad Method	proxy_setcaps (Caps *caps*) : Boolean
Gst.PadTemplate Property	caps : Gst.Caps
Gst.PadTemplate Method	new Gst.PadTemplate.c_new (String *name_template, PadDirection direction, PadPresence presence, Caps caps*) : Gst.PadTemplate Create a new Gst.PadTemplate
Gst.PadTemplate Method	get_caps () : Gst.Caps Gets the capabilities of the pad template.
Gst.StaticCaps Method	get () : Gst.Caps Converts a GstStaticCaps to a GstCaps.
Gst.StaticPadTemplate Method	get_caps () : Gst.Caps Gets the capabilities of the static pad template.
Gst.TypeFind Method	suggest (Number *probability, Caps caps) : none If a GstTypeFindFunction* calls this function it suggests the caps with the given probability.
Gst.TypeFindFactory Method	get_caps () : Gst.Caps Gets the GstCaps associated with a typefind factory.
GstApp.AppSink Property	caps : Gst.Caps
GstApp.AppSink Method	set_caps (Caps *caps*) : none Set the capabilities on the appsink element.
GstApp.AppSink Method	get_caps () : Gst.Caps Get the configured caps on appsink.
GstApp.AppSrc Property	caps : Gst.Caps
GstApp.AppSrc Method	set_caps (Caps *caps*) : none Set the capabilities on the appsrc element.
GstApp.AppSrc Method	get_caps () : Gst.Caps Get the configured caps on appsrc.
GstAudio Method	GstAudio.set_caps_channel_positions_list (Caps *caps, AudioChannelPosition pos, Number num_positions*) : none Sets a (possibly non-fixed) list of possible audio channel positions (given in pos) on the given caps.
GstAudio.RingBuffer Method	GstAudio.RingBuffer.parse_caps (RingBufferSpec *spec, Caps caps) : Boolean Parse caps* into spec.
GstBase Method	GstBase.type_find_helper (Pad *src, Number size) : Gst.Caps Tries to find what type of data is flowing from the given source GstPad*.
GstBase Method	GstBase.type_find_helper_for_buffer (Object *obj, Buffer buf, TypeFindProbability prob) : Gst.Caps Tries to find what type of data is contained in the given GstBuffer*, the assumption being that the buffer represents the beginning of the stream or file.
GstBase Method	GstBase.type_find_helper_for_extension (Object *obj, String extension) : Gst.Caps Tries to find the best GstCaps* associated with extension.
GstBase Method	GstBase.type_find_helper_get_range (Object *obj, Function func, Number size, TypeFindProbability prob*) : Gst.Caps Utility function to do pull-based typefinding.
GstBase Method	GstBase.type_find_helper_get_range_ext (Object *obj, Function func, Number size, String extension, TypeFindProbability prob*) : Gst.Caps Utility function to do pull-based typefinding.
GstBase.BaseTransform Method	suggest (Caps *caps, Number size) : none Instructs trans* to suggest new caps upstream.
GstCheck Method	GstCheck.caps_equal (Caps *caps1, Caps caps2*) : none Compare two caps with gst_caps_is_equal and fail unless they are equal.
GstCheck Method	GstCheck.setup_sink_pad (Element *element, StaticPadTemplate template, Caps caps*) : Gst.Pad
GstCheck Method	GstCheck.setup_src_pad (Element *element, StaticPadTemplate template, Caps caps*) : Gst.Pad
GstPbutils Method	GstPbutils.missing_decoder_installer_detail_new (Caps *decode_caps*) : String Returns an opaque string containing all the details about the missing element to be passed to an external installer called via gst_install_plugins_async() or gst_install_plugins_sync().
GstPbutils Method	GstPbutils.missing_decoder_message_new (Element *element, Caps decode_caps) : Gst.Message Creates a missing-plugin message for element* to notify the application that a decoder element for a particular set of (fixed) caps is missing.
GstPbutils Method	GstPbutils.missing_encoder_installer_detail_new (Caps *encode_caps*) : String Returns an opaque string containing all the details about the missing element to be passed to an external installer called via gst_install_plugins_async() or gst_install_plugins_sync().
GstPbutils Method	GstPbutils.missing_encoder_message_new (Element *element, Caps encode_caps) : Gst.Message Creates a missing-plugin message for element* to notify the application that an encoder element for a particular set of (fixed) caps is missing.
GstPbutils Method	GstPbutils.pb_utils_add_codec_description_to_tag_list (TagList *taglist, String codec_tag, Caps caps) : Boolean Adds a codec tag describing the format specified by caps* to taglist.
GstPbutils Method	GstPbutils.pb_utils_get_codec_description (Caps *caps) : String Returns a localised (as far as this is possible) string describing the media format specified in caps*, for use in error dialogs or other messages to be seen by the user.
GstPbutils Method	GstPbutils.pb_utils_get_decoder_description (Caps *caps) : String Returns a localised string describing an decoder for the format specified in caps*, for use in error dialogs or other messages to be seen by the user.
GstPbutils Method	GstPbutils.pb_utils_get_encoder_description (Caps *caps) : String Returns a localised string describing an encoder for the format specified in caps*, for use in error dialogs or other messages to be seen by the user.
GstRiff Method	GstRiff.create_audio_caps (Number *codec_id, riff_strh strh, riff_strf_auds strf, Buffer strf_data, Buffer strd_data, Array codec_name*) : Gst.Caps
GstRiff Method	GstRiff.create_audio_template_caps () : Gst.Caps
GstRiff Method	GstRiff.create_iavs_caps (Number *codec_fcc, riff_strh strh, riff_strf_iavs strf, Buffer strf_data, Buffer strd_data, Array codec_name*) : Gst.Caps
GstRiff Method	GstRiff.create_iavs_template_caps () : Gst.Caps
GstRiff Method	GstRiff.create_video_caps (Number *codec_fcc, riff_strh strh, riff_strf_vids strf, Buffer strf_data, Buffer strd_data, Array codec_name*) : Gst.Caps
GstRiff Method	GstRiff.create_video_template_caps () : Gst.Caps
GstRtsp.RTSPExtension Method	configure_stream (Caps *caps*) : Boolean
GstVideo Method	GstVideo.format_new_caps (VideoFormat *format, Number width, Number height, Number framerate_n, Number framerate_d, Number par_n, Number par_d) : Gst.Caps Creates a new GstCaps* object based on the parameters provided.
GstVideo Method	GstVideo.format_new_caps_interlaced (VideoFormat *format, Number width, Number height, Number framerate_n, Number framerate_d, Number par_n, Number par_d, Boolean interlaced) : Gst.Caps Creates a new GstCaps* object based on the parameters provided.
GstVideo Method	GstVideo.format_parse_caps (Caps *caps, VideoFormat format, Object out_values) : Boolean Determines the GstVideoFormat* of caps and places it in the location pointed to by format.
GstVideo Method	GstVideo.format_parse_caps_interlaced (Caps *caps, Object out_values) : Boolean Extracts whether the caps represents interlaced content or not and places it in interlaced*.
GstVideo Method	GstVideo.parse_caps_chroma_site (Caps *caps*) : String Extracts the chroma site used by the caps.
GstVideo Method	GstVideo.parse_caps_color_matrix (Caps *caps*) : String Extracts the color matrix used by the caps.
GstVideo Method	GstVideo.parse_caps_framerate (Caps *caps, Object out_values) : Boolean Extracts the frame rate from caps* and places the values in the locations pointed to by fps_n and fps_d.
GstVideo Method	GstVideo.parse_caps_pixel_aspect_ratio (Caps *caps, Object out_values) : Boolean Extracts the pixel aspect ratio from caps* and places the values in the locations pointed to by par_n and par_d.

Un-official Seed Documentation

Gst

Classes

Interfaces

Structs

Unions

Enums

Struct Gst.Caps