three.MF.V3.Tasks.CaptureImage 

  1from MF.V3.Descriptors.CaptureImage import CaptureImage as MF_V3_Descriptors_CaptureImage_CaptureImage
  2from MF.V3.Settings.CaptureImage import CaptureImage as MF_V3_Settings_CaptureImage_CaptureImage
  3from MF.V3.Task import TaskState as MF_V3_Task_TaskState, Task as MF_V3_Task_Task
  4from typing import List
  5
  6
  7class CaptureImage:
  8    """*
  9    Capture an image from one or both cameras.
 10
 11    > Request example:
 12
 13    ```json
 14    {
 15    "Task":{
 16    "Index":1,
 17    "Type":"CaptureImage"
 18    "Input":{
 19    "selection":{0,1},
 20    "grayscale":false,
 21    "codec":jpg
 22    }
 23    }
 24    }
 25    ```
 26
 27    > Buffer messages from server.
 28
 29    ```json
 30    {
 31    "Buffer":{
 32    "Descriptor":"{"camera":0,"codec":"jpg","grayscale":false,"height":1560,"step":6312,"width":2104},
 33    "Index":0,
 34    "Size":856664,
 35    "Task":{
 36    "Index":1,
 37    "Type":"CaptureImage",
 38    "Input":{"selection":{0,1}, "grayscale":false, "codec":jpg}
 39    }
 40    }
 41    }
 42    ```
 43    ```json
 44    {
 45    "Buffer":{
 46    "Descriptor":"{"camera":1,"codec":"jpg","grayscale":false,"height":1560,"step":6312,"width":2104},
 47    "Index":1,
 48    "Size":847726,
 49    "Task":{
 50    "Index":1,
 51    "Type":"CaptureImage",
 52    "Input":{"selection":{0,1}, "grayscale":false, "codec":jpg}
 53    }
 54    }
 55    }
 56    ```
 57
 58    > Response example:
 59
 60    ```json
 61    {
 62    "Task":{
 63    "Index":1,
 64    "Type":"CaptureImage"
 65    "Input":{
 66    "selection":{0,1},
 67    "grayscale":false,
 68    "codec":jpg
 69    }
 70    "Output":[
 71    {"camera":0,"codec":"jpg","grayscale":false,"height":1560,"step":6312,"width":2104},
 72    {"camera":1,"codec":"jpg","grayscale":false,"height":1560,"step":6312,"width":2104}
 73    ],
 74    "State":"Completed"
 75    }
 76    }
 77    ```
 78    """
 79    class Request:
 80
 81        """
 82         Client request for the `CaptureImage` task.
 83        """
 84        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CaptureImage_CaptureImage):
 85            # A unique identifier generated by the client.
 86            self.Index = Index
 87            # "CaptureImage"
 88            self.Type = Type
 89            # The Image settings
 90            self.Input = Input
 91
 92    class Response:
 93
 94        """
 95         Server response for the `CaptureImage` task.
 96        """
 97        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CaptureImage_CaptureImage, Output: List[MF_V3_Descriptors_CaptureImage_CaptureImage] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
 98            # The unique identifier generated by the client.
 99            self.Index = Index
