Index of types


A
abr [Encoder.MP3]
application [Encoder.Opus]
audio [Ogg_muxer]
Audio data type
audio_t [Frame]
Audio data.

B
bitrate [Encoder.Opus]
bitrate [Encoder.Vorbis]
bitrate_control [Encoder.Theora]
bitrate_control [Encoder.Speex]
bitrate_control [Encoder.MP3]

C
category [Lang]
Category of an operator.
child [Switch]
clock_variable [Source]
clock_variable [Clock]
connection [Http]
A connection with an http server.
constr [Lang_types]
constraints [Lang_types]
constructed [Lang_types]
content [Frame]
Actual content of a frame.
content_kind [Frame]
Multiplicity of each field of a frame.
content_layer [Frame]
A content layer representation (see t.contents).
content_type [Frame]
Content type of a frame: number of channels for audio, video and MIDI.
converter [Video_converter]
~proportional src dst performs the conversion from frame src to frame dst.
converter [Audio_converter.Samplerate]
A converter takes a convertion ratio (output samplerate / input samplerate), an audio buffer, an offset in the buffer, a duration in the buffer and returns a resampled buffer.
converter_plug [Video_converter]
converter_plug [Audio_converter.Samplerate]

D
data [Ogg_muxer]
A data unit
data_encoder [Ogg_muxer]
A data encoder is an encoder for either a audio or a video track.
decoder [Decoder]
descr [Lang_types]
doc_flag [Lang]
Some flags that can be attached to operators.
dynload [Dyntools]

E
encoder [Encoder]
An encoder, once initialized, is something that consumes frames, insert metadata and that you eventually close (triggers flushing).
end_of_stream [Ogg_muxer]
Ends the track.
env [Lang_values.V]
env [Lang]
error [Http]
Error handling
explanation [Lang_types]
export_metadata [Encoder.Meta]

F
factory [Encoder]
fields [Frame]
A frame contains fields which hold audio, video and MIDI data.
file [Decoder]
A local file is simply identified by its filename.
file_decoder [Decoder]
A decoder is a filling function and a closing function, called at least when filling fails, i.e.
fisbone_packet [Ogg_muxer]
Returns an optional fisbone packet, which will contain the data for this stream to put in the ogg skeleton, if enabled in the encoder.
format [Encoder]
full_env [Lang_values.V]
full_env [Lang]

G
ground [Lang_types]

H
header_encoder [Ogg_muxer]
Returns the first page of the stream, to be placed at the very beginning.
headers [Http]
Type for headers data.

I
id3v2_export [Encoder.MP3]
in_term [Lang_values]
in_value [Lang_values.V]
in_value [Lang]
indicator [Request]
An indicator is a resource location (URI), when meaningful, it can be declared as temporary if liquidsoap should destroy it after usage (this means deleting a local file).
input [Decoder]
item [Encoder.Ogg]

L
lang_kind_format [Lang]
Description of how many of a channel type does an operator want.
lang_kind_formats [Lang]
let_t [Lang_values]
log [Request]

M
max_bandwidth [Encoder.Opus]
metadata [Request]
metadata [MFrame]
metadata [Frame]
Metadata of a frame.
metadata [AFrame]
midi_t [Frame]
MIDI data.
mode [Generator.From_audio_video_plus]
Same as From_audio_video.
mode [Generator.From_audio_video]
In `Audio mode, only audio can be put in the buffer, and similarly for the `Video mode.
mode [Encoder.Speex]
mode [Encoder.Opus]
mode [Encoder.Vorbis]
multiplicity [Frame]
Multiplicity of a field, used in types to impose constraints on channels (empty, variable, at least k, etc.).

N
namespace [Server]
Namespaces are used to avoid name conflicts.

O
overfull [Generator.From_audio_video_plus]
How to handle overfull buffers: drop old data, keeping at most len ticks.

P
page_end_time [Ogg_muxer]
Type for a function returning a page's ending time.
playlist [Playlist_parser]
A playlist is list of metadatas,uri
plugin [Playlist_parser]
A plugin is a boolean and a parsing function
plugin [Encoder]
A plugin might or might not accept a given format.
pos [Lang_types]
position [Ogg_muxer]
Return the end time of a page, in milliseconds.
priority [Tutils]
Priorities for the different scheduler usages.
proto [Lang]
protocol [Request]

Q
quality [Encoder.Vorbis]

R
read_ops [Wav]
request [Http]
Type for full Http request.
resolve_flag [Request]
Resolving can fail because an URI is invalid, or doesn't refer to a valid audio file, or simply because there was no enough time left.
restart_condition [Encoder.External]

S
signal [Encoder.Opus]
source_t [Source]
The liveness type of a source indicates whether or not it can fail to broadcast.
state [Ogg_muxer]
You may register new tracks on state Eos or Bos.
status [Http]
Status of a request: version of the HTTP protocol, status number and status message.
stereo_mode [Encoder.MP3]
stream [Decoder]
A stream is identified by a MIME type.
stream_decoder [Decoder]
A stream decoder does not "own" any file descriptor, and is generally assumed to not allocate resources (in the sense of things that should be explicitly managed, not just garbage collected).
stream_encoder [Ogg_muxer]
The full stream encoder type.
stream_start [Ogg_muxer]
Returns the remaining header data, before data encoding starts.

T
t [Wav]
t [VFrame]
t [Request]
Type of requests, which are devices for obtaining a local file from an URI.
t [Ogg_muxer]
Main type for the ogg encoder
t [MFrame]
t [Lang_types]
Every type gets a level annotation.
t [Lang]
The type of a value.
t [Generator.S_Asio]
t [Generator.S]
t [Generator.From_audio_video_plus]
t [Generator.From_audio_video]
t [Generator.From_frames]
t [Generator.Generator]
All positions and lengths are in ticks.
t [Frame]
A frame.
t [Encoder.Ogg]
t [Encoder.Dirac]
t [Encoder.Theora]
t [Encoder.GStreamer]
t [Encoder.Speex]
t [Encoder.External]
t [Encoder.VoAacEnc]
t [Encoder.AACPlus]
t [Encoder.Shine]
t [Encoder.Flac]
t [Encoder.MP3]
t [Encoder.Opus]
t [Encoder.Vorbis]
t [Encoder.WAV]
t [Audio_converter.Samplerate]
t [AFrame]
term [Lang_values]
track_data [Ogg_muxer]
A track data is a data unit of either audio or video.
track_encoder [Ogg_muxer]
A track encoder takes the track data, the ogg logical stream, and fills the stream.
track_mode [Switch]
The switch can either happen at any time in the stream (insensitive) or only at track limits (sensitive).
transition [Switch]

V
value [Lang_values.V]
value [Lang]
A typed value.
variance [Lang_types]
video [Ogg_muxer]
Video data type
video_t [Frame]
Video data.