Skip to content
This repository was archived by the owner on Nov 14, 2023. It is now read-only.

Commit d2ec271

Browse files
committed
Update README.md
1 parent 839e96b commit d2ec271

File tree

1 file changed

+23
-5
lines changed

1 file changed

+23
-5
lines changed

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -208,17 +208,35 @@ Always do this. It is sometimes critically important to disconnect the camera wh
208208
def capture_screenshot(self, kwargs):
209209
def capture_video(self, kwargs): # Android only
210210
def stop_capture_video(self): # Android only
211-
```
212-
Optional arguments:
211+
```
212+
213+
Captures are saved to '<location>/<date>/<time>.jpg' or '.mp4'.
214+
215+
The default values are as follows. On a desktop <location> is '.', on Android <location> is 'DCIM/<appname>'. The value of <date> is the current date, the format is 'YYYY_MM_DD'. The value of <time> is the current time, the format is 'hh_mm_ss_xx' (xx is 1/100 sec).
216+
217+
The [filepath_callback](https://github.com/Android-for-Python/Camera4Kivy#filepath_callback) reports the actual path for a particular capture.
218+
219+
Be aware that on Android >= 10 shared storage files are saved in a database, called MediaStore, and not in a file system. The characteristics of Android storage are outside the scope of this document.
220+
221+
The values of <location>, <date>, <time> can be modified with optional keyword arguments:
213222

214223
##### location :
215-
A directory that must exist. Default '.' except on Android where can be 'shared' (default) or 'private'.
224+
225+
The value replaces <location>.
226+
227+
On a desktop the value is directory that must exist.
228+
229+
On Android the value can only be 'shared' or 'private', other values are ignored. The value 'shared' specifies Android shared storage 'DCIM/<appname>' (this is also the default). The value 'private' specifies app local storage 'app_storage_path()/DCIM'. If you want a different location use 'private' and move the resulting file based on the path provided by filepath_callback.
216230

217231
##### subdir
218-
A single directory that will be created. Default value is the date.
232+
233+
The value replaces <date>, the subdirectory will be created.
219234

220235
##### name
221-
The file name, default value is the time and '.jpg' or '.mp4'
236+
237+
The value replaces <time>, the '.jpg' or '.mp4' extensions will be added automatically.
238+
239+
Note that it is a characteristic of Android >= 10 shared storage that a second capture with a same subdir and name values as the first, will not overwrite the first. It will create a second file named '<subdir>/<name> (1).jpg', the name is created by Android MediaStore. The MediaStore may crash if it creates too many (31 ?) such names.
222240

223241
#### Select Camera
224242

0 commit comments

Comments
 (0)