Back to Seed Clases

GstBase

Classes

Interfaces

Structs

Unions

Enums

BaseSrcFlags

Struct GstBase.ByteReader

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

A byte reader instance.

Properties
Properties		Defined By
	byte : Number	GstBase.ByteReader
	data : void*	GstBase.ByteReader
	size : Number	GstBase.ByteReader

Methods / Constructors
Method / Constructor		Defined By
	new GstBase.ByteReader () Create a new GstBase.ByteReader Create a new GstBase.ByteReader
	new GstBase.ByteReader.c_new (String *data, Number size) : GstBase.ByteReader Create a new GstBase.ByteReader Create a new GstBase.ByteReader Parameters: String data* Required (not null) Number size Required (not null) Returns: GstBase.ByteReader
	new GstBase.ByteReader.from_buffer (Buffer *buffer) : GstBase.ByteReader Create a new GstBase.ByteReader Create a new GstBase.ByteReader Parameters: Gst.Buffer buffer* Required (not null) Returns: GstBase.ByteReader
	dup_data (Number *size, Object out_values) : Boolean Returns a newly-allocated copy of the current data position if at least size* bytes are left and updates the current position. Returns a newly-allocated copy of the current data position if at least size bytes are left and updates the current position. Parameters: Number size Required (not null) Object out_values Number val Returns: Boolean	GstBase.ByteReader
	dup_string_utf16 (Object *out_values) : Boolean Returns a newly-allocated copy of the current data position if there is a NUL-terminated UTF-16 string in the data (this could be an empty string as well), and advances the current position. Returns a newly-allocated copy of the current data position if there is a NUL-terminated UTF-16 string in the data (this could be an empty string as well), and advances the current position. No input checking for valid UTF-16 is done. This function is endianness agnostic - you should not assume the UTF-16 characters are in host endianness. This function will fail if no NUL-terminator was found in in the data. byte alignment of the UTF-16 string. Parameters: Object out_values* Number str Returns: Boolean string put into str must be freed with g_free() when no longer needed.	GstBase.ByteReader
	dup_string_utf32 (Object *out_values) : Boolean Returns a newly-allocated copy of the current data position if there is a NUL-terminated UTF-32 string in the data (this could be an empty string as well), and advances the current position. Returns a newly-allocated copy of the current data position if there is a NUL-terminated UTF-32 string in the data (this could be an empty string as well), and advances the current position. No input checking for valid UTF-32 is done. This function is endianness agnostic - you should not assume the UTF-32 characters are in host endianness. This function will fail if no NUL-terminator was found in in the data. byte alignment of the UTF-32 string. Parameters: Object out_values* Number str Returns: Boolean string put into str must be freed with g_free() when no longer needed.	GstBase.ByteReader
	dup_string_utf8 (Array *str) : Boolean FIXME:Reads (copies) a NUL-terminated string in the GstByteReader* instance, advancing the current position to the byte after the string. FIXME:Reads (copies) a NUL-terminated string in the GstByteReader instance, advancing the current position to the byte after the string. This will work for any NUL-terminated string with a character width of 8 bits, so ASCII, UTF-8, ISO-8859-N etc. No input checking for valid UTF-8 is done. This function will fail if no NUL-terminator was found in in the data. Parameters: Array str Required (not null) Returns: Boolean string put into str must be freed with g_free() when no longer needed.	GstBase.ByteReader
	free () : none Frees a GstByteReader instance, which was previously allocated by gst_byte_reader_new() or gst_byte_reader_new_from_buffer(). Frees a GstByteReader instance, which was previously allocated by gst_byte_reader_new() or gst_byte_reader_new_from_buffer(). Returns: none	GstBase.ByteReader
	get_data (Number *size, Object out_values) : Boolean Returns a constant pointer to the current data position if at least size* bytes are left and updates the current position. Returns a constant pointer to the current data position if at least size bytes are left and updates the current position. Parameters: Number size Required (not null) Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_float32_be (Object *out_values) : Boolean Read a 32 bit big endian floating point value into val* and update the current position. Read a 32 bit big endian floating point value into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_float32_le (Object *out_values) : Boolean Read a 32 bit little endian floating point value into val* and update the current position. Read a 32 bit little endian floating point value into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_float64_be (Object *out_values) : Boolean Read a 64 bit big endian floating point value into val* and update the current position. Read a 64 bit big endian floating point value into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_float64_le (Object *out_values) : Boolean Read a 64 bit little endian floating point value into val* and update the current position. Read a 64 bit little endian floating point value into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_int16_be (Object *out_values) : Boolean Read a signed 16 bit big endian integer into val* and update the current position. Read a signed 16 bit big endian integer into val and update the current position. Parameters: Object out_values int16 val Returns: Boolean	GstBase.ByteReader
	get_int16_le (Object *out_values) : Boolean Read a signed 16 bit little endian integer into val* and update the current position. Read a signed 16 bit little endian integer into val and update the current position. Parameters: Object out_values int16 val Returns: Boolean	GstBase.ByteReader
	get_int24_be (Object *out_values) : Boolean Read a signed 24 bit big endian integer into val* and update the current position. Read a signed 24 bit big endian integer into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_int24_le (Object *out_values) : Boolean Read a signed 24 bit little endian integer into val* and update the current position. Read a signed 24 bit little endian integer into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_int32_be (Object *out_values) : Boolean Read a signed 32 bit big endian integer into val* and update the current position. Read a signed 32 bit big endian integer into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_int32_le (Object *out_values) : Boolean Read a signed 32 bit little endian integer into val* and update the current position. Read a signed 32 bit little endian integer into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_int64_be (Object *out_values) : Boolean Read a signed 64 bit big endian integer into val* and update the current position. Read a signed 64 bit big endian integer into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_int64_le (Object *out_values) : Boolean Read a signed 64 bit little endian integer into val* and update the current position. Read a signed 64 bit little endian integer into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_int8 (Object *out_values) : Boolean Read a signed 8 bit integer into val* and update the current position. Read a signed 8 bit integer into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_pos () : Number Returns the current position of a GstByteReader instance in bytes. Returns the current position of a GstByteReader instance in bytes. Returns: Number	GstBase.ByteReader
	get_remaining () : Number Returns the remaining number of bytes of a GstByteReader instance. Returns the remaining number of bytes of a GstByteReader instance. Returns: Number	GstBase.ByteReader
	get_size () : Number Returns the total number of bytes of a GstByteReader instance. Returns the total number of bytes of a GstByteReader instance. Returns: Number	GstBase.ByteReader
	get_string_utf8 (Array *str) : Boolean Returns a constant pointer to the current data position if there is a NUL-terminated string in the data (this could be just a NUL terminator), advancing the current position to the byte after the string. Returns a constant pointer to the current data position if there is a NUL-terminated string in the data (this could be just a NUL terminator), advancing the current position to the byte after the string. This will work for any NUL-terminated string with a character width of 8 bits, so ASCII, UTF-8, ISO-8859-N etc. No input checking for valid UTF-8 is done. This function will fail if no NUL-terminator was found in in the data. Parameters: Array str* Required (not null) Returns: Boolean	GstBase.ByteReader
	get_uint16_be (Object *out_values) : Boolean Read an unsigned 16 bit big endian integer into val* and update the current position. Read an unsigned 16 bit big endian integer into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_uint16_le (Object *out_values) : Boolean Read an unsigned 16 bit little endian integer into val* and update the current position. Read an unsigned 16 bit little endian integer into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_uint24_be (Object *out_values) : Boolean Read an unsigned 24 bit big endian integer into val* and update the current position. Read an unsigned 24 bit big endian integer into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_uint24_le (Object *out_values) : Boolean Read an unsigned 24 bit little endian integer into val* and update the current position. Read an unsigned 24 bit little endian integer into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_uint32_be (Object *out_values) : Boolean Read an unsigned 32 bit big endian integer into val* and update the current position. Read an unsigned 32 bit big endian integer into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_uint32_le (Object *out_values) : Boolean Read an unsigned 32 bit little endian integer into val* and update the current position. Read an unsigned 32 bit little endian integer into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_uint64_be (Object *out_values) : Boolean Read an unsigned 64 bit big endian integer into val* and update the current position. Read an unsigned 64 bit big endian integer into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_uint64_le (Object *out_values) : Boolean Read an unsigned 64 bit little endian integer into val* and update the current position. Read an unsigned 64 bit little endian integer into val and update the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	get_uint8 (String *val) : Boolean Read an unsigned 8 bit integer into val* and update the current position. Read an unsigned 8 bit integer into val and update the current position. Parameters: String val Required (not null) Returns: Boolean	GstBase.ByteReader
	init (String *data, Number size) : none Initializes a GstByteReader* instance to read from data. Initializes a GstByteReader instance to read from data. This function can be called on already initialized instances. Parameters: String data Required (not null) Number size Required (not null) Returns: none	GstBase.ByteReader
	init_from_buffer (Buffer *buffer) : none Initializes a GstByteReader* instance to read from buffer. Initializes a GstByteReader instance to read from buffer. This function can be called on already initialized instances. Parameters: Gst.Buffer buffer Required (not null) Returns: none	GstBase.ByteReader
	masked_scan_uint32 (Number *mask, Number pattern, Number offset, Number size) : Number Scan for pattern pattern* with applied mask mask in the byte reader data, starting from offset offset relative to the current position. Scan for pattern pattern with applied mask mask in the byte reader data, starting from offset offset relative to the current position. The bytes in pattern and mask are interpreted left-to-right, regardless of endianness. All four bytes of the pattern must be present in the byte reader data for it to match, even if the first or last bytes are masked out. It is an error to call this function without making sure that there is enough data (offset+size bytes) in the byte reader. Example: // Assume the reader contains 0x00 0x01 0x02 ... 0xfe 0xff gst_byte_reader_masked_scan_uint32 (reader, 0xffffffff, 0x00010203, 0, 256); // -> returns 0 gst_byte_reader_masked_scan_uint32 (reader, 0xffffffff, 0x00010203, 1, 255); // -> returns -1 gst_byte_reader_masked_scan_uint32 (reader, 0xffffffff, 0x01020304, 1, 255); // -> returns 1 gst_byte_reader_masked_scan_uint32 (reader, 0xffff, 0x0001, 0, 256); // -> returns -1 gst_byte_reader_masked_scan_uint32 (reader, 0xffff, 0x0203, 0, 256); // -> returns 0 gst_byte_reader_masked_scan_uint32 (reader, 0xffff0000, 0x02030000, 0, 256); // -> returns 2 gst_byte_reader_masked_scan_uint32 (reader, 0xffff0000, 0x02030000, 0, 4); // -> returns -1 Parameters: Number mask Required (not null) Number pattern Required (not null) Number offset Required (not null) position Number size Required (not null) Returns: Number	GstBase.ByteReader
	peek_data (Number *size, Object out_values) : Boolean Returns a constant pointer to the current data position if at least size* bytes are left and keeps the current position. Returns a constant pointer to the current data position if at least size bytes are left and keeps the current position. Parameters: Number size Required (not null) Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_float32_be (Object *out_values) : Boolean Read a 32 bit big endian floating point value into val* but keep the current position. Read a 32 bit big endian floating point value into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_float32_le (Object *out_values) : Boolean Read a 32 bit little endian floating point value into val* but keep the current position. Read a 32 bit little endian floating point value into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_float64_be (Object *out_values) : Boolean Read a 64 bit big endian floating point value into val* but keep the current position. Read a 64 bit big endian floating point value into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_float64_le (Object *out_values) : Boolean Read a 64 bit little endian floating point value into val* but keep the current position. Read a 64 bit little endian floating point value into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_int16_be (Object *out_values) : Boolean Read a signed 16 bit big endian integer into val* but keep the current position. Read a signed 16 bit big endian integer into val but keep the current position. Parameters: Object out_values int16 val Returns: Boolean	GstBase.ByteReader
	peek_int16_le (Object *out_values) : Boolean Read a signed 16 bit little endian integer into val* but keep the current position. Read a signed 16 bit little endian integer into val but keep the current position. Parameters: Object out_values int16 val Returns: Boolean	GstBase.ByteReader
	peek_int24_be (Object *out_values) : Boolean Read a signed 24 bit big endian integer into val* but keep the current position. Read a signed 24 bit big endian integer into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_int24_le (Object *out_values) : Boolean Read a signed 24 bit little endian integer into val* but keep the current position. Read a signed 24 bit little endian integer into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_int32_be (Object *out_values) : Boolean Read a signed 32 bit big endian integer into val* but keep the current position. Read a signed 32 bit big endian integer into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_int32_le (Object *out_values) : Boolean Read a signed 32 bit little endian integer into val* but keep the current position. Read a signed 32 bit little endian integer into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_int64_be (Object *out_values) : Boolean Read a signed 64 bit big endian integer into val* but keep the current position. Read a signed 64 bit big endian integer into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_int64_le (Object *out_values) : Boolean Read a signed 64 bit little endian integer into val* but keep the current position. Read a signed 64 bit little endian integer into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_int8 (Object *out_values) : Boolean Read a signed 8 bit integer into val* but keep the current position. Read a signed 8 bit integer into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_string_utf8 (Array *str) : Boolean Returns a constant pointer to the current data position if there is a NUL-terminated string in the data (this could be just a NUL terminator). Returns a constant pointer to the current data position if there is a NUL-terminated string in the data (this could be just a NUL terminator). The current position will be maintained. This will work for any NUL-terminated string with a character width of 8 bits, so ASCII, UTF-8, ISO-8859-N etc. No input checking for valid UTF-8 is done. This function will fail if no NUL-terminator was found in in the data. Parameters: Array str* Required (not null) Returns: Boolean	GstBase.ByteReader
	peek_uint16_be (Object *out_values) : Boolean Read a signed 16 bit big endian integer into val* but keep the current position. Read a signed 16 bit big endian integer into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_uint16_le (Object *out_values) : Boolean Read a signed 16 bit little endian integer into val* but keep the current position. Read a signed 16 bit little endian integer into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_uint24_be (Object *out_values) : Boolean Read a signed 24 bit big endian integer into val* but keep the current position. Read a signed 24 bit big endian integer into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_uint24_le (Object *out_values) : Boolean Read a signed 24 bit little endian integer into val* but keep the current position. Read a signed 24 bit little endian integer into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_uint32_be (Object *out_values) : Boolean Read a signed 32 bit big endian integer into val* but keep the current position. Read a signed 32 bit big endian integer into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_uint32_le (Object *out_values) : Boolean Read a signed 32 bit little endian integer into val* but keep the current position. Read a signed 32 bit little endian integer into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_uint64_be (Object *out_values) : Boolean Read a signed 64 bit big endian integer into val* but keep the current position. Read a signed 64 bit big endian integer into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_uint64_le (Object *out_values) : Boolean Read a signed 64 bit little endian integer into val* but keep the current position. Read a signed 64 bit little endian integer into val but keep the current position. Parameters: Object out_values Number val Returns: Boolean	GstBase.ByteReader
	peek_uint8 (String *val) : Boolean Read a signed 8 bit integer into val* but keep the current position. Read a signed 8 bit integer into val but keep the current position. Parameters: String val Required (not null) Returns: Boolean	GstBase.ByteReader
	set_pos (Number *pos) : Boolean Sets the new position of a GstByteReader* instance to pos in bytes. Sets the new position of a GstByteReader instance to pos in bytes. otherwise. Parameters: Number pos Required (not null) Returns: Boolean	GstBase.ByteReader
	skip (Number *nbytes) : Boolean Skips nbytes* bytes of the GstByteReader instance. Skips nbytes bytes of the GstByteReader instance. Parameters: Number nbytes Required (not null) Returns: Boolean	GstBase.ByteReader
	skip_string_utf16 () : Boolean Skips a NUL-terminated UTF-16 string in the GstByteReader instance, advancing the current position to the byte after the string. Skips a NUL-terminated UTF-16 string in the GstByteReader instance, advancing the current position to the byte after the string. No input checking for valid UTF-16 is done. This function will fail if no NUL-terminator was found in in the data. Returns: Boolean	GstBase.ByteReader
	skip_string_utf32 () : Boolean Skips a NUL-terminated UTF-32 string in the GstByteReader instance, advancing the current position to the byte after the string. Skips a NUL-terminated UTF-32 string in the GstByteReader instance, advancing the current position to the byte after the string. No input checking for valid UTF-32 is done. This function will fail if no NUL-terminator was found in in the data. Returns: Boolean	GstBase.ByteReader
	skip_string_utf8 () : Boolean Skips a NUL-terminated string in the GstByteReader instance, advancing the current position to the byte after the string. Skips a NUL-terminated string in the GstByteReader instance, advancing the current position to the byte after the string. This will work for any NUL-terminated string with a character width of 8 bits, so ASCII, UTF-8, ISO-8859-N etc. No input checking for valid UTF-8 is done. This function will fail if no NUL-terminator was found in in the data. Returns: Boolean	GstBase.ByteReader

Events
None

Un-official Seed Documentation

GstBase

Classes

Interfaces

Structs

Unions

Enums

Struct GstBase.ByteReader