The freesound Reference Manual

This is the freesound Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:06:42 2021 GMT+0.

1 Introduction

Common Lisp client for the Freesound API

Freesound is a large-scale collaborative database of audio recordings released under Creative Commons licenses. It offers an API for interacting with the database: searching for sounds, retrieving meta-data, accessing audio content analysis, download and upload sounds, comment, rate, and bookmark, etc.

This is a Common Lisp library for the API, created and maintained by Nuno Trocado, and released under the MIT License.

Installing and loading

With quicklisp:

(ql:quickload "freesound")

Authentication

The Freesound API offers two authentication strategies: token-based and OAuth2. The first one is simpler, but you need OAuth2 to access resources that imply a logged in user, including downloading sounds (but not lossy preview versions).

Token authentication

To use the token authentication strategy, request new API credentials at Freesound. Then you'll be shown a table with the requested credentials. Set *token* to the alphanumeric string found in the "Client secret/Api key" column:

(setf *token* <string>)

If you save it on a ".token" file on the same directory as the freesound system, the code will be read automatically every time the system is loaded.

OAuth2 authentication

In addition to the previous steps, find the "client id" at the same credentials table in the Freesound website. Then do:

(setf *client-id* <string>)
(oauth2-authorize)

The default browser will be opened and you'll be asked to log in and authorize the access to Freesound. The specific link will be also printed (typically to the REPL). Afterwards, you'll be redirected to another Freesound page showing you a new alphanumeric code. Copy this code and do:

(oauth2-get-tokens <code>)

This function stores the oauth2 token in *oauth2-access-token*, which will be used in further API calls. It will also return two values: the access token itself and a refresh token. If you save the refresh token you can spare yourself (or the user of your app) the full authorization process, by using (oauth2-get-tokens <refresh token> :refresh t) each time the authorization times out, which it does after 24 hours.

Documentation

Full documentation is here.

Refer to the Freesound API documentation for the complete description of the available resources and their request parameters and accepted values, as well as the format of the responses.

The responses obtained from Freesound are translated to Common Lisp data structures. In particular, objects like search results and instance information are parsed as hash tables.

For the request parameters, a string conforming to the API syntax is always accepted. When multiple terms are to be passed to a single parameter, lists are also accepted, and converted to the appropriate strings under the hood. Numbers are automatically parsed too.

In some cases, there are further facilities to construct parameters in a lispy way. Check the examples below and the reference.

There are also convenience functions to make it easier to perform quick queries from the REPL: print-search-result and print-info.

Overview and examples

Searching

Perform a text search, using the minus '-' character to exclude terms from the search:

(text-search "conga percussive -loop")

This is equivalent:

(text-search '("conga" "percussive" "-loop"))

In general, any request parameters can be passed either as a single string conforming to the API syntax, or as a list of terms.

Filter properties can be further specified with the operators :and, :or, :range, :range-to, and :range-from. For example:

(text-search "rain" 
             :filter '((:tag (:and "soundscape" "forest")) 
                       (:created (:range-from "2010-12-01T23:59:59.999Z")) 
                       (:duration (:range 10 120))))

print-search-result is a convenience function to pretty print the results.

Here's another example:

(print-search-result (text-search "piano"
                                  :filter '(:duration (:range-to 2))
                                  :sort "rating_desc"
                                  :page-size 3
                                  :fields '("id" "name" "analysis")
                                  :descriptors '("lowlevel.spectral_centroid.mean"
                                                 "lowlevel.pitch.mean")))

Which prints:

Showing 3 results from a total of 943:

id:            442981
name:          Sol-G.m4a
analysis:      lowlevel:      spectral_cent: mean:          499.9333
                              pitch:         mean:          386.42862

id:            39210
name:          Piano ff 062.wav
analysis:      lowlevel:      spectral_cent: mean:          1047.3967
                              pitch:         mean:          933.2059

id:            337302
name:          MSfxP6 - 183 - One Shot Sound 3
analysis:      lowlevel:      spectral_cent: mean:          435.96042
                              pitch:         mean:          460.73337

