Membrane Element: Hackney

Membrane Element: Hackney v0.3.1 Membrane.Element.Hackney.Source View Source

This module provides a source element allowing you to receive data as a client using HTTP. It is based upon Hackney library that is responsible for making HTTP requests.

See the t/0 for the available configuration options.

Element options

Passed via struct Membrane.Element.Hackney.Source.t/0

  • location

    Required

    The URL to fetch by the element

  • method

    Default value: :get

    HTTP method that will be used when making a request

  • body

    Default value: ""

    The request body

  • headers

    Default value: []

    List of additional request headers in format accepted by :hackney.request/5

  • hackney_opts

    Default value: []

    Additional options for Hackney in format accepted by :hackney.request/5

  • max_retries

    Default value: 0

    Maximum number of retries before returning an error. Can be set to :infinity.

  • retry_delay

    Default value: 1 |> Membrane.Time.seconds()

    Delay between reconnection attempts in case of connection error.

  • is_live

    Default value: false

    Assume the source is live. If true, when resuming after error, the element will not use Range header to skip to the current position in bytes.

Pads

:output

Availability:always
Bin?false
Caps:any
Direction:output
Mode:pull
Name:output

Link to this section Summary

Types

t()

Struct containing options for Membrane.Element.Hackney.Source

Functions

membrane_pads()

Returns pads descriptions for Membrane.Element.Hackney.Source

options()

Returns description of options available for this module

Link to this section Types

Link to this type

t()

View Source 
t() :: %Membrane.Element.Hackney.Source{
  body: String.t(),
  hackney_opts: keyword(),
  headers: keyword(),
  is_live: boolean(),
  location: String.t(),
  max_retries: non_neg_integer() | :infinity,
  method: :get | :post | :put | :patch | :delete | :head | :options,
  retry_delay: Membrane.Time.t()
}

Struct containing options for Membrane.Element.Hackney.Source

Link to this section Functions

Link to this function

membrane_pads()

View Source 
membrane_pads() :: [{Membrane.Pad.name_t(), Membrane.Pad.description_t()}]

Returns pads descriptions for Membrane.Element.Hackney.Source

Link to this function

options()

View Source 
options() :: keyword()

Returns description of options available for this module