wallpaper

package module

v0.0.0-...-fbd022e Latest Latest Go to latest Published: May 8, 2021 License: Unlicense Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ltpquang/wallpaper

Links

Open Source Insights

README ¶

wallpaper

A cross-platform (Linux, Windows, and macOS) Golang library for getting and setting the desktop background.

Installation

go get github.com/reujab/wallpaper

Example

package main

import (
	"fmt"

	"github.com/reujab/wallpaper"
)

func main() {
	background, err := wallpaper.Get()

	if err != nil {
		panic(err)
	}

	fmt.Println("Current wallpaper:", background)
	wallpaper.SetFromFile("/usr/share/backgrounds/gnome/adwaita-day.jpg")
	wallpaper.SetFromURL("https://i.imgur.com/pIwrYeM.jpg")
}

Notes

Enlightenment is not supported.

Documentation ¶

Rendered for

Constants ¶

This section is empty.

Variables ¶

View Source

var Desktop = os.Getenv("XDG_CURRENT_DESKTOP")

Desktop contains the current desktop environment on Linux. Empty string on all other operating systems.

View Source

var DesktopSession = os.Getenv("DESKTOP_SESSION")

View Source

var ErrUnsupportedDE = errors.New("your desktop environment is not supported")

ErrUnsupportedDE is thrown when Desktop is not a supported desktop environment.

Functions ¶

func Get ¶

func Get() (string, error)

Get returns the current wallpaper.

func SetFromFile ¶

func SetFromFile(file string) error

SetFromFile sets wallpaper from a file path.

func SetFromURL ¶

func SetFromURL(url string) error

SetFromURL sets wallpaper from a URL.

In GNOME, it sets org.gnome.desktop.background.picture-uri to the URL. In other desktops, it downloads the image and calls SetFromFile.

Types ¶

This section is empty.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
example

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL