Pipeline
High-level operations shared by the CLI and the TUI.
delete_recording(vault, rec, cfg)
¶
Delete a recording's files and remove it from the index.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
vault
|
Vault
|
The vault. |
required |
rec
|
Recording
|
The recording. |
required |
cfg
|
dict
|
The configuration. |
required |
Source code in src/murmurvault/pipeline.py
130 131 132 133 134 135 136 137 138 139 140 141 142 143 | |
import_file(vault, src, title='', folder='', tags=None)
¶
Import an audio or video file as a new recording.
The original file is kept as original.<ext> next to a 16 kHz FLAC track used for processing.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
vault
|
Vault
|
The vault. |
required |
src
|
Path
|
File to import. |
required |
title
|
str
|
Title; defaults to the file name. |
''
|
folder
|
str
|
Destination folder. |
''
|
tags
|
list[str] | None
|
Tags to apply. |
None
|
Returns:
| Type | Description |
|---|---|
Recording
|
The new recording, not yet transcribed. |
Source code in src/murmurvault/pipeline.py
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 | |
reindex_recording(vault, rec, cfg, transcript=None)
¶
Update the search index for one recording.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
vault
|
Vault
|
The vault. |
required |
rec
|
Recording
|
The recording. |
required |
cfg
|
dict
|
The configuration. |
required |
transcript
|
Transcript | None
|
Transcript to index; defaults to the active one. |
None
|
Returns:
| Type | Description |
|---|---|
int
|
Number of chunks indexed. |
Source code in src/murmurvault/pipeline.py
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | |
to_srt(transcript)
¶
Render a transcript as SubRip subtitles.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
transcript
|
Transcript
|
The transcript. |
required |
Returns:
| Type | Description |
|---|---|
str
|
SRT text. |
Source code in src/murmurvault/pipeline.py
146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 | |
transcribe_recording(vault, rec, cfg, *, engine=None, model=None, language=None, diarization=None, progress=_noop)
¶
Run an accurate transcription pass over every track, save it as the active transcript and index it.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
vault
|
Vault
|
The vault. |
required |
rec
|
Recording
|
The recording. |
required |
cfg
|
dict
|
The configuration. |
required |
engine
|
str | None
|
Engine name; defaults to |
None
|
model
|
str | None
|
Override the engine's model. |
None
|
language
|
str | None
|
Language code; defaults to |
None
|
diarization
|
bool | None
|
Split non-microphone tracks by speaker; defaults to |
None
|
progress
|
Progress
|
Called with short status messages. |
_noop
|
Returns:
| Type | Description |
|---|---|
Transcript
|
The transcript, with segments from all tracks merged in time order. |
Source code in src/murmurvault/pipeline.py
55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 | |