A number of things have changed between version 1.4 and 1.5 of the API. While this guide includes most changes you need to know, see the Wowza Video REST API reference documentation to confirm specific details of endpoint behavior in v1.5.
What's changed
Over the course of development, we made the following changes to the REST API from version 1.4 to version 1.5.
VOD streams
In v1.5, we added functionality that allows you to create video on demand (VOD) streams. A VOD stream is a recording of a live stream that viewers can replay at a later date. VOD streams can be configured through the live stream or transcoder workflow and only work with Fastly stream targets.
After the broadcast is over and the live stream or transcoder is stopped, Wowza Video creates the VOD stream and generates a playback URL. For more information, see Create a VOD stream with the Wowza Video REST API.
File streaming
In v1.5, we added functionality that allows you to stream .mp3 and H.264-encoded .mp4 and .flv files. Files must be hosted in a publicly accessible location on a web server, Google Storage, or Amazon S3 bucket.
We also added transcoder properties that allow you to play a file on a continuous loop and schedule a file to automatically start streaming at a specific date and time. For more information, see Stream a file with the Wowza Video REST API.
Peak storage object references
In v1.5, we updated the response received when you fetch peak storage for an account. The response now includes peak storage for both recordings and VOD streams. We also updated object references for peak storage.
v1.4 | v1.5 |
---|---|
{ "peak": { "recordings": { "bytes": 15130718193 } }, "limits": { "from": "2019-12-07T00:00:00.000Z", "to": "2019-12-21T00:00:00.000Z" } } | { "bytes": 163535997883, "limits": { "from": "2019-12-07T00:00:00.000Z", "to": "2019-12-21T00:00:00.000Z" } } |
Added and updated functionality
Check out the other updates and additions to the REST API between v1.4 and v1.5. Links go to the applicable article or section of reference documentation unless otherwise noted.
- Removed the recording parameter from the following transcoder endpoints:
- POST /transcoders
- GET /transcoders/[transcoder_id]
- PATCH /transcoders/[transcoder_id]
- To enable stream recording when creating a transcoder, use the mp4 transcoder property.
- Added the ability to set the encoder parameter to other_udp, other_srt, or other_webrtc when creating a live stream.
- Added the ability to set the play_maximum_connections parameter for all transcoder types. Previously, this parameter was only available for 24x7 and passthrough transcoders. For more information, see Play streams directly from a transcoder with the Wowza Video REST API.
- Added the ability to configure transcoder properties when creating a transcoder.
- Removed the zones property from the response returned when fetching usage for all stream targets.
- Added the ability to configure AES-128 encryption for playback of HLS streams. For more information, see Secure HLS streams with AES-128 external encryption using the Wowza Video REST API.
- Replaced the page pagination query parameter with the next_page_key parameter. This change only applies to the GET /usage/stream_targets and GET /usage/vod_streams endpoints. For more information, see Get paginated query results with the Wowza Video REST API.