Commit 4c5728b1 authored by Joel Collins's avatar Joel Collins
Browse files

Updated docstrings and todo

parent 9f259b7f
Loading
Loading
Loading
Loading
+18 −3
Original line number Diff line number Diff line
@@ -234,7 +234,15 @@ class BaseCamera(object):
            fmt: str='jpeg',
            shunt_others: bool=True):

        """Add a new capture to the image list, and shunt all others."""
        """
        Create a new image capture object. Adds to the image list, and shunt all others.

        Args:
            write_to_file (bool): Should the StreamObject write to a file, or an in-memory byte stream.
            keep_on_disk (bool): Should the data be kept on disk after session ends. Creating the capture with a content manager sets this to false.
            filename (str): Name of the stored file. Defaults to timestamp.
            fmt (str): Format of the capture.
        """

        if not filename:
            filename = self.generate_basename(self.images)
@@ -258,10 +266,17 @@ class BaseCamera(object):
            keep_on_disk: bool=True,
            filename: str=None,
            fmt: str='h264',
            quality: int=15,
            shunt_others: bool=True):

        """Add a new capture to the video list, and shunt all others."""
        """
        Create a new video capture object. Adds to the image list, and shunt all others.

        Args:
            write_to_file (bool): Should the StreamObject write to a file, or an in-memory byte stream.
            keep_on_disk (bool): Should the data be kept on disk after session ends. Creating the capture with a content manager sets this to false.
            filename (str): Name of the stored file. Defaults to timestamp.
            fmt (str): Format of the capture.
        """

        if not filename:
            filename = self.generate_basename(self.videos)
+2 −0
Original line number Diff line number Diff line
@@ -418,6 +418,8 @@ class StreamingCamera(BaseCamera):

        logging.info("Capturing to {}".format(output))


        # TODO: Do we really always want bayer data for full captures?
        if not use_video_port:

            # Pause video splitter port 1
+1 −1

File changed.

Contains only whitespace changes.