apple-music.txt

==============================================================================
INTRODUCTION                                                 *apple-music.intro*


 This is a simple plugin to control Apple Music using Neovim.
 It uses AppleScript to control the Music app on macOS.

 For example,

>
   require('apple-music').play_track("Sir Duke")
<

==============================================================================
PLUGIN OVERVIEW                                               *apple-music.nvim*

M.setup()                                                              *M.setup*
     * {temp_playlist_name: string} - The name of the temporary playlist to use
     								(see `apple-music.caveats` for details on temporary playlists)


M.play_track()                                                    *M.play_track*
    @usage require('apple-music').play_track("Sir Duke")


M.play_playlist()                                              *M.play_playlist*
    @usage require('apple-music').play_playlist("Slow Dance")


M.play_album()                                                    *M.play_album*
    @usage require('apple-music').play_album("Nashville Skyline")


M.next_track()                                                    *M.next_track*
    Play the next track
    @usage require('apple-music').next_track()


M.previous_track()                                            *M.previous_track*
    Play the previous track
    @usage require('apple-music').previous_track()


M.restart_track()                                              *M.restart_track*
    Restart the current track
    @usage require('apple-music').restart_track()


M.toggle_play()                                                  *M.toggle_play*
    Toggle playback (play/pause)
    @usage require('apple-music').toggle_play()


M.resume()                                                            *M.resume*
    Resume playback
    @usage require('apple-music').resume()


M.pause()                                                              *M.pause*
    Puase Playback
    @usage require('apple-music').pause()


M.enable_shuffle()                                            *M.enable_shuffle*
    Enable shuffle
    @usage require('apple-music').enable_shuffle()


M.disable_shuffle()                                          *M.disable_shuffle*
    Disable shuffle
    @usage require('apple-music').disable_shuffle()


M.favorite_current_track()                            *M.favorite_current_track*
    Favorite current (playing) track.
    NOTE: Below macOS 14 (Sonoma), it'll be `loved`.
    @usage require('apple-music').favorite_current_track()


M.unfavorite_current_track()                        *M.unfavorite_current_track*
    Unfavorite current (playing) track.
    NOTE: Below macOS 14 (Sonoma), it'll be un-`loved`.
    @usage require('apple-music').unfavorite_current_track()


M.toggle_favorite_current_track()              *M.toggle_favorite_current_track*
    Toggle favorite for current (playing) track.
    NOTE: Below macOS 14 (Sonoma), it'll toggle `loved`.
    @usage require('apple-music').toggle_favorite_current_track()


M.toggle_shuffle()                                            *M.toggle_shuffle*
    Toggle shuffle
    @usage require('apple-music').toggle_shuffle()


M.shuffle_is_enabled()                                    *M.shuffle_is_enabled*
    Determine if shuffle is enabled
    @usage require('apple-music').shuffle_is_enabled()


M._cleanup()                                                        *M._cleanup*


M.cleanup()                                                          *M.cleanup*
    Delete temporary playlist. See `apple-music.caveats` for details.
    You may have to call this multiple times to remove all temporary playlists.
    @usage require('apple-music').cleanup()


M.cleanup_all()                                                  *M.cleanup_all*
    Cleanup all temporary playlists, as long as you have less than 10...
    You may still have to call this multiple times.
    There may be weird text written to your screen, but restarting neovim will fix this.
    @usage require('apple-music').cleanup_all()


M.get_playlists()                                              *M.get_playlists*
    Get a list of playlists from your Apple Music library
    @usage require('apple-music').get_playlists()


M.select_playlist_telescope()                      *M.select_playlist_telescope*
    Select and play a playlist using Telescope
    @usage require('apple-music').select_playlist_telescope()


M.get_albums()                                                    *M.get_albums*
    Get a list of albums from your Apple Music library
    @usage require('apple-music').get_albums()


M.select_album_telescope()                            *M.select_album_telescope*
    Select and play an album using Telescope
    @usage require('apple-music').select_album_telescope()


M.get_tracks()                                                    *M.get_tracks*
    Get a list of tracks from your Apple Music library
    @usage require('apple-music').get_tracks()


M.select_track_telescope()                            *M.select_track_telescope*
    Select and play a track using Telescope
    @usage require('apple-music').select_track_telescope()


vim:tw=78:ts=8:noet:ft=help:norl: