# `Boombox.Packet`
[🔗](https://github.com/membraneframework/boombox/blob/v0.2.10/lib/boombox/packet.ex#L1)

Data structure emitted and accepted by `Boombox.run/1`
when using `:stream` input or output.

# `format`

```elixir
@type format() ::
  %{}
  | %{
      audio_format: Membrane.RawAudio.SampleFormat.t(),
      audio_rate: pos_integer(),
      audio_channels: pos_integer()
    }
```

# `payload`

```elixir
@type payload() :: Vix.Vips.Image.t() | binary()
```

# `t`

```elixir
@type t() :: %Boombox.Packet{
  format: format(),
  kind: :audio | :video,
  payload: payload(),
  pts: Membrane.Time.t()
}
```

Data structure emitted and accepted by `Boombox.run/1`
when using `:stream` input or output.

# `update_payload`

```elixir
@spec update_payload(t(), (payload() -> payload())) :: t()
```

---

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