Membrane.RTC.Engine.Endpoint.Recording (Membrane RTC Engine Recording Endpoint v0.4.0)

View Source

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 Engine

  • stores 

    [{storage(), storage_opts()}]

    Required
    A list of stores that the recorded streams will be uploaded to. Should implement Membrane.RTC.Engine.Endpoint.Recording.Storage behaviour.

  • recording_id 

    String.t()

    Required
    Recording id that will be saved along with report

  • subscribe_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

storage()
storage_opts()
t()

Struct containing options for Membrane.RTC.Engine.Endpoint.Recording

Functions

options()

Returns description of options available for this module

subscribe(engine, endpoint_id, endpoints)

Subscribe Recording endpoint to tracks from endpoints.

Types

storage()

@type storage() :: module()

storage_opts()

@type storage_opts() :: any()

t()

@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

options()

@spec options() :: keyword()

Returns description of options available for this module

subscribe(engine, endpoint_id, endpoints)

@spec subscribe(engine :: pid(), endpoint_id :: any(), endpoints :: [any()]) :: :ok

Subscribe Recording endpoint to tracks from endpoints.

It is only valid to use when Recording has subscribe_mode set to :manual.