core

Documentation

Index

• Constants
• func FromMock(t testing.TB) bool
• func GetWallpaper() (string, error)
• func MockServers(t testing.TB)
• func Run(execute func(*Config) *Image, cfg *Config)
• func SetWallpaper(path string, mode Mode) error
• func WithFuriganaApiAppId(appId string) crawlerConfigOption
• func WithGoogleAppCredentials(credentials string) crawlerConfigOption
• func WithUseGoogleText2SpeechService(use bool) crawlerConfigOption
• func WithUseGoogleTranslateService(use bool) crawlerConfigOption
• type Audio
  • func (a *Audio) Close() error
  • func (a *Audio) Dump(path string) error
  • func (a *Audio) Play() error
• type Config
• type Image
  • func DownloadAndDecode(day types.Day, region types.Region, resolution types.Resolution, ...) (*Image, error)
  • func SetupTestImage(t testing.TB) *Image
  • func (img *Image) DrawDescription(position types.Position, fontName string) error
  • func (img *Image) DrawQRCode(resolution types.Resolution, position types.Position) error
  • func (img *Image) DrawWatermark(watermarkFile string, rotateCounterClockwise bool) error
  • func (img *Image) EncodeAndDump(targetDir string) (string, error)
  • func (i *Image) Equals(other *Image) bool
  • func (i *Image) Update(o *Image)
• type Mode

Constants

const (
	ModeCenter  = wallpaper.Center
	ModeCrop    = wallpaper.Crop
	ModeFit     = wallpaper.Fit
	ModeSpan    = wallpaper.Span
	ModeStretch = wallpaper.Stretch
	ModeTile    = wallpaper.Tile
)

const AppName = "Bing Wallpaper Changer"

Functions

func FromMock

func FromMock(t testing.TB) bool

FromMock returns true if the test is running in mock mode.

func GetWallpaper

func GetWallpaper() (string, error)

GetWallpaper returns the path to the current wallpaper.

func MockServers

func MockServers(t testing.TB)

MockServers sets up mock servers for the Bing and Hiragana API.

func Run

func Run(execute func(*Config) *Image, cfg *Config)

Run executes the given function with the given configuration.

func SetWallpaper

func SetWallpaper(path string, mode Mode) error

SetWallpaper sets the wallpaper from the given path.

func WithFuriganaApiAppId

func WithFuriganaApiAppId(appId string) crawlerConfigOption

func WithGoogleAppCredentials

func WithGoogleAppCredentials(credentials string) crawlerConfigOption

func WithUseGoogleText2SpeechService

func WithUseGoogleText2SpeechService(use bool) crawlerConfigOption

func WithUseGoogleTranslateService

func WithUseGoogleTranslateService(use bool) crawlerConfigOption

Types

type Audio

type Audio struct {
	Encoding   string
	Location   string
	Source     io.Reader
	SampleRate int32
}

func (*Audio) Close

func (a *Audio) Close() error

Implements the io.Closer interface.

func (*Audio) Dump

func (a *Audio) Dump(path string) error

Dump dumps the audio to the target path.

func (*Audio) Play

func (a *Audio) Play() error

Play plays the audio.

type Config

type Config struct {
	Day                         types.Day        `json:"day"`
	Region                      types.Region     `json:"region"`
	Resolution                  types.Resolution `json:"resolution"`
	DrawDescription             bool             `json:"drawDescription"`
	DrawQRCode                  bool             `json:"drawQRCode"`
	Watermark                   string           `json:"watermark"`
	DownloadOnly                bool             `json:"downloadOnly"`
	DownloadDirectory           string           `json:"downloadDirectory"`
	RotateCounterClockwise      bool             `json:"rotateCounterClockwise"`
	GoogleAppCredentials        string           `json:"googleAppCredentials"`
	FuriganaApiAppId            string           `json:"furiganaApiAppId"`
	UseGoogleText2SpeechService bool             `json:"useGoogleText2SpeechService"`
	UseGoogleTranslateService   bool             `json:"useGoogleTranslateService"`
	Daemon                      bool             `json:"daemon"`
	Debug                       bool             `json:"debug"`
}

type Image

type Image struct {
	image.Image
	Audio       *Audio
	Description string
	SearchURL   string
	DownloadURL string
	Location    string
}

Image is a wrapper around the image.Image interface.

func DownloadAndDecode

func DownloadAndDecode(day types.Day, region types.Region, resolution types.Resolution, opts ...crawlerConfigOption) (*Image, error)

DownloadAndDecode fetches the Bing wallpaper and decodes it.

func SetupTestImage

func SetupTestImage(t testing.TB) *Image

SetupTestImage returns a test image

func (*Image) DrawDescription

func (img *Image) DrawDescription(position types.Position, fontName string) error

DrawDescription draws a title onto the given image.

func (*Image) DrawQRCode

func (img *Image) DrawQRCode(resolution types.Resolution, position types.Position) error

DrawQRCode draws a QR code onto the given image.

func (*Image) DrawWatermark

func (img *Image) DrawWatermark(watermarkFile string, rotateCounterClockwise bool) error

DrawWatermark draws a watermark onto the given image.

func (*Image) EncodeAndDump

func (img *Image) EncodeAndDump(targetDir string) (string, error)

EncodeAndDump encodes the image and dumps it to the target directory. If audio description is available, it will be dumped as well.

func (*Image) Equals

func (i *Image) Equals(other *Image) bool

Equals returns true if the given image is equal to the receiver.

func (*Image) Update

func (i *Image) Update(o *Image)

Update updates the receiver with the given image.

type Mode

type Mode = wallpaper.Mode

Mode represents the wallpaper setting mode.