Class (GI Struct)

GstAudio-1.0 ▶ GstAudio ▶ AudioConverterSince 1.8

This object is used to convert audio samples from one format to another. The object can perform conversion of:

  • audio format with optional dithering and noise shaping

  • audio samplerate

  • audio channels and channel layout

1.8

Index
constructor
$gtype
convert free get_config get_in_frames get_max_latency get_out_frames is_passthrough reset supports_inplace update_config new
$gtype: GType<AudioConverter>

  • Convenience wrapper around gst_audio_converter_samples(), which will perform allocation of the output buffer based on the result from gst_audio_converter_get_out_frames().

    Parameters

    Returns [boolean, Uint8Array<ArrayBufferLike>]

    true is the conversion could be performed.

    1.14

  • Calculate how many input frames are currently needed by convert to produce out_frames of output frames.

    Parameters

    • out_frames: number | bigint

      number of output frames

    Returns number

    the number of input frames

  • Get the maximum number of input frames that the converter would need before producing output.

    Returns number

    the latency of convert as expressed in the number of frames.

  • Calculate how many output frames can be produced when in_frames input frames are given to convert.

    Parameters

    • in_frames: number | bigint

      number of input frames

    Returns number

    the number of output frames

  • Returns whether the audio converter will operate in passthrough mode. The return value would be typically input to gst_base_transform_set_passthrough()

    Returns boolean

    true when no conversion will actually occur.

    1.16

  • Reset convert to the state it was when it was first created, clearing any history it might currently have.

    Returns void

  • Returns whether the audio converter can perform the conversion in-place. The return value would be typically input to gst_base_transform_set_in_place()

    Returns boolean

    true when the conversion can be done in place.

    1.12

  • Set in_rate, out_rate and config as extra configuration for convert.

    in_rate and out_rate specify the new sample rates of input and output formats. A value of 0 leaves the sample rate unchanged.

    config can be null, in which case, the current configuration is not changed.

    If the parameters in config can not be set exactly, this function returns false and will try to update as much state as possible. The new state can then be retrieved and refined with gst_audio_converter_get_config().

    Look at the GST_AUDIO_CONVERTER_OPT_* fields to check valid configuration option and values.

    Parameters

    Returns boolean

    true when the new parameters could be set