Class AudioRingBufferSpec

java.lang.Object
org.javagi.base.ProxyInstance
org.freedesktop.gstreamer.audio.AudioRingBufferSpec
All Implemented Interfaces:
Proxy
@Generated("org.javagi.JavaGI") public class AudioRingBufferSpec extends ProxyInstance

The structure containing the format specification of the ringbuffer.

When type is GST_AUDIO_RING_BUFFER_FORMAT_TYPE_DSD, the dsdFormat is valid (otherwise it is unused). Also, when DSD is the sample type, only the rate, channels, position, and bpf fields in info are populated.

  • Constructor Details

    • AudioRingBufferSpec

      public AudioRingBufferSpec(MemorySegment address)
      Create a AudioRingBufferSpec proxy instance for the provided memory address.
      Parameters:
      address - the memory address of the native object

    • AudioRingBufferSpec

      public AudioRingBufferSpec(Arena arena)
      Allocate a new AudioRingBufferSpec.
      Parameters:
      arena - to control the memory allocation scope

    • AudioRingBufferSpec

      public AudioRingBufferSpec()
      Allocate a new AudioRingBufferSpec. The memory is allocated with Arena.ofAuto().

    • AudioRingBufferSpec

      public AudioRingBufferSpec(Caps caps, AudioRingBufferFormatType type, AudioInfo info, long latencyTime, long bufferTime, int segsize, int segtotal, int seglatency, Arena arena)
      Allocate a new AudioRingBufferSpec with the fields set to the provided values.
      Parameters:
      caps - value for the field caps
      type - value for the field type
      info - value for the field info
      latencyTime - value for the field latencyTime
      bufferTime - value for the field bufferTime
      segsize - value for the field segsize
      segtotal - value for the field segtotal
      seglatency - value for the field seglatency
      arena - to control the memory allocation scope

    • AudioRingBufferSpec

      public AudioRingBufferSpec(Caps caps, AudioRingBufferFormatType type, AudioInfo info, long latencyTime, long bufferTime, int segsize, int segtotal, int seglatency)
      Allocate a new AudioRingBufferSpec with the fields set to the provided values. The memory is allocated with Arena.ofAuto().
      Parameters:
      caps - value for the field caps
      type - value for the field type
      info - value for the field info
      latencyTime - value for the field latencyTime
      bufferTime - value for the field bufferTime
      segsize - value for the field segsize
      segtotal - value for the field segtotal
      seglatency - value for the field seglatency

  • Method Details

    • getMemoryLayout

      public static MemoryLayout getMemoryLayout()
      The memory layout of the native struct.
      Returns:
      the memory layout

    • readCaps

      public Caps readCaps()
      Read the value of the field caps.
      Returns:
      The value of the field caps

    • writeCaps

      public void writeCaps(Caps caps)
      Write a value in the field caps.
      Parameters:
      caps - The new value for the field caps

    • readType

      public AudioRingBufferFormatType readType()
      Read the value of the field type.
      Returns:
      The value of the field type

    • writeType

      public void writeType(AudioRingBufferFormatType type)
      Write a value in the field type.
      Parameters:
      type - The new value for the field type

    • readInfo

      public @Nullable AudioInfo readInfo()
      Read the value of the field info.
      Returns:
      The value of the field info

    • writeInfo

      public void writeInfo(@Nullable AudioInfo info)
      Write a value in the field info.
      Parameters:
      info - The new value for the field info

    • readLatencyTime

      public long readLatencyTime()
      Read the value of the field latency_time.
      Returns:
      The value of the field latency_time

    • writeLatencyTime

      public void writeLatencyTime(long latencyTime)
      Write a value in the field latency_time.
      Parameters:
      latencyTime - The new value for the field latency_time

    • readBufferTime

      public long readBufferTime()
      Read the value of the field buffer_time.
      Returns:
      The value of the field buffer_time

    • writeBufferTime

      public void writeBufferTime(long bufferTime)
      Write a value in the field buffer_time.
      Parameters:
      bufferTime - The new value for the field buffer_time

    • readSegsize

      public int readSegsize()
      Read the value of the field segsize.
      Returns:
      The value of the field segsize

    • writeSegsize

      public void writeSegsize(int segsize)
      Write a value in the field segsize.
      Parameters:
      segsize - The new value for the field segsize

    • readSegtotal

      public int readSegtotal()
      Read the value of the field segtotal.
      Returns:
      The value of the field segtotal

    • writeSegtotal

      public void writeSegtotal(int segtotal)
      Write a value in the field segtotal.
      Parameters:
      segtotal - The new value for the field segtotal

    • readSeglatency

      public int readSeglatency()
      Read the value of the field seglatency.
      Returns:
      The value of the field seglatency

    • writeSeglatency

      public void writeSeglatency(int seglatency)
      Write a value in the field seglatency.
      Parameters:
      seglatency - The new value for the field seglatency