Skip to content

Commit aadd148

Browse files
Comments for options of PullAudioWorkletProcessor
1 parent 1085fe7 commit aadd148

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

src/KristofferStrube.Blazor.WebAudio/AudioWorklet/AudioWorkletProcessors/PullAudioWorkletProcessor.Options.cs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,29 @@
22

33
public partial class PullAudioWorkletProcessor
44
{
5+
/// <summary>
6+
/// Options for creating <see cref="PullAudioWorkletProcessor"/>.
7+
/// </summary>
58
public class Options
69
{
10+
/// <summary>
11+
/// Low tide for when the processor should request more chunks.
12+
/// </summary>
713
public int LowTide { get; set; } = 10;
14+
15+
/// <summary>
16+
/// High tide for when the processor should begin discarding chunks.
17+
/// </summary>
818
public int HighTide { get; set; } = 50;
19+
20+
/// <summary>
21+
/// Size of each individual chunk.
22+
/// </summary>
923
public int BufferRequestSize { get; set; } = 10;
24+
25+
/// <summary>
26+
/// Resolution used for transfering chunks.
27+
/// </summary>
1028
public Resolution Resolution { get; set; } = Resolution.Double;
1129

1230
/// <summary>

0 commit comments

Comments
 (0)