As you can see, the response included the fields and descriptors chosen, and was limited to 3 results, as this was the page-size that we specified.

The descriptors (audio features) can also be used as the search query, with content-search:

(content-search '("lowlevel.pitch.mean" 220)
                :page-size 10
		:fields '("id" "tags"))

The results are sorted according to their distance from the descriptor value.

The target for content-search can also be another sound. In this case, the target sound's descriptors will be used as the search query, but it's possible to further limit the search using :descriptors-filter, which accepts the same constructs as :filter in text-search.

(content-search 39210
		:descriptors-filter '(("tonal.key_key" "\"A\"")
                                      ("tonal.key_strength" (:range-from 0.8))))

Note that for parameters that must be enclosed in double-quotes, we have to escape the double-quotes, like "A" above.

You can achieve the same kind of search with similar.

Finally, it's also possible to search in meta-data and audio features at the same time, with combined-search.

Sounds

Use info to get information on a sound from the Freesound database. For example:

(info 1234 :fields "filesize")

If you're calling info after performing a search, it's recommended that you include the fields parameter with the search request, removing the need to make an extra query for each individual result.

print-info is useful to quickly get the values at the REPL:

(print-info (info 213524
		  :fields '("name" "analysis")
		  :descriptors '("rhythm.bpm"
				 "lowlevel.mfcc.min"
				 "lowlevel.spectral_centroid.mean"
				 "tonal.hpcp_entropy.var")))

Prints:

name:          120 bpm distorded drum loop
analysis:      lowlevel:      spectral_cent: mean:          1313.7423
                              mfcc:          min:           (-1011.6488
                                                             -21.778429
                                                             -79.655426
                                                             -22.136934
                                                             -39.293144
                                                             -32.40432
                                                             -29.894882
                                                             -21.09641
                                                             -27.268171
                                                             -25.490017
                                                             -66.50812
                                                             -33.063526
                                                             -21.2058)
               tonal:         hpcp_entropy:  var:           0.45190468
               rhythm:        bpm:           119.80438

Use preview to download lossy versions of sounds:

(preview 678 "~/678.mp3")

And download for other formats, e.g.:

(download 345 (merge-pathnames (gethash "name" (info 345))
                               (user-homedir-pathname)))

You can also upload your sounds with upload, either describing them at the same time or using describe-sound later. Check the list of sounds pending approval with pending-uploads.

Note that OAuth2 authentication is required for downloading (but not with preview) and uploading.

Other functions that operate on sounds are comment, edit-sound-description, bookmark, and rate.

Users, packs, and more

There's a range of functions that return information on a Freesound user. Check the documentation. They start with user-.

Similarly, you can get information and operate on packs with the functions that start with pack-.

me returns information on the logged-in user, and descriptors returns the available audio descriptor names, organized by category.

Contributing

Feedback, questions, bug reports, pull requests, etc. are very welcomed!

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 `freesound`

Author

Nuno Trocado https://nunotrocado.com

Home Page

https://nunotrocado.com/freesound/

Source Control

(:git "https://github.com/ntrocado/freesound")

License

MIT

Description

A client for Freesound.org.

Version

1.0

Dependencies

alexandria
cl-ppcre
dexador
yason
trivial-open-browser

Source

freesound.asd (file)

Components

package.lisp (file)
freesound.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 `freesound.asd`

Location: freesound.asd
Systems: freesound (system)

3.1.2 `freesound/package.lisp`

Parent: freesound (system)
Location: package.lisp
Packages: freesound

3.1.3 `freesound/freesound.lisp`

Dependency

package.lisp (file)

Parent

freesound (system)

Location

freesound.lisp

Exported Definitions

*client-id* (special variable)
*oauth2-access-token* (special variable)
*oauth2-refresh-token* (special variable)
*token* (special variable)
analysis (function)
bookmark (function)
combined-search (function)
comment (function)
comments (function)
content-search (function)
describe-sound (function)
descriptors (function)
download (function)
edit-sound-description (function)
info (function)
me (function)
oauth2-authorize (function)
pack-download (function)
pack-instance (function)
pack-sounds (function)
pending-uploads (function)
preview (function)
print-info (function)
print-search-result (function)
rate (function)
similar (function)
text-search (function)
upload (function)
user-bookmark-categories (function)
user-packs (function)
user-sounds (function)

