rest

package
v1.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 10, 2023 License: AGPL-3.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var ErrActionFailed = errors.New("action could not be performed")
View Source
var ErrActionNotReady = errors.New("actions can not be performed yet")

Functions

This section is empty.

Types

type Server

type Server struct {
	// contains filtered or unexported fields
}

Implements ServerInterface

func (Server) AddHooks added in v1.1.0

func (s Server) AddHooks(cfg common.Config)

func (Server) DoAction added in v1.1.0

func (s Server) DoAction(action string) error

func (Server) GetInfo added in v1.2.1

func (s Server) GetInfo(w http.ResponseWriter, r *http.Request, path string)

Info (GET /info/{path})

func (Server) GetLights

func (s Server) GetLights(w http.ResponseWriter, r *http.Request)

List all light effects (GET /lights)

func (Server) GetLightsEffect

func (s Server) GetLightsEffect(w http.ResponseWriter, r *http.Request, effect LightEffect)

Get light effect details (GET /lights/{effect})

func (Server) GetMusic

func (s Server) GetMusic(w http.ResponseWriter, r *http.Request)

List all playlists (GET /music)

func (Server) GetMusicPlaying

func (s Server) GetMusicPlaying(w http.ResponseWriter, r *http.Request)

Get now playing info (GET /music/playing)

func (Server) GetMusicPlaylist

func (s Server) GetMusicPlaylist(w http.ResponseWriter, r *http.Request, playlist Playlist)

Get playlist details (GET /music/{playlist})

func (Server) GetMusicPlaylistChance

func (s Server) GetMusicPlaylistChance(w http.ResponseWriter, r *http.Request, playlist string)

Get playlist chance (GET /music/{playlist}/chance)

func (Server) GetMusicPlaylistPosition

func (s Server) GetMusicPlaylistPosition(w http.ResponseWriter, r *http.Request, playlist string)

Get position in playlist (GET /music/{playlist}/position)

func (Server) GetPing

func (s Server) GetPing(w http.ResponseWriter, r *http.Request)

Ping (GET /ping)

func (Server) GetProfiles added in v1.1.0

func (s Server) GetProfiles(w http.ResponseWriter, r *http.Request)

List all light effects (GET /profiles)

func (Server) GetRoot

func (s Server) GetRoot(w http.ResponseWriter, r *http.Request)

List all endpoints (GET /)

func (Server) GetSounds

func (s Server) GetSounds(w http.ResponseWriter, r *http.Request)

List all sounds (GET /sounds)

func (Server) GetSoundsSound

func (s Server) GetSoundsSound(w http.ResponseWriter, r *http.Request, sound Sound)

Get sound details (GET /sounds/{sound})

func (Server) GetSystemIntensity

func (s Server) GetSystemIntensity(w http.ResponseWriter, r *http.Request)

Get Intensity (GET /system/intensity)

func (Server) GetSystemVolume

func (s Server) GetSystemVolume(w http.ResponseWriter, r *http.Request)

Get volume (GET /system/volume)

func (Server) PostLightsClear

func (s Server) PostLightsClear(w http.ResponseWriter, r *http.Request)

Stop all light effects (POST /lights/clear)

func (Server) PostLightsStart

func (s Server) PostLightsStart(w http.ResponseWriter, r *http.Request, effect LightEffect)

Start a light effect (POST /lights/{effect}/set)

func (Server) PostLightsStop

func (s Server) PostLightsStop(w http.ResponseWriter, r *http.Request, effect LightEffect)

Stop a light effect (POST /lights/{effect}/stop)

func (Server) PostMusicNext

func (s Server) PostMusicNext(w http.ResponseWriter, r *http.Request)

Play the next track (POST /music/next)

func (Server) PostMusicPause

func (s Server) PostMusicPause(w http.ResponseWriter, r *http.Request)

Stop music playback (POST /music/pause)

func (Server) PostMusicPlay

func (s Server) PostMusicPlay(w http.ResponseWriter, r *http.Request)

Start music playback (POST /music/play)

func (Server) PostMusicPlaylistSkip

func (s Server) PostMusicPlaylistSkip(w http.ResponseWriter, r *http.Request, playlist Playlist)

Skip the next song in a playlist (POST /music/{playlist}/skip)

func (Server) PostMusicStop

func (s Server) PostMusicStop(w http.ResponseWriter, r *http.Request)

Stop music playback (POST /music/stop)

func (Server) PostProfilesSet added in v1.1.0

func (s Server) PostProfilesSet(w http.ResponseWriter, r *http.Request, profile string)

Start a light effect (POST /profiles/{profile}/set)

func (Server) PostShellCommand

func (s Server) PostShellCommand(w http.ResponseWriter, r *http.Request, command string)

Shell Command (POST /shell/{command})

func (Server) PostSoundsLoop

func (s Server) PostSoundsLoop(w http.ResponseWriter, r *http.Request, sound Sound)

Loop a sound (POST /sounds/{sound}/loop)

func (Server) PostSoundsPlay

func (s Server) PostSoundsPlay(w http.ResponseWriter, r *http.Request, sound Sound)

Play a sound (POST /sounds/{sound}/play)

func (Server) PostSoundsUnloop

func (s Server) PostSoundsUnloop(w http.ResponseWriter, r *http.Request, sound Sound)

Stop a looped sound (POST /sounds/{sound}/unloop)

func (Server) PostSystemIntensity

func (s Server) PostSystemIntensity(w http.ResponseWriter, r *http.Request)

Set Intensity (POST /system/intensity)

func (Server) PostSystemIntensityDelta

func (s Server) PostSystemIntensityDelta(w http.ResponseWriter, r *http.Request, delta int)

Change Intensity (POST /system/intensity/{delta})

func (Server) PostSystemVolume

func (s Server) PostSystemVolume(w http.ResponseWriter, r *http.Request)

Set Volume (POST /system/volume)

func (Server) PostSystemVolumeDelta

func (s Server) PostSystemVolumeDelta(w http.ResponseWriter, r *http.Request, delta int)

Change Volume (POST /system/volume/{delta})

Jump to

Keyboard shortcuts

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