View Source Membrane.Hackney.Source (Membrane Hackney plugin v0.7.0)
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
Element options
Passed via struct Membrane.Hackney.Source.t/0
location
String.t()
Required
The URL to fetch by the elementmethod
:get | :post | :put | :patch | :delete | :head | :options
Default value:
:get
HTTP method that will be used when making a requestbody
String.t()
Default value:
""
The request bodyheaders
keyword
Default value:
[]
List of additional request headers in format accepted by:hackney.request/5
hackney_opts
keyword
Default value:
[]
Additional options for Hackney in format accepted by:hackney.request/5
max_retries
non_neg_integer() | :infinity
Default value:
0
Maximum number of retries before returning an error. Can be set to:infinity
.retry_delay
Time.t()
Default value:
Membrane.Time.second()
Delay between reconnection attempts in case of connection error.is_live
boolean
Default value:
false
Assume the source is live. If true, when resuming after error, the element will not useRange
header to skip to the current position in bytes.
pads
Pads
output
:output
Availability | :always |
Caps | :any |
Demand mode | :manual |
Demand unit | :buffers |
Direction | :output |
Mode | :pull |
Name | :output |
Link to this section Summary
Types
Struct containing options for Membrane.Hackney.Source
Functions
Returns pads descriptions for Membrane.Hackney.Source
Returns description of options available for this module
Link to this section Types
Specs
t() :: %Membrane.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.Hackney.Source
Link to this section Functions
Specs
membrane_pads() :: [{Membrane.Pad.name_t(), Membrane.Pad.description_t()}]
Returns pads descriptions for Membrane.Hackney.Source
Specs
options() :: keyword()
Returns description of options available for this module