opusenc

opusenc

Synopsis

struct              GstOpusEnc;
enum                GstOpusEncBitrateType;

Object Hierarchy

  GObject
   +----GInitiallyUnowned
         +----GstObject
               +----GstElement
                     +----GstAudioEncoder
                           +----GstOpusEnc

Implemented Interfaces

GstOpusEnc implements GstPreset and GstTagSetter.

Properties

  "audio"                    gboolean              : Read / Write
  "audio-type"               GstOpusEncAudioType   : Read / Write
  "bandwidth"                GstOpusEncBandwidth   : Read / Write
  "bitrate"                  gint                  : Read / Write
  "bitrate-type"             GstOpusEncBitrateType  : Read / Write
  "cbr"                      gboolean              : Read / Write
  "complexity"               gint                  : Read / Write
  "constrained-vbr"          gboolean              : Read / Write
  "dtx"                      gboolean              : Read / Write
  "frame-size"               GstOpusEncFrameSize   : Read / Write
  "inband-fec"               gboolean              : Read / Write
  "max-payload-size"         guint                 : Read / Write
  "packet-loss-percentage"   gint                  : Read / Write

Description

This element encodes raw audio to OPUS.

Example pipelines

1
gst-launch-1.0 -v audiotestsrc wave=sine num-buffers=100 ! audioconvert ! opusenc ! oggmux ! filesink location=sine.ogg
Encode a test sine signal to Ogg/OPUS.

Synopsis

Element Information

plugin

opus

author

Vincent Penquerc'h <vincent.penquerch@collabora.co.uk>

class

Codec/Encoder/Audio

Element Pads

name

sink

direction

sink

presence

always

details

audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int)48000, channels=(int)[ 1, 8 ]

audio/x-raw, format=(string)S16LE, layout=(string)interleaved, rate=(int){ 8000, 12000, 16000, 24000 }, channels=(int)[ 1, 8 ]

name

src

direction

source

presence

always

details

audio/x-opus

Details

struct GstOpusEnc

struct GstOpusEnc;

enum GstOpusEncBitrateType

typedef enum {
  BITRATE_TYPE_CBR,
  BITRATE_TYPE_VBR,
  BITRATE_TYPE_CONSTRAINED_VBR,
} GstOpusEncBitrateType;

BITRATE_TYPE_CBR

BITRATE_TYPE_VBR

BITRATE_TYPE_CONSTRAINED_VBR

Property Details

The "audio" property

  "audio"                    gboolean              : Read / Write

Audio or voice (DEPRECATED: use audio-type).

Default value: TRUE


The "audio-type" property

  "audio-type"               GstOpusEncAudioType   : Read / Write

What type of audio to optimize for.

Default value: Generic audio


The "bandwidth" property

  "bandwidth"                GstOpusEncBandwidth   : Read / Write

Audio Band Width.

Default value: Full band


The "bitrate" property

  "bitrate"                  gint                  : Read / Write

Specify an encoding bit-rate (in bps).

Allowed values: [4000,650000]

Default value: 64000


The "bitrate-type" property

  "bitrate-type"             GstOpusEncBitrateType  : Read / Write

Bitrate type.

Default value: CBR


The "cbr" property

  "cbr"                      gboolean              : Read / Write

Constant bit rate (DEPRECATED: use bitrate-type).

Default value: TRUE


The "complexity" property

  "complexity"               gint                  : Read / Write

Complexity.

Allowed values: [0,10]

Default value: 10


The "constrained-vbr" property

  "constrained-vbr"          gboolean              : Read / Write

Constrained VBR (DEPRECATED: use bitrate-type).

Default value: TRUE


The "dtx" property

  "dtx"                      gboolean              : Read / Write

DTX.

Default value: FALSE


The "frame-size" property

  "frame-size"               GstOpusEncFrameSize   : Read / Write

The duration of an audio frame, in ms.

Default value: 20


The "inband-fec" property

  "inband-fec"               gboolean              : Read / Write

Enable forward error correction.

Default value: FALSE


The "max-payload-size" property

  "max-payload-size"         guint                 : Read / Write

Maximum payload size in bytes.

Allowed values: [2,4000]

Default value: 4000


The "packet-loss-percentage" property

  "packet-loss-percentage"   gint                  : Read / Write

Packet loss percentage.

Allowed values: [0,100]

Default value: 0

See Also

opusdec, oggmux