Cancel looping audio playback

Cancel any currently playing looping audio for an audio device

POST /api/audioplayback/cancelLoopingAudioPlayback

Cancel looping audio playback

cURL

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"
  ]
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "successMap": {},
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

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

Show child attributes

warningMsg · string | null