Membrane Agora plugin
v0.1.0

View Source Membrane.Agora.Sink (Membrane Agora plugin v0.1.0)

Membrane element wrapping Agora's Server Gateway SDK.

Element options

Passed via struct Membrane.Agora.Sink.t/0

  • app_id 

    String.t()

    Required
    ID of an Agora application.

  • channel_name 

    String.t()

    Required

  • token 

    String.t()

    Required

  • user_id 

    String.t()

    Default value: "0"
    User ID, must contain only numbers (0-9).

    If set to "0" (default), the user ID of the Agora's channel will be chosen automatically.

Pads

:audio

Accepted formats:

Membrane.AAC
Direction::input
Availability::on_request
Flow control::auto
Demand unit:nil

:video

Accepted formats:

%Membrane.H264{alignment: :au}
Direction::input
Availability::on_request
Flow control::auto
Demand unit:nil

Summary

Types

t()

Struct containing options for Membrane.Agora.Sink

Functions

options()

Returns description of options available for this module

Types

Link to this type

t()

View Source 
@type t() :: %Membrane.Agora.Sink{
  app_id: String.t(),
  channel_name: String.t(),
  token: String.t(),
  user_id: String.t()
}

Struct containing options for Membrane.Agora.Sink

Functions

Link to this function

options()

View Source 
@spec options() :: keyword()

Returns description of options available for this module