View Source Membrane.RTC.Engine.Endpoint.Recording (Membrane RTC Engine Recording Endpoint v0.2.0)
An Endpoint responsible for saving incoming tracks to pointed storages.
Bin options
Passed via struct Membrane.RTC.Engine.Endpoint.Recording.t/0
rtc_engine
pid()
Required
Pid of parent Enginestores
[{storage(), storage_opts()}]
Required
A list of stores that the recorded streams will be uploaded to. Should implementMembrane.RTC.Engine.Endpoint.Recording.Storage
behaviour.recording_id
String.t()
Required
Recording id that will be saved along with reportsubscribe_mode
:auto | :manual
Default value:
:auto
Whether tracks should be subscribed automatically when they're ready. If set to:manual
, Recording endpoint will subscribe only to tracks from endpoints sent using message:{:subscribe, endpoints}
Pads
:input
Accepted formats:
Membrane.RTP
Direction: | :input |
Availability: | :on_request |
Summary
Types
Struct containing options for Membrane.RTC.Engine.Endpoint.Recording
Functions
Returns description of options available for this module
Subscribe Recording endpoint to tracks from endpoints.
Types
@type storage() :: module()
@type storage_opts() :: any()
@type t() :: %Membrane.RTC.Engine.Endpoint.Recording{ recording_id: String.t(), rtc_engine: pid(), stores: [{storage(), storage_opts()}], subscribe_mode: :auto | :manual }
Struct containing options for Membrane.RTC.Engine.Endpoint.Recording
Functions
@spec options() :: keyword()
Returns description of options available for this module
Subscribe Recording endpoint to tracks from endpoints.
It is only valid to use when Recording has subscribe_mode
set to :manual.