Audio

API for communication with ZBOS by Zora Robotics.

Channels

zbos/audio/player/start

PUB Play media

Play specific media from audio options

Channel tags

  • Audio

AudioOptions
Payload

Name

Type

Description

Accepted values

requestId

string

Any

url

string

Any

loop

boolean

Any

cloudInfo

object

Any

cloudInfo. fileId

string

Any

cloudInfo. token

string

Any

randomRequestId

string

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

zbos/audio/player/stop

PUB Stop media

Channel tags

  • Audio

EmptyMessage

Empty message

zbos/audio/player/ended

SUB Media ended

Channel tags

  • Audio

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

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

zbos/audio/player/pause

PUB Pause media

Channel tags

  • Audio

EmptyMessage

Empty message

zbos/audio/player/resume

PUB Resume media

Channel tags

  • Audio

EmptyMessage

Empty message

zbos/audio/volume/set

PUB Set volume

Channel tags

  • Audio

Int
Payload

Name

Type

Description

Accepted values

Message Payload

integer

Any
Example of payload (generated)
100

zbos/audio/volume/get

PUB Get volume

see zbos/audio/volume/response/\{key} for response

Channel tags

  • Audio

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}

SUB response: Get volume

Channel tags

  • Audio

Int
Payload

Name

Type

Description

Accepted values

Message Payload

integer

Any
Example of payload (generated)
100

zbos/audio/volume/event

SUB event: Volume change

Notify subscribers of a volume change.

Channel tags

  • Audio

Int
Payload

Name

Type

Description

Accepted values

Message Payload

integer

Any
Example of payload (generated)
100

zbos/audio/beep

PUB Play beep

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

Channel tags

  • Audio

EmptyMessage

Empty message

zbos/audio/microphone/release

PUB Release the microphone

Request the microphone to be released from use by third-party apps.

Channel tags

  • Audio

EmptyMessage

Empty message