SCREENS_API.md

Screens API

Table of Contents

• Screens API
  • Table of Contents
  • Getters
    • Get areas
    • Get area
    • Calculate screen duration
    • Get max possible duration
  • Setters
    • Set current screen id
    • Set duration
    • Toggle icon position
    • Set lower third settings
  • Return project data
  • Save

Getters

Get areas

Gets areas for current screen.

console.log(projectDataInstance.getScreen(0).getAreas()) // array of areas object

Get area

Gets area with given index for current screen.

console.log(projectDataInstance.getScreen(0).getArea(0)) // gets area with index 0 (first area)

Calculate screen duration

Calculates screen duration. It's useful when there is need to manually set screen duration.

console.log(projectDataInstance.getScreen(0).calculateScreenDuration())

Get max possible duration

Filters areas to find only video ones. Checks if count of video areas is more than 0, then counts sum of wordCounts. Otherwise returns maxDuration if there is one, or duration.

console.log(projectDataInstance.getScreen(0).getMaxPossibleDuration())

Setters

All the setters of screen instance can be called in chain.

Set current screen id

Renderforest.getProjectData(15220886)
  .then((projectDataInstance) =>
projectDataInstance.setCurrentScreenId(0)
      .save()
  )

Set duration

If screen's duration is not adjustable, then throws error. If given duration is more than max possible duration, then also throws error. Otherwise sets given value.

Renderforest.getProjectData(15220886)
  .then((projectDataInstance) => 
    projectDataInstance.getScreen(0)
      .setDuration(5)
      .save()
  )

Toggle icon position

If screen does not have icon adjustment, then throws error. Otherwise toggles icon position.

Renderforest.getProjectData(15220886)
  .then((projectDataInstance) => 
    projectDataInstance.setDuration(5)
      .toggleIconPosition()
      .save()
  )

See screen duration and toggle icon position adjustment example

Set lower third settings

If screen does'nt have lower third settings then throws error. Otherwise sets start and duration params for lower third settings.

Renderforest.getProjectData(15220886)
  .then((projectDataInstance) => 
      projectDataInstance.getScreen(0)
        .setLowerThirdSettings(2, 5)
        .save()
  )

See lower third settings adjustment example

Return project data

For project data manipulation sometimes there is need to step back from area object to project data for further development.

projectDataInstance.getScreen(0)
  .setLowerThirdSettings(2, 5)
  .returnProjectData()
  .getScreen(1)
  .setDuration(8)

Save

Save method works with the same logic as the project data one. From the hood it steps back project data then calls save method.

projectDataInstance.getScreen(0)
  .setLowerThirdSettings(2, 5)
  .returnProjectData()
  .getScreen(1)
  .setDuration(8)
  .save()

⬆ back to the top