View Source Boombox.Packet (Boombox v0.1.0)

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

Summary

Types

format()

payload()

t()

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

Functions

update_payload(packet, fun)

Types

format()

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

payload()

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

t()

@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.

Functions

update_payload(packet, fun)

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