Ruby wrapper for xosd - X on screen display library

The gem was designed for libxosd version 2.2.14 but likely to work with other versions too.

Instantiate an instance of XOSD:

require 'xosd'

xosd = XOSD.new

You may pass zero or more of the options to the constructor:

All of the options have the corresponding setter, e.g. you can either:

xosd = XOSD.new(timeout: 5)

or

xosd = XOSD.new
xosd.timeout = 5

Example:

xosd = XOSD.new(
    position: :bottom,
    align: :center,
    vertical_offset: 100,
    font: '-*-arial-*-*-*-*-*-320-*-*-*-*-*-*',
    colour: 'black',
    outline_colour: 'orange',
    outline_offset: 1,
    shadow_colour: 'white',
    shadow_offset: 1,
    timeout: 3
)
xosd.display 'A line to display on screen'
xosd.teardown

When done with displaying on screen messages, make sure to teardown the object by calling the teardown method:

xosd.teardown

If you don't do it, it will try to tear itself down during garbage collection, but you should not depend on it.

To display a string use display method:

xosd.display 'A message to display on screen'

You may use several lines:

xosd = XOSD.new(lines: 3)
xosd.display 'First line to display', line: 0
xosd.display 'Second line to display', line: 1
xosd.display 'Third line to display', line: 2
xosd.teardown

You may use #scroll_by to scroll the messages:

xosd.scroll_by 1

To display a bar similar to TV volume bar:

xosd = XOSD.new(bar_length: 100)
xosd.bar_length = 100 # same effect as above
xosd.display_bar 50

Use :bar_length constructor option or set bar_length later to define how long the bar will be.

To display a slider similar to TV brightness control:

xosd.display_slider 50

Adjust slider length similar to how it is done for the percentage bar.

Call on_screen? method to find out if anything is being displayed on screen.

xosd.on_screen?

You may wait for the message to disappear using xosd_wait_until_no_display:

xosd.xosd_wait_until_no_display

You may hide and show the last displayed message

xosd.dispaly 'A message'
xosd.hide
xosd.show

If you are interested in making changes to the gem, you may want to setup a virtual machine to assist with that.

• Install Virtual Box from https://www.virtualbox.org/

• Install Vagrant from https://www.vagrantup.com/

• Provision the virtual machine (it will be named xosd):

  $ vagrant up

• Add ssh info of the virtual machine to the ssh config:

  $ vagrant ssh-config >> ~/.ssh/config

• To open an ssh session with the virtual machine (the gem folder will be mounted under /vagrant):

  $ ssh -X xosd