GstAudio-1.0 ▶ GstAudio ▶ AudioInfo

constructor

• new AudioInfo(
      properties?: Partial<
          {
              bpf: number;
              channels: number;
              flags: GstAudio.AudioFlags;
              layout: GstAudio.AudioLayout;
              position: GstAudio.AudioChannelPosition[];
              rate: number;
          },
      >,
  ): AudioInfo

  Parameters

  • Optionalproperties: Partial<
        {
            bpf: number;
            channels: number;
            flags: GstAudio.AudioFlags;
            layout: GstAudio.AudioLayout;
            position: GstAudio.AudioChannelPosition[];
            rate: number;
        },
    >

  Returns AudioInfo

bpf

channels

flags

layout

position

rate

Static$gtype

convert

• convert(
      src_fmt: Gst.Format,
      src_val: number,
      dest_fmt: Gst.Format,
  ): [boolean, number]

  Converts among various Gst.Format types. This function handles GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For raw audio, GST_FORMAT_DEFAULT corresponds to audio frames. This function can be used to handle pad queries of the type GST_QUERY_CONVERT.

  Parameters

  • src_fmt: Gst.Format

    Gst.Format of the src_val

  • src_val: number

    value to convert

  • dest_fmt: Gst.Format

    Gst.Format of the dest_val

  Returns [boolean, number]

  TRUE if the conversion was successful.

copy

• copy(): AudioInfo

  Copy a GstAudioInfo structure.

  Returns AudioInfo

  a new GstAudio.AudioInfo. free with gst_audio_info_free.

free

• free(): void

  Free a GstAudioInfo structure previously allocated with gst_audio_info_new() or gst_audio_info_copy().

  Returns void

is_equal

• is_equal(other: AudioInfo): boolean

  Compares two GstAudio.AudioInfo and returns whether they are equal or not

  Parameters

  • other: AudioInfo

    a GstAudio.AudioInfo

  Returns boolean

  true if info and other are equal, else false.

set_format

• set_format(
      format: GstAudio.AudioFormat,
      rate: number,
      channels: number,
      position?: GstAudio.AudioChannelPosition[],
  ): void

  Set the default info for the audio info of format and rate and channels.

  Note: This initializes info first, no values are preserved.

  Parameters

  • format: GstAudio.AudioFormat

    the format

  • rate: number

    the samplerate

  • channels: number

    the number of channels

  • Optionalposition: GstAudio.AudioChannelPosition[]

    the channel positions

  Returns void

to_caps

• to_caps(): Gst.Caps

  Convert the values of info into a Gst.Caps.

  Returns Gst.Caps

  the new Gst.Caps containing the info of info.

Staticfrom_caps

• from_caps(caps: Gst.Caps): [boolean, AudioInfo]

  Parse caps and update info.

  Parameters

  • caps: Gst.Caps

    a Gst.Caps

  Returns [boolean, AudioInfo]

Staticinit

• init(): AudioInfo

  Initialize info with default values.

  Returns AudioInfo

Staticnew

• new(): AudioInfo

  Returns AudioInfo

Staticnew_from_caps

• new_from_caps(caps: Gst.Caps): AudioInfo

  Parameters

  • caps: Gst.Caps

  Returns AudioInfo