Back to Seed Clases

GstAudio

Classes

Interfaces

Structs

Unions

Enums

GObject.Object
parent-child marker Gst.Object
GstAudio.RingBuffer

Class GstAudio.RingBuffer

Import line:	GstAudio = imports.gi.GstAudio;
GIR File:	GstAudio-0.10.gir
C documentation:	GstRingBuffer
Class :	RingBuffer
Extends:	Gst.Object
	Show / Hide Inherited methods, properties and signals

The ringbuffer base class structure.

Properties
Properties		Defined By
	_gst_reserved : void* read only	Gst.Object
	acquired : Boolean read only	GstAudio.RingBuffer
	callback : [object Object] read only	GstAudio.RingBuffer
	cb_data : void* read only	GstAudio.RingBuffer
	cond : GLib.Cond read only	GstAudio.RingBuffer
	data : Gst.Buffer read only	GstAudio.RingBuffer
	empty_seg : void* read only	GstAudio.RingBuffer
	flags : Number read only	Gst.Object
	lock : GLib.Mutex read only	Gst.Object
	name : String	Gst.Object
	name_prefix : String read only	Gst.Object
	object : Gst.Object read only	GstAudio.RingBuffer
	open : Boolean read only	GstAudio.RingBuffer
	parent : Gst.Object read only	Gst.Object
	refcount : Number read only	Gst.Object
	samples_per_seg : Number read only	GstAudio.RingBuffer
	segbase : Number read only	GstAudio.RingBuffer
	segdone : Number read only	GstAudio.RingBuffer
	segstate : GstAudio.RingBufferSegState read only	GstAudio.RingBuffer
	spec : GstAudio.RingBufferSpec read only	GstAudio.RingBuffer
	state : Number read only	GstAudio.RingBuffer
	waiting : Number read only	GstAudio.RingBuffer