Internal Definitions

*root-uri* (special variable)
commas (function)
description-tags-format (function)
ensure-commas (function)
ensure-list-of-lists (function)
http-parameters (function)
oauth2-get-tokens (function)
optional-params-list (function)
parse-filter (function)
parse-target (function)
prepare-plist (function)
print-columns (function)
resource (function)
spaces (function)
system-relative-read-file (function)
translate-license (function)
translate-preview-format (function)
uri (function)
user-bookmark-category-sounds (function)
user-info (function)

4 Packages

Packages are listed by definition order.

4.1 `freesound`

Common Lisp client to the Freesound API.

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

*client-id* (special variable)
*oauth2-access-token* (special variable)
*oauth2-refresh-token* (special variable)
*token* (special variable)
analysis (function)
bookmark (function)
combined-search (function)
comment (function)
comments (function)
content-search (function)
describe-sound (function)
descriptors (function)
download (function)
edit-sound-description (function)
info (function)
me (function)
oauth2-authorize (function)
pack-download (function)
pack-instance (function)
pack-sounds (function)
pending-uploads (function)
preview (function)
print-info (function)
print-search-result (function)
rate (function)
similar (function)
text-search (function)
upload (function)
user-bookmark-categories (function)
user-packs (function)
user-sounds (function)

Internal Definitions

*root-uri* (special variable)
commas (function)
description-tags-format (function)
ensure-commas (function)
ensure-list-of-lists (function)
http-parameters (function)
oauth2-get-tokens (function)
optional-params-list (function)
parse-filter (function)
parse-target (function)
prepare-plist (function)
print-columns (function)
resource (function)
spaces (function)
system-relative-read-file (function)
translate-license (function)
translate-preview-format (function)
uri (function)
user-bookmark-category-sounds (function)
user-info (function)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *client-id*

An alphanumeric string issued by Freesound, used as part of OAuth2 authentication.

Package: freesound
Source: freesound.lisp (file)

Special Variable: *oauth2-access-token*

An alphanumeric string used as an access token for OAuth2 restricted resources. Call ‘oauth2-get-tokens‘ to initialize.

Package: freesound
Source: freesound.lisp (file)

Special Variable: *oauth2-refresh-token*

An alphanumeric string used to get a new OAuth2 access token, without starting the whole authentication process. Call ‘oauth2-get-tokens‘ to initialize. To refresh the OAuth2 access token, pass this to ‘oauth2-get-tokens‘ with ‘:refresh t‘.

Package: freesound
Source: freesound.lisp (file)

Special Variable: *token*

An alphanumeric string issued by Freesound to authenticate API calls.

Package: freesound
Source: freesound.lisp (file)

5.1.2 Functions

Function: analysis SOUND-ID &key DESCRIPTORS NORMALIZED

Retrieve analysis information (content-based descriptors) on SOUND-ID.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id58

Package: freesound
Source: freesound.lisp (file)

Function: bookmark SOUND-ID &key NAME CATEGORY

Bookmark an existing sound SOUND-ID. The sound will be bookmarked by the Freesound user logged in using OAuth2, therefore this method requires OAuth2 authentication.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id66

Package: freesound
Source: freesound.lisp (file)

Function: combined-search &key QUERY FILTER SORT TARGET DESCRIPTORS-FILTER PAGE PAGE-SIZE FIELDS DESCRIPTORS NORMALIZED

Perform a combination of text search and content search, returning a hash-table with the sound list response.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id55

See ‘text-search‘ and ‘content-search‘.

Package: freesound
Source: freesound.lisp (file)

Function: comment SOUND-ID COMMENT

Post a COMMENT to an existing sound SOUND-ID. The comment will appear to be made by the Freesound user logged in using OAuth2.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id68

