General Notes
- All paths above are relative to the REST endpoint base (something like http://your.server/files)
- If the service is down or not working it will return a status 503, this means the the underlying service is not working and is either restarting or has failed
- A status code 500 means a general failure has occurred which is not recoverable and was not anticipated. In other words, there is a bug! You should file an error report with your server logs from the time when the error occurred: Opencast Issue Tracker
Table of Contents
Write methods
| Method / Path: | POST /analyze |
|---|---|
| Description: | Starts an audio analyzing process |
| Path params: | NONE |
| Required (form) params: | sourceAudioTrack: The track just containing the audio stream |
| Optional (form) params: | NONE |
| Response formats: | text/xml |
| Status codes: |
200: OK, Results in an xml document containing the job for the analyzing task 400: Bad Request, If required parameters aren't set or if sourceAudioTrack isn't from the type Track |
| Testing: |
Sample:
/analyze
Testing form (click to reveal)
|
| Method / Path: | POST /normalize |
|---|---|
| Description: | Starts audio normalization process |
| Path params: | NONE |
| Required (form) params: |
sourceAudioTrack: The track containing the audio stream
targetRmsLevDb: The target RMS level dB |
| Optional (form) params: | NONE |
| Response formats: | text/xml |
| Status codes: |
200: OK, Results in an xml document containing the job for the audio normalization task 400: Bad Request, If required parameters aren't set or if sourceAudioTrack isn't from the type Track |
| Testing: |
Sample:
/normalize
Testing form (click to reveal)
|