GstAudioRingBuffer

GstAudio.AudioRingBuffer

GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──GstAudio.AudioRingBuffer

GstAudio.AudioRingBuffer.prototype.acquire

function GstAudio.AudioRingBuffer.prototype.acquire(spec: GstAudio.AudioRingBufferSpec): {
    // javascript wrapper for 'gst_audio_ring_buffer_acquire'
}

Allocate the resources for the ringbuffer. This function fills in the data pointer of the ring buffer with a valid Gst.Buffer to which samples can be written.

GstAudio.AudioRingBuffer.prototype.activate

function GstAudio.AudioRingBuffer.prototype.activate(active: Number): {
    // javascript wrapper for 'gst_audio_ring_buffer_activate'
}

Activate buf to start or stop pulling data.

MT safe.

GstAudio.AudioRingBuffer.prototype.advance

function GstAudio.AudioRingBuffer.prototype.advance(advance: Number): {
    // javascript wrapper for 'gst_audio_ring_buffer_advance'
}

Subclasses should call this function to notify the fact that advance segments are now processed by the device.

MT safe.

GstAudio.AudioRingBuffer.prototype.clear

function GstAudio.AudioRingBuffer.prototype.clear(segment: Number): {
    // javascript wrapper for 'gst_audio_ring_buffer_clear'
}

Clear the given segment of the buffer with silence samples. This function is used by subclasses.

MT safe.

GstAudio.AudioRingBuffer.prototype.clear_all

function GstAudio.AudioRingBuffer.prototype.clear_all(): {
    // javascript wrapper for 'gst_audio_ring_buffer_clear_all'
}

Clear all samples from the ringbuffer.

MT safe.

GstAudio.AudioRingBuffer.prototype.close_device

function GstAudio.AudioRingBuffer.prototype.close_device(): {
    // javascript wrapper for 'gst_audio_ring_buffer_close_device'
}

Close the audio device associated with the ring buffer. The ring buffer should already have been released via GstAudio.AudioRingBuffer.prototype.release.

GstAudio.AudioRingBuffer.prototype.commit

function GstAudio.AudioRingBuffer.prototype.commit(sample: Number, data: [ Number ], in_samples: Number, out_samples: Number, accum: Number): {
    // javascript wrapper for 'gst_audio_ring_buffer_commit'
}

Commit in_samples samples pointed to by data to the ringbuffer buf.

in_samples and out_samples define the rate conversion to perform on the samples in data. For negative rates, out_samples must be negative and in_samples positive.

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 sample in reverse order.

out_samples does not need to be a multiple of the segment size of the ringbuffer although it is recommended for optimal performance.

accum will hold a temporary accumulator used in rate conversion and should be 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 accum value back to this function.

MT safe.

GstAudio.AudioRingBuffer.prototype.convert

function GstAudio.AudioRingBuffer.prototype.convert(src_fmt: Gst.Format, src_val: Number, dest_fmt: Gst.Format): {
    // javascript wrapper for 'gst_audio_ring_buffer_convert'
}

Convert src_val in src_fmt to the equivalent value in dest_fmt. The result will be put in dest_val.

GstAudio.AudioRingBuffer.prototype.delay

function GstAudio.AudioRingBuffer.prototype.delay(): {
    // javascript wrapper for 'gst_audio_ring_buffer_delay'
}

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 transferred 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 transferred to the ringbuffer.

GstAudio.AudioRingBuffer.prototype.device_is_open

function GstAudio.AudioRingBuffer.prototype.device_is_open(): {
    // javascript wrapper for 'gst_audio_ring_buffer_device_is_open'
}

Checks the status of the device associated with the ring buffer.

GstAudio.AudioRingBuffer.prototype.get_segbase

function GstAudio.AudioRingBuffer.prototype.get_segbase(): {
    // javascript wrapper for 'gst_audio_ring_buffer_get_segbase'
}

Gets the current segment base number of the ringbuffer.

MT safe.

Since : 1.26

GstAudio.AudioRingBuffer.prototype.get_segdone

function GstAudio.AudioRingBuffer.prototype.get_segdone(): {
    // javascript wrapper for 'gst_audio_ring_buffer_get_segdone'
}

Gets the current segment number of the ringbuffer.

MT safe.

Since : 1.26

GstAudio.AudioRingBuffer.prototype.is_acquired

function GstAudio.AudioRingBuffer.prototype.is_acquired(): {
    // javascript wrapper for 'gst_audio_ring_buffer_is_acquired'
}

Check if the ringbuffer is acquired and ready to use.

GstAudio.AudioRingBuffer.prototype.is_active

