index :: net

net.freesound

Freesound API v2 client

available since version: 0.9.8

---

information

1) create Freesound API credentials at: 2) save this id/secret pair into the file if using @oauth_file property or set @oauth_id/@oauth_secret properties explicitly or enter it with the editor 3) [access auth( get a temporal application code from the Freesound website (valid for ~24 hours) 4) [access code CODE( exchange this application code to the internal secret access token

methods:

• access auth get application authorization code (valid ~24 hours) from Freesound page: should open in web browser.
  

• access code exchange application authorization code to temp access token that will be used for every request. Note: you can do it only once, otherwise you need to get another application authorization code from Freesite site.
  parameters:
  • CODE application auth code. Copy it from from Freesound webpage!
    type: symbol
    required: True
    

• access load load temp access token (not OAuth id/secret!) from the special file from the current patch directory
  

• access store store temp access token (not OAuth id/secret!) into the special file in the current patch directory
  

• download download Freesound file
  parameters:
  • ID Freesound soundfile ID (get it from search result, for examples)
    type: int
    required: True
    
• load load Freesound file into Pd arrays
  parameters:

  • ID Freesound soundfile ID (get it from search result, for examples)
    type: int
    required: True
    

  • @array array name
    type: symbol
    required: True
    

  • [@norm] normalize sound
    type: bool
    

• me get and output user information
  

• search perform search
  parameters:

  • [@p] search page number
    type: int
    

  • [@n] number of results
    type: int
    

  • [@fields] requested fields
    type: symbol
    

  • [@sort] sort methods: "score", "duration_desc", "duration_asc", "created_desc", "created_asc", "downloads_desc", "downloads_asc", "rating_desc", "rating_asc"
    type: symbol
    

  • [@filter] filter expression, for example: @filter type mp3. See https://freesound.org/docs/api/resources_apiv2.html
    type: symbol
    

properties:

• @oauth_file (initonly) Get/set path to file with OAuth2 ID/secret, one per line
  type: symbol
  

• @oauth_id (initonly) Get/set Freesound OAuth2 ID
  type: symbol
  

• @oauth_secret (initonly) Get/set Freesound OAuth2 secret
  type: symbol
  

inlets:

• input
  type: control

outlets:

• messages: [user DICT( - user info, [progress VALUE( - download process information, [loaded( - when finished loading, [downloaded( - when file download is finished, [results DICT( - search result.
  type: control

keywords:

net freesound

Authors: Serge Poltavsky

License: GPL3 or later