api

Documentation

Index

• type Server
  • func NewServer(service service.MgmtService) *Server
  • func (s *Server) AddSpeakersToZone(ctx context.Context, in *ZoneRequest) (*UpdateResponse, error)
  • func (s *Server) ChangeZoneName(ctx context.Context, in *ZoneRequest) (*UpdateResponse, error)
  • func (s *Server) CreateZone(ctx context.Context, in *ZoneRequest) (*CreateResponse, error)
  • func (s *Server) DeleteZone(ctx context.Context, in *ZoneRequest) (*UpdateResponse, error)
  • func (s *Server) GetCurrentTrack(ctx context.Context, in *GetTrackRequest) (*Track, error)
  • func (s *Server) GetMuteForSpeaker(ctx context.Context, in *GetMuteRequest) (*SpeakerMuteResponse, error)
  • func (s *Server) GetSpeakers(ctx context.Context, in *GetSpeakersRequest) (*GetSpeakersResponse, error)
  • func (s *Server) GetZones(ctx context.Context, in *GetZonesRequest) (*GetZonesResponse, error)
  • func (s *Server) RemoveSpeakersFromZone(ctx context.Context, in *ZoneRequest) (*UpdateResponse, error)
  • func (s *Server) SetDisplayNameForSpeaker(ctx context.Context, in *SetSpeakerDisplayNameRequest) (*UpdateResponse, error)
  • func (s *Server) SetMuteForSpeaker(ctx context.Context, in *SetMuteRequest) (*UpdateResponse, error)

Types

type Server

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

Server represents the gRPC server

func NewServer

func NewServer(service service.MgmtService) *Server

NewServer instantiates a new RPC server

func (*Server) AddSpeakersToZone

func (s *Server) AddSpeakersToZone(ctx context.Context, in *ZoneRequest) (*UpdateResponse, error)

AddSpeakersToZone will add speakers to an existing zone

func (*Server) ChangeZoneName

func (s *Server) ChangeZoneName(ctx context.Context, in *ZoneRequest) (*UpdateResponse, error)

ChangeZoneName updates the name of a zone

func (*Server) CreateZone

func (s *Server) CreateZone(ctx context.Context, in *ZoneRequest) (*CreateResponse, error)

CreateZone will create a new zone, which is a collection of speakers that play together

func (*Server) DeleteZone

func (s *Server) DeleteZone(ctx context.Context, in *ZoneRequest) (*UpdateResponse, error)

DeleteZone will delete the given zone

func (*Server) GetCurrentTrack

func (s *Server) GetCurrentTrack(ctx context.Context, in *GetTrackRequest) (*Track, error)

GetCurrentTrack gets the current track

func (*Server) GetMuteForSpeaker

func (s *Server) GetMuteForSpeaker(ctx context.Context, in *GetMuteRequest) (*SpeakerMuteResponse, error)

GetMuteForSpeaker returns speaker mute state

func (*Server) GetSpeakers

func (s *Server) GetSpeakers(ctx context.Context, in *GetSpeakersRequest) (*GetSpeakersResponse, error)

GetSpeakers will get all the music playing nodes

func (*Server) GetZones

func (s *Server) GetZones(ctx context.Context, in *GetZonesRequest) (*GetZonesResponse, error)

GetZones will return the zones in the system

func (*Server) RemoveSpeakersFromZone

func (s *Server) RemoveSpeakersFromZone(ctx context.Context, in *ZoneRequest) (*UpdateResponse, error)

RemoveSpeakersFromZone will remove speakers from the given zone

func (*Server) SetDisplayNameForSpeaker

func (s *Server) SetDisplayNameForSpeaker(ctx context.Context, in *SetSpeakerDisplayNameRequest) (*UpdateResponse, error)

SetDisplayNameForSpeaker will update the speakers display name

func (*Server) SetMuteForSpeaker

func (s *Server) SetMuteForSpeaker(ctx context.Context, in *SetMuteRequest) (*UpdateResponse, error)

SetMuteForSpeaker will mute or unmute the given speaker