function GstAudio.AudioRingBuffer.prototype.is_active(): {
    // javascript wrapper for 'gst_audio_ring_buffer_is_active'
}

Check if buf is activated.

MT safe.

GstAudio.AudioRingBuffer.prototype.is_flushing

function GstAudio.AudioRingBuffer.prototype.is_flushing(): {
    // javascript wrapper for 'gst_audio_ring_buffer_is_flushing'
}

Check if buf is flushing.

MT safe.

GstAudio.AudioRingBuffer.prototype.may_start

function GstAudio.AudioRingBuffer.prototype.may_start(allowed: Number): {
    // javascript wrapper for 'gst_audio_ring_buffer_may_start'
}

Tell the ringbuffer that it is allowed to start playback when the ringbuffer is filled with samples.

MT safe.

GstAudio.AudioRingBuffer.prototype.open_device

function GstAudio.AudioRingBuffer.prototype.open_device(): {
    // javascript wrapper for 'gst_audio_ring_buffer_open_device'
}

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.

GstAudio.AudioRingBuffer.prototype.pause

function GstAudio.AudioRingBuffer.prototype.pause(): {
    // javascript wrapper for 'gst_audio_ring_buffer_pause'
}

Pause processing samples from the ringbuffer.

GstAudio.AudioRingBuffer.prototype.prepare_read

function GstAudio.AudioRingBuffer.prototype.prepare_read(): {
    // javascript wrapper for 'gst_audio_ring_buffer_prepare_read'
}

Returns a pointer to memory where the data from segment segment can be found. This function is mostly used by subclasses.

GstAudio.AudioRingBuffer.prototype.read

function GstAudio.AudioRingBuffer.prototype.read(sample: Number, data: [ Number ], len: Number): {
    // javascript wrapper for 'gst_audio_ring_buffer_read'
}

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.

len should not be a multiple of the segment size of the ringbuffer although it is recommended.

timestamp will return the timestamp associated with the data returned.

GstAudio.AudioRingBuffer.prototype.release

function GstAudio.AudioRingBuffer.prototype.release(): {
    // javascript wrapper for 'gst_audio_ring_buffer_release'
}

Free the resources of the ringbuffer.

GstAudio.AudioRingBuffer.prototype.samples_done

function GstAudio.AudioRingBuffer.prototype.samples_done(): {
    // javascript wrapper for 'gst_audio_ring_buffer_samples_done'
}

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 GstAudio.AudioRingBuffer.prototype.delay).

GstAudio.AudioRingBuffer.prototype.set_callback_full

function GstAudio.AudioRingBuffer.prototype.set_callback_full(cb: GstAudio.AudioRingBufferCallback, user_data: Object): {
    // javascript wrapper for 'gst_audio_ring_buffer_set_callback_full'
}

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.

Since : 1.12

GstAudio.AudioRingBuffer.prototype.set_channel_positions

function GstAudio.AudioRingBuffer.prototype.set_channel_positions(position: [ GstAudio.AudioChannelPosition ]): {
    // javascript wrapper for 'gst_audio_ring_buffer_set_channel_positions'
}

Tell the ringbuffer about the device's channel positions. This must be called in when the ringbuffer is acquired.

GstAudio.AudioRingBuffer.prototype.set_errored

function GstAudio.AudioRingBuffer.prototype.set_errored(): {
    // javascript wrapper for 'gst_audio_ring_buffer_set_errored'
}

Mark the ringbuffer as errored after it has started.

MT safe.

Since : 1.24

GstAudio.AudioRingBuffer.prototype.set_flushing

function GstAudio.AudioRingBuffer.prototype.set_flushing(flushing: Number): {
    // javascript wrapper for 'gst_audio_ring_buffer_set_flushing'
}

Set the ringbuffer to flushing mode or normal mode.

MT safe.

GstAudio.AudioRingBuffer.prototype.set_sample

function GstAudio.AudioRingBuffer.prototype.set_sample(sample: Number): {
    // javascript wrapper for 'gst_audio_ring_buffer_set_sample'
}

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.

GstAudio.AudioRingBuffer.prototype.set_segdone

function GstAudio.AudioRingBuffer.prototype.set_segdone(segdone: Number): {
    // javascript wrapper for 'gst_audio_ring_buffer_set_segdone'
}

Sets the current segment number of the ringbuffer.

MT safe.

Since : 1.26

GstAudio.AudioRingBuffer.prototype.set_timestamp

function GstAudio.AudioRingBuffer.prototype.set_timestamp(readseg: Number, timestamp: Number): {
    // javascript wrapper for 'gst_audio_ring_buffer_set_timestamp'
}

