three.MF.V3.Tasks.StartVideo
1from MF.V3.Settings.Video import Video as MF_V3_Settings_Video_Video 2from MF.V3.Task import TaskState as MF_V3_Task_TaskState 3 4 5class StartVideo: 6 """* 7 Start the video stream. 8 9 The video frames are sent as task buffers associated with the reserved video task index -1. The left and right camera frames are sent in buffer 0 and 1, respectively. 10 11 > Request example: 12 13 ```json 14 { 15 "Task":{ 16 "Index":1, 17 "Type":"StartVideo" 18 } 19 } 20 ``` 21 22 > Response example: 23 24 ```json 25 { 26 "Task":{ 27 "Index":1, 28 "Type":"StartVideo", 29 "Output":{ 30 "codec":"JPEG", 31 "format":"YUV420", 32 "width":510, 33 "height":380 34 }, 35 "State":"Completed" 36 } 37 } 38 ``` 39 """ 40 class Request: 41 42 """ 43 Client request for the `StartVideo` task. 44 """ 45 def __init__(self, Index: int, Type: str): 46 # A unique identifier generated by the client. 47 self.Index = Index 48 # "StartVideo" 49 self.Type = Type 50 51 class Response: 52 53 """ 54 Server response for the `StartVideo` task. 55 """ 56 def __init__(self, Index: int, Type: str, Output: MF_V3_Settings_Video_Video = None, State: MF_V3_Task_TaskState = None, Error: str = None): 57 # The unique identifier generated by the client. 58 self.Index = Index 59 # "StartVideo" 60 self.Type = Type 61 # The video settings. 62 self.Output = Output 63 # The current state of the task. 64 self.State = State 65 # A string describing the error if the task has failed. 66 self.Error = Error 67 68 def __init__(self): 69 pass
class
StartVideo:
6class StartVideo: 7 """* 8 Start the video stream. 9 10 The video frames are sent as task buffers associated with the reserved video task index -1. The left and right camera frames are sent in buffer 0 and 1, respectively. 11 12 > Request example: 13 14 ```json 15 { 16 "Task":{ 17 "Index":1, 18 "Type":"StartVideo" 19 } 20 } 21 ``` 22 23 > Response example: 24 25 ```json 26 { 27 "Task":{ 28 "Index":1, 29 "Type":"StartVideo", 30 "Output":{ 31 "codec":"JPEG", 32 "format":"YUV420", 33 "width":510, 34 "height":380 35 }, 36 "State":"Completed" 37 } 38 } 39 ``` 40 """ 41 class Request: 42 43 """ 44 Client request for the `StartVideo` task. 45 """ 46 def __init__(self, Index: int, Type: str): 47 # A unique identifier generated by the client. 48 self.Index = Index 49 # "StartVideo" 50 self.Type = Type 51 52 class Response: 53 54 """ 55 Server response for the `StartVideo` task. 56 """ 57 def __init__(self, Index: int, Type: str, Output: MF_V3_Settings_Video_Video = None, State: MF_V3_Task_TaskState = None, Error: str = None): 58 # The unique identifier generated by the client. 59 self.Index = Index 60 # "StartVideo" 61 self.Type = Type 62 # The video settings. 63 self.Output = Output 64 # The current state of the task. 65 self.State = State 66 # A string describing the error if the task has failed. 67 self.Error = Error 68 69 def __init__(self): 70 pass
* Start the video stream.
The video frames are sent as task buffers associated with the reserved video task index -1. The left and right camera frames are sent in buffer 0 and 1, respectively.
Request example:
{
"Task":{
"Index":1,
"Type":"StartVideo"
}
}
Response example:
{
"Task":{
"Index":1,
"Type":"StartVideo",
"Output":{
"codec":"JPEG",
"format":"YUV420",
"width":510,
"height":380
},
"State":"Completed"
}
}
class
StartVideo.Request:
41 class Request: 42 43 """ 44 Client request for the `StartVideo` task. 45 """ 46 def __init__(self, Index: int, Type: str): 47 # A unique identifier generated by the client. 48 self.Index = Index 49 # "StartVideo" 50 self.Type = Type
Client request for the StartVideo
task.
class
StartVideo.Response:
52 class Response: 53 54 """ 55 Server response for the `StartVideo` task. 56 """ 57 def __init__(self, Index: int, Type: str, Output: MF_V3_Settings_Video_Video = None, State: MF_V3_Task_TaskState = None, Error: str = None): 58 # The unique identifier generated by the client. 59 self.Index = Index 60 # "StartVideo" 61 self.Type = Type 62 # The video settings. 63 self.Output = Output 64 # The current state of the task. 65 self.State = State 66 # A string describing the error if the task has failed. 67 self.Error = Error
Server response for the StartVideo
task.
StartVideo.Response( Index: int, Type: str, Output: MF.V3.Settings.Video.Video = None, State: MF.V3.Task.TaskState = None, Error: str = None)
57 def __init__(self, Index: int, Type: str, Output: MF_V3_Settings_Video_Video = None, State: MF_V3_Task_TaskState = None, Error: str = None): 58 # The unique identifier generated by the client. 59 self.Index = Index 60 # "StartVideo" 61 self.Type = Type 62 # The video settings. 63 self.Output = Output 64 # The current state of the task. 65 self.State = State 66 # A string describing the error if the task has failed. 67 self.Error = Error