three.MF.V3.Tasks.SetCameras

View Source

 1from MF.V3.Descriptors.Settings.Camera import Camera as MF_V3_Descriptors_Settings_Camera_Camera
 2from MF.V3.Settings.Camera import Camera as MF_V3_Settings_Camera_Camera
 3from MF.V3.Task import TaskState as MF_V3_Task_TaskState
 4
 5
 6class SetCameras:
 7    """*
 8    Apply camera settings to one or both cameras.
 9
10    > Request example:
11
12    ```json
13    {
14    "Task":{
15    "Index":1,
16    "Type":"SetCameras",
17    "Input":{
18    "analogGain":256,
19    "digitalGain":128,
20    "exposure":18000
21    },
22    }
23    }
24    ```
25
26    > Response example:
27
28    ```json
29    {
30    "Task":{
31    "Index":1,
32    "Type":"SetCameras"
33    "Input":{
34    "analogGain":256,
35    "digitalGain":512,
36    "exposure":18000
37    },
38    "Output":{
39    "analogGain":{"default":512.0,"max":1024.0,"min":256.0,"value":256.0},
40    "digitalGain":{"default":256,"max":65536,"min":256,"value":512},
41    "exposure":{"default":27000,"max":90000,"min":9000,"value":18000},
42    },
43    "State":"Completed"
44    }
45    }
46    ```
47    """
48    class Request:
49
50        """
51         Client request for the `SetCameras` task.
52        """
53        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Camera_Camera = None):
54            # A unique identifier generated by the client.
55            self.Index = Index
56            # "SetCameras"
57            self.Type = Type
58            # Camera settings.
59            self.Input = Input
60
61    class Response:
62
63        """
64         Server response for the `SetCameras` task.
65        """
66        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Camera_Camera = None, Output: MF_V3_Descriptors_Settings_Camera_Camera = None, State: MF_V3_Task_TaskState = None, Error: str = None):
67            # The unique identifier generated by the client.
68            self.Index = Index
69            # "SetCameras"
70            self.Type = Type
71            # Requested camera settings.
72            self.Input = Input
73            # Actual camera settings after applying the requested settings.
74            self.Output = Output
75            # The current state of the task.
76            self.State = State
77            # A string describing the error if the task has failed.
78            self.Error = Error
79
80    def __init__(self):
81        pass

class SetCameras: View Source

 7class SetCameras:
 8    """*
 9    Apply camera settings to one or both cameras.
10
11    > Request example:
12
13    ```json
14    {
15    "Task":{
16    "Index":1,
17    "Type":"SetCameras",
18    "Input":{
19    "analogGain":256,
20    "digitalGain":128,
21    "exposure":18000
22    },
23    }
24    }
25    ```
26
27    > Response example:
28
29    ```json
30    {
31    "Task":{
32    "Index":1,
33    "Type":"SetCameras"
34    "Input":{
35    "analogGain":256,
36    "digitalGain":512,
37    "exposure":18000
38    },
39    "Output":{
40    "analogGain":{"default":512.0,"max":1024.0,"min":256.0,"value":256.0},
41    "digitalGain":{"default":256,"max":65536,"min":256,"value":512},
42    "exposure":{"default":27000,"max":90000,"min":9000,"value":18000},
43    },
44    "State":"Completed"
45    }
46    }
47    ```
48    """
49    class Request:
50
51        """
52         Client request for the `SetCameras` task.
53        """
54        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Camera_Camera = None):
55            # A unique identifier generated by the client.
56            self.Index = Index
57            # "SetCameras"
58            self.Type = Type
59            # Camera settings.
60            self.Input = Input
61
62    class Response:
63
64        """
65         Server response for the `SetCameras` task.
66        """
67        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Camera_Camera = None, Output: MF_V3_Descriptors_Settings_Camera_Camera = None, State: MF_V3_Task_TaskState = None, Error: str = None):
68            # The unique identifier generated by the client.
69            self.Index = Index
70            # "SetCameras"
71            self.Type = Type
72            # Requested camera settings.
73            self.Input = Input
74            # Actual camera settings after applying the requested settings.
75            self.Output = Output
76            # The current state of the task.
77            self.State = State
78            # A string describing the error if the task has failed.
79            self.Error = Error
80
81    def __init__(self):
82        pass

* Apply camera settings to one or both cameras.

Request example:

{
"Task":{
"Index":1,
"Type":"SetCameras",
"Input":{
"analogGain":256,
"digitalGain":128,
"exposure":18000
},
}
}

Response example:

{
"Task":{
"Index":1,
"Type":"SetCameras"
"Input":{
"analogGain":256,
"digitalGain":512,
"exposure":18000
},
"Output":{
"analogGain":{"default":512.0,"max":1024.0,"min":256.0,"value":256.0},
"digitalGain":{"default":256,"max":65536,"min":256,"value":512},
"exposure":{"default":27000,"max":90000,"min":9000,"value":18000},
},
"State":"Completed"
}
}

class SetCameras.Request: View Source

49    class Request:
50
51        """
52         Client request for the `SetCameras` task.
53        """
54        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Camera_Camera = None):
55            # A unique identifier generated by the client.
56            self.Index = Index
57            # "SetCameras"
58            self.Type = Type
59            # Camera settings.
60            self.Input = Input

Client request for the SetCameras task.

SetCameras.Request(Index: int, Type: str, Input: MF.V3.Settings.Camera.Camera = None) View Source

54        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Camera_Camera = None):
55            # A unique identifier generated by the client.
56            self.Index = Index
57            # "SetCameras"
58            self.Type = Type
59            # Camera settings.
60            self.Input = Input

Index

Type

Input

class SetCameras.Response: View Source

62    class Response:
63
64        """
65         Server response for the `SetCameras` task.
66        """
67        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Camera_Camera = None, Output: MF_V3_Descriptors_Settings_Camera_Camera = None, State: MF_V3_Task_TaskState = None, Error: str = None):
68            # The unique identifier generated by the client.
69            self.Index = Index
70            # "SetCameras"
71            self.Type = Type
72            # Requested camera settings.
73            self.Input = Input
74            # Actual camera settings after applying the requested settings.
75            self.Output = Output
76            # The current state of the task.
77            self.State = State
78            # A string describing the error if the task has failed.
79            self.Error = Error

Server response for the SetCameras task.

SetCameras.Response( Index: int, Type: str, Input: MF.V3.Settings.Camera.Camera = None, Output: MF.V3.Descriptors.Settings.Camera.Camera = None, State: MF.V3.Task.TaskState = None, Error: str = None) View Source

67        def __init__(self, Index: int, Type: str, Input: MF_V3_Settings_Camera_Camera = None, Output: MF_V3_Descriptors_Settings_Camera_Camera = None, State: MF_V3_Task_TaskState = None, Error: str = None):
68            # The unique identifier generated by the client.
69            self.Index = Index
70            # "SetCameras"
71            self.Type = Type
72            # Requested camera settings.
73            self.Input = Input
74            # Actual camera settings after applying the requested settings.
75            self.Output = Output
76            # The current state of the task.
77            self.State = State
78            # A string describing the error if the task has failed.
79            self.Error = Error

Index

Type

Input

Output

State

Error