GstAudio.AudioRingBuffer.prototype.start

function GstAudio.AudioRingBuffer.prototype.start(): {
    // javascript wrapper for 'gst_audio_ring_buffer_start'
}

Start processing samples from the ringbuffer.

GstAudio.AudioRingBuffer.prototype.stop

function GstAudio.AudioRingBuffer.prototype.stop(): {
    // javascript wrapper for 'gst_audio_ring_buffer_stop'
}

Stop processing samples from the ringbuffer.

GstAudio.AudioRingBuffer.prototype.debug_spec_buff

function GstAudio.AudioRingBuffer.prototype.debug_spec_buff(spec: GstAudio.AudioRingBufferSpec): {
    // javascript wrapper for 'gst_audio_ring_buffer_debug_spec_buff'
}

Print debug info about the buffer sized in spec to the debug log.

GstAudio.AudioRingBuffer.prototype.debug_spec_caps

function GstAudio.AudioRingBuffer.prototype.debug_spec_caps(spec: GstAudio.AudioRingBufferSpec): {
    // javascript wrapper for 'gst_audio_ring_buffer_debug_spec_caps'
}

Print debug info about the parsed caps in spec to the debug log.

GstAudio.AudioRingBuffer.prototype.parse_caps

function GstAudio.AudioRingBuffer.prototype.parse_caps(spec: GstAudio.AudioRingBufferSpec, caps: Gst.Caps): {
    // javascript wrapper for 'gst_audio_ring_buffer_parse_caps'
}

Parse caps into spec.

vfunc_acquire

function vfunc_acquire(buf: GstAudio.AudioRingBuffer, spec: GstAudio.AudioRingBufferSpec): {
    // javascript implementation of the 'acquire' virtual method
}

allocate the resources for the ringbuffer using the given spec

vfunc_activate

function vfunc_activate(buf: GstAudio.AudioRingBuffer, active: Number): {
    // javascript implementation of the 'activate' virtual method
}

activate the thread that starts pulling and monitoring the consumed segments in the device.

vfunc_clear_all

function vfunc_clear_all(buf: GstAudio.AudioRingBuffer): {
    // javascript implementation of the 'clear_all' virtual method
}

Optional. Clear the entire ringbuffer. Subclasses should chain up to the parent implementation to invoke the default handler.

vfunc_close_device

function vfunc_close_device(buf: GstAudio.AudioRingBuffer): {
    // javascript implementation of the 'close_device' virtual method
}

close the device

vfunc_commit

function vfunc_commit(buf: GstAudio.AudioRingBuffer, sample: Number, data: [ Number ], in_samples: Number, out_samples: Number, accum: Number): {
    // javascript implementation of the 'commit' virtual method
}

write samples into the ringbuffer

vfunc_delay

function vfunc_delay(buf: GstAudio.AudioRingBuffer): {
    // javascript implementation of the 'delay' virtual method
}

get number of frames queued in device

vfunc_open_device

function vfunc_open_device(buf: GstAudio.AudioRingBuffer): {
    // javascript implementation of the 'open_device' virtual method
}

open the device, don't set any params or allocate anything

vfunc_pause

function vfunc_pause(buf: GstAudio.AudioRingBuffer): {
    // javascript implementation of the 'pause' virtual method
}

pause processing of samples

vfunc_release

function vfunc_release(buf: GstAudio.AudioRingBuffer): {
    // javascript implementation of the 'release' virtual method
}

free resources of the ringbuffer

vfunc_resume

function vfunc_resume(buf: GstAudio.AudioRingBuffer): {
    // javascript implementation of the 'resume' virtual method
}

resume processing of samples after pause

vfunc_start

function vfunc_start(buf: GstAudio.AudioRingBuffer): {
    // javascript implementation of the 'start' virtual method
}

start processing of samples

vfunc_stop

function vfunc_stop(buf: GstAudio.AudioRingBuffer): {
    // javascript implementation of the 'stop' virtual method
}

stop processing of samples

GstAudio.AudioRingBufferSpec

GstAudio.AudioRingBufferFormatType

The format of the samples in the ringbuffer.

GstAudio.AudioRingBufferState

The state of the ringbuffer.

GstAudio.AudioRingBufferCallback

function GstAudio.AudioRingBufferCallback(rbuf: GstAudio.AudioRingBuffer, data: [ Number ], len: Number, user_data: Object): {
    // javascript wrapper for 'GstAudioRingBufferCallback'
}

This function is set with gst_audio_ring_buffer_set_callback (not introspectable) and is called to fill the memory at data with len bytes of samples.