Streams

Update stream settings

Update a stream's format, detection_mode and/or outage_notifications. format tunes which recognisers run, based on the kind of music the station plays (electronic, classical, pop, or null to clear back to auto); classical, for example, runs AcoustID only. detection_mode sets your accuracy/coverage preference (precise, balanced, or broad). outage_notifications turns the down/recovery emails for this stream on or off. Send any one of them, or several. The response echoes back only the fields you changed. Takes effect within a minute, no need to re-register.

Requires a paid plan: the free tier returns 403 for this endpoint.

patch/v1/streams/{id}

Request

  • Base URL: https://api.sonovault.now
  • URL: https://api.sonovault.now/v1/streams/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Stream id.

Response

Successful response

idstring required

Stream ID.

formatstring nullable

The tuning hint now in force. Returned only when you sent format.

detection_mode'precise' | 'balanced' | 'broad'

The mode now in force. Takes effect on the stream within a minute. Returned only when you sent detection_mode.

outage_notificationsboolean

The outage-email setting now in force. Returned only when you sent outage_notifications.

Changes

No recorded changes to this operation across all 1 revision of this API.