Membrane RTMP plugin v0.13.1

View Source Membrane.RTMP.Sink (Membrane RTMP plugin v0.13.1)

Membrane element being client-side of RTMP streams. It needs to receive at least one of: video stream in H264 format or audio in AAC format. Currently it supports only:

  • RTMP proper - "plain" RTMP protocol
  • RTMPS - RTMP over TLS/SSL other RTMP variants - RTMPT, RTMPE, RTMFP are not supported. Implementation based on FFmpeg.

element-options

 Element options

Passed via struct Membrane.RTMP.Sink.t/0

  • rtmp_url 

    String.t()

    Required
    Destination URL of the stream. It needs to start with rtmp:// or rtmps:// depending on the protocol variant. This URL should be provided by your streaming service.

  • max_attempts 

    pos_integer() | :infinity

    Default value: 1
    Maximum number of connection attempts before failing with an error. The attempts will happen every 500 ms

  • tracks 

    [track_type()]

    Default value: [:audio, :video]
    A list of tracks, which will be sent. Can be :audio, :video or both.

pads

 Pads

video

 :video

Accepted formats:

MP4.Payload
Direction::input
Availability::on_request
Mode::pull
Demand mode::manual
Demand unit::buffers

audio

 :audio

Accepted formats:

AAC
Direction::input
Availability::on_request
Mode::pull
Demand mode::manual
Demand unit::buffers

Link to this section Summary

Types

t()

Struct containing options for Membrane.RTMP.Sink

track_type()

Functions

options()

Returns description of options available for this module

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Membrane.RTMP.Sink{
  max_attempts: pos_integer() | :infinity,
  rtmp_url: String.t(),
  tracks: [track_type()]
}

Struct containing options for Membrane.RTMP.Sink

Link to this type

track_type()

View Source 
@type track_type() :: :audio | :video

Link to this section Functions

Link to this function

options()

View Source 
@spec options() :: keyword()

Returns description of options available for this module