Media

API for communication with ZBOS by Zora Robotics.

Channels

zbos/media/library/list

PUB List all media libraries

\[DEPRECATED] Please use zbos/media/library/list/get

Channel tags

  • Media

EmptyMessage

Empty message

zbos/media/library/list/event

SUB event: Listing all media libraries

Channel tags

  • Media

EmptyMessage

Empty message

zbos/media/library/list/get

PUB Get a list of media items

see zbos/media/library/list/response/\{key} for response

Channel tags

  • Media

FilteringRequest
Payload

Name

Type

Description

Accepted values

key

string

Any

limit

integer

Any

offset

integer

Any

filters

array (object)

Any

filters. field

string

Field to check on. Note that the field should be camelCase, not snake_case

Any

filters. value

string

Value to check on. For numbers you should use 'min' and 'max'.

Any

filters. min

number

Minimum value, only usable for number fields

Any

filters. max

number

Maximum value, only usable for number fields

Any

filters. direction

string

Direction to sort on. Can be 'asc' or 'desc'. The default direction is 'asc'

* asc * desc

filters. operator

string

Operator for either the child filters, or this filter object itself. Can be 'and', 'or' or 'not'. Default is 'and'. The root operator is always 'and'

* and * or * not

filters. match_type

string

Match type for string values. Can be 'exact', 'contains', 'starts_with', 'ends_with'. The default match_type is 'contains'

* exact * contains * starts_with * ends_with

filters. filters

array (object)

Filters on which the operator will be applied. If there are no child filters, the operator will be applied to the filter object itself.

Any

filters. field_filters

array (object)

Filters to apply on the child fields of the field. Will only work if the field is an object, array/list or map.

Any

sort

array (object)

Any

sort. field

string

Field to check on. Note that the field should be camelCase, not snake_case

Any

sort. value

string

Value to check on. For numbers you should use 'min' and 'max'.

Any

sort. min

number

Minimum value, only usable for number fields

Any

sort. max

number

Maximum value, only usable for number fields

Any

sort. direction

string

Direction to sort on. Can be 'asc' or 'desc'. The default direction is 'asc'

* asc * desc

sort. operator

string

Operator for either the child filters, or this filter object itself. Can be 'and', 'or' or 'not'. Default is 'and'. The root operator is always 'and'

* and * or * not

sort. match_type

string

Match type for string values. Can be 'exact', 'contains', 'starts_with', 'ends_with'. The default match_type is 'contains'

* exact * contains * starts_with * ends_with

sort. filters

array (object)

Filters on which the operator will be applied. If there are no child filters, the operator will be applied to the filter object itself.

Any

sort. field_filters

array (object)

Filters to apply on the child fields of the field. Will only work if the field is an object, array/list or map.

Any

language

string

Optional. Set the language to have all translations filled in. The language format is ISO 639-1 language code, Eg: 'en' or 'en-US'

Any
Examples of payload
{
  "key": "Test123",
  "limit": 50,
  "offset": 10,
  "filters": [
    {
      "operator": "or",
      "match_type": "contains"
    },
    {
      "field": "type",
      "value": "image",
      "operator": "and",
      "match_type": "contains"
    },
    {
      "field": "date",
      "operator": "and",
      "match_type": "contains"
    }
  ],
  "sort": [
    {
      "field": "extension",
      "operator": "and",
      "match_type": "contains"
    },
    {
      "field": "name",
      "operator": "and",
      "match_type": "contains"
    }
  ]
}

zbos/media/library/list/response/\{key}

SUB response: Get a list of media items

Channel tags

  • Media

Array<MediaFile>
Payload

Name

Type

Description

Accepted values

Message Payload

array (object)

Any

Message Payload. fileId

string

Any

Message Payload. path

string

Any

Message Payload. fileName

string

Any

Message Payload. extension

string

Any

Message Payload. type

string

Any

Message Payload. mimeType

string

Any

Message Payload. downloadPath

string

Any

Message Payload. previewPath

string

Any

Message Payload. thumbnailPath

string

Any

Message Payload. checksum

string

Any

Message Payload. cloudFileId

string

Any

Message Payload. size

number

Any

Message Payload. modifiedAt

number

Any

Message Payload. isDefaultAsset

boolean

Any

Message Payload. fullPath

string

Any
Examples of payload
{
  "fileId": "string",
  "path": "string",
  "fileName": "string",
  "extension": "string",
  "type": "string",
  "mimeType": "string",
  "downloadPath": "string",
  "previewPath": "string",
  "thumbnailPath": "string",
  "checksum": "string",
  "cloudFileId": "string",
  "size": 0,
  "modifiedAt": 0,
  "defaultAsset": false
}

zbos/media/library/event

SUB Library item changed event

This event is published when an item in the media library list changes

Channel tags

  • Media

EmptyMessage

Empty message

zbos/media/sync/device/get

PUB Get media sync devices

Channel tags

  • Media

EmptyMessage

Empty message

zbos/media/sync/device/event

SUB event: Media sync devices

Channel tags

  • Media

String
Payload

Name

Type

Description

Accepted values

Message Payload

string

Any
Example of payload (generated)
"string"

zbos/media/export/get

PUB Get all media exports

Channel tags

  • Media

ExportRequestDto
Payload

Name

Type

Description

Accepted values

clientId

string

Any

compositionId

string

Any

compositionName

string

Any

mediaPaths

array (string)

Any
Examples of payload
{
  "clientId": "string",
  "compositionId": "string",
  "compositionName": "string",
  "mediaPaths": [
    "string"
  ]
}

zbos/media/export/event

SUB event: All media exported

Channel tags

  • Media

ExportRequestDto
Payload

Name

Type

Description

Accepted values

clientId

string

Any

compositionId

string

Any

compositionName

string

Any

mediaPaths

array (string)

Any
Examples of payload
{
  "clientId": "string",
  "compositionId": "string",
  "compositionName": "string",
  "mediaPaths": [
    "string"
  ]
}

zbos/media/apk/install

PUB Install APK

Channel tags

  • Media

EmptyMessage

Empty message

zbos/media/delete/all

PUB Delete all media

Channel tags

  • Media

EmptyMessage

Empty message