videoflow.consumers package

This package contains a collection of consumers that implement the videoflow.core.node.ConsumerNode interface

Submodules

videoflow.consumers.basic module

class videoflow.consumers.basic.CommandlineConsumer(sep: str = ' ', end: str = '\n', **kwargs)

Bases: ConsumerNode

Writes the input received to the command line.

• Arguments:

  • sep: separator to use between tokens.

  • end: end of line character

consume(item: Any) → None

Prints item to the command line, adding an end of line character after it.

• Arguments:

  • item: It can be anything that can be printed with the print() function

class videoflow.consumers.basic.FileAppenderConsumer(filepath: str, **kwargs)

Bases: ConsumerNode

Appends a text representation of each received item, one per line, to a file.

• Arguments:

  • filepath: path to the file to append to (created if missing). The folder must already exist.

consume(item: Any) → None

Method definition that needs to be implemented by subclasses.

• Arguments:

  • item: the item being received as input (or consumed).

class videoflow.consumers.basic.VoidConsumer(**kwargs)

Bases: ConsumerNode

Ignores the input received. Helpful in debugging flows.

consume(item: Any) → None

Does nothing with the item passed

class videoflow.consumers.basic.WebhookConsumer(host: str, method: str = 'post', **kwargs)

Bases: ConsumerNode

consume(item: Any) → None

Method definition that needs to be implemented by subclasses.

• Arguments:

  • item: the item being received as input (or consumed).

videoflow.consumers.video module

class videoflow.consumers.video.VideofileWriter(video_file: str, swap_channels: bool = True, fps: int = 30, **kwargs)

Bases: ConsumerNode

Opens a video file writer object and writes subsequent frames received into the object. If video file exists it overwrites it.

The video writer will open when it receives the first frame. - Arguments:

• video_file: path to video. Folder where video lives must exist. Extension must be .avi

• fps: frames per second

close() → None

Closes the video stream

consume(item: ndarray) → None

Receives the picture frame to append to the video and appends it to the video.

If it is the first frame received, it opens the video file and determines the height and width of the video from the dimensions of that first frame. Every subsequent frame is expected to have the same height and width. If it does not has it, it gets resized to it.

• Arguments:

  • item: np.ndarray of dimension (height, width, 3)

open() → None

We don’t open the video writer here. We need to wait for the first frame to arrive in order to determine the width and height of the video