grouprenderingcontrol

Documentation

Overview

Package grouprenderingcontrol is a generated GroupRenderingControl package.

Index

• Constants
• type GetGroupMuteArgs
• type GetGroupMuteResponse
• type GetGroupVolumeArgs
• type GetGroupVolumeResponse
• type GroupMute
• type GroupVolume
• type GroupVolumeChangeable
• type Property
• 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) GetGroupMute(args *GetGroupMuteArgs) (*GetGroupMuteResponse, error)
  • func (s *Service) GetGroupVolume(args *GetGroupVolumeArgs) (*GetGroupVolumeResponse, error)
  • func (s *Service) Location() *url.URL
  • func (zp *Service) ParseEvent(body []byte) []interface{}
  • func (s *Service) SetGroupMute(args *SetGroupMuteArgs) (*SetGroupMuteResponse, error)
  • func (s *Service) SetGroupVolume(args *SetGroupVolumeArgs) (*SetGroupVolumeResponse, error)
  • func (s *Service) SetRelativeGroupVolume(args *SetRelativeGroupVolumeArgs) (*SetRelativeGroupVolumeResponse, error)
  • func (s *Service) SnapshotGroupVolume(args *SnapshotGroupVolumeArgs) (*SnapshotGroupVolumeResponse, error)
• type ServiceOption
  • func WithClient(c *http.Client) ServiceOption
  • func WithLocation(u *url.URL) ServiceOption
• type SetGroupMuteArgs
• type SetGroupMuteResponse
• type SetGroupVolumeArgs
• type SetGroupVolumeResponse
• type SetRelativeGroupVolumeArgs
• type SetRelativeGroupVolumeResponse
• type SnapshotGroupVolumeArgs
• type SnapshotGroupVolumeResponse
• type UpnpEvent

Constants

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

Types

type GetGroupMuteArgs

type GetGroupMuteArgs struct {
	Xmlns      string `xml:"xmlns:u,attr"`
	InstanceID uint32 `xml:"InstanceID"`
}

GetGroupMute Argument type.

type GetGroupMuteResponse

type GetGroupMuteResponse struct {
	CurrentMute bool `xml:"CurrentMute"`
}

GetGroupMute Response type.

type GetGroupVolumeArgs

type GetGroupVolumeArgs struct {
	Xmlns      string `xml:"xmlns:u,attr"`
	InstanceID uint32 `xml:"InstanceID"`
}

GetGroupVolume Argument type.

type GetGroupVolumeResponse

type GetGroupVolumeResponse struct {
	CurrentVolume uint16 `xml:"CurrentVolume"`
}

GetGroupVolume Response type.

type GroupMute

type GroupMute bool

State Variables

type GroupVolume

type GroupVolume uint16

type GroupVolumeChangeable

type GroupVolumeChangeable bool

type Property

type Property struct {
	XMLName               xml.Name               `xml:"property"`
	GroupMute             *GroupMute             `xml:"GroupMute"`
	GroupVolume           *GroupVolume           `xml:"GroupVolume"`
	GroupVolumeChangeable *GroupVolumeChangeable `xml:"GroupVolumeChangeable"`
}

Property represents a single property in a UPnP event notification.

type Service

type Service struct {
	GroupMute             *GroupMute
	GroupVolume           *GroupVolume
	GroupVolumeChangeable *GroupVolumeChangeable
	// contains filtered or unexported fields
}

Service represents GroupRenderingControl service.

func NewService

func NewService(opts ...ServiceOption) *Service

NewService creates a new instance of the GroupRenderingControl 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) GetGroupMute

func (s *Service) GetGroupMute(args *GetGroupMuteArgs) (*GetGroupMuteResponse, error)

GetGroupMute calls the GetGroupMute action on the service.

func (*Service) GetGroupVolume

func (s *Service) GetGroupVolume(args *GetGroupVolumeArgs) (*GetGroupVolumeResponse, error)

GetGroupVolume calls the GetGroupVolume action on the service.

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) SetGroupMute

func (s *Service) SetGroupMute(args *SetGroupMuteArgs) (*SetGroupMuteResponse, error)

SetGroupMute calls the SetGroupMute action on the service.

func (*Service) SetGroupVolume

func (s *Service) SetGroupVolume(args *SetGroupVolumeArgs) (*SetGroupVolumeResponse, error)

SetGroupVolume calls the SetGroupVolume action on the service.

func (*Service) SetRelativeGroupVolume

func (s *Service) SetRelativeGroupVolume(args *SetRelativeGroupVolumeArgs) (*SetRelativeGroupVolumeResponse, error)

SetRelativeGroupVolume calls the SetRelativeGroupVolume action on the service.

func (*Service) SnapshotGroupVolume

func (s *Service) SnapshotGroupVolume(args *SnapshotGroupVolumeArgs) (*SnapshotGroupVolumeResponse, error)

SnapshotGroupVolume calls the SnapshotGroupVolume 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 SetGroupMuteArgs

type SetGroupMuteArgs struct {
	Xmlns       string `xml:"xmlns:u,attr"`
	InstanceID  uint32 `xml:"InstanceID"`
	DesiredMute bool   `xml:"DesiredMute"`
}

SetGroupMute Argument type.

type SetGroupMuteResponse

type SetGroupMuteResponse struct {
}

SetGroupMute Response type.

type SetGroupVolumeArgs

type SetGroupVolumeArgs struct {
	Xmlns         string `xml:"xmlns:u,attr"`
	InstanceID    uint32 `xml:"InstanceID"`
	DesiredVolume uint16 `xml:"DesiredVolume"`
}

SetGroupVolume Argument type.

type SetGroupVolumeResponse

type SetGroupVolumeResponse struct {
}

SetGroupVolume Response type.

type SetRelativeGroupVolumeArgs

type SetRelativeGroupVolumeArgs struct {
	Xmlns      string `xml:"xmlns:u,attr"`
	InstanceID uint32 `xml:"InstanceID"`
	Adjustment int32  `xml:"Adjustment"`
}

SetRelativeGroupVolume Argument type.

type SetRelativeGroupVolumeResponse

type SetRelativeGroupVolumeResponse struct {
	NewVolume uint16 `xml:"NewVolume"`
}

SetRelativeGroupVolume Response type.

type SnapshotGroupVolumeArgs

type SnapshotGroupVolumeArgs struct {
	Xmlns      string `xml:"xmlns:u,attr"`
	InstanceID uint32 `xml:"InstanceID"`
}

SnapshotGroupVolume Argument type.

type SnapshotGroupVolumeResponse

type SnapshotGroupVolumeResponse struct {
}

SnapshotGroupVolume Response type.

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.