player

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 26, 2025 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Player

type Player struct {
	Send     func(method lib.HTTPMethod, action string, options [][2]string, body []byte) ([]byte, error)
	DeviceID string
	Market   string // An ISO 3166-1 alpha-2 country code, https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
}

func New

func New(send func(method lib.HTTPMethod, action string, options [][2]string, body []byte) ([]byte, error)) Player

func (*Player) AddItemToPlaybackQueue

func (s *Player) AddItemToPlaybackQueue(uri lib.URI) error

Requires premium.

Scopes: `ScopeUserModifyPlaybackState`

func (*Player) GetAvailableDevices

func (s *Player) GetAvailableDevices() (getAvailableDevices, error)

Scopes: `ScopeUserReadPlaybackState`

func (*Player) GetCurrentlyPlayingTrack

func (s *Player) GetCurrentlyPlayingTrack() (getCurrentlyPlayingTrack, error)

Scopes: `ScopeUserReadCurrentlyPlaying`

func (*Player) GetPlaybackState

func (s *Player) GetPlaybackState() (getPlaybackState, error)

Scopes: `ScopeUserReadPlaybackState`

func (*Player) GetRecentlyPlayedTracks

func (s *Player) GetRecentlyPlayedTracks(limit int, stamp time.Time, after bool) (getRecentlyPlayedTracks, error)

Scopes: `ScopeUserReadRecentlyPlayed`

Return items after stamp if after is true, otherwise returns items before time. Use `time.Time{}` to disable this filter.

func (*Player) GetTheUsersQueue

func (s *Player) GetTheUsersQueue() (getTheUsersQueue, error)

Scopes: `ScopeUserReadCurrentlyPlaying`, `ScopeUserReadPlaybackState`

func (*Player) PausePlayback

func (s *Player) PausePlayback() error

Requires premium.

Scopes: `ScopeUserModifyPlaybackState`

func (*Player) SeekToPosition

func (s *Player) SeekToPosition(position time.Duration) error

Requires premium.

Scopes: `ScopeUserModifyPlaybackState`

func (*Player) SetPlaybackVolume

func (s *Player) SetPlaybackVolume(volume int) error

Requires premium.

Scopes: `ScopeUserModifyPlaybackState`

func (*Player) SetRepeatMode

func (s *Player) SetRepeatMode(state lib.RepeatMode) error

Requires premium.

Scopes: `ScopeUserModifyPlaybackState`

func (*Player) SkipToNext

func (s *Player) SkipToNext() error

Requires premium.

Scopes: `ScopeUserModifyPlaybackState`

func (*Player) SkipToPrevious

func (s *Player) SkipToPrevious() error

Requires premium.

Scopes: `ScopeUserModifyPlaybackState`

func (*Player) StartResumePlayback

func (s *Player) StartResumePlayback(position time.Duration) error

Requires premium.

Scopes: `ScopeUserModifyPlaybackState`

Use `time.Duration(-1)` to disable this filter.

func (*Player) StartResumePlaybackRaw

func (s *Player) StartResumePlaybackRaw(req map[string]any) error

Requires premium.

Scopes: `ScopeUserModifyPlaybackState`

Body:

{
    "context_uri": "spotify:album:5ht7ItJgpBH7W6vJ5BqpPr",
    "uris": ["spotify:track:4iV5W9uYEdYUVa79Axb7Rh", "spotify:track:1301WleyT98MSxVHPZCA6M"],
    "offset": {
        "position": 5,
        "uri": "spotify:track:1301WleyT98MSxVHPZCA6M"
    },
    "position_ms": 0
}

func (*Player) TogglePlaybackShuffle

func (s *Player) TogglePlaybackShuffle(state bool) error

Requires premium.

Scopes: `ScopeUserModifyPlaybackState`

func (*Player) TransferPlayback

func (s *Player) TransferPlayback(deviceID string, play bool) error

Requires premium.

Scopes: `ScopeUserModifyPlaybackState`

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL