Back to Seed Clases

Gst

Classes

Interfaces

Structs

Unions

Enums

Struct Gst.Buffer

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

The structure of a GstBuffer. Use the associated macros to access the public variables.

Properties
Properties		Defined By
	_gst_reserved : Array	Gst.Buffer
	caps : Gst.Caps	Gst.Buffer
	data : void*	Gst.Buffer
	duration : Number	Gst.Buffer
	free_func : [object Object]	Gst.Buffer
	malloc_data : void*	Gst.Buffer
	mini_object : Gst.MiniObject	Gst.Buffer
	offset : Number	Gst.Buffer
	offset_end : Number	Gst.Buffer
	parent : Gst.Buffer	Gst.Buffer
	size : Number	Gst.Buffer
	timestamp : Number	Gst.Buffer

Methods / Constructors
Method / Constructor		Defined By
	new Gst.Buffer () Create a new Gst.Buffer Create a new Gst.Buffer
	new Gst.Buffer.and_alloc (Number *size) : Gst.Buffer Create a new Gst.Buffer Create a new Gst.Buffer Parameters: Number size* Required (not null) Returns: Gst.Buffer
	copy_metadata (Buffer *src, BufferCopyFlags flags) : none Copies the metadata from src* into dest. Copies the metadata from src into dest. The data, size and mallocdata fields are not copied. all the metadata fields. This function is typically called from a custom buffer copy function after creating dest and setting the data, size, mallocdata. Parameters: Gst.Buffer src Required (not null) Gst.BufferCopyFlags flags Required (not null) Returns: none	Gst.Buffer
	create_sub (Number *offset, Number size) : Gst.Buffer Creates a sub-buffer from parent* at offset and size. Creates a sub-buffer from parent at offset and size. This sub-buffer uses the actual memory space of the parent buffer. This function will copy the offset and timestamp fields when the offset is 0. If not, they will be set to GST_CLOCK_TIME_NONE and GST_BUFFER_OFFSET_NONE. If offset equals 0 and size equals the total size of buffer, the duration and offset end fields are also copied. If not they will be set to GST_CLOCK_TIME_NONE and GST_BUFFER_OFFSET_NONE. MT safe. Returns NULL if the arguments were invalid. Parameters: Number offset Required (not null) begins. Number size Required (not null) Returns: Gst.Buffer	Gst.Buffer
	get_caps () : Gst.Caps Gets the media type of the buffer. Gets the media type of the buffer. This can be NULL if there is no media type attached to this buffer. Returns NULL if there were no caps on this buffer. Returns: Gst.Caps	Gst.Buffer
	is_metadata_writable () : Boolean Similar to gst_buffer_is_writable, but this only ensures that the refcount of the buffer is 1, indicating that the caller is the sole owner and can change the buffer metadata, such as caps and timestamps. Similar to gst_buffer_is_writable, but this only ensures that the refcount of the buffer is 1, indicating that the caller is the sole owner and can change the buffer metadata, such as caps and timestamps. Returns: Boolean	Gst.Buffer
	is_span_fast (Buffer *buf2) : Boolean Determines whether a gst_buffer_span() can be done without copying the contents, that is, whether the data areas are contiguous sub-buffers of the same buffer. Determines whether a gst_buffer_span() can be done without copying the contents, that is, whether the data areas are contiguous sub-buffers of the same buffer. MT safe. FALSE if a copy would be required. Parameters: Gst.Buffer buf2* Required (not null) Returns: Boolean	Gst.Buffer
	join (Buffer *buf2) : Gst.Buffer Create a new buffer that is the concatenation of the two source buffers, and unrefs the original source buffers. Create a new buffer that is the concatenation of the two source buffers, and unrefs the original source buffers. If the buffers point to contiguous areas of memory, the buffer is created without copying the data. This is a convenience function for C programmers. See also gst_buffer_merge(), which does the same thing without unreffing the input parameters. Language bindings without explicit reference counting should not wrap this function. Parameters: Gst.Buffer buf2* Required (not null) Returns: Gst.Buffer	Gst.Buffer
	make_metadata_writable () : Gst.Buffer Similar to gst_buffer_make_writable, but does not ensure that the buffer data array is writable. Similar to gst_buffer_make_writable, but does not ensure that the buffer data array is writable. Instead, this just ensures that the returned buffer is solely owned by the caller, by creating a subbuffer of the original buffer if necessary. After calling this function, buf should not be referenced anymore. The result of this function has guaranteed writable metadata. Returns: Gst.Buffer	Gst.Buffer
	merge (Buffer *buf2) : Gst.Buffer Create a new buffer that is the concatenation of the two source buffers. Create a new buffer that is the concatenation of the two source buffers. The original source buffers will not be modified or unref'd. Make sure you unref the source buffers if they are not used anymore afterwards. If the buffers point to contiguous areas of memory, the buffer is created without copying the data. Parameters: Gst.Buffer buf2* Required (not null) Returns: Gst.Buffer	Gst.Buffer
	set_caps (Caps *caps) : none Sets the media type on the buffer. Sets the media type on the buffer. The refcount of the caps will be increased and any previous caps on the buffer will be unreffed. Parameters: Gst.Caps caps* Required (not null) Returns: none	Gst.Buffer
	span (Number *offset, Buffer buf2, Number len) : Gst.Buffer buffer should start. buffer should start. Creates a new buffer that consists of part of buf1 and buf2. Logically, buf1 and buf2 are concatenated into a single larger buffer, and a new buffer is created at the given offset inside this space, with a given length. If the two source buffers are children of the same larger buffer, and are contiguous, the new buffer will be a child of the shared parent, and thus no copying is necessary. you can use gst_buffer_is_span_fast() to determine if a memcpy will be needed. MT safe. Returns NULL if the arguments are invalid. Parameters: Number offset* Required (not null) Gst.Buffer buf2 Required (not null) Number len Required (not null) Returns: Gst.Buffer	Gst.Buffer
	stamp (Buffer *src) : none Copies additional information (the timestamp, duration, and offset start and end) from one buffer to the other. Copies additional information (the timestamp, duration, and offset start and end) from one buffer to the other. This function does not copy any buffer flags or caps and is equivalent to gst_buffer_copy_metadata(dest, src, GST_BUFFER_COPY_TIMESTAMPS). control. Parameters: Gst.Buffer src* Required (not null) Returns: none	Gst.Buffer

Events
None

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
Gst Method	Gst.buffer_try_new_and_alloc (Number *size*) : Gst.Buffer Tries to create a newly allocated buffer with data of the given size.
Gst.BufferList Method	get (Number *group, Number idx) : Gst.Buffer Get the buffer at idx* in group.
Gst.BufferListIterator Method	next () : Gst.Buffer Returns the next buffer in the list iterated with it.
Gst.BufferListIterator Method	add (Buffer *buffer) : none Inserts buffer* into the GstBufferList iterated with it.
Gst.BufferListIterator Method	steal () : Gst.Buffer Returns the last buffer returned by gst_buffer_list_iterator_next() without modifying the refcount of the buffer.
Gst.BufferListIterator Method	take (Buffer *buffer*) : none Replaces the last buffer returned by gst_buffer_list_iterator_next() with this function is called.
Gst.BufferListIterator Method	do (Function *do_func, void *user_data*) : Gst.Buffer Calls the given function for the last buffer returned by gst_buffer_list_iterator_next().
Gst.BufferListIterator Method	merge_group () : Gst.Buffer Merge a buffer list group into a normal GstBuffer by copying its metadata and memcpying its data into consecutive memory.
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	push (Buffer *buffer) : Gst.FlowReturn Pushes a buffer to the peer of pad*.
Gst.Pad Method	pull_range (Number *offset, Number size, Buffer buffer) : Gst.FlowReturn Pulls a buffer* from the peer pad.
Gst.Pad Method	chain (Buffer *buffer) : Gst.FlowReturn Chain a buffer to pad*.
Gst.Pad Method	get_range (Number *offset, Number size, Buffer buffer) : Gst.FlowReturn When pad* is flushing this function returns GST_FLOW_WRONG_STATE immediatly.
Gst.TagList Method	get_buffer (String *tag, Buffer value) : Boolean Copies the first buffer for the given tag in the taglist into the variable pointed to by value*.
Gst.TagList Method	get_buffer_index (String *tag, Number index, Buffer value) : Boolean Gets the buffer that is at the given index for the given tag in the given list and copies it into the variable pointed to by value*.
GstApp.AppSink Method	pull_preroll () : Gst.Buffer Get the last preroll buffer in appsink.
GstApp.AppSink Method	pull_buffer () : Gst.Buffer This function blocks until a buffer or EOS becomes available or the appsink element is set to the READY/NULL state.
GstApp.AppSrc Signal	push_buffer (AppSrc *self, Buffer buffer*) : Gst.FlowReturn Adds a buffer to the queue of buffers that the appsrc element will push to its source pad.
GstApp.AppSrc Method	push_buffer (Buffer *buffer*) : Gst.FlowReturn Adds a buffer to the queue of buffers that the appsrc element will push to its source pad.
GstAudio Method	GstAudio.buffer_clip (Buffer *buffer, Segment segment, Number rate, Number frame_size) : Gst.Buffer Clip the the buffer to the given GstSegment*.
GstAudio Method	GstAudio.duration_from_pad_buffer (Pad *pad, Buffer buf) : Number Calculate length in nanoseconds of audio buffer buf* based on capabilities of
GstAudio Method	GstAudio.frame_length (Pad *pad, Buffer buf*) : Number Calculate length of buffer in frames.
GstAudio Method	GstAudio.is_buffer_framed (Pad *pad, Buffer buf*) : Boolean Check if the buffer size is a whole multiple of the frame size.
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.Adapter Method	push (Buffer *buf) : none Adds the data from buf* to the data stored inside adapter and takes ownership of the buffer.
GstBase.Adapter Method	take_buffer (Number *nbytes) : Gst.Buffer Returns a GstBuffer* containing the first nbytes bytes of the This function is potentially more performant than gst_adapter_take() since it can reuse the memory in pushed buffers by subbuffering or merging.
GstBase.BaseSink Property	last_buffer : Gst.Buffer read only
GstBase.BaseSink Method	get_last_buffer () : Gst.Buffer Get the last buffer that arrived in the sink and was used for preroll or for rendering.
GstBase.BitReader Method	new GstBase.BitReader.from_buffer (Buffer *buffer*) : GstBase.BitReader Create a new GstBase.BitReader
GstBase.BitReader Method	init_from_buffer (Buffer *buffer) : none Initializes a GstBitReader* instance to read from buffer.
GstBase.ByteReader Method	new GstBase.ByteReader.from_buffer (Buffer *buffer*) : GstBase.ByteReader Create a new GstBase.ByteReader
GstBase.ByteReader Method	init_from_buffer (Buffer *buffer) : none Initializes a GstByteReader* instance to read from buffer.
GstBase.ByteWriter Method	new GstBase.ByteWriter.with_buffer (Buffer *buffer, Boolean initialized*) : GstBase.ByteWriter Create a new GstBase.ByteWriter
GstBase.ByteWriter Method	init_with_buffer (Buffer *buffer, Boolean initialized) : none Initializes writer* with the given buffer.
GstBase.ByteWriter Method	free_and_get_buffer () : Gst.Buffer Frees writer and all memory allocated by it except the current data, which is returned as GstBuffer.
GstBase.ByteWriter Method	reset_and_get_buffer () : Gst.Buffer Resets writer and returns the current data as buffer.
GstBase.CollectPads Method	peek (CollectData *data) : Gst.Buffer Peek at the buffer currently queued in data*.
GstBase.CollectPads Method	pop (CollectData *data) : Gst.Buffer Pop the buffer currently queued in data*.
GstBase.CollectPads Method	read_buffer (CollectData *data, Number size) : Gst.Buffer Get a buffer of size* bytes from the given pad data.
GstBase.CollectPads Method	take_buffer (CollectData *data, Number size) : Gst.Buffer Get a buffer of size* bytes from the given pad data.
GstCheck Method	GstCheck.buffer_straw_get_buffer (Element *bin, Pad pad) : Gst.Buffer Get one buffer from pad*.
GstCheck Method	GstCheck.chain_func (Pad *pad, Buffer buffer*) : Gst.FlowReturn
GstCheck Method	GstCheck.element_push_buffer (String *element_name, Buffer buffer_in, Buffer buffer_out) : none Create an element* with the factory with the name and push the and this will be compared with buffer_out.
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_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_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.parse_chunk (Element *element, Buffer buf, Object out_values, Number fourcc, Buffer chunk_data*) : Boolean Reads a single chunk.
GstRiff Method	GstRiff.parse_file_header (Element *element, Buffer buf, Object out_values*) : Boolean Reads the first few bytes from the provided buffer, checks if this stream is a RIFF stream, and determines document type.
GstRiff Method	GstRiff.parse_info (Element *element, Buffer buf, TagList taglist*) : none Parses stream metadata from input data.
GstRiff Method	GstRiff.parse_strf_auds (Element *element, Buffer buf, riff_strf_auds strf, Buffer data*) : Boolean Parses an audio stream´s strf structure plus optionally some extradata from input data.
GstRiff Method	GstRiff.parse_strf_iavs (Element *element, Buffer buf, riff_strf_iavs strf, Buffer data*) : Boolean Parses a interleaved (also known as "complex") stream´s strf structure plus optionally some extradata from input data.
GstRiff Method	GstRiff.parse_strf_vids (Element *element, Buffer buf, riff_strf_vids strf, Buffer data*) : Boolean Parses a video stream´s strf structure plus optionally some extradata from input data.
GstRiff Method	GstRiff.parse_strh (Element *element, Buffer buf, riff_strh strh*) : Boolean Parses a strh structure from input data.
GstRiff Method	GstRiff.read_chunk (Element *element, Pad pad, Object out_values, Number tag, Buffer chunk_data*) : Gst.FlowReturn Reads a single chunk of data.
GstRtp Method	GstRtp.buffer_allocate_data (Buffer *buffer, Number payload_len, Number pad_len, Number csrc_count) : none Allocate enough data in buffer* to hold an RTP packet with csrc_count CSRCs, a payload length of payload_len and padding of pad_len.
GstRtp Method	GstRtp.buffer_get_csrc (Buffer *buffer, Number idx) : Number Get the CSRC at index idx* in buffer.
GstRtp Method	GstRtp.buffer_get_csrc_count (Buffer *buffer) : Number Get the CSRC count of the RTP packet in buffer*.
GstRtp Method	GstRtp.buffer_get_extension (Buffer *buffer) : Boolean Check if the extension bit is set on the RTP packet in buffer*.
GstRtp Method	GstRtp.buffer_get_extension_data (Buffer *buffer, Object out_values, void *data*) : Boolean Get the extension data.
GstRtp Method	GstRtp.buffer_get_header_len (Buffer *buffer) : Number Return the total length of the header in buffer*.
GstRtp Method	GstRtp.buffer_get_marker (Buffer *buffer) : Boolean Check if the marker bit is set on the RTP packet in buffer*.
GstRtp Method	GstRtp.buffer_get_packet_len (Buffer *buffer) : Number Return the total length of the packet in buffer*.
GstRtp Method	GstRtp.buffer_get_padding (Buffer *buffer) : Boolean Check if the padding bit is set on the RTP packet in buffer*.
GstRtp Method	GstRtp.buffer_get_payload (Buffer *buffer) : void Get a pointer to the payload data in buffer.
GstRtp Method	GstRtp.buffer_get_payload_buffer (Buffer *buffer) : Gst.Buffer Create a buffer of the payload of the RTP packet in buffer*.
GstRtp Method	GstRtp.buffer_get_payload_len (Buffer *buffer) : Number Get the length of the payload of the RTP packet in buffer*.
GstRtp Method	GstRtp.buffer_get_payload_subbuffer (Buffer *buffer, Number offset, Number len) : Gst.Buffer Create a subbuffer of the payload of the RTP packet in buffer*.
GstRtp Method	GstRtp.buffer_get_payload_type (Buffer *buffer) : Number Get the payload type of the RTP packet in buffer*.
GstRtp Method	GstRtp.buffer_get_seq (Buffer *buffer) : Number Get the sequence number of the RTP packet in buffer*.
GstRtp Method	GstRtp.buffer_get_ssrc (Buffer *buffer) : Number Get the SSRC of the RTP packet in buffer*.
GstRtp Method	GstRtp.buffer_get_timestamp (Buffer *buffer) : Number Get the timestamp of the RTP packet in buffer*.
GstRtp Method	GstRtp.buffer_get_version (Buffer *buffer) : Number Get the version number of the RTP packet in buffer*.
GstRtp Method	GstRtp.buffer_new_allocate (Number *payload_len, Number pad_len, Number csrc_count) : Gst.Buffer Allocate a new GstBuffer* with enough data to hold an RTP packet with All other RTP header fields will be set to 0/FALSE.
GstRtp Method	GstRtp.buffer_new_allocate_len (Number *packet_len, Number pad_len, Number csrc_count) : Gst.Buffer Create a new GstBuffer* that can hold an RTP packet that is exactly All RTP header fields will be set to 0/FALSE.
GstRtp Method	GstRtp.buffer_new_copy_data (void* *data, Number len) : Gst.Buffer Create a new buffer and set the data to a copy of len* bytes of data and the size to len.
GstRtp Method	GstRtp.buffer_new_take_data (void* *data, Number len) : Gst.Buffer Create a new buffer and set the data and size of the buffer to data* and len respectively.
GstRtp Method	GstRtp.buffer_pad_to (Buffer *buffer, Number len) : none Set the amount of padding in the RTP packet in buffer* to
GstRtp Method	GstRtp.buffer_set_csrc (Buffer *buffer, Number idx, Number csrc) : none Modify the CSRC at index idx* in buffer to csrc.
GstRtp Method	GstRtp.buffer_set_extension (Buffer *buffer, Boolean extension) : none Set the extension bit on the RTP packet in buffer* to extension.
GstRtp Method	GstRtp.buffer_set_extension_data (Buffer *buffer, Number bits, Number length) : Boolean the extension, excluding the extension header ( therefore zero is a valid length) Set the extension bit of the rtp buffer and fill in the bits* and length of the extension header.
GstRtp Method	GstRtp.buffer_set_marker (Buffer *buffer, Boolean marker) : none Set the marker bit on the RTP packet in buffer* to marker.
GstRtp Method	GstRtp.buffer_set_packet_len (Buffer *buffer, Number len) : none Set the total buffer* size to len.
GstRtp Method	GstRtp.buffer_set_padding (Buffer *buffer, Boolean padding) : none Set the padding bit on the RTP packet in buffer* to padding.
GstRtp Method	GstRtp.buffer_set_payload_type (Buffer *buffer, Number payload_type) : none Set the payload type of the RTP packet in buffer* to payload_type.
GstRtp Method	GstRtp.buffer_set_seq (Buffer *buffer, Number seq) : none Set the sequence number of the RTP packet in buffer* to seq.
GstRtp Method	GstRtp.buffer_set_ssrc (Buffer *buffer, Number ssrc) : none Set the SSRC on the RTP packet in buffer* to ssrc.
GstRtp Method	GstRtp.buffer_set_timestamp (Buffer *buffer, Number timestamp) : none Set the timestamp of the RTP packet in buffer* to timestamp.
GstRtp Method	GstRtp.buffer_set_version (Buffer *buffer, Number version) : none Set the version of the RTP packet in buffer* to version.
GstRtp Method	GstRtp.buffer_validate (Buffer *buffer) : Boolean Check if the data pointed to by buffer* is a valid RTP packet using validate_data().
GstRtp Method	GstRtp.rtcp_buffer_add_packet (Buffer *buffer, RTCPType type, RTCPPacket packet) : Boolean Add a new packet of type* to buffer.
GstRtp Method	GstRtp.rtcp_buffer_end (Buffer *buffer) : none Finish buffer* after being constructured.
GstRtp Method	GstRtp.rtcp_buffer_get_first_packet (Buffer *buffer, RTCPPacket packet) : Boolean Initialize a new GstRTCPPacket* pointer that points to the first packet in
GstRtp Method	GstRtp.rtcp_buffer_get_packet_count (Buffer *buffer) : Number Get the number of RTCP packets in buffer*.
GstRtp Method	GstRtp.rtcp_buffer_new (Number *mtu*) : Gst.Buffer Create a new buffer for constructing RTCP packets.
GstRtp Method	GstRtp.rtcp_buffer_new_copy_data (void* *data, Number len) : Gst.Buffer Create a new buffer and set the data to a copy of len* bytes of data and the size to len.
GstRtp Method	GstRtp.rtcp_buffer_new_take_data (void* *data, Number len) : Gst.Buffer Create a new buffer and set the data and size of the buffer to data* and len respectively.
GstRtp Method	GstRtp.rtcp_buffer_validate (Buffer *buffer) : Boolean Check if the data pointed to by buffer* is a valid RTCP packet using gst_rtcp_buffer_validate_data().
GstRtp.BaseRTPDepayload Method	push (Buffer *out_buf) : Gst.FlowReturn Push out_buf* to the peer of filter.
GstRtp.BaseRTPDepayload Method	push_ts (Number *timestamp, Buffer out_buf) : Gst.FlowReturn Push out_buf* to the peer of filter.
GstRtp.BaseRTPPayload Method	push (Buffer *buffer) : Gst.FlowReturn Push buffer* to the peer element of the payloader.
GstTag Method	GstTag.image_data_to_image_buffer (String *image_data, Number image_data_len, TagImageType image_type) : Gst.Buffer Helper function for tag-reading plugins to create a GstBuffer* suitable to add to a GstTagList as an image tag (such as GST_TAG_IMAGE or GST_TAG_PREVIEW_IMAGE) from the encoded image data and an (optional) image type.
GstTag Method	GstTag.list_from_vorbiscomment_buffer (Buffer *buffer, String id_data, Number id_data_length, Array vendor_string*) : Gst.TagList Creates a new tag list that contains the information parsed out of a vorbiscomment packet.
GstTag Method	GstTag.list_from_xmp_buffer (Buffer *buffer*) : Gst.TagList Parse a xmp packet into a taglist.
GstTag Method	GstTag.list_to_vorbiscomment_buffer (TagList *list, String id_data, Number id_data_length, String vendor_string*) : Gst.Buffer Creates a new vorbiscomment buffer from a tag list.
GstTag Method	GstTag.list_to_xmp_buffer (TagList *list, Boolean read_only*) : Gst.Buffer Formats a taglist as a xmp packet.

Un-official Seed Documentation

Gst

Classes

Interfaces

Structs

Unions

Enums

Struct Gst.Buffer