5ila5 / qtile-playerctl-widget

A Widget for Qtile to controll playerctl player

Playerctl

class libqtile.widget.Playerctl(*args, **kwargs)

Supported bar orientations: horizontal only

Configuration options

key	default	description
app_player_icons	{'spotifyd': 'spotify'}	Replaces Icon of first_app with the second Default: replaces Spotifyd(not found) icon with spotify Icon (if installed)
background	None	Widget background color
bottom_margin	3	Distance between bottom of the Bar Icon
controll_multiple	True	shows Icon with the currently selected player if False Controlls always all Player at once
default_icon	'~/Pictures/not_found.png'	Default icon if no icon for the given Application found
distance	10	distance Betwen Icons distance multiplier*icon_width Play/Pause
fmt	'{}'	To format the string returned by the widget. For example, if the clock widget returns '08:46' we can do fmt='time {}' do print 'time 08:46' on the widget. To format the individual strings like hour and minutes use the format paramater of the widget (if it has one)
font	'sans'	Default font
fontshadow	None	font shadow color, default is None(no shadow)
fontsize	None	Font size. Calculated if None.
foreground	'ffffff'	Foreground colour
icon_color	'FFFFFF'	Color of Play Pause Next... Icons
icon_order	(1, 2, 3)	Order of Icons (1,2,3) represents prev -> Pl/pause -> next
icon_width	(20, 30)	Width of Play/Pause(1) and Next/Pref(2) Buttons
list	[]	White Blacklist dependent on list_type. playerctl player name "all" Black/Whitelists the general Controll
list_type	0	0 all Applications, 1 Blacklist,2 Whitelist
markup	True	Whether or not to use pango markup
max_chars	0	Maximum number of characters to display in widget.
mouse_callbacks	{}	Dict of mouse button press callback functions. Accepts functions and lazy calls.
padding	None	Padding. Calculated if None.
player_icons	{}	path to icons format {"player_name": "source to icon"}
scroll	False	Whether text should be scrolled. When True, you must set the widget's width.
scroll_clear	False	Whether text should scroll completely away (True) or stop when the end of the text is shown (False)
scroll_delay	2	Number of seconds to pause before starting scrolling and restarting/clearing text at end
scroll_hide	False	Whether the widget should hide when scrolling has finished
scroll_interval	0.1	Time in seconds before next scrolling step
scroll_repeat	True	Whether text should restart scrolling once the text has ended
scroll_step	1	Number of pixels to scroll with each step
showVolume	True	show Playervolume like the Volume Widget
show_next	True	Show next Track button
show_prev	True	Show previous Track button
top_margin	3	Distance between top of the Bar Icon
update_interval	0.5	Update time in seconds.