fiftyone.utils.data.parsers.FiftyOneUnlabeledVideoSampleParser

class documentation

class FiftyOneUnlabeledVideoSampleParser(ExtractClipsMixin, UnlabeledVideoSampleParser): (source)

Constructor: FiftyOneUnlabeledVideoSampleParser(compute_metadata, write_clips, clip_dir, video_format)

View In Hierarchy

Parser for fiftyone.core.sample.Sample instances that contain videos.

This class also supports fiftyone.core.clips.ClipView instances.

Parameters
compute_metadatawhether to compute fiftyone.core.metadata.VideoMetadata instances on-the-fly if get_video_metadata is called and no metadata is available
write_clipswhether to write clips when get_video_path is called
clip_dira directory to write clips. Only applicable when parsing fiftyone.core.clips.ClipView instances
video_formatthe video format to use when writing video clips to disk. By default, fiftyone.config.default_video_ext is used
Method __init__ Undocumented
Method get_video_metadata Returns the video metadata for the current sample.
Method get_video_path Returns the video path for the current sample.
Property has_video_metadata Whether this parser produces fiftyone.core.metadata.VideoMetadata instances for samples that it parses.

Inherited from ExtractClipsMixin:

Method _get_clip_metadata Undocumented
Method _get_clip_path Undocumented
Instance Variable _curr_clip_path Undocumented

Inherited from SampleParser (via ExtractClipsMixin, UnlabeledVideoSampleParser):

Method clear_sample Clears the current sample.
Method with_sample Sets the current sample so that subsequent calls to methods of this parser will return information from the given sample.
Property current_sample The current sample.
Instance Variable _current_sample Undocumented
def __init__(self, compute_metadata=False, write_clips=True, clip_dir=None, video_format=None): (source)
overrides fiftyone.utils.data.parsers.ExtractClipsMixin.__init__

Undocumented

def get_video_metadata(self): (source)
overrides fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.get_video_metadata

Returns the video metadata for the current sample.

Returns
a fiftyone.core.metadata.VideoMetadata instance
def get_video_path(self): (source)
overrides fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.get_video_path

Returns the video path for the current sample.

Returns
the path to the video on disk
@property
has_video_metadata = (source)
overrides fiftyone.utils.data.parsers.UnlabeledVideoSampleParser.has_video_metadata

Whether this parser produces fiftyone.core.metadata.VideoMetadata instances for samples that it parses.