Guest User

Untitled

a guest
Jun 7th, 2015
381
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
  1. # /usr/local/bin/liquidsoap --list-plugins
  2. All the plugs
  3. + audio file formats (duration)
  4. Methods to extract duration from a file.
  5. + FLAC
  6. (no doc)
  7. + FLAC
  8. (no doc)
  9. + MAD
  10. (no doc)
  11. + OGG/FLAC
  12. (no doc)
  13. + VORBIS
  14. (no doc)
  15. + WAV
  16. (no doc)
  17. + file decoding
  18. File decoding methods.
  19. + FLAC
  20. Use libflac to decode any file if its MIME type or file extension is appropriate.
  21. + IMAGE
  22. Decoder for static images.
  23. + MAD
  24. Use libmad to decode any file if its MIME type or file extension is appropriate.
  25. + META
  26. (no doc)
  27. + MIDI
  28. (no doc)
  29. + OGG
  30. Decode a file as OGG provided that libogg accepts it.
  31. + WAV
  32. Decode as WAV any file with a correct header.
  33. + image file decoding
  34. Image file decoding methods.
  35. + PPM
  36. Native decoding of PPM images.
  37. + metadata formats
  38. Methods to extract metadata from a file.
  39. + FLAC
  40. (no doc)
  41. + OGG
  42. (no doc)
  43. + TAGLIB
  44. (no doc)
  45. + playlist formats
  46. Method to parse playlist.
  47. + application/x-cue
  48. (no doc)
  49. + application/x-mpegURL
  50. (no doc)
  51. + audio/mpegurl
  52. (no doc)
  53. + audio/x-mpegurl
  54. (no doc)
  55. + audio/x-scpls
  56. (no doc)
  57. + protocols
  58. Methods to get a file. They are the first part of URIs: 'protocol:args'.
  59. + ANNOTATE
  60. [annotate:key="val",key2="val2",...:uri] adds the metadata to the request and is then resolved into uri
  61. + FTP
  62. Fetch files using "/usr/bin/wget".
  63. + HTTP
  64. Fetch files using "/usr/bin/wget".
  65. + HTTPS
  66. Fetch files using "/usr/bin/wget".
  67. + MPD
  68. [mpd:tag="value"] finds all files with a tag equal to a given value using mpd.
  69. + REPLAY_GAIN
  70. (no doc)
  71. + SAY
  72. Speech synthesis, with optional voice choice using say:voice/blah.
  73. + TIME
  74. Speech synthesis of a message where $(time) is replaced by the current time
  75. + samplerate converters
  76. Methods for converting samplerate.
  77. + libsamplerate
  78. (no doc)
  79. + native
  80. (no doc)
  81. + scripting values
  82. scripting values
  83. + !=
  84. Comparison of comparable values.
  85. + _category
  86. Bool
  87. + _type
  88. ('a,'a)->bool where 'a is an orderable type
  89. + (unlabeled)
  90. (no doc)
  91. + default
  92. None
  93. + type
  94. anything that is an orderable type
  95. + (unlabeled)
  96. (no doc)
  97. + default
  98. None
  99. + type
  100. anything that is an orderable type
  101. + %
  102. <code>pattern % [...,(k,v),...]</code> changes in the pattern occurences of:
  103. - <code>$(k)</code> into <code>v</code>;
  104. - <code>$(if $(k2),"a","b")</code> into "a" if k2 is found in the list, "b" otherwise.
  105. + _category
  106. String
  107. + _type
  108. (string,[(string*string)])->string
  109. + (unlabeled)
  110. (no doc)
  111. + default
  112. None
  113. + type
  114. string
  115. + (unlabeled)
  116. (no doc)
  117. + default
  118. None
  119. + type
  120. [(string*string)]
  121. + *
  122. Multiplication of numbers.
  123. + _category
  124. Math
  125. + _type
  126. ('a,'a)->'a where 'a is a number type
  127. + (unlabeled)
  128. (no doc)
  129. + default
  130. None
  131. + type
  132. anything that is a number type
  133. + (unlabeled)
  134. (no doc)
  135. + default
  136. None
  137. + type
  138. anything that is a number type
  139. + +
  140. Addition of numbers.
  141. + _category
  142. Math
  143. + _type
  144. ('a,'a)->'a where 'a is a number type
  145. + (unlabeled)
  146. (no doc)
  147. + default
  148. None
  149. + type
  150. anything that is a number type
  151. + (unlabeled)
  152. (no doc)
  153. + default
  154. None
  155. + type
  156. anything that is a number type
  157. + -
  158. Substraction of numbers.
  159. + _category
  160. Math
  161. + _type
  162. ('a,'a)->'a where 'a is a number type
  163. + (unlabeled)
  164. (no doc)
  165. + default
  166. None
  167. + type
  168. anything that is a number type
  169. + (unlabeled)
  170. (no doc)
  171. + default
  172. None
  173. + type
  174. anything that is a number type
  175. + /
  176. Division of numbers.
  177. + _category
  178. Math
  179. + _type
  180. ('a,'a)->'a where 'a is a number type
  181. + (unlabeled)
  182. (no doc)
  183. + default
  184. None
  185. + type
  186. anything that is a number type
  187. + (unlabeled)
  188. (no doc)
  189. + default
  190. None
  191. + type
  192. anything that is a number type
  193. + <
  194. Comparison of comparable values.
  195. + _category
  196. Bool
  197. + _type
  198. ('a,'a)->bool where 'a is an orderable type
  199. + (unlabeled)
  200. (no doc)
  201. + default
  202. None
  203. + type
  204. anything that is an orderable type
  205. + (unlabeled)
  206. (no doc)
  207. + default
  208. None
  209. + type
  210. anything that is an orderable type
  211. + <=
  212. Comparison of comparable values.
  213. + _category
  214. Bool
  215. + _type
  216. ('a,'a)->bool where 'a is an orderable type
  217. + (unlabeled)
  218. (no doc)
  219. + default
  220. None
  221. + type
  222. anything that is an orderable type
  223. + (unlabeled)
  224. (no doc)
  225. + default
  226. None
  227. + type
  228. anything that is an orderable type
  229. + ==
  230. Comparison of comparable values.
  231. + _category
  232. Bool
  233. + _type
  234. ('a,'a)->bool where 'a is an orderable type
  235. + (unlabeled)
  236. (no doc)
  237. + default
  238. None
  239. + type
  240. anything that is an orderable type
  241. + (unlabeled)
  242. (no doc)
  243. + default
  244. None
  245. + type
  246. anything that is an orderable type
  247. + >
  248. Comparison of comparable values.
  249. + _category
  250. Bool
  251. + _type
  252. ('a,'a)->bool where 'a is an orderable type
  253. + (unlabeled)
  254. (no doc)
  255. + default
  256. None
  257. + type
  258. anything that is an orderable type
  259. + (unlabeled)
  260. (no doc)
  261. + default
  262. None
  263. + type
  264. anything that is an orderable type
  265. + >=
  266. Comparison of comparable values.
  267. + _category
  268. Bool
  269. + _type
  270. ('a,'a)->bool where 'a is an orderable type
  271. + (unlabeled)
  272. (no doc)
  273. + default
  274. None
  275. + type
  276. anything that is an orderable type
  277. + (unlabeled)
  278. (no doc)
  279. + default
  280. None
  281. + type
  282. anything that is an orderable type
  283. + ^
  284. Concatenate strings.
  285. + _category
  286. String
  287. + _type
  288. (string,string)->string
  289. + (unlabeled)
  290. (no doc)
  291. + default
  292. None
  293. + type
  294. string
  295. + (unlabeled)
  296. (no doc)
  297. + default
  298. None
  299. + type
  300. string
  301. + _[_]
  302. l[k] returns the first v such that (k,v) is in the list l (or "" if no such v exists).
  303. + _category
  304. List
  305. + _type
  306. (string,[(string*string)])->string
  307. + (unlabeled)
  308. (no doc)
  309. + default
  310. None
  311. + type
  312. string
  313. + (unlabeled)
  314. (no doc)
  315. + default
  316. None
  317. + type
  318. [(string*string)]
  319. + abs
  320. Absolute value.
  321. + _category
  322. Math
  323. + _type
  324. ('a)->'a where 'a is a number type
  325. + (unlabeled)
  326. (no doc)
  327. + default
  328. None
  329. + type
  330. anything that is a number type
  331. + add
  332. Mix sources, with optional normalization. Only relay metadata from the first source that is effectively summed.
  333. + _category
  334. Source / Sound Processing
  335. + _type
  336. (?id:string,?normalize:bool,?weights:[int],
  337. [source(audio='#a,video='#b,midi=0)])->
  338. source(audio='#a,video='#b,midi=0)
  339. + id
  340. Force the value of the source ID.
  341. + default
  342. ""
  343. + type
  344. string
  345. + normalize
  346. (no doc)
  347. + default
  348. true
  349. + type
  350. bool
  351. + weights
  352. Relative weight of the sources in the sum. The empty list stands for the homogeneous distribution.
  353. + default
  354. []
  355. + type
  356. [int]
  357. + (unlabeled)
  358. (no doc)
  359. + default
  360. None
  361. + type
  362. [source(audio='#a,video='#b,midi=0)]
  363. + add_decoder
  364. Register an external decoder. The encoder should output in WAV format to his standard output (stdout) and read data from its standard input (stdin).
  365. + _category
  366. Liquidsoap
  367. + _type
  368. (name:string,description:string,?mimes:[string],
  369. test:((string)->int),string)->unit
  370. + name
  371. Format/decoder's name.
  372. + default
  373. None
  374. + type
  375. string
  376. + description
  377. Description of the decoder.
  378. + default
  379. None
  380. + type
  381. string
  382. + mimes
  383. List of mime types supported by this decoder for decoding streams.
  384. + default
  385. []
  386. + type
  387. [string]
  388. + test
  389. Function used to determine if a file should be decoded by the decoder. Returned values are: 0: no decodable audio, -1: decodable audio but number of audio channels unknown, x: fixed number of decodable audio channels.
  390. + default
  391. None
  392. + type
  393. (string)->int
  394. + (unlabeled)
  395. Process to start.
  396. + default
  397. None
  398. + type
  399. string
  400. + add_metadata_resolver
  401. Register an external file metadata decoder.
  402. + _category
  403. Liquidsoap
  404. + _type
  405. (string,((string)->[(string*string)]))->unit
  406. + (unlabeled)
  407. Format/resolver's name.
  408. + default
  409. None
  410. + type
  411. string
  412. + (unlabeled)
  413. Process to start. The function takes the format and filename as argument and returns a list of (name,value) fields.
  414. + default
  415. None
  416. + type
  417. (string)->[(string*string)]
  418. + add_oblivious_decoder
  419. Register an external file decoder. The encoder should output in WAV format to his standard output (stdout) and read data from the file it receives. The estimated remaining duration for this decoder will be unknown until the @buffer@ last seconds of the file. If possible, it is recommended to decode from stdin and use @add_decoder@.
  420. + _category
  421. Liquidsoap
  422. + _type
  423. (name:string,description:string,test:((string)->int),
  424. ?buffer:float,((string)->string))->unit
  425. + name
  426. Format/decoder's name.
  427. + default
  428. None
  429. + type
  430. string
  431. + description
  432. Description of the decoder.
  433. + default
  434. None
  435. + type
  436. string
  437. + test
  438. Function used to determine if a file should be decoded by the decoder. Returned values are: 0: no decodable audio, -1: decodable audio but number of audio channels unknown, x: fixed number of decodable audio channels.
  439. + default
  440. None
  441. + type
  442. (string)->int
  443. + buffer
  444. (no doc)
  445. + default
  446. 5.
  447. + type
  448. float
  449. + (unlabeled)
  450. Process to start. The function takes the filename as argument and returns the process to start.
  451. + default
  452. None
  453. + type
  454. (string)->string
  455. + add_protocol
  456. Register a new protocol.
  457. + _category
  458. Liquidsoap
  459. + _type
  460. (?temporary:bool,string,((string,float)->[string]))->unit
  461. + temporary
  462. if true, file removed when it is finished.
  463. + default
  464. false
  465. + type
  466. bool
  467. + (unlabeled)
  468. (no doc)
  469. + default
  470. None
  471. + type
  472. string
  473. + (unlabeled)
  474. (no doc)
  475. + default
  476. None
  477. + type
  478. (string,float)->[string]
  479. + add_skip_command
  480. Add a skip function to a source when it does not have one by default
  481. + _category
  482. Interaction
  483. + (unlabeled)
  484. The source to attach the command to.
  485. + default
  486. None
  487. + type
  488. source('a)
  489. + _type
  490. (source('a))->unit
  491. + add_timeout
  492. Call a function in N seconds. If the result of the function is positive or null, the task will be scheduled again after this amount of time (in seconds).
  493. + _category
  494. Control
  495. + _type
  496. (?fast:bool,float,(()->float))->unit
  497. + fast
  498. Set to <code>false</code> if the execution of the code can take long in order to lower its priority below that of request resolutions and fast timeouts. This is only effective if you set a dedicated queue for fast tasks, see the "scheduler" settings for more details.
  499. + default
  500. true
  501. + type
  502. bool
  503. + (unlabeled)
  504. (no doc)
  505. + default
  506. None
  507. + type
  508. float
  509. + (unlabeled)
  510. (no doc)
  511. + default
  512. None
  513. + type
  514. ()->float
  515. + amplify
  516. Multiply the amplitude of the signal.
  517. + _category
  518. Source / Sound Processing
  519. + _type
  520. (?id:string,?override:string,'a,
  521. source(audio='#b,video='#c,midi='#d))->
  522. source(audio='#b,video='#c,midi='#d)
  523. where 'a is either float or ()->float
  524. + id
  525. Force the value of the source ID.
  526. + default
  527. ""
  528. + type
  529. string
  530. + override
  531. Specify the name of a metadata field that, when present and well-formed, overrides the amplification factor for the current track. Well-formed values are floats in decimal notation (e.g. '0.7') which are taken as normal/linear multiplicative factors; values can be passed in decibels with the suffix 'dB' (e.g. '-8.2 dB', but the spaces do not matter).
  532. + default
  533. "liq_amplify"
  534. + type
  535. string
  536. + (unlabeled)
  537. Multiplicative factor.
  538. + default
  539. None
  540. + type
  541. anything that is either float or ()->float
  542. + (unlabeled)
  543. (no doc)
  544. + default
  545. None
  546. + type
  547. source(audio='#b,video='#c,midi='#d)
  548. + and
  549. Return the conjunction of its arguments
  550. + _category
  551. Bool
  552. + _type
  553. (bool,bool)->bool
  554. + (unlabeled)
  555. (no doc)
  556. + default
  557. None
  558. + type
  559. bool
  560. + (unlabeled)
  561. (no doc)
  562. + default
  563. None
  564. + type
  565. bool
  566. + append
  567. Append an extra track to every track. Set the metadata 'liq_append' to 'false' to inhibit appending on one track.
  568. + _category
  569. Source / Track Processing
  570. + _type
  571. (?id:string,?insert_missing:bool,?merge:bool,source('a),
  572. (([(string*string)])->source('a)))->source('a)
  573. + id
  574. Force the value of the source ID.
  575. + default
  576. ""
  577. + type
  578. string
  579. + insert_missing
  580. Treat track beginnings without metadata as having empty one.
  581. + default
  582. true
  583. + type
  584. bool
  585. + merge
  586. Merge the track with its appended track.
  587. + default
  588. false
  589. + type
  590. bool
  591. + (unlabeled)
  592. (no doc)
  593. + default
  594. None
  595. + type
  596. source('a)
  597. + (unlabeled)
  598. Given the metadata, build the source producing the track to append. This source is allowed to fail (produce nothing) if no relevant track is to be appended.
  599. + default
  600. None
  601. + type
  602. ([(string*string)])->source('a)
  603. + argv
  604. Get command-line parameters.
  605. + _category
  606. System
  607. + _type
  608. (?default:string,int)->string
  609. + default
  610. (no doc)
  611. + default
  612. ""
  613. + type
  614. string
  615. + (unlabeled)
  616. (no doc)
  617. + default
  618. None
  619. + type
  620. int
  621. + at
  622. Restrict a source to play only when a predicate is true.
  623. + _category
  624. Source / Track Processing
  625. + (unlabeled)
  626. The predicate, typically a time interval such as <code>{10h-10h30}</code>.
  627. + default
  628. None
  629. + type
  630. ()->bool
  631. + (unlabeled)
  632. (no doc)
  633. + default
  634. None
  635. + type
  636. source('a)
  637. + _type
  638. ((()->bool),source('a))->source('a)
  639. + audio.map
  640. Map a function to all audio samples. This is SLOW!
  641. + _category
  642. Source / Sound Processing
  643. + _type
  644. (?id:string,((float)->float),
  645. source(audio='#a,video='#b,midi='#c))->
  646. source(audio='#a,video='#b,midi='#c)
  647. + _flag
  648. hidden
  649. + id
  650. Force the value of the source ID.
  651. + default
  652. ""
  653. + type
  654. string
  655. + (unlabeled)
  656. (no doc)
  657. + default
  658. None
  659. + type
  660. (float)->float
  661. + (unlabeled)
  662. (no doc)
  663. + default
  664. None
  665. + type
  666. source(audio='#a,video='#b,midi='#c)
  667. + audio_to_stereo
  668. Convert any kind of audio source into a stereo source.
  669. + _category
  670. Source / Conversions
  671. + _type
  672. (?id:string,source(audio=*+1,video=0,midi=0))->
  673. source(audio=2,video=0,midi=0)
  674. + id
  675. Force the value of the source ID.
  676. + default
  677. ""
  678. + type
  679. string
  680. + (unlabeled)
  681. (no doc)
  682. + default
  683. None
  684. + type
  685. source(audio=*+1,video=0,midi=0)
  686. + base64.decode
  687. Decode a Base64 encoded string.
  688. + _category
  689. String
  690. + _type
  691. (string)->string
  692. + (unlabeled)
  693. (no doc)
  694. + default
  695. None
  696. + type
  697. string
  698. + base64.encode
  699. Encode a string in Base64.
  700. + _category
  701. String
  702. + _type
  703. (string)->string
  704. + (unlabeled)
  705. (no doc)
  706. + default
  707. None
  708. + type
  709. string
  710. + basename
  711. Get the base name of a path.
  712. + _category
  713. System
  714. + _type
  715. (string)->string
  716. + (unlabeled)
  717. (no doc)
  718. + default
  719. None
  720. + type
  721. string
  722. + blank
  723. Produce silence and blank images.
  724. + _category
  725. Source / Input
  726. + _type
  727. (?id:string,?duration:float)->source('a)
  728. + id
  729. Force the value of the source ID.
  730. + default
  731. ""
  732. + type
  733. string
  734. + duration
  735. Duration of blank tracks in seconds, default means forever.
  736. + default
  737. 0.
  738. + type
  739. float
  740. + bool_of_float
  741. Convert a float to a bool.
  742. + _category
  743. Math
  744. + _type
  745. (float)->bool
  746. + (unlabeled)
  747. (no doc)
  748. + default
  749. None
  750. + type
  751. float
  752. + bool_of_int
  753. Convert an int to a bool.
  754. + _category
  755. Math
  756. + _type
  757. (int)->bool
  758. + (unlabeled)
  759. (no doc)
  760. + default
  761. None
  762. + type
  763. int
  764. + bool_of_string
  765. Convert a string to a bool.
  766. + _category
  767. String
  768. + _type
  769. (?default:bool,string)->bool
  770. + default
  771. (no doc)
  772. + default
  773. false
  774. + type
  775. bool
  776. + (unlabeled)
  777. (no doc)
  778. + default
  779. None
  780. + type
  781. string
  782. + buffer
  783. Create a buffer between two different clocks.
  784. + _category
  785. Source / Liquidsoap
  786. + _type
  787. (?id:string,?buffer:float,?fallible:bool,?max:float,
  788. ?on_start:(()->unit),?on_stop:(()->unit),?start:bool,
  789. source('a))->source('a)
  790. + id
  791. Force the value of the source ID.
  792. + default
  793. ""
  794. + type
  795. string
  796. + buffer
  797. Amount of data to pre-buffer, in seconds.
  798. + default
  799. 1.
  800. + type
  801. float
  802. + fallible
  803. Allow the child source to fail, in which case the output will be (temporarily) stopped.
  804. + default
  805. false
  806. + type
  807. bool
  808. + max
  809. Maximum amount of buffered data, in seconds.
  810. + default
  811. 10.
  812. + type
  813. float
  814. + on_start
  815. Callback executed when outputting starts.
  816. + default
  817. {()}
  818. + type
  819. ()->unit
  820. + on_stop
  821. Callback executed when outputting stops.
  822. + default
  823. {()}
  824. + type
  825. ()->unit
  826. + start
  827. Automatically start outputting whenever possible. If true, an infallible (normal) output will start outputting as soon as it is created, and a fallible output will (re)start as soon as its source becomes available for streaming.
  828. + default
  829. true
  830. + type
  831. bool
  832. + (unlabeled)
  833. (no doc)
  834. + default
  835. None
  836. + type
  837. source('a)
  838. + clip
  839. Clip sound.
  840. + _category
  841. Source / Sound Processing
  842. + _type
  843. (?id:string,?max:float,?min:float,
  844. source(audio='#a,video='#b,midi='#c))->
  845. source(audio='#a,video='#b,midi='#c)
  846. + id
  847. Force the value of the source ID.
  848. + default
  849. ""
  850. + type
  851. string
  852. + max
  853. Maximal acceptable value.
  854. + default
  855. 0.999
  856. + type
  857. float
  858. + min
  859. Minimal acceptable value.
  860. + default
  861. -0.999
  862. + type
  863. float
  864. + (unlabeled)
  865. (no doc)
  866. + default
  867. None
  868. + type
  869. source(audio='#a,video='#b,midi='#c)
  870. + clock
  871. Assign a new clock to the given source (and to other time-dependent sources) and return the source. It is a conveniency wrapper around clock.assign_new(), allowing more concise scripts in some cases.
  872. + _category
  873. Liquidsoap
  874. + sync
  875. Do not synchronize the clock on regular wallclock time, but try to run as fast as possible (CPU burning mode).
  876. + default
  877. true
  878. + type
  879. bool
  880. + id
  881. (no doc)
  882. + default
  883. ""
  884. + type
  885. string
  886. + (unlabeled)
  887. (no doc)
  888. + default
  889. None
  890. + type
  891. source('a)
  892. + _type
  893. (?sync:bool,?id:string,source('a))->source('a)
  894. + clock.assign_new
  895. Create a new clock and assign it to a list of sources.
  896. + _category
  897. Liquidsoap
  898. + _type
  899. (?id:string,?sync:bool,[source('a)])->unit
  900. + id
  901. Identifier for the new clock. The default empty string means that the identifier of the first source will be used.
  902. + default
  903. ""
  904. + type
  905. string
  906. + sync
  907. Do not synchronize the clock on regular wallclock time, but try to run as fast as possible (CPU burning mode).
  908. + default
  909. true
  910. + type
  911. bool
  912. + (unlabeled)
  913. List of sources to which the new clock will be assigned
  914. + default
  915. None
  916. + type
  917. [source('a)]
  918. + clock.unify
  919. Enforce that a list of sources all belong to the same clock.
  920. + _category
  921. Liquidsoap
  922. + _type
  923. ([source('a)])->unit
  924. + (unlabeled)
  925. (no doc)
  926. + default
  927. None
  928. + type
  929. [source('a)]
  930. + comb
  931. Comb filter.
  932. + _category
  933. Source / Sound Processing
  934. + _type
  935. (?id:string,?delay:float,?feedback:'a,
  936. source(audio='#b,video='#c,midi='#d))->
  937. source(audio='#b,video='#c,midi='#d)
  938. where 'a is either float or ()->float
  939. + id
  940. Force the value of the source ID.
  941. + default
  942. ""
  943. + type
  944. string
  945. + delay
  946. Delay in seconds.
  947. + default
  948. 0.001
  949. + type
  950. float
  951. + feedback
  952. Feedback coefficient in dB.
  953. + default
  954. -6.
  955. + type
  956. anything that is either float or ()->float
  957. + (unlabeled)
  958. (no doc)
  959. + default
  960. None
  961. + type
  962. source(audio='#b,video='#c,midi='#d)
  963. + compand
  964. Compand the signal
  965. + _category
  966. Source / Sound Processing
  967. + _type
  968. (?id:string,?mu:float,
  969. source(audio='#a,video='#b,midi='#c))->
  970. source(audio='#a,video='#b,midi='#c)
  971. + id
  972. Force the value of the source ID.
  973. + default
  974. ""
  975. + type
  976. string
  977. + mu
  978. (no doc)
  979. + default
  980. 1.
  981. + type
  982. float
  983. + (unlabeled)
  984. (no doc)
  985. + default
  986. None
  987. + type
  988. source(audio='#a,video='#b,midi='#c)
  989. + compress
  990. Compress the signal.
  991. + _category
  992. Source / Sound Processing
  993. + _type
  994. (?id:string,?attack:'a,?gain:'b,?knee:'c,?ratio:float,
  995. ?release:'d,?rms_window:float,?threshold:'e,
  996. source(audio='#f,video='#g,midi='#h))->
  997. source(audio='#f,video='#g,midi='#h)
  998. where 'a, 'b, 'c, 'd, 'e is either float or ()->float
  999. + id
  1000. Force the value of the source ID.
  1001. + default
  1002. ""
  1003. + type
  1004. string
  1005. + attack
  1006. Attack time (ms).
  1007. + default
  1008. 100.
  1009. + type
  1010. anything that is either float or ()->float
  1011. + gain
  1012. Additional gain (dB).
  1013. + default
  1014. 0.
  1015. + type
  1016. anything that is either float or ()->float
  1017. + knee
  1018. Knee radius (dB).
  1019. + default
  1020. 1.
  1021. + type
  1022. anything that is either float or ()->float
  1023. + ratio
  1024. Gain reduction ratio (n:1).
  1025. + default
  1026. 2.
  1027. + type
  1028. float
  1029. + release
  1030. Release time (ms).
  1031. + default
  1032. 400.
  1033. + type
  1034. anything that is either float or ()->float
  1035. + rms_window
  1036. Window for computing RMS (in sec).
  1037. + default
  1038. 0.1
  1039. + type
  1040. float
  1041. + threshold
  1042. Threshold level (dB).
  1043. + default
  1044. -10.
  1045. + type
  1046. anything that is either float or ()->float
  1047. + (unlabeled)
  1048. (no doc)
  1049. + default
  1050. None
  1051. + type
  1052. source(audio='#f,video='#g,midi='#h)
  1053. + compress.exponential
  1054. Exponential compressor.
  1055. + _category
  1056. Source / Sound Processing
  1057. + _type
  1058. (?id:string,?mu:float,
  1059. source(audio='#a,video='#b,midi='#c))->
  1060. source(audio='#a,video='#b,midi='#c)
  1061. + id
  1062. Force the value of the source ID.
  1063. + default
  1064. ""
  1065. + type
  1066. string
  1067. + mu
  1068. Exponential compression factor, typically greater than 1.
  1069. + default
  1070. 2.
  1071. + type
  1072. float
  1073. + (unlabeled)
  1074. (no doc)
  1075. + default
  1076. None
  1077. + type
  1078. source(audio='#a,video='#b,midi='#c)
  1079. + configure.default_font
  1080. Liquidsoap's default font file.
  1081. + _category
  1082. Liquidsoap
  1083. + _type
  1084. string
  1085. + configure.libdir
  1086. Liquidsoap's library directory.
  1087. + _category
  1088. Liquidsoap
  1089. + _type
  1090. string
  1091. + configure.logdir
  1092. Liquidsoap's logging directory.
  1093. + _category
  1094. Liquidsoap
  1095. + _type
  1096. string
  1097. + configure.rundir
  1098. Liquidsoap's PID file directory.
  1099. + _category
  1100. Liquidsoap
  1101. + _type
  1102. string
  1103. + cross
  1104. Generic cross operator, allowing the composition of the N last seconds of a track with the beginning of the next track.
  1105. + _category
  1106. Source / Sound Processing
  1107. + _type
  1108. (?id:string,?active:bool,?conservative:bool,
  1109. ?duration:float,?inhibit:float,?minimum:float,
  1110. ?override:string,((source('a),source('a))->source('a)),
  1111. source('a))->source('a)
  1112. + id
  1113. Force the value of the source ID.
  1114. + default
  1115. ""
  1116. + type
  1117. string
  1118. + active
  1119. The active behavior is to keep ticking the child's clock when the operator is not streaming. Otherwise the child's clock is strictly based on what is streamed off the child source, which results in time-dependent active sources to be frozen when that source is stopped.
  1120. + default
  1121. false
  1122. + type
  1123. bool
  1124. + conservative
  1125. Do not trust remaining time estimations, always buffering data in advance. This avoids being tricked by skips, either manual or caused by skip_blank().
  1126. + default
  1127. false
  1128. + type
  1129. bool
  1130. + duration
  1131. Duration in seconds of the crossed end of track. This value can be changed on a per-file basis using a special metadata field.
  1132. + default
  1133. 5.
  1134. + type
  1135. float
  1136. + inhibit
  1137. Minimum delay between two transitions. It is useful in order to avoid that a transition is triggered on top of another when an end-of-track occurs in the first one. Negative values mean <code>duration+1</code>. Warning: zero inhibition can cause infinite loops.
  1138. + default
  1139. -1.
  1140. + type
  1141. float
  1142. + minimum
  1143. Minimum duration (in sec.) for a cross: If the track ends without any warning (e.g. in case of skip) there may not be enough data for a decent composition. Set to 0. to avoid having transitions after skips, or more to avoid transitions on short tracks. With the negative default, transitions always occur.
  1144. + default
  1145. -1.
  1146. + type
  1147. float
  1148. + override
  1149. Metadata field which, if present and containing a float, overrides the 'duration' parameter for current track.
  1150. + default
  1151. "liq_start_next"
  1152. + type
  1153. string
  1154. + (unlabeled)
  1155. Composition of an end of track and the next track.
  1156. + default
  1157. None
  1158. + type
  1159. (source('a),source('a))->source('a)
  1160. + (unlabeled)
  1161. (no doc)
  1162. + default
  1163. None
  1164. + type
  1165. source('a)
  1166. + crossfade
  1167. Simple crossfade.
  1168. + _category
  1169. Source / Track Processing
  1170. + id
  1171. (no doc)
  1172. + default
  1173. ""
  1174. + type
  1175. string
  1176. + conservative
  1177. Always prepare for a premature end-of-track.
  1178. + default
  1179. true
  1180. + type
  1181. bool
  1182. + start_next
  1183. Duration in seconds of the crossed end of track.
  1184. + default
  1185. 5.
  1186. + type
  1187. float
  1188. + fade_in
  1189. Duration of the fade in for next track.
  1190. + default
  1191. 3.
  1192. + type
  1193. float
  1194. + fade_out
  1195. Duration of the fade out for previous track.
  1196. + default
  1197. 3.
  1198. + type
  1199. float
  1200. + (unlabeled)
  1201. The source to use.
  1202. + default
  1203. None
  1204. + type
  1205. source(audio='#a,video='#b,midi=0)
  1206. + _type
  1207. (?id:string,?conservative:bool,?start_next:float,
  1208. ?fade_in:float,?fade_out:float,
  1209. source(audio='#a,video='#b,midi=0))->
  1210. source(audio='#a,video='#b,midi=0)
  1211. + cue_cut
  1212. Start track after a cue in point and stop it at cue out point. The cue points are given as metadata, in seconds from the begining of tracks.
  1213. + _category
  1214. Source / Track Processing
  1215. + _type
  1216. (?id:string,?cue_in_metadata:string,
  1217. ?cue_out_metadata:string,
  1218. source(audio='#a,video='#b,midi='#c))->
  1219. source(audio='#a,video='#b,midi='#c)
  1220. + id
  1221. Force the value of the source ID.
  1222. + default
  1223. ""
  1224. + type
  1225. string
  1226. + cue_in_metadata
  1227. Metadata for cue in points.
  1228. + default
  1229. "liq_cue_in"
  1230. + type
  1231. string
  1232. + cue_out_metadata
  1233. Metadata for cue out points.
  1234. + default
  1235. "liq_cue_out"
  1236. + type
  1237. string
  1238. + (unlabeled)
  1239. (no doc)
  1240. + default
  1241. None
  1242. + type
  1243. source(audio='#a,video='#b,midi='#c)
  1244. + dB_of_lin
  1245. Convert linear scale into decibels.
  1246. + _category
  1247. Math
  1248. + _type
  1249. (float)->float
  1250. + (unlabeled)
  1251. (no doc)
  1252. + default
  1253. None
  1254. + type
  1255. float
  1256. + delay
  1257. Prevents the child from being ready again too fast after a end of track
  1258. + _category
  1259. Source / Track Processing
  1260. + _type
  1261. (?id:string,?initial:bool,float,source('a))->source('a)
  1262. + id
  1263. Force the value of the source ID.
  1264. + default
  1265. ""
  1266. + type
  1267. string
  1268. + initial
  1269. Start in unavailable state, as if a track had just finished.
  1270. + default
  1271. false
  1272. + type
  1273. bool
  1274. + (unlabeled)
  1275. The source won't be ready less than this amount of seconds after any end of track
  1276. + default
  1277. None
  1278. + type
  1279. float
  1280. + (unlabeled)
  1281. (no doc)
  1282. + default
  1283. None
  1284. + type
  1285. source('a)
  1286. + dirname
  1287. Get the directory name of a path.
  1288. + _category
  1289. System
  1290. + _type
  1291. (string)->string
  1292. + (unlabeled)
  1293. (no doc)
  1294. + default
  1295. None
  1296. + type
  1297. string
  1298. + drop_audio
  1299. Drop all audio channels of a stream.
  1300. + _category
  1301. Source / Conversions
  1302. + _type
  1303. (?id:string,source(audio='#a,video='#b,midi='#c))->
  1304. source(audio=0,video='#b,midi='#c)
  1305. + id
  1306. Force the value of the source ID.
  1307. + default
  1308. ""
  1309. + type
  1310. string
  1311. + (unlabeled)
  1312. (no doc)
  1313. + default
  1314. None
  1315. + type
  1316. source(audio='#a,video='#b,midi='#c)
  1317. + drop_metadata
  1318. Removes all metadata coming from a source.
  1319. + _category
  1320. Source / Track Processing
  1321. + (unlabeled)
  1322. (no doc)
  1323. + default
  1324. None
  1325. + type
  1326. source('a)
  1327. + _type
  1328. (source('a))->source('a)
  1329. + drop_midi
  1330. Drop all midi channels of a stream.
  1331. + _category
  1332. Source / Conversions
  1333. + _type
  1334. (?id:string,source(audio='#a,video='#b,midi='#c))->
  1335. source(audio='#a,video='#b,midi=0)
  1336. + id
  1337. Force the value of the source ID.
  1338. + default
  1339. ""
  1340. + type
  1341. string
  1342. + (unlabeled)
  1343. (no doc)
  1344. + default
  1345. None
  1346. + type
  1347. source(audio='#a,video='#b,midi='#c)
  1348. + drop_video
  1349. Drop all video channels of a stream.
  1350. + _category
  1351. Source / Conversions
  1352. + _type
  1353. (?id:string,source(audio='#a,video='#b,midi='#c))->
  1354. source(audio='#a,video=0,midi='#c)
  1355. + id
  1356. Force the value of the source ID.
  1357. + default
  1358. ""
  1359. + type
  1360. string
  1361. + (unlabeled)
  1362. (no doc)
  1363. + default
  1364. None
  1365. + type
  1366. source(audio='#a,video='#b,midi='#c)
  1367. + eat_blank
  1368. Eat blanks, i.e., drop the contents of the stream until it is not blank anymore.
  1369. + _category
  1370. Source / Track Processing
  1371. + _type
  1372. (?id:string,?at_beginning:bool,?max_blank:float,
  1373. ?min_noise:float,?threshold:float,?track_sensitive:bool,
  1374. source(audio='#a,video='#b,midi='#c))->
  1375. source(audio='#a,video='#b,midi='#c)
  1376. + id
  1377. Force the value of the source ID.
  1378. + default
  1379. ""
  1380. + type
  1381. string
  1382. + at_beginning
  1383. Only eat at the beginning of a track.
  1384. + default
  1385. false
  1386. + type
  1387. bool
  1388. + max_blank
  1389. Maximum duration of silence allowed, in seconds.
  1390. + default
  1391. 20.
  1392. + type
  1393. float
  1394. + min_noise
  1395. Minimum duration of noise required to end silence, in seconds.
  1396. + default
  1397. 0.
  1398. + type
  1399. float
  1400. + threshold
  1401. Power in decibels under which the stream is considered silent.
  1402. + default
  1403. -40.
  1404. + type
  1405. float
  1406. + track_sensitive
  1407. Reset blank counter at each track.
  1408. + default
  1409. true
  1410. + type
  1411. bool
  1412. + (unlabeled)
  1413. (no doc)
  1414. + default
  1415. None
  1416. + type
  1417. source(audio='#a,video='#b,midi='#c)
  1418. + echo
  1419. Add echo.
  1420. + _category
  1421. Source / Sound Processing
  1422. + _type
  1423. (?id:string,?delay:'a,?feedback:'b,?ping_pong:bool,
  1424. source(audio='#c,video='#d,midi='#e))->
  1425. source(audio='#c,video='#d,midi='#e)
  1426. where 'a, 'b is either float or ()->float
  1427. + id
  1428. Force the value of the source ID.
  1429. + default
  1430. ""
  1431. + type
  1432. string
  1433. + delay
  1434. Delay in seconds.
  1435. + default
  1436. 0.5
  1437. + type
  1438. anything that is either float or ()->float
  1439. + feedback
  1440. Feedback coefficient in dB (negative).
  1441. + default
  1442. -6.
  1443. + type
  1444. anything that is either float or ()->float
  1445. + ping_pong
  1446. Use ping-pong delay.
  1447. + default
  1448. false
  1449. + type
  1450. bool
  1451. + (unlabeled)
  1452. (no doc)
  1453. + default
  1454. None
  1455. + type
  1456. source(audio='#c,video='#d,midi='#e)
  1457. + empty
  1458. A source that does not produce anything. No silence, no track at all.
  1459. + _category
  1460. Source / Input
  1461. + _type
  1462. (?id:string)->source(audio='a,video='b,midi='c)
  1463. + id
  1464. Force the value of the source ID.
  1465. + default
  1466. ""
  1467. + type
  1468. string
  1469. + enable_external_faad_decoder
  1470. Enable or disable external FAAD (AAC/AAC+/M4A) decoders. Requires faad binary in the path for audio decoding and metaflac binary for metadata. Does not work on Win32.
  1471. Please note that built-in support for faad is available in liquidsoap if compiled and should be preferred over the external decoder.
  1472. + _category
  1473. Liquidsoap
  1474. + _type
  1475. ()->unit
  1476. + enable_external_flac_decoder
  1477. Enable external FLAC decoders. Requires flac binary in the path for audio decoding and metaflac binary for metadata. Does not work on Win32. Default: disabled.
  1478. Please note that built-in support for FLAC is available in liquidsoap if compiled and should be preferred over the external decoder.
  1479. + _category
  1480. Liquidsoap
  1481. + _type
  1482. ()->unit
  1483. + enable_external_mpc_decoder
  1484. Enable external Musepack decoder. Requires the mpcdec binary in the path. Does not work on Win32.
  1485. + _category
  1486. Liquidsoap
  1487. + _type
  1488. ()->unit
  1489. + enable_replaygain_metadata
  1490. Enable replay gain metadata resolver. This resolver will process any file decoded by liquidsoap and add a replay_gain metadata when this value could be computed. For a finer-grained replay gain processing, use the replay_gain protocol.
  1491. + _category
  1492. Liquidsoap
  1493. + extract_replaygain
  1494. The extraction program
  1495. + default
  1496. "/usr/local/lib/liquidsoap/1.1.1/extract-replaygain"
  1497. + type
  1498. string
  1499. + _type
  1500. (?extract_replaygain:string)->unit
  1501. + environment
  1502. Return the process environment.
  1503. + _category
  1504. System
  1505. + _type
  1506. ()->[(string*string)]
  1507. + eval
  1508. Evaluate a string as an expression in the toplevel environment.
  1509. + _category
  1510. Liquidsoap
  1511. + _type
  1512. (string)->string
  1513. + _flag
  1514. hidden
  1515. + (unlabeled)
  1516. (no doc)
  1517. + default
  1518. None
  1519. + type
  1520. string
  1521. + exec_at
  1522. Execute a given action when a predicate is true.
  1523. This will be run in background.
  1524. + _category
  1525. System
  1526. + freq
  1527. Frequency for checking the predicate, in seconds.
  1528. + default
  1529. 1.
  1530. + type
  1531. float
  1532. + pred
  1533. Predicate indicating when to execute the function, typically a time interval such as <code>{10h-10h30}</code>.
  1534. + default
  1535. None
  1536. + type
  1537. ()->bool
  1538. + (unlabeled)
  1539. Function to execute when the predicate is true.
  1540. + default
  1541. None
  1542. + type
  1543. ()->unit
  1544. + _type
  1545. (?freq:float,pred:(()->bool),(()->unit))->unit
  1546. + fade.final
  1547. Fade a stream to silence.
  1548. + _category
  1549. Source / Sound Processing
  1550. + _type
  1551. (?id:string,?duration:float,?override:string,
  1552. ?type:string,source(audio='#a,video='#b,midi='#c))->
  1553. source(audio='#a,video='#b,midi='#c)
  1554. + id
  1555. Force the value of the source ID.
  1556. + default
  1557. ""
  1558. + type
  1559. string
  1560. + duration
  1561. Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
  1562. + default
  1563. 3.
  1564. + type
  1565. float
  1566. + override
  1567. Metadata field which, if present and containing a float, overrides the 'duration' parameter for current track.
  1568. + default
  1569. "liq_fade_final"
  1570. + type
  1571. string
  1572. + type
  1573. Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
  1574. + default
  1575. "lin"
  1576. + type
  1577. string
  1578. + (unlabeled)
  1579. (no doc)
  1580. + default
  1581. None
  1582. + type
  1583. source(audio='#a,video='#b,midi='#c)
  1584. + fade.in
  1585. Fade the beginning of tracks. A special override metadata field can be used to set the duration for a specific track (float in seconds).
  1586. + _category
  1587. Source / Sound Processing
  1588. + _type
  1589. (?id:string,?duration:float,?override:string,
  1590. ?type:string,source(audio='#a,video='#b,midi='#c))->
  1591. source(audio='#a,video='#b,midi='#c)
  1592. + id
  1593. Force the value of the source ID.
  1594. + default
  1595. ""
  1596. + type
  1597. string
  1598. + duration
  1599. Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
  1600. + default
  1601. 3.
  1602. + type
  1603. float
  1604. + override
  1605. Metadata field which, if present and containing a float, overrides the 'duration' parameter for current track.
  1606. + default
  1607. "liq_fade_in"
  1608. + type
  1609. string
  1610. + type
  1611. Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
  1612. + default
  1613. "lin"
  1614. + type
  1615. string
  1616. + (unlabeled)
  1617. (no doc)
  1618. + default
  1619. None
  1620. + type
  1621. source(audio='#a,video='#b,midi='#c)
  1622. + fade.initial
  1623. Fade the beginning of a stream.
  1624. + _category
  1625. Source / Sound Processing
  1626. + _type
  1627. (?id:string,?duration:float,?type:string,
  1628. source(audio='#a,video='#b,midi='#c))->
  1629. source(audio='#a,video='#b,midi='#c)
  1630. + id
  1631. Force the value of the source ID.
  1632. + default
  1633. ""
  1634. + type
  1635. string
  1636. + duration
  1637. Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
  1638. + default
  1639. 3.
  1640. + type
  1641. float
  1642. + type
  1643. Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
  1644. + default
  1645. "lin"
  1646. + type
  1647. string
  1648. + (unlabeled)
  1649. (no doc)
  1650. + default
  1651. None
  1652. + type
  1653. source(audio='#a,video='#b,midi='#c)
  1654. + fade.out
  1655. Fade the end of tracks. A special override metadata field can be used to set the duration for a specific track (float in seconds).
  1656. + _category
  1657. Source / Sound Processing
  1658. + _type
  1659. (?id:string,?duration:float,?override:string,
  1660. ?type:string,source(audio='#a,video='#b,midi='#c))->
  1661. source(audio='#a,video='#b,midi='#c)
  1662. + id
  1663. Force the value of the source ID.
  1664. + default
  1665. ""
  1666. + type
  1667. string
  1668. + duration
  1669. Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
  1670. + default
  1671. 3.
  1672. + type
  1673. float
  1674. + override
  1675. Metadata field which, if present and containing a float, overrides the 'duration' parameter for current track.
  1676. + default
  1677. "liq_fade_out"
  1678. + type
  1679. string
  1680. + type
  1681. Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
  1682. + default
  1683. "lin"
  1684. + type
  1685. string
  1686. + (unlabeled)
  1687. (no doc)
  1688. + default
  1689. None
  1690. + type
  1691. source(audio='#a,video='#b,midi='#c)
  1692. + fail
  1693. Creates a source that fails to produce anything.
  1694. + _category
  1695. Source / Input
  1696. + id
  1697. (no doc)
  1698. + default
  1699. ""
  1700. + type
  1701. string
  1702. + _type
  1703. (?id:string)->source('a)
  1704. + fallback
  1705. At the beginning of each track, select the first ready child.
  1706. + _category
  1707. Source / Track Processing
  1708. + _type
  1709. (?id:string,?replay_metadata:bool,?track_sensitive:bool,
  1710. ?transitions:[(source('a),source('a))->source('a)],
  1711. [source('a)])->source('a)
  1712. + id
  1713. Force the value of the source ID.
  1714. + default
  1715. ""
  1716. + type
  1717. string
  1718. + replay_metadata
  1719. Replay the last metadata of a child when switching to it in the middle of a track.
  1720. + default
  1721. true
  1722. + type
  1723. bool
  1724. + track_sensitive
  1725. Re-select only on end of tracks.
  1726. + default
  1727. true
  1728. + type
  1729. bool
  1730. + transitions
  1731. Transition functions, padded with <code>fun (x,y) -> y</code> functions.
  1732. + default
  1733. []
  1734. + type
  1735. [(source('a),source('a))->source('a)]
  1736. + (unlabeled)
  1737. Select the first ready source in this list.
  1738. + default
  1739. None
  1740. + type
  1741. [source('a)]
  1742. + fallback.skip
  1743. Special track insensitive fallback that always skips current song before switching.
  1744. + _category
  1745. Source / Track Processing
  1746. + input
  1747. The input source
  1748. + default
  1749. None
  1750. + type
  1751. source('a)
  1752. + (unlabeled)
  1753. The fallback source
  1754. + default
  1755. None
  1756. + type
  1757. source('a)
  1758. + _type
  1759. (input:source('a),source('a))->source('a)
  1760. + file.duration
  1761. Compute the duration in seconds of audio data contained in a file. The computation may be expensive. Returns -1. if computation failed, typically if the file was not recognized as valid audio.
  1762. + _category
  1763. Liquidsoap
  1764. + _type
  1765. (string)->float
  1766. + (unlabeled)
  1767. (no doc)
  1768. + default
  1769. None
  1770. + type
  1771. string
  1772. + file.exists
  1773. Returns true if the file or directory exists.
  1774. + _category
  1775. System
  1776. + _type
  1777. (string)->bool
  1778. + (unlabeled)
  1779. (no doc)
  1780. + default
  1781. None
  1782. + type
  1783. string
  1784. + file.mime
  1785. Get the MIME type of a file, according to libmagic.
  1786. + _category
  1787. Liquidsoap
  1788. + _type
  1789. (string)->string
  1790. + (unlabeled)
  1791. (no doc)
  1792. + default
  1793. None
  1794. + type
  1795. string
  1796. + file.mime_default
  1797. Alias of file.mime (because it is available)
  1798. + _category
  1799. System
  1800. + (unlabeled)
  1801. (no doc)
  1802. + default
  1803. None
  1804. + type
  1805. string
  1806. + _type
  1807. (string)->string
  1808. + file.watch
  1809. Call a function when a file is modified. Returns unwatch function.
  1810. + _category
  1811. System
  1812. + _type
  1813. (string,(()->unit))->()->unit
  1814. + (unlabeled)
  1815. File to watch.
  1816. + default
  1817. None
  1818. + type
  1819. string
  1820. + (unlabeled)
  1821. Handler function.
  1822. + default
  1823. None
  1824. + type
  1825. ()->unit
  1826. + filter
  1827. Perform several kinds of filtering on the signal
  1828. + _category
  1829. Source / Sound Processing
  1830. + _type
  1831. (?id:string,freq:'a,mode:string,?q:'b,?wetness:'c,
  1832. source(audio='#d,video='#e,midi='#f))->
  1833. source(audio='#d,video='#e,midi='#f)
  1834. where 'a, 'b, 'c is either float or ()->float
  1835. + id
  1836. Force the value of the source ID.
  1837. + default
  1838. ""
  1839. + type
  1840. string
  1841. + freq
  1842. (no doc)
  1843. + default
  1844. None
  1845. + type
  1846. anything that is either float or ()->float
  1847. + mode
  1848. Available modes are 'low' (for low-pass filter), 'high' (for high-pass filter), 'band' (for band-pass filter) and 'notch' (for notch / band-stop / band-rejection filter).
  1849. + default
  1850. None
  1851. + type
  1852. string
  1853. + q
  1854. (no doc)
  1855. + default
  1856. 1.
  1857. + type
  1858. anything that is either float or ()->float
  1859. + wetness
  1860. How much of the original signal should be added (1. means only filtered and 0. means only original signal).
  1861. + default
  1862. 1.
  1863. + type
  1864. anything that is either float or ()->float
  1865. + (unlabeled)
  1866. (no doc)
  1867. + default
  1868. None
  1869. + type
  1870. source(audio='#d,video='#e,midi='#f)
  1871. + filter.fir
  1872. Low-pass FIR filter.
  1873. + _category
  1874. Source / Sound Processing
  1875. + _type
  1876. (?id:string,beta:float,?coeffs:int,frequency:float,
  1877. source(audio='#a,video='#b,midi='#c))->
  1878. source(audio='#a,video='#b,midi='#c)
  1879. + id
  1880. Force the value of the source ID.
  1881. + default
  1882. ""
  1883. + type
  1884. string
  1885. + beta
  1886. Beta should range between 0 and 1.
  1887. + default
  1888. None
  1889. + type
  1890. float
  1891. + coeffs
  1892. Number of coefficients
  1893. + default
  1894. 255
  1895. + type
  1896. int
  1897. + frequency
  1898. Corner frequency in Hz (frequency at which the response is 0.5, that is -6 dB).
  1899. + default
  1900. None
  1901. + type
  1902. float
  1903. + (unlabeled)
  1904. (no doc)
  1905. + default
  1906. None
  1907. + type
  1908. source(audio='#a,video='#b,midi='#c)
  1909. + filter.iir.butterworth.bandpass
  1910. IIR filter
  1911. + _category
  1912. Source / Sound Processing
  1913. + _type
  1914. (?id:string,frequency1:float,frequency2:float,?order:int,
  1915. source(audio='#a,video='#b,midi='#c))->
  1916. source(audio='#a,video='#b,midi='#c)
  1917. + id
  1918. Force the value of the source ID.
  1919. + default
  1920. ""
  1921. + type
  1922. string
  1923. + frequency1
  1924. First corner frequency
  1925. + default
  1926. None
  1927. + type
  1928. float
  1929. + frequency2
  1930. Second corner frequency
  1931. + default
  1932. None
  1933. + type
  1934. float
  1935. + order
  1936. Filter order
  1937. + default
  1938. 4
  1939. + type
  1940. int
  1941. + (unlabeled)
  1942. (no doc)
  1943. + default
  1944. None
  1945. + type
  1946. source(audio='#a,video='#b,midi='#c)
  1947. + filter.iir.butterworth.bandstop
  1948. IIR filter
  1949. + _category
  1950. Source / Sound Processing
  1951. + _type
  1952. (?id:string,frequency1:float,frequency2:float,?order:int,
  1953. source(audio='#a,video='#b,midi='#c))->
  1954. source(audio='#a,video='#b,midi='#c)
  1955. + id
  1956. Force the value of the source ID.
  1957. + default
  1958. ""
  1959. + type
  1960. string
  1961. + frequency1
  1962. First corner frequency
  1963. + default
  1964. None
  1965. + type
  1966. float
  1967. + frequency2
  1968. Second corner frequency
  1969. + default
  1970. None
  1971. + type
  1972. float
  1973. + order
  1974. Filter order
  1975. + default
  1976. 4
  1977. + type
  1978. int
  1979. + (unlabeled)
  1980. (no doc)
  1981. + default
  1982. None
  1983. + type
  1984. source(audio='#a,video='#b,midi='#c)
  1985. + filter.iir.butterworth.high
  1986. IIR filter
  1987. + _category
  1988. Source / Sound Processing
  1989. + _type
  1990. (?id:string,frequency:float,?order:int,
  1991. source(audio='#a,video='#b,midi='#c))->
  1992. source(audio='#a,video='#b,midi='#c)
  1993. + id
  1994. Force the value of the source ID.
  1995. + default
  1996. ""
  1997. + type
  1998. string
  1999. + frequency
  2000. Corner frequency
  2001. + default
  2002. None
  2003. + type
  2004. float
  2005. + order
  2006. Filter order
  2007. + default
  2008. 4
  2009. + type
  2010. int
  2011. + (unlabeled)
  2012. (no doc)
  2013. + default
  2014. None
  2015. + type
  2016. source(audio='#a,video='#b,midi='#c)
  2017. + filter.iir.butterworth.low
  2018. IIR filter
  2019. + _category
  2020. Source / Sound Processing
  2021. + _type
  2022. (?id:string,frequency:float,?order:int,
  2023. source(audio='#a,video='#b,midi='#c))->
  2024. source(audio='#a,video='#b,midi='#c)
  2025. + id
  2026. Force the value of the source ID.
  2027. + default
  2028. ""
  2029. + type
  2030. string
  2031. + frequency
  2032. Corner frequency
  2033. + default
  2034. None
  2035. + type
  2036. float
  2037. + order
  2038. Filter order
  2039. + default
  2040. 4
  2041. + type
  2042. int
  2043. + (unlabeled)
  2044. (no doc)
  2045. + default
  2046. None
  2047. + type
  2048. source(audio='#a,video='#b,midi='#c)
  2049. + filter.iir.eq.allpass
  2050. All pass biquad filter.
  2051. + _category
  2052. Source / Sound Processing
  2053. + _type
  2054. (?id:string,?bandwidth:float,frequency:float,
  2055. source(audio='#a,video='#b,midi='#c))->
  2056. source(audio='#a,video='#b,midi='#c)
  2057. + id
  2058. Force the value of the source ID.
  2059. + default
  2060. ""
  2061. + type
  2062. string
  2063. + bandwidth
  2064. Bandwidth (in octaves)
  2065. + default
  2066. 0.333333333333
  2067. + type
  2068. float
  2069. + frequency
  2070. Center frequency
  2071. + default
  2072. None
  2073. + type
  2074. float
  2075. + (unlabeled)
  2076. (no doc)
  2077. + default
  2078. None
  2079. + type
  2080. source(audio='#a,video='#b,midi='#c)
  2081. + filter.iir.eq.bandpass
  2082. Band pass biquad filter.
  2083. + _category
  2084. Source / Sound Processing
  2085. + _type
  2086. (?id:string,frequency:float,?q:float,
  2087. source(audio='#a,video='#b,midi='#c))->
  2088. source(audio='#a,video='#b,midi='#c)
  2089. + id
  2090. Force the value of the source ID.
  2091. + default
  2092. ""
  2093. + type
  2094. string
  2095. + frequency
  2096. Center frequency
  2097. + default
  2098. None
  2099. + type
  2100. float
  2101. + q
  2102. Q
  2103. + default
  2104. 1.
  2105. + type
  2106. float
  2107. + (unlabeled)
  2108. (no doc)
  2109. + default
  2110. None
  2111. + type
  2112. source(audio='#a,video='#b,midi='#c)
  2113. + filter.iir.eq.high
  2114. High pass biquad filter.
  2115. + _category
  2116. Source / Sound Processing
  2117. + _type
  2118. (?id:string,frequency:float,?q:float,
  2119. source(audio='#a,video='#b,midi='#c))->
  2120. source(audio='#a,video='#b,midi='#c)
  2121. + id
  2122. Force the value of the source ID.
  2123. + default
  2124. ""
  2125. + type
  2126. string
  2127. + frequency
  2128. Corner frequency
  2129. + default
  2130. None
  2131. + type
  2132. float
  2133. + q
  2134. Q
  2135. + default
  2136. 1.
  2137. + type
  2138. float
  2139. + (unlabeled)
  2140. (no doc)
  2141. + default
  2142. None
  2143. + type
  2144. source(audio='#a,video='#b,midi='#c)
  2145. + filter.iir.eq.highshelf
  2146. High shelf biquad filter.
  2147. + _category
  2148. Source / Sound Processing
  2149. + _type
  2150. (?id:string,frequency:float,?slope:float,
  2151. source(audio='#a,video='#b,midi='#c))->
  2152. source(audio='#a,video='#b,midi='#c)
  2153. + id
  2154. Force the value of the source ID.
  2155. + default
  2156. ""
  2157. + type
  2158. string
  2159. + frequency
  2160. Center frequency
  2161. + default
  2162. None
  2163. + type
  2164. float
  2165. + slope
  2166. Shelf slope (in dB/octave)
  2167. + default
  2168. 1.
  2169. + type
  2170. float
  2171. + (unlabeled)
  2172. (no doc)
  2173. + default
  2174. None
  2175. + type
  2176. source(audio='#a,video='#b,midi='#c)
  2177. + filter.iir.eq.low
  2178. Low pass biquad filter.
  2179. + _category
  2180. Source / Sound Processing
  2181. + _type
  2182. (?id:string,frequency:float,?q:float,
  2183. source(audio='#a,video='#b,midi='#c))->
  2184. source(audio='#a,video='#b,midi='#c)
  2185. + id
  2186. Force the value of the source ID.
  2187. + default
  2188. ""
  2189. + type
  2190. string
  2191. + frequency
  2192. Corner frequency
  2193. + default
  2194. None
  2195. + type
  2196. float
  2197. + q
  2198. Q
  2199. + default
  2200. 1.
  2201. + type
  2202. float
  2203. + (unlabeled)
  2204. (no doc)
  2205. + default
  2206. None
  2207. + type
  2208. source(audio='#a,video='#b,midi='#c)
  2209. + filter.iir.eq.lowshelf
  2210. Low shelf biquad filter.
  2211. + _category
  2212. Source / Sound Processing
  2213. + _type
  2214. (?id:string,frequency:float,?slope:float,
  2215. source(audio='#a,video='#b,midi='#c))->
  2216. source(audio='#a,video='#b,midi='#c)
  2217. + id
  2218. Force the value of the source ID.
  2219. + default
  2220. ""
  2221. + type
  2222. string
  2223. + frequency
  2224. Corner frequency
  2225. + default
  2226. None
  2227. + type
  2228. float
  2229. + slope
  2230. Shelf slope (dB/octave)
  2231. + default
  2232. 1.
  2233. + type
  2234. float
  2235. + (unlabeled)
  2236. (no doc)
  2237. + default
  2238. None
  2239. + type
  2240. source(audio='#a,video='#b,midi='#c)
  2241. + filter.iir.eq.notch
  2242. Band pass biquad filter.
  2243. + _category
  2244. Source / Sound Processing
  2245. + _type
  2246. (?id:string,frequency:float,?q:float,
  2247. source(audio='#a,video='#b,midi='#c))->
  2248. source(audio='#a,video='#b,midi='#c)
  2249. + id
  2250. Force the value of the source ID.
  2251. + default
  2252. ""
  2253. + type
  2254. string
  2255. + frequency
  2256. Center frequency
  2257. + default
  2258. None
  2259. + type
  2260. float
  2261. + q
  2262. Q
  2263. + default
  2264. 1.
  2265. + type
  2266. float
  2267. + (unlabeled)
  2268. (no doc)
  2269. + default
  2270. None
  2271. + type
  2272. source(audio='#a,video='#b,midi='#c)
  2273. + filter.iir.eq.peak
  2274. Peak EQ biquad filter.
  2275. + _category
  2276. Source / Sound Processing
  2277. + _type
  2278. (?id:string,frequency:float,?gain:float,?q:float,
  2279. source(audio='#a,video='#b,midi='#c))->
  2280. source(audio='#a,video='#b,midi='#c)
  2281. + id
  2282. Force the value of the source ID.
  2283. + default
  2284. ""
  2285. + type
  2286. string
  2287. + frequency
  2288. Center frequency
  2289. + default
  2290. None
  2291. + type
  2292. float
  2293. + gain
  2294. Gain (in dB)
  2295. + default
  2296. 1.
  2297. + type
  2298. float
  2299. + q
  2300. Q
  2301. + default
  2302. 1.
  2303. + type
  2304. float
  2305. + (unlabeled)
  2306. (no doc)
  2307. + default
  2308. None
  2309. + type
  2310. source(audio='#a,video='#b,midi='#c)
  2311. + filter.iir.resonator.allpass
  2312. IIR filter
  2313. + _category
  2314. Source / Sound Processing
  2315. + _type
  2316. (?id:string,frequency:float,?q:float,
  2317. source(audio='#a,video='#b,midi='#c))->
  2318. source(audio='#a,video='#b,midi='#c)
  2319. + id
  2320. Force the value of the source ID.
  2321. + default
  2322. ""
  2323. + type
  2324. string
  2325. + frequency
  2326. Corner frequency
  2327. + default
  2328. None
  2329. + type
  2330. float
  2331. + q
  2332. Quality factor
  2333. + default
  2334. 60.
  2335. + type
  2336. float
  2337. + (unlabeled)
  2338. (no doc)
  2339. + default
  2340. None
  2341. + type
  2342. source(audio='#a,video='#b,midi='#c)
  2343. + filter.iir.resonator.bandpass
  2344. IIR filter
  2345. + _category
  2346. Source / Sound Processing
  2347. + _type
  2348. (?id:string,frequency:float,?q:float,
  2349. source(audio='#a,video='#b,midi='#c))->
  2350. source(audio='#a,video='#b,midi='#c)
  2351. + id
  2352. Force the value of the source ID.
  2353. + default
  2354. ""
  2355. + type
  2356. string
  2357. + frequency
  2358. Corner frequency
  2359. + default
  2360. None
  2361. + type
  2362. float
  2363. + q
  2364. Quality factor
  2365. + default
  2366. 60.
  2367. + type
  2368. float
  2369. + (unlabeled)
  2370. (no doc)
  2371. + default
  2372. None
  2373. + type
  2374. source(audio='#a,video='#b,midi='#c)
  2375. + filter.iir.resonator.bandstop
  2376. IIR filter
  2377. + _category
  2378. Source / Sound Processing
  2379. + _type
  2380. (?id:string,frequency:float,?q:float,
  2381. source(audio='#a,video='#b,midi='#c))->
  2382. source(audio='#a,video='#b,midi='#c)
  2383. + id
  2384. Force the value of the source ID.
  2385. + default
  2386. ""
  2387. + type
  2388. string
  2389. + frequency
  2390. Corner frequency
  2391. + default
  2392. None
  2393. + type
  2394. float
  2395. + q
  2396. Quality factor
  2397. + default
  2398. 60.
  2399. + type
  2400. float
  2401. + (unlabeled)
  2402. (no doc)
  2403. + default
  2404. None
  2405. + type
  2406. source(audio='#a,video='#b,midi='#c)
  2407. + flanger
  2408. Flanger effect.
  2409. + _category
  2410. Source / Sound Processing
  2411. + _type
  2412. (?id:string,?delay:float,?feedback:'a,?freq:'b,?phase:'c,
  2413. source(audio='#d,video='#e,midi='#f))->
  2414. source(audio='#d,video='#e,midi='#f)
  2415. where 'a, 'b, 'c is either float or ()->float
  2416. + id
  2417. Force the value of the source ID.
  2418. + default
  2419. ""
  2420. + type
  2421. string
  2422. + delay
  2423. Delay in seconds.
  2424. + default
  2425. 0.001
  2426. + type
  2427. float
  2428. + feedback
  2429. Feedback coefficient in dB.
  2430. + default
  2431. 0.
  2432. + type
  2433. anything that is either float or ()->float
  2434. + freq
  2435. Frequency in Hz.
  2436. + default
  2437. 0.5
  2438. + type
  2439. anything that is either float or ()->float
  2440. + phase
  2441. Phase difference between channels in radians.
  2442. + default
  2443. 1.
  2444. + type
  2445. anything that is either float or ()->float
  2446. + (unlabeled)
  2447. (no doc)
  2448. + default
  2449. None
  2450. + type
  2451. source(audio='#d,video='#e,midi='#f)
  2452. + float_of_int
  2453. Convert an int to a float.
  2454. + _category
  2455. Math
  2456. + _type
  2457. (int)->float
  2458. + (unlabeled)
  2459. (no doc)
  2460. + default
  2461. None
  2462. + type
  2463. int
  2464. + float_of_string
  2465. Convert a string to a float.
  2466. + _category
  2467. String
  2468. + _type
  2469. (?default:float,string)->float
  2470. + default
  2471. (no doc)
  2472. + default
  2473. 0.
  2474. + type
  2475. float
  2476. + (unlabeled)
  2477. (no doc)
  2478. + default
  2479. None
  2480. + type
  2481. string
  2482. + fst
  2483. Get the first component of a pair.
  2484. + _category
  2485. Pair
  2486. + _type
  2487. (('a*'b))->'a
  2488. + (unlabeled)
  2489. (no doc)
  2490. + default
  2491. None
  2492. + type
  2493. ('a*'b)
  2494. + garbage_collect
  2495. Trigger full major garbage collection.
  2496. + _category
  2497. Liquidsoap
  2498. + _type
  2499. ()->unit
  2500. + get
  2501. Get a setting's value.
  2502. + _category
  2503. Liquidsoap
  2504. + _type
  2505. (default:'a,string)->'a
  2506. where 'a is bool, int, float, string or [string]
  2507. + default
  2508. (no doc)
  2509. + default
  2510. None
  2511. + type
  2512. anything that is bool, int, float, string or [string]
  2513. + (unlabeled)
  2514. (no doc)
  2515. + default
  2516. None
  2517. + type
  2518. string
  2519. + get_clock_status
  2520. Get the current time for all allocated clocks.
  2521. + _category
  2522. Liquidsoap
  2523. + _type
  2524. ()->[(string*int)]
  2525. + get_mime
  2526. Generic mime test. First try to use file.mime if it exist.
  2527. Otherwise try to get the value using the file binary.
  2528. Returns "" (empty string) if no value can be find.
  2529. + _category
  2530. System
  2531. + (unlabeled)
  2532. The file to test
  2533. + default
  2534. None
  2535. + type
  2536. string
  2537. + _type
  2538. (string)->string
  2539. + get_process_lines
  2540. Perform a shell call and return the list of its output lines.
  2541. + _category
  2542. System
  2543. + _type
  2544. (string)->[string]
  2545. + (unlabeled)
  2546. (no doc)
  2547. + default
  2548. None
  2549. + type
  2550. string
  2551. + get_process_output
  2552. Perform a shell call and return its output.
  2553. + _category
  2554. System
  2555. + _type
  2556. (string)->string
  2557. + (unlabeled)
  2558. (no doc)
  2559. + default
  2560. None
  2561. + type
  2562. string
  2563. + getenv
  2564. Get the value associated to a variable in the process environment. Return "" if variable is not set.
  2565. + _category
  2566. System
  2567. + _type
  2568. (string)->string
  2569. + (unlabeled)
  2570. (no doc)
  2571. + default
  2572. None
  2573. + type
  2574. string
  2575. + getopt
  2576. Parse command line options:
  2577. <code>getopt("-o")</code> returns "1" if "-o" was passed without any parameter, "0" otherwise.
  2578. <code>getopt(default="X","-o")</code> returns "Y" if "-o Y" was passed, "X" otherwise.
  2579. The result is removed from the list of arguments, affecting subsequent
  2580. calls to <code>argv()</code> and <code>getopt()</code>.
  2581. + _category
  2582. System
  2583. + _type
  2584. (?default:string,string)->string
  2585. + default
  2586. (no doc)
  2587. + default
  2588. ""
  2589. + type
  2590. string
  2591. + (unlabeled)
  2592. (no doc)
  2593. + default
  2594. None
  2595. + type
  2596. string
  2597. + getpid
  2598. Get the process' pid.
  2599. + _category
  2600. System
  2601. + _type
  2602. ()->int
  2603. + gettimeofday
  2604. Return the current time since 00:00:00 GMT, Jan. 1, 1970, in seconds.
  2605. + _category
  2606. System
  2607. + _type
  2608. ()->float
  2609. + harbor.http.register
  2610. Register a HTTP handler on the harbor. The given function receives as argument the full requested uri (e.g. "foo?var=bar"), http protocol version, possible input data and the list of HTTP headers and returns the answer sent to the client, including HTTP headers. Registered uri can be regular expressions (e.g. ".+\.php") and can override default metadata handlers.
  2611. + _category
  2612. Liquidsoap
  2613. + _type
  2614. (port:int,method:string,string,
  2615. ((protocol:string,data:string,headers:[(string*string)],
  2616. string)->string))->unit
  2617. + port
  2618. Port to server.
  2619. + default
  2620. None
  2621. + type
  2622. int
  2623. + method
  2624. Accepted method
  2625. + default
  2626. None
  2627. + type
  2628. string
  2629. + (unlabeled)
  2630. URI to serve.
  2631. + default
  2632. None
  2633. + type
  2634. string
  2635. + (unlabeled)
  2636. Function to execute. method argument is "PUT" or "GET", protocol argument is "HTTP/1.1" or "HTTP/1.0" etc., data argument contains data passed in case of a PUT request, and "" otherwise. headers argument contains the HTTP headers. Unlabeled argument contains the requested URI.
  2637. + default
  2638. None
  2639. + type
  2640. (protocol:string,data:string,headers:[(string*string)],
  2641. string)->string
  2642. + harbor.http.remove
  2643. Remove a registered HTTP handler on the harbor.
  2644. + _category
  2645. Liquidsoap
  2646. + _type
  2647. (method:string,port:int,string)->unit
  2648. + method
  2649. Method served.
  2650. + default
  2651. None
  2652. + type
  2653. string
  2654. + port
  2655. Port to server.
  2656. + default
  2657. None
  2658. + type
  2659. int
  2660. + (unlabeled)
  2661. URI served.
  2662. + default
  2663. None
  2664. + type
  2665. string
  2666. + http.get
  2667. Perform a full Http GET request and return (status,headers),data.
  2668. + _category
  2669. Interaction
  2670. + _type
  2671. (?headers:[(string*string)],?timeout:float,string)->
  2672. ((((string*int)*string)*[(string*string)])*string)
  2673. + headers
  2674. Additional headers.
  2675. + default
  2676. []
  2677. + type
  2678. [(string*string)]
  2679. + timeout
  2680. Timeout for network operations.
  2681. + default
  2682. 10.
  2683. + type
  2684. float
  2685. + (unlabeled)
  2686. Requested URL, e.g. "http://www.google.com:80/index.html".
  2687. + default
  2688. None
  2689. + type
  2690. string
  2691. + http.post
  2692. Perform a full Http POST request and return (status,headers),data.
  2693. + _category
  2694. Interaction
  2695. + _type
  2696. (?data:string,?headers:[(string*string)],?timeout:float,
  2697. string)->
  2698. ((((string*int)*string)*[(string*string)])*string)
  2699. + data
  2700. Http POST data.
  2701. + default
  2702. ""
  2703. + type
  2704. string
  2705. + headers
  2706. Additional headers.
  2707. + default
  2708. []
  2709. + type
  2710. [(string*string)]
  2711. + timeout
  2712. Timeout for network operations.
  2713. + default
  2714. 10.
  2715. + type
  2716. float
  2717. + (unlabeled)
  2718. Requested URL, e.g. "http://www.google.com:80/index.html".
  2719. + default
  2720. None
  2721. + type
  2722. string
  2723. + http_codes
  2724. List of HTTP response codes and statuses.
  2725. + _category
  2726. Interaction
  2727. + _type
  2728. [(string*string)]
  2729. + http_response
  2730. Create a HTTP response string
  2731. + _category
  2732. Interaction
  2733. + protocol
  2734. HTTP protocol used.
  2735. + default
  2736. "HTTP/1.1"
  2737. + type
  2738. string
  2739. + code
  2740. Response code.
  2741. + default
  2742. 200
  2743. + type
  2744. int
  2745. + headers
  2746. Response headers.
  2747. + default
  2748. []
  2749. + type
  2750. [(string*string)]
  2751. + data
  2752. Response data
  2753. + default
  2754. ""
  2755. + type
  2756. string
  2757. + _type
  2758. (?protocol:string,?code:int,?headers:[(string*string)],
  2759. ?data:string)->string
  2760. + icy.update_metadata
  2761. Update metata on an icecast mountpoint using the ICY protocol.
  2762. + _category
  2763. Interaction
  2764. + _type
  2765. (?host:string,?port:int,?user:string,?password:string,
  2766. mount:string,?protocol:string,?encoding:string,
  2767. ?headers:[(string*string)],[(string*string)])->unit
  2768. + host
  2769. (no doc)
  2770. + default
  2771. "localhost"
  2772. + type
  2773. string
  2774. + port
  2775. (no doc)
  2776. + default
  2777. 8000
  2778. + type
  2779. int
  2780. + user
  2781. (no doc)
  2782. + default
  2783. "source"
  2784. + type
  2785. string
  2786. + password
  2787. (no doc)
  2788. + default
  2789. "hackme"
  2790. + type
  2791. string
  2792. + mount
  2793. (no doc)
  2794. + default
  2795. None
  2796. + type
  2797. string
  2798. + protocol
  2799. Protocol to use. One of: "icy" or "http"
  2800. + default
  2801. "http"
  2802. + type
  2803. string
  2804. + encoding
  2805. Encoding used to send metadata, default (UTF-8) if empty.
  2806. + default
  2807. ""
  2808. + type
  2809. string
  2810. + headers
  2811. Additional headers.
  2812. + default
  2813. [("User-Agent","Liquidsoap/1.1.1 (Unix; OCaml 3.12.1)")]
  2814. + type
  2815. [(string*string)]
  2816. + (unlabeled)
  2817. (no doc)
  2818. + default
  2819. None
  2820. + type
  2821. [(string*string)]
  2822. + id
  2823. Does not do anything, simply forwards its input stream.
  2824. + _category
  2825. Source / Conversions
  2826. + _type
  2827. (?id:string,source('a))->source('a)
  2828. + id
  2829. Force the value of the source ID.
  2830. + default
  2831. ""
  2832. + type
  2833. string
  2834. + (unlabeled)
  2835. (no doc)
  2836. + default
  2837. None
  2838. + type
  2839. source('a)
  2840. + if
  2841. The basic conditional.
  2842. + _category
  2843. Control
  2844. + _type
  2845. (bool,then:(()->'a),else:(()->'a))->'a
  2846. + _flag
  2847. hidden
  2848. + (unlabeled)
  2849. (no doc)
  2850. + default
  2851. None
  2852. + type
  2853. bool
  2854. + then
  2855. (no doc)
  2856. + default
  2857. None
  2858. + type
  2859. ()->'a
  2860. + else
  2861. (no doc)
  2862. + default
  2863. None
  2864. + type
  2865. ()->'a
  2866. + ignore
  2867. Convert anything to unit, preventing warnings.
  2868. + _category
  2869. Control
  2870. + _type
  2871. ('a)->unit
  2872. + (unlabeled)
  2873. (no doc)
  2874. + default
  2875. None
  2876. + type
  2877. 'a
  2878. + in
  2879. Create a source from the first available input driver in pulseaudio, portaudio, oss, alsa, blank.
  2880. + _category
  2881. Source / Input
  2882. + id
  2883. (no doc)
  2884. + default
  2885. ""
  2886. + type
  2887. string
  2888. + start
  2889. (no doc)
  2890. + default
  2891. true
  2892. + type
  2893. bool
  2894. + on_start
  2895. (no doc)
  2896. + default
  2897. {()}
  2898. + type
  2899. ()->unit
  2900. + on_stop
  2901. (no doc)
  2902. + default
  2903. {()}
  2904. + type
  2905. ()->unit
  2906. + fallible
  2907. (no doc)
  2908. + default
  2909. false
  2910. + type
  2911. bool
  2912. + _type
  2913. (?id:string,?start:bool,?on_start:(()->unit),
  2914. ?on_stop:(()->unit),?fallible:bool)->
  2915. active_source(audio='#a+1,video=0,midi=0)
  2916. + input.external
  2917. Stream data from an external application.
  2918. + _category
  2919. Source / Input
  2920. + _type
  2921. (?id:string,?buffer:float,?channels:int,?max:float,
  2922. ?restart:bool,?restart_on_error:bool,?samplerate:int,
  2923. string)->source(audio='#a+1,video=0,midi=0)
  2924. + id
  2925. Force the value of the source ID.
  2926. + default
  2927. ""
  2928. + type
  2929. string
  2930. + buffer
  2931. Duration of the pre-buffered data.
  2932. + default
  2933. 2.
  2934. + type
  2935. float
  2936. + channels
  2937. Number of channels.
  2938. + default
  2939. 2
  2940. + type
  2941. int
  2942. + max
  2943. Maximum duration of the buffered data.
  2944. + default
  2945. 10.
  2946. + type
  2947. float
  2948. + restart
  2949. Restart process when exited.
  2950. + default
  2951. true
  2952. + type
  2953. bool
  2954. + restart_on_error
  2955. Restart process when exited with error.
  2956. + default
  2957. false
  2958. + type
  2959. bool
  2960. + samplerate
  2961. Samplerate.
  2962. + default
  2963. 44100
  2964. + type
  2965. int
  2966. + (unlabeled)
  2967. Command to execute.
  2968. + default
  2969. None
  2970. + type
  2971. string
  2972. + input.harbor
  2973. Retrieves the given http stream from the harbor.
  2974. + _category
  2975. Source / Input
  2976. + _type
  2977. (?id:string,?auth:((string,string)->bool),?buffer:float,
  2978. ?debug:bool,?dumpfile:string,?icy:bool,
  2979. ?icy_metadata_charset:string,?logfile:string,?max:float,
  2980. ?metadata_charset:string,
  2981. ?on_connect:(([(string*string)])->unit),
  2982. ?on_disconnect:(()->unit),?password:string,?port:int,
  2983. ?timeout:float,?user:string,string)->source('a)
  2984. + id
  2985. Force the value of the source ID.
  2986. + default
  2987. ""
  2988. + type
  2989. string
  2990. + auth
  2991. Authentication function. <code>f(login,password)</code> returns <code>true</code> if the user should be granted access for this login. Override any other method if used.
  2992. + default
  2993. fun (_,_) -> false
  2994. + type
  2995. (string,string)->bool
  2996. + buffer
  2997. Duration of the pre-buffered data.
  2998. + default
  2999. 2.
  3000. + type
  3001. float
  3002. + debug
  3003. Run in debugging mode by not catching some exceptions.
  3004. + default
  3005. false
  3006. + type
  3007. bool
  3008. + dumpfile
  3009. Dump stream to file, for debugging purpose. Disabled if empty.
  3010. + default
  3011. ""
  3012. + type
  3013. string
  3014. + icy
  3015. Enable ICY (shoutcast) protocol.
  3016. + default
  3017. false
  3018. + type
  3019. bool
  3020. + icy_metadata_charset
  3021. ICY (shoutcast) metadata charset. Guessed if empty. Default for shoutcast is ISO-8859-1. Set to that value if all your clients send metadata using this charset and automatic detection is not working for you.
  3022. + default
  3023. ""
  3024. + type
  3025. string
  3026. + logfile
  3027. Log buffer status to file, for debugging purpose. Disabled if empty.
  3028. + default
  3029. ""
  3030. + type
  3031. string
  3032. + max
  3033. Maximum duration of the buffered data.
  3034. + default
  3035. 10.
  3036. + type
  3037. float
  3038. + metadata_charset
  3039. Metadata charset for non-ICY (shoutcast) source protocols. Guessed if empty.
  3040. + default
  3041. ""
  3042. + type
  3043. string
  3044. + on_connect
  3045. Function to execute when a source is connected. Its receives the list of headers, of the form: (<label>,<value>). All labels are lowercase.
  3046. + default
  3047. fun (_) -> ()
  3048. + type
  3049. ([(string*string)])->unit
  3050. + on_disconnect
  3051. Functions to excecute when a source is disconnected
  3052. + default
  3053. {()}
  3054. + type
  3055. ()->unit
  3056. + password
  3057. Source password.
  3058. + default
  3059. "hackme"
  3060. + type
  3061. string
  3062. + port
  3063. Port used to connect to the source.
  3064. + default
  3065. 8005
  3066. + type
  3067. int
  3068. + timeout
  3069. Timeout for source connectionn.
  3070. + default
  3071. 30.
  3072. + type
  3073. float
  3074. + user
  3075. Source user.
  3076. + default
  3077. "source"
  3078. + type
  3079. string
  3080. + (unlabeled)
  3081. Mountpoint to look for.
  3082. + default
  3083. None
  3084. + type
  3085. string
  3086. + input.http
  3087. Forwards the given http stream. The relay can be paused/resumed using the start/stop telnet commands.
  3088. + _category
  3089. Source / Input
  3090. + _type
  3091. (?id:string,?autostart:bool,?bind_address:string,
  3092. ?buffer:float,?debug:bool,?force_mime:string,
  3093. ?logfile:string,?max:float,?new_track_on_metadata:bool,
  3094. ?playlist_mode:string,?poll_delay:float,?timeout:float,
  3095. ?user_agent:string,string)->source('a)
  3096. + id
  3097. Force the value of the source ID.
  3098. + default
  3099. ""
  3100. + type
  3101. string
  3102. + autostart
  3103. Initially start relaying or not.
  3104. + default
  3105. true
  3106. + type
  3107. bool
  3108. + bind_address
  3109. Address to bind on the local machine. This option can be useful if your machine is bound to multiple IPs. Empty means no bind address.
  3110. + default
  3111. ""
  3112. + type
  3113. string
  3114. + buffer
  3115. Duration of the pre-buffered data.
  3116. + default
  3117. 2.
  3118. + type
  3119. float
  3120. + debug
  3121. Run in debugging mode, not catching some exceptions.
  3122. + default
  3123. false
  3124. + type
  3125. bool
  3126. + force_mime
  3127. Force mime data type. Not used if empty.
  3128. + default
  3129. ""
  3130. + type
  3131. string
  3132. + logfile
  3133. Log buffer status to file, for debugging purpose. Disabled if empty.
  3134. + default
  3135. ""
  3136. + type
  3137. string
  3138. + max
  3139. Maximum duration of the buffered data.
  3140. + default
  3141. 10.
  3142. + type
  3143. float
  3144. + new_track_on_metadata
  3145. Treat new metadata as new track.
  3146. + default
  3147. true
  3148. + type
  3149. bool
  3150. + playlist_mode
  3151. Valid modes are "normal", "random", "randomize" and "first". The first ones have the same meaning as for the mode parameter of the playlist operator. The last one discards all entries but the first one.
  3152. + default
  3153. "normal"
  3154. + type
  3155. string
  3156. + poll_delay
  3157. Polling delay when trying to connect to the stream.
  3158. + default
  3159. 2.
  3160. + type
  3161. float
  3162. + timeout
  3163. Timeout for source connectionn.
  3164. + default
  3165. 30.
  3166. + type
  3167. float
  3168. + user_agent
  3169. User agent.
  3170. + default
  3171. "Liquidsoap/1.1.1 (Unix; OCaml 3.12.1)"
  3172. + type
  3173. string
  3174. + (unlabeled)
  3175. URL of an http stream (default port is 80).
  3176. + default
  3177. None
  3178. + type
  3179. string
  3180. + input.keyboard
  3181. Play notes from the keyboard.
  3182. + _category
  3183. Source / Input
  3184. + _type
  3185. (?id:string)->source(audio='#a,video=0,midi='#b+1)
  3186. + _flag
  3187. hidden
  3188. + _flag
  3189. experimental
  3190. + id
  3191. Force the value of the source ID.
  3192. + default
  3193. ""
  3194. + type
  3195. string
  3196. + input.mplayer
  3197. Stream data from mplayer
  3198. + _category
  3199. Source / Input
  3200. + _category
  3201. Source / Input
  3202. + id
  3203. (no doc)
  3204. + default
  3205. "input.mplayer"
  3206. + type
  3207. string
  3208. + restart
  3209. restart on exit.
  3210. + default
  3211. true
  3212. + type
  3213. bool
  3214. + restart_on_error
  3215. restart on exit with error.
  3216. + default
  3217. false
  3218. + type
  3219. bool
  3220. + buffer
  3221. Duration of the pre-buffered data.
  3222. + default
  3223. 0.2
  3224. + type
  3225. float
  3226. + max
  3227. Maximum duration of the buffered data.
  3228. + default
  3229. 10.
  3230. + type
  3231. float
  3232. + (unlabeled)
  3233. data URI.
  3234. + default
  3235. None
  3236. + type
  3237. string
  3238. + _type
  3239. (?id:string,?restart:bool,?restart_on_error:bool,
  3240. ?buffer:float,?max:float,string)->
  3241. source(audio='#a+1,video=0,midi=0)
  3242. + input.oss
  3243. Stream from an OSS input device.
  3244. + _category
  3245. Source / Input
  3246. + _type
  3247. (?id:string,?clock_safe:bool,?device:string,
  3248. ?fallible:bool,?on_start:(()->unit),?on_stop:(()->unit),
  3249. ?start:bool)->active_source(audio='#a+1,video=0,midi=0)
  3250. + id
  3251. Force the value of the source ID.
  3252. + default
  3253. ""
  3254. + type
  3255. string
  3256. + clock_safe
  3257. Force the use of the dedicated OSS clock.
  3258. + default
  3259. true
  3260. + type
  3261. bool
  3262. + device
  3263. OSS device to use.
  3264. + default
  3265. "/dev/dsp"
  3266. + type
  3267. string
  3268. + fallible
  3269. Allow the input to stop. When false, the source will be infallible but the stop command won't have any effect.
  3270. + default
  3271. false
  3272. + type
  3273. bool
  3274. + on_start
  3275. Callback executed when input starts.
  3276. + default
  3277. {()}
  3278. + type
  3279. ()->unit
  3280. + on_stop
  3281. Callback executed when input stops.
  3282. + default
  3283. {()}
  3284. + type
  3285. ()->unit
  3286. + start
  3287. Start input as soon as it is created. Disabling it is only taken into account for a fallible input.
  3288. + default
  3289. true
  3290. + type
  3291. bool
  3292. + input.udp
  3293. Input encoded data from UDP, without any control whatsoever.
  3294. + _category
  3295. Source / Input
  3296. + _type
  3297. (?id:string,?buffer:float,host:string,port:int,string)->
  3298. active_source('a)
  3299. + _flag
  3300. experimental
  3301. + id
  3302. Force the value of the source ID.
  3303. + default
  3304. ""
  3305. + type
  3306. string
  3307. + buffer
  3308. Duration of buffered data before starting playout.
  3309. + default
  3310. 1.
  3311. + type
  3312. float
  3313. + host
  3314. (no doc)
  3315. + default
  3316. None
  3317. + type
  3318. string
  3319. + port
  3320. (no doc)
  3321. + default
  3322. None
  3323. + type
  3324. int
  3325. + (unlabeled)
  3326. Mime type.
  3327. + default
  3328. None
  3329. + type
  3330. string
  3331. + insert_metadata
  3332. Dynamically insert metadata in a stream. Returns a pair (f,s) where s is a new source and f is a function of type (metadata)->unit, used to insert metadata in s.
  3333. + _category
  3334. Source / Track Processing
  3335. + _type
  3336. (?id:string,source('a))->
  3337. ((([(string*string)])->unit)*source('a))
  3338. + id
  3339. Force the value of the source ID.
  3340. + default
  3341. ""
  3342. + type
  3343. string
  3344. + (unlabeled)
  3345. (no doc)
  3346. + default
  3347. None
  3348. + type
  3349. source('a)
  3350. + int_of_float
  3351. Convert a float to a int.
  3352. + _category
  3353. Math
  3354. + _type
  3355. (float)->int
  3356. + (unlabeled)
  3357. (no doc)
  3358. + default
  3359. None
  3360. + type
  3361. float
  3362. + int_of_string
  3363. Convert a string to a int.
  3364. + _category
  3365. String
  3366. + _type
  3367. (?default:int,string)->int
  3368. + default
  3369. (no doc)
  3370. + default
  3371. 0
  3372. + type
  3373. int
  3374. + (unlabeled)
  3375. (no doc)
  3376. + default
  3377. None
  3378. + type
  3379. string
  3380. + interactive.bool
  3381. Read a boolean from an interactive input.
  3382. + _category
  3383. Interaction
  3384. + _type
  3385. (string,bool)->()->bool
  3386. + (unlabeled)
  3387. (no doc)
  3388. + default
  3389. None
  3390. + type
  3391. string
  3392. + (unlabeled)
  3393. (no doc)
  3394. + default
  3395. None
  3396. + type
  3397. bool
  3398. + interactive.float
  3399. Read a float from an interactive input.
  3400. + _category
  3401. Interaction
  3402. + _type
  3403. (string,float)->()->float
  3404. + (unlabeled)
  3405. (no doc)
  3406. + default
  3407. None
  3408. + type
  3409. string
  3410. + (unlabeled)
  3411. (no doc)
  3412. + default
  3413. None
  3414. + type
  3415. float
  3416. + interactive.string
  3417. Read a string from an interactive input.
  3418. + _category
  3419. Interaction
  3420. + _type
  3421. (string,string)->()->string
  3422. + (unlabeled)
  3423. (no doc)
  3424. + default
  3425. None
  3426. + type
  3427. string
  3428. + (unlabeled)
  3429. (no doc)
  3430. + default
  3431. None
  3432. + type
  3433. string
  3434. + is_directory
  3435. Returns true if the directory exists.
  3436. + _category
  3437. System
  3438. + _type
  3439. (string)->bool
  3440. + (unlabeled)
  3441. (no doc)
  3442. + default
  3443. None
  3444. + type
  3445. string
  3446. + json_of
  3447. Convert a value to a json string.
  3448. + _category
  3449. String
  3450. + _type
  3451. (?compact:bool,'a)->string
  3452. + compact
  3453. Output compact text.
  3454. + default
  3455. false
  3456. + type
  3457. bool
  3458. + (unlabeled)
  3459. (no doc)
  3460. + default
  3461. None
  3462. + type
  3463. 'a
  3464. + limit
  3465. Limit the signal.
  3466. + _category
  3467. Source / Sound Processing
  3468. + _type
  3469. (?id:string,?attack:'a,?gain:'b,?knee:'c,?ratio:float,
  3470. ?release:'d,?rms_window:float,?threshold:'e,
  3471. source(audio='#f,video='#g,midi='#h))->
  3472. source(audio='#f,video='#g,midi='#h)
  3473. where 'a, 'b, 'c, 'd, 'e is either float or ()->float
  3474. + id
  3475. Force the value of the source ID.
  3476. + default
  3477. ""
  3478. + type
  3479. string
  3480. + attack
  3481. Attack time (ms).
  3482. + default
  3483. 100.
  3484. + type
  3485. anything that is either float or ()->float
  3486. + gain
  3487. Additional gain (dB).
  3488. + default
  3489. 0.
  3490. + type
  3491. anything that is either float or ()->float
  3492. + knee
  3493. Knee radius (dB).
  3494. + default
  3495. 1.
  3496. + type
  3497. anything that is either float or ()->float
  3498. + ratio
  3499. Gain reduction ratio (n:1).
  3500. + default
  3501. 20.
  3502. + type
  3503. float
  3504. + release
  3505. Release time (ms).
  3506. + default
  3507. 400.
  3508. + type
  3509. anything that is either float or ()->float
  3510. + rms_window
  3511. Window for computing RMS (in sec).
  3512. + default
  3513. 0.1
  3514. + type
  3515. float
  3516. + threshold
  3517. Threshold level (dB).
  3518. + default
  3519. -10.
  3520. + type
  3521. anything that is either float or ()->float
  3522. + (unlabeled)
  3523. (no doc)
  3524. + default
  3525. None
  3526. + type
  3527. source(audio='#f,video='#g,midi='#h)
  3528. + lin_of_dB
  3529. Convert decibels into linear scale.
  3530. + _category
  3531. Math
  3532. + _type
  3533. (float)->float
  3534. + (unlabeled)
  3535. (no doc)
  3536. + default
  3537. None
  3538. + type
  3539. float
  3540. + liquidsoap.version
  3541. Liquidsoap version string.
  3542. + _category
  3543. Liquidsoap
  3544. + _type
  3545. string
  3546. + list.add
  3547. Add an element at the top of a list.
  3548. + _category
  3549. List
  3550. + _type
  3551. ('a,['a])->['a]
  3552. + (unlabeled)
  3553. (no doc)
  3554. + default
  3555. None
  3556. + type
  3557. 'a
  3558. + (unlabeled)
  3559. (no doc)
  3560. + default
  3561. None
  3562. + type
  3563. ['a]
  3564. + list.append
  3565. Catenate two lists.
  3566. + _category
  3567. List
  3568. + _type
  3569. (['a],['a])->['a]
  3570. + (unlabeled)
  3571. (no doc)
  3572. + default
  3573. None
  3574. + type
  3575. ['a]
  3576. + (unlabeled)
  3577. (no doc)
  3578. + default
  3579. None
  3580. + type
  3581. ['a]
  3582. + list.assoc
  3583. Alias for the <code>l[k]</code> notation.
  3584. + _category
  3585. List
  3586. + (unlabeled)
  3587. Key to look for
  3588. + default
  3589. None
  3590. + type
  3591. string
  3592. + (unlabeled)
  3593. List of pairs (key,value)
  3594. + default
  3595. None
  3596. + type
  3597. [(string*string)]
  3598. + _type
  3599. (string,[(string*string)])->string
  3600. + list.filter
  3601. Filter a list according to a filtering function.
  3602. + _category
  3603. List
  3604. + _type
  3605. ((('a)->bool),['a])->['a]
  3606. + (unlabeled)
  3607. (no doc)
  3608. + default
  3609. None
  3610. + type
  3611. ('a)->bool
  3612. + (unlabeled)
  3613. (no doc)
  3614. + default
  3615. None
  3616. + type
  3617. ['a]
  3618. + list.fold
  3619. Fold a function on every element of a list: list.fold(f,x1,[e1,..,en]) is f(...f(f(x1,e1),e2)...,en).
  3620. + _category
  3621. List
  3622. + _type
  3623. ((('a,'b)->'a),'a,['b])->'a
  3624. + (unlabeled)
  3625. Function f for which f(x,e) which will be called on every element e with the current value of x, returning the new value of x.
  3626. + default
  3627. None
  3628. + type
  3629. ('a,'b)->'a
  3630. + (unlabeled)
  3631. Initial value x1, to be updated by successive calls of f(x,e).
  3632. + default
  3633. None
  3634. + type
  3635. 'a
  3636. + (unlabeled)
  3637. (no doc)
  3638. + default
  3639. None
  3640. + type
  3641. ['b]
  3642. + list.hd
  3643. Return the head (first element) of a list, or "" if the list is empty.
  3644. + _category
  3645. List
  3646. + _type
  3647. ([string])->string
  3648. + (unlabeled)
  3649. (no doc)
  3650. + default
  3651. None
  3652. + type
  3653. [string]
  3654. + list.iter
  3655. Call a function on every element of a list.
  3656. + _category
  3657. List
  3658. + _type
  3659. ((('a)->unit),['a])->unit
  3660. + (unlabeled)
  3661. (no doc)
  3662. + default
  3663. None
  3664. + type
  3665. ('a)->unit
  3666. + (unlabeled)
  3667. (no doc)
  3668. + default
  3669. None
  3670. + type
  3671. ['a]
  3672. + list.length
  3673. Get the length of a list, i.e. its number of elements.
  3674. + _category
  3675. List
  3676. + _type
  3677. (['a])->int
  3678. + (unlabeled)
  3679. (no doc)
  3680. + default
  3681. None
  3682. + type
  3683. ['a]
  3684. + list.map
  3685. Map a function on every element of a list.
  3686. + _category
  3687. List
  3688. + _type
  3689. ((('a)->'b),['a])->['b]
  3690. + (unlabeled)
  3691. (no doc)
  3692. + default
  3693. None
  3694. + type
  3695. ('a)->'b
  3696. + (unlabeled)
  3697. (no doc)
  3698. + default
  3699. None
  3700. + type
  3701. ['a]
  3702. + list.mem
  3703. Check if an element belongs to a list.
  3704. + _category
  3705. List
  3706. + _type
  3707. ('a,['a])->bool where 'a is an orderable type
  3708. + (unlabeled)
  3709. (no doc)
  3710. + default
  3711. None
  3712. + type
  3713. anything that is an orderable type
  3714. + (unlabeled)
  3715. (no doc)
  3716. + default
  3717. None
  3718. + type
  3719. ['a] where 'a is an orderable type
  3720. + list.mem_assoc
  3721. list.mem_assoc(key,l) returns true if l contains a pair (key,value)
  3722. + _category
  3723. List
  3724. + (unlabeled)
  3725. Key to look for
  3726. + default
  3727. None
  3728. + type
  3729. anything that is an orderable type
  3730. + (unlabeled)
  3731. List of pairs (key,value)
  3732. + default
  3733. None
  3734. + type
  3735. [('a*'b)] where 'a is an orderable type
  3736. + _type
  3737. ('a,[('a*'b)])->bool where 'a is an orderable type
  3738. + list.nth
  3739. Get the n-th element of a list (the first element is at position 0).
  3740. + _category
  3741. List
  3742. + _type
  3743. (['a],int)->'a
  3744. + (unlabeled)
  3745. (no doc)
  3746. + default
  3747. None
  3748. + type
  3749. ['a]
  3750. + (unlabeled)
  3751. (no doc)
  3752. + default
  3753. None
  3754. + type
  3755. int
  3756. + list.randomize
  3757. Shuffle the content of a list.
  3758. + _category
  3759. List
  3760. + _type
  3761. (['a])->['a]
  3762. + (unlabeled)
  3763. (no doc)
  3764. + default
  3765. None
  3766. + type
  3767. ['a]
  3768. + list.remove
  3769. Remove a value from a list.
  3770. + _category
  3771. List
  3772. + _type
  3773. ('a,['a])->['a]
  3774. + (unlabeled)
  3775. (no doc)
  3776. + default
  3777. None
  3778. + type
  3779. 'a
  3780. + (unlabeled)
  3781. (no doc)
  3782. + default
  3783. None
  3784. + type
  3785. ['a]
  3786. + list.remove_assoc
  3787. Remove a pair from an associative list
  3788. + _category
  3789. List
  3790. + (unlabeled)
  3791. Key of pair to be removed
  3792. + default
  3793. None
  3794. + type
  3795. string
  3796. + (unlabeled)
  3797. List of pairs (key,value)
  3798. + default
  3799. None
  3800. + type
  3801. [(string*string)]
  3802. + _type
  3803. (string,[(string*string)])->[(string*string)]
  3804. + list.rev
  3805. Revert list order.
  3806. + _category
  3807. List
  3808. + _type
  3809. (['a])->['a]
  3810. + (unlabeled)
  3811. (no doc)
  3812. + default
  3813. None
  3814. + type
  3815. ['a]
  3816. + list.sort
  3817. Sort a list according to a comparison function.
  3818. + _category
  3819. List
  3820. + _type
  3821. ((('a,'a)->int),['a])->['a]
  3822. + (unlabeled)
  3823. (no doc)
  3824. + default
  3825. None
  3826. + type
  3827. ('a,'a)->int
  3828. + (unlabeled)
  3829. (no doc)
  3830. + default
  3831. None
  3832. + type
  3833. ['a]
  3834. + list.tl
  3835. Return the list without its first element.
  3836. + _category
  3837. List
  3838. + _type
  3839. (['a])->['a]
  3840. + (unlabeled)
  3841. (no doc)
  3842. + default
  3843. None
  3844. + type
  3845. ['a]
  3846. + log
  3847. Log a message.
  3848. + _category
  3849. Liquidsoap
  3850. + _type
  3851. (?label:string,?level:int,string)->unit
  3852. + label
  3853. (no doc)
  3854. + default
  3855. "lang"
  3856. + type
  3857. string
  3858. + level
  3859. (no doc)
  3860. + default
  3861. 3
  3862. + type
  3863. int
  3864. + (unlabeled)
  3865. (no doc)
  3866. + default
  3867. None
  3868. + type
  3869. string
  3870. + log_clocks
  3871. Create a log of clock times for all the clocks initially present.
  3872. The log is in a simple format which you can directly use with gnuplot.
  3873. + _category
  3874. Liquidsoap
  3875. + delay
  3876. Delay before setting up the clock logger. This should be used to ensure that the logger starts only after the clocks are created.
  3877. + default
  3878. 0.
  3879. + type
  3880. float
  3881. + interval
  3882. Polling interval.
  3883. + default
  3884. 1.
  3885. + type
  3886. float
  3887. + (unlabeled)
  3888. Path of the log file.
  3889. + default
  3890. None
  3891. + type
  3892. string
  3893. + _type
  3894. (?delay:float,?interval:float,string)->unit
  3895. + map_metadata
  3896. Rewrite metadata on the fly using a function.
  3897. + _category
  3898. Source / Track Processing
  3899. + _type
  3900. (?id:string,?insert_missing:bool,?strip:bool,
  3901. ?update:bool,(([(string*string)])->[(string*string)]),
  3902. source('a))->source('a)
  3903. + id
  3904. Force the value of the source ID.
  3905. + default
  3906. ""
  3907. + type
  3908. string
  3909. + insert_missing
  3910. Treat track beginnings without metadata as having empty ones. The operational order is: create empty if needed, map and strip if enabled.
  3911. + default
  3912. true
  3913. + type
  3914. bool
  3915. + strip
  3916. Completely remove empty metadata. Operates on both empty values and empty metadata chunk.
  3917. + default
  3918. false
  3919. + type
  3920. bool
  3921. + update
  3922. Only update metadata. If false, only returned values will be set as metadata.
  3923. + default
  3924. true
  3925. + type
  3926. bool
  3927. + (unlabeled)
  3928. A function that returns new metadata.
  3929. + default
  3930. None
  3931. + type
  3932. ([(string*string)])->[(string*string)]
  3933. + (unlabeled)
  3934. (no doc)
  3935. + default
  3936. None
  3937. + type
  3938. source('a)
  3939. + max_int
  3940. Maximal representable integer.
  3941. + _category
  3942. Math
  3943. + _type
  3944. ()->int
  3945. + _flag
  3946. hidden
  3947. + mean
  3948. Produce mono audio by taking the mean of all audio channels.
  3949. + _category
  3950. Source / Conversions
  3951. + _type
  3952. (?id:string,source(audio='#a,video='#b,midi='#c))->
  3953. source(audio=1,video='#b,midi='#c)
  3954. + id
  3955. Force the value of the source ID.
  3956. + default
  3957. ""
  3958. + type
  3959. string
  3960. + (unlabeled)
  3961. (no doc)
  3962. + default
  3963. None
  3964. + type
  3965. source(audio='#a,video='#b,midi='#c)
  3966. + merge_tracks
  3967. Merge all tracks from a source.
  3968. + _category
  3969. Source / Track Processing
  3970. + (unlabeled)
  3971. (no doc)
  3972. + default
  3973. None
  3974. + type
  3975. source('a)
  3976. + _type
  3977. (source('a))->source('a)
  3978. + metadata.export
  3979. Filter-out internal metadata.
  3980. + _category
  3981. Liquidsoap
  3982. + _type
  3983. ([(string*string)])->[(string*string)]
  3984. + (unlabeled)
  3985. (no doc)
  3986. + default
  3987. None
  3988. + type
  3989. [(string*string)]
  3990. + mic_filter
  3991. Remove low frequencies often produced by microphones.
  3992. + _category
  3993. Source / Sound Processing
  3994. + (unlabeled)
  3995. The input source.
  3996. + default
  3997. None
  3998. + type
  3999. source(audio='#a,video='#b,midi='#c)
  4000. + _type
  4001. (source(audio='#a,video='#b,midi='#c))->
  4002. source(audio='#a,video='#b,midi='#c)
  4003. + midi.chord
  4004. Generate a chord.
  4005. + _category
  4006. Source / MIDI Processing
  4007. + _type
  4008. (?id:string,?metadata:string,
  4009. source(audio='#a,video='#b,midi='#c))->
  4010. source(audio='#a,video='#b,midi='#c+1)
  4011. + id
  4012. Force the value of the source ID.
  4013. + default
  4014. ""
  4015. + type
  4016. string
  4017. + metadata
  4018. Name of the metadata containing the chords.
  4019. + default
  4020. "chord"
  4021. + type
  4022. string
  4023. + (unlabeled)
  4024. (no doc)
  4025. + default
  4026. None
  4027. + type
  4028. source(audio='#a,video='#b,midi='#c)
  4029. + midi.merge_all
  4030. Merge all MIDI tracks in one.
  4031. + _category
  4032. Source / MIDI Processing
  4033. + _type
  4034. (?id:string,?track_out:int,
  4035. source(audio='#a,video='#b,midi='#c+1))->
  4036. source(audio='#a,video='#b,midi='#c+1)
  4037. + id
  4038. Force the value of the source ID.
  4039. + default
  4040. ""
  4041. + type
  4042. string
  4043. + track_out
  4044. Destination track.
  4045. + default
  4046. 0
  4047. + type
  4048. int
  4049. + (unlabeled)
  4050. (no doc)
  4051. + default
  4052. None
  4053. + type
  4054. source(audio='#a,video='#b,midi='#c+1)
  4055. + midi.remove
  4056. Remove MIDI tracks.
  4057. + _category
  4058. Source / MIDI Processing
  4059. + _type
  4060. (?id:string,[int],source(audio='#a,video='#b,midi='#c+1))->
  4061. source(audio='#a,video='#b,midi='#c+1)
  4062. + id
  4063. Force the value of the source ID.
  4064. + default
  4065. ""
  4066. + type
  4067. string
  4068. + (unlabeled)
  4069. Tracks to remove.
  4070. + default
  4071. None
  4072. + type
  4073. [int]
  4074. + (unlabeled)
  4075. (no doc)
  4076. + default
  4077. None
  4078. + type
  4079. source(audio='#a,video='#b,midi='#c+1)
  4080. + midimeter
  4081. Display midi events.
  4082. + _category
  4083. Source / Visualization
  4084. + _type
  4085. (?id:string,source(audio='#a,video='#b,midi='#c))->
  4086. source(audio='#a,video='#b,midi='#c)
  4087. + _flag
  4088. hidden
  4089. + _flag
  4090. experimental
  4091. + id
  4092. Force the value of the source ID.
  4093. + default
  4094. ""
  4095. + type
  4096. string
  4097. + (unlabeled)
  4098. (no doc)
  4099. + default
  4100. None
  4101. + type
  4102. source(audio='#a,video='#b,midi='#c)
  4103. + min_int
  4104. Minimal representable integer.
  4105. + _category
  4106. Math
  4107. + _type
  4108. ()->int
  4109. + _flag
  4110. hidden
  4111. + mix
  4112. Mixing table controllable via the telnet interface.
  4113. + _category
  4114. Source / Sound Processing
  4115. + _type
  4116. (?id:string,[source(audio='#a,video='#b,midi='#c)])->
  4117. source(audio='#a,video='#b,midi='#c)
  4118. + id
  4119. Force the value of the source ID.
  4120. + default
  4121. ""
  4122. + type
  4123. string
  4124. + (unlabeled)
  4125. (no doc)
  4126. + default
  4127. None
  4128. + type
  4129. [source(audio='#a,video='#b,midi='#c)]
  4130. + mksafe
  4131. Turn a source into an infaillible source.
  4132. by adding blank when the source is not available.
  4133. + _category
  4134. Source / Track Processing
  4135. + (unlabeled)
  4136. the source to turn infaillible
  4137. + default
  4138. None
  4139. + type
  4140. source('a)
  4141. + _type
  4142. (source('a))->source('a)
  4143. + mod
  4144. Integer remainder. If y is not zero, x == (x / y) * y + x mod y, and abs(x mod y) <= abs(y)-1.
  4145. + _category
  4146. Math
  4147. + _type
  4148. (int,int)->int
  4149. + (unlabeled)
  4150. (no doc)
  4151. + default
  4152. None
  4153. + type
  4154. int
  4155. + (unlabeled)
  4156. (no doc)
  4157. + default
  4158. None
  4159. + type
  4160. int
  4161. + mux_audio
  4162. Mux an audio stream into an audio-free stream.
  4163. + _category
  4164. Source / Conversions
  4165. + _type
  4166. (?id:string,audio:source(audio='#a,video=0,midi=0),
  4167. source(audio=0,video='#b,midi='#c))->
  4168. source(audio='#a,video='#b,midi='#c)
  4169. + id
  4170. Force the value of the source ID.
  4171. + default
  4172. ""
  4173. + type
  4174. string
  4175. + audio
  4176. (no doc)
  4177. + default
  4178. None
  4179. + type
  4180. source(audio='#a,video=0,midi=0)
  4181. + (unlabeled)
  4182. (no doc)
  4183. + default
  4184. None
  4185. + type
  4186. source(audio=0,video='#b,midi='#c)
  4187. + mux_mono
  4188. Mux a mono audio stream into another stream.
  4189. + _category
  4190. Source / Conversions
  4191. + _type
  4192. (?id:string,mono:source(audio=1,video=0,midi=0),
  4193. source(audio='#a,video='#b,midi='#c))->
  4194. source(audio='#a+1,video='#b,midi='#c)
  4195. + id
  4196. Force the value of the source ID.
  4197. + default
  4198. ""
  4199. + type
  4200. string
  4201. + mono
  4202. (no doc)
  4203. + default
  4204. None
  4205. + type
  4206. source(audio=1,video=0,midi=0)
  4207. + (unlabeled)
  4208. (no doc)
  4209. + default
  4210. None
  4211. + type
  4212. source(audio='#a,video='#b,midi='#c)
  4213. + mux_stereo
  4214. Mux a stereo audio stream into another stream.
  4215. + _category
  4216. Source / Conversions
  4217. + _type
  4218. (?id:string,stereo:source(audio=2,video=0,midi=0),
  4219. source(audio='#a,video='#b,midi='#c))->
  4220. source(audio='#a+2,video='#b,midi='#c)
  4221. + id
  4222. Force the value of the source ID.
  4223. + default
  4224. ""
  4225. + type
  4226. string
  4227. + stereo
  4228. (no doc)
  4229. + default
  4230. None
  4231. + type
  4232. source(audio=2,video=0,midi=0)
  4233. + (unlabeled)
  4234. (no doc)
  4235. + default
  4236. None
  4237. + type
  4238. source(audio='#a,video='#b,midi='#c)
  4239. + mux_video
  4240. Add video channnels to a stream.
  4241. + _category
  4242. Source / Conversions
  4243. + _type
  4244. (?id:string,video:source(audio=0,video='#a,midi=0),
  4245. source(audio='#b,video=0,midi='#c))->
  4246. source(audio='#b,video='#a,midi='#c)
  4247. + id
  4248. Force the value of the source ID.
  4249. + default
  4250. ""
  4251. + type
  4252. string
  4253. + video
  4254. (no doc)
  4255. + default
  4256. None
  4257. + type
  4258. source(audio=0,video='#a,midi=0)
  4259. + (unlabeled)
  4260. (no doc)
  4261. + default
  4262. None
  4263. + type
  4264. source(audio='#b,video=0,midi='#c)
  4265. + noise
  4266. Generate white noise.
  4267. + _category
  4268. Source / Input
  4269. + _type
  4270. (?id:string,?duration:float)->
  4271. source(audio='a,video='b,midi=0)
  4272. + id
  4273. Force the value of the source ID.
  4274. + default
  4275. ""
  4276. + type
  4277. string
  4278. + duration
  4279. (no doc)
  4280. + default
  4281. 0.
  4282. + type
  4283. float
  4284. + normalize
  4285. Normalize the signal. Dynamic normalization of the signal is sometimes the only option, and can make a listening experience much nicer. However, its dynamic aspect implies some limitations which can go as far as creating saturation in some extreme cases. If possible, consider using some track-based normalization techniques such as those based on replay gain. See the documentation for more details.
  4286. + _category
  4287. Source / Sound Processing
  4288. + _type
  4289. (?id:string,?gain_max:'a,?gain_min:'b,?k_down:'c,
  4290. ?k_up:'d,?target:'e,?threshold:'f,?window:float,
  4291. source(audio='#g,video='#h,midi='#i))->
  4292. source(audio='#g,video='#h,midi='#i)
  4293. where 'a, 'b, 'c, 'd, 'e, 'f is either float or ()->float
  4294. + id
  4295. Force the value of the source ID.
  4296. + default
  4297. ""
  4298. + type
  4299. string
  4300. + gain_max
  4301. Maximal gain value (dB).
  4302. + default
  4303. 6.
  4304. + type
  4305. anything that is either float or ()->float
  4306. + gain_min
  4307. Minimal gain value (dB).
  4308. + default
  4309. -6.
  4310. + type
  4311. anything that is either float or ()->float
  4312. + k_down
  4313. Coefficient when the power must go down (between 0 and 1, slowest to fastest).
  4314. + default
  4315. 0.1
  4316. + type
  4317. anything that is either float or ()->float
  4318. + k_up
  4319. Coefficient when the power must go up (between 0 and 1, slowest to fastest).
  4320. + default
  4321. 0.005
  4322. + type
  4323. anything that is either float or ()->float
  4324. + target
  4325. Desired RMS (dB).
  4326. + default
  4327. -13.
  4328. + type
  4329. anything that is either float or ()->float
  4330. + threshold
  4331. Minimal RMS for activaing gain control (dB).
  4332. + default
  4333. -40.
  4334. + type
  4335. anything that is either float or ()->float
  4336. + window
  4337. Duration of the window used to compute the current RMS power (second).
  4338. + default
  4339. 0.1
  4340. + type
  4341. float
  4342. + (unlabeled)
  4343. (no doc)
  4344. + default
  4345. None
  4346. + type
  4347. source(audio='#g,video='#h,midi='#i)
  4348. + not
  4349. Returns the negation of its argument.
  4350. + _category
  4351. Bool
  4352. + _type
  4353. (bool)->bool
  4354. + (unlabeled)
  4355. (no doc)
  4356. + default
  4357. None
  4358. + type
  4359. bool
  4360. + notify_metadata
  4361. Use notify to display metadata info.
  4362. + _category
  4363. Source / Track Processing
  4364. + urgency
  4365. Urgency (low|normal|critical).
  4366. + default
  4367. "low"
  4368. + type
  4369. string
  4370. + icon
  4371. Icon filename or stock icon to display.
  4372. + default
  4373. "stock_smiley-22"
  4374. + type
  4375. string
  4376. + time
  4377. Timeout in milliseconds.
  4378. + default
  4379. 3000
  4380. + type
  4381. int
  4382. + display
  4383. Function used to display a metadata packet.
  4384. + default
  4385. <fun>
  4386. + type
  4387. ([(string*string)])->string
  4388. + title
  4389. Title of the notification message.
  4390. + default
  4391. "Liquidsoap: new track"
  4392. + type
  4393. string
  4394. + (unlabeled)
  4395. (no doc)
  4396. + default
  4397. None
  4398. + type
  4399. source('a)
  4400. + _type
  4401. (?urgency:string,?icon:string,?time:int,
  4402. ?display:(([(string*string)])->string),?title:string,
  4403. source('a))->source('a)
  4404. + nrj
  4405. Compress and normalize, producing a more uniform and "full" sound.
  4406. + _category
  4407. Source / Sound Processing
  4408. + (unlabeled)
  4409. The input source.
  4410. + default
  4411. None
  4412. + type
  4413. source(audio='#a,video='#b,midi='#c)
  4414. + _type
  4415. (source(audio='#a,video='#b,midi='#c))->
  4416. source(audio='#a,video='#b,midi='#c)
  4417. + of_json
  4418. Parse a json string into a liquidsoap value.
  4419. + _category
  4420. String
  4421. + _type
  4422. (default:'a,string)->'a
  4423. + default
  4424. Default value if string cannot be parsed.
  4425. + default
  4426. None
  4427. + type
  4428. 'a
  4429. + (unlabeled)
  4430. (no doc)
  4431. + default
  4432. None
  4433. + type
  4434. string
  4435. + on_blank
  4436. Calls a given handler when detecting a blank.
  4437. + _category
  4438. Source / Track Processing
  4439. + _type
  4440. (?id:string,?max_blank:float,?min_noise:float,
  4441. ?on_noise:(()->unit),?threshold:float,
  4442. ?track_sensitive:bool,(()->unit),
  4443. source(audio='#a,video='#b,midi='#c))->
  4444. source(audio='#a,video='#b,midi='#c)
  4445. + id
  4446. Force the value of the source ID.
  4447. + default
  4448. ""
  4449. + type
  4450. string
  4451. + max_blank
  4452. Maximum duration of silence allowed, in seconds.
  4453. + default
  4454. 20.
  4455. + type
  4456. float
  4457. + min_noise
  4458. Minimum duration of noise required to end silence, in seconds.
  4459. + default
  4460. 0.
  4461. + type
  4462. float
  4463. + on_noise
  4464. Handler called when noise is detected.
  4465. + default
  4466. {()}
  4467. + type
  4468. ()->unit
  4469. + threshold
  4470. Power in decibels under which the stream is considered silent.
  4471. + default
  4472. -40.
  4473. + type
  4474. float
  4475. + track_sensitive
  4476. Reset blank counter at each track.
  4477. + default
  4478. true
  4479. + type
  4480. bool
  4481. + (unlabeled)
  4482. Handler called when blank is detected.
  4483. + default
  4484. None
  4485. + type
  4486. ()->unit
  4487. + (unlabeled)
  4488. (no doc)
  4489. + default
  4490. None
  4491. + type
  4492. source(audio='#a,video='#b,midi='#c)
  4493. + on_end
  4494. Call a given handler when there is less than a given amount of time remaining before then end of track.
  4495. + _category
  4496. Source / Track Processing
  4497. + _type
  4498. (?id:string,?delay:float,
  4499. ((float,[(string*string)])->unit),source('a))->
  4500. source('a)
  4501. + id
  4502. Force the value of the source ID.
  4503. + default
  4504. ""
  4505. + type
  4506. string
  4507. + delay
  4508. Execute handler when remaining time is less or equal to this value.
  4509. + default
  4510. 5.
  4511. + type
  4512. float
  4513. + (unlabeled)
  4514. Function to execute. First argument is the remaining time, second is the latest metadata.
  4515. + default
  4516. None
  4517. + type
  4518. (float,[(string*string)])->unit
  4519. + (unlabeled)
  4520. (no doc)
  4521. + default
  4522. None
  4523. + type
  4524. source('a)
  4525. + on_metadata
  4526. Call a given handler on metadata packets.
  4527. + _category
  4528. Source / Track Processing
  4529. + _type
  4530. (?id:string,(([(string*string)])->unit),source('a))->
  4531. source('a)
  4532. + id
  4533. Force the value of the source ID.
  4534. + default
  4535. ""
  4536. + type
  4537. string
  4538. + (unlabeled)
  4539. Function called on every metadata packet in the stream. It should be fast because it is ran in the main thread.
  4540. + default
  4541. None
  4542. + type
  4543. ([(string*string)])->unit
  4544. + (unlabeled)
  4545. (no doc)
  4546. + default
  4547. None
  4548. + type
  4549. source('a)
  4550. + on_shutdown
  4551. Register a function to be called when Liquidsoap shuts down.
  4552. + _category
  4553. System
  4554. + _type
  4555. ((()->unit))->unit
  4556. + (unlabeled)
  4557. (no doc)
  4558. + default
  4559. None
  4560. + type
  4561. ()->unit
  4562. + on_track
  4563. Call a given handler on new tracks.
  4564. + _category
  4565. Source / Track Processing
  4566. + _type
  4567. (?id:string,(([(string*string)])->unit),source('a))->
  4568. source('a)
  4569. + id
  4570. Force the value of the source ID.
  4571. + default
  4572. ""
  4573. + type
  4574. string
  4575. + (unlabeled)
  4576. Function called on every beginning of track in the stream, with the corresponding metadata as argument. If there is no metadata at the beginning of track, the empty list is passed. That function should be fast because it is ran in the main thread.
  4577. + default
  4578. None
  4579. + type
  4580. ([(string*string)])->unit
  4581. + (unlabeled)
  4582. (no doc)
  4583. + default
  4584. None
  4585. + type
  4586. source('a)
  4587. + once
  4588. Creates a source that plays only one track of the input source.
  4589. + _category
  4590. Source / Track Processing
  4591. + (unlabeled)
  4592. The input source.
  4593. + default
  4594. None
  4595. + type
  4596. source('a)
  4597. + _type
  4598. (source('a))->source('a)
  4599. + or
  4600. Return the disjunction of its arguments
  4601. + _category
  4602. Bool
  4603. + _type
  4604. (bool,bool)->bool
  4605. + (unlabeled)
  4606. (no doc)
  4607. + default
  4608. None
  4609. + type
  4610. bool
  4611. + (unlabeled)
  4612. (no doc)
  4613. + default
  4614. None
  4615. + type
  4616. bool
  4617. + os.type
  4618. Type of OS running liquidsoap.
  4619. + _category
  4620. System
  4621. + _type
  4622. string
  4623. + osd_metadata
  4624. Use X On Screen Display to display metadata info.
  4625. + _category
  4626. Source / Track Processing
  4627. + color
  4628. Color of the text.
  4629. + default
  4630. "green"
  4631. + type
  4632. string
  4633. + position
  4634. Position of the text (top|middle|bottom).
  4635. + default
  4636. "top"
  4637. + type
  4638. string
  4639. + font
  4640. Font used (xfontsel is your friend...)
  4641. + default
  4642. "-*-courier-*-r-*-*-*-240-*-*-*-*-*-*"
  4643. + type
  4644. string
  4645. + display
  4646. Function used to display a metadata packet.
  4647. + default
  4648. <fun>
  4649. + type
  4650. ([(string*string)])->string
  4651. + (unlabeled)
  4652. (no doc)
  4653. + default
  4654. None
  4655. + type
  4656. source('a)
  4657. + _type
  4658. (?color:string,?position:string,?font:string,
  4659. ?display:(([(string*string)])->string),source('a))->
  4660. source('a)
  4661. + out
  4662. Output a stream using the 'output.prefered' operator. The input source does not need to be infallible, blank will just be played during failures.
  4663. + _category
  4664. Source / Output
  4665. + (unlabeled)
  4666. the source to output
  4667. + default
  4668. None
  4669. + type
  4670. source(audio='#a+1,video='#b,midi='#c)
  4671. + _type
  4672. (source(audio='#a+1,video='#b,midi='#c))->
  4673. active_source(audio='#a+1,video='#b,midi='#c)
  4674. + output.ao
  4675. Output stream to local sound card using libao.
  4676. + _category
  4677. Source / Output
  4678. + _type
  4679. (?id:string,?buffer_size:int,?channels_matrix:string,
  4680. ?clock_safe:bool,?driver:string,?fallible:bool,
  4681. ?on_start:(()->unit),?on_stop:(()->unit),
  4682. ?options:[(string*string)],?start:bool,
  4683. source(audio='#a+1,video='#b,midi='#c))->
  4684. active_source(audio='#a+1,video='#b,midi='#c)
  4685. + id
  4686. Force the value of the source ID.
  4687. + default
  4688. ""
  4689. + type
  4690. string
  4691. + buffer_size
  4692. Set buffer size, in frames.
  4693. + default
  4694. 2
  4695. + type
  4696. int
  4697. + channels_matrix
  4698. Output channels matrix, "" for AO's default.
  4699. + default
  4700. ""
  4701. + type
  4702. string
  4703. + clock_safe
  4704. Use the dedicated AO clock.
  4705. + default
  4706. true
  4707. + type
  4708. bool
  4709. + driver
  4710. Driver to be used, "" for AO's default.
  4711. + default
  4712. ""
  4713. + type
  4714. string
  4715. + fallible
  4716. Allow the child source to fail, in which case the output will be (temporarily) stopped.
  4717. + default
  4718. false
  4719. + type
  4720. bool
  4721. + on_start
  4722. Callback executed when outputting starts.
  4723. + default
  4724. {()}
  4725. + type
  4726. ()->unit
  4727. + on_stop
  4728. Callback executed when outputting stops.
  4729. + default
  4730. {()}
  4731. + type
  4732. ()->unit
  4733. + options
  4734. List of parameters, depends on the driver.
  4735. + default
  4736. []
  4737. + type
  4738. [(string*string)]
  4739. + start
  4740. Automatically start outputting whenever possible. If true, an infallible (normal) output will start outputting as soon as it is created, and a fallible output will (re)start as soon as its source becomes available for streaming.
  4741. + default
  4742. true
  4743. + type
  4744. bool
  4745. + (unlabeled)
  4746. (no doc)
  4747. + default
  4748. None
  4749. + type
  4750. source(audio='#a+1,video='#b,midi='#c)
  4751. + output.dummy
  4752. Dummy output for debugging purposes.
  4753. + _category
  4754. Source / Output
  4755. + _type
  4756. (?id:string,?fallible:bool,?on_start:(()->unit),
  4757. ?on_stop:(()->unit),?start:bool,source('a))->
  4758. active_source('a)
  4759. + id
  4760. Force the value of the source ID.
  4761. + default
  4762. ""
  4763. + type
  4764. string
  4765. + fallible
  4766. Allow the child source to fail, in which case the output will be (temporarily) stopped.
  4767. + default
  4768. false
  4769. + type
  4770. bool
  4771. + on_start
  4772. Callback executed when outputting starts.
  4773. + default
  4774. {()}
  4775. + type
  4776. ()->unit
  4777. + on_stop
  4778. Callback executed when outputting stops.
  4779. + default
  4780. {()}
  4781. + type
  4782. ()->unit
  4783. + start
  4784. Automatically start outputting whenever possible. If true, an infallible (normal) output will start outputting as soon as it is created, and a fallible output will (re)start as soon as its source becomes available for streaming.
  4785. + default
  4786. true
  4787. + type
  4788. bool
  4789. + (unlabeled)
  4790. (no doc)
  4791. + default
  4792. None
  4793. + type
  4794. source('a)
  4795. + output.external
  4796. Send the stream to a process' standard input.
  4797. + _category
  4798. Source / Output
  4799. + _type
  4800. (?id:string,?fallible:bool,?flush:bool,
  4801. ?on_start:(()->unit),?on_stop:(()->unit),
  4802. ?reopen_delay:float,?reopen_on_metadata:bool,
  4803. ?reopen_when:(()->bool),?start:bool,format('a),string,
  4804. source('a))->active_source('a)
  4805. + id
  4806. Force the value of the source ID.
  4807. + default
  4808. ""
  4809. + type
  4810. string
  4811. + fallible
  4812. Allow the child source to fail, in which case the output will be (temporarily) stopped.
  4813. + default
  4814. false
  4815. + type
  4816. bool
  4817. + flush
  4818. Perform a flush after each write.
  4819. + default
  4820. false
  4821. + type
  4822. bool
  4823. + on_start
  4824. Callback executed when outputting starts.
  4825. + default
  4826. {()}
  4827. + type
  4828. ()->unit
  4829. + on_stop
  4830. Callback executed when outputting stops.
  4831. + default
  4832. {()}
  4833. + type
  4834. ()->unit
  4835. + reopen_delay
  4836. Prevent re-opening within that delay, in seconds.
  4837. + default
  4838. 120.
  4839. + type
  4840. float
  4841. + reopen_on_metadata
  4842. Re-open on every new metadata information.
  4843. + default
  4844. false
  4845. + type
  4846. bool
  4847. + reopen_when
  4848. When should the output be re-opened.
  4849. + default
  4850. {false}
  4851. + type
  4852. ()->bool
  4853. + start
  4854. Automatically start outputting whenever possible. If true, an infallible (normal) output will start outputting as soon as it is created, and a fallible output will (re)start as soon as its source becomes available for streaming.
  4855. + default
  4856. true
  4857. + type
  4858. bool
  4859. + (unlabeled)
  4860. Encoding format.
  4861. + default
  4862. None
  4863. + type
  4864. format('a)
  4865. + (unlabeled)
  4866. Process to pipe data to. Some strftime conversion specifiers are available: <code>%SMHdmY</code>. You can also use <code>$(..)</code> interpolation notation for metadata.
  4867. + default
  4868. None
  4869. + type
  4870. string
  4871. + (unlabeled)
  4872. (no doc)
  4873. + default
  4874. None
  4875. + type
  4876. source('a)
  4877. + output.file
  4878. Output the source stream to a file.
  4879. + _category
  4880. Source / Output
  4881. + _type
  4882. (?id:string,?append:bool,?dir_perm:int,?fallible:bool,
  4883. ?flush:bool,?on_close:((string)->unit),
  4884. ?on_start:(()->unit),?on_stop:(()->unit),?perm:int,
  4885. ?reopen_delay:float,?reopen_on_metadata:bool,
  4886. ?reopen_when:(()->bool),?start:bool,format('a),string,
  4887. source('a))->active_source('a)
  4888. + id
  4889. Force the value of the source ID.
  4890. + default
  4891. ""
  4892. + type
  4893. string
  4894. + append
  4895. Do not truncate but append in the file if it exists.
  4896. + default
  4897. false
  4898. + type
  4899. bool
  4900. + dir_perm
  4901. Permission of the directories if some have to be created, up to umask. Although you can enter values in octal notation (0oXXX) they will be displayed in decimal (for instance, 0o777 = 7*8^2 + 7*8 + 7 = 511).
  4902. + default
  4903. 511
  4904. + type
  4905. int
  4906. + fallible
  4907. Allow the child source to fail, in which case the output will be (temporarily) stopped.
  4908. + default
  4909. false
  4910. + type
  4911. bool
  4912. + flush
  4913. Perform a flush after each write.
  4914. + default
  4915. false
  4916. + type
  4917. bool
  4918. + on_close
  4919. This function will be called for each file, after that it is finished and closed. The filename will be passed as argument.
  4920. + default
  4921. fun (_) -> ()
  4922. + type
  4923. (string)->unit
  4924. + on_start
  4925. Callback executed when outputting starts.
  4926. + default
  4927. {()}
  4928. + type
  4929. ()->unit
  4930. + on_stop
  4931. Callback executed when outputting stops.
  4932. + default
  4933. {()}
  4934. + type
  4935. ()->unit
  4936. + perm
  4937. Permission of the file if it has to be created, up to umask. You can and should write this number in octal notation: 0oXXX. The default value is however displayed in decimal (0o666 = 6*8^2 + 6*8 + 6 = 438).
  4938. + default
  4939. 438
  4940. + type
  4941. int
  4942. + reopen_delay
  4943. Prevent re-opening within that delay, in seconds.
  4944. + default
  4945. 120.
  4946. + type
  4947. float
  4948. + reopen_on_metadata
  4949. Re-open on every new metadata information.
  4950. + default
  4951. false
  4952. + type
  4953. bool
  4954. + reopen_when
  4955. When should the output be re-opened.
  4956. + default
  4957. {false}
  4958. + type
  4959. ()->bool
  4960. + start
  4961. Automatically start outputting whenever possible. If true, an infallible (normal) output will start outputting as soon as it is created, and a fallible output will (re)start as soon as its source becomes available for streaming.
  4962. + default
  4963. true
  4964. + type
  4965. bool
  4966. + (unlabeled)
  4967. Encoding format.
  4968. + default
  4969. None
  4970. + type
  4971. format('a)
  4972. + (unlabeled)
  4973. Filename where to output the stream. Some strftime conversion specifiers are available: <code>%SMHdmY</code>. You can also use <code>$(..)</code> interpolation notation for metadata.
  4974. + default
  4975. None
  4976. + type
  4977. string
  4978. + (unlabeled)
  4979. (no doc)
  4980. + default
  4981. None
  4982. + type
  4983. source('a)
  4984. + output.harbor
  4985. Encode and output the stream using the harbor server.
  4986. + _category
  4987. Source / Output
  4988. + _type
  4989. (?id:string,?auth:((string,string)->bool),?buffer:int,
  4990. ?burst:int,?chunk:int,?dumpfile:string,?encoding:string,
  4991. ?fallible:bool,?format:string,
  4992. ?headers:[(string*string)],?icy_metadata:string,
  4993. ?metaint:int,mount:string,
  4994. ?on_connect:((headers:[(string*string)],uri:string,
  4995. protocol:string,string)->unit),
  4996. ?on_disconnect:((string)->unit),?on_start:(()->unit),
  4997. ?on_stop:(()->unit),?password:string,?port:int,
  4998. ?protocol:string,?start:bool,?timeout:float,?url:string,
  4999. ?user:string,format('a),source('a))->active_source('a)
  5000. + id
  5001. Force the value of the source ID.
  5002. + default
  5003. ""
  5004. + type
  5005. string
  5006. + auth
  5007. Authentication function. <code>f(login,password)</code> returns <code>true</code> if the user should be granted access for this login. Override any other method if used.
  5008. + default
  5009. fun (_,_) -> false
  5010. + type
  5011. (string,string)->bool
  5012. + buffer
  5013. Maximun buffer per-client.
  5014. + default
  5015. 327675
  5016. + type
  5017. int
  5018. + burst
  5019. Initial burst of data sent to the client.
  5020. + default
  5021. 65534
  5022. + type
  5023. int
  5024. + chunk
  5025. Send data to clients using chunks of at least this length.
  5026. + default
  5027. 1024
  5028. + type
  5029. int
  5030. + dumpfile
  5031. Dump stream to file, for debugging purpose. Disabled if empty.
  5032. + default
  5033. ""
  5034. + type
  5035. string
  5036. + encoding
  5037. Encoding used to send metadata. If empty, defaults to "ISO-8859-1" for non-ogg formats and "UTF-8" otherwise.
  5038. + default
  5039. ""
  5040. + type
  5041. string
  5042. + fallible
  5043. Allow the child source to fail, in which case the output will be (temporarily) stopped.
  5044. + default
  5045. false
  5046. + type
  5047. bool
  5048. + format
  5049. Format, e.g. "audio/ogg". When empty, the encoder is used to guess.
  5050. + default
  5051. ""
  5052. + type
  5053. string
  5054. + headers
  5055. Additional headers.
  5056. + default
  5057. []
  5058. + type
  5059. [(string*string)]
  5060. + icy_metadata
  5061. Send new metadata using the ICY protocol. One of: "guess", "true", "false"
  5062. + default
  5063. "guess"
  5064. + type
  5065. string
  5066. + metaint
  5067. Interval used to send ICY metadata
  5068. + default
  5069. 16000
  5070. + type
  5071. int
  5072. + mount
  5073. (no doc)
  5074. + default
  5075. None
  5076. + type
  5077. string
  5078. + on_connect
  5079. Callback executed when connection is established.
  5080. + default
  5081. fun (~headers,~uri,~protocol,_) -> ()
  5082. + type
  5083. (headers:[(string*string)],uri:string,protocol:string,
  5084. string)->unit
  5085. + on_disconnect
  5086. Callback executed when connection stops.
  5087. + default
  5088. fun (_) -> ()
  5089. + type
  5090. (string)->unit
  5091. + on_start
  5092. Callback executed when outputting starts.
  5093. + default
  5094. {()}
  5095. + type
  5096. ()->unit
  5097. + on_stop
  5098. Callback executed when outputting stops.
  5099. + default
  5100. {()}
  5101. + type
  5102. ()->unit
  5103. + password
  5104. (no doc)
  5105. + default
  5106. "hackme"
  5107. + type
  5108. string
  5109. + port
  5110. (no doc)
  5111. + default
  5112. 8000
  5113. + type
  5114. int
  5115. + protocol
  5116. Protocol of the streaming server: 'http' for Icecast, 'icy' for shoutcast.
  5117. + default
  5118. "http"
  5119. + type
  5120. string
  5121. + start
  5122. Automatically start outputting whenever possible. If true, an infallible (normal) output will start outputting as soon as it is created, and a fallible output will (re)start as soon as its source becomes available for streaming.
  5123. + default
  5124. true
  5125. + type
  5126. bool
  5127. + timeout
  5128. Timeout for network operations.
  5129. + default
  5130. 30.
  5131. + type
  5132. float
  5133. + url
  5134. (no doc)
  5135. + default
  5136. ""
  5137. + type
  5138. string
  5139. + user
  5140. User for client connection, disabled if empty.
  5141. + default
  5142. ""
  5143. + type
  5144. string
  5145. + (unlabeled)
  5146. Encoding format.
  5147. + default
  5148. None
  5149. + type
  5150. format('a)
  5151. + (unlabeled)
  5152. (no doc)
  5153. + default
  5154. None
  5155. + type
  5156. source('a)
  5157. + output.icecast
  5158. Encode and output the stream to an icecast2 or shoutcast server.
  5159. + _category
  5160. Source / Output
  5161. + _type
  5162. (?id:string,?connection_timeout:float,
  5163. ?description:string,?dumpfile:string,?encoding:string,
  5164. ?fallible:bool,?format:string,?genre:string,
  5165. ?headers:[(string*string)],?host:string,
  5166. ?icy_metadata:string,?mount:string,?name:string,
  5167. ?on_connect:(()->unit),?on_disconnect:(()->unit),
  5168. ?on_error:((string)->float),?on_start:(()->unit),
  5169. ?on_stop:(()->unit),?password:string,?port:int,
  5170. ?protocol:string,?public:bool,?start:bool,
  5171. ?timeout:float,?url:string,?user:string,format('a),
  5172. source('a))->active_source('a)
  5173. + id
  5174. Force the value of the source ID.
  5175. + default
  5176. ""
  5177. + type
  5178. string
  5179. + connection_timeout
  5180. Timeout for establishing network connections (disabled is negative).
  5181. + default
  5182. 5.
  5183. + type
  5184. float
  5185. + description
  5186. (no doc)
  5187. + default
  5188. "Liquidsoap Radio!"
  5189. + type
  5190. string
  5191. + dumpfile
  5192. Dump stream to file, for debugging purpose. Disabled if empty.
  5193. + default
  5194. ""
  5195. + type
  5196. string
  5197. + encoding
  5198. Encoding used to send metadata. If empty, defaults to "UTF-8" for "http" protocol and "ISO-8859-1" for "icy" protocol.
  5199. + default
  5200. ""
  5201. + type
  5202. string
  5203. + fallible
  5204. Allow the child source to fail, in which case the output will be (temporarily) stopped.
  5205. + default
  5206. false
  5207. + type
  5208. bool
  5209. + format
  5210. Format, e.g. "audio/ogg". When empty, the encoder is used to guess.
  5211. + default
  5212. ""
  5213. + type
  5214. string
  5215. + genre
  5216. (no doc)
  5217. + default
  5218. "Misc"
  5219. + type
  5220. string
  5221. + headers
  5222. Additional headers.
  5223. + default
  5224. [("User-Agent","Liquidsoap/1.1.1 (Unix; OCaml 3.12.1)")]
  5225. + type
  5226. [(string*string)]
  5227. + host
  5228. (no doc)
  5229. + default
  5230. "localhost"
  5231. + type
  5232. string
  5233. + icy_metadata
  5234. Send new metadata using the ICY protocol. One of: "guess", "true", "false"
  5235. + default
  5236. "guess"
  5237. + type
  5238. string
  5239. + mount
  5240. (no doc)
  5241. + default
  5242. "Use [name] with .ogg extension if relevant"
  5243. + type
  5244. string
  5245. + name
  5246. (no doc)
  5247. + default
  5248. "Use [mount]"
  5249. + type
  5250. string
  5251. + on_connect
  5252. Callback executed when connection is established.
  5253. + default
  5254. {()}
  5255. + type
  5256. ()->unit
  5257. + on_disconnect
  5258. Callback executed when connection stops.
  5259. + default
  5260. {()}
  5261. + type
  5262. ()->unit
  5263. + on_error
  5264. Callback executed when an error happens. The callback receives a string representation of the error that occured and returns a float. If returned value is positive, connection will be tried again after this amount of time (in seconds).
  5265. + default
  5266. fun (_) -> 3.
  5267. + type
  5268. (string)->float
  5269. + on_start
  5270. Callback executed when outputting starts.
  5271. + default
  5272. {()}
  5273. + type
  5274. ()->unit
  5275. + on_stop
  5276. Callback executed when outputting stops.
  5277. + default
  5278. {()}
  5279. + type
  5280. ()->unit
  5281. + password
  5282. (no doc)
  5283. + default
  5284. "hackme"
  5285. + type
  5286. string
  5287. + port
  5288. (no doc)
  5289. + default
  5290. 8000
  5291. + type
  5292. int
  5293. + protocol
  5294. Protocol of the streaming server: 'http' for Icecast, 'icy' for shoutcast.
  5295. + default
  5296. "http"
  5297. + type
  5298. string
  5299. + public
  5300. (no doc)
  5301. + default
  5302. true
  5303. + type
  5304. bool
  5305. + start
  5306. Automatically start outputting whenever possible. If true, an infallible (normal) output will start outputting as soon as it is created, and a fallible output will (re)start as soon as its source becomes available for streaming.
  5307. + default
  5308. true
  5309. + type
  5310. bool
  5311. + timeout
  5312. Timeout for network read and write.
  5313. + default
  5314. 30.
  5315. + type
  5316. float
  5317. + url
  5318. (no doc)
  5319. + default
  5320. "http://savonet.sf.net"
  5321. + type
  5322. string
  5323. + user
  5324. User for shout source connection. Useful only in special cases, like with per-mountpoint users.
  5325. + default
  5326. "source"
  5327. + type
  5328. string
  5329. + (unlabeled)
  5330. Encoding format.
  5331. + default
  5332. None
  5333. + type
  5334. format('a)
  5335. + (unlabeled)
  5336. (no doc)
  5337. + default
  5338. None
  5339. + type
  5340. source('a)
  5341. + output.oss
  5342. Output the source's stream to an OSS output device.
  5343. + _category
  5344. Source / Output
  5345. + _type
  5346. (?id:string,?clock_safe:bool,?device:string,
  5347. ?fallible:bool,?on_start:(()->unit),?on_stop:(()->unit),
  5348. ?start:bool,source(audio='#a+1,video='#b,midi='#c))->
  5349. active_source(audio='#a+1,video='#b,midi='#c)
  5350. + id
  5351. Force the value of the source ID.
  5352. + default
  5353. ""
  5354. + type
  5355. string
  5356. + clock_safe
  5357. Force the use of the dedicated OSS clock.
  5358. + default
  5359. true
  5360. + type
  5361. bool
  5362. + device
  5363. OSS device to use.
  5364. + default
  5365. "/dev/dsp"
  5366. + type
  5367. string
  5368. + fallible
  5369. Allow the child source to fail, in which case the output will be (temporarily) stopped.
  5370. + default
  5371. false
  5372. + type
  5373. bool
  5374. + on_start
  5375. Callback executed when outputting starts.
  5376. + default
  5377. {()}
  5378. + type
  5379. ()->unit
  5380. + on_stop
  5381. Callback executed when outputting stops.
  5382. + default
  5383. {()}
  5384. + type
  5385. ()->unit
  5386. + start
  5387. Automatically start outputting whenever possible. If true, an infallible (normal) output will start outputting as soon as it is created, and a fallible output will (re)start as soon as its source becomes available for streaming.
  5388. + default
  5389. true
  5390. + type
  5391. bool
  5392. + (unlabeled)
  5393. (no doc)
  5394. + default
  5395. None
  5396. + type
  5397. source(audio='#a+1,video='#b,midi='#c)
  5398. + output.prefered
  5399. Output to local audio card using the first available driver in pulseaudio, portaudio, oss, alsa, ao, dummy.
  5400. + _category
  5401. Source / Output
  5402. + id
  5403. (no doc)
  5404. + default
  5405. ""
  5406. + type
  5407. string
  5408. + fallible
  5409. (no doc)
  5410. + default
  5411. false
  5412. + type
  5413. bool
  5414. + on_start
  5415. (no doc)
  5416. + default
  5417. {()}
  5418. + type
  5419. ()->unit
  5420. + on_stop
  5421. (no doc)
  5422. + default
  5423. {()}
  5424. + type
  5425. ()->unit
  5426. + start
  5427. (no doc)
  5428. + default
  5429. true
  5430. + type
  5431. bool
  5432. + (unlabeled)
  5433. (no doc)
  5434. + default
  5435. None
  5436. + type
  5437. source(audio='#a+1,video='#b,midi='#c)
  5438. + _type
  5439. (?id:string,?fallible:bool,?on_start:(()->unit),
  5440. ?on_stop:(()->unit),?start:bool,
  5441. source(audio='#a+1,video='#b,midi='#c))->
  5442. active_source(audio='#a+1,video='#b,midi='#c)
  5443. + output.shoutcast
  5444. Output to shoutcast.
  5445. + _category
  5446. Source / Output
  5447. + id
  5448. Output's ID
  5449. + default
  5450. "output.shoutcast"
  5451. + type
  5452. string
  5453. + start
  5454. Start output threads on operator initialization.
  5455. + default
  5456. true
  5457. + type
  5458. bool
  5459. + host
  5460. (no doc)
  5461. + default
  5462. "localhost"
  5463. + type
  5464. string
  5465. + port
  5466. (no doc)
  5467. + default
  5468. 8000
  5469. + type
  5470. int
  5471. + user
  5472. User for shout source connection. Useful only in special cases, like with per-mountpoint users.
  5473. + default
  5474. "source"
  5475. + type
  5476. string
  5477. + password
  5478. (no doc)
  5479. + default
  5480. "hackme"
  5481. + type
  5482. string
  5483. + genre
  5484. (no doc)
  5485. + default
  5486. "Misc"
  5487. + type
  5488. string
  5489. + url
  5490. (no doc)
  5491. + default
  5492. "http://liquidsoap.fm"
  5493. + type
  5494. string
  5495. + name
  5496. (no doc)
  5497. + default
  5498. "Liquidsoap Radio!"
  5499. + type
  5500. string
  5501. + public
  5502. (no doc)
  5503. + default
  5504. true
  5505. + type
  5506. bool
  5507. + format
  5508. Format, e.g. "audio/ogg". When empty, the encoder is used to guess.
  5509. + default
  5510. ""
  5511. + type
  5512. string
  5513. + dumpfile
  5514. Dump stream to file, for debugging purpose. Disabled if empty.
  5515. + default
  5516. ""
  5517. + type
  5518. string
  5519. + icy_metadata
  5520. Send new metadata using the ICY protocol. One of: "guess", "true", "false"
  5521. + default
  5522. "guess"
  5523. + type
  5524. string
  5525. + on_connect
  5526. Callback executed when connection starts.
  5527. + default
  5528. {()}
  5529. + type
  5530. ()->unit
  5531. + on_disconnect
  5532. Callback executed when connection stops.
  5533. + default
  5534. {()}
  5535. + type
  5536. ()->unit
  5537. + aim
  5538. (no doc)
  5539. + default
  5540. ""
  5541. + type
  5542. string
  5543. + icq
  5544. (no doc)
  5545. + default
  5546. ""
  5547. + type
  5548. string
  5549. + irc
  5550. (no doc)
  5551. + default
  5552. ""
  5553. + type
  5554. string
  5555. + icy_reset
  5556. Reset shoutcast source buffer upon connecting (necessary for NSV).
  5557. + default
  5558. true
  5559. + type
  5560. bool
  5561. + fallible
  5562. Allow the child source to fail, in which case the output will be (temporarily) stopped.
  5563. + default
  5564. false
  5565. + type
  5566. bool
  5567. + on_start
  5568. Callback executed when outputting starts.
  5569. + default
  5570. {()}
  5571. + type
  5572. ()->unit
  5573. + on_stop
  5574. Callback executed when outputting stops.
  5575. + default
  5576. {()}
  5577. + type
  5578. ()->unit
  5579. + on_error
  5580. Callback executed when an error happens. If returned value is positive, connection wll be tried again after this amount of time (in seconds).
  5581. + default
  5582. fun (_) -> 3.
  5583. + type
  5584. (string)->float
  5585. + (unlabeled)
  5586. Endoding format. For shoutcast, should be mp3 or AAC(+).
  5587. + default
  5588. None
  5589. + type
  5590. format('a)
  5591. + (unlabeled)
  5592. The source to output
  5593. + default
  5594. None
  5595. + type
  5596. source('a)
  5597. + _type
  5598. (?id:string,?start:bool,?host:string,?port:int,
  5599. ?user:string,?password:string,?genre:string,?url:string,
  5600. ?name:string,?public:bool,?format:string,
  5601. ?dumpfile:string,?icy_metadata:string,
  5602. ?on_connect:(()->unit),?on_disconnect:(()->unit),
  5603. ?aim:string,?icq:string,?irc:string,?icy_reset:bool,
  5604. ?fallible:bool,?on_start:(()->unit),?on_stop:(()->unit),
  5605. ?on_error:((string)->float),format('a),source('a))->
  5606. active_source('a)
  5607. + output.udp
  5608. Output encoded data to UDP, without any control whatsoever.
  5609. + _category
  5610. Source / Output
  5611. + _type
  5612. (?id:string,?fallible:bool,host:string,
  5613. ?on_start:(()->unit),?on_stop:(()->unit),port:int,
  5614. ?start:bool,format('a),source('a))->active_source('a)
  5615. + _flag
  5616. experimental
  5617. + id
  5618. Force the value of the source ID.
  5619. + default
  5620. ""
  5621. + type
  5622. string
  5623. + fallible
  5624. Allow the child source to fail, in which case the output will be (temporarily) stopped.
  5625. + default
  5626. false
  5627. + type
  5628. bool
  5629. + host
  5630. (no doc)
  5631. + default
  5632. None
  5633. + type
  5634. string
  5635. + on_start
  5636. Callback executed when outputting starts.
  5637. + default
  5638. {()}
  5639. + type
  5640. ()->unit
  5641. + on_stop
  5642. Callback executed when outputting stops.
  5643. + default
  5644. {()}
  5645. + type
  5646. ()->unit
  5647. + port
  5648. (no doc)
  5649. + default
  5650. None
  5651. + type
  5652. int
  5653. + start
  5654. Automatically start outputting whenever possible. If true, an infallible (normal) output will start outputting as soon as it is created, and a fallible output will (re)start as soon as its source becomes available for streaming.
  5655. + default
  5656. true
  5657. + type
  5658. bool
  5659. + (unlabeled)
  5660. Encoding format.
  5661. + default
  5662. None
  5663. + type
  5664. format('a)
  5665. + (unlabeled)
  5666. (no doc)
  5667. + default
  5668. None
  5669. + type
  5670. source('a)
  5671. + path.concat
  5672. Concatenate two paths, using the appropriate directory separator.
  5673. + _category
  5674. System
  5675. + _type
  5676. (string,string)->string
  5677. + (unlabeled)
  5678. (no doc)
  5679. + default
  5680. None
  5681. + type
  5682. string
  5683. + (unlabeled)
  5684. (no doc)
  5685. + default
  5686. None
  5687. + type
  5688. string
  5689. + pitch
  5690. Compute the pitch of a sound.
  5691. + _category
  5692. Source / Sound Processing
  5693. + _type
  5694. (?id:string,?freq_max:float,?freq_min:float,
  5695. ?length:float,source(audio='#a,video='#b,midi='#c))->
  5696. source(audio='#a,video='#b,midi='#c)
  5697. + _flag
  5698. hidden
  5699. + _flag
  5700. experimental
  5701. + id
  5702. Force the value of the source ID.
  5703. + default
  5704. ""
  5705. + type
  5706. string
  5707. + freq_max
  5708. Maximal frequency
  5709. + default
  5710. 10000.
  5711. + type
  5712. float
  5713. + freq_min
  5714. Minimal frequency
  5715. + default
  5716. 40.
  5717. + type
  5718. float
  5719. + length
  5720. Length in seconds of the analysis window
  5721. + default
  5722. 0.1
  5723. + type
  5724. float
  5725. + (unlabeled)
  5726. (no doc)
  5727. + default
  5728. None
  5729. + type
  5730. source(audio='#a,video='#b,midi='#c)
  5731. + playlist
  5732. Loop on a playlist of URIs.
  5733. + _category
  5734. Source / Input
  5735. + _type
  5736. (?id:string,?conservative:bool,?default_duration:float,
  5737. ?length:float,?mime_type:string,?mode:string,
  5738. ?prefix:string,?reload:int,?reload_mode:string,
  5739. ?timeout:float,string)->source('a)
  5740. + id
  5741. Force the value of the source ID.
  5742. + default
  5743. ""
  5744. + type
  5745. string
  5746. + conservative
  5747. If true, estimated remaining time on the current track is not considered when computing queue length.
  5748. + default
  5749. false
  5750. + type
  5751. bool
  5752. + default_duration
  5753. When unknown, assume this duration (in sec.) for files.
  5754. + default
  5755. 30.
  5756. + type
  5757. float
  5758. + length
  5759. How much audio (in sec.) should be queued in advance.
  5760. + default
  5761. 10.
  5762. + type
  5763. float
  5764. + mime_type
  5765. Default MIME type for the playlist. Empty string means automatic detection.
  5766. + default
  5767. ""
  5768. + type
  5769. string
  5770. + mode
  5771. Play the files in the playlist either in the order ("normal" mode), or shuffle the playlist each time it is loaded, and play it in this order for a whole round ("randomize" mode), or pick a random file in the playlist each time ("random" mode).
  5772. + default
  5773. "randomize"
  5774. + type
  5775. string
  5776. + prefix
  5777. Add a constant prefix to all requests. Useful for passing extra information using annotate, or for resolution through a particular protocol, such as replaygain.
  5778. + default
  5779. ""
  5780. + type
  5781. string
  5782. + reload
  5783. Amount of time (in seconds or rounds), when applicable, before which the playlist is reloaded; 0 means never.
  5784. + default
  5785. 0
  5786. + type
  5787. int
  5788. + reload_mode
  5789. Unit of the reload parameter, either 'rounds', 'seconds' or 'watch' (reload the file whenever it is changed).
  5790. + default
  5791. "seconds"
  5792. + type
  5793. string
  5794. + timeout
  5795. Timeout (in sec.) for a single download.
  5796. + default
  5797. 20.
  5798. + type
  5799. float
  5800. + (unlabeled)
  5801. URI where to find the playlist.
  5802. + default
  5803. None
  5804. + type
  5805. string
  5806. + playlist.merge
  5807. Play the whole playlist as one track.
  5808. + id
  5809. Force the value of the source ID.
  5810. + default
  5811. ""
  5812. + type
  5813. string
  5814. + random
  5815. Randomize playlist content
  5816. + default
  5817. false
  5818. + type
  5819. bool
  5820. + (unlabeled)
  5821. Playlist URI.
  5822. + default
  5823. None
  5824. + type
  5825. string
  5826. + _type
  5827. (?id:string,?random:bool,string)->source('a)
  5828. + playlist.once
  5829. Custom playlist source written using the script language.
  5830. Will read directory or playlist, play all files and stop
  5831. + _category
  5832. Source / Input
  5833. + id
  5834. Force the value of the source ID.
  5835. + default
  5836. ""
  5837. + type
  5838. string
  5839. + random
  5840. Randomize playlist content
  5841. + default
  5842. false
  5843. + type
  5844. bool
  5845. + on_done
  5846. Function to execute when the playlist is finished
  5847. + default
  5848. {()}
  5849. + type
  5850. ()->unit
  5851. + reload_mode
  5852. If set to "watch", will be reloaded when the playlist is changed
  5853. + default
  5854. ""
  5855. + type
  5856. string
  5857. + (unlabeled)
  5858. Playlist URI
  5859. + default
  5860. None
  5861. + type
  5862. string
  5863. + _type
  5864. (?id:string,?random:bool,?on_done:(()->unit),
  5865. ?reload_mode:string,string)->source('a)
  5866. + playlist.parse
  5867. Try to parse a local playlist. Return a list of (metadata,URI) items, where metadata is a list of (key,value) bindings.
  5868. + _category
  5869. Liquidsoap
  5870. + _type
  5871. (string)->[([(string*string)]*string)]
  5872. + (unlabeled)
  5873. (no doc)
  5874. + default
  5875. None
  5876. + type
  5877. string
  5878. + playlist.reloadable
  5879. Custom playlist source written using the script language.
  5880. Will read directory or playlist, play all files and stop.
  5881. Returns a pair @(reload,source)@ where @reload@ is a function of type @(?uri:string)->unit@ used to reload the source and @source@ is the actual source. The reload function can optionally be called with a new playlist URI. Otherwise, it reloads the previous URI.
  5882. + _category
  5883. Source / Input
  5884. + id
  5885. Force the value of the source ID.
  5886. + default
  5887. ""
  5888. + type
  5889. string
  5890. + random
  5891. Randomize playlist content
  5892. + default
  5893. false
  5894. + type
  5895. bool
  5896. + on_done
  5897. Function to execute when the playlist is finished
  5898. + default
  5899. {()}
  5900. + type
  5901. ()->unit
  5902. + (unlabeled)
  5903. Playlist URI
  5904. + default
  5905. None
  5906. + type
  5907. string
  5908. + _type
  5909. (?id:string,?random:bool,?on_done:(()->unit),string)->
  5910. (((?uri:string)->unit)*source('a))
  5911. + playlist.safe
  5912. Loop on a playlist of local files, and never fail. In order to do so, it has to check every file at the loading, so the streamer startup may take a few seconds. To avoid this, use a standard playlist, and put only a few local files in a default safe_playlist in order to ensure the liveness of the streamer.
  5913. + _category
  5914. Source / Input
  5915. + _type
  5916. (?id:string,?mime_type:string,?mode:string,
  5917. ?prefix:string,?reload:int,?reload_mode:string,string)->
  5918. source('a)
  5919. + id
  5920. Force the value of the source ID.
  5921. + default
  5922. ""
  5923. + type
  5924. string
  5925. + mime_type
  5926. Default MIME type for the playlist. Empty string means automatic detection.
  5927. + default
  5928. ""
  5929. + type
  5930. string
  5931. + mode
  5932. Play the files in the playlist either in the order ("normal" mode), or shuffle the playlist each time it is loaded, and play it in this order for a whole round ("randomize" mode), or pick a random file in the playlist each time ("random" mode).
  5933. + default
  5934. "randomize"
  5935. + type
  5936. string
  5937. + prefix
  5938. Add a constant prefix to all requests. Useful for passing extra information using annotate, or for resolution through a particular protocol, such as replaygain.
  5939. + default
  5940. ""
  5941. + type
  5942. string
  5943. + reload
  5944. Amount of time (in seconds or rounds), when applicable, before which the playlist is reloaded; 0 means never.
  5945. + default
  5946. 0
  5947. + type
  5948. int
  5949. + reload_mode
  5950. Unit of the reload parameter, either 'rounds', 'seconds' or 'watch' (reload the file whenever it is changed).
  5951. + default
  5952. "seconds"
  5953. + type
  5954. string
  5955. + (unlabeled)
  5956. URI where to find the playlist.
  5957. + default
  5958. None
  5959. + type
  5960. string
  5961. + pow
  5962. Exponentiation of numbers.
  5963. + _category
  5964. Math
  5965. + _type
  5966. ('a,'a)->'a where 'a is a number type
  5967. + (unlabeled)
  5968. (no doc)
  5969. + default
  5970. None
  5971. + type
  5972. anything that is a number type
  5973. + (unlabeled)
  5974. (no doc)
  5975. + default
  5976. None
  5977. + type
  5978. anything that is a number type
  5979. + prepend
  5980. Prepend an extra track before every track. Set the metadata 'liq_prepend' to 'false' to inhibit prepending on one track.
  5981. + _category
  5982. Source / Track Processing
  5983. + _type
  5984. (?id:string,?merge:bool,
  5985. source(audio='#a,video='#b,midi='#c),
  5986. (([(string*string)])->
  5987. source(audio='#a,video='#b,midi='#c)))->
  5988. source(audio='#a,video='#b,midi='#c)
  5989. + id
  5990. Force the value of the source ID.
  5991. + default
  5992. ""
  5993. + type
  5994. string
  5995. + merge
  5996. Merge the track with its appended track.
  5997. + default
  5998. false
  5999. + type
  6000. bool
  6001. + (unlabeled)
  6002. (no doc)
  6003. + default
  6004. None
  6005. + type
  6006. source(audio='#a,video='#b,midi='#c)
  6007. + (unlabeled)
  6008. Given the metadata, build the source producing the track to prepend. This source is allowed to fail (produce nothing) if no relevant track is to be appended. However, success must be immediate or it will not be taken into account.
  6009. + default
  6010. None
  6011. + type
  6012. ([(string*string)])->source(audio='#a,video='#b,midi='#c)
  6013. + print
  6014. Print on standard output.
  6015. + _category
  6016. Interaction
  6017. + _type
  6018. (?newline:bool,'a)->unit
  6019. + newline
  6020. If true, a newline is added after displaying the value.
  6021. + default
  6022. true
  6023. + type
  6024. bool
  6025. + (unlabeled)
  6026. (no doc)
  6027. + default
  6028. None
  6029. + type
  6030. 'a
  6031. + quote
  6032. Escape shell metacharacters.
  6033. + _category
  6034. String
  6035. + _type
  6036. (string)->string
  6037. + (unlabeled)
  6038. (no doc)
  6039. + default
  6040. None
  6041. + type
  6042. string
  6043. + random
  6044. At the beginning of every track, select a random ready child.
  6045. + _category
  6046. Source / Track Processing
  6047. + _type
  6048. (?id:string,?replay_metadata:bool,?track_sensitive:bool,
  6049. ?transitions:[(source('a),source('a))->source('a)],
  6050. ?weights:[int],[source('a)])->source('a)
  6051. + id
  6052. Force the value of the source ID.
  6053. + default
  6054. ""
  6055. + type
  6056. string
  6057. + replay_metadata
  6058. Replay the last metadata of a child when switching to it in the middle of a track.
  6059. + default
  6060. true
  6061. + type
  6062. bool
  6063. + track_sensitive
  6064. Re-select only on end of tracks.
  6065. + default
  6066. true
  6067. + type
  6068. bool
  6069. + transitions
  6070. Transition functions, padded with <code>fun (x,y) -> y</code> functions.
  6071. + default
  6072. []
  6073. + type
  6074. [(source('a),source('a))->source('a)]
  6075. + weights
  6076. Weights of the children (padded with 1), defining for each child the probability that it is selected.
  6077. + default
  6078. []
  6079. + type
  6080. [int]
  6081. + (unlabeled)
  6082. (no doc)
  6083. + default
  6084. None
  6085. + type
  6086. [source('a)]
  6087. + random.bool
  6088. Generate a random value.
  6089. + _category
  6090. Bool
  6091. + _type
  6092. ()->bool
  6093. + random.float
  6094. Generate a random value.
  6095. + _category
  6096. Math
  6097. + _type
  6098. (?min:float,?max:float)->float
  6099. + min
  6100. (no doc)
  6101. + default
  6102. -1000000.
  6103. + type
  6104. float
  6105. + max
  6106. (no doc)
  6107. + default
  6108. 1000000.
  6109. + type
  6110. float
  6111. + random.int
  6112. Generate a random value.
  6113. + _category
  6114. Math
  6115. + _type
  6116. (?min:float,?max:float)->int
  6117. + min
  6118. (no doc)
  6119. + default
  6120. -1073741824
  6121. + type
  6122. float
  6123. + max
  6124. (no doc)
  6125. + default
  6126. 1073741823
  6127. + type
  6128. float
  6129. + read
  6130. Read some value from standard input (console).
  6131. + _category
  6132. System
  6133. + hide
  6134. Hide typed characters (for passwords).
  6135. + default
  6136. false
  6137. + type
  6138. bool
  6139. + _type
  6140. (?hide:bool)->string
  6141. + register_flow
  6142. Register a radio on Liquidsoap Flows.
  6143. + _category
  6144. Liquidsoap
  6145. + server
  6146. (no doc)
  6147. + default
  6148. ""
  6149. + type
  6150. string
  6151. + user
  6152. (no doc)
  6153. + default
  6154. "default"
  6155. + type
  6156. string
  6157. + password
  6158. (no doc)
  6159. + default
  6160. "default"
  6161. + type
  6162. string
  6163. + email
  6164. (no doc)
  6165. + default
  6166. ""
  6167. + type
  6168. string
  6169. + radio
  6170. Name of the radio.
  6171. + default
  6172. None
  6173. + type
  6174. string
  6175. + website
  6176. URL of the website of the radio.
  6177. + default
  6178. None
  6179. + type
  6180. string
  6181. + description
  6182. Description of the radio.
  6183. + default
  6184. None
  6185. + type
  6186. string
  6187. + genre
  6188. Genre of the radio (rock or rap or etc.).
  6189. + default
  6190. None
  6191. + type
  6192. string
  6193. + streams
  6194. List of streams for the radio described by a pair of strings consisting of the format of the stream and the url of the stream. The format should be of the form "ogg/128k" consisting of the codec and the bitrate, separated by "/".
  6195. + default
  6196. None
  6197. + type
  6198. [(string*string)]
  6199. + (unlabeled)
  6200. (no doc)
  6201. + default
  6202. None
  6203. + type
  6204. source('a)
  6205. + _type
  6206. (?server:string,?user:string,?password:string,
  6207. ?email:string,radio:string,website:string,
  6208. description:string,genre:string,
  6209. streams:[(string*string)],source('a))->source('a)
  6210. + reopen.stderr
  6211. Reopen standard error on the given file
  6212. + _category
  6213. System
  6214. + _type
  6215. (string)->unit
  6216. + (unlabeled)
  6217. (no doc)
  6218. + default
  6219. None
  6220. + type
  6221. string
  6222. + reopen.stdin
  6223. Reopen standard input on the given file
  6224. + _category
  6225. System
  6226. + _type
  6227. (string)->unit
  6228. + (unlabeled)
  6229. (no doc)
  6230. + default
  6231. None
  6232. + type
  6233. string
  6234. + reopen.stdout
  6235. Reopen standard output on the given file
  6236. + _category
  6237. System
  6238. + _type
  6239. (string)->unit
  6240. + (unlabeled)
  6241. (no doc)
  6242. + default
  6243. None
  6244. + type
  6245. string
  6246. + replaygain_protocol
  6247. Register the replaygain protocol.
  6248. + _category
  6249. Liquidsoap
  6250. + (unlabeled)
  6251. (no doc)
  6252. + default
  6253. None
  6254. + type
  6255. string
  6256. + (unlabeled)
  6257. (no doc)
  6258. + default
  6259. None
  6260. + type
  6261. 'a
  6262. + _type
  6263. (string,'a)->[string]
  6264. + request.create
  6265. Create a request. Creation may fail if there is no available RID, which cannot be detected currently: in that case one will obtain a request that will fail to be resolved.
  6266. + _category
  6267. Liquidsoap
  6268. + _type
  6269. (?indicators:[string],?persistent:bool,string)->
  6270. request('a)
  6271. + indicators
  6272. (no doc)
  6273. + default
  6274. []
  6275. + type
  6276. [string]
  6277. + persistent
  6278. (no doc)
  6279. + default
  6280. false
  6281. + type
  6282. bool
  6283. + (unlabeled)
  6284. (no doc)
  6285. + default
  6286. None
  6287. + type
  6288. string
  6289. + request.create.raw
  6290. Create a raw request, i.e. for files that should not be decoded for streaming. Creation may fail if there is no available RID, which cannot be detected currently: in that case one will obtain a request that will fail to be resolved.
  6291. + _category
  6292. Liquidsoap
  6293. + _type
  6294. (?indicators:[string],?persistent:bool,string)->
  6295. request(audio=0,video=0,midi=0)
  6296. + indicators
  6297. (no doc)
  6298. + default
  6299. []
  6300. + type
  6301. [string]
  6302. + persistent
  6303. (no doc)
  6304. + default
  6305. false
  6306. + type
  6307. bool
  6308. + (unlabeled)
  6309. (no doc)
  6310. + default
  6311. None
  6312. + type
  6313. string
  6314. + request.destroy
  6315. Destroying a request causes any temporary associated file to be deleted, and releases its RID. Persistent requests resist to destroying, unless forced.
  6316. + _category
  6317. Liquidsoap
  6318. + _type
  6319. (?force:bool,request('a))->unit
  6320. + force
  6321. Destroy the request even if it is persistent.
  6322. + default
  6323. false
  6324. + type
  6325. bool
  6326. + (unlabeled)
  6327. (no doc)
  6328. + default
  6329. None
  6330. + type
  6331. request('a)
  6332. + request.dynamic
  6333. Play request dynamically created by a given function.
  6334. + _category
  6335. Source / Input
  6336. + _type
  6337. (?id:string,?conservative:bool,?default_duration:float,
  6338. ?length:float,?timeout:float,(()->request('a)))->
  6339. source('a)
  6340. + id
  6341. Force the value of the source ID.
  6342. + default
  6343. ""
  6344. + type
  6345. string
  6346. + conservative
  6347. If true, estimated remaining time on the current track is not considered when computing queue length.
  6348. + default
  6349. false
  6350. + type
  6351. bool
  6352. + default_duration
  6353. When unknown, assume this duration (in sec.) for files.
  6354. + default
  6355. 30.
  6356. + type
  6357. float
  6358. + length
  6359. How much audio (in sec.) should be queued in advance.
  6360. + default
  6361. 10.
  6362. + type
  6363. float
  6364. + timeout
  6365. Timeout (in sec.) for a single download.
  6366. + default
  6367. 20.
  6368. + type
  6369. float
  6370. + (unlabeled)
  6371. (no doc)
  6372. + default
  6373. None
  6374. + type
  6375. ()->request('a)
  6376. + request.equeue
  6377. Receive URIs from users, and play them. Insertion and deletion possible at any position.
  6378. + _category
  6379. Source / Input
  6380. + _type
  6381. (?id:string,?conservative:bool,?default_duration:float,
  6382. ?length:float,?timeout:float)->source('a)
  6383. + id
  6384. Force the value of the source ID.
  6385. + default
  6386. ""
  6387. + type
  6388. string
  6389. + conservative
  6390. If true, estimated remaining time on the current track is not considered when computing queue length.
  6391. + default
  6392. false
  6393. + type
  6394. bool
  6395. + default_duration
  6396. When unknown, assume this duration (in sec.) for files.
  6397. + default
  6398. 30.
  6399. + type
  6400. float
  6401. + length
  6402. How much audio (in sec.) should be queued in advance.
  6403. + default
  6404. 10.
  6405. + type
  6406. float
  6407. + timeout
  6408. Timeout (in sec.) for a single download.
  6409. + default
  6410. 20.
  6411. + type
  6412. float
  6413. + request.filename
  6414. Return a valid local filename if the request is ready, and the empty string otherwise.
  6415. + _category
  6416. Liquidsoap
  6417. + _type
  6418. (request('a))->string
  6419. + (unlabeled)
  6420. (no doc)
  6421. + default
  6422. None
  6423. + type
  6424. request('a)
  6425. + request.metadata
  6426. Get the metadata associated to a request.
  6427. + _category
  6428. Liquidsoap
  6429. + _type
  6430. (request('a))->[(string*string)]
  6431. + (unlabeled)
  6432. (no doc)
  6433. + default
  6434. None
  6435. + type
  6436. request('a)
  6437. + request.queue
  6438. Receive URIs from users, and play them.
  6439. + _category
  6440. Source / Input
  6441. + _type
  6442. (?id:string,?conservative:bool,?default_duration:float,
  6443. ?interactive:bool,?length:float,?queue:[request('a)],
  6444. ?timeout:float)->source('a)
  6445. + id
  6446. Force the value of the source ID.
  6447. + default
  6448. ""
  6449. + type
  6450. string
  6451. + conservative
  6452. If true, estimated remaining time on the current track is not considered when computing queue length.
  6453. + default
  6454. false
  6455. + type
  6456. bool
  6457. + default_duration
  6458. When unknown, assume this duration (in sec.) for files.
  6459. + default
  6460. 30.
  6461. + type
  6462. float
  6463. + interactive
  6464. Should the queue be controllable via telnet?
  6465. + default
  6466. true
  6467. + type
  6468. bool
  6469. + length
  6470. How much audio (in sec.) should be queued in advance.
  6471. + default
  6472. 10.
  6473. + type
  6474. float
  6475. + queue
  6476. Initial queue of requests.
  6477. + default
  6478. []
  6479. + type
  6480. [request('a)]
  6481. + timeout
  6482. Timeout (in sec.) for a single download.
  6483. + default
  6484. 20.
  6485. + type
  6486. float
  6487. + request.ready
  6488. Check if a request is ready, i.e. is associated to a valid local file. Unless the initial URI was such a file, a request has to be resolved before being ready.
  6489. + _category
  6490. Liquidsoap
  6491. + _type
  6492. (request('a))->bool
  6493. + (unlabeled)
  6494. (no doc)
  6495. + default
  6496. None
  6497. + type
  6498. request('a)
  6499. + request.resolve
  6500. Resolve a request, i.e. attempt to get a valid local file. The operation can take some time. Return true if the resolving was successful, false otherwise (timeout or invalid URI).
  6501. + _category
  6502. Liquidsoap
  6503. + _type
  6504. (?timeout:float,request('a))->bool
  6505. + timeout
  6506. Limit in seconds to the duration of the resolving.
  6507. + default
  6508. 30.
  6509. + type
  6510. float
  6511. + (unlabeled)
  6512. (no doc)
  6513. + default
  6514. None
  6515. + type
  6516. request('a)
  6517. + rewrite_metadata
  6518. Rewrite metadata on the fly using a list of (target,rules).
  6519. + _category
  6520. Source / Track Processing
  6521. + (unlabeled)
  6522. List of (target,value) rewriting rules.
  6523. + default
  6524. None
  6525. + type
  6526. [(string*string)]
  6527. + insert_missing
  6528. Treat track beginnings without metadata as having empty ones. The operational order is: create empty if needed, map and strip if enabled.
  6529. + default
  6530. true
  6531. + type
  6532. bool
  6533. + update
  6534. Only update metadata. If false, only returned values will be set as metadata.
  6535. + default
  6536. true
  6537. + type
  6538. bool
  6539. + strip
  6540. Completly remove empty metadata. Operates on both empty values and empty metadata chunk.
  6541. + default
  6542. false
  6543. + type
  6544. bool
  6545. + (unlabeled)
  6546. (no doc)
  6547. + default
  6548. None
  6549. + type
  6550. source('a)
  6551. + _type
  6552. ([(string*string)],?insert_missing:bool,?update:bool,
  6553. ?strip:bool,source('a))->source('a)
  6554. + rms
  6555. Get current audio RMS volume of the source. Returns a pair @(f,s)@ where s is a new source and @f@ is a function of type @() -> float@ and returns the current RMS of the source.
  6556. + _category
  6557. Source / Visualization
  6558. + _type
  6559. (?id:string,source(audio='#a+1,video='#b,midi='#c))->
  6560. ((()->float)*source(audio='#a+1,video='#b,midi='#c))
  6561. + id
  6562. Force the value of the source ID.
  6563. + default
  6564. ""
  6565. + type
  6566. string
  6567. + (unlabeled)
  6568. (no doc)
  6569. + default
  6570. None
  6571. + type
  6572. source(audio='#a+1,video='#b,midi='#c)
  6573. + rotate
  6574. Rotate between the sources.
  6575. + _category
  6576. Source / Track Processing
  6577. + _type
  6578. (?id:string,?replay_metadata:bool,?track_sensitive:bool,
  6579. ?transitions:[(source('a),source('a))->source('a)],
  6580. ?weights:[int],[source('a)])->source('a)
  6581. + id
  6582. Force the value of the source ID.
  6583. + default
  6584. ""
  6585. + type
  6586. string
  6587. + replay_metadata
  6588. Replay the last metadata of a child when switching to it in the middle of a track.
  6589. + default
  6590. true
  6591. + type
  6592. bool
  6593. + track_sensitive
  6594. Re-select only on end of tracks.
  6595. + default
  6596. true
  6597. + type
  6598. bool
  6599. + transitions
  6600. Transition functions, padded with <code>fun (x,y) -> y</code> functions.
  6601. + default
  6602. []
  6603. + type
  6604. [(source('a),source('a))->source('a)]
  6605. + weights
  6606. Weights of the children (padded with 1), defining for each child how many tracks are played from it per round, if that many are actually available.
  6607. + default
  6608. []
  6609. + type
  6610. [int]
  6611. + (unlabeled)
  6612. (no doc)
  6613. + default
  6614. None
  6615. + type
  6616. [source('a)]
  6617. + saw
  6618. Generate a saw wave.
  6619. + _category
  6620. Source / Input
  6621. + _type
  6622. (?id:string,?amplitude:float,?duration:float,?float)->
  6623. source(audio='#a+1,video=0,midi=0)
  6624. + id
  6625. Force the value of the source ID.
  6626. + default
  6627. ""
  6628. + type
  6629. string
  6630. + amplitude
  6631. Maximal value of the waveform.
  6632. + default
  6633. 1.
  6634. + type
  6635. float
  6636. + duration
  6637. Duration in seconds (0. means infinite).
  6638. + default
  6639. 0.
  6640. + type
  6641. float
  6642. + (unlabeled)
  6643. Frequency of the saw.
  6644. + default
  6645. 440.
  6646. + type
  6647. float
  6648. + say_metadata
  6649. Append speech-synthesized tracks reading the metadata.
  6650. + _category
  6651. Source / Track Processing
  6652. + (unlabeled)
  6653. The source to use
  6654. + default
  6655. None
  6656. + type
  6657. source(?A)
  6658. + pattern
  6659. Pattern to use
  6660. + default
  6661. "say:$(if $(artist),\"It was $(artist)$(if $(title),\\\", $(title)\\\").\")"
  6662. + type
  6663. string
  6664. + _type
  6665. (source(?A),?pattern:string)->source(?A)
  6666. + sequence
  6667. Play only one track of every successive source, except for the last one which is played as much as available. Sources are released after being used, allowing them to shutdown cleanly and free their resources.
  6668. + _category
  6669. Source / Track Processing
  6670. + _type
  6671. (?id:string,?merge:bool,[source('a)])->source('a)
  6672. + id
  6673. Force the value of the source ID.
  6674. + default
  6675. ""
  6676. + type
  6677. string
  6678. + merge
  6679. (no doc)
  6680. + default
  6681. false
  6682. + type
  6683. bool
  6684. + (unlabeled)
  6685. (no doc)
  6686. + default
  6687. None
  6688. + type
  6689. [source('a)]
  6690. + server.execute
  6691. Execute a liquidsoap server command.
  6692. + _category
  6693. Liquidsoap
  6694. + _type
  6695. (string,?string)->[string]
  6696. + (unlabeled)
  6697. (no doc)
  6698. + default
  6699. None
  6700. + type
  6701. string
  6702. + (unlabeled)
  6703. (no doc)
  6704. + default
  6705. ""
  6706. + type
  6707. string
  6708. + server.insert_metadata
  6709. Register a server/telnet command to update a source's metadata. Returns a new source, which will receive the updated metadata. The command has the following format: insert key1="val1",key2="val2",...
  6710. + _category
  6711. Source / Track Processing
  6712. + id
  6713. Force the value of the source ID.
  6714. + default
  6715. ""
  6716. + type
  6717. string
  6718. + (unlabeled)
  6719. (no doc)
  6720. + default
  6721. None
  6722. + type
  6723. source('a)
  6724. + _type
  6725. (?id:string,source('a))->source('a)
  6726. + server.register
  6727. Register a command. You can then execute this function through the server, either telnet or socket.
  6728. + _category
  6729. Interaction
  6730. + _type
  6731. (?namespace:string,?description:string,?usage:string,
  6732. string,((string)->string))->unit
  6733. + namespace
  6734. (no doc)
  6735. + default
  6736. ""
  6737. + type
  6738. string
  6739. + description
  6740. A description of your command.
  6741. + default
  6742. "No documentation available."
  6743. + type
  6744. string
  6745. + usage
  6746. (no doc)
  6747. + default
  6748. ""
  6749. + type
  6750. string
  6751. + (unlabeled)
  6752. (no doc)
  6753. + default
  6754. None
  6755. + type
  6756. string
  6757. + (unlabeled)
  6758. (no doc)
  6759. + default
  6760. None
  6761. + type
  6762. (string)->string
  6763. + server.rms
  6764. Register a command that outputs the RMS of the returned source.
  6765. + _category
  6766. Source / Visualization
  6767. + id
  6768. Force the value of the source ID.
  6769. + default
  6770. ""
  6771. + type
  6772. string
  6773. + (unlabeled)
  6774. (no doc)
  6775. + default
  6776. None
  6777. + type
  6778. source(audio='#a+1,video='#b,midi='#c)
  6779. + _type
  6780. (?id:string,source(audio='#a+1,video='#b,midi='#c))->
  6781. source(audio='#a+1,video='#b,midi='#c)
  6782. + set
  6783. Change some setting. Use <code>liquidsoap --conf-descr</code> and <code>liquidsoap --conf-descr-key KEY</code> on the command-line to get some information about available settings.
  6784. + _category
  6785. Liquidsoap
  6786. + _type
  6787. (string,'a)->unit
  6788. where 'a is bool, int, float, string or [string]
  6789. + (unlabeled)
  6790. (no doc)
  6791. + default
  6792. None
  6793. + type
  6794. string
  6795. + (unlabeled)
  6796. (no doc)
  6797. + default
  6798. None
  6799. + type
  6800. anything that is bool, int, float, string or [string]
  6801. + setenv
  6802. Set the value associated to a variable in the process environment.
  6803. + _category
  6804. System
  6805. + _type
  6806. (string,string)->unit
  6807. + (unlabeled)
  6808. Variable to be set.
  6809. + default
  6810. None
  6811. + type
  6812. string
  6813. + (unlabeled)
  6814. Value to set.
  6815. + default
  6816. None
  6817. + type
  6818. string
  6819. + shutdown
  6820. Shutdown the application.
  6821. + _category
  6822. System
  6823. + _type
  6824. ()->unit
  6825. + sine
  6826. Generate a sine wave.
  6827. + _category
  6828. Source / Input
  6829. + _type
  6830. (?id:string,?amplitude:float,?duration:float,?float)->
  6831. source(audio='#a+1,video=0,midi=0)
  6832. + id
  6833. Force the value of the source ID.
  6834. + default
  6835. ""
  6836. + type
  6837. string
  6838. + amplitude
  6839. Maximal value of the waveform.
  6840. + default
  6841. 1.
  6842. + type
  6843. float
  6844. + duration
  6845. Duration in seconds (0. means infinite).
  6846. + default
  6847. 0.
  6848. + type
  6849. float
  6850. + (unlabeled)
  6851. Frequency of the sine.
  6852. + default
  6853. 440.
  6854. + type
  6855. float
  6856. + single
  6857. Loop on a request. It never fails if the request is static, meaning that it can be fetched once. Typically, http, ftp, say requests are static, and time is not.
  6858. + _category
  6859. Source / Input
  6860. + _type
  6861. (?id:string,?conservative:bool,?default_duration:float,
  6862. ?length:float,?timeout:float,string)->source('a)
  6863. + id
  6864. Force the value of the source ID.
  6865. + default
  6866. ""
  6867. + type
  6868. string
  6869. + conservative
  6870. If true, estimated remaining time on the current track is not considered when computing queue length.
  6871. + default
  6872. false
  6873. + type
  6874. bool
  6875. + default_duration
  6876. When unknown, assume this duration (in sec.) for files.
  6877. + default
  6878. 30.
  6879. + type
  6880. float
  6881. + length
  6882. How much audio (in sec.) should be queued in advance.
  6883. + default
  6884. 10.
  6885. + type
  6886. float
  6887. + timeout
  6888. Timeout (in sec.) for a single download.
  6889. + default
  6890. 20.
  6891. + type
  6892. float
  6893. + (unlabeled)
  6894. URI where to find the file
  6895. + default
  6896. None
  6897. + type
  6898. string
  6899. + skip_blank
  6900. Skip track when detecting a blank.
  6901. + _category
  6902. Source / Track Processing
  6903. + id
  6904. Force the value of the source ID.
  6905. + default
  6906. ""
  6907. + type
  6908. string
  6909. + threshold
  6910. Power in decibels under which the stream is considered silent.
  6911. + default
  6912. -40.
  6913. + type
  6914. float
  6915. + max_blank
  6916. Maximum silence length allowed, in seconds.
  6917. + default
  6918. 20.
  6919. + type
  6920. float
  6921. + min_noise
  6922. Minimum duration of noise required to end silence, in seconds.
  6923. + default
  6924. 0.
  6925. + type
  6926. float
  6927. + track_sensitive
  6928. Reset blank counter at each track.
  6929. + default
  6930. true
  6931. + type
  6932. bool
  6933. + (unlabeled)
  6934. (no doc)
  6935. + default
  6936. None
  6937. + type
  6938. source(audio='#a,video='#b,midi='#c)
  6939. + _type
  6940. (?id:string,?threshold:float,?max_blank:float,
  6941. ?min_noise:float,?track_sensitive:bool,
  6942. source(audio='#a,video='#b,midi='#c))->
  6943. source(audio='#a,video='#b,midi='#c)
  6944. + sky
  6945. Multiband-compression.
  6946. + _category
  6947. Source / Sound Processing
  6948. + (unlabeled)
  6949. The input source.
  6950. + default
  6951. None
  6952. + type
  6953. source(audio='#a,video='#b,midi=0)
  6954. + _type
  6955. (source(audio='#a,video='#b,midi=0))->
  6956. source(audio='#a,video='#b,midi=0)
  6957. + smart_cross
  6958. Cross operator, allowing the composition of the N last seconds of a track with the beginning of the next track, using a transition function depending on the relative power of the signal before and after the end of track.
  6959. + _category
  6960. Source / Sound Processing
  6961. + _type
  6962. (?id:string,?active:bool,?conservative:bool,
  6963. ?duration:float,?inhibit:float,?minimum:float,
  6964. ?width:float,
  6965. ((float,float,[(string*string)],[(string*string)],
  6966. source(audio='#a+1,video=0,midi=0),
  6967. source(audio='#a+1,video=0,midi=0))->
  6968. source(audio='#a+1,video=0,midi=0)),
  6969. source(audio='#a+1,video=0,midi=0))->
  6970. source(audio='#a+1,video=0,midi=0)
  6971. + id
  6972. Force the value of the source ID.
  6973. + default
  6974. ""
  6975. + type
  6976. string
  6977. + active
  6978. The active behavior is to keep ticking the child's clock when the operator is not streaming. Otherwise the child's clock is strictly based on what is streamed off the child source, which results in time-dependent active sources to be frozen when that source is stopped.
  6979. + default
  6980. false
  6981. + type
  6982. bool
  6983. + conservative
  6984. Do not trust remaining time estimations, always buffering data in advance. This avoids being tricked by skips, either manual or caused by skip_blank().
  6985. + default
  6986. false
  6987. + type
  6988. bool
  6989. + duration
  6990. Duration in seconds of the crossed end of track.
  6991. + default
  6992. 5.
  6993. + type
  6994. float
  6995. + inhibit
  6996. Minimum delay between two transitions. It is useful in order to avoid that a transition is triggered on top of another when an end-of-track occurs in the first one. Negative values mean <code>duration+1</code>. Warning: zero inhibition can cause infinite loops.
  6997. + default
  6998. -1.
  6999. + type
  7000. float
  7001. + minimum
  7002. Minimum duration (in sec.) for a cross: If the track ends without any warning (e.g. in case of skip) there may not be enough data for a decent composition. Set to 0. to avoid having transitions after skips, or more to avoid transitions on short tracks. With the negative default, transitions always occur.
  7003. + default
  7004. -1.
  7005. + type
  7006. float
  7007. + width
  7008. Width of the power computation window.
  7009. + default
  7010. 1.
  7011. + type
  7012. float
  7013. + (unlabeled)
  7014. Transition function, composing from the end of a track and the next track. It also takes the power of the signal before and after the transition, and the metadata.
  7015. + default
  7016. None
  7017. + type
  7018. (float,float,[(string*string)],[(string*string)],
  7019. source(audio='#a+1,video=0,midi=0),
  7020. source(audio='#a+1,video=0,midi=0))->
  7021. source(audio='#a+1,video=0,midi=0)
  7022. + (unlabeled)
  7023. (no doc)
  7024. + default
  7025. None
  7026. + type
  7027. source(audio='#a+1,video=0,midi=0)
  7028. + smart_crossfade
  7029. Crossfade between tracks, taking the respective volume levels into account in the choice of the transition.
  7030. + _category
  7031. Source / Track Processing
  7032. + start_next
  7033. Crossing duration, if any.
  7034. + default
  7035. 5.
  7036. + type
  7037. float
  7038. + fade_in
  7039. Fade-in duration, if any.
  7040. + default
  7041. 3.
  7042. + type
  7043. float
  7044. + fade_out
  7045. Fade-out duration, if any.
  7046. + default
  7047. 3.
  7048. + type
  7049. float
  7050. + default
  7051. Transition used when no rule applies (default: sequence).
  7052. + default
  7053. <fun>
  7054. + type
  7055. (source(audio='#a+1,video=0,midi=0),
  7056. source(audio='#a+1,video=0,midi=0))->
  7057. source(audio='#a+1,video=0,midi=0)
  7058. + high
  7059. Value, in dB, for loud sound level.
  7060. + default
  7061. -15.
  7062. + type
  7063. float
  7064. + medium
  7065. Value, in dB, for medium sound level.
  7066. + default
  7067. -32.
  7068. + type
  7069. float
  7070. + margin
  7071. Margin to detect sources that have too different sound level for crossing.
  7072. + default
  7073. 4.
  7074. + type
  7075. float
  7076. + width
  7077. Width of the volume analysis window.
  7078. + default
  7079. 2.
  7080. + type
  7081. float
  7082. + conservative
  7083. Always prepare for a premature end-of-track.
  7084. + default
  7085. true
  7086. + type
  7087. bool
  7088. + (unlabeled)
  7089. The input source.
  7090. + default
  7091. None
  7092. + type
  7093. source(audio='#a+1,video=0,midi=0)
  7094. + _type
  7095. (?start_next:float,?fade_in:float,?fade_out:float,
  7096. ?default:((source(audio='#a+1,video=0,midi=0),
  7097. source(audio='#a+1,video=0,midi=0))->
  7098. source(audio='#a+1,video=0,midi=0)),
  7099. ?high:float,?medium:float,?margin:float,?width:float,
  7100. ?conservative:bool,source(audio='#a+1,video=0,midi=0))->
  7101. source(audio='#a+1,video=0,midi=0)
  7102. + smooth_add
  7103. Mixes two streams, with faded transitions between the state when only the normal stream is available and when the special stream gets added on top of it.
  7104. + _category
  7105. Source / Track Processing
  7106. + delay
  7107. Delay before starting the special source.
  7108. + default
  7109. 0.5
  7110. + type
  7111. float
  7112. + p
  7113. Portion of amplitude of the normal source in the mix.
  7114. + default
  7115. 0.2
  7116. + type
  7117. float
  7118. + normal
  7119. The normal source, which could be called the carrier too.
  7120. + default
  7121. None
  7122. + type
  7123. source(audio='#a,video='#b,midi=0)
  7124. + special
  7125. The special source.
  7126. + default
  7127. None
  7128. + type
  7129. source(audio='#a,video='#b,midi=0)
  7130. + _type
  7131. (?delay:float,?p:float,
  7132. normal:source(audio='#a,video='#b,midi=0),
  7133. special:source(audio='#a,video='#b,midi=0))->
  7134. source(audio='#a,video='#b,midi=0)
  7135. + snd
  7136. Get the second component of a pair.
  7137. + _category
  7138. Pair
  7139. + _type
  7140. (('a*'b))->'b
  7141. + (unlabeled)
  7142. (no doc)
  7143. + default
  7144. None
  7145. + type
  7146. ('a*'b)
  7147. + source.dynamic
  7148. Dynamically change the underlying source.
  7149. + _category
  7150. Source / Track Processing
  7151. + _type
  7152. (?id:string,(()->[source('a)]))->source('a)
  7153. + _flag
  7154. experimental
  7155. + id
  7156. Force the value of the source ID.
  7157. + default
  7158. ""
  7159. + type
  7160. string
  7161. + (unlabeled)
  7162. (no doc)
  7163. + default
  7164. None
  7165. + type
  7166. ()->[source('a)]
  7167. + source.fallible
  7168. Indicate if a source may fail, i.e. may not be ready to stream.
  7169. + _category
  7170. Liquidsoap
  7171. + _type
  7172. (source('a))->bool
  7173. + (unlabeled)
  7174. (no doc)
  7175. + default
  7176. None
  7177. + type
  7178. source('a)
  7179. + source.id
  7180. Get one source's identifier.
  7181. + _category
  7182. Liquidsoap
  7183. + _type
  7184. (source('a))->string
  7185. + (unlabeled)
  7186. (no doc)
  7187. + default
  7188. None
  7189. + type
  7190. source('a)
  7191. + source.init
  7192. Simultaneously initialize sources, return the sublist of sources that failed to initialized.
  7193. + _category
  7194. Liquidsoap
  7195. + _type
  7196. ([source(audio=*,video=*,midi=*)])->
  7197. [source(audio=*,video=*,midi=*)]
  7198. + (unlabeled)
  7199. (no doc)
  7200. + default
  7201. None
  7202. + type
  7203. [source(audio=*,video=*,midi=*)]
  7204. + source.is_ready
  7205. Indicate if a source is ready to stream, or currently streaming.
  7206. + _category
  7207. Liquidsoap
  7208. + _type
  7209. (source('a))->bool
  7210. + (unlabeled)
  7211. (no doc)
  7212. + default
  7213. None
  7214. + type
  7215. source('a)
  7216. + source.on_shutdown
  7217. Register a function to be called when source shuts down.
  7218. + _category
  7219. System
  7220. + _type
  7221. (source('a),(()->unit))->unit
  7222. + (unlabeled)
  7223. (no doc)
  7224. + default
  7225. None
  7226. + type
  7227. source('a)
  7228. + (unlabeled)
  7229. (no doc)
  7230. + default
  7231. None
  7232. + type
  7233. ()->unit
  7234. + source.remaining
  7235. Estimation of remaining time in the current track.
  7236. + _category
  7237. Liquidsoap
  7238. + _type
  7239. (source('a))->float
  7240. + (unlabeled)
  7241. (no doc)
  7242. + default
  7243. None
  7244. + type
  7245. source('a)
  7246. + source.seek
  7247. Seek forward, in seconds. Returns the amount of time effectively seeked.
  7248. + _category
  7249. Liquidsoap
  7250. + _type
  7251. (source('a),float)->float
  7252. + (unlabeled)
  7253. (no doc)
  7254. + default
  7255. None
  7256. + type
  7257. source('a)
  7258. + (unlabeled)
  7259. (no doc)
  7260. + default
  7261. None
  7262. + type
  7263. float
  7264. + source.shutdown
  7265. Desactivate a source.
  7266. + _category
  7267. Liquidsoap
  7268. + _type
  7269. (source('a))->unit
  7270. + (unlabeled)
  7271. (no doc)
  7272. + default
  7273. None
  7274. + type
  7275. source('a)
  7276. + source.skip
  7277. Skip to the next track.
  7278. + _category
  7279. Liquidsoap
  7280. + _type
  7281. (source('a))->unit
  7282. + (unlabeled)
  7283. (no doc)
  7284. + default
  7285. None
  7286. + type
  7287. source('a)
  7288. + square
  7289. Generate a square wave.
  7290. + _category
  7291. Source / Input
  7292. + _type
  7293. (?id:string,?amplitude:float,?duration:float,?float)->
  7294. source(audio='#a+1,video=0,midi=0)
  7295. + id
  7296. Force the value of the source ID.
  7297. + default
  7298. ""
  7299. + type
  7300. string
  7301. + amplitude
  7302. Maximal value of the waveform.
  7303. + default
  7304. 1.
  7305. + type
  7306. float
  7307. + duration
  7308. Duration in seconds (0. means infinite).
  7309. + default
  7310. 0.
  7311. + type
  7312. float
  7313. + (unlabeled)
  7314. Frequency of the square.
  7315. + default
  7316. 440.
  7317. + type
  7318. float
  7319. + stereo.ms.decode
  7320. Decode mid+side stereo (M/S) to left+right stereo.
  7321. + _category
  7322. Source / Sound Processing
  7323. + _type
  7324. (?id:string,?width:float,source(audio=2,video=0,midi=0))->
  7325. source(audio=2,video=0,midi=0)
  7326. + id
  7327. Force the value of the source ID.
  7328. + default
  7329. ""
  7330. + type
  7331. string
  7332. + width
  7333. Width of the stereo field.
  7334. + default
  7335. 1.
  7336. + type
  7337. float
  7338. + (unlabeled)
  7339. (no doc)
  7340. + default
  7341. None
  7342. + type
  7343. source(audio=2,video=0,midi=0)
  7344. + stereo.ms.encode
  7345. Encode left+right stereo to mid+side stereo (M/S).
  7346. + _category
  7347. Source / Sound Processing
  7348. + _type
  7349. (?id:string,source(audio=2,video=0,midi=0))->
  7350. source(audio=2,video=0,midi=0)
  7351. + id
  7352. Force the value of the source ID.
  7353. + default
  7354. ""
  7355. + type
  7356. string
  7357. + (unlabeled)
  7358. (no doc)
  7359. + default
  7360. None
  7361. + type
  7362. source(audio=2,video=0,midi=0)
  7363. + stereo.pan
  7364. Pan a stereo sound.
  7365. + _category
  7366. Source / Sound Processing
  7367. + _type
  7368. (?id:string,?field:'a,?pan:'b,
  7369. source(audio=2,video=0,midi=0))->
  7370. source(audio=2,video=0,midi=0)
  7371. where 'a, 'b is either float or ()->float
  7372. + id
  7373. Force the value of the source ID.
  7374. + default
  7375. ""
  7376. + type
  7377. string
  7378. + field
  7379. Field width in degrees (between 0 and 90).
  7380. + default
  7381. 90.
  7382. + type
  7383. anything that is either float or ()->float
  7384. + pan
  7385. Pan ranges between -1 and 1.
  7386. + default
  7387. 0.
  7388. + type
  7389. anything that is either float or ()->float
  7390. + (unlabeled)
  7391. (no doc)
  7392. + default
  7393. None
  7394. + type
  7395. source(audio=2,video=0,midi=0)
  7396. + store_metadata
  7397. Keep track of the last N metadata packets in the stream, and make the history available via a server command.
  7398. + _category
  7399. Source / Track Processing
  7400. + _type
  7401. (?id:string,?size:int,source('a))->source('a)
  7402. + id
  7403. Force the value of the source ID.
  7404. + default
  7405. ""
  7406. + type
  7407. string
  7408. + size
  7409. Size of the history
  7410. + default
  7411. 10
  7412. + type
  7413. int
  7414. + (unlabeled)
  7415. (no doc)
  7416. + default
  7417. None
  7418. + type
  7419. source('a)
  7420. + stretch
  7421. Slow down or accelerate an audio stream by stretching (sounds lower) or squeezing it (sounds higher).
  7422. + _category
  7423. Source / Sound Processing
  7424. + _type
  7425. (?id:string,?active:bool,ratio:'a,
  7426. source(audio='#b+1,video=0,midi=0))->
  7427. source(audio='#c+1,video=0,midi=0)
  7428. where 'a is either float or ()->float
  7429. + id
  7430. Force the value of the source ID.
  7431. + default
  7432. ""
  7433. + type
  7434. string
  7435. + active
  7436. The active behavior is to keep ticking the child's clock when the operator is not streaming. Otherwise the child's clock is strictly based on what is streamed off the child source, which results in time-dependent active sources to be frozen when that source is stopped.
  7437. + default
  7438. true
  7439. + type
  7440. bool
  7441. + ratio
  7442. A value higher than 1 means slowing down.
  7443. + default
  7444. None
  7445. + type
  7446. anything that is either float or ()->float
  7447. + (unlabeled)
  7448. (no doc)
  7449. + default
  7450. None
  7451. + type
  7452. source(audio='#b+1,video=0,midi=0)
  7453. + string.capitalize
  7454. Return a string with the first character set to upper case (capitalize), or to lower case (uncapitalize).
  7455. + _category
  7456. String
  7457. + _type
  7458. (?capitalize:bool,?space_sensitive:bool,string)->string
  7459. + capitalize
  7460. Capitalize if true, uncapitalize otherwise
  7461. + default
  7462. true
  7463. + type
  7464. bool
  7465. + space_sensitive
  7466. Capitalize each space separated sub-string.
  7467. + default
  7468. true
  7469. + type
  7470. bool
  7471. + (unlabeled)
  7472. (no doc)
  7473. + default
  7474. None
  7475. + type
  7476. string
  7477. + string.case
  7478. Convert a string to lower or upper case.
  7479. + _category
  7480. String
  7481. + _type
  7482. (?lower:bool,string)->string
  7483. + lower
  7484. Convert to lower case if true and uppercase otherwise.
  7485. + default
  7486. true
  7487. + type
  7488. bool
  7489. + (unlabeled)
  7490. (no doc)
  7491. + default
  7492. None
  7493. + type
  7494. string
  7495. + string.concat
  7496. Concatenate strings.
  7497. + _category
  7498. String
  7499. + _type
  7500. (?separator:string,[string])->string
  7501. + separator
  7502. (no doc)
  7503. + default
  7504. ""
  7505. + type
  7506. string
  7507. + (unlabeled)
  7508. (no doc)
  7509. + default
  7510. None
  7511. + type
  7512. [string]
  7513. + string.escape
  7514. Escape special charaters in a string. String is parsed char by char. See @string.utf8.escape@ for an UTF8-aware parsing function.
  7515. + _category
  7516. String
  7517. + _type
  7518. (?special_chars:[string],?escape_char:((string)->string),
  7519. string)->string
  7520. + special_chars
  7521. List of characters that should be escaped. The first character of each element in the list is considered.
  7522. + default
  7523. ["\127", "\\", "\"", "\000", "\001", "\002", "\003", "\004", "\005", "\006", "\007", "\b", "\t", "\n", "\011", "\012", "\r", "\014", "\015", "\016", "\017", "\018", "\019", "\020", "\021", "\022", "\023", "\024", "\025", "\026", "\027", "\028", "\029", "\030", "\031"]
  7524. + type
  7525. [string]
  7526. + escape_char
  7527. Function used to escape a character.
  7528. + default
  7529. <fun>
  7530. + type
  7531. (string)->string
  7532. + (unlabeled)
  7533. (no doc)
  7534. + default
  7535. None
  7536. + type
  7537. string
  7538. + string.extract
  7539. Extract substrings from a string.
  7540. Perl compatible regular expressions are recognized. Hence, special characters should be escaped.
  7541. Returns a list of (index,value).
  7542. If the list does not have a pair associated to some index, it means that the corresponding pattern was not found.
  7543. + _category
  7544. String
  7545. + _type
  7546. (pattern:string,string)->[(string*string)]
  7547. + pattern
  7548. (no doc)
  7549. + default
  7550. None
  7551. + type
  7552. string
  7553. + (unlabeled)
  7554. (no doc)
  7555. + default
  7556. None
  7557. + type
  7558. string
  7559. + string.length
  7560. Get the length of a string.
  7561. + _category
  7562. String
  7563. + _type
  7564. (string)->int
  7565. + (unlabeled)
  7566. (no doc)
  7567. + default
  7568. None
  7569. + type
  7570. string
  7571. + string.match
  7572. Match a string with an expression.
  7573. Perl compatible regular expressions are recognized. Hence, special characters should be escaped.
  7574. + _category
  7575. String
  7576. + _type
  7577. (pattern:string,string)->bool
  7578. + pattern
  7579. (no doc)
  7580. + default
  7581. None
  7582. + type
  7583. string
  7584. + (unlabeled)
  7585. (no doc)
  7586. + default
  7587. None
  7588. + type
  7589. string
  7590. + string.recode
  7591. Convert a string. Effective only if Camomile is enabled.
  7592. + _category
  7593. String
  7594. + _type
  7595. (?in_enc:string,?out_enc:string,string)->string
  7596. + in_enc
  7597. Input encoding. Autodetected if empty.
  7598. + default
  7599. ""
  7600. + type
  7601. string
  7602. + out_enc
  7603. Output encoding.
  7604. + default
  7605. "UTF-8"
  7606. + type
  7607. string
  7608. + (unlabeled)
  7609. (no doc)
  7610. + default
  7611. None
  7612. + type
  7613. string
  7614. + string.replace
  7615. Replace substrings in a string.
  7616. Will replace all substrings matched in the pattern by the string returned by the replace function.
  7617. + _category
  7618. String
  7619. + _type
  7620. (pattern:string,((string)->string),string)->string
  7621. + pattern
  7622. (no doc)
  7623. + default
  7624. None
  7625. + type
  7626. string
  7627. + (unlabeled)
  7628. (no doc)
  7629. + default
  7630. None
  7631. + type
  7632. (string)->string
  7633. + (unlabeled)
  7634. (no doc)
  7635. + default
  7636. None
  7637. + type
  7638. string
  7639. + string.split
  7640. Split a string at 'separator'.
  7641. Perl compatible regular expressions are recognized. Hence, special characters should be escaped.
  7642. + _category
  7643. String
  7644. + _type
  7645. (separator:string,string)->[string]
  7646. + separator
  7647. (no doc)
  7648. + default
  7649. None
  7650. + type
  7651. string
  7652. + (unlabeled)
  7653. (no doc)
  7654. + default
  7655. None
  7656. + type
  7657. string
  7658. + string.utf8.escape
  7659. Escape special charaters in an UTF8 string.
  7660. + _category
  7661. String
  7662. + _type
  7663. (?special_chars:[string],?escape_char:((string)->string),
  7664. string)->string
  7665. + special_chars
  7666. List of characters that should be escaped. The first character of each element in the list is considered.
  7667. + default
  7668. ["\127", "\\", "\"", "\000", "\001", "\002", "\003", "\004", "\005", "\006", "\007", "\b", "\t", "\n", "\011", "\012", "\r", "\014", "\015", "\016", "\017", "\018", "\019", "\020", "\021", "\022", "\023", "\024", "\025", "\026", "\027", "\028", "\029", "\030", "\031"]
  7669. + type
  7670. [string]
  7671. + escape_char
  7672. Function used to escape a character.
  7673. + default
  7674. <fun>
  7675. + type
  7676. (string)->string
  7677. + (unlabeled)
  7678. (no doc)
  7679. + default
  7680. None
  7681. + type
  7682. string
  7683. + string_of
  7684. Return the representation of a value.
  7685. + _category
  7686. String
  7687. + _type
  7688. ('a)->string
  7689. + (unlabeled)
  7690. (no doc)
  7691. + default
  7692. None
  7693. + type
  7694. 'a
  7695. + string_of_metadata
  7696. Standard function for displaying metadata.
  7697. Shows artist and title, using "Unknown" when a field is empty.
  7698. + _category
  7699. String
  7700. + (unlabeled)
  7701. Metadata packet to be displayed.
  7702. + default
  7703. None
  7704. + type
  7705. [(string*string)]
  7706. + _type
  7707. ([(string*string)])->string
  7708. + strip_blank
  7709. Make the source unavailable when it is streaming blank.
  7710. + _category
  7711. Source / Track Processing
  7712. + _type
  7713. (?id:string,?max_blank:float,?min_noise:float,
  7714. ?threshold:float,?track_sensitive:bool,
  7715. source(audio='#a,video='#b,midi='#c))->
  7716. source(audio='#a,video='#b,midi='#c)
  7717. + id
  7718. Force the value of the source ID.
  7719. + default
  7720. ""
  7721. + type
  7722. string
  7723. + max_blank
  7724. Maximum duration of silence allowed, in seconds.
  7725. + default
  7726. 20.
  7727. + type
  7728. float
  7729. + min_noise
  7730. Minimum duration of noise required to end silence, in seconds.
  7731. + default
  7732. 0.
  7733. + type
  7734. float
  7735. + threshold
  7736. Power in decibels under which the stream is considered silent.
  7737. + default
  7738. -40.
  7739. + type
  7740. float
  7741. + track_sensitive
  7742. Reset blank counter at each track.
  7743. + default
  7744. true
  7745. + type
  7746. bool
  7747. + (unlabeled)
  7748. (no doc)
  7749. + default
  7750. None
  7751. + type
  7752. source(audio='#a,video='#b,midi='#c)
  7753. + swap
  7754. Swap two channels of a stereo source.
  7755. + _category
  7756. Source / Conversions
  7757. + _type
  7758. (?id:string,source(audio=2,video=0,midi=0))->
  7759. source(audio=2,video=0,midi=0)
  7760. + id
  7761. Force the value of the source ID.
  7762. + default
  7763. ""
  7764. + type
  7765. string
  7766. + (unlabeled)
  7767. (no doc)
  7768. + default
  7769. None
  7770. + type
  7771. source(audio=2,video=0,midi=0)
  7772. + switch
  7773. At the beginning of a track, select the first source whose predicate is true.
  7774. + _category
  7775. Source / Track Processing
  7776. + _type
  7777. (?id:string,?replay_metadata:bool,?single:[bool],
  7778. ?track_sensitive:bool,
  7779. ?transitions:[(source('a),source('a))->source('a)],
  7780. [((()->bool)*source('a))])->source('a)
  7781. + id
  7782. Force the value of the source ID.
  7783. + default
  7784. ""
  7785. + type
  7786. string
  7787. + replay_metadata
  7788. Replay the last metadata of a child when switching to it in the middle of a track.
  7789. + default
  7790. true
  7791. + type
  7792. bool
  7793. + single
  7794. Forbid the selection of a branch for two tracks in a row. The empty list stands for <code>[false,...,false]</code>.
  7795. + default
  7796. []
  7797. + type
  7798. [bool]
  7799. + track_sensitive
  7800. Re-select only on end of tracks.
  7801. + default
  7802. true
  7803. + type
  7804. bool
  7805. + transitions
  7806. Transition functions, padded with <code>fun (x,y) -> y</code> functions.
  7807. + default
  7808. []
  7809. + type
  7810. [(source('a),source('a))->source('a)]
  7811. + (unlabeled)
  7812. Sources with the predicate telling when they can be played.
  7813. + default
  7814. None
  7815. + type
  7816. [((()->bool)*source('a))]
  7817. + synth.all.saw
  7818. Saw synthesizer. It creates one synthesizer for each channel.
  7819. + _category
  7820. Source / Sound Synthesis
  7821. + _type
  7822. (?id:string,?attack:float,?decay:float,?envelope:bool,
  7823. ?release:float,?sustain:float,
  7824. source(audio='#a+1,video='#b,midi='#c+16))->
  7825. source(audio='#a+1,video='#b,midi='#c+16)
  7826. + id
  7827. Force the value of the source ID.
  7828. + default
  7829. ""
  7830. + type
  7831. string
  7832. + attack
  7833. Envelope attack (in seconds).
  7834. + default
  7835. 0.02
  7836. + type
  7837. float
  7838. + decay
  7839. Envelope decay (in seconds).
  7840. + default
  7841. 0.01
  7842. + type
  7843. float
  7844. + envelope
  7845. Use envelope.
  7846. + default
  7847. true
  7848. + type
  7849. bool
  7850. + release
  7851. Envelope release (in seconds).
  7852. + default
  7853. 0.01
  7854. + type
  7855. float
  7856. + sustain
  7857. Envelope sustain level.
  7858. + default
  7859. 0.9
  7860. + type
  7861. float
  7862. + (unlabeled)
  7863. (no doc)
  7864. + default
  7865. None
  7866. + type
  7867. source(audio='#a+1,video='#b,midi='#c+16)
  7868. + synth.all.sine
  7869. Sine synthesizer. It creates one synthesizer for each channel.
  7870. + _category
  7871. Source / Sound Synthesis
  7872. + _type
  7873. (?id:string,?attack:float,?decay:float,?envelope:bool,
  7874. ?release:float,?sustain:float,
  7875. source(audio='#a+1,video='#b,midi='#c+16))->
  7876. source(audio='#a+1,video='#b,midi='#c+16)
  7877. + id
  7878. Force the value of the source ID.
  7879. + default
  7880. ""
  7881. + type
  7882. string
  7883. + attack
  7884. Envelope attack (in seconds).
  7885. + default
  7886. 0.02
  7887. + type
  7888. float
  7889. + decay
  7890. Envelope decay (in seconds).
  7891. + default
  7892. 0.01
  7893. + type
  7894. float
  7895. + envelope
  7896. Use envelope.
  7897. + default
  7898. true
  7899. + type
  7900. bool
  7901. + release
  7902. Envelope release (in seconds).
  7903. + default
  7904. 0.01
  7905. + type
  7906. float
  7907. + sustain
  7908. Envelope sustain level.
  7909. + default
  7910. 0.9
  7911. + type
  7912. float
  7913. + (unlabeled)
  7914. (no doc)
  7915. + default
  7916. None
  7917. + type
  7918. source(audio='#a+1,video='#b,midi='#c+16)
  7919. + synth.all.square
  7920. Square synthesizer. It creates one synthesizer for each channel.
  7921. + _category
  7922. Source / Sound Synthesis
  7923. + _type
  7924. (?id:string,?attack:float,?decay:float,?envelope:bool,
  7925. ?release:float,?sustain:float,
  7926. source(audio='#a+1,video='#b,midi='#c+16))->
  7927. source(audio='#a+1,video='#b,midi='#c+16)
  7928. + id
  7929. Force the value of the source ID.
  7930. + default
  7931. ""
  7932. + type
  7933. string
  7934. + attack
  7935. Envelope attack (in seconds).
  7936. + default
  7937. 0.02
  7938. + type
  7939. float
  7940. + decay
  7941. Envelope decay (in seconds).
  7942. + default
  7943. 0.01
  7944. + type
  7945. float
  7946. + envelope
  7947. Use envelope.
  7948. + default
  7949. true
  7950. + type
  7951. bool
  7952. + release
  7953. Envelope release (in seconds).
  7954. + default
  7955. 0.01
  7956. + type
  7957. float
  7958. + sustain
  7959. Envelope sustain level.
  7960. + default
  7961. 0.9
  7962. + type
  7963. float
  7964. + (unlabeled)
  7965. (no doc)
  7966. + default
  7967. None
  7968. + type
  7969. source(audio='#a+1,video='#b,midi='#c+16)
  7970. + synth.saw
  7971. Saw synthesizer.
  7972. + _category
  7973. Source / Sound Synthesis
  7974. + _type
  7975. (?id:string,?attack:float,?channel:int,?decay:float,
  7976. ?envelope:bool,?release:float,?sustain:float,
  7977. ?volume:float,source(audio='#a+1,video='#b,midi='#c+1))->
  7978. source(audio='#a+1,video='#b,midi='#c+1)
  7979. + id
  7980. Force the value of the source ID.
  7981. + default
  7982. ""
  7983. + type
  7984. string
  7985. + attack
  7986. Envelope attack (in seconds).
  7987. + default
  7988. 0.02
  7989. + type
  7990. float
  7991. + channel
  7992. MIDI channel to handle.
  7993. + default
  7994. 0
  7995. + type
  7996. int
  7997. + decay
  7998. Envelope decay (in seconds).
  7999. + default
  8000. 0.01
  8001. + type
  8002. float
  8003. + envelope
  8004. Use envelope.
  8005. + default
  8006. true
  8007. + type
  8008. bool
  8009. + release
  8010. Envelope release (in seconds).
  8011. + default
  8012. 0.05
  8013. + type
  8014. float
  8015. + sustain
  8016. Envelope sustain level.
  8017. + default
  8018. 0.9
  8019. + type
  8020. float
  8021. + volume
  8022. Initial volume.
  8023. + default
  8024. 0.3
  8025. + type
  8026. float
  8027. + (unlabeled)
  8028. (no doc)
  8029. + default
  8030. None
  8031. + type
  8032. source(audio='#a+1,video='#b,midi='#c+1)
  8033. + synth.sine
  8034. Sine synthesizer.
  8035. + _category
  8036. Source / Sound Synthesis
  8037. + _type
  8038. (?id:string,?attack:float,?channel:int,?decay:float,
  8039. ?envelope:bool,?release:float,?sustain:float,
  8040. ?volume:float,source(audio='#a+1,video='#b,midi='#c+1))->
  8041. source(audio='#a+1,video='#b,midi='#c+1)
  8042. + id
  8043. Force the value of the source ID.
  8044. + default
  8045. ""
  8046. + type
  8047. string
  8048. + attack
  8049. Envelope attack (in seconds).
  8050. + default
  8051. 0.02
  8052. + type
  8053. float
  8054. + channel
  8055. MIDI channel to handle.
  8056. + default
  8057. 0
  8058. + type
  8059. int
  8060. + decay
  8061. Envelope decay (in seconds).
  8062. + default
  8063. 0.01
  8064. + type
  8065. float
  8066. + envelope
  8067. Use envelope.
  8068. + default
  8069. true
  8070. + type
  8071. bool
  8072. + release
  8073. Envelope release (in seconds).
  8074. + default
  8075. 0.05
  8076. + type
  8077. float
  8078. + sustain
  8079. Envelope sustain level.
  8080. + default
  8081. 0.9
  8082. + type
  8083. float
  8084. + volume
  8085. Initial volume.
  8086. + default
  8087. 0.3
  8088. + type
  8089. float
  8090. + (unlabeled)
  8091. (no doc)
  8092. + default
  8093. None
  8094. + type
  8095. source(audio='#a+1,video='#b,midi='#c+1)
  8096. + synth.square
  8097. Square synthesizer.
  8098. + _category
  8099. Source / Sound Synthesis
  8100. + _type
  8101. (?id:string,?attack:float,?channel:int,?decay:float,
  8102. ?envelope:bool,?release:float,?sustain:float,
  8103. ?volume:float,source(audio='#a+1,video='#b,midi='#c+1))->
  8104. source(audio='#a+1,video='#b,midi='#c+1)
  8105. + id
  8106. Force the value of the source ID.
  8107. + default
  8108. ""
  8109. + type
  8110. string
  8111. + attack
  8112. Envelope attack (in seconds).
  8113. + default
  8114. 0.02
  8115. + type
  8116. float
  8117. + channel
  8118. MIDI channel to handle.
  8119. + default
  8120. 0
  8121. + type
  8122. int
  8123. + decay
  8124. Envelope decay (in seconds).
  8125. + default
  8126. 0.01
  8127. + type
  8128. float
  8129. + envelope
  8130. Use envelope.
  8131. + default
  8132. true
  8133. + type
  8134. bool
  8135. + release
  8136. Envelope release (in seconds).
  8137. + default
  8138. 0.05
  8139. + type
  8140. float
  8141. + sustain
  8142. Envelope sustain level.
  8143. + default
  8144. 0.9
  8145. + type
  8146. float
  8147. + volume
  8148. Initial volume.
  8149. + default
  8150. 0.3
  8151. + type
  8152. float
  8153. + (unlabeled)
  8154. (no doc)
  8155. + default
  8156. None
  8157. + type
  8158. source(audio='#a+1,video='#b,midi='#c+1)
  8159. + system
  8160. Shell command call. Set verbose to true to log process' output and errors.
  8161. + _category
  8162. System
  8163. + _type
  8164. (string)->unit
  8165. + (unlabeled)
  8166. (no doc)
  8167. + default
  8168. None
  8169. + type
  8170. string
  8171. + test_process
  8172. Return true if process exited with 0 code. Command should return quickly.
  8173. + _category
  8174. System
  8175. + (unlabeled)
  8176. Command to test
  8177. + default
  8178. None
  8179. + type
  8180. string
  8181. + _type
  8182. (string)->bool
  8183. + time_in_mod
  8184. INTERNAL: time_in_mod(a,b,c) checks that the unix time T satisfies a <= T mod c < b
  8185. + _category
  8186. Other
  8187. + _type
  8188. (int,int,int)->bool
  8189. + _flag
  8190. hidden
  8191. + (unlabeled)
  8192. (no doc)
  8193. + default
  8194. None
  8195. + type
  8196. int
  8197. + (unlabeled)
  8198. (no doc)
  8199. + default
  8200. None
  8201. + type
  8202. int
  8203. + (unlabeled)
  8204. (no doc)
  8205. + default
  8206. None
  8207. + type
  8208. int
  8209. + unsafe.single.infallible
  8210. Loops on a request, which has to be ready and should be persistent. WARNING: if used uncarefully, it can crash your application!
  8211. + _category
  8212. Source / Input
  8213. + _type
  8214. (?id:string,request('a))->source('a)
  8215. + _flag
  8216. hidden
  8217. + id
  8218. Force the value of the source ID.
  8219. + default
  8220. ""
  8221. + type
  8222. string
  8223. + (unlabeled)
  8224. (no doc)
  8225. + default
  8226. None
  8227. + type
  8228. request('a)
  8229. + url.decode
  8230. Decode an encoded url (e.g. "%20" becomes " ").
  8231. + _category
  8232. String
  8233. + _type
  8234. (?plus:bool,string)->string
  8235. + plus
  8236. (no doc)
  8237. + default
  8238. true
  8239. + type
  8240. bool
  8241. + (unlabeled)
  8242. (no doc)
  8243. + default
  8244. None
  8245. + type
  8246. string
  8247. + url.encode
  8248. Encode an url (e.g. " " becomes "%20").
  8249. + _category
  8250. String
  8251. + _type
  8252. (?plus:bool,string)->string
  8253. + plus
  8254. (no doc)
  8255. + default
  8256. true
  8257. + type
  8258. bool
  8259. + (unlabeled)
  8260. (no doc)
  8261. + default
  8262. None
  8263. + type
  8264. string
  8265. + url.split
  8266. Split an url of the form foo?arg=bar&arg2=bar2 into ("foo",[("arg","bar"),("arg2","bar2")]).
  8267. + _category
  8268. String
  8269. + (unlabeled)
  8270. Url to split
  8271. + default
  8272. None
  8273. + type
  8274. string
  8275. + _type
  8276. (string)->(string*[(string*string)])
  8277. + video.add_image
  8278. Add a static image on the first video channel.
  8279. + _category
  8280. Source / Video Processing
  8281. + id
  8282. Force the value of the source ID.
  8283. + default
  8284. ""
  8285. + type
  8286. string
  8287. + width
  8288. Scale to width (zero means frame width, negative means original width).
  8289. + default
  8290. 0
  8291. + type
  8292. int
  8293. + height
  8294. Scale to height (zero means frame height, negative means original height).
  8295. + default
  8296. 0
  8297. + type
  8298. int
  8299. + x
  8300. x position.
  8301. + default
  8302. 1073741823
  8303. + type
  8304. int
  8305. + y
  8306. y position.
  8307. + default
  8308. 1073741823
  8309. + type
  8310. int
  8311. + file
  8312. Path to the image file.
  8313. + default
  8314. None
  8315. + type
  8316. 'a
  8317. + (unlabeled)
  8318. (no doc)
  8319. + default
  8320. None
  8321. + type
  8322. source(audio='#b,video='#c,midi=0)
  8323. + _type
  8324. (?id:string,?width:int,?height:int,?x:int,?y:int,file:'a,
  8325. source(audio='#b,video='#c,midi=0))->
  8326. source(audio='#b,video='#c,midi=0)
  8327. + video.fade.final
  8328. Fade a stream to black.
  8329. + _category
  8330. Source / Video Processing
  8331. + _type
  8332. (?id:string,?duration:float,?transition:string,
  8333. ?type:string,source(audio='#a,video='#b+1,midi='#c))->
  8334. source(audio='#a,video='#b+1,midi='#c)
  8335. + id
  8336. Force the value of the source ID.
  8337. + default
  8338. ""
  8339. + type
  8340. string
  8341. + duration
  8342. Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
  8343. + default
  8344. 3.
  8345. + type
  8346. float
  8347. + transition
  8348. Kind of transition (fade|slide_left|slide_right|slide_up|slide_down|grow|disc|random).
  8349. + default
  8350. "fade"
  8351. + type
  8352. string
  8353. + type
  8354. Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
  8355. + default
  8356. "lin"
  8357. + type
  8358. string
  8359. + (unlabeled)
  8360. (no doc)
  8361. + default
  8362. None
  8363. + type
  8364. source(audio='#a,video='#b+1,midi='#c)
  8365. + video.fade.in
  8366. Fade the beginning of tracks. Metadata 'liq_video_fade_in' can be used to set the duration for a specific track (float in seconds).
  8367. + _category
  8368. Source / Video Processing
  8369. + _type
  8370. (?id:string,?duration:float,?override:string,
  8371. ?transition:string,?type:string,
  8372. source(audio='#a,video='#b+1,midi='#c))->
  8373. source(audio='#a,video='#b+1,midi='#c)
  8374. + id
  8375. Force the value of the source ID.
  8376. + default
  8377. ""
  8378. + type
  8379. string
  8380. + duration
  8381. Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
  8382. + default
  8383. 3.
  8384. + type
  8385. float
  8386. + override
  8387. Metadata field which, if present and containing a float, overrides the 'duration' parameter for current track.
  8388. + default
  8389. "liq_video_fade_in"
  8390. + type
  8391. string
  8392. + transition
  8393. Kind of transition (fade|slide_left|slide_right|slide_up|slide_down|grow|disc|random).
  8394. + default
  8395. "fade"
  8396. + type
  8397. string
  8398. + type
  8399. Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
  8400. + default
  8401. "lin"
  8402. + type
  8403. string
  8404. + (unlabeled)
  8405. (no doc)
  8406. + default
  8407. None
  8408. + type
  8409. source(audio='#a,video='#b+1,midi='#c)
  8410. + video.fade.initial
  8411. Fade the beginning of a stream.
  8412. + _category
  8413. Source / Video Processing
  8414. + _type
  8415. (?id:string,?duration:float,?transition:string,
  8416. ?type:string,source(audio='#a,video='#b+1,midi='#c))->
  8417. source(audio='#a,video='#b+1,midi='#c)
  8418. + id
  8419. Force the value of the source ID.
  8420. + default
  8421. ""
  8422. + type
  8423. string
  8424. + duration
  8425. Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
  8426. + default
  8427. 3.
  8428. + type
  8429. float
  8430. + transition
  8431. Kind of transition (fade|slide_left|slide_right|slide_up|slide_down|grow|disc|random).
  8432. + default
  8433. "fade"
  8434. + type
  8435. string
  8436. + type
  8437. Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
  8438. + default
  8439. "lin"
  8440. + type
  8441. string
  8442. + (unlabeled)
  8443. (no doc)
  8444. + default
  8445. None
  8446. + type
  8447. source(audio='#a,video='#b+1,midi='#c)
  8448. + video.fade.out
  8449. Fade the end of tracks. Metadata 'liq_video_fade_out' can be used to set the duration for a specific track (float in seconds).
  8450. + _category
  8451. Source / Video Processing
  8452. + _type
  8453. (?id:string,?duration:float,?override:string,
  8454. ?transition:string,?type:string,
  8455. source(audio='#a,video='#b+1,midi='#c))->
  8456. source(audio='#a,video='#b+1,midi='#c)
  8457. + id
  8458. Force the value of the source ID.
  8459. + default
  8460. ""
  8461. + type
  8462. string
  8463. + duration
  8464. Duration of the fading. This value can be set on a per-file basis using the metadata field passed as override.
  8465. + default
  8466. 3.
  8467. + type
  8468. float
  8469. + override
  8470. Metadata field which, if present and containing a float, overrides the 'duration' parameter for current track.
  8471. + default
  8472. "liq_video_fade_out"
  8473. + type
  8474. string
  8475. + transition
  8476. Kind of transition (fade|slide_left|slide_right|slide_up|slide_down|grow|disc|random).
  8477. + default
  8478. "fade"
  8479. + type
  8480. string
  8481. + type
  8482. Fader shape (lin|sin|log|exp): linear, sinusoidal, logarithmic or exponential.
  8483. + default
  8484. "lin"
  8485. + type
  8486. string
  8487. + (unlabeled)
  8488. (no doc)
  8489. + default
  8490. None
  8491. + type
  8492. source(audio='#a,video='#b+1,midi='#c)
  8493. + video.fill
  8494. Fill frame with a color.
  8495. + _category
  8496. Source / Video Processing
  8497. + _type
  8498. (?id:string,?color:int,
  8499. source(audio='#a,video='#b+1,midi='#c))->
  8500. source(audio='#a,video='#b+1,midi='#c)
  8501. + id
  8502. Force the value of the source ID.
  8503. + default
  8504. ""
  8505. + type
  8506. string
  8507. + color
  8508. Color to fill the image with.
  8509. + default
  8510. 0
  8511. + type
  8512. int
  8513. + (unlabeled)
  8514. (no doc)
  8515. + default
  8516. None
  8517. + type
  8518. source(audio='#a,video='#b+1,midi='#c)
  8519. + video.greyscale
  8520. Convert video to greyscale.
  8521. + _category
  8522. Source / Video Processing
  8523. + _type
  8524. (?id:string,source(audio='#a,video='#b+1,midi='#c))->
  8525. source(audio='#a,video='#b+1,midi='#c)
  8526. + id
  8527. Force the value of the source ID.
  8528. + default
  8529. ""
  8530. + type
  8531. string
  8532. + (unlabeled)
  8533. (no doc)
  8534. + default
  8535. None
  8536. + type
  8537. source(audio='#a,video='#b+1,midi='#c)
  8538. + video.invert
  8539. Invert video.
  8540. + _category
  8541. Source / Video Processing
  8542. + _type
  8543. (?id:string,source(audio='#a,video='#b+1,midi='#c))->
  8544. source(audio='#a,video='#b+1,midi='#c)
  8545. + id
  8546. Force the value of the source ID.
  8547. + default
  8548. ""
  8549. + type
  8550. string
  8551. + (unlabeled)
  8552. (no doc)
  8553. + default
  8554. None
  8555. + type
  8556. source(audio='#a,video='#b+1,midi='#c)
  8557. + video.lomo
  8558. Emulate the "Lomo effect".
  8559. + _category
  8560. Source / Video Processing
  8561. + _type
  8562. (?id:string,source(audio='#a,video='#b+1,midi='#c))->
  8563. source(audio='#a,video='#b+1,midi='#c)
  8564. + id
  8565. Force the value of the source ID.
  8566. + default
  8567. ""
  8568. + type
  8569. string
  8570. + (unlabeled)
  8571. (no doc)
  8572. + default
  8573. None
  8574. + type
  8575. source(audio='#a,video='#b+1,midi='#c)
  8576. + video.opacity
  8577. Scale opacity of video.
  8578. + _category
  8579. Source / Video Processing
  8580. + _type
  8581. (?id:string,float,source(audio='#a,video='#b+1,midi='#c))->
  8582. source(audio='#a,video='#b+1,midi='#c)
  8583. + id
  8584. Force the value of the source ID.
  8585. + default
  8586. ""
  8587. + type
  8588. string
  8589. + (unlabeled)
  8590. Coefficient to scale opacity with.
  8591. + default
  8592. None
  8593. + type
  8594. float
  8595. + (unlabeled)
  8596. (no doc)
  8597. + default
  8598. None
  8599. + type
  8600. source(audio='#a,video='#b+1,midi='#c)
  8601. + video.opacity.blur
  8602. Blur opacity of video.
  8603. + _category
  8604. Source / Video Processing
  8605. + _type
  8606. (?id:string,source(audio='#a,video='#b+1,midi='#c))->
  8607. source(audio='#a,video='#b+1,midi='#c)
  8608. + id
  8609. Force the value of the source ID.
  8610. + default
  8611. ""
  8612. + type
  8613. string
  8614. + (unlabeled)
  8615. (no doc)
  8616. + default
  8617. None
  8618. + type
  8619. source(audio='#a,video='#b+1,midi='#c)
  8620. + video.rotate
  8621. Rotate video.
  8622. + _category
  8623. Source / Video Processing
  8624. + _type
  8625. (?id:string,?angle:'a,?speed:'b,
  8626. source(audio='#c,video='#d+1,midi='#e))->
  8627. source(audio='#c,video='#d+1,midi='#e)
  8628. where 'a, 'b is either float or ()->float
  8629. + id
  8630. Force the value of the source ID.
  8631. + default
  8632. ""
  8633. + type
  8634. string
  8635. + angle
  8636. Initial angle in radians.
  8637. + default
  8638. 0.
  8639. + type
  8640. anything that is either float or ()->float
  8641. + speed
  8642. Rotation speed in radians per sec.
  8643. + default
  8644. 3.1416
  8645. + type
  8646. anything that is either float or ()->float
  8647. + (unlabeled)
  8648. (no doc)
  8649. + default
  8650. None
  8651. + type
  8652. source(audio='#c,video='#d+1,midi='#e)
  8653. + video.scale
  8654. Scale and translate video.
  8655. + _category
  8656. Source / Video Processing
  8657. + _type
  8658. (?id:string,?scale:float,?x:int,?xscale:float,?y:int,
  8659. ?yscale:float,source(audio='#a,video='#b+1,midi='#c))->
  8660. source(audio='#a,video='#b+1,midi='#c)
  8661. + id
  8662. Force the value of the source ID.
  8663. + default
  8664. ""
  8665. + type
  8666. string
  8667. + scale
  8668. Scaling coefficient in both directions.
  8669. + default
  8670. 1.
  8671. + type
  8672. float
  8673. + x
  8674. x offset.
  8675. + default
  8676. 0
  8677. + type
  8678. int
  8679. + xscale
  8680. x scaling.
  8681. + default
  8682. 1.
  8683. + type
  8684. float
  8685. + y
  8686. y offset.
  8687. + default
  8688. 0
  8689. + type
  8690. int
  8691. + yscale
  8692. y scaling.
  8693. + default
  8694. 1.
  8695. + type
  8696. float
  8697. + (unlabeled)
  8698. (no doc)
  8699. + default
  8700. None
  8701. + type
  8702. source(audio='#a,video='#b+1,midi='#c)
  8703. + video.sepia
  8704. Convert video to sepia.
  8705. + _category
  8706. Source / Video Processing
  8707. + _type
  8708. (?id:string,source(audio='#a,video='#b+1,midi='#c))->
  8709. source(audio='#a,video='#b+1,midi='#c)
  8710. + id
  8711. Force the value of the source ID.
  8712. + default
  8713. ""
  8714. + type
  8715. string
  8716. + (unlabeled)
  8717. (no doc)
  8718. + default
  8719. None
  8720. + type
  8721. source(audio='#a,video='#b+1,midi='#c)
  8722. + video.tile
  8723. Tile sources (same as add but produces tiles of videos).
  8724. + _category
  8725. Source / Video Processing
  8726. + _type
  8727. (?id:string,?normalize:bool,?proportional:bool,
  8728. ?weights:[int],[source(audio='#a,video='#b+1,midi='#c)])->
  8729. source(audio='#a,video='#b+1,midi='#c)
  8730. + id
  8731. Force the value of the source ID.
  8732. + default
  8733. ""
  8734. + type
  8735. string
  8736. + normalize
  8737. (no doc)
  8738. + default
  8739. true
  8740. + type
  8741. bool
  8742. + proportional
  8743. Scale preserving the proportions.
  8744. + default
  8745. true
  8746. + type
  8747. bool
  8748. + weights
  8749. Relative weight of the sources in the sum. The empty list stands for the homogeneous distribution.
  8750. + default
  8751. []
  8752. + type
  8753. [int]
  8754. + (unlabeled)
  8755. (no doc)
  8756. + default
  8757. None
  8758. + type
  8759. [source(audio='#a,video='#b+1,midi='#c)]
  8760. + video.transparent
  8761. Set a color to be transparent.
  8762. + _category
  8763. Source / Video Processing
  8764. + _type
  8765. (?id:string,?color:int,?precision:float,
  8766. source(audio='#a,video='#b+1,midi='#c))->
  8767. source(audio='#a,video='#b+1,midi='#c)
  8768. + id
  8769. Force the value of the source ID.
  8770. + default
  8771. ""
  8772. + type
  8773. string
  8774. + color
  8775. Color which should be transparent (in 0xRRGGBB format).
  8776. + default
  8777. 0
  8778. + type
  8779. int
  8780. + precision
  8781. Precision in color matching (0. means match precisely the color and 1. means match every color).
  8782. + default
  8783. 0.
  8784. + type
  8785. float
  8786. + (unlabeled)
  8787. (no doc)
  8788. + default
  8789. None
  8790. + type
  8791. source(audio='#a,video='#b+1,midi='#c)
  8792. + video.volume
  8793. Graphical visualization of the sound.
  8794. + _category
  8795. Source / Visualization
  8796. + _type
  8797. (?id:string,source(audio='#a+1,video=0,midi=0))->
  8798. source(audio='#a+1,video=1,midi=0)
  8799. + id
  8800. Force the value of the source ID.
  8801. + default
  8802. ""
  8803. + type
  8804. string
  8805. + (unlabeled)
  8806. (no doc)
  8807. + default
  8808. None
  8809. + type
  8810. source(audio='#a+1,video=0,midi=0)
  8811. + vumeter
  8812. VU meter (display the audio volume).
  8813. + _category
  8814. Source / Visualization
  8815. + _type
  8816. (?id:string,?scroll:bool,
  8817. source(audio='#a+1,video='#b,midi='#c))->
  8818. source(audio='#a+1,video='#b,midi='#c)
  8819. + id
  8820. Force the value of the source ID.
  8821. + default
  8822. ""
  8823. + type
  8824. string
  8825. + scroll
  8826. Scroll.
  8827. + default
  8828. false
  8829. + type
  8830. bool
  8831. + (unlabeled)
  8832. (no doc)
  8833. + default
  8834. None
  8835. + type
  8836. source(audio='#a+1,video='#b,midi='#c)
  8837. + ~-
  8838. Returns the opposite of its argument.
  8839. + _category
  8840. Math
  8841. + _type
  8842. ('a)->'a where 'a is a number type
  8843. + (unlabeled)
  8844. (no doc)
  8845. + default
  8846. None
  8847. + type
  8848. anything that is a number type
  8849. + stream decoding
  8850. Stream decoding methods.
  8851. + FLAC
  8852. Use libflac to decode any stream with an appropriate MIME type.
  8853. + MAD
  8854. Use libmad to decode any stream with an appropriate MIME type.
  8855. + OGG
  8856. Decode as OGG any stream with an appropriate MIME type.
  8857. + PCM/BASIC
  8858. Decode audio/basic as headerless stereo U8 PCM at 8kHz.
  8859. + WAV
  8860. Decode a WAV stream with an appropriate MIME type.
  8861. + stream encoding formats
  8862. Methods to encode streams.
  8863. + EXTERNAL
  8864. (no doc)
  8865. + FLAC
  8866. (no doc)
  8867. + MP3/LIBLAME/BUILTIN
  8868. (no doc)
  8869. + OGG
  8870. (no doc)
  8871. + WAV
  8872. (no doc)
  8873. + video converters
  8874. Methods for converting video frames.
  8875. + native
  8876. (no doc)
RAW Paste Data