VideoMixer.FilterGraph (video_mixer v2.1.5)

Summary

Types

layout()

role()

Functions

build(layout, specs_by_role, output_spec, opts \\ [])

Types

layout()

@type layout() ::
  :single_fit
  | :hstack
  | :vstack
  | :xstack
  | :primary_sidebar
  | :primary_sidebar_cropped

role()

@type role() ::
  :primary
  | :sidebar
  | :left
  | :right
  | :top
  | :bottom
  | :top_left
  | :top_right
  | :bottom_left
  | :bottom_right

Functions

build(layout, specs_by_role, output_spec, opts \\ [])

@spec build(
  layout(),
  keyword(VideoMixer.FrameSpec.t()) | map(),
  VideoMixer.FrameSpec.t() | map(),
  keyword()
) ::
  {:ok,
   %{
     graph: String.t(),
     filter_indexes: [non_neg_integer()],
     input_order: [role()],
     mapping: [VideoMixer.FrameSpec.t()]
   }}
  | {:error, VideoMixer.Error.t()}