This is the freesound Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 05:05:50 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
freesoundA client for Freesound.org.
Nuno Trocado https://nunotrocado.com
(GIT https://github.com/ntrocado/freesound)
MIT
1.0
alexandria (system).
cl-ppcre (system).
dexador (system).
yason (system).
trivial-open-browser (system).
package.lisp (file).
freesound.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
freesound/freesound.lisppackage.lisp (file).
freesound (system).
*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).
*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).
Packages are listed by definition order.
freesoundCommon Lisp client to the Freesound API.
common-lisp.
*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).
*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).
Definitions are sorted by export status, category, package, and then by lexicographic order.
An alphanumeric string issued by Freesound, used as part of OAuth2 authentication.
An alphanumeric string used as an access token for OAuth2 restricted resources. Call ‘oauth2-get-tokens‘ to initialize.
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‘.
An alphanumeric string issued by Freesound to authenticate API calls.
Retrieve analysis information (content-based descriptors) on SOUND-ID.
API documentation: https://freesound.org/docs/api/resources_apiv2.html#id58
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
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‘.
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
Retrieves comments for SOUND-ID.
API documentation: https://freesound.org/docs/api/resources_apiv2.html#id60
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.
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.
Information about the available audio descriptors that are extracted from Freesound sounds.
API documentation: https://freesound.org/docs/api/resources_apiv2.html#id81
Download SOUND-ID into PATHNAME. Keyword options are as in ‘open‘. OAuth2 required.
API documentation: https://freesound.org/docs/api/resources_apiv2.html#id61
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.
Retrieve information about SOUND-ID.
API documentation: https://freesound.org/docs/api/resources_apiv2.html#id57
Information about the user that is logged in using the OAuth2 procedure.
API documentation: https://freesound.org/docs/api/resources_apiv2.html#id80
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.
Download PACK-ID into PATHNAME. Keyword options are as in ‘open‘. OAuth2 required.
API documentation: https://freesound.org/docs/api/resources_apiv2.html#id78
Retrieve information about the pack PACK-ID.
API documentation: https://freesound.org/docs/api/resources_apiv2.html#id76
Retrieve information about the sounds included in the pack PACK-ID.
API documentation: https://freesound.org/docs/api/resources_apiv2.html#id77
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
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.
Pretty print INFO, which is the response to ‘info‘ (sound instance) or to ‘analysis‘.
Pretty print SEARCH-RESULT, a sound list response.
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
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.
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))))
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.
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
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
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
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.
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
Retrieve information about Freesound user USERNAME.
API documentation: https://freesound.org/docs/api/resources_apiv2.html#id70
| Jump to: | A B C D E F H I M O P R S T U |
|---|
| Jump to: | A B C D E F H I M O P R S T U |
|---|
| Jump to: | *
S |
|---|
| Jump to: | *
S |
|---|
| Jump to: | F P S |
|---|
| Jump to: | F P S |
|---|