sonos

README

go-sonos

A Go-language library for accessing UPnP AV devices

Documentation

Overview

A go-language implementation of the Sonos UPnP API.

Index

• Constants
• func Coverage(s *Sonos)
• func Discover(ifiname, port string) (mgr ssdp.Manager, err error)
• func MakeReactor(ifiname, port string) upnp.Reactor
• type Sonos
  • func Connect(dev ssdp.Device, reactor upnp.Reactor, flags int) (sonos *Sonos)
  • func ConnectAny(mgr ssdp.Manager, reactor upnp.Reactor, flags int) (sonos []*Sonos)
  • func MakeSonos(svc_map upnp.ServiceMap, reactor upnp.Reactor, flags int) (sonos *Sonos)
  • func (this *Sonos) GetAlbumTracks(album string) ([]model.Object, error)
  • func (this *Sonos) GetAllGenres() (objects []model.Object, err error)
  • func (this *Sonos) GetArtistAlbums(artist string) (objects []model.Object, err error)
  • func (this *Sonos) GetDirectChildren(objectId string) (objects []model.Object, err error)
  • func (this *Sonos) GetGenreArtists(genre string) ([]model.Object, error)
  • func (this *Sonos) GetMetadata(objectId string) (objects []model.Object, err error)
  • func (this *Sonos) GetQueueContents() (objects []model.Object, err error)
  • func (this *Sonos) GetRootLevelChildren() (objects []model.Object, err error)
  • func (this *Sonos) GetTrackFromAlbum(album, track string) ([]model.Object, error)
  • func (this *Sonos) ListAttributes() (objects []model.Object, err error)
  • func (this *Sonos) ListChildren(objectId string) (objects []model.Object, err error)
  • func (this *Sonos) ListInternetRadio() (objects []model.Object, err error)
  • func (this *Sonos) ListMusicShares() (objects []model.Object, err error)
  • func (this *Sonos) ListQueues() (objects []model.Object, err error)
  • func (this *Sonos) ListSavedQueues() (objects []model.Object, err error)

Constants

const (
	ObjectID_Attributes    = "A:"
	ObjectID_MusicShares   = "S:"
	ObjectID_Queues        = "Q:"
	ObjectID_SavedQueues   = "SQ:"
	ObjectID_InternetRadio = "R:"
	ObjectID_EntireNetwork = "EN:"
	//
	ObjectID_Queue_AVT_Instance_0 = "Q:0"
	//
	ObjectID_Attribute_Genres = "A:GENRE"
	ObjectID_Attribute_Album  = "A:ALBUM"
	ObjectID_Attribute_Artist = "A:ARTIST"
)

const (
	SVC_ALARM_CLOCK         = 1
	SVC_AV_TRANSPORT        = SVC_ALARM_CLOCK << 1
	SVC_CONNECTION_MANAGER  = SVC_AV_TRANSPORT << 1
	SVC_CONTENT_DIRECTORY   = SVC_CONNECTION_MANAGER << 1
	SVC_DEVICE_PROPERTIES   = SVC_CONTENT_DIRECTORY << 1
	SVC_GROUP_MANAGEMENT    = SVC_DEVICE_PROPERTIES << 1
	SVC_MUSIC_SERVICES      = SVC_GROUP_MANAGEMENT << 1
	SVC_RENDERING_CONTROL   = SVC_MUSIC_SERVICES << 1
	SVC_SYSTEM_PROPERTIES   = SVC_RENDERING_CONTROL << 1
	SVC_ZONE_GROUP_TOPOLOGY = SVC_SYSTEM_PROPERTIES << 1
	//
	SVC_ALL = SVC_ALARM_CLOCK |
		SVC_AV_TRANSPORT |
		SVC_CONNECTION_MANAGER |
		SVC_CONTENT_DIRECTORY |
		SVC_DEVICE_PROPERTIES |
		SVC_GROUP_MANAGEMENT |
		SVC_MUSIC_SERVICES |
		SVC_RENDERING_CONTROL |
		SVC_SYSTEM_PROPERTIES |
		SVC_ZONE_GROUP_TOPOLOGY
)

const MUSIC_SERVICES = "schemas-upnp-org-MusicServices"

const SONOS = "Sonos"

Functions

func Coverage

func Coverage(s *Sonos)

func Discover

func Discover(ifiname, port string) (mgr ssdp.Manager, err error)

func MakeReactor

func MakeReactor(ifiname, port string) upnp.Reactor

Types

type Sonos

type Sonos struct {
	upnp.AlarmClock
	upnp.AVTransport
	upnp.ConnectionManager
	upnp.ContentDirectory
	upnp.DeviceProperties
	upnp.GroupManagement
	upnp.MusicServices
	upnp.RenderingControl
	upnp.SystemProperties
	upnp.ZoneGroupTopology
}

func Connect

func Connect(dev ssdp.Device, reactor upnp.Reactor, flags int) (sonos *Sonos)

func ConnectAny

func ConnectAny(mgr ssdp.Manager, reactor upnp.Reactor, flags int) (sonos []*Sonos)

func MakeSonos

func MakeSonos(svc_map upnp.ServiceMap, reactor upnp.Reactor, flags int) (sonos *Sonos)

func (*Sonos) GetAlbumTracks

func (this *Sonos) GetAlbumTracks(album string) ([]model.Object, error)

func (*Sonos) GetAllGenres

func (this *Sonos) GetAllGenres() (objects []model.Object, err error)

func (*Sonos) GetArtistAlbums

func (this *Sonos) GetArtistAlbums(artist string) (objects []model.Object, err error)

func (*Sonos) GetDirectChildren

func (this *Sonos) GetDirectChildren(objectId string) (objects []model.Object, err error)

func (*Sonos) GetGenreArtists

func (this *Sonos) GetGenreArtists(genre string) ([]model.Object, error)

func (*Sonos) GetMetadata

func (this *Sonos) GetMetadata(objectId string) (objects []model.Object, err error)

func (*Sonos) GetQueueContents

func (this *Sonos) GetQueueContents() (objects []model.Object, err error)

func (*Sonos) GetRootLevelChildren

func (this *Sonos) GetRootLevelChildren() (objects []model.Object, err error)

func (*Sonos) GetTrackFromAlbum

func (this *Sonos) GetTrackFromAlbum(album, track string) ([]model.Object, error)

func (*Sonos) ListAttributes

func (this *Sonos) ListAttributes() (objects []model.Object, err error)

func (*Sonos) ListChildren

func (this *Sonos) ListChildren(objectId string) (objects []model.Object, err error)

func (*Sonos) ListInternetRadio

func (this *Sonos) ListInternetRadio() (objects []model.Object, err error)

func (*Sonos) ListMusicShares

func (this *Sonos) ListMusicShares() (objects []model.Object, err error)

func (*Sonos) ListQueues

func (this *Sonos) ListQueues() (objects []model.Object, err error)

func (*Sonos) ListSavedQueues

func (this *Sonos) ListSavedQueues() (objects []model.Object, err error)