Skip to content

generic

Classes:

Attributes:

BoundVSMapValue module-attribute 

BoundVSMapValue = TypeVar('BoundVSMapValue', bound=VSMapValue)

Type variable that can be one of the types in a VSMapValue.

BoundVSMapValue_0 module-attribute 

BoundVSMapValue_0 = TypeVar('BoundVSMapValue_0', bound=VSMapValue)

BoundVSMapValue_1 module-attribute 

BoundVSMapValue_1 = TypeVar('BoundVSMapValue_1', bound=VSMapValue)

F_VD module-attribute 

F_VD = TypeVar('F_VD', bound=Callable[..., VideoNode])

GenericVSFunction module-attribute 

GenericVSFunction = Callable[..., VideoNodeT]

HoldsPropValueT module-attribute 

HoldsPropValueT = FrameProps | VideoFrame | AudioFrame | VideoNode | AudioNode

Types that can hold :py:attr:vs.FrameProps.

HoldsVideoFormatT module-attribute 

HoldsVideoFormatT = VideoNode | VideoFrame | VideoFormat

Types from which a clear VideoFormat can be retrieved.

VSFunction module-attribute 

VSFunction = Union[
    VSFunctionNoArgs[VideoNodeT, VideoNodeT],
    VSFunctionArgs[VideoNodeT, VideoNodeT],
    VSFunctionKwArgs[VideoNodeT, VideoNodeT],
    VSFunctionAllArgs[VideoNodeT, VideoNodeT],
]

Function that takes a :py:attr:vs.VideoNode as its first argument and returns a :py:attr:vs.VideoNode.

VSMapValue module-attribute 

VSMapValue = Union[_VSMapValue, SingleOrSeq[Callable[..., _VSMapValue]]]

Values that a VSMap can hold, so all that a :py:attr:`vs.Function`` can accept in args and can return.

VSMapValueCallback module-attribute 

VSMapValueCallback = Callable[..., VSMapValue]

Callback that can be held in a VSMap. It can only return values representable in a VSMap.

VideoFormatT module-attribute 

VideoFormatT = PresetVideoFormat | VideoFormat

Types representing a clear VideoFormat.

VideoNodeIterableT module-attribute 

VideoNodeIterableT = Union[
    VideoNodeT,
    Iterable[VideoNodeT | Iterable[VideoNodeT]],
    Iterable[VideoNodeT | Iterable[VideoNodeT | Iterable[VideoNodeT]]],
]

VideoNodeT module-attribute 

VideoNodeT = TypeVar('VideoNodeT', bound=VideoNode)

VideoNodeT_co module-attribute 

VideoNodeT_co = TypeVar('VideoNodeT_co', bound=VideoNode, covariant=True)

VideoNodeT_contra module-attribute 

VideoNodeT_contra = TypeVar(
    "VideoNodeT_contra", bound=VideoNode, contravariant=True
)

ConstantFormatVideoNode

Bases: VideoNode

Attributes:

format instance-attribute 

format: VideoFormat

VSFunctionAllArgs

Bases: Protocol[VideoNodeT_contra, VideoNodeT_co]

Methods:

__call__ 

__call__(clip: VideoNodeT_contra, *args: Any, **kwargs: Any) -> VideoNodeT_co
Source code 
98
99
def __call__(self, clip: VideoNodeT_contra, *args: Any, **kwargs: Any) -> VideoNodeT_co:
    ...

VSFunctionArgs

Bases: Protocol[VideoNodeT_contra, VideoNodeT_co]

Methods:

__call__ 

__call__(clip: VideoNodeT_contra, *args: Any) -> VideoNodeT_co
Source code 
88
89
def __call__(self, clip: VideoNodeT_contra, *args: Any) -> VideoNodeT_co:
    ...

VSFunctionKwArgs

Bases: Protocol[VideoNodeT_contra, VideoNodeT_co]

Methods:

__call__ 

__call__(clip: VideoNodeT_contra, **kwargs: Any) -> VideoNodeT_co
Source code 
93
94
def __call__(self, clip: VideoNodeT_contra, **kwargs: Any) -> VideoNodeT_co:
    ...

VSFunctionNoArgs

Bases: Protocol[VideoNodeT_contra, VideoNodeT_co]

Methods:

__call__ 

__call__(clip: VideoNodeT_contra) -> VideoNodeT_co
Source code 
83
84
def __call__(self, clip: VideoNodeT_contra) -> VideoNodeT_co:
    ...