View Source Membrane.File.Sink (Membrane File plugin v0.12.0)
Element that creates a file and stores incoming buffers there (in binary format).
When Membrane.File.SeekEvent is received, the element starts writing buffers starting
from position. By default, it overwrites previously stored bytes. You can set insert?
field of the event to true to start inserting new buffers without overwriting previous ones.
Please note, that inserting requires rewriting the file, what negatively impacts performance.
For more information refer to Membrane.File.SeekEvent moduledoc.
element-options
Element options
Passed via struct Membrane.File.Sink.t/0
locationPath.t()Required
Path of the output file
pads
Pads
input
:input
| Availability | :always |
| Caps | :any |
| Demand mode | :manual |
| Demand unit | :buffers |
| Direction | :input |
| Mode | :pull |
| Name | :input |
Link to this section Summary
Types
Struct containing options for Membrane.File.Sink
Functions
Returns pads descriptions for Membrane.File.Sink
Returns description of options available for this module
Link to this section Types
@type t() :: %Membrane.File.Sink{location: Path.t()}
Struct containing options for Membrane.File.Sink
Link to this section Functions
@spec membrane_pads() :: [{Membrane.Pad.name_t(), Membrane.Pad.description_t()}]
Returns pads descriptions for Membrane.File.Sink
@spec options() :: keyword()
Returns description of options available for this module