Freesound

Value Members

1. final def !=(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

2. final def ##(): Int

   

   Definition Classes

   AnyRef → Any

3. final def ==(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

4. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

5. def clone(): AnyRef

   

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... )

6. def download(id: Int, out: File)(implicit auth: Auth): Processor[Unit]

   

   Downloads a sound file in its original quality.

   Downloads a sound file in its original quality.

   id

   the identifier of the sound (i.e. Sound#id)

   out

   the file to write to

7. def downloadUriToFile(uri: URI, out: File)(implicit client: Client): Processor[Unit]

   

   Downloads a file, such as the sound file preview in its reduced preview quality.

   Downloads a file, such as the sound file preview in its reduced preview quality.

   uri

   the URI to the file, e.g. as obtained from a Preview instance.

   out

   the file to write to

8. final def eq(arg0: AnyRef): Boolean

   

   Definition Classes

   AnyRef

9. def equals(arg0: Any): Boolean

   

   Definition Classes

   AnyRef → Any

10. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

11. def getAuth(code: String)(implicit client: Client): Future[Auth]

    

    Given an authorization code obtained by the user via https://www.freesound.org/apiv2/oauth2/authorize/?client_id=XXX&response_type=code requests actual access keys.

12. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

13. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

14. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

15. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

16. final def notify(): Unit

    

    Definition Classes

    AnyRef

17. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

18. def readAuth(f: File = file("auth.json")): Auth

    

    Reads a Json file containing authorization access.

19. def readClient(f: File = file("client.json")): Client

    

    Reads a Json file containing an object with fields id and secret, specifying a client or application's access keys to Freesound (http://www.freesound.org/apiv2/apply).

20. def refreshAuth()(implicit client: Client, auth: Auth): Future[Auth]

    

    Given an existing access key that is or might expire, requests an fresh new access key.

21. final def synchronized[T0](arg0: ⇒ T0): T0

    

    Definition Classes

    AnyRef

22. def textCount(query: String, filter: Filter = Filter())(implicit client: Client): Future[Int]

    

    Performs a text-based search and returns the total count of matches.

    Performs a text-based search and returns the total count of matches.

    query

    the query term(s)

    filter

    a filter definition constraining the search results

23. def textSearch(query: String, filter: Filter = Filter(), sort: Sort = Sort.Score, groupByPack: Boolean = false, maxItems: Int = 100)(implicit client: Client): Future[IndexedSeq[Sound]]

    

    Performs a text-based search.

    Performs a text-based search.

    query

    the query term(s)

    filter

    a filter definition constraining the search results

    sort

    the order in which the results will be sorted

    groupByPack

    if true, groups results by sound pack (collection)

    maxItems

    the maximum number of result items to obtain. If the search yields more items that this number, only the first maxItems items will be received.

24. def toString(): String

    

    Definition Classes

    AnyRef → Any

25. val urlApiBase: String

    

26. var urlGetAuth: String

    

27. val urlHome: String

    

28. var urlImage: String

    

    URL for image renderings.

    URL for image renderings. Contains four %s placeholders: sound-id.div(1000), sound-id, user-id, wave_L.png-vs-wave_M.png-vs-spec_L.jpg-vs-spec_M.jpg

29. var urlSoundBrowse: String

    

    URL for inspecting the sound on the Freesound website.

    URL for inspecting the sound on the Freesound website. Two placeholders %s and %s will be replaced by the user-name and the sound id.

30. var urlSoundDownload: String

    

    URL for downloading a sound.

    URL for downloading a sound. A placeholder %s will be replaced by the sound id.

31. var urlSoundPreview: String

    

    URL for sound previews.

    URL for sound previews. Contains five %s placeholders: sound-id.div(1000), sound-id, user-id, lq-vs-hq, ogg-vs-mp3.

    Note: this should be removed, as the server organisation seems to be a moving target; instead we need the indirection via previews query field.

32. var urlTextSearch: String

    

    URL for starting a text search.

33. var urlWebAuthorize: String

    

    URL for web-based application authorization by user.

    URL for web-based application authorization by user. Contains one %s placeholder: The public client id (client.id).

34. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

35. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

36. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

37. def writeAuth(f: File = file("auth.json"))(implicit auth: Auth): Unit

    

    Writes a Json file containing authorization access.