respot

Documentation

Index

• Variables
• func APResolve() (string, error)
• func GenerateDeviceUID(name string) string
• type APList
• type PinOpts
• type Session
• type SessionContext
  • func DefaultSessionContext(deviceLabel string) *SessionContext
• type SessionInfo
• type SessionLogin

Variables

var StartNewSession func(ctx *SessionContext) (Session, error)

Forward declartion to create a respot.Session.

Functions

func APResolve

func APResolve() (string, error)

APResolve fetches the available Spotify access point URLs and picks a random one

func GenerateDeviceUID

func GenerateDeviceUID(name string) string

Types

type APList

type APList struct {
	ApList []string `json:"ap_list"`
}

APList is the JSON structure corresponding to the output of the AP endpoint resolve API

type PinOpts

type PinOpts struct {

	// If set, media.Asset.OnStart(Ctx().Context) will be called on the returned media.Asset.
	// This is for convenience but not desirable when the asset is in a time-to-live cache, for example.
	StartInternally bool

	// Expresses preferences for the requested asset's codec and format.
	Format asset.AssetFormat
}

type Session

type Session interface {
	Close() error

	// Returns the SessionContext current in use by this session
	Context() *SessionContext

	// Initiates login with params contained in Ctx.Login
	Login() error

	Search(query string, limit int) (*mercury.SearchResponse, error)
	Mercury() *mercury.Client

	// Initiates downloading ("pinning") with the given spotify track ID or URI.
	// The track data is accessible via media.Asset, supporting io.ReadSeekCloser and is essential for streaming or serving.
	PinTrack(trackID string, opts PinOpts) (media.Asset, error)
}

type SessionContext

type SessionContext struct {
	task.Context              // logging & shutdown
	Login        SessionLogin // means for the session to login
	Info         SessionInfo  // filled in during Session.Login()
	Keys         crypto.Keys  // If nil, will be auto-generated
	DeviceName   string       // Label of the device being used
	DeviceUID    string       // if nil, auto-generated from DeviceName
}

func DefaultSessionContext

func DefaultSessionContext(deviceLabel string) *SessionContext

DefaultSessionContext creates a SessionContext with the given device label.

type SessionInfo

type SessionInfo struct {
	Username string // authenticated canonical username
	AuthBlob []byte // reusable authentication blob for Spotify Connect devices
	Country  string // user country returned by Spotify
}

type SessionLogin

type SessionLogin struct {
	Username  string
	Password  string // AUTHENTICATION_USER_PASS
	AuthData  []byte // AUTHENTICATION_STORED_SPOTIFY_CREDENTIALS
	AuthToken string // AUTHENTICATION_SPOTIFY_TOKEN
}