Package: freesound
Source: freesound.lisp (file)

Function: comments SOUND-ID &key PAGE PAGE-SIZE

Retrieves comments for SOUND-ID.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id60

Package: freesound
Source: freesound.lisp (file)

Function: content-search TARGET &key DESCRIPTORS-FILTER PAGE PAGE-SIZE FIELDS DESCRIPTORS NORMALIZED

Search sounds based on their content descriptors, returning a hash-table with the sound list response.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id54

The filter syntax described in ‘text-search‘ also applies to DESCRIPTORS-FILTER.

Package: freesound
Source: freesound.lisp (file)

Function: describe-sound UPLOAD-FILENAME TAGS DESCRIPTION LICENSE &key NAME PACK GEOTAG

Describe a previously uploaded audio file that has not yet been described. OAuth2 required.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id63

LICENSE is either one of the strings accepted by the API, or one of the following: :attribution, :attribution-noncommercial, :creative-commons.

Package: freesound
Source: freesound.lisp (file)

Function: descriptors ()

Information about the available audio descriptors that are extracted from Freesound sounds.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id81

Package: freesound
Source: freesound.lisp (file)

Function: download SOUND-ID PATHNAME &key IF-EXISTS IF-DOES-NOT-EXIST

Download SOUND-ID into PATHNAME. Keyword options are as in ‘open‘. OAuth2 required.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id61

Package: freesound
Source: freesound.lisp (file)

Function: edit-sound-description SOUND-ID &key NAME TAGS DESCRIPTION LICENSE PACK GEOTAG

Edit the description of an already existing sound. Note that this resource can only be used to edit descriptions of sounds created by the Freesound user logged in using OAuth2.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id65

LICENSE is either one of the strings accepted by the API, or one of the following: :attribution, :attribution-noncommercial, :creative-commons.

Package: freesound
Source: freesound.lisp (file)

Function: info SOUND-ID &key FIELDS DESCRIPTORS NORMALIZED

Retrieve information about SOUND-ID.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id57

Package: freesound
Source: freesound.lisp (file)

Function: me ()

Information about the user that is logged in using the OAuth2 procedure.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id80

Package: freesound
Source: freesound.lisp (file)

Function: oauth2-authorize &optional CLIENT-ID

As the first step of OAuth2 authentication, open the default browser on a Freesound page, where users are prompted to log in and asked to give permission for the application. The url is also printed to standard output.

Package: freesound
Source: freesound.lisp (file)

Function: pack-download PACK-ID PATHNAME &key IF-EXISTS IF-DOES-NOT-EXIST

Download PACK-ID into PATHNAME. Keyword options are as in ‘open‘. OAuth2 required.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id78

Package: freesound
Source: freesound.lisp (file)

Function: pack-instance PACK-ID

Retrieve information about the pack PACK-ID.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id76

Package: freesound
Source: freesound.lisp (file)

Function: pack-sounds PACK-ID &key PAGE PAGE-SIZE FIELDS DESCRIPTORS NORMALIZED

Retrieve information about the sounds included in the pack PACK-ID.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id77

Package: freesound
Source: freesound.lisp (file)

Function: pending-uploads ()

Retrieve a list of audio files uploaded by the Freesound user logged in using OAuth2 that have not yet been described, processed or moderated.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id64

Package: freesound
Source: freesound.lisp (file)

Function: preview SOUND-ID PATHNAME &key FORMAT

Download a lossy version of SOUND-ID, writing it to PATHNAME. FORMAT is either :hq-mp3, :hq-ogg, :lq-mp3, :lq-ogg, where "hq" is higher quality and "lq" lower quality.

Package: freesound
Source: freesound.lisp (file)

Function: print-info INFO &optional STREAM

Pretty print INFO, which is the response to ‘info‘ (sound instance) or to ‘analysis‘.

Package: freesound
Source: freesound.lisp (file)

Function: print-search-result SEARCH-RESULT &optional STREAM

Pretty print SEARCH-RESULT, a sound list response.

Package: freesound
Source: freesound.lisp (file)

