Updated alsa (markdown)

[etc/awesome.git] / alsa.md

diff --git a/alsa.md b/alsa.md
index f978bce54e6dd86c7c977ff8afd7d64f149fc986..daf4016fafe0bf1504d08e5395972a4152d19484 100644 (file)
--- a/alsa.md
+++ b/alsa.md
@@ -1,52 +1,53 @@
-Shows and controls alsa volume.
+[<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
 
-       myvolume = lain.widgets.alsa()
+Shows and controls alsa volume with a textbox.
 
-* Left click: Launch `alsamixer` in your `terminal`.
-* Right click: Mute/unmute.
-* Scroll wheel: Increase/decrase volume.
+       volumewidget = lain.widgets.alsa()
 
-The function takes a table as optional argument, which can contain:
+### input table
 
 Variable | Meaning | Type | Default
 --- | --- | --- | ---
+`timeout` | Refresh timeout seconds | int | 5
 `channel` | Mixer channel | string | "Master" 
-`step` | Step at which volume is increased/decreased | string | "1%"
-`header` | Text to show before value | string | " Vol "
-`header_color` | Header color | string | `beautiful.fg_normal` or "#FFFFFF"
-`color` | Value color | string | `beautiful.fg_focus` or "#FFFFFF"
+`settings` | User settings | function | empty function
 
-and outputs the following table:
+`settings` can use the following variables:
+
+Variable | Meaning | Type | Values
+--- | --- | --- | ---
+`volume_now.level` | Self explained | int | 0-100
+`volume_now.status` | Device status | string | "on", "off"
+
+### output table
 
 Variable | Meaning | Type
 --- | --- | --- 
 `widget` | The widget | `wibox.widget.textbox`
-`channel` | Alsa channel | string
-`step` | Increase/decrease step | string
-`notify` | Update `widget` | function
+`update` | Update `widget` | function
 
-Finally, you can control the widget with key bindings like these:
+You can control the widget with key bindings like these:
 
     -- Volume control
     awful.key({ altkey }, "Up",
     function ()
-        awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "+")
-        volume.notify()
+        awful.util.spawn("amixer set Master 1%+")
+        volumewidget.update()
     end),
     awful.key({ altkey }, "Down",
     function ()
-        awful.util.spawn("amixer sset " .. volume.channel .. " " .. volume.step .. "-")
-        volume.notify()
+        awful.util.spawn("amixer set Master 1%-")
+        volumewidget.update()
     end),
     awful.key({ altkey }, "m",
     function ()
         awful.util.spawn("amixer set Master playback toggle")
-        volume.notify()
+        volumewidget.update()
     end),
     awful.key({ altkey, "Control" }, "m", 
     function ()
         awful.util.spawn("amixer set Master playback 100%", false )
-        volume.notify()
+        volumewidget.update()
     end),
 
 where `altkey = "Mod1"`.
\ No newline at end of file