Methods / Constructors
Method / Constructor		Defined By
	new GstAudio.RingBuffer (Object *properties) Create a new GstAudio.RingBuffer Create a new GstAudio.RingBuffer Parameters: Object properties*
	GstAudio.RingBuffer.debug_spec_buff (RingBufferSpec *spec) : none Print debug info about the buffer sized in spec* to the debug log. Print debug info about the buffer sized in spec to the debug log. Parameters: GstAudio.RingBufferSpec spec Required (not null) Returns: none	GstAudio.RingBuffer
	GstAudio.RingBuffer.debug_spec_caps (RingBufferSpec *spec) : none Print debug info about the parsed caps in spec* to the debug log. Print debug info about the parsed caps in spec to the debug log. Parameters: GstAudio.RingBufferSpec spec Required (not null) Returns: none	GstAudio.RingBuffer
	GstAudio.RingBuffer.parse_caps (RingBufferSpec *spec, Caps caps) : Boolean Parse caps* into spec. Parse caps into spec. Parameters: GstAudio.RingBufferSpec spec Required (not null) Gst.Caps caps Required (not null) Returns: Boolean	GstAudio.RingBuffer
	acquire (RingBufferSpec *spec) : Boolean Allocate the resources for the ringbuffer. Allocate the resources for the ringbuffer. This function fills in the data pointer of the ring buffer with a valid GstBuffer* to which samples can be written. MT safe. Parameters: GstAudio.RingBufferSpec spec Required (not null) Returns: Boolean	GstAudio.RingBuffer
	activate (Boolean *active) : Boolean Activate buf* to start or stop pulling data. Activate buf to start or stop pulling data. MT safe. FALSE on error. Parameters: Boolean active Required (not null) Returns: Boolean	GstAudio.RingBuffer
	advance (Number *advance) : none Subclasses should call this function to notify the fact that MT safe. Subclasses should call this function to notify the fact that MT safe. Parameters: Number advance* Required (not null) Returns: none	GstAudio.RingBuffer
	clear (Number *segment) : none Clear the given segment of the buffer with silence samples. Clear the given segment of the buffer with silence samples. This function is used by subclasses. MT safe. Parameters: Number segment* Required (not null) Returns: none	GstAudio.RingBuffer
	clear_all () : none Fill the ringbuffer with silence. Fill the ringbuffer with silence. MT safe. Returns: none	GstAudio.RingBuffer
	close_device () : Boolean Close the audio device associated with the ring buffer. Close the audio device associated with the ring buffer. The ring buffer should already have been released via gst_ring_buffer_release(). MT safe. Returns: Boolean	GstAudio.RingBuffer
	commit (Number *sample, String data, Number len) : Number Same as gst_ring_buffer_commit_full() but with a in_samples and out_samples equal to len, ignoring accum. Same as gst_ring_buffer_commit_full() but with a in_samples and out_samples equal to len, ignoring accum. error. MT safe. Parameters: Number sample* Required (not null) String data Required (not null) Number len Required (not null) Returns: Number	GstAudio.RingBuffer
	commit_full (Object *out_values, String data, Number in_samples, Number out_samples) : Number Commit in_samples* samples pointed to by data to the ringbuffer buf. Commit in_samples samples pointed to by data to the ringbuffer buf. samples in data. For negative rates, out_samples must be negative and When out_samples is positive, the first sample will be written at position sample in the ringbuffer. When out_samples is negative, the last sample will be written to although it is recommended for optimal performance. set to 0 when this function is first called. In case the commit operation is interrupted, one can resume the processing by passing the previously returned MT safe. number of samples written can be less than out_samples when buf was interrupted with a flush or stop. Parameters: Object out_values Number sample Number accum String data Required (not null) Number in_samples Required (not null) Number out_samples Required (not null) Returns: Number	GstAudio.RingBuffer
	convert (Format *src_fmt, Number src_val, Format dest_fmt, Object out_values) : Boolean Convert src_val* in src_fmt to the equivalent value in dest_fmt. Convert src_val in src_fmt to the equivalent value in dest_fmt. The result will be put in dest_val. Parameters: Gst.Format src_fmt Required (not null) Number src_val Required (not null) Gst.Format dest_fmt Required (not null) Object out_values Number dest_val Returns: Boolean	GstAudio.RingBuffer
	default_error (Object *error, String debug) : none A default error function. A default error function. The default handler will simply print the error string using g_print. Parameters: Object error* Required (not null) String debug Required (not null) Returns: none	Gst.Object
	delay () : Number Get the number of samples queued in the audio device. Get the number of samples queued in the audio device. This is usually less than the segment size but can be bigger when the implementation uses another internal buffer between the audio device. For playback ringbuffers this is the amount of samples transfered from the ringbuffer to the device but still not played. For capture ringbuffers this is the amount of samples in the device that are not yet transfered to the ringbuffer. MT safe. Returns: Number	GstAudio.RingBuffer
	device_is_open () : Boolean Checks the status of the device associated with the ring buffer. Checks the status of the device associated with the ring buffer. MT safe. Returns: Boolean	GstAudio.RingBuffer
	get_name () : String Returns a copy of the name of object. Returns a copy of the name of object. Caller should g_free() the return value after usage. For a nameless object, this returns NULL, which you can safely g_free() as well. MT safe. This function grabs and releases object's LOCK. Returns: String after usage.	Gst.Object
	get_name_prefix () : String Returns a copy of the name prefix of object. Returns a copy of the name prefix of object. Caller should g_free() the return value after usage. For a prefixless object, this returns NULL, which you can safely g_free() as well. MT safe. This function grabs and releases object's LOCK. Returns: String after usage.	Gst.Object
	get_parent () : Gst.Object Returns the parent of object. Returns the parent of object. This function increases the refcount of the parent object so you should gst_object_unref() it after usage. MT safe. Grabs and releases object's LOCK. Returns: Gst.Object parent. unref after usage.	Gst.Object
	get_path_string () : String Generates a string describing the path of object in the object hierarchy. Generates a string describing the path of object in the object hierarchy. Only useful (or used) for debugging. MT safe. Grabs and releases the GstObject's LOCK for all objects in the hierarchy. Returns: String g_free() the string after usage.	Gst.Object
	has_ancestor (Object *ancestor) : Boolean Check if object* has an ancestor ancestor somewhere up in the hierarchy. Check if object has an ancestor ancestor somewhere up in the hierarchy. MT safe. Grabs and releases object's locks. Parameters: Gst.Object ancestor Required (not null) Returns: Boolean	Gst.Object
	is_acquired () : Boolean Check if the ringbuffer is acquired and ready to use. Check if the ringbuffer is acquired and ready to use. MT safe. Returns: Boolean	GstAudio.RingBuffer
	is_active () : Boolean Check if buf is activated. Check if buf is activated. MT safe. Returns: Boolean	GstAudio.RingBuffer
	may_start (Boolean *allowed) : none Tell the ringbuffer that it is allowed to start playback when the ringbuffer is filled with samples. Tell the ringbuffer that it is allowed to start playback when the ringbuffer is filled with samples. MT safe. Parameters: Boolean allowed* Required (not null) Returns: none	GstAudio.RingBuffer
	open_device () : Boolean Open the audio device associated with the ring buffer. Open the audio device associated with the ring buffer. Does not perform any setup on the device. You must open the device before acquiring the ring buffer. MT safe. Returns: Boolean	GstAudio.RingBuffer
	pause () : Boolean Pause processing samples from the ringbuffer. Pause processing samples from the ringbuffer. MT safe. Returns: Boolean	GstAudio.RingBuffer
	prepare_read (Object *out_values) : Boolean Returns a pointer to memory where the data from segment segment* can be found. Returns a pointer to memory where the data from segment segment can be found. This function is mostly used by subclasses. MT safe. Parameters: Object out_values Number segment Number readptr Number len Returns: Boolean	GstAudio.RingBuffer
	read (Number *sample, String data, Number len) : Number Read len* samples from the ringbuffer into the memory pointed to by data. Read len samples from the ringbuffer into the memory pointed to by data. The first sample should be read from position sample in the ringbuffer. although it is recommended. error. MT safe. Parameters: Number sample Required (not null) String data Required (not null) Number len Required (not null) Returns: Number	GstAudio.RingBuffer
	release () : Boolean Free the resources of the ringbuffer. Free the resources of the ringbuffer. MT safe. Returns: Boolean	GstAudio.RingBuffer
	replace (Object *newobj) : none Unrefs the GstObject* pointed to by oldobj, refs newobj and puts newobj in *oldobj. Unrefs the GstObject pointed to by oldobj, refs newobj and puts newobj in *oldobj. Be carefull when calling this function, it does not take any locks. You might want to lock the object owning oldobj pointer before calling this function. Make sure not to LOCK oldobj because it might be unreffed which could cause a deadlock when it is disposed. Parameters: Gst.Object newobj Required (not null) Returns: none	Gst.Object
	restore_thyself (Node *self) : none Restores object* with the data from the parent XML node. Restores object with the data from the parent XML node. Parameters: libxml2.Node self Required (not null) Returns: none	Gst.Object
	samples_done () : Number Get the number of samples that were processed by the ringbuffer since it was last started. Get the number of samples that were processed by the ringbuffer since it was last started. This does not include the number of samples not yet processed (see gst_ring_buffer_delay()). MT safe. Returns: Number	GstAudio.RingBuffer
	save_thyself (Node *parent) : libxml2.Node Saves object* into the parent XML node. Saves object into the parent XML node. Parameters: libxml2.Node parent Required (not null) Returns: libxml2.Node	Gst.Object
	set_callback (Function cb, void* *user_data) : none Sets the given callback function on the buffer. Sets the given callback function on the buffer. This function will be called every time a segment has been written to a device. MT safe. Parameters: Function (RingBuffer rbuf, String data, Number len, void *user_data) : none Required (not null) void user_data Required (not null) Returns: none	GstAudio.RingBuffer
	set_flushing (Boolean *flushing) : none Set the ringbuffer to flushing mode or normal mode. Set the ringbuffer to flushing mode or normal mode. MT safe. Parameters: Boolean flushing* Required (not null) Returns: none	GstAudio.RingBuffer
	set_name (String *name) : Boolean Sets the name of object, or gives object* a guaranteed unique name (if name is NULL). Sets the name of object, or gives object a guaranteed unique name (if name is NULL). This function makes a copy of the provided name, so the caller retains ownership of the name it sent. a parent cannot be renamed, this function returns FALSE in those cases. MT safe. This function grabs and releases object's LOCK. Parameters: String name Required (not null) Returns: Boolean	Gst.Object
	set_name_prefix (String *name_prefix) : none Sets the name prefix of object* to name_prefix. Sets the name prefix of object to name_prefix. This function makes a copy of the provided name prefix, so the caller retains ownership of the name prefix it sent. MT safe. This function grabs and releases object's LOCK. Parameters: String name_prefix Required (not null) Returns: none	Gst.Object
	set_parent (Object *parent) : Boolean Sets the parent of object* to parent. Sets the parent of object to parent. The object's reference count will be incremented, and any floating reference will be removed (see gst_object_sink()). This function causes the parent-set signal to be emitted when the parent was successfully set. already had a parent or object and parent are the same. MT safe. Grabs and releases object's LOCK. Parameters: Gst.Object parent Required (not null) Returns: Boolean	Gst.Object
	set_sample (Number *sample) : none Make sure that the next sample written to the device is accounted for as being the sample* sample written to the device. Make sure that the next sample written to the device is accounted for as being the sample sample written to the device. This value will be used in reporting the current sample position of the ringbuffer. This function will also clear the buffer with silence. MT safe. Parameters: Number sample Required (not null) Returns: none	GstAudio.RingBuffer
	start () : Boolean Start processing samples from the ringbuffer. Start processing samples from the ringbuffer. MT safe. Returns: Boolean	GstAudio.RingBuffer
	stop () : Boolean Stop processing samples from the ringbuffer. Stop processing samples from the ringbuffer. MT safe. Returns: Boolean	GstAudio.RingBuffer
	unparent () : none Clear the parent of object, removing the associated reference. Clear the parent of object, removing the associated reference. This function decreases the refcount of object. MT safe. Grabs and releases object's lock. Returns: none	Gst.Object

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	deep_notify (Object *self, Object prop_object, ParamSpec prop) : none The deep notify signal is used to be notified of property changes. The deep notify signal is used to be notified of property changes. It is typically attached to the toplevel bin to receive notifications from all the elements contained in that bin. Parameters: Gst.Object self* Gst.Object prop_object GObject.ParamSpec prop Returns: {none}	Gst.Object
	object_saved (Object *self, void *xml_node) : none Trigered whenever a new object is saved to XML. Trigered whenever a new object is saved to XML. You can connect to this signal to insert custom XML tags into the core XML. Parameters: Gst.Object self* void* xml_node Returns: {none}	Gst.Object
	parent_set (Object *self, Object parent) : none Emitted when the parent of an object is set. Emitted when the parent of an object is set. Parameters: Gst.Object self* Gst.Object parent Returns: {none}	Gst.Object
	parent_unset (Object *self, Object parent) : none Emitted when the parent of an object is unset. Emitted when the parent of an object is unset. Parameters: Gst.Object self* Gst.Object parent Returns: {none}	Gst.Object

Used by These Methods / Signals / Properties
Class / Namespace	Method / Signal / Properties
GstAudio.BaseAudioSink Method	create_ringbuffer () : GstAudio.RingBuffer Create and return the GstRingBuffer for sink.
GstAudio.BaseAudioSrc Method	create_ringbuffer () : GstAudio.RingBuffer Create and return the GstRingBuffer for src.

Un-official Seed Documentation

GstAudio

Classes

Interfaces

Structs

Unions

Enums

Class GstAudio.RingBuffer