Function: rate SOUND-ID RATING

Rate an existing sound SOUND-ID with RATING, between 0 and 5 (where 5 is the maximum). The sound will be rated by the Freesound user logged in using OAuth2.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id67

Package: freesound
Source: freesound.lisp (file)

Function: similar SOUND-ID &key DESCRIPTORS-FILTER PAGE PAGE-SIZE FIELDS DESCRIPTORS NORMALIZED

Retrieve sounds similar to SOUND-ID, returning a hash table with the sound list response.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id59

The filter syntax described in ‘text-search‘ also applies to DESCRIPTORS-FILTER.

Package: freesound
Source: freesound.lisp (file)

Function: text-search QUERY &key FILTER SORT GROUP-BY-PACK PAGE PAGE-SIZE FIELDS DESCRIPTORS NORMALIZED

Search sounds by matching their tags and other kids of metadata, returning a hash-table with the sound list response.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id53

FILTER is either a string conforming to the API syntax, or a list of key/value pairs. For example:
(text-search "trumpet" :filter ’((:type "ogg") (:channels 2)))

Each filter property can be further specified with the operators :and, :or, :range, :range-to, and :range-from. For example: (text-search "rain"
:filter ’((:tag (:and "soundscape" "forest"))
(:created (:range-from "2010-12-01T23:59:59.999Z"))
(:duration (:range 10 120))))

Package: freesound
Source: freesound.lisp (file)

Function: upload FILE &key NAME TAGS DESCRIPTION LICENSE PACK GEOTAG

Upload an audio FILE into Freesound and (optionally) describe it. If a description is intended, all of TAGS, DESCRIPTION and LICENSE are required. OAuth2 required.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id62

LICENSE is either one of the strings accepted by the API, or one of the following: :attribution, :attribution-noncommercial, :creative-commons.

Package: freesound
Source: freesound.lisp (file)

Function: user-bookmark-categories USERNAME &key PAGE PAGE-SIZE

Retrieve the bookmark categories uploaded by Freesound user USERNAME, returning a hash table with the sound list response.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id73

Package: freesound
Source: freesound.lisp (file)

Function: user-packs USERNAME &key PAGE PAGE-SIZE

Retrieve information about the packs uploaded by Freesound user USERNAME, returning a hash table with the sound list response.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id72

Package: freesound
Source: freesound.lisp (file)

Function: user-sounds USERNAME &key PAGE PAGE-SIZE FIELDS DESCRIPTORS NORMALIZED

Retrieve information about the sounds uploaded by Freesound user USERNAME, returning a hash table with the sound list response.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id71

Package: freesound
Source: freesound.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *root-uri*

Package: freesound
Source: freesound.lisp (file)

5.2.2 Functions

Function: commas LST

Package: freesound
Source: freesound.lisp (file)

Function: description-tags-format TAGS

Package: freesound
Source: freesound.lisp (file)

Function: ensure-commas IN

Package: freesound
Source: freesound.lisp (file)

Function: ensure-list-of-lists LST

Package: freesound
Source: freesound.lisp (file)

Function: http-parameters PLIST

Package: freesound
Source: freesound.lisp (file)

Function: oauth2-get-tokens CODE &key TOKEN CLIENT-ID REFRESH

Return the OAuth2 access token and a refresh token. CODE is either the initial authorization code, or a previously generated refresh token. In this second case, REFRESH must be T. Also set *oauth2-access-token* to the new value.

Package: freesound
Source: freesound.lisp (file)

Function: optional-params-list NAMES PARAMS

Package: freesound
Source: freesound.lisp (file)

Function: parse-filter FILTER

Package: freesound
Source: freesound.lisp (file)

Function: parse-target TARGET

Package: freesound
Source: freesound.lisp (file)

Function: prepare-plist PLIST

Package: freesound
Source: freesound.lisp (file)

Function: print-columns K V LEVEL STREAM

Package: freesound
Source: freesound.lisp (file)

Function: resource URI &key METHOD CONTENT AUTHENTICATION TOKEN OAUTH2-ACCESS-TOKEN

