pyflink.multimodal.expression.VideoExpressionAccessor.extract_frames#

VideoExpressionAccessor.extract_frames(*, frame_selector: Literal['all_frames', 'keyframe', 'sample'] = 'all_frames', sample_interval_ms: Optional[int] = None, max_frames: Optional[int] = None, image_height: Optional[int] = None, image_width: Optional[int] = None, on_error: Literal['raise', 'null'] = 'raise', container_options: Optional[Mapping[str, str]] = None, read_chunk_size: Optional[int] = None, max_cached_blocks: Optional[int] = None, read_ahead_blocks: Optional[int] = None, concurrency: Optional[int] = None) → pyflink.table.expression.Expression[source]#

Extract selected frames from this expression as an array.

Equivalent to video_extract_frames(). See that function for full parameter details.

Parameters

frame_selector – Frame selection mode, "all_frames", "keyframe", or "sample".
sample_interval_ms – Sampling interval for frame_selector set to "sample".
max_frames – Optional safety limit for frames retained in memory.
image_height – Optional output frame height in pixels.
image_width – Optional output frame width in pixels.
on_error – "raise" to propagate failures, "null" to return None for unreadable inputs.
container_options – Optional PyAV av.open options.
read_chunk_size – Optional read chunk size in bytes for video files.
max_cached_blocks – Optional number of read chunks to cache per opened video.
read_ahead_blocks – Optional number of chunks to prefetch after a read.
concurrency – Optional execution concurrency for this operation. None uses the framework default.

Returns

A DataFrame expression that produces ARRAY<IMAGE> selected video frames retained on the same output row.