Guest User

Untitled

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