Developer Portal
Quick StartsComposition scriptingAPIs and SDKsSupport
  • Portal overview
  • Quick start
  • REST API
    • Introduction
    • Rate limits
    • Authorization
    • How-to guides
      • Get a control app's API token
      • Get a composition's sub-composition IDs and names and their payload structures
      • Get a control app's model
      • Get a control app's metadata
      • Update a sub-composition's content
      • Update a sub-composition's animation state
      • Update a sub-composition's content and animation state in one call
      • Update multiple sub-compositions in one call
    • API reference
      • Get control app details
        • Get a control app's metadata
        • Get a control app's model
        • Get a control app's control data
      • Send data to a control app
        • Update a control app's content
        • Update a control app's animation state
      • Take out all of an app's output
  • Data stream API
    • Introduction
    • Rate limits
    • Authorization
    • How-to guides
      • Create a data stream
      • Link a data stream to a composition
      • Send data to an app using the data stream API
    • API reference
  • Composition scripting
    • Introduction
    • Overview
    • Quick start
      • Find sub-compositions and widgets
      • Read and update control nodes
      • Set text widget text properties
      • Read and update widget properties
      • Read control nodes and update widget properties
      • Set image widget URL property
      • Set table widget content property
    • Cheat sheets
      • Fundamentals
      • Interactive overlays
      • Best practices
    • Use cases
      • Read control nodes and generate HTML text
      • Read control nodes, generate HTML text with background
      • Text Ticker - Start ticker on "In" animation
    • Composition script editor reference
  • Software development kits
    • Graphics SDK
      • Getting started
      • Reference
        • SDK functions
        • Composition object
        • Sequencer object
      • Guides and examples
        • Load a composition with its token
        • Load a composition with its URL
        • Get the composition URL of an app instance
        • Sequencer VOD example
        • Control local preview of app
        • Load app instance output
    • Overlay SDK
      • Getting started
      • SDK functions
      • Use case examples
    • Widget SDK
      • Preparing your environment
      • Getting started
      • Reference
        • Widget UI definition
        • Widget callback functions
        • Time control object
        • Composition instance
      • Guides and examples
        • Widget example: CSS patterns
    • App SDK
  • Singular Basics
    • Overview of Singular
    • Managing overlays in the Dashboard
      • How to create a new composition
      • How to open a new app template
      • How to create an app for a composition
      • How to extract a composition from an app
      • How to find an app's shared app token and shared API URL
      • Dashboard reference
    • Building overlays in Composer
      • How to build a composition
      • How to set up layer logic to automate overlay transitions
      • How to set up control nodes to make widget properties available to a control app
      • Animating overlays
        • How to create timeline animations
        • How to create behavior animations
        • How to create update animations
      • How to make overlays interactive
      • How to adapt overlays to various screen sizes
      • Composer reference
    • Controlling overlays in Studio and UNO
      • How to use Studio
      • Studio reference
      • UNO reference
  • Support
    • Singular status
    • Support resources
    • Singular terminology
    • Performance Testing
Powered by GitBook
On this page
  • Properties
  • Methods
  • play(time)
  • seek(time)
  • setDuration(duration)
  • setPayload(payload)
  • start()
  • stop()

Was this helpful?

  1. Software development kits
  2. Graphics SDK
  3. Reference

Sequencer object

Properties

Name
Type
Example
Description

seqId

String

"-N8o2dhQeHQXZ6Emr2I7"

The ID of a sequencer.

Methods

The sequencer object has the following methods:

Method
Return type
Description

-

Plays a sequence to time.

-

Seeks a sequence to time.

-

Sets the duration of a sequence.

-

Sets a sequencer payload.

-

Starts playing a sequence.

-

Stops playing a sequence.

play(time)

Plays a sequence to a specified time.

Parameters

Name
Type
Description

time

number

Time in seconds.

sequencer.play(10.5);

See also

seek(time)

Seeks a sequence to a specified time.

Parameters

Name
Type
Description

time

number

Time in seconds.

sequencer.seek(10.5);

See also

setDuration(duration)

Sets the duration of a sequence.

Parameters

Name
Type
Description

duration

number

Duration in seconds.

sequencer.setDuration(120.0);

See also

setPayload(payload)

Sets the payload of a sequence.

Parameters

Name
Type
Description

payload

JSON

A payload defining a sequence's data and timing.

const payload = {
  "2ed116aa-bb56-49a5-adc4-37f7654312a8": [{
    "beginTime": 2,
    "endTime": 5,
    "controlNode": {
      "payload": {
        "Text": "This is headline 1"
      }
    }
  }, {
    "beginTime": 5,
    "endTime": 9,
    "controlNode": {
      "payload": {
        "Text": "This is headline 2"
      }
    }
  }],
  "dce1e90c-1d8d-4854-87e0-da8eed153105": [{
    "beginTime": 7,
    "endTime": 10,
    "controlNode": {
      "payload": {
        "Image": "https://assets.singular.live/7072b13f9e20b98034f48d6202400ff9/svgs/57VdHBnRTPNEU4yirlLfKm_w880h146.svg",
        "Image Size": "100",
        "Title": "A panel on the left size"
      }
    }
  }]
};

sequencer.setPayload(payload);

See also

start()

Starts playing a sequence.

stop()

Stops playing a sequence.

PreviousComposition objectNextGuides and examples

Last updated 2 years ago

Was this helpful?

getSequencer
seek
start
stop
getSequencer
play
start
stop
getSequencer
setPayload
getSequencer
setDuration
play(time)
seek(time)
setDuration(duration)
setPayload(payload)
start()
stop()