# `Membrane.Opus`
[🔗](https://github.com/membraneframework/membrane_opus_format/blob/v0.3.2/lib/membrane_opus.ex#L1)

This module implements struct describing an Opus-encoded audio stream.

Based on [RFC 6716](https://tools.ietf.org/html/rfc6716).

# `channels_t`

```elixir
@type channels_t() :: 1 | 2
```

Number of channels transmitted in the stream.

# `self_delimiting_t`

```elixir
@type self_delimiting_t() :: boolean()
```

Determines if stream uses self-delimiting framing.

Self-delimiting framing provides information necessary to parse
uncontainerized Opus stream.

# `t`

```elixir
@type t() :: %Membrane.Opus{
  channels: channels_t(),
  self_delimiting?: self_delimiting_t()
}
```

---

*Consult [api-reference.md](api-reference.md) for complete listing*
