Membrane RTC Engine v0.11.0

View Source Membrane.RTC.Engine.Endpoint.HLS.CompositorConfig (Membrane RTC Engine v0.11.0)

Module representing compositor configuration for the HLS endpoint.

Compositor is the element responsible for positioning input video streams into one video output.

Link to this section Summary

Types

t()
  • stream_format - output video specification in Membrane.RawVideo format
  • layout_module - Module implementing Membrane.RTC.Engine.Endpoint.HLS.VideoLayoutMaker behavior that should be used by the HLS endpoint.
  • background - Struct representing module that generates video used as a background in composed video.

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %Membrane.RTC.Engine.Endpoint.HLS.CompositorConfig{
  background: struct() | nil,
  layout_module: module(),
  stream_format: Membrane.RawVideo.t()
}
  • stream_format - output video specification in Membrane.RawVideo format
  • layout_module - Module implementing Membrane.RTC.Engine.Endpoint.HLS.VideoLayoutMaker behavior that should be used by the HLS endpoint.
  • background - Struct representing module that generates video used as a background in composed video.