Class AudioRingBuffer

Namespace

GstAudio

Assembly

GstAudio-1.0.dll

public class AudioRingBuffer : Object, IDisposable, NativeObject, GTypeProvider, InstanceFactory

Inheritance

object

Object

InitiallyUnowned

Object

AudioRingBuffer

Implements

IDisposable

NativeObject

GTypeProvider

InstanceFactory

Inherited Members

Object.CheckUniqueness(List, string)

Object.DefaultDeepNotify(Object, Object, ParamSpec, string[])

Object.RefSink(nint)

Object.AddControlBinding(ControlBinding)

Object.DefaultError(Error, string)

Object.GetControlBinding(string)

Object.GetControlRate()

Object.GetGValueArray(string, ClockTime, ClockTime, Value[])

Object.GetName()

Object.GetParent()

Object.GetPathString()

Object.GetValue(string, ClockTime)

Object.HasActiveControlBindings()

Object.HasAncestor(Object)

Object.HasAsAncestor(Object)

Object.HasAsParent(Object)

Object.Ref()

Object.RemoveControlBinding(ControlBinding)

Object.SetControlBindingDisabled(string, bool)

Object.SetControlBindingsDisabled(bool)

Object.SetControlRate(ClockTime)

Object.SetName(string)

Object.SetParent(Object)

Object.SuggestNextSync()

Object.SyncValues(ClockTime)

Object.Unparent()

Object.Unref()

Object.NamePropertyDefinition

Object.Name

Object.ParentPropertyDefinition

Object.Parent

Object.DeepNotifySignal

Object.OnDeepNotify

Object.Handle

Object.Dispose()

Object.CompatControl(nuint, nint)

Object.InterfaceFindProperty(TypeInterface, string)

Object.InterfaceInstallProperty(TypeInterface, ParamSpec)

Object.AddWeakPointer(ref nint)

Object.BindProperty(string, Object, string, BindingFlags)

Object.BindPropertyFull(string, Object, string, BindingFlags, Closure, Closure)

Object.ForceFloating()

Object.FreezeNotify()

Object.GetData(string)

Object.GetProperty(string, Value)

Object.GetQdata(Quark)

Object.GetValist(string, nint)

Object.Getv(string[], Value[])

Object.IsFloating()

Object.Notify(string)

Object.NotifyByPspec(ParamSpec)

Object.RefSink()

Object.RemoveWeakPointer(ref nint)

Object.RunDispose()

Object.SetData(string, nint)

Object.SetProperty(string, Value)

Object.SetQdata(Quark, nint)

Object.SetValist(string, nint)

Object.Setv(string[], Value[])

Object.StealData(string)

Object.StealQdata(Quark)

Object.TakeRef()

Object.ThawNotify()

Object.WatchClosure(Closure)

Object.NotifySignal

Object.OnNotify

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AudioRingBuffer(params ConstructArgument[])

[Obsolete("Regular C# constructors on native classes will be removed in a future version. Please see the linked documentation for more details. It contains scenarios and possible solutions to prepare for the upcoming changes.", DiagnosticId = "GirCore1007", UrlFormat = "https://gircore.github.io/docs/integration/diagnostic/1007.html")]
public AudioRingBuffer(params ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

AudioRingBuffer(CreationData)

[Obsolete("This constructor is a workaround to keep legacy APIs alive. Do not use it.")]
protected AudioRingBuffer(CreationData data)

Parameters

data CreationData

AudioRingBuffer(AudioRingBufferHandle)

protected AudioRingBuffer(AudioRingBufferHandle handle)

Parameters

handle AudioRingBufferHandle

Methods

Acquire(AudioRingBufferSpec)

public bool Acquire(AudioRingBufferSpec spec)

Parameters

spec AudioRingBufferSpec

Returns

bool

Activate(bool)

public bool Activate(bool active)

Parameters

active bool

Returns

bool

Advance(uint)

public void Advance(uint advance)

Parameters

advance uint

Clear(int)

public void Clear(int segment)

Parameters

segment int

ClearAll()

public void ClearAll()

CloseDevice()

public bool CloseDevice()

Returns

bool

Commit(ref ulong, Span<byte>, int, ref int)

public uint Commit(ref ulong sample, Span<byte> data, int outSamples, ref int accum)

Parameters

sample ulong

data Span<byte>

outSamples int

accum int

Returns

uint

Convert(Format, long, Format, out long)

public bool Convert(Format srcFmt, long srcVal, Format destFmt, out long destVal)

Parameters

srcFmt Format

srcVal long

destFmt Format

destVal long

Returns

bool

DebugSpecBuff(AudioRingBufferSpec)

public static void DebugSpecBuff(AudioRingBufferSpec spec)

Parameters

spec AudioRingBufferSpec

DebugSpecCaps(AudioRingBufferSpec)

public static void DebugSpecCaps(AudioRingBufferSpec spec)

Parameters

spec AudioRingBufferSpec

Delay()

public uint Delay()

Returns

uint

DeviceIsOpen()

public bool DeviceIsOpen()

Returns

bool

GetGType()

public static Type GetGType()

Returns

Type

GetSegbase()

[Version("1.26")]
public ulong GetSegbase()

Returns

ulong

GetSegdone()

[Version("1.26")]
public ulong GetSegdone()

Returns

ulong

IsAcquired()

public bool IsAcquired()

Returns

bool

IsActive()

public bool IsActive()

Returns

bool

IsFlushing()

public bool IsFlushing()

Returns

bool

MayStart(bool)

public void MayStart(bool allowed)

Parameters

allowed bool

NewFromPointer(nint, bool)

Creates a new managed AudioRingBuffer instance for a given pointer.

public static AudioRingBuffer NewFromPointer(nint ptr, bool ownsHandle)

Parameters

ptr nint

ownsHandle bool

Returns

AudioRingBuffer

NewWithProperties(ConstructArgument[])

Creates a new AudioRingBuffer and sets the properties specified by the construct arguments.

public static AudioRingBuffer NewWithProperties(ConstructArgument[] constructArguments)

Parameters

constructArguments ConstructArgument[]

The properties to set.

Returns

AudioRingBuffer

OpenDevice()

public bool OpenDevice()

Returns

bool

ParseCaps(AudioRingBufferSpec, Caps)

public static bool ParseCaps(AudioRingBufferSpec spec, Caps caps)

Parameters

spec AudioRingBufferSpec

caps Caps

Returns

bool

Pause()

public bool Pause()

Returns

bool

Read(ulong, Span<byte>, out ClockTime)

public uint Read(ulong sample, Span<byte> data, out ClockTime timestamp)

Parameters

sample ulong

data Span<byte>

timestamp ClockTime

Returns

uint

Release()

public bool Release()

Returns

bool

SamplesDone()

public ulong SamplesDone()

Returns

ulong

SetCallback(AudioRingBufferCallback?)

[Version("1.12")]
public void SetCallback(AudioRingBufferCallback? cb)

Parameters

cb AudioRingBufferCallback

SetErrored()

[Version("1.24")]
public void SetErrored()

SetFlushing(bool)

public void SetFlushing(bool flushing)

Parameters

flushing bool

SetSample(ulong)

public void SetSample(ulong sample)

Parameters

sample ulong

SetSegdone(ulong)

[Version("1.26")]
public void SetSegdone(ulong segdone)

Parameters

segdone ulong

SetTimestamp(int, ClockTime)

public void SetTimestamp(int readseg, ClockTime timestamp)

Parameters

readseg int

timestamp ClockTime

Start()

public bool Start()

Returns

bool

Stop()

public bool Stop()

Returns

bool