freesound-juce
A JUCE client for accessing the Freesound API
Public Member Functions | Public Attributes | List of all members
FSSound Class Reference

A class which implements the Sound instance. More...

#include <FreesoundAPI.h>

Public Member Functions

 FSSound ()
 Default constructor, creates an empty FSSound object. More...
 
 FSSound (var sound)
 Constructor from the response of a sound instance request. More...
 
URL getDownload ()
 Gets the sound download URL. More...
 

Public Attributes

String id
 The sound’s unique identifier.
 
URL url
 The URI for this sound on the Freesound website.
 
String name
 The name user gave to the sound.
 
StringArray tags
 An array of tags the user gave to the sound.
 
String description
 The description the user gave to the sound.
 
String geotag
 Latitude and longitude of the geotag separated by spaces.
 
String created
 The date when the sound was uploaded.
 
String license
 The license under which the sound is available.
 
String format
 The type of sound (wav, aif, aiff, mp3, m4a or flac)
 
int channels
 The number of channels.
 
int filesize
 The size of the file in bytes.
 
int bitrate
 The bit rate of the sound in kbps.
 
int bitdepth
 The bit depth of the sound.
 
int duration
 The duration of the sound in seconds.
 
int samplerate
 The samplerate of the sound.
 
String user
 The username of the uploader of the sound.
 
URL pack
 If the sound is part of a pack, this URI points to that pack’s API resource.
 
URL download
 The URI for retrieving the original sound.
 
URL bookmark
 The URI for bookmarking the sound.
 
var previews
 Dictionary containing the URIs for mp3 and ogg versions of the sound.
 
var images
 Dictionary including the URIs for spectrogram and waveform visualizations of the sound.
 
int numDownloads
 The number of times the sound was downloaded.
 
float avgRating
 The average rating of the sound.
 
int numRatings
 The number of times the sound was rated.
 
URL rate
 The URI for rating the sound.
 
URL comments
 The URI of a paginated list of the comments of the sound.
 
int numComments
 The number of comments.
 
URL comment
 The URI to comment the sound.
 
URL similarSounds
 URI pointing to the similarity resource (to get a list of similar sounds)
 
var analysis
 Dictionary containing requested descriptors information according to the descriptors request parameter.
 
URL analysisStats
 URI pointing to the complete analysis results of the sound.
 
URL analysisFrames
 The URI for retrieving a JSON file with analysis information for each frame of the sound.
 
var acAnalysis
 Dictionary containing the results of the AudioCommons analysis for the given sound.
 

Detailed Description

A class which implements the Sound instance.

Author
Antonio
Date
09/07/2019

Constructor & Destructor Documentation

◆ FSSound() [1/2]

FSSound::FSSound ( )

Default constructor, creates an empty FSSound object.

Author
Antonio
Date
09/07/2019

◆ FSSound() [2/2]

FSSound::FSSound ( var  sound)

Constructor from the response of a sound instance request.

Author
Antonio
Date
09/07/2019
Parameters
soundThe response of a sound instance request

Member Function Documentation

◆ getDownload()

URL FSSound::getDownload ( )

Gets the sound download URL.

Author
Antonio
Date
09/07/2019
Returns
The sound download URL.

The documentation for this class was generated from the following files: