lib/spotify.rb in spotify-7.0.3 vs lib/spotify.rb in spotify-7.0.4

@@ -1,71 +1,77 @@
 # coding: utf-8
 require 'ffi'
 require 'spotify/version'
 
 # FFI wrapper around libspotify.
-# 
+#
 # See official documentation for more detailed documentation about
 # functions and their behavior.
-# 
+#
 # @see http://developer.spotify.com/en/libspotify/docs/
 module Spotify
   extend FFI::Library
   ffi_lib ['libspotify', '/Library/Frameworks/libspotify.framework/libspotify']
-  
+
   # libspotify API version
   # @return [Fixnum]
   API_VERSION = VERSION.split('.').first.to_i
-  
+
   #
   # Error
-  # 
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__error.html
+
+  #
   enum :error, [:ok, :bad_api_version, :api_initialization_failed,
                :track_not_playable, :resource_not_loaded,
                :bad_application_key, :bad_username_or_password,
                :user_banned, :unable_to_contact_server,
                :client_too_old, :other_permanent, :bad_user_agent,
                :missing_callback, :invalid_indata,
                :index_out_of_range, :user_needs_premium,
                :other_transient, :is_loading, :no_stream_available,
                :permission_denied, :inbox_is_full, :no_cache,
                :no_such_user]
-  
+
   attach_function :error_message, :sp_error_message, [ :error ], :string
-  
+
   #
   # Audio
-  # 
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__session.html
+
+  #
   enum :sampletype, [:int16_native_endian]
   enum :bitrate, %w(160k 320k)
-  
+
   # FFI::Struct for Audio Format.
-  # 
+  #
   # @attr [:sampletype] sample_type
   # @attr [Fixnum] sample_rate
   # @attr [Fixnum] channels
   class AudioFormat < FFI::Struct
     layout :sample_type, :sampletype,
            :sample_rate, :int,
            :channels, :int
   end
 
   # FFI::Struct for Audio Buffer Stats.
-  # 
+  #
   # @attr [Fixnum] samples
   # @attr [Fixnum] stutter
   class AudioBufferStats < FFI::Struct
     layout :samples, :int,
            :stutter, :int
   end
-  
+
   #
   # Session
-  # 
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__session.html
+
+  #
   enum :connectionstate, [:logged_out, :logged_in, :disconnected, :undefined]
 
   attach_function :session_create, :sp_session_create, [ :pointer, :pointer ], :error
   attach_function :session_release, :sp_session_release, [ :pointer ], :void
   attach_function :session_login, :sp_session_login, [ :pointer, :string, :string ], :void
@@ -88,11 +94,11 @@
   attach_function :session_preferred_bitrate, :sp_session_preferred_bitrate, [ :pointer, :bitrate ], :void
   attach_function :session_num_friends, :sp_session_num_friends, [ :pointer ], :int
   attach_function :session_friend, :sp_session_friend, [ :pointer, :int ], :pointer
 
   # FFI::Struct for Session callbacks.
-  # 
+  #
   # @attr [callback(:pointer, :error):void] logged_in
   # @attr [callback(:pointer):void] logged_out
   # @attr [callback(:pointer):void] metadata_updated
   # @attr [callback(:pointer, :error):void] connection_error
   # @attr [callback(:pointer, :string):void] message_to_user
@@ -123,11 +129,11 @@
            :stop_playback, callback([ :pointer ], :void),
            :get_audio_buffer_stats, callback([ :pointer, :pointer ], :void)
   end
 
   # FFI::Struct for Session configuration.
-  # 
+  #
   # @attr [Fixnum] api_version
   # @attr [Pointer] cache_location
   # @attr [Pointer] settings_location
   # @attr [size_t] application_key_size
   # @attr [Pointer] user_agent
@@ -144,17 +150,19 @@
            :user_agent, :pointer,
            :callbacks, :pointer,
            :userdata, :pointer,
            :compress_playlists, :int,
            :dont_save_metadata_for_playlists, :int,
-           :initially_unload_playlists, :int    
+           :initially_unload_playlists, :int
   end
-  
+
   #
   # Link
-  # 
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__link.html
+
+  #
   enum :linktype, [:invalid, :track, :album, :artist, :search,
                    :playlist, :profile, :starred, :localtrack]
 
   attach_function :link_create_from_string, :sp_link_create_from_string, [ :string ], :pointer
   attach_function :link_create_from_track, :sp_link_create_from_track, [ :pointer, :int ], :pointer
@@ -170,15 +178,17 @@
   attach_function :link_as_album, :sp_link_as_album, [ :pointer ], :pointer
   attach_function :link_as_artist, :sp_link_as_artist, [ :pointer ], :pointer
   attach_function :link_as_user, :sp_link_as_user, [ :pointer ], :pointer
   attach_function :link_add_ref, :sp_link_add_ref, [ :pointer ], :void
   attach_function :link_release, :sp_link_release, [ :pointer ], :void
-  
+
   #
   # Tracks
-  # 
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__track.html
+
+  #
   attach_function :track_is_loaded, :sp_track_is_loaded, [ :pointer ], :bool
   attach_function :track_error, :sp_track_error, [ :pointer ], :error
   attach_function :track_is_available, :sp_track_is_available, [ :pointer, :pointer ], :bool
   attach_function :track_is_local, :sp_track_is_local, [ :pointer, :pointer ], :bool
   attach_function :track_is_autolinked, :sp_track_is_autolinked, [ :pointer, :pointer ], :bool
@@ -193,15 +203,17 @@
   attach_function :track_disc, :sp_track_disc, [ :pointer ], :int
   attach_function :track_index, :sp_track_index, [ :pointer ], :int
   attach_function :localtrack_create, :sp_localtrack_create, [ :string, :string, :string, :int ], :pointer
   attach_function :track_add_ref, :sp_track_add_ref, [ :pointer ], :void
   attach_function :track_release, :sp_track_release, [ :pointer ], :void
-  
+
   #
   # Albums
-  # 
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__album.html
+
+  #
   enum :albumtype, [:album, :single, :compilation, :unknown]
 
   attach_function :album_is_loaded, :sp_album_is_loaded, [ :pointer ], :bool
   attach_function :album_is_available, :sp_album_is_available, [ :pointer ], :bool
   attach_function :album_artist, :sp_album_artist, [ :pointer ], :pointer
@@ -209,15 +221,17 @@
   attach_function :album_name, :sp_album_name, [ :pointer ], :string
   attach_function :album_year, :sp_album_year, [ :pointer ], :int
   attach_function :album_type, :sp_album_type, [ :pointer ], :albumtype
   attach_function :album_add_ref, :sp_album_add_ref, [ :pointer ], :void
   attach_function :album_release, :sp_album_release, [ :pointer ], :void
-  
+
   #
   # Album Browser
-  # 
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__albumbrowse.html
+
+  #
   attach_function :albumbrowse_create, :sp_albumbrowse_create, [ :pointer, :pointer, callback([:pointer, :pointer], :void), :pointer ], :pointer
   attach_function :albumbrowse_is_loaded, :sp_albumbrowse_is_loaded, [ :pointer ], :bool
   attach_function :albumbrowse_error, :sp_albumbrowse_error, [ :pointer ], :error
   attach_function :albumbrowse_album, :sp_albumbrowse_album, [ :pointer ], :pointer
   attach_function :albumbrowse_artist, :sp_albumbrowse_artist, [ :pointer ], :pointer
@@ -226,24 +240,28 @@
   attach_function :albumbrowse_num_tracks, :sp_albumbrowse_num_tracks, [ :pointer ], :int
   attach_function :albumbrowse_track, :sp_albumbrowse_track, [ :pointer, :int ], :pointer
   attach_function :albumbrowse_review, :sp_albumbrowse_review, [ :pointer ], :string
   attach_function :albumbrowse_add_ref, :sp_albumbrowse_add_ref, [ :pointer ], :void
   attach_function :albumbrowse_release, :sp_albumbrowse_release, [ :pointer ], :void
-  
+
   #
   # Artists
-  # 
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__artist.html
+
+  #
   attach_function :artist_name, :sp_artist_name, [ :pointer ], :string
   attach_function :artist_is_loaded, :sp_artist_is_loaded, [ :pointer ], :bool
   attach_function :artist_add_ref, :sp_artist_add_ref, [ :pointer ], :void
   attach_function :artist_release, :sp_artist_release, [ :pointer ], :void
-  
+
   #
   # Artist Browsing
-  # 
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__artistbrowse.html
+
+  #
   attach_function :artistbrowse_create, :sp_artistbrowse_create, [ :pointer, :pointer, callback([:pointer, :pointer], :void), :pointer ], :pointer
   attach_function :artistbrowse_is_loaded, :sp_artistbrowse_is_loaded, [ :pointer ], :bool
   attach_function :artistbrowse_error, :sp_artistbrowse_error, [ :pointer ], :error
   attach_function :artistbrowse_artist, :sp_artistbrowse_artist, [ :pointer ], :pointer
   attach_function :artistbrowse_num_portraits, :sp_artistbrowse_num_portraits, [ :pointer ], :int
@@ -255,33 +273,37 @@
   attach_function :artistbrowse_num_similar_artists, :sp_artistbrowse_num_similar_artists, [ :pointer ], :int
   attach_function :artistbrowse_similar_artist, :sp_artistbrowse_similar_artist, [ :pointer, :int ], :pointer
   attach_function :artistbrowse_biography, :sp_artistbrowse_biography, [ :pointer ], :string
   attach_function :artistbrowse_add_ref, :sp_artistbrowse_add_ref, [ :pointer ], :void
   attach_function :artistbrowse_release, :sp_artistbrowse_release, [ :pointer ], :void
-  
+
   #
   # Images
-  # 
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__image.html
+
+  #
   enum :imageformat, [:unknown, -1, :jpeg]
 
   callback :image_loaded, [ :pointer, :pointer ], :void
   attach_function :image_create, :sp_image_create, [ :pointer, :uchar], :pointer
   attach_function :image_add_load_callback, :sp_image_add_load_callback, [ :pointer, :image_loaded, :pointer ], :void
   attach_function :image_remove_load_callback, :sp_image_remove_load_callback, [ :pointer, :image_loaded, :pointer ], :void
   attach_function :image_is_loaded, :sp_image_is_loaded, [ :pointer ], :bool
   attach_function :image_error, :sp_image_error, [ :pointer ], :error
   attach_function :image_format, :sp_image_format, [ :pointer ], :imageformat
   attach_function :image_data, :sp_image_data, [ :pointer, :pointer ], :pointer
-  attach_function :image_image_id, :sp_image_image_id, [ :pointer ], :pointer # string?
+  attach_function :image_image_id, :sp_image_image_id, [ :pointer ], :pointer
   attach_function :image_add_ref, :sp_image_add_ref, [ :pointer ], :void
   attach_function :image_release, :sp_image_release, [ :pointer ], :void
-  
+
   #
   # Searching
-  # 
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__search.html
+
+  #
   enum :radio_genre, [
     :alt_pop_rock, 0x1,
     :blues       , 0x2,
     :country     , 0x4,
     :disco       , 0x8,
@@ -299,11 +321,10 @@
     :pop_rock    , 0x8000,
     :soul        , 0x10000,
     :techno      , 0x20000
   ]
 
-
   attach_function :search_create, :sp_search_create, [ :pointer, :string, :int, :int, :int, :int, :int, :int, callback([:pointer, :pointer], :void), :pointer ], :pointer
   attach_function :radio_search_create, :sp_radio_search_create, [ :pointer, :uint, :uint, :radio_genre, :pointer, :pointer ], :pointer
   attach_function :search_is_loaded, :sp_search_is_loaded, [ :pointer ], :bool
   attach_function :search_error, :sp_search_error, [ :pointer ], :error
   attach_function :search_num_tracks, :sp_search_num_tracks, [ :pointer ], :int
@@ -317,15 +338,17 @@
   attach_function :search_total_tracks, :sp_search_total_tracks, [ :pointer ], :int
   attach_function :search_total_albums, :sp_search_total_albums, [ :pointer ], :int
   attach_function :search_total_artists, :sp_search_total_artists, [ :pointer ], :int
   attach_function :search_add_ref, :sp_search_add_ref, [ :pointer ], :void
   attach_function :search_release, :sp_search_release, [ :pointer ], :void
-  
+
   #
   # Playlists
-  # 
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__playlist.html
+
+  #
   enum :playlist_type, [:playlist, :start_folder, :end_folder, :placeholder]
 
   attach_function :playlist_is_loaded, :sp_playlist_is_loaded, [ :pointer ], :bool
   attach_function :playlist_add_callbacks, :sp_playlist_add_callbacks, [ :pointer, :pointer, :pointer ], :void
   attach_function :playlist_remove_callbacks, :sp_playlist_remove_callbacks, [ :pointer, :pointer, :pointer ], :void
@@ -357,11 +380,11 @@
   attach_function :playlist_create, :sp_playlist_create, [ :pointer, :pointer ], :pointer
   attach_function :playlist_add_ref, :sp_playlist_add_ref, [ :pointer ], :void
   attach_function :playlist_release, :sp_playlist_release, [ :pointer ], :void
 
   # FFI::Struct for Playlist callbacks.
-  # 
+  #
   # @attr [callback(:pointer, :pointer, :int, :int, :pointer):void] tracks_added
   # @attr [callback(:pointer, :pointer, :int, :pointer):void] tracks_removed
   # @attr [callback(:pointer, :pointer, :int, :int, :pointer):void] tracks_moved
   # @attr [callback(:pointer, :pointer):void] playlist_renamed
   # @attr [callback(:pointer, :pointer):void] playlist_state_changed
@@ -388,22 +411,23 @@
            :track_message_changed, callback([ :pointer, :int, :string, :pointer ], :void),
            :subscribers_changed, callback([ :pointer, :pointer ], :void)
   end
 
   # FFI::Struct for Subscribers of a Playlist.
-  # 
+  #
   # @attr [Fixnum] count
   # @attr [Pointer<String>] subscribers
   class Subscribers < FFI::Struct
     layout :count, :uint,
            :subscribers, :pointer # array of count strings
   end
 
   #
   # Playlist Container
-  # 
+  #
 
+  #
   attach_function :playlistcontainer_add_callbacks, :sp_playlistcontainer_add_callbacks, [ :pointer, :pointer, :pointer ], :void
   attach_function :playlistcontainer_remove_callbacks, :sp_playlistcontainer_remove_callbacks, [ :pointer, :pointer, :pointer ], :void
   attach_function :playlistcontainer_num_playlists, :sp_playlistcontainer_num_playlists, [ :pointer ], :int
   attach_function :playlistcontainer_playlist, :sp_playlistcontainer_playlist, [ :pointer, :int ], :pointer
   attach_function :playlistcontainer_playlist_type, :sp_playlistcontainer_playlist_type, [ :pointer, :int ], :int
@@ -417,41 +441,45 @@
   attach_function :playlistcontainer_owner, :sp_playlistcontainer_owner, [ :pointer ], :pointer
   attach_function :playlistcontainer_add_ref, :sp_playlistcontainer_add_ref, [ :pointer ], :void
   attach_function :playlistcontainer_release, :sp_playlistcontainer_release, [ :pointer ], :void
 
   # FFI::Struct for the PlaylistContainer.
-  # 
+  #
   # @attr [callback(:pointer, :pointer, :int, :pointer):void] playlist_added
   # @attr [callback(:pointer, :pointer, :int, :pointer):void] playlist_removed
   # @attr [callback(:pointer, :pointer, :int, :int, :pointer):void] playlist_moved
   # @attr [callback(:pointer, :pointer):void] container_loaded
   class PlaylistContainerCallbacks < FFI::Struct
     layout :playlist_added, callback([ :pointer, :pointer, :int, :pointer ], :void),
            :playlist_removed, callback([ :pointer, :pointer, :int, :pointer ], :void),
            :playlist_moved, callback([ :pointer, :pointer, :int, :int, :pointer ], :void),
            :container_loaded, callback([ :pointer, :pointer ], :void)
   end
-  
+
   #
   # User handling
-  # 
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__user.html
+
+  #
   enum :relation_type, [:unknown, :none, :unidirectional, :bidirectional]
 
   attach_function :user_canonical_name, :sp_user_canonical_name, [ :pointer ], :string
   attach_function :user_display_name, :sp_user_display_name, [ :pointer ], :string
   attach_function :user_is_loaded, :sp_user_is_loaded, [ :pointer ], :bool
   attach_function :user_full_name, :sp_user_full_name, [ :pointer ], :string
   attach_function :user_picture, :sp_user_picture, [ :pointer ], :string
   attach_function :user_relation_type, :sp_user_relation_type, [ :pointer, :pointer ], :relation_type
   attach_function :user_add_ref, :sp_user_add_ref, [ :pointer ], :void
   attach_function :user_release, :sp_user_release, [ :pointer ], :void
-  
+
   #
   # Toplists
-  # 
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__toplist.html
+
+  #
   enum :toplisttype, [:artists, :albums, :tracks]
   enum :toplistregion, [:everywhere, :user]
 
   attach_function :toplistbrowse_create, :sp_toplistbrowse_create, [ :pointer, :toplisttype, :toplistregion, :string, callback([:pointer, :pointer], :void), :pointer ], :pointer
   attach_function :toplistbrowse_is_loaded, :sp_toplistbrowse_is_loaded, [ :pointer ], :bool
@@ -462,14 +490,16 @@
   attach_function :toplistbrowse_artist, :sp_toplistbrowse_artist, [ :pointer, :int ], :pointer
   attach_function :toplistbrowse_num_albums, :sp_toplistbrowse_num_albums, [ :pointer ], :int
   attach_function :toplistbrowse_album, :sp_toplistbrowse_album, [ :pointer, :int ], :pointer
   attach_function :toplistbrowse_num_tracks, :sp_toplistbrowse_num_tracks, [ :pointer ], :int
   attach_function :toplistbrowse_track, :sp_toplistbrowse_track, [ :pointer, :int ], :pointer
-  
+
   #
   # Inbox
-  # 
+  #
   # @see http://developer.spotify.com/en/libspotify/docs/group__inbox.html
+
+  #
   attach_function :inbox_post_tracks, :sp_inbox_post_tracks, [ :pointer, :string, :pointer, :int, :string, callback([:pointer, :pointer], :void), :pointer ], :pointer
   attach_function :inbox_error, :sp_inbox_error, [ :pointer ], :error
   attach_function :inbox_add_ref, :sp_inbox_add_ref, [ :pointer ], :void
   attach_function :inbox_release, :sp_inbox_release, [ :pointer ], :void
 end
\ No newline at end of file