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.

F_VD module-attribute 

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

FuncExceptT module-attribute 

FuncExceptT = FuncExcept

GenericVSFunction module-attribute 

GenericVSFunction = Callable[..., VideoNodeT]

HoldsPropValue module-attribute 

HoldsPropValue = (
    FrameProps
    | VideoFrame
    | AudioFrame
    | VideoNode
    | AudioNode
    | Mapping[str, Any]
)

Types that can hold a vs.FrameProps.

HoldsPropValueT module-attribute 

HoldsPropValueT = HoldsPropValue

Deprecated alias of HoldsPropValue.

HoldsVideoFormat module-attribute 

HoldsVideoFormat = VideoNode | VideoFrame | VideoFormat

Types from which a clear VideoFormat can be retrieved.

HoldsVideoFormatT module-attribute 

HoldsVideoFormatT = HoldsVideoFormat

Deprecated alias of HoldsVideoFormat.

VSFunction module-attribute 

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

Function that takes a VideoNode as its first argument and returns a VideoNode.

VSMapValue module-attribute 

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

Values that a VSMap can hold, so all that a 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.

VideoFormatLike module-attribute 

VideoFormatLike = PresetVideoFormat | VideoFormat

Types representing a clear VideoFormat.

VideoFormatT module-attribute 

VideoFormatT = VideoFormatLike

Deprecated alias of VideoFormatLike.

VideoNodeIterableT module-attribute 

VideoNodeIterableT: TypeAlias = Union[
    VideoNodeT, Iterable["VideoNodeIterableT[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 in vstools/types/generic.py 
121
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 in vstools/types/generic.py 
113
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 in vstools/types/generic.py 
117
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 in vstools/types/generic.py 
109
def __call__(self, clip: VideoNodeT_contra) -> VideoNodeT_co: ...

VSFunctionPlanesArgs

Bases: VSFunctionKwArgs[VideoNodeT_contra, VideoNodeT_co], Protocol

Methods:

__call__ 

__call__(
    clip: VideoNodeT_contra, *, planes: Planes = ..., **kwargs: Any
) -> VideoNodeT_co
Source code in vstools/types/generic.py 
136
def __call__(self, clip: VideoNodeT_contra, *, planes: Planes = ..., **kwargs: Any) -> VideoNodeT_co: ...