Membrane RTP plugin

View Source Membrane.RTCP.Packet behaviour (Membrane RTP plugin v0.23.0)

Functions common to all RTCP Packets

Link to this section Summary

Types

t()

Callbacks

decode(binary, packet_specific)

Decodes binary with packet body (without header) into packet struct. Used by parse/1

encode(struct)

Encodes packet struct into the tuple used by serialize/1

Functions

parse(packets)
serialize(packet)

Converts packet structure into binary

Link to this section Types

Link to this type

t()

View Source 
@type t() ::
  Membrane.RTCP.AppPacket.t()
  | Membrane.RTCP.ByePacket.t()
  | Membrane.RTCP.FeedbackPacket.t()
  | Membrane.RTCP.TransportFeedbackPacket.t()
  | Membrane.RTCP.ReceiverReportPacket.t()
  | Membrane.RTCP.SenderReportPacket.t()
  | Membrane.RTCP.SdesPacket.t()

Link to this section Callbacks

Link to this callback

decode(binary, packet_specific)

View Source 
@callback decode(binary(), packet_specific :: Membrane.RTCP.Header.packet_specific_t()) ::
  {:ok, struct()} | {:error, atom()}

Decodes binary with packet body (without header) into packet struct. Used by parse/1

Link to this callback

encode(struct)

View Source 
@callback encode(struct()) ::
  {body :: binary(),
   packet_specific :: Membrane.RTCP.Header.packet_specific_t()}

Encodes packet struct into the tuple used by serialize/1

Link to this section Functions

Link to this function

parse(packets)

View Source 
@spec parse(binary()) :: {:ok, [t()]} | {:error, any()}
Link to this function

serialize(packet)

View Source 
@spec serialize(t() | [t()]) :: binary()

Converts packet structure into binary