GstAudio-1.0 ▶ GstAudio ▶ AudioBufferSince 1.16

constructor

• new AudioBuffer(): AudioBuffer

  Returns AudioBuffer

n_planes

n_samples

planes

Static$gtype

unmap

• unmap(): void

  Unmaps an audio buffer that was previously mapped with gst_audio_buffer_map().

  Returns void

Staticclip

• clip(
      buffer: Gst.Buffer,
      segment: Segment,
      rate: number,
      bpf: number,
  ): Gst.Buffer

  Clip the buffer to the given %GstSegment.

  After calling this function the caller does not own a reference to buffer anymore.

  Parameters

  • buffer: Gst.Buffer

    The buffer to clip.

  • segment: Segment

    Segment in Gst.Format.TIME or Gst.Format.DEFAULT to which the buffer should be clipped.

  • rate: number

    sample rate.

  • bpf: number

    size of one audio frame in bytes. This is the size of one sample * number of channels.

  Returns Gst.Buffer

Staticmap

• map(
      info: AudioInfo,
      gstbuffer: Gst.Buffer,
      flags: Gst.MapFlags,
  ): [boolean, AudioBuffer]

  Maps an audio gstbuffer so that it can be read or written and stores the result of the map operation in buffer.

  This is especially useful when the gstbuffer is in non-interleaved (planar) layout, in which case this function will use the information in the gstbuffer's attached GstAudio.AudioMeta in order to map each channel in a separate "plane" in GstAudio.AudioBuffer. If a GstAudio.AudioMeta is not attached on the gstbuffer, then it must be in interleaved layout.

  If a GstAudio.AudioMeta is attached, then the GstAudio.AudioInfo on the meta is checked against info. Normally, they should be equal, but in case they are not, a g_critical will be printed and the GstAudio.AudioInfo from the meta will be used.

  In non-interleaved buffers, it is possible to have each channel on a separate Gst.Memory. In this case, each memory will be mapped separately to avoid copying their contents in a larger memory area. Do note though that it is not supported to have a single channel spanning over two or more different Gst.Memory objects. Although the map operation will likely succeed in this case, it will be highly sub-optimal and it is recommended to merge all the memories in the buffer before calling this function.

  Note: The actual Gst.Buffer is not ref'ed, but it is required to stay valid as long as it's mapped.

  Parameters

  • info: AudioInfo

    the audio properties of the buffer

  • gstbuffer: Gst.Buffer

    the Gst.Buffer to be mapped

  • flags: Gst.MapFlags

    the access mode for the memory

  Returns [boolean, AudioBuffer]

Staticreorder_channels

• reorder_channels(
      buffer: Gst.Buffer,
      format: GstAudio.AudioFormat,
      from: GstAudio.AudioChannelPosition[],
      to: GstAudio.AudioChannelPosition[],
  ): boolean

  Reorders buffer from the channel positions from to the channel positions to. from and to must contain the same number of positions and the same positions, only in a different order. buffer must be writable.

  Parameters

  • buffer: Gst.Buffer

    The buffer to reorder.

  • format: GstAudio.AudioFormat

    The %GstAudioFormat of the buffer.

  • from: GstAudio.AudioChannelPosition[]

    The channel positions in the buffer.

  • to: GstAudio.AudioChannelPosition[]

    The channel positions to convert to.

  Returns boolean

Statictruncate

• truncate(
      buffer: Gst.Buffer,
      bpf: number,
      trim: number,
      samples: number,
  ): Gst.Buffer

  Truncate the buffer to finally have samples number of samples, removing the necessary amount of samples from the end and trim number of samples from the beginning.

  This function does not know the audio rate, therefore the caller is responsible for re-setting the correct timestamp and duration to the buffer. However, timestamp will be preserved if trim == 0, and duration will also be preserved if there is no trimming to be done. Offset and offset end will be preserved / updated.

  After calling this function the caller does not own a reference to buffer anymore.

  Parameters

  • buffer: Gst.Buffer

    The buffer to truncate.

  • bpf: number

    size of one audio frame in bytes. This is the size of one sample * number of channels.

  • trim: number

    the number of samples to remove from the beginning of the buffer

  • samples: number

    the final number of samples that should exist in this buffer or -1 to use all the remaining samples if you are only removing samples from the beginning.

  Returns Gst.Buffer