Composer

API for communication with ZBOS by Zora Robotics.

Channels

zbos/composition/start

publish

Start composition

Payload is composition json

Channel tags
  • Composer

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/composition/start/id

publish

Start composition by id

Channel tags
  • Composer

Message CompositionStartRequest
Payload

Name

Type

Description

Accepted values

id

string

Any

settings

object

Any

settings.pinned

boolean

Any

settings.schedulerParallel

boolean

Any

variables

object

Any

Examples of payload
{
  "id": "string",
  "settings": {
    "pinned": false,
    "schedulerParallel": false
  },
  "variables": {
    "var1": "var1_value",
    "var2": "var2_value"
  }
}

zbos/{source}/start/event

subscribe

event: Composition started

Channel tags
  • Composer

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/{source}/stop

publish

Stop composition

Channel tags
  • Composer

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/{source}/stop/event

subscribe

event: Composition stopped

Channel tags
  • Composer

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/composition/pause

publish

Pause composition

Channel tags
  • Composer

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/composition/pause/event

subscribe

event: Composition paused

Timeline ID

Channel tags
  • Composer

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/composition/resume

publish

Resume composition

Channel tags
  • Composer

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/composition/resume/event

subscribe

event: Composition Resumed

Channel tags
  • Composer

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/{source}/loop/event

subscribe

event: Composition loop state

Channel tags
  • Composer

Message LoopProperty
Payload

Name

Type

Description

Accepted values

infinite

boolean

Any

repeatTimes

integer

Total loop count

Any

currentRepeatTimes

integer

current loop count

Any

Examples of payload
{
  "infinite": true,
  "currentRepeatTimes": 3
}

zbos/composition/settings

publish

Settings for a given composition

Channel tags
  • Composer

Message TimelinePropertiesWrapper
Payload

Name

Type

Description

Accepted values

properties

object

Any

properties.loop

object

Any

properties.loop.infinite

boolean

Any

properties.loop.repeatTimes

integer

Total loop count

Any

properties.loop.currentRepeatTimes

integer

current loop count

Any

properties.general

object

Any

properties.general.stoppable

boolean

Any

properties.general.powerManagement

object

  • DEFAULT

  • AWARE

  • DISABLED

properties.general.powerManagement.name

string

Any

properties.general.powerManagement.ordinal

integer

Any

timelineId

string

Composition ID

Any

isScheduler

boolean

Any

isPinned

boolean

Any

type

object

  • SIMPLE_COMPOSITION

  • ADVANCED_COMPOSITION

type.name

string

Any

type.ordinal

integer

Any

Examples of payload
{}

zbos/composition/save

publish

Save composition

Channel tags
  • Composer

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/composition/save/multiple

publish

Save multiple compositions

Channel tags
  • Composer

Message SaveMultipleCompositionRequest
Payload

Name

Type

Description

Accepted values

key

string

Required key

Any

compositions

array(object)

Array of compositions

Any

compositions.id

string

Any

compositions.name

string

Any

compositions.type

object

  • SIMPLE_COMPOSITION

  • ADVANCED_COMPOSITION

compositions.type.name

string

Any

compositions.type.ordinal

integer

Any

Examples of payload
{
  "compositions": [
    {
      "id": "string",
      "name": "string",
      "type": "SIMPLE_COMPOSITION"
    }
  ]
}

zbos/composition/save/event

subscribe

event: Composition Saved

Channel tags
  • Composer

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Examples of payload
"string"

zbos/composition/save/multiple/response/{key}

subscribe

response: Save multiple compositions

Channel tags
  • Composer

Message Map
Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/composition/load

publish

Load composition

Channel tags
  • Composer

Message CompositionLoadRequest
Payload

Name

Type

Description

Accepted values

id

string

Any

Examples of payload
{
  "id": "string"
}

zbos/composition/load/event

subscribe

event: Composition loaded

Channel tags
  • Composer

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/composition/list

publish

Get list of compositions

Channel tags
  • Composer

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/composition/list/event

subscribe

event: Get list of compositions

Channel tags
  • Composer

Message Array<SimpleComposition>
Payload

Name

Type

Description

Accepted values

Message Payload

array(object)

Any

Message Payload.id

string

Any

Message Payload.name

string

Any

Message Payload.type

object

  • SIMPLE_COMPOSITION

  • ADVANCED_COMPOSITION

Message Payload.type.name

string

Any

Message Payload.type.ordinal

integer

Any

Examples of payload
{
  "id": "string",
  "name": "string",
  "type": "SIMPLE_COMPOSITION"
}

zbos/composition/delete

publish

Delete composition by id

Channel tags
  • Composer

Message CompositionDeleteRequest
Payload

Name

Type

Description

Accepted values

id

string

Any

Examples of payload
{
  "id": "string"
}

zbos/composition/delete/all

publish

Deletes all compositions

Channel tags
  • Composer

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/composition/delete/response

