Effects

Effect

Bases: Protocol[ClipType]

A protocol for clip effects.

Note

This is a runtime checkable protocol, which means isinstance() and issubclass() checks can be performed against it.

apply

apply(clip: ClipType) -> ClipType

Apply the effect to the clip.

Source code in src/mosaico/effects/protocol.py

def apply(self, clip: ClipType) -> ClipType:
    """Apply the effect to the clip."""
    ...

VideoEffect module-attribute

VideoEffect = (
    ZoomInEffect
    | ZoomOutEffect
    | PanLeftEffect
    | PanRightEffect
    | PanUpEffect
    | PanDownEffect
    | FadeInEffect
    | FadeOutEffect
)

A type representing any video effect.

VideoEffectType module-attribute

VideoEffectType = Literal[
    "zoom_in",
    "zoom_out",
    "pan_left",
    "pan_right",
    "pan_up",
    "pan_down",
    "fade_in",
    "fade_out",
]

A type representing the type of a video effect.