Skip to main content
POST
/
api
/
audioplayback
/
cancelLoopingAudioPlayback
Cancel looping audio playback
curl --request POST \
  --url https://api2.rhombussystems.com/api/audioplayback/cancelLoopingAudioPlayback \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "audioDevices": [
    "AAAAAAAAAAAAAAAAAAAAAA.v0"
  ]
}
'
{
  "error": true,
  "errorMsg": "<string>",
  "successMap": {},
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey
string
header
required

Your API key for Rhombus.

Headers

x-auth-scheme
string
default:api-token
required

Authentication scheme indicator ("api-token").

Required string length: 9

Body

application/json

Request to cancel looping audio playback on audio devices.

audioDevices
(string<DeviceFacetUuid> | null)[] | null

List of audio device UUIDs to cancel looping playback on

RUUID with optional appended facet information

Example:

"AAAAAAAAAAAAAAAAAAAAAA.v0"

Response

200 - application/json

OK

Response from canceling looping audio playback.

error
boolean | null
errorMsg
string | null
successMap
object

Map of audio device UUIDs to success status for canceling playback

warningMsg
string | null