AsyncAPI channel · Modulate
· Velma 2 Music Detection Streaming API
/api/velma-2-music-detection-streaming
## WebSocket Close Codes
- `1000`: Normal closure after the `done` message, or after the
connection completes.
- `1003`: Invalid or missing query parameters (unknown `audio_format`,
invalid `sample_rate` or `num_channels`, a raw format missing
`sample_rate`/`num_channels`, `sample_rate`/`num_channels` supplied
without `audio_format`, or `audio_format` omitted). An `error` message
is sent
Provider:ModulateAsyncAPI: v3.0.0Spec: Velma 2 Music Detection Streaming APIOperations: 5Messages: 5
Channel address
/api/velma-2-music-detection-streaming
Operations
send
sendAudio
Stream audio data to the server.
send
signalEnd
Signal end of audio stream.
receive
receiveFrameResult
Receive a per-frame detection result.
receive
receiveDone
Receive the final summary when analysis is complete.
receive
receiveError
Receive an error notification.
Messages
audioData
A binary frame containing audio samples.
Content-Type: application/octet-stream
endOfStream
An empty text frame signalling that the client has finished sending audio.
Content-Type: text/plain
frameResult
A single 192-millisecond frame detection result.
Content-Type: application/json
done
Analysis complete - all frame results have been delivered.
Content-Type: application/json
error
An error occurred during connection or analysis.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.