update README

This commit is contained in:
Yi Ge 2019-05-01 05:43:59 +02:00 committed by GitHub
parent eb29dd4d90
commit c63e508623
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 6 deletions

View File

@ -67,18 +67,18 @@ The OCR process runs in parallel and is CPU intensive. It takes 3 minutes on my
## API
```python
videocr.get_subtitles(
video_path: str, lang='eng', time_start='0:00', time_end='',
conf_threshold=65, sim_threshold=90, use_fullframe=False)
get_subtitles(
video_path: str, lang='eng', time_start='0:00', time_end='',
conf_threshold=65, sim_threshold=90, use_fullframe=False)
```
Return the subtitles string in SRT format.
```python
videocr.save_subtitles_to_file(
video_path: str, file_path='subtitle.srt', lang='eng', time_start='0:00',
time_end='', conf_threshold=65, sim_threshold=90, use_fullframe=False)
save_subtitles_to_file(
video_path: str, file_path='subtitle.srt', lang='eng', time_start='0:00', time_end='',
conf_threshold=65, sim_threshold=90, use_fullframe=False)
```
Write subtitles to `file_path`. If the file does not exist, it will be created automatically.