SOUNDS_API.md

Sounds API

• Sounds API
  • Get All Sounds
  • Get Company Sounds
  • Get Recommended Sounds

Get All Sounds

Retrieves sounds given the duration.

If the authorization is not present, then response limits to 5.

const RenderforestClient = require('@renderforest/sdk-node')

RenderforestClient.getCompanySoundsLimited({ duration: 4 })
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

See example

With authorization it's possible to fetch all sounds.

Get Company Sounds

Retrieves company sounds with the given duration.

If no duration specified, an empty array is returned.

const RenderforestClient = require('@renderforest/sdk-node')

const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })

Renderforest.getCompanySounds({ duration: 4 })
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

• The sounds will have greater or equal duration to the specified one.
• Remember — any given value of the duration greater than 180 will be overridden by 180!

See example

const RenderforestClient = require('@renderforest/sdk-node')

const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })

Renderforest.getSounds({ duration: 4 })
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

• The sounds will have greater or equal duration to the specified one.
• Remember — any given value of the duration greater than 180 will be overridden by 180!

See example

Get Recommended Sounds

Retrieves recommended sounds for the given template.

If the authorization is not present, then response limits to 5.

const RenderforestClient = require('@renderforest/sdk-node')

RenderforestClient.getRecommendedSoundsLimited(701, { duration: 5 })
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

See example

With authorization it's possible to fetch all recommended sounds.

const RenderforestClient = require('@renderforest/sdk-node')

const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })

Renderforest.getRecommendedSounds(701, { duration: 5 })
  .then(console.log) // handle the success
  .catch(console.error) // handle the error

• These sounds will have greater or equal duration to the specified one.
• Remember — any given value of the duration greater than 180 will be overridden by 180!

See example

⬆ back to the top