blingbling.volume.html 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  3. <html>
  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
  5. <head>
  6. <title>Reference</title>
  7. <link rel="stylesheet" href="../ldoc.css" type="text/css" />
  8. </head>
  9. <body>
  10. <div id="container">
  11. <div id="product">
  12. <div id="product_logo"></div>
  13. <div id="product_name"><big><b></b></big></div>
  14. <div id="product_description"></div>
  15. </div> <!-- id="product" -->
  16. <div id="main">
  17. <!-- Menu -->
  18. <div id="navigation">
  19. <br/>
  20. <h1>ldoc</h1>
  21. <ul>
  22. <li><a href="../index.html">Index</a></li>
  23. </ul>
  24. <h2>Contents</h2>
  25. <ul>
  26. <li><a href="#Functions">Functions</a></li>
  27. </ul>
  28. <h2>Modules</h2>
  29. <ul class="$(kind=='Topics' and '' or 'nowrap'">
  30. <li><a href="../modules/blingbling.calendar.html">blingbling.calendar</a></li>
  31. <li><a href="../modules/blingbling.clock.html">blingbling.clock</a></li>
  32. <li><a href="../modules/blingbling.helpers.html">blingbling.helpers</a></li>
  33. <li><a href="../modules/blingbling.linegraph.html">blingbling.linegraph</a></li>
  34. <li><a href="../modules/blingbling.widget.html">blingbling.widget</a></li>
  35. <li><a href="../modules/blingbling.popups.html">blingbling.popups</a></li>
  36. <li><a href="../modules/blingbling.progress_graph.html">blingbling.progress_graph</a></li>
  37. <li><a href="../modules/blingbling.system.html">blingbling.system</a></li>
  38. <li><a href="../modules/blingbling.tagslist.html">blingbling.tagslist</a></li>
  39. <li><a href="../modules/blingbling.task_warrior.html">blingbling.task_warrior</a></li>
  40. <li><a href="../modules/blingbling.text_box.html">blingbling.text_box</a></li>
  41. <li><a href="../modules/blingbling.transient.html">blingbling.transient</a></li>
  42. <li><a href="../modules/blingbling.triangular_progress_graph.html">blingbling.triangular_progress_graph</a></li>
  43. <li><a href="../modules/blingbling.udisks_glue.html">blingbling.udisks_glue</a></li>
  44. <li><a href="../modules/blingbling.value_text_box.html">blingbling.value_text_box</a></li>
  45. <li><strong>blingbling.volume</strong></li>
  46. <li><a href="../modules/blingbling.wlourf_circle_graph.html">blingbling.wlourf_circle_graph</a></li>
  47. </ul>
  48. </div>
  49. <div id="content">
  50. <h1>Module <code>blingbling.volume</code></h1>
  51. <p>Volume widget</p>
  52. <p></p>
  53. <h2><a href="#Functions">Functions</a></h2>
  54. <table class="function_list">
  55. <tr>
  56. <td class="name" nowrap><a href="#set_master_control">set_master_control (volume_graph)</a></td>
  57. <td class="summary">Link the widget to the master channel of your system (uses amixer).</td>
  58. </tr>
  59. <tr>
  60. <td class="name" nowrap><a href="#new">new (args)</a></td>
  61. <td class="summary">Create a volume_graph widget.</td>
  62. </tr>
  63. </table>
  64. <br/>
  65. <br/>
  66. <h2><a name="Functions"></a>Functions</h2>
  67. <dl class="function">
  68. <dt>
  69. <a name = "set_master_control"></a>
  70. <strong>set_master_control (volume_graph)</strong>
  71. </dt>
  72. <dd>
  73. Link the widget to the master channel of your system (uses amixer).
  74. a left clic toggle mute/unmute, wheel up to increase the volume and wheel down to decrease the volume
  75. <h3>Parameters:</h3>
  76. <ul>
  77. <li><span class="parameter">volume_graph</span>
  78. </li>
  79. </ul>
  80. <h3>Usage:</h3>
  81. <ul>
  82. <pre class="example">myvolume:set_master_control()</pre>
  83. </ul>
  84. </dd>
  85. <dt>
  86. <a name = "new"></a>
  87. <strong>new (args)</strong>
  88. </dt>
  89. <dd>
  90. Create a volume_graph widget.
  91. <h3>Parameters:</h3>
  92. <ul>
  93. <li><span class="parameter">args</span>
  94. Standard widget() arguments. This is a table that accepts
  95. different keys:
  96. <p> <code>{ cmd = "amixer -c 1", label = "$percent%", graph_color = "#005500" }</code>
  97. <p> The default cmd is "amixer" which should be good enough if you only have one audio output.
  98. You can provide another command based on your need. For example, the "amixer -c 1" command
  99. has been given by k3rni contributor and allow to select the audio card. (see
  100. https://github.com/cedlemo/blingbling/pull/30 for more information.
  101. <p> The other keys are those related to the graph itself and are the same that those
  102. used with the triangular_progress_graph
  103. </li>
  104. </ul>
  105. <h3>Returns:</h3>
  106. <ol>
  107. A graph widget.
  108. </ol>
  109. </dd>
  110. </dl>
  111. </div> <!-- id="content" -->
  112. </div> <!-- id="main" -->
  113. <div id="about">
  114. <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.3</a></i>
  115. <i style="float:right;">Last updated 2015-08-04 10:16:50 </i>
  116. </div> <!-- id="about" -->
  117. </div> <!-- id="container" -->
  118. </body>
  119. </html>