100            # "CaptureImage"
101            self.Type = Type
102            # Requested capture image settings.s
103            self.Input = Input
104            # A capture image descriptors for each selected camera.
105            self.Output = Output
106            # The current state of the task.
107            self.State = State
108            # A string describing the error if the task has failed.
109            self.Error = Error
110
111    class Buffer:
112
113        """
114         Server buffer message for the `CaptureImage` task.
115        """
116        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: MF_V3_Descriptors_CaptureImage_CaptureImage):
117            # The zero-based index identifying the data buffer.
118            self.Index = Index
119            # The size of the incoming data buffer in bytes.
120            self.Size = Size
121            # The requested CaptureImage task.
122            self.Task = Task
123            # The capture image descriptor.
124            self.Descriptor = Descriptor
125
126    def __init__(self):
127        pass
class CaptureImage: 
  8class CaptureImage:
  9    """*
 10    Capture an image from one or both cameras.
 11
 12    > Request example:
 13
 14    ```json
 15    {
 16    "Task":{
 17    "Index":1,
 18    "Type":"CaptureImage"
 19    "Input":{
 20    "selection":{0,1},
 21    "grayscale":false,
 22    "codec":jpg
 23    }
 24    }
 25    }
 26    ```
 27
 28    > Buffer messages from server.
 29
 30    ```json
 31    {
 32    "Buffer":{
 33    "Descriptor":"{"camera":0,"codec":"jpg","grayscale":false,"height":1560,"step":6312,"width":2104},
 34    "Index":0,
 35    "Size":856664,
 36    "Task":{
 37    "Index":1,
 38    "Type":"CaptureImage",
 39    "Input":{"selection":{0,1}, "grayscale":false, "codec":jpg}
 40    }
 41    }
 42    }
 43    ```
 44    ```json
 45    {
 46    "Buffer":{
 47    "Descriptor":"{"camera":1,"codec":"jpg","grayscale":false,"height":1560,"step":6312,"width":2104},
 48    "Index":1,
 49    "Size":847726,
 50    "Task":{
 51    "Index":1,
 52    "Type":"CaptureImage",
 53    "Input":{"selection":{0,1}, "grayscale":false, "codec":jpg}
 54    }
 55    }
 56    }
 57    ```
 58
 59    > Response example:
 60
 61    ```json
 62    {
 63    "Task":{
 64    "Index":1,
 65    "Type":"CaptureImage"
 66    "Input":{
 67    "selection":{0,1},
 68    "grayscale":false,
 69    "codec":jpg
 70    }
 71    "Output":[
 72    {"camera":0,"codec":"jpg","grayscale":false,"height":1560,"step":6312,"width":2104},
 73    {"camera":1,"codec":"jpg","grayscale":false,"height":1560,"step":6312,"width":2104}
 74    ],
 75    "State":"Completed"
 76    }
 77    }
 78    ```
 79    """
 80    class Request:
 81
 82        """
 83         Client request for the `CaptureImage` task.
 84        """
 85        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CaptureImage_CaptureImage):
 86            # A unique identifier generated by the client.
 87            self.Index = Index
 88            # "CaptureImage"
 89            self.Type = Type
 90            # The Image settings
 91            self.Input = Input
 92
 93    class Response:
 94
 95        """
 96         Server response for the `CaptureImage` task.
 97        """
 98        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CaptureImage_CaptureImage, Output: List[MF_V3_Descriptors_CaptureImage_CaptureImage] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
 99            # The unique identifier generated by the client.
100            self.Index = Index
101            # "CaptureImage"
102            self.Type = Type
103            # Requested capture image settings.s
104            self.Input = Input
105            # A capture image descriptors for each selected camera.
106            self.Output = Output
107            # The current state of the task.
108            self.State = State
109            # A string describing the error if the task has failed.
110            self.Error = Error
111
112    class Buffer:
113
114        """
115         Server buffer message for the `CaptureImage` task.
116        """
117        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: MF_V3_Descriptors_CaptureImage_CaptureImage):
118            # The zero-based index identifying the data buffer.
119            self.Index = Index
120            # The size of the incoming data buffer in bytes.
121            self.Size = Size
122            # The requested CaptureImage task.
123            self.Task = Task
124            # The capture image descriptor.
125            self.Descriptor = Descriptor
126
127    def __init__(self):
128        pass

* Capture an image from one or both cameras.

Request example:

{
"Task":{
"Index":1,
"Type":"CaptureImage"
"Input":{
"selection":{0,1},
"grayscale":false,
"codec":jpg
}
}
}

Buffer messages from server.

{
"Buffer":{
"Descriptor":"{"camera":0,"codec":"jpg","grayscale":false,"height":1560,"step":6312,"width":2104},
"Index":0,
"Size":856664,
"Task":{
"Index":1,
"Type":"CaptureImage",
"Input":{"selection":{0,1}, "grayscale":false, "codec":jpg}
}
}
}

