File: protocols.md

package info (click to toggle)
liquidsoap 2.1.3-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 12,924 kB
  • sloc: ml: 73,577; javascript: 24,836; sh: 3,440; makefile: 764; xml: 114; ansic: 96; lisp: 62; python: 35; perl: 8; ruby: 8
file content (108 lines) | stat: -rw-r--r-- 2,394 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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
53
54
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
### ANNOTATE

Add metadata to a request

The syntax is `annotate:key="val",key2="val2",...:uri`.

### FFMPEG

Decode any file to wave using ffmpeg

The syntax is `ffmpeg:uri`.

### FILE

File protocol. Only local files are supported

The syntax is `file:///path/to/file`. This protocol is static.

### GTTS

Generate speech synthesis using Google translate's text-to-speech API. This requires the `gtts-cli` binary.  Result may be mono.

The syntax is `gtts:Text to read`. This protocol is static.

### HTTP

Download http URLs using curl

The syntax is `http://...`.

### HTTPS

Download http URLs using curl

The syntax is `https://...`.

### MPD

Finds all files with a tag equal to a given value using mpd.

The syntax is `mpd:tag=value`.

### POLLY

Generate speech synthesis using AWS polly service. Result might be mono, needs aws binary in the path.

The syntax is `polly:Text to read`. This protocol is static.

### PROCESS

Resolve a request using an arbitrary process. `<cmd>` is interpolated with: `[("input",<input>),("output",<output>),("colon",":")]`. `uri` is an optional child request, `<output>` is the name of a fresh temporary file and has extension `.<extname>`. `<input>` is an optional input file name as returned while resolving `uri`.

The syntax is `process:<extname>,<cmd>[:uri]`.

### REPLAYGAIN

Compute ReplayGain value using the extract-replaygain script. Adds returned value as `"replaygain_track_gain"` metadata

The syntax is `replaygain:uri`.

### S3

Fetch files from s3 using the AWS CLI

The syntax is `s3://uri`.

### SAY

Generate speech synthesis using text2wave. Result is always stereo.

The syntax is `say:Text to read`. This protocol is static.

### STEREO

Convert a file to stereo (currently decodes to wav).

The syntax is `stereo:<uri>`. This protocol is static.

### SYNTH

Syntesize audio. Parameters are optional.

The syntax is `synth:shape=sine,frequency=440.,duration=10.`. This protocol is static.

### TEXT2WAVE

Generate speech synthesis using text2wave. Result may be mono.

The syntax is `text2wave:Text to read`. This protocol is static.

### TMP

Mark the given uri as temporary. Useful when chaining protocols

The syntax is `tmp:uri`.

### YOUTUBE-DL

Resolve a request using youtube-dl.

The syntax is `youtube-dl:uri`.

### YOUTUBE-PL

Resolve a request as a youtube playlist using youtube-dl.

The syntax is `youtube-pl:uri`.