Skip to content

Commit 9343745

Browse files
Update README.md
1 parent 267d48a commit 9343745

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,14 +85,15 @@ The `MicroscopeClient` object has a few basic methods. If you created an instan
8585
|`microscope.grab_image()` | |A `[image_height x image_width x 3] uint8 array` | Gets the next image the camera sends in its MJPEG preview stream.|
8686
|`microscope.calibrate_xy()`| | | Untested.|
8787
|`microscope.autofocus()` | | | Runs the fast autofocus routine. |
88-
|`microscope.record_video()`| `format` : video format (`h264` and `mjpeg` tested) (default: h264) <br/> `framerate` : video framerate (fps) (default: 30) <br/> `length` : length of video (seconds) (default: 1)<br/>`save locally` : Logical on whether to save video locally (default: true) <br/> `save_location`: The directory in which to save the video (filename is the timestamped one generated by the microscope) (default: current working directory) | The location (either locally or on the microscope) where the video has been saved| Records a video using the [video extension](https://gitlab.com/openflexure/microscope-extensions/openflexure-videoplugin)
88+
|`microscope.record_video(format, framerate, length, save_locally, save_location)`| `format`: video format (`h264` and `mjpeg` tested) (default: h264)<br/>`framerate`: video framerate (fps) (default: 30)<br/>`length`: length of video (seconds) (default: 1)<br/>`save_locally`: Logical on whether to save video locally (default: true) <br/>`save_location`: The directory in which to save the video (filename is the timestamped one generated by the microscope) (default: current working directory) | The location (either locally or on the microscope) where the video has been saved| Records a video using the [video extension](https://gitlab.com/openflexure/microscope-extensions/openflexure-videoplugin).|
89+
|`microscope.preview()` | | |Launches a preview window displaying a live video feed from the microscope.|
8990

9091

9192
## Extensions
9293

9394
To run methods provided by the microscope extensions, you can use the `extensions` `struct` to make `get` or `post` requests.
9495

95-
**However**, due to MATLAB struct limitation, you need to replace any `.` in your extension name to `_DOT_` and any `-` to `_DASH`. For example, the extension `org.openflexure.autofocus` should be written as `org_DOT_openflexure_DOT_autofocus`.
96+
**However**, due to MATLAB struct limitation, you need to replace any `.` in your extension name to `_DOT_` and any `-` to `_DASH_`. For example, the extension `org.openflexure.autofocus` should be written as `org_DOT_openflexure_DOT_autofocus`.
9697

9798
For a post request, `data` can be a `struct`, `character vector`, `numeric`, `cell` etc. The full list of supported types for post requests is in the [MATLAB documentation](https://uk.mathworks.com/help/matlab/ref/webwrite.html#buocgv5-data), but they have not all been tested.
9899

0 commit comments

Comments
 (0)