{
"Buffer":{
"Descriptor":"{"camera":1,"codec":"jpg","grayscale":false,"height":1560,"step":6312,"width":2104},
"Index":1,
"Size":847726,
"Task":{
"Index":1,
"Type":"CaptureImage",
"Input":{"selection":{0,1}, "grayscale":false, "codec":jpg}
}
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"CaptureImage"
"Input":{
"selection":{0,1},
"grayscale":false,
"codec":jpg
}
"Output":[
{"camera":0,"codec":"jpg","grayscale":false,"height":1560,"step":6312,"width":2104},
{"camera":1,"codec":"jpg","grayscale":false,"height":1560,"step":6312,"width":2104}
],
"State":"Completed"
}
}
class CaptureImage.Request: 
80    class Request:
81
82        """
83         Client request for the `CaptureImage` task.
84        """
85        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CaptureImage_CaptureImage):
86            # A unique identifier generated by the client.
87            self.Index = Index
88            # "CaptureImage"
89            self.Type = Type
90            # The Image settings
91            self.Input = Input

Client request for the CaptureImage task.

CaptureImage.Request( Index: int, Type: str, Input: MF.V3.Settings.CaptureImage.CaptureImage) 
85        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CaptureImage_CaptureImage):
86            # A unique identifier generated by the client.
87            self.Index = Index
88            # "CaptureImage"
89            self.Type = Type
90            # The Image settings
91            self.Input = Input
Index
Type
Input
class CaptureImage.Response: 
 93    class Response:
 94
 95        """
 96         Server response for the `CaptureImage` task.
 97        """
 98        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CaptureImage_CaptureImage, Output: List[MF_V3_Descriptors_CaptureImage_CaptureImage] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
 99            # The unique identifier generated by the client.
100            self.Index = Index
101            # "CaptureImage"
102            self.Type = Type
103            # Requested capture image settings.s
104            self.Input = Input
105            # A capture image descriptors for each selected camera.
106            self.Output = Output
107            # The current state of the task.
108            self.State = State
109            # A string describing the error if the task has failed.
110            self.Error = Error

Server response for the CaptureImage task.

CaptureImage.Response( Index: int, Type: str, Input: MF.V3.Settings.CaptureImage.CaptureImage, Output: List[MF.V3.Descriptors.CaptureImage.CaptureImage] = None, State: MF.V3.Task.TaskState = None, Error: str = None) 
 98        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_CaptureImage_CaptureImage, Output: List[MF_V3_Descriptors_CaptureImage_CaptureImage] = None, State: MF_V3_Task_TaskState = None, Error: str = None):
 99            # The unique identifier generated by the client.
100            self.Index = Index
101            # "CaptureImage"
102            self.Type = Type
103            # Requested capture image settings.s
104            self.Input = Input
105            # A capture image descriptors for each selected camera.
106            self.Output = Output
107            # The current state of the task.
108            self.State = State
109            # A string describing the error if the task has failed.
110            self.Error = Error
Index
Type
Input
Output
State
Error
class CaptureImage.Buffer: 
112    class Buffer:
113
114        """
115         Server buffer message for the `CaptureImage` task.
116        """
117        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: MF_V3_Descriptors_CaptureImage_CaptureImage):
118            # The zero-based index identifying the data buffer.
119            self.Index = Index
120            # The size of the incoming data buffer in bytes.
121            self.Size = Size
122            # The requested CaptureImage task.
123            self.Task = Task
124            # The capture image descriptor.
125            self.Descriptor = Descriptor

Server buffer message for the CaptureImage task.

CaptureImage.Buffer( Index: int, Size: int, Task: MF.V3.Task.Task, Descriptor: MF.V3.Descriptors.CaptureImage.CaptureImage) 
117        def __init__(self, Index: int, Size: int, Task: MF_V3_Task_Task, Descriptor: MF_V3_Descriptors_CaptureImage_CaptureImage):
118            # The zero-based index identifying the data buffer.
119            self.Index = Index
120            # The size of the incoming data buffer in bytes.
121            self.Size = Size
122            # The requested CaptureImage task.
123            self.Task = Task
124            # The capture image descriptor.
125            self.Descriptor = Descriptor
Index
Size
Task
Descriptor