Package: freesound
Source: freesound.lisp (file)

Function: spaces STRING

Package: freesound
Source: freesound.lisp (file)

Function: system-relative-read-file FILENAME

Package: freesound
Source: freesound.lisp (file)

Function: translate-license LICENSE

Package: freesound
Source: freesound.lisp (file)

Function: translate-preview-format FORMAT

Package: freesound
Source: freesound.lisp (file)

Function: uri RESOURCE &optional ROOT

Package: freesound
Source: freesound.lisp (file)

Function: user-bookmark-category-sounds USERNAME &key BOOKMARK-CATEGORY-ID PAGE PAGE-SIZE FIELDS DESCRIPTORS NORMALIZED

Retrieve information about the sounds from a bookmark category created by Freesound user USERNAME, returning a hash table with the sound list response.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id74

Package: freesound
Source: freesound.lisp (file)

Function: user-info USERNAME

Retrieve information about Freesound user USERNAME.

API documentation: https://freesound.org/docs/api/resources_apiv2.html#id70

Package: freesound
Source: freesound.lisp (file)

Appendix A Indexes

A.1 Concepts

Jump to:	F L

	Index Entry	Section

F
	File, Lisp, `freesound.asd`:	The freesound․asd file
	File, Lisp, `freesound/freesound.lisp`:	The freesound/freesound․lisp file
	File, Lisp, `freesound/package.lisp`:	The freesound/package․lisp file
	`freesound.asd`:	The freesound․asd file
	`freesound/freesound.lisp`:	The freesound/freesound․lisp file
	`freesound/package.lisp`:	The freesound/package․lisp file

L
	Lisp File, `freesound.asd`:	The freesound․asd file
	Lisp File, `freesound/freesound.lisp`:	The freesound/freesound․lisp file
	Lisp File, `freesound/package.lisp`:	The freesound/package․lisp file

Jump to:	F L

A.2 Functions

Jump to:	A B C D E F H I M O P R S T U

	Index Entry	Section

A
	`analysis`:	Exported functions

B
	`bookmark`:	Exported functions

C
	`combined-search`:	Exported functions
	`commas`:	Internal functions
	`comment`:	Exported functions
	`comments`:	Exported functions
	`content-search`:	Exported functions

D
	`describe-sound`:	Exported functions
	`description-tags-format`:	Internal functions
	`descriptors`:	Exported functions
	`download`:	Exported functions

E
	`edit-sound-description`:	Exported functions
	`ensure-commas`:	Internal functions
	`ensure-list-of-lists`:	Internal functions

F
	`Function, analysis`:	Exported functions
	`Function, bookmark`:	Exported functions
	`Function, combined-search`:	Exported functions
	`Function, commas`:	Internal functions
	`Function, comment`:	Exported functions
	`Function, comments`:	Exported functions
	`Function, content-search`:	Exported functions
	`Function, describe-sound`:	Exported functions
	`Function, description-tags-format`:	Internal functions
	`Function, descriptors`:	Exported functions
	`Function, download`:	Exported functions
	`Function, edit-sound-description`:	Exported functions
	`Function, ensure-commas`:	Internal functions
	`Function, ensure-list-of-lists`:	Internal functions
	`Function, http-parameters`:	Internal functions
	`Function, info`:	Exported functions
	`Function, me`:	Exported functions
	`Function, oauth2-authorize`:	Exported functions
	`Function, oauth2-get-tokens`:	Internal functions
	`Function, optional-params-list`:	Internal functions
	`Function, pack-download`:	Exported functions
	`Function, pack-instance`:	Exported functions
	`Function, pack-sounds`:	Exported functions
	`Function, parse-filter`:	Internal functions
	`Function, parse-target`:	Internal functions
	`Function, pending-uploads`:	Exported functions
	`Function, prepare-plist`:	Internal functions
	`Function, preview`:	Exported functions
	`Function, print-columns`:	Internal functions
	`Function, print-info`:	Exported functions
	`Function, print-search-result`:	Exported functions
	`Function, rate`:	Exported functions
	`Function, resource`:	Internal functions
	`Function, similar`:	Exported functions
	`Function, spaces`:	Internal functions
	`Function, system-relative-read-file`:	Internal functions
	`Function, text-search`:	Exported functions
	`Function, translate-license`:	Internal functions
	`Function, translate-preview-format`:	Internal functions
	`Function, upload`:	Exported functions
	`Function, uri`:	Internal functions
	`Function, user-bookmark-categories`:	Exported functions
	`Function, user-bookmark-category-sounds`:	Internal functions
	`Function, user-info`:	Internal functions
	`Function, user-packs`:	Exported functions
	`Function, user-sounds`:	Exported functions

