package liquidsoap-lang

  1. Overview
  2. Docs
package liquidsoap-lang
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module Doc.ValueSource

Documenentation for values.

Sourcetype flag = [
  1. | `Hidden
  2. | `Deprecated
  3. | `Experimental
  4. | `Extra
]

Documentation flags.

Sourceval string_of_flag : flag -> string
Sourceval flag_of_string : string -> [> `Deprecated | `Experimental | `Extra | `Hidden ] option
Sourcetype source = [
  1. | `Input
  2. | `Output
  3. | `Conversion
  4. | `FFmpegFilter
  5. | `Track
  6. | `Audio
  7. | `Video
  8. | `MIDI
  9. | `Visualization
  10. | `Synthesis
  11. | `Testing
  12. | `Fade
  13. | `Liquidsoap
]

Kind of source.

Sourcetype category = [
  1. | `Source of source
  2. | `Track of source
  3. | `System
  4. | `File
  5. | `Math
  6. | `String
  7. | `List
  8. | `Bool
  9. | `Getter
  10. | `Time
  11. | `Liquidsoap
  12. | `Metadata
  13. | `Programming
  14. | `Interaction
  15. | `Internet
  16. | `Configuration
  17. | `Settings
  18. | `None
]
Sourceval categories : (category * string) list
Sourceval string_of_category : category -> string
Sourceval category_of_string : string -> category option
Sourcetype argument = {
  1. arg_type : string;
  2. arg_default : string option;
    (*

    default value

    *)
  3. arg_description : string option;
}
Sourcetype meth = {
  1. meth_type : string;
  2. meth_description : string option;
}
Sourcetype t = {
  1. typ : string;
  2. category : category;
  3. flags : flag list;
  4. description : string;
  5. examples : string list;
  6. arguments : (string option * argument) list;
  7. methods : (string * meth) list;
}

Documentation for a function.

Sourceval add : string -> t Lazy.t -> unit
Sourceval get : Map.key -> t
Sourceval print_functions : (Map.key -> unit) -> unit

Only print function names.

Sourceval print_functions_by_category : (string -> unit) -> unit
Sourceval colorize : Console.text_style list -> string -> string
Sourceval title_color : string -> string
Sourceval type_color : string -> string
Sourceval default_color : string -> string
Sourceval label_color : string -> string
Sourceval print : Map.key -> (string -> unit) -> unit
Sourceval to_json : unit -> Json.t
Sourceval print_functions_md : ?extra:bool -> ?deprecated:bool -> (string -> unit) -> unit
Sourceval print_emacs_completions : (string -> unit) -> unit
OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct