Audio

API for communication with ZBOS by Zora Robotics.

Channels

zbos/audio/player/start

publish

Play media

Play specific media from audio options

Channel tags
  • Audio

Message AudioOptions
Payload

Name

Type

Description

Accepted values

requestId

string

Any

url

string

Any

loop

boolean

Any

Examples of payload
{
  "requestId": "1",
  "url": "Url",
  "loop": true
}

zbos/audio/player/stop

publish

Stop media

Channel tags
  • Audio

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/audio/player/ended

subscribe

Media ended

Channel tags
  • Audio

Message String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any

Examples of payload
{
  "requestId": "1",
  "url": "Url"
}

zbos/audio/player/pause

publish

Pause media

Channel tags
  • Audio

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/audio/player/resume

publish

Resume media

Channel tags
  • Audio

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}

zbos/audio/volume/set

publish

Set volume

Channel tags
  • Audio

Message Int
Payload

Name

Type

Description

Accepted values

Message Payload

integer

Any

Example of payload (generated)
100

zbos/audio/volume/get

publish

Get volume

Channel tags
  • Audio

Message KeyResult

Random key

Payload

Name

Type

Description

Accepted values

key

string

Required random key

Any

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

zbos/audio/volume/response/{key}

subscribe

response: Get volume

Channel tags
  • Audio

Message Int
Payload

Name

Type

Description

Accepted values

Message Payload

integer

Any

Example of payload (generated)
100

zbos/audio/volume/event

subscribe

event: Volume change

Notify subscribers of a volume change.

Channel tags
  • Audio

Message Int
Payload

Name

Type

Description

Accepted values

Message Payload

integer

Any

Example of payload (generated)
100

zbos/audio/beep

publish

Play beep

Publish to play a beep sound. Used by the robot when the hot word is recognized.

Channel tags
  • Audio

Message EmptyMessage

Empty message

Payload

Name

Type

Description

Accepted values

Message Payload

object

Any

Example of payload (generated)
{}