Skip to content

Commit 2daaa32

Browse files
committed
README.md: Fix incorrect formulas in documentation for metadata JSON file
Signed-off-by: Andrew Gunnerson <accounts+github@chiller3.com>
1 parent 70c1c4e commit 2daaa32

1 file changed

Lines changed: 17 additions & 16 deletions

File tree

‎README.md‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -242,26 +242,26 @@ The JSON structure is shown in the following example. Note that only `timestamp_
242242
"parameter_type": "bitrate",
243243
244244
// The encoder quality/size parameter.
245-
"parameter": 48000,
245+
"parameter": 48000
246246
},
247247
248248
// Details about the recording and encoding process. If the recording
249249
// process fails, this is set to null.
250250
"recording": {
251251
// The total number of audio frames that BCR read from the audio
252-
// device. This includes the periods of time when the recording was
253-
// paused or on hold.
254-
// (Number of frames == number of samples * channel count)
255-
"frames_total": 96000,
252+
// device. A frame is defined as a bundle of samples, with one
253+
// sample per channel. This value includes the periods of time where
254+
// the recording was paused or on hold.
255+
"frames_total": 40000,
256256
257257
// The number of audio frames that were actually saved to the output
258-
// file. This excludes the periods of time when the recording was
259-
// paused or on hold.
260-
// (Number of frames == number of samples * channel count)
261-
"frames_encoded": 48000,
258+
// file. A frame is defined as a bundle of samples, with one sample
259+
// per channel. This value excludes the periods of time where the
260+
// recording was paused or on hold.
261+
"frames_encoded": 32000,
262262
263263
// The number of samples per second of audio.
264-
"sample_rate": 48000,
264+
"sample_rate": 16000,
265265
266266
// The number of channels in the audio.
267267
"channel_count": 1,
@@ -272,21 +272,22 @@ The JSON structure is shown in the following example. Note that only `timestamp_
272272
"duration_secs_wall": 3.0,
273273
274274
// The total time in seconds that BCR read from the audio device.
275-
// (Equal to: frames_total / sample_rate / channel_count)
276-
"duration_secs_total": 2.0,
275+
// (Equal to: frames_total / sample_rate)
276+
"duration_secs_total": 2.5,
277277
278278
// The time in seconds of audio actually saved to the output file.
279-
// (Equal to: frames_encoded / sample_rate / channel_count)
280-
"duration_secs_encoded": 1.0,
279+
// (Equal to: frames_encoded / sample_rate)
280+
"duration_secs_encoded": 2.0,
281281
282282
// The size of the recording buffer in frames. This is the maximum
283283
// number of audio frames read from the audio driver before it is
284284
// passed to the audio encoder.
285-
"buffer_frames": 640,
285+
"buffer_frames": 3840,
286286
287287
// The number of buffer overruns. This is the number of times that
288288
// the CPU or storage couldn't keep up while encoding the raw audio,
289-
// resulting in skips (loss of audio).
289+
// resulting in skips (loss of audio). This value cannot be
290+
// calculated accurately and is just an estimate.
290291
"buffer_overruns": 0,
291292

292293
// Whether the call was ever paused by the user.

0 commit comments

Comments
 (0)