View Source Membrane.OverlayFilter (Membrane Overlay plugin v0.2.0)

Applies image or text overlay to video.

Based on Image.

You need to provide the first overlay description as the initial_overlay option. To update overlay dynamically you can send {:update_overlay,Membrane.OverlayFilter.OverlayDescription} notification from parent.

Element options

Passed via struct Membrane.OverlayFilter.t/0

  • initial_overlay

    OverlayDescription.t()

    Required
    Description of the overlay that will be initially used.

Pads

:input

Accepted formats:

%RawVideo{pixel_format: :I420}
Direction::input
Availability::always
Flow control::auto

:output

Accepted formats:

%RawVideo{pixel_format: :I420}
Direction::output
Availability::always
Flow control::auto

Summary

Types

t()

Struct containing options for Membrane.OverlayFilter

Functions

Returns description of options available for this module

Types

@type t() :: %Membrane.OverlayFilter{
  initial_overlay: Membrane.OverlayFilter.OverlayDescription.t()
}

Struct containing options for Membrane.OverlayFilter

Functions

@spec options() :: keyword()

Returns description of options available for this module