View Source Membrane.VideoCompositor (Membrane Video Compositor plugin v0.2.1)

A bin responsible for doing framerate conversion on all input videos and piping them into the compositor element.

bin-options

Bin options

Passed via struct Membrane.VideoCompositor.t/0

  • stream_format

    Membrane.RawVideo.t()

    Required
    Stream format for the output video of the compositor

pads

Pads

input

:input

Accepted formats:

%Membrane.RawVideo{pixel_format: :I420}
Direction::input
Availability::on_request
Mode::pull
Demand unit::buffers

Pad options:

  • initial_placement

    BaseVideoPlacement.t()

    Required
    Initial placement of the video on the screen

  • timestamp_offset

    Membrane.Time.non_neg_t()

    Default value: 0
    Input stream PTS offset in nanoseconds. Must be non-negative.

  • initial_video_transformations

    VideoTransformations.t()

    Default value: nil
    Specify the initial types and the order of transformations applied to video.

output

:output

Accepted formats:

%Membrane.RawVideo{pixel_format: :I420}
Direction::output
Availability::always
Mode::pull
Demand unit::buffers

Link to this section Summary

Types

Options for pad :input

t()

Struct containing options for Membrane.VideoCompositor

A message describing a compositor video placement update

A message describing a compositor video transformations update

Functions

Returns description of options available for this module

Link to this section Types

@type input_pad_opts_t() :: [
  initial_placement:
    Membrane.VideoCompositor.RustStructs.BaseVideoPlacement.t(),
  timestamp_offset: Membrane.Time.non_neg_t(),
  initial_video_transformations:
    Membrane.VideoCompositor.VideoTransformations.t()
]

Options for pad :input

@type t() :: %Membrane.VideoCompositor{stream_format: Membrane.RawVideo.t()}

Struct containing options for Membrane.VideoCompositor

@type update_placement_t() ::
  {:update_placement,
   [
     {Membrane.Pad.ref_t(),
      Membrane.VideoCompositor.RustStructs.BaseVideoPlacement.t()}
   ]}

A message describing a compositor video placement update

Link to this type

update_transformations_t()

View Source
@type update_transformations_t() ::
  {:update_transformations,
   [{Membrane.Pad.ref_t(), Membrane.VideoCompositor.VideoTransformations.t()}]}

A message describing a compositor video transformations update

Link to this section Functions

@spec options() :: keyword()

Returns description of options available for this module