Class SpeexDSPJitterBuffer

Speexdsp jitter buffer.

Inheritance
object
SpeexDSPJitterBuffer
Implements
Inherited Members
Namespace: SpeexDSPSharp.Core
Assembly: SpeexDSPSharp.Core.dll
Syntax
public class SpeexDSPJitterBuffer : IDisposable

Constructors

| Edit this page View Source

SpeexDSPJitterBuffer(int)

Creates a new speexdsp jitter buffer.

Declaration
public SpeexDSPJitterBuffer(int step_size)
Parameters
Type Name Description
int step_size

Starting value for the size of concealment packets and delay adjustment steps. Can be changed at any time using JITTER_BUFFER_SET_DELAY_STEP and JITTER_BUFFER_GET_CONCEALMENT_SIZE.

Fields

| Edit this page View Source

_handler

Direct safe handle for the SpeexDSPJitterBuffer. IT IS NOT RECOMMENDED TO CLOSE THE HANDLE DIRECTLY! Instead use Dispose(bool) to dispose the handle and object safely.

Declaration
protected readonly SpeexDSPJitterBufferSafeHandler _handler
Field Value
Type Description
SpeexDSPJitterBufferSafeHandler

Methods

| Edit this page View Source

CheckError(int)

Checks if there is an opus error and throws if the error is a negative value.

Declaration
protected static void CheckError(int error)
Parameters
Type Name Description
int error

The error code to input.
Exceptions
Type Condition
SpeexDSPException
| Edit this page View Source

Ctl<T>(JitterBufferCtl, ref T)

Performs a ctl request.

Declaration
public int Ctl<T>(JitterBufferCtl request, ref T value) where T : unmanaged
Parameters
Type Name Description
JitterBufferCtl request

The request you want to specify.
T value

The input/output value.
Returns
Type Description
int

0 if no error, -1 if request is unknown.
Type Parameters
Name Description
T

The type you want to input/output.
| Edit this page View Source

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()
| Edit this page View Source

Dispose(bool)

Dispose logic.

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

Set to true if fully disposing.
| Edit this page View Source

~SpeexDSPJitterBuffer()

Speexdsp jitter buffer destructor.

Declaration
protected ~SpeexDSPJitterBuffer()
| Edit this page View Source

Get(ref SpeexDSPJitterBufferPacket, int, ref int)

Get one packet from the jitter buffer.

Declaration
public JitterBufferState Get(ref SpeexDSPJitterBufferPacket packet, int desired_span, ref int start_offset)
Parameters
Type Name Description
SpeexDSPJitterBufferPacket packet

Returned packet.
int desired_span

Number of samples (or units) we wish to get from the buffer (no guarantee).
int start_offset

Timestamp for the returned packet.
Returns
Type Description
JitterBufferState

JitterBufferState
| Edit this page View Source

GetAnother(ref SpeexDSPJitterBufferPacket)

Used right after jitter_buffer_get() to obtain another packet that would have the same timestamp. This is mainly useful for media where a single "frame" can be split into several packets.

Declaration
public int GetAnother(ref SpeexDSPJitterBufferPacket packet)
Parameters
Type Name Description
SpeexDSPJitterBufferPacket packet

Returned packet.
Returns
Type Description
int

JitterBufferState
| Edit this page View Source

GetPointerTimestamp()

Get pointer timestamp of jitter buffer.

Declaration
public int GetPointerTimestamp()
Returns
Type Description
int

I have no clue what this returns.
| Edit this page View Source

Put(ref SpeexDSPJitterBufferPacket)

Put one packet into the jitter buffer.

Declaration
public void Put(ref SpeexDSPJitterBufferPacket packet)
Parameters
Type Name Description
SpeexDSPJitterBufferPacket packet

Incoming packet.
| Edit this page View Source

RemainingSpan(int)

Telling the jitter buffer about the remaining data in the application buffer.

Declaration
public void RemainingSpan(int remaining_span)
Parameters
Type Name Description
int remaining_span

Amount of data buffered by the application (timestamp units).
| Edit this page View Source

Reset()

Reset the jitter buffer to its original state.

Declaration
public void Reset()
| Edit this page View Source

ThrowIfDisposed()

Throws an exception if this object is disposed or the handler is closed.

Declaration
protected virtual void ThrowIfDisposed()
Exceptions
Type Condition
ObjectDisposedException
| Edit this page View Source

Tick()

Advance by one tick.

Declaration
public void Tick()
| Edit this page View Source

UpdateDelay(ref SpeexDSPJitterBufferPacket, ref int)

N.A.

Declaration
public int UpdateDelay(ref SpeexDSPJitterBufferPacket packet, ref int start_offset)
Parameters
Type Name Description
SpeexDSPJitterBufferPacket packet
int start_offset
Returns
Type Description
int

Implements

IDisposable