Membrane Overlay plugin
v0.1.0

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

Applies image or text overlay to video.

Based on Image.

Element options

Passed via struct Membrane.OverlayFilter.t/0

  • overlay 

    Path.t() | Vix.Vips.Image.t()

    Required
    Path to the overlay image or a Vix image.

    You can get a Vix image for example by calling Image.open/2, Image.Text.text/2 or Vix.Vips.Image.new_from_buffer/2.

  • x 

    integer() | :center | :left | :right

    Default value: :center
    Distance of the overlay image from the left (or right if negative) border of the frame. Can be also set to center, left or right.

  • y 

    integer() | :middle | :top | :bottom

    Default value: :middle
    Distance of the overlay image from the top (or bottom if negative) border of the frame. Can be also set to middle, top or bottom.

  • blend_mode 

    Image.BlendMode.t()

    Default value: :over
    The manner in which the overlay is composed on the frame.

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

options()

Returns description of options available for this module

Types

Link to this type

t()

View Source 
@type t() :: %Membrane.OverlayFilter{
  blend_mode: Image.BlendMode.t(),
  overlay: Path.t() | Vix.Vips.Image.t(),
  x: integer() | :center | :left | :right,
  y: integer() | :middle | :top | :bottom
}

Struct containing options for Membrane.OverlayFilter

Functions

Link to this function

options()

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

Returns description of options available for this module