gstaudioiec61937

## gstaudioiec61937 gstaudioiec61937 — Utility functions for IEC 61937 payloading |

## Synopsis

    #include <gst/audio/gstaudioiec61937.h>

    guint               gst_audio_iec61937_frame_size       (const GstRingBufferSpec *spec);
    gboolean            gst_audio_iec61937_payload          (const guint8 *src,
                                                             guint src_n,
                                                             guint8 *dst,
                                                             guint dst_n,
                                                             const GstRingBufferSpec *spec);

## Description

This module contains some helper functions for encapsulating various audio formats in IEC 61937 headers and padding.

## Details

### gst_audio_iec61937_frame_size ()

    guint               gst_audio_iec61937_frame_size       (const GstRingBufferSpec *spec);

Calculated the size of the buffer expected by `gst_audio_iec61937_payload()` for payloading type from `spec`.

`spec` : | the ringbufer spec
Returns : | the size or 0 if the given `type` is not supported or cannot be payloaded.

Since 0.10.36

### gst_audio_iec61937_payload ()

    gboolean            gst_audio_iec61937_payload          (const guint8 *src,
                                                             guint src_n,
                                                             guint8 *dst,
                                                             guint dst_n,
                                                             const GstRingBufferSpec *spec);

Payloads `src` in the form specified by IEC 61937 for the type from `spec` and stores the result in `dst`. `src` must contain exactly one frame of data and the frame is not checked for errors.

`src` : | a buffer containing the data to payload
`src_n` : | size of `src` in bytes
`dst` : | the destination buffer to store the payloaded contents in. Should not overlap with `src`
`dst_n` : | size of `dst` in bytes
`spec` : | the ringbufer spec for `src`
Returns : | transfer-full: `TRUE` if the payloading was successful, `FALSE` otherwise.

Since 0.10.36