qplay

Documentation

Overview

Package qplay is a generated QPlay package.

Index

• Constants
• type Property
• type QPlayAuthArgs
• type QPlayAuthResponse
• type Service
  • func NewService(opts ...ServiceOption) *Service
  • func (s *Service) Client() *http.Client
  • func (s *Service) ControlEndpoint() *url.URL
  • func (s *Service) EventEndpoint() *url.URL
  • func (s *Service) Location() *url.URL
  • func (zp *Service) ParseEvent(body []byte) []interface{}
  • func (s *Service) QPlayAuth(args *QPlayAuthArgs) (*QPlayAuthResponse, error)
• type ServiceOption
  • func WithClient(c *http.Client) ServiceOption
  • func WithLocation(u *url.URL) ServiceOption
• type UpnpEvent

Constants

const (
	ServiceURN     = "urn:schemas-upnp-org:service:QPlay:1"
	EncodingSchema = "http://schemas.xmlsoap.org/soap/encoding/"
	EnvelopeSchema = "http://schemas.xmlsoap.org/soap/envelope/"
)

Types

type Property

type Property struct {
	XMLName xml.Name `xml:"property"`
}

Property represents a single property in a UPnP event notification.

type QPlayAuthArgs

type QPlayAuthArgs struct {
	Xmlns string `xml:"xmlns:u,attr"`
	Seed  string `xml:"Seed"`
}

QPlayAuth Argument type.

type QPlayAuthResponse

type QPlayAuthResponse struct {
	Code string `xml:"Code"`
	MID  string `xml:"MID"`
	DID  string `xml:"DID"`
}

QPlayAuth Response type.

type Service

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

Service represents QPlay service.

func NewService

func NewService(opts ...ServiceOption) *Service

NewService creates a new instance of the QPlay service. You must provide at least a location URL and an HTTP client using the options.

func (*Service) Client

func (s *Service) Client() *http.Client

Client returns the HTTP client used to communicate with the service.

func (*Service) ControlEndpoint

func (s *Service) ControlEndpoint() *url.URL

ControlEndpoint returns the control endpoint URL of the service. This is usually a URL relative to the device's base URL.

func (*Service) EventEndpoint

func (s *Service) EventEndpoint() *url.URL

EventEndpoint returns the event endpoint URL of the service. This is usually a URL relative to the device's base URL.

func (*Service) Location

func (s *Service) Location() *url.URL

Location returns the base URL of the device hosting the service.

func (*Service) ParseEvent

func (zp *Service) ParseEvent(body []byte) []interface{}

ParseEvent parses a UPnP event notification and updates the service's state variables accordingly. It returns a slice of updated state variable values.

func (*Service) QPlayAuth

func (s *Service) QPlayAuth(args *QPlayAuthArgs) (*QPlayAuthResponse, error)

QPlayAuth calls the QPlayAuth action on the service.

type ServiceOption

type ServiceOption func(*Service)

func WithClient

func WithClient(c *http.Client) ServiceOption

func WithLocation

func WithLocation(u *url.URL) ServiceOption

type UpnpEvent

type UpnpEvent struct {
	XMLName      xml.Name   `xml:"propertyset"`
	XMLNameSpace string     `xml:"xmlns:e,attr"`
	Properties   []Property `xml:"property"`
}

UpnpEvent represents a UPnP event notification.