Membrane Element: HTTPoison v0.1.0 Membrane.Element.HTTPoison.Source View Source

This module HTTP source using HTTPoison library to make requests

It has an option to resume file download when an error occurrs. Full list of options available via options/0

Link to this section Summary

Types

t()

Struct containing options for Membrane.Element.HTTPoison.Source

  • location: The URL to fetch by the element
  • method: HTTP method to use
  • body: Request body
  • headers: List of additional request headers in format accepted by HTTPoison.request/5
  • poison_opts: Additional options to HTTPoison in format accepted by HTTPoison.request/5
  • resume_on_error: If set to true, the element will try to automatically resume the download (from proper position) if the connection is broken.
  • is_live: Assume the source is live. When true, resume after error will not use Range header to skip to the current position in bytes

Functions

Returns all known source pads for Membrane.Element.HTTPoison.Source

Returns description of options available for this module

Link to this section Types

Link to this type t() View Source
t() :: %Membrane.Element.HTTPoison.Source{
  location: String.t(),
  method: :get | :post | :put | :patch | :delete | :head | :options,
  body: String.t(),
  headers: HTTPoison.headers(),
  poison_opts: keyword(),
  resume_on_error: boolean(),
  is_live: boolean()
}

Struct containing options for Membrane.Element.HTTPoison.Source

  • location: The URL to fetch by the element
  • method: HTTP method to use
  • body: Request body
  • headers: List of additional request headers in format accepted by HTTPoison.request/5
  • poison_opts: Additional options to HTTPoison in format accepted by HTTPoison.request/5
  • resume_on_error: If set to true, the element will try to automatically resume the download (from proper position) if the connection is broken.
  • is_live: Assume the source is live. When true, resume after error will not use Range header to skip to the current position in bytes.

Link to this section Functions

Returns all known source pads for Membrane.Element.HTTPoison.Source

They are the following:

  • Pad: :source

    • Availability: :always
    • Mode: :pull
    • Caps: any

Returns description of options available for this module