opus_multistream_ctls(3)

📦
version 1.6.1 · 8 versions
, in ubuntu resolute, ubuntu stonking

✨ opus_multistream_ctls ✨

okay bestie, welcome to the opus_multistream_ctls(3) page 💖 this one lives in the Opus manual, and it's short but it's iconic, fr fr.

🌸 NAME 🌸

opus_multistream_ctls — Multistream specific encoder and decoder CTLs 🎀

so basically: these are convenience macros that are specific to the opus_multistream_encoder_ctl() and opus_multistream_decoder_ctl() interface. that's the whole vibe. periodt.

✨ SYNOPSIS ✨

🦋 Macros 🦋

  • #define OPUS_MULTISTREAM_GET_ENCODER_STATE(x, y) — Gets the encoder state for an individual stream of a multistream encoder. 👑
  • #define OPUS_MULTISTREAM_GET_DECODER_STATE(x, y) — Gets the decoder state for an individual stream of a multistream decoder. 💅

💜 Detailed Description 💜

okay so, these are convenience macros that are specific to the opus_multistream_encoder_ctl() and opus_multistream_decoder_ctl() interface. (yes, same sentence as up top, the manpage is just being thorough, let it cook 🍓)

and here's the tea, bestie: the CTLs from Generic CTLs, Encoder related CTLs, and Decoder related CTLs may be applied to a multistream encoder or decoder as well. 🌈

plus — and this is the main character energy part — you may retrieve the encoder or decoder state for an specific stream via OPUS_MULTISTREAM_GET_ENCODER_STATE or OPUS_MULTISTREAM_GET_DECODER_STATE and apply CTLs to it individually. one stream at a time, tailored, obsessed. 😭💖

🧚 Macro Definition Documentation 🧚

🎀 #define OPUS_MULTISTREAM_GET_DECODER_STATE( x, y)

Gets the decoder state for an individual stream of a multistream decoder. slay.

Parameters

  • x opus_int32: The index of the stream whose decoder you wish to retrieve. This must be non-negative and less than the streams parameter used to initialize the decoder.
  • y OpusDecoder**: Returns a pointer to the given decoder state.

Return values

  • OPUS_BAD_ARG — The index of the requested stream was out of range.
ngl if you go out of range you get OPUS_BAD_ARG and nothing else, so like... stay in your lane, bestie 🙈

🌟 #define OPUS_MULTISTREAM_GET_ENCODER_STATE( x, y)

Gets the encoder state for an individual stream of a multistream encoder. ate, no crumbs. 🔥

Parameters

  • x opus_int32: The index of the stream whose encoder you wish to retrieve. This must be non-negative and less than the streams parameter used to initialize the encoder.
  • y OpusEncoder**: Returns a pointer to the given encoder state.

Return values

  • OPUS_BAD_ARG — The index of the requested stream was out of range.
same energy as the decoder one — negative index? too big? OPUS_BAD_ARG. it's giving boundaries. 💀

👑 Author 👑

Generated automatically by Doxygen for Opus from the source code. (not a human, not a bestie, just Doxygen doing its little thing 🫶)

and that's the page, babes ✨ this was Version 1.6.1, dated Thu Jan 29 2026 14:35:32, and it's the opus_multistream_ctls(3) one in case you lost track. go forth and retrieve your per-stream states, you absolute icon 💅🌸💖

📦 where this page comes from