subscribe

response: Delete composition

Channel tags
  • Composer

Message SuccessMessage

Success message

Payload

Name

Type

Description

Accepted values

success

boolean

Any

message

string

Optional error message

Any

Examples of payload
{
  "success": true
}

zbos/composition/changed/event

subscribe

event: Composition changed

Channel tags
  • Composer

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/composition/audio/stop

publish

Stop audio composition

Channel tags
  • Composer

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/composition/video/stop

publish

Stop video composition

Channel tags
  • Composer

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/composition/image/stop

publish

Stop image composition

Channel tags
  • Composer

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/composition/error

subscribe

event: Composition encountered error

List of possible error reasons: 'INVALID_ID': The block id is malformed/broken. 'INVALID_TYPE': The block type is malformed/broken. 'INVALID_BLOCK': One of the properties aside from id and type is malformed/broken.

Channel tags
  • Composer

Message CompositionError
Payload

Name

Type

Description

Accepted values

type

string

Block type that caused the error, 'UNKNOWN' if not known

Any

id

string

Block ID that caused the error, 'UNKNOWN' if not known

Any

reasons

array(string)

Any

Examples of payload
{
  "type": "string",
  "id": "string"
}

zbos/api/request

publish

Get api

see zbos/api/response/{key} for response

Channel tags
  • Composer

Message ApiRequestBlock
Payload

Name

Type

Description

Accepted values

name

string

Any

endpoint

string

Any

body

string

Any

params

object

Any

headers

object

Any

Examples of payload
{}

zbos/api/response/{key}

subscribe

response: Get api

Channel tags
  • Composer

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/composition/default/variable/request

publish

Get default composition variables

Payload "key" is optionalsee zbos/composition/default/variable/response/{key} for response

Channel tags
  • Composer

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

Examples of payload
{
  "key": "ABCxyz"
}

zbos/composition/default/variable/response/{key}

subscribe

response: Get default composition variables

Payload is array of variable names

Channel tags
  • Composer

Message Array<String>
Payload

Name

Type

Description

Accepted values

Message Payload

array(string)

Any

Example of payload (generated)
[
  "string"
]

zbos/composition/status/get

publish

Get composition statussee zbos/composition/status/response/{key} for response

Channel tags
  • Composer

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

Examples of payload
{
  "key": "ABCxyz"
}

zbos/composition/status/response/{key}

subscribe

response: Composition status

Channel tags
  • Composer

Message CompositionStatus
Payload

Name

Type

Description

Accepted values

id

string

Any

state

object

Default, playing or paused

  • DEFAULT

  • PLAYING

  • PAUSED

state.name

string

Any

state.ordinal

integer

Any

activeBlocks

array(string)

Any

properties

object

Composition properties

Any

properties.loop

object

Any

properties.loop.infinite

boolean

Any

properties.loop.repeatTimes

integer

Total loop count

Any

properties.loop.currentRepeatTimes

integer

current loop count

Any

properties.general

object

Any

properties.general.stoppable

boolean

Any

properties.general.powerManagement

object

  • DEFAULT

  • AWARE

  • DISABLED

properties.general.powerManagement.name

string

Any

properties.general.powerManagement.ordinal

integer

Any

playCount

integer

Current repeat iteration

Any

Examples of payload
{
  "id": "string",
  "state": "DEFAULT",
  "activeBlocks": [
    "string"
  ],
  "properties": {
    "loop": {
      "infinite": true,
      "currentRepeatTimes": 3
    },
    "general": {
      "powerManagement": "DEFAULT"
    }
  },
  "playCount": 5
}

zbos/composition/block/start

publish

Start composition block

Channel tags
  • Composer

Message Block
Payload

Name

Type

Description

Accepted values

id

string

Block ID

Any

index

integer

Any

blocking

boolean

Any

input

object

Any

input.connectors

array(object)

Any

input.connectors.id

string

Any

input.connectors.connection

object

Any

input.connectors.connection.blockId

string

Any

input.connectors.connection.connectorId

string

Any

output

object

Any

output.connectors

array(object)

Any

output.connectors.id

string

Any

output.connectors.connection

object

Any

output.connectors.connection.blockId

string

Any

output.connectors.connection.connectorId

string

Any

nextBlockId

string

Any

Examples of payload
{
  "index": 5,
  "blocking": false,
  "nextBlockId": "string"
}

zbos/{source}/block/start/event

subscribe

event: Composition block started

Channel tags
  • Composer

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/composition/block/stop

publish

Stop composition block

Block ID to stop, when key = "all", all active blocks will be stopped.

Channel tags
  • Composer

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

Examples of payload
{
  "key": "ABCxyz"
}

zbos/{source}/block/end/event

subscribe

event: Composition block ended

Channel tags
  • Composer

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"

zbos/{source}/block/pause/event

subscribe

event: Composition block paused

Channel tags
  • Composer

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Example of payload (generated)
"string"