View Source Membrane.Agora.Sink (Membrane Agora plugin v0.4.0)
Membrane sink that wraps 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 will be chosen automatically.
Pads
:audio
Accepted formats:
Membrane.AAC
Membrane.Opus
Direction: | :input |
Availability: | :on_request |
Flow control: | :auto |
Pad options:
sample_rate
pos_integer()
Default value:
48000
Sample rate of the audio stream going through :audio pad.Used only if the audio codec is
Membrane.Opus
. If the audio codec isMembrane.AAC
, sample rate value will be passed in the stream format.Defaults to 48 000.
:video
Accepted formats:
%Membrane.H264{alignment: :au}
Direction: | :input |
Availability: | :on_request |
Flow control: | :auto |
Summary
Types
@type audio_pad_opts() :: [{:sample_rate, pos_integer()}]
Options for pad :audio
@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
@spec options() :: keyword()
Returns description of options available for this module