H
	`http-parameters`:	Internal functions

I
	`info`:	Exported functions

M
	`me`:	Exported functions

O
	`oauth2-authorize`:	Exported functions
	`oauth2-get-tokens`:	Internal functions
	`optional-params-list`:	Internal functions

P
	`pack-download`:	Exported functions
	`pack-instance`:	Exported functions
	`pack-sounds`:	Exported functions
	`parse-filter`:	Internal functions
	`parse-target`:	Internal functions
	`pending-uploads`:	Exported functions
	`prepare-plist`:	Internal functions
	`preview`:	Exported functions
	`print-columns`:	Internal functions
	`print-info`:	Exported functions
	`print-search-result`:	Exported functions

R
	`rate`:	Exported functions
	`resource`:	Internal functions

S
	`similar`:	Exported functions
	`spaces`:	Internal functions
	`system-relative-read-file`:	Internal functions

T
	`text-search`:	Exported functions
	`translate-license`:	Internal functions
	`translate-preview-format`:	Internal functions

U
	`upload`:	Exported functions
	`uri`:	Internal functions
	`user-bookmark-categories`:	Exported functions
	`user-bookmark-category-sounds`:	Internal functions
	`user-info`:	Internal functions
	`user-packs`:	Exported functions
	`user-sounds`:	Exported functions

Jump to:	A B C D E F H I M O P R S T U

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`client-id`:	Exported special variables
	`oauth2-access-token`:	Exported special variables
	`oauth2-refresh-token`:	Exported special variables
	`root-uri`:	Internal special variables
	`token`:	Exported special variables

S
	`Special Variable, client-id`:	Exported special variables
	`Special Variable, oauth2-access-token`:	Exported special variables
	`Special Variable, oauth2-refresh-token`:	Exported special variables
	`Special Variable, root-uri`:	Internal special variables
	`Special Variable, token`:	Exported special variables

Jump to:	* S

A.4 Data types

Jump to:	F P S

	Index Entry	Section

F
	`freesound`:	The freesound system
	`freesound`:	The freesound package

P
	`Package, freesound`:	The freesound package

S
	`System, freesound`:	The freesound system

Jump to:	F P S

• Introduction		What freesound is all about
• Systems		The systems documentation
• Files		The files documentation
• Packages		The packages documentation
• Definitions		The symbols documentation
• Indexes		Concepts, functions, variables and data types

• Concept index
• Function index
• Variable index
• Data type index

• The freesound.asd file
• The freesound/package.lisp file
• The freesound/freesound.lisp file

The freesound Reference Manual

Table of Contents

The freesound Reference Manual

1 Introduction

Common Lisp client for the Freesound API

Installing and loading

Authentication

Token authentication

OAuth2 authentication

Documentation

Overview and examples

Searching

Sounds

Users, packs, and more

Contributing

2 Systems

2.1 freesound

3 Files

3.1 Lisp

3.1.1 freesound.asd

3.1.2 freesound/package.lisp

3.1.3 freesound/freesound.lisp

4 Packages

4.1 freesound

5 Definitions

5.1 Exported definitions

5.1.1 Special variables

5.1.2 Functions

5.2 Internal definitions

5.2.1 Special variables

5.2.2 Functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `freesound`

3.1.1 `freesound.asd`

3.1.2 `freesound/package.lisp`

3.1.3 `freesound/freesound.lisp`

4.1 `freesound`