Operations related to live streams. A live stream is a single, linear video broadcast. You broadcast a live stream by receiving encoded source video into the Wowza Video service and letting Wowza Video transcode the stream and deliver it to viewers. A live stream is essentially a one-stop method for creating a transcoder, output renditions, stream targets, and associated players.
Wowza Video
/- Reference
- REST API
/
Fetch a live stream
Wowza Video REST API Reference Documentation (v2.0)
API lifecycle phase: Current
| Want to take the API for a test run? All you'll need is a Wowza Video subscription, or free trial, for the API access token. Then, fork our collection in Postman and you'll be making calls to our REST API in minutes! See Trial the Wowza Video REST API using Postman for more information. |
This reference documentation provides details about the operations, parameters, and request and response schemas for every resource and endpoint in the Wowza Video REST API. Samples appear in the right column. Sample requests are presented in cURL (Shell) and JavaScript; some samples also include just the JSON object. Response samples are all JSON. Examples in cURL use environment variables so you can easily copy and paste them. To learn more, see Using cURL.
Reference documentation is available for every version of the API. Use the Version menu at the top of the page to access the reference doc for a different version of the API.
Note: If you haven't moved over to the new Wowza Video UI experience, you won't be able to access v2.0 of the API. We're migrating customers iteratively. See Upgrade to the Wowza Video 2.0 REST API for more information.
Download OpenAPI description
Overview
License
Languages
Servers
Mock server
https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi
https://api.video.wowza.com/api/v2.0
Query
Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter. Filters use a zero-based index.
For valid filter operators and filter fields, see How to get filtered query results with the Wowza Video REST API.
Example: filter[0][field]=state&filter[0][eq]=stopped
Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1.
For more information and examples, see Get paginated query results with the Wowza Video REST API.
- Mock serverhttps://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/live_streams
- https://api.video.wowza.com/api/v2.0/live_streams
- curl
- Java
- Python
- JavaScript
curl -i -X GET \
'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/live_streams?filter=string&page=0&per_page=0'Success
Example: [{"id":"wdjfqvsv","name":"My PAYG Transcoded WSE Live Stream","state":"stopped","created_at":"2020-01-29T17:16:21.849Z","updated_at":"2020-01-31T16:06:47.849Z"},{"id":"KyxWKtHQ","name":"My 24x7 Passthrough Live Stream","state":"started","created_at":"2020-01-29T17:16:21.849Z","updated_at":"2020-01-31T02:26:05.849Z"},{"id":"Ly40ZDSg","name":"My PAYG Transcoded Teradek Cube Live Stream","state":"started","created_at":"2020-01-29T17:16:21.849Z","updated_at":"2020-01-30T18:13:18.849Z"}]
The date and time that the live stream was created.
Example: ""
A descriptive name for the live stream. Maximum 200 characters.
Example: ""
The state of the live stream.
Enum"starting""stopping""started""stopped""resetting"
Example: "started"
Response
application/json
{ "live_streams": [ { … }, { … }, { … } ] }
- Mock serverhttps://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/live_streams/{id}
- https://api.video.wowza.com/api/v2.0/live_streams/{id}
- curl
- Java
- Python
- JavaScript
curl -i -X GET \
'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/live_streams/{id}'Success
Example: {"aspect_ratio_height":720,"aspect_ratio_width":1280,"billing_mode":"pay_as_you_go","broadcast_location":"us_west_california","closed_caption_type":"cea","connection_code":"0e15cb","connection_code_expires_at":"2020-11-30T17:16:21.956Z","created_at":"2020-01-29T17:16:21.956Z","delivery_method":"push","delivery_protocols":["rtmp","rtsp","wowz","webrtc"],"description":"This is my first live stream.","direct_playback_urls":{"rtmp":[{"name":"source","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6"}],"rtsp":[{"name":"source","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"wowz":[{"name":"source","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"webrtc":[{"name":"source","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream6"}]},"encoder":"other_rtmp","flowplayer":true,"hosted_page":{"enabled":true,"description":"My Hosted Page Description","logo_image_url":"https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg","sharing_icons":true,"title":"My Hosted Page","url":"https://embed.flowplayer.com/hosted/default/e8dk5bf6"},"id":"wdjfqvsv","name":"My PAYG Transcoded WSE Live Stream","playback_stream_name":"wxyz6789","player_id":"205b4e8-b160-43c2-868d-d88698a4e850","player_type":"wowza_flowplayer_v2","embed_code":null,"hls_playback_url":"https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8","logo_image_url":"https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg","logo_position":"top-right","video_poster_image_url":"https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg","width":640,"recording":true,"reference_id":"mySystemID_01","save_asset":false,"security":{"force_ssl_playback":false,"geoblock_enabled":true,"geoblock_by_location":"allow","geoblock_country_codes":"DE, US","geoblock_ip_override":"deny","geoblock_ip_addresses":"77.12.34.567, 78.23.45.678","token_auth_enabled":false,"token_auth_playlist_only":false},"state":"stopped","stream_source_id":"5skrfpyf","stream_targets":[{"id":"klbmg2h8"},{"id":"bnjtdmmc"}],"target_delivery_protocol":"hls-https","transcoder_type":"transcoded","updated_at":"2020-01-31T06:12:39.956Z","use_stream_source":true,"vod_stream":true,"watermark":true,"watermark_height":80,"watermark_image_url":"https://prod.s3.amazonaws.com/uploads/transcoder/watermark_image/12345/4baa13.jpg","watermark_opacity":75,"watermark_position":"top-right","watermark_width":100}
The height, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with aspect_ratio_width, makes up the input resolution.
Default: 720.
Example: 720
The width, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with aspect_ratio_height, makes up the input resolution.
Default: 1280.
Example: 1280
Only applies to live streams created from re-streaming an asset in Asset Management. The id for the asset associated with the re-streamed live stream. You can manage this asset in Asset Management.
The billing mode for the stream.
Default: pay_as_you_go.
pay_as_you_go — Billed as a single event. A single event is use-based and you incur charges for the time spent streaming.
twentyfour_seven — Billed as a 24x7 channel. A 24x7 channel is unlimited stream time for one channel. This billing mode doesn't incur overages, since it's unlimited.
Enum"pay_as_you_go""twentyfour_seven"
Example: "pay_as_you_go"
The location of your stream. Choose a location as close as possible to your video source.
Enum"asia_pacific_australia""asia_pacific_india""asia_pacific_japan""asia_pacific_singapore""asia_pacific_s_korea""asia_pacific_taiwan""eu_belgium""eu_germany""eu_ireland""south_america_brazil"
Example: "eu_germany"
The type of closed caption data being passed from the source. The default, none, indicates that no data is being provided. cea indicates that a CEA closed captioning data stream is being provided. on_text indicates that an onTextData closed captioning data stream is being provided. both indicates that both CEA and onTextData closed captioning data streams are being provided.
Enum"none""cea""on_text""both"
Example: "cea"
A six-character, alphanumeric string that allows certain encoders, including Wowza Streaming Engine and the Wowza GoCoder app, to connect with Wowza Video. The code can be used once and expires 24 hours after it's created.
Example: "0e15cb"
The date and time that the connection_code expires.
Example: "2020-11-30T17:16:21.956Z"
The date and time that the live stream was created.
Example: "2020-01-29T17:16:21.956Z"
The type of connection between the video source and the transcoder. The default, push, instructs the source to push the stream to the transcoder. pull instructs the transcoder to pull the video from the source. cdn uses a stream source to deliver the stream to the transcoder.
Enum"pull""cdn""push"
Example: "push"
An array of direct delivery protocols enabled for this live stream. By default, rtmp, rtsp, webrtc, and wowz are enabled.
Example: ["rtmp","rtsp","wowz","webrtc"]
An optional description of the live stream.
Example: "This is my first live stream."
A list of direct playback URLs for the live stream's delivery protocols. Each protocol has a URL for the source and a URL for each output rendition.
Example: {"rtmp":[{"name":"source","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6"}],"rtsp":[{"name":"source","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"wowz":[{"name":"source","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"webrtc":[{"name":"source","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream6"}]}
The video source for the live stream. Choose the type of camera or encoder you're using to connect to the Wowza Video transcoder. If your specific device isn't listed, choose ipcamera, other_rtmp, or other_rtsp.
Enum"wowza_clearcaster""wowza_gocoder""wowza_streaming_engine""media_ds""axis""epiphan""file""hauppauge""jvc""live_u"
Example: "other_rtmp"
Indicates whether or not the player for the live stream is a Wowza Flowplayer player. True indicates the player is a Wowza Flowplayer player. Our new Wowza Video experience uses Wowza Flowplayer. If you are a Wowza Video legacy subscriber, Wowza Flowplayer is also the player used.
False indicates the player is either an original_html5 player or wowza_player. The original HTML and Wowza players are the players available for Wowza Streaming Cloud subscribers.
Example: true
The unique alphanumeric string that identifies the live stream.
Example: "wdjfqvsv"
For streams whose target_delivery_protocol is hls-https. If true, turns off incoming and sort packet buffers and delivers smaller video packets to the player, which can reduce latency as long as networks can handle the increased overhead. The default is false.
Example: ""
A descriptive name for the live stream. Maximum 200 characters.
Example: "My PAYG Transcoded WSE Live Stream"
The stream name used in the direct playback URL.
Example: "wxyz6789"
The player object is deprecated in 2.0. Create and update player configurations in the user interface.
Any values you send using the player object will be ignored.
The following fields have been moved outside of the player object and reside within the live_stream object where you can still access them through the API:
- embed_code
- hls_playback_url
- logo_image_url
- logo_position
- video_poster_image_url
- width
(Available from version 2.0) The unique alphanumeric string that identifies the player configuration to use for this stream.
When you pass a player configuration ID, Wowza Video uses that player configuration to customize and style the player. If you don't pass a value, the default player configuration for the account is used.
Create and edit player configurations in the user interface. The ID is on the General tab for the player configuration.
Default: Default player configuration
Note: player_id is not returned in the response if it's not explicitly sent and the default player configuration is used instead.
Example: 2205b4e8-b160-43c2-868d-d88698a4e850
Example: "205b4e8-b160-43c2-868d-d88698a4e850"
(Available from version 2.0) The type of player associated with the stream. Streams created in legacy Wowza Video have a player type of wowza_flowplayer_v1. Streams created in later versions of Wowza Video have a player type of wowza_flowplayer_v2.
Knowing the player type is useful if you've migrated streams from legacy Wowza Video. The player for a stream created in the legacy version of Wowza Video isn't editable in the new platform.
Example: wowza_flowplayer_v1
Enum"wowza_flowplayer_v1""wowza_flowplayer_v2"
Example: "wowza_flowplayer_v2"
The HTML code that can be used in an external webpage to host the Wowza Flowplayer.
Example: ""
The address that can be used to configure playback of the stream using the HLS protocol.
Example: "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8"
The month, day, year, and time of day that the countdown timer should stop displaying to the viewer. Specify YYYY-MM-DD HH:MM:SS. The response is in UTC time.
For example, if you set the countdown_at for 2024-12-15T17:00:00:000Z and the countdown_timezone as America/New_York, the viewer would see their current time minus the time remaining until the date and time you set. So, if there's 5 hours to go until 1700 NYC time for the viewer, the viewer sees 5:00:00 on the player indicating their's 5 hours left and the timer counts down from there. The countdown starts as soon as the streamer configures it.
Required when countdown is true.
Example: "countdown_at": "2024-02-01T00:00:00.000Z"
Example: "2024-02-01T00:00:00.000Z"
The time zone the countdown timer runs in.
Required when countdown is true.
Click to expand for the full list of valid values
| Locations | Wowza Video time_zone value |
|---|---|
| International Date Line West | Etc/GMT+12 |
| Midway Island | Pacific/Midway |
| American Samoa | Pacific/Pago_Pago |
| Hawaii | Pacific/Honolulu |
| Alaska | America/Juneau |
| Pacific Time (US & Canada) | America/Los_Angeles |
| Tijuana | America/Tijuana |
| Mountain Time (US & Canada) | America/Denver |
| Arizona | America/Phoenix |
| Chihuahua | America/Chihuahua |
| Mazatlan | America/Mazatlan |
| Central Time (US & Canada) | America/Chicago |
| Saskatchewan | America/Regina |
| Guadalajara | America/Mexico_City |
| Mexico City | America/Mexico_City |
| Monterrey | America/Monterrey |
| Central America | America/Guatemala |
| Eastern Time (US & Canada) | America/New_York |
| Indiana (East) | America/Indiana/Indianapolis |
| Bogota | America/Bogota |
| Lima | America/Lima |
| Quito | America/Lima |
| Atlantic Time (Canada) | America/Halifax |
| Caracas | America/Caracas |
| La Paz | America/La_Paz |
| Santiago | America/Santiago |
| Newfoundland | America/St_Johns |
| Brasilia | America/Sao_Paulo |
| Buenos Aires | America/Argentina/Buenos_Aires |
| Montevideo | America/Montevideo |
| Georgetown | America/Guyana |
| Puerto Rico | America/Puerto_Rico |
| Greenland | America/Godthab |
| Mid-Atlantic | Atlantic/South_Georgia |
| Azores | Atlantic/Azores |
| Cape Verde Is. | Atlantic/Cape_Verde |
| Dublin | Europe/Dublin |
| Edinburgh | Europe/London |
| Lisbon | Europe/Lisbon |
| London | Europe/London |
| Casablanca | Africa/Casablanca |
| Monrovia | Africa/Monrovia |
| UTC | Etc/UTC |
| Belgrade | Europe/Belgrade |
| Bratislava | Europe/Bratislava |
| Budapest | Europe/Budapest |
| Ljubljana | Europe/Ljubljana |
| Prague | Europe/Prague |
| Sarajevo | Europe/Sarajevo |
| Skopje | Europe/Skopje |
| Warsaw | Europe/Warsaw |
| Zagreb | Europe/Zagreb |
| Brussels | Europe/Brussels |
| Copenhagen | Europe/Copenhagen |
| Madrid | Europe/Madrid |
| Paris | Europe/Paris |
| Amsterdam | Europe/Amsterdam |
| Berlin | Europe/Berlin |
| Bern | Europe/Zurich |
| Zurich | Europe/Zurich |
| Rome | Europe/Rome |
| Stockholm | Europe/Stockholm |
| Vienna | Europe/Vienna |
| West Central Africa | Africa/Algiers |
| Bucharest | Europe/Bucharest |
| Cairo | Africa/Cairo |
| Helsinki | Europe/Helsinki |
| Kyiv | Europe/Kiev |
| Riga | Europe/Riga |
| Sofia | Europe/Sofia |
| Tallinn | Europe/Tallinn |
| Vilnius | Europe/Vilnius |
| Athens | Europe/Athens |
| Istanbul | Europe/Istanbul |
| Minsk | Europe/Minsk |
| Jerusalem | Asia/Jerusalem |
| Harare | Africa/Harare |
| Pretoria | Africa/Johannesburg |
| Kaliningrad | Europe/Kaliningrad |
| Moscow | Europe/Moscow |
| St. Petersburg | Europe/Moscow |
| Volgograd | Europe/Volgograd |
| Samara | Europe/Samara |
| Kuwait | Asia/Kuwait |
| Riyadh | Asia/Riyadh |
| Nairobi | Africa/Nairobi |
| Baghdad | Asia/Baghdad |
| Tehran | Asia/Tehran |
| Abu Dhabi | Asia/Muscat |
| Muscat | Asia/Muscat |
| Baku | Asia/Baku |
| Tbilisi | Asia/Tbilisi |
| Yerevan | Asia/Yerevan |
| Kabul | Asia/Kabul |
| Ekaterinburg | Asia/Yekaterinburg |
| Islamabad | Asia/Karachi |
| Karachi | Asia/Karachi |
| Tashkent | Asia/Tashkent |
| Chennai | Asia/Kolkata |
| Kolkata | Asia/Kolkata |
| Mumbai | Asia/Kolkata |
| New Delhi | Asia/Kolkata |
| Kathmandu | Asia/Kathmandu |
| Astana | Asia/Dhaka |
| Dhaka | Asia/Dhaka |
| Sri Jayawardenepura | Asia/Colombo |
| Almaty | Asia/Almaty |
| Novosibirsk | Asia/Novosibirsk |
| Rangoon | Asia/Rangoon |
| Bangkok | Asia/Bangkok |
| Hanoi | Asia/Bangkok |
| Jakarta | Asia/Jakarta |
| Krasnoyarsk | Asia/Krasnoyarsk |
| Beijing | Asia/Shanghai |
| Chongqing | Asia/Chongqing |
| Hong Kong | Asia/Hong_Kong |
| Urumqi | Asia/Urumqi |
| Kuala Lumpur | Asia/Kuala_Lumpur |
| Singapore | Asia/Singapore |
| Taipei | Asia/Taipei |
| Perth | Australia/Perth |
| Irkutsk | Asia/Irkutsk |
| Ulaanbaatar | Asia/Ulaanbaatar |
| Seoul | Asia/Seoul |
| Osaka | Asia/Tokyo |
| Sapporo | Asia/Tokyo |
| Tokyo | Asia/Tokyo |
| Yakutsk | Asia/Yakutsk |
| Darwin | Australia/Darwin |
| Adelaide | Australia/Adelaide |
| Canberra | Australia/Melbourne |
| Melbourne | Australia/Melbourne |
| Sydney | Australia/Sydney |
| Brisbane | Australia/Brisbane |
| Hobart | Australia/Hobart |
| Vladivostok | Asia/Vladivostok |
| Guam | Pacific/Guam |
| Port Moresby | Pacific/Port_Moresby |
| Magadan | Asia/Magadan |
| Srednekolymsk | Asia/Srednekolymsk |
| Solomon Is. | Pacific/Guadalcanal |
| New Caledonia | Pacific/Noumea |
| Fiji | Pacific/Fiji |
| Kamchatka | Asia/Kamchatka |
| Marshall Is. | Pacific/Majuro |
| Auckland | Pacific/Auckland |
| Wellington | Pacific/Auckland |
| Nuku'alofa | Pacific/Tongatapu |
| Tokelau Is. | Pacific/Fakaofo |
| Chatham Is. | Pacific/Chatham |
| Samoa | Pacific/Apia |
Default: Etc/UTC
Example: America/New_York
Example: "America/New_York"
The path to a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.
Example: "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg"
The corner of the player in which you want the player logo to appear. The default is top-left.
Enum"top-left""top-right""bottom-left""bottom-right"
Example: "top-right"
The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.
Example: "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg"
The width, in pixels, of a fixed-size player. The default is 640.
Example: 640
If true, creates a recording of the live stream. The recording starts when the live stream starts and stops automatically when the live stream stops.
Recordings created from a live stream capture up to eight hours of content. If a live stream runs for longer than eight hours, the most recent eight hours are recorded. To record more than eight hours of a single broadcast, stop the live stream and start it again to create multiple recordings.
Default: false.
Note: If save_asset is true, that field overrides a true recording value and the asset is saved in Asset Management.
Example: true
A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with transcoder events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|
You can't use brackets or quotation marks.
See Wowza Video Webhook Event Reference Documentation to learn about webhooks.
Available from version 1.7.
Example: "mySystemID_01"
If true, saves an MP4 recording and a VOD asset in Asset Management. The default is false. You can't set save_asset for a live stream created from re-streaming an asset in Asset Management.
Note: If this value is true, recording and/or vod_stream are set to false. You need a Wowza Video subscription to access Asset Management.
Available from version 1.8.
Configuration of stream security. These settings only apply to Wowza CDN on Fastly stream targets, not Facebook Live, LinkedIn Live, or custom targets.
Example: {"force_ssl_playback":false,"geoblock_enabled":true,"geoblock_by_location":"allow","geoblock_country_codes":"DE, US","geoblock_ip_override":"deny","geoblock_ip_addresses":"77.12.34.567, 78.23.45.678","token_auth_enabled":false,"token_auth_playlist_only":false}
Details that you can use to manually configure and connect a video source to the live stream.
Example: ""
The state of the live stream.
Enum"starting""stopping""started""stopped""resetting"
Example: "stopped"
The unique alphanumeric string that identifies the stream source, if a stream source is used.
Example: "5skrfpyf"
An array of unique alphanumeric strings that identify the stream targets used by the live stream. A primary_stream_target is a single stream target that automatically gets created for all output renditions (the ABR ladder) created when you create a live stream through a live stream flow. The primary_stream_target cannot be deleted or reassigned.
Example: [{"id":"klbmg2h8"},{"id":"bnjtdmmc"}]
The type of stream being delivered from Wowza Video. The default and only valid value is hls-https.
Value"hls-https"
Example: "hls-https"
The type of transcoder, either transcoded for streams that are transcoded into adaptive bitrate renditions or passthrough for streams that aren't processed by the transcoder.
Note: passthrough isn't supported in the asia_pacific_singapore region.
Default: transcoded.
Enum"transcoded""passthrough"
Example: "transcoded"
The date and time that the live stream was updated.
Example: "2020-01-31T06:12:39.956Z"
If true, uses a stream source to deliver the stream to Wowza Video. The default, false, pushes directly to Wowza Video.
Example: true
If true, creates a VOD stream after the live stream ends. The default is false. VOD streams require a Fastly stream target with HLS as a delivery protocol.
Note: If save_asset is true, that field overrides a true vod_stream value and the asset is saved in Asset Management.
Example: true
Embeds an image into the transcoded stream for copyright protection. Specify true to embed a watermark image.
Example: true
The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height.
Example: 80
The path to a GIF, JPEG, or PNG image that is embedded in all bitrate renditions of the stream. Watermark image files must be 2.5 MB or smaller.
Example: "https://prod.s3.amazonaws.com/uploads/transcoder/watermark_image/12345/4baa13.jpg"
The opacity, or percentage of transparency, of the watermark. 0 is fully transparent; 100 is fully opaque.
Enum0123456789
Example: 75
The corner of the video frame in which you want the watermark to appear. The default is top-left.
Enum"top-left""top-right""bottom-left""bottom-right"
Example: "top-right"
Response
application/json
{ "live_stream": { "aspect_ratio_height": 720, "aspect_ratio_width": 1280, "billing_mode": "pay_as_you_go", "broadcast_location": "us_west_california", "closed_caption_type": "cea", "connection_code": "0e15cb", "connection_code_expires_at": "2020-11-30T17:16:21.956Z", "created_at": "2020-01-29T17:16:21.956Z", "delivery_method": "push", "delivery_protocols": [ … ], "description": "This is my first live stream.", "direct_playback_urls": { … }, "encoder": "other_rtmp", "flowplayer": true, "hosted_page": { … }, "id": "wdjfqvsv", "name": "My PAYG Transcoded WSE Live Stream", "playback_stream_name": "wxyz6789", "player_id": "205b4e8-b160-43c2-868d-d88698a4e850", "player_type": "wowza_flowplayer_v2", "embed_code": null, "hls_playback_url": "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8", "logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg", "logo_position": "top-right", "video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg", "width": 640, "recording": true, "reference_id": "mySystemID_01", "save_asset": false, "security": { … }, "state": "stopped", "stream_source_id": "5skrfpyf", "stream_targets": [ … ], "target_delivery_protocol": "hls-https", "transcoder_type": "transcoded", "updated_at": "2020-01-31T06:12:39.956Z", "use_stream_source": true, "vod_stream": true, "watermark": true, "watermark_height": 80, "watermark_image_url": "https://prod.s3.amazonaws.com/uploads/transcoder/watermark_image/12345/4baa13.jpg", "watermark_opacity": 75, "watermark_position": "top-right", "watermark_width": 100 } }
Bodyapplication/jsonrequired
Provide the details of the live stream to update in the body of the request.
Example: {"name":"My Updated Live Stream","description":"This is my first live stream.","recording":true}
The height, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with aspect_ratio_width, makes up the input resolution.
Default: 720.
Example: "aspect_ratio_height": 720
Example: 1080
The width, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with aspect_ratio_height, makes up the input resolution.
Default: 1280.
Example: "aspect_ratio_width": 1280
Example: 1920
The video source for the live stream. Choose the type of camera or encoder you're using to connect to the Wowza Video transcoder. If your specific device isn't listed, choose ipcamera, other_rtmp, or other_rtsp.
Example: "encoder": "other_rtmp"
Enum"wowza_clearcaster""wowza_gocoder""wowza_streaming_engine""media_ds""axis""epiphan""file""hauppauge""jvc""live_u"
Example: "other_rtmp"
A descriptive name for the live stream. Maximum 200 characters.
Example: "name": "My Updated Live Stream"
Example: "My Updated Live Stream"
The type of closed caption data being passed from the source. The default, none, indicates that no data is being provided. cea indicates that a CEA closed captioning data stream is being provided. on_text indicates that an onTextData closed captioning data stream is being provided. both indicates that both CEA and onTextData closed captioning data streams are being provided.
Example: "closed_caption_type": "cea"
Enum"none""cea""on_text""both"
Example: "cea"
The type of connection between the video source and the transcoder. The default, push, instructs the source to push the stream to the transcoder. pull instructs the transcoder to pull the video from the source. cdn uses a stream source to deliver the stream to the transcoder.
Example: "delivery_method": "pull"
Enum"pull""cdn""push"
Example: "push"
An array of direct delivery protocols enabled for this live stream. By default, rtmp, rtsp, webrtc, and wowz are enabled.
Example: See response body sample
An optional description of the live stream.
Example: "This is my first live stream."
Authentication is required by default for RTMP and RTSP push connections from a video source to Wowza Video. Specify true to disable authentication with the video source.
Example: "disable_authentication": false
Example: false
A password for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.
Example: "password": 68332313
Example: "68332313"
The player object is deprecated in 2.0. Create and update player configurations in the user interface.
Any values you send using the player object will be ignored.
The following fields have been moved outside of the player object and reside within the live_stream object where you can still access them through the API:
- logo_image
- logo_position
- video_poster_image
- width
- remove_video_poster_image
- remove_logo_image
(Available from version 2.0) The unique alphanumeric string that identifies the player configuration to use for this stream.
When you pass a player configuration ID, Wowza Video uses that player configuration to customize and style the player. If you don't pass a value, the default player configuration for the account is used.
Create and edit player configurations in the user interface. The ID is on the General tab for the player configuration.
Default: Default player configuration
Example: 2205b4e8-b160-43c2-868d-d88698a4e850
A Base64-encoded string representation of a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.
Example: "logo_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"
Example: ""
The corner of the player in which you want the player logo to appear. The default is top-left.
Example: "logo_position": "top-right"
Enum"top-left""top-right""bottom-left""bottom-right"
Example: ""
The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.
Example: "video_poster_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"
Example: ""
The width, in pixels, of a fixed-size player. The default is 640.
Example: "width": 640
Example: ""
If true, removes the logo file from the player. The default is false.
Example: "remove_logo_image": true
Example: true
If true, removes the poster image. The default is false.
Example: "remove_video_poster_image": true
Example: true
If true, creates a recording of the live stream. The recording starts when the live stream starts and stops automatically when the live stream stops.
Recordings created from a live stream capture up to eight hours of content. If a live stream runs for longer than eight hours, the most recent eight hours are recorded. To record more than eight hours of a single broadcast, stop the live stream and start it again to create multiple recordings.
Default: false
Note: If save_asset is true, that field overrides a true recording value and the asset is saved in Asset Management.
Example: "recording": true
Example: true
A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with transcoder events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|
You can't use brackets or quotation marks.
See Wowza Video Webhook Event Reference Documentation to learn about webhooks.
Available from version 1.7.
Example: "reference_id": "mySystemID_01"
Example: "mySystemID_01"
If true, saves an MP4 recording and a VOD asset in Asset Management. The default is false. You can't set save_asset for a live stream created from re-streaming an asset in Asset Management
Note: If this value is true, recording and/or vod_stream are set to false. You need a Wowza Video subscription to access Asset Management.
Available from version 1.8.
Example: "save_asset": true
Configuration of stream security. These settings only apply to Wowza CDN on Fastly stream targets, not Facebook Live, LinkedIn Live, or custom targets.
For the delivery_method pull or encoder file.
For pull, enter the URL of an IP camera or video encoder using an RTMP and RTSP pull connection to Wowza Video. Consult the camera or encoder documentation for the URL syntax.
For file, enter the source file URL, including the protocol (http, https, gs, s3).
Example: "source_url": "xyz.streamlock.net/vod/mp4:Movie.mov"
Example: "xyz.streamlock.net/vod/mp4:Movie.mov"
The type of stream being delivered from Wowza Video. The default and only valid value is hls-https.
Example: "target_delivery_protocol": "hls-https"
Value"hls-https"
Example: "hls-https"
If true, uses a stream source to deliver the stream to Wowza Video. The default, false, pushes directly to Wowza Video.
Example: "use_stream_source": false
Example: false
A user name for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.
Example: "username": "client2"
Example: "client2"
If true, creates a VOD stream after the live stream ends. The default is false.VOD streams require a Fastly stream target with HLS as a delivery protocol.
Note: If save_asset is true, that field overrides a true vod_stream value and the asset is saved in Asset Management.
Example: "vod_stream": true
Example: true
Embeds an image into the transcoded stream for copyright protection. Specify true to embed a watermark image.
Example: "watermark": true
Example: ""
The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height.
Example: "watermark_height": 80
Example: ""
A Base64-encoded string representation of a GIF, JPEG, or PNG image that is embedded in all bitrate renditions of the stream. Watermark image files must be 2.5 MB or smaller.
Example: "watermark_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"
Example: ""
The opacity, or percentage of transparency, of the watermark. 0 is fully transparent; 100 is fully opaque.
Example: "watermark_opacity": 75
Enum0123456789
Example: ""
The corner of the video frame in which you want the watermark to appear. The default is top-left.
Example: "watermark_position": "top-left"
Enum"top-left""top-right""bottom-left""bottom-right"
Example: ""
The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width.
Example: "watermark_width": 100
Example: ""
The month, day, year, and time of day that the countdown timer should stop displaying to the viewer. Specify YYYY-MM-DD HH:MM:SS.
For example, if you set the countdown_at for 2024-12-15T17:00:00:000Z and the countdown_timezone as America/New_York, the viewer would see their current time minus the time remaining until the date and time you set. So, if there's 5 hours to go until 1700 NYC time for the viewer, the viewer sees 5:00:00 on the player indicating there are 5 hours left, then the timer counts down from there. The countdown starts as soon as the streamer configures it.
Required when countdown is true.
Example: "countdown_at": "2024-02-01T00:00:00.000Z"
Example: "2024-02-01T00:00:00.000Z"
The time zone the countdown timer runs in.
Required when countdown is true.
Click to expand for the full list of valid values
| Locations | Wowza Video time_zone value |
|---|---|
| International Date Line West | Etc/GMT+12 |
| Midway Island | Pacific/Midway |
| American Samoa | Pacific/Pago_Pago |
| Hawaii | Pacific/Honolulu |
| Alaska | America/Juneau |
| Pacific Time (US & Canada) | America/Los_Angeles |
| Tijuana | America/Tijuana |
| Mountain Time (US & Canada) | America/Denver |
| Arizona | America/Phoenix |
| Chihuahua | America/Chihuahua |
| Mazatlan | America/Mazatlan |
| Central Time (US & Canada) | America/Chicago |
| Saskatchewan | America/Regina |
| Guadalajara | America/Mexico_City |
| Mexico City | America/Mexico_City |
| Monterrey | America/Monterrey |
| Central America | America/Guatemala |
| Eastern Time (US & Canada) | America/New_York |
| Indiana (East) | America/Indiana/Indianapolis |
| Bogota | America/Bogota |
| Lima | America/Lima |
| Quito | America/Lima |
| Atlantic Time (Canada) | America/Halifax |
| Caracas | America/Caracas |
| La Paz | America/La_Paz |
| Santiago | America/Santiago |
| Newfoundland | America/St_Johns |
| Brasilia | America/Sao_Paulo |
| Buenos Aires | America/Argentina/Buenos_Aires |
| Montevideo | America/Montevideo |
| Georgetown | America/Guyana |
| Puerto Rico | America/Puerto_Rico |
| Greenland | America/Godthab |
| Mid-Atlantic | Atlantic/South_Georgia |
| Azores | Atlantic/Azores |
| Cape Verde Is. | Atlantic/Cape_Verde |
| Dublin | Europe/Dublin |
| Edinburgh | Europe/London |
| Lisbon | Europe/Lisbon |
| London | Europe/London |
| Casablanca | Africa/Casablanca |
| Monrovia | Africa/Monrovia |
| UTC | Etc/UTC |
| Belgrade | Europe/Belgrade |
| Bratislava | Europe/Bratislava |
| Budapest | Europe/Budapest |
| Ljubljana | Europe/Ljubljana |
| Prague | Europe/Prague |
| Sarajevo | Europe/Sarajevo |
| Skopje | Europe/Skopje |
| Warsaw | Europe/Warsaw |
| Zagreb | Europe/Zagreb |
| Brussels | Europe/Brussels |
| Copenhagen | Europe/Copenhagen |
| Madrid | Europe/Madrid |
| Paris | Europe/Paris |
| Amsterdam | Europe/Amsterdam |
| Berlin | Europe/Berlin |
| Bern | Europe/Zurich |
| Zurich | Europe/Zurich |
| Rome | Europe/Rome |
| Stockholm | Europe/Stockholm |
| Vienna | Europe/Vienna |
| West Central Africa | Africa/Algiers |
| Bucharest | Europe/Bucharest |
| Cairo | Africa/Cairo |
| Helsinki | Europe/Helsinki |
| Kyiv | Europe/Kiev |
| Riga | Europe/Riga |
| Sofia | Europe/Sofia |
| Tallinn | Europe/Tallinn |
| Vilnius | Europe/Vilnius |
| Athens | Europe/Athens |
| Istanbul | Europe/Istanbul |
| Minsk | Europe/Minsk |
| Jerusalem | Asia/Jerusalem |
| Harare | Africa/Harare |
| Pretoria | Africa/Johannesburg |
| Kaliningrad | Europe/Kaliningrad |
| Moscow | Europe/Moscow |
| St. Petersburg | Europe/Moscow |
| Volgograd | Europe/Volgograd |
| Samara | Europe/Samara |
| Kuwait | Asia/Kuwait |
| Riyadh | Asia/Riyadh |
| Nairobi | Africa/Nairobi |
| Baghdad | Asia/Baghdad |
| Tehran | Asia/Tehran |
| Abu Dhabi | Asia/Muscat |
| Muscat | Asia/Muscat |
| Baku | Asia/Baku |
| Tbilisi | Asia/Tbilisi |
| Yerevan | Asia/Yerevan |
| Kabul | Asia/Kabul |
| Ekaterinburg | Asia/Yekaterinburg |
| Islamabad | Asia/Karachi |
| Karachi | Asia/Karachi |
| Tashkent | Asia/Tashkent |
| Chennai | Asia/Kolkata |
| Kolkata | Asia/Kolkata |
| Mumbai | Asia/Kolkata |
| New Delhi | Asia/Kolkata |
| Kathmandu | Asia/Kathmandu |
| Astana | Asia/Dhaka |
| Dhaka | Asia/Dhaka |
| Sri Jayawardenepura | Asia/Colombo |
| Almaty | Asia/Almaty |
| Novosibirsk | Asia/Novosibirsk |
| Rangoon | Asia/Rangoon |
| Bangkok | Asia/Bangkok |
| Hanoi | Asia/Bangkok |
| Jakarta | Asia/Jakarta |
| Krasnoyarsk | Asia/Krasnoyarsk |
| Beijing | Asia/Shanghai |
| Chongqing | Asia/Chongqing |
| Hong Kong | Asia/Hong_Kong |
| Urumqi | Asia/Urumqi |
| Kuala Lumpur | Asia/Kuala_Lumpur |
| Singapore | Asia/Singapore |
| Taipei | Asia/Taipei |
| Perth | Australia/Perth |
| Irkutsk | Asia/Irkutsk |
| Ulaanbaatar | Asia/Ulaanbaatar |
| Seoul | Asia/Seoul |
| Osaka | Asia/Tokyo |
| Sapporo | Asia/Tokyo |
| Tokyo | Asia/Tokyo |
| Yakutsk | Asia/Yakutsk |
| Darwin | Australia/Darwin |
| Adelaide | Australia/Adelaide |
| Canberra | Australia/Melbourne |
| Melbourne | Australia/Melbourne |
| Sydney | Australia/Sydney |
| Brisbane | Australia/Brisbane |
| Hobart | Australia/Hobart |
| Vladivostok | Asia/Vladivostok |
| Guam | Pacific/Guam |
| Port Moresby | Pacific/Port_Moresby |
| Magadan | Asia/Magadan |
| Srednekolymsk | Asia/Srednekolymsk |
| Solomon Is. | Pacific/Guadalcanal |
| New Caledonia | Pacific/Noumea |
| Fiji | Pacific/Fiji |
| Kamchatka | Asia/Kamchatka |
| Marshall Is. | Pacific/Majuro |
| Auckland | Pacific/Auckland |
| Wellington | Pacific/Auckland |
| Nuku'alofa | Pacific/Tongatapu |
| Tokelau Is. | Pacific/Fakaofo |
| Chatham Is. | Pacific/Chatham |
| Samoa | Pacific/Apia |
Default: Etc/UTC
Example: America/New_York
Example: "America/New_York"
- Mock serverhttps://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/live_streams/{id}
- https://api.video.wowza.com/api/v2.0/live_streams/{id}
- curl
- Java
- Python
- JavaScript
curl -i -X PATCH \
'https://developer-m.wowza.com/_mock/docs/wowza-video/api/video/openapi/live_streams/{id}' \
-H 'Content-Type: application/json' \
-d '{
"live_stream": {
"name": "My Updated Live Stream",
"description": "This is my first live stream.",
"recording": true
}
}'Success
Example: {"aspect_ratio_height":720,"aspect_ratio_width":1280,"billing_mode":"pay_as_you_go","broadcast_location":"us_west_california","closed_caption_type":"cea","connection_code":"0e15cb","connection_code_expires_at":"2020-11-30T17:16:21.956Z","created_at":"2020-01-29T17:16:21.956Z","delivery_method":"push","delivery_protocols":["rtmp","rtsp","wowz","webrtc"],"description":"This is my first live stream.","direct_playback_urls":{"rtmp":[{"name":"source","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6"}],"rtsp":[{"name":"source","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"wowz":[{"name":"source","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"webrtc":[{"name":"source","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream6"}]},"encoder":"other_rtmp","flowplayer":true,"hosted_page":{"enabled":true,"description":"My Hosted Page Description","logo_image_url":"https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg","sharing_icons":true,"title":"My Hosted Page","url":"https://embed.flowplayer.com/hosted/default/e8dk5bf6"},"id":"wdjfqvsv","name":"My PAYG Transcoded WSE Live Stream","playback_stream_name":"wxyz6789","player_id":"205b4e8-b160-43c2-868d-d88698a4e850","player_type":"wowza_flowplayer_v2","embed_code":null,"hls_playback_url":"https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8","logo_image_url":"https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg","logo_position":"top-right","video_poster_image_url":"https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg","width":640,"recording":true,"reference_id":"mySystemID_01","save_asset":false,"security":{"force_ssl_playback":false,"geoblock_enabled":true,"geoblock_by_location":"allow","geoblock_country_codes":"DE, US","geoblock_ip_override":"deny","geoblock_ip_addresses":"77.12.34.567, 78.23.45.678","token_auth_enabled":false,"token_auth_playlist_only":false},"state":"stopped","stream_source_id":"5skrfpyf","stream_targets":[{"id":"klbmg2h8"},{"id":"bnjtdmmc"}],"target_delivery_protocol":"hls-https","transcoder_type":"transcoded","updated_at":"2020-01-31T06:12:39.956Z","use_stream_source":true,"vod_stream":true,"watermark":true,"watermark_height":80,"watermark_image_url":"https://prod.s3.amazonaws.com/uploads/transcoder/watermark_image/12345/4baa13.jpg","watermark_opacity":75,"watermark_position":"top-right","watermark_width":100}
The height, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with aspect_ratio_width, makes up the input resolution.
Default: 720.
Example: 720
The width, in pixels, of the video source. Should correspond to a widescreen (16:9) or standard (4:3) aspect ratio and be divisible by 8. Combined with aspect_ratio_height, makes up the input resolution.
Default: 1280.
Example: 1280
Only applies to live streams created from re-streaming an asset in Asset Management. The id for the asset associated with the re-streamed live stream. You can manage this asset in Asset Management.
The billing mode for the stream.
Default: pay_as_you_go.
pay_as_you_go — Billed as a single event. A single event is use-based and you incur charges for the time spent streaming.
twentyfour_seven — Billed as a 24x7 channel. A 24x7 channel is unlimited stream time for one channel. This billing mode doesn't incur overages, since it's unlimited.
Enum"pay_as_you_go""twentyfour_seven"
Example: "pay_as_you_go"
The location of your stream. Choose a location as close as possible to your video source.
Enum"asia_pacific_australia""asia_pacific_india""asia_pacific_japan""asia_pacific_singapore""asia_pacific_s_korea""asia_pacific_taiwan""eu_belgium""eu_germany""eu_ireland""south_america_brazil"
Example: "eu_germany"
The type of closed caption data being passed from the source. The default, none, indicates that no data is being provided. cea indicates that a CEA closed captioning data stream is being provided. on_text indicates that an onTextData closed captioning data stream is being provided. both indicates that both CEA and onTextData closed captioning data streams are being provided.
Enum"none""cea""on_text""both"
Example: "cea"
A six-character, alphanumeric string that allows certain encoders, including Wowza Streaming Engine and the Wowza GoCoder app, to connect with Wowza Video. The code can be used once and expires 24 hours after it's created.
Example: "0e15cb"
The date and time that the connection_code expires.
Example: "2020-11-30T17:16:21.956Z"
The date and time that the live stream was created.
Example: "2020-01-29T17:16:21.956Z"
The type of connection between the video source and the transcoder. The default, push, instructs the source to push the stream to the transcoder. pull instructs the transcoder to pull the video from the source. cdn uses a stream source to deliver the stream to the transcoder.
Enum"pull""cdn""push"
Example: "push"
An array of direct delivery protocols enabled for this live stream. By default, rtmp, rtsp, webrtc, and wowz are enabled.
Example: ["rtmp","rtsp","wowz","webrtc"]
An optional description of the live stream.
Example: "This is my first live stream."
A list of direct playback URLs for the live stream's delivery protocols. Each protocol has a URL for the source and a URL for each output rendition.
Example: {"rtmp":[{"name":"source","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6"}],"rtsp":[{"name":"source","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"wowz":[{"name":"source","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"}],"webrtc":[{"name":"source","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead"},{"name":"webrtc","output_id":"dcxq5q6c","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream1"},{"name":"V:1280x720+A:128K","output_id":"0g116zkf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream2"},{"name":"V:854x480+A:128K","output_id":"4qqkwndt","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream3"},{"name":"V:640x360+A:128K","output_id":"0pv8djpg","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream4"},{"name":"V:512x288+A:128K","output_id":"b09xrxjf","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream5"},{"name":"V:320x180+A:128K","output_id":"bvkh2nsz","url":"wss://abc123.entrypoint.video.wowza.com/webrtc-session.json","application_name":"app-B8P6K226","stream_name":"1722aead_stream6"}]}
The video source for the live stream. Choose the type of camera or encoder you're using to connect to the Wowza Video transcoder. If your specific device isn't listed, choose ipcamera, other_rtmp, or other_rtsp.
Enum"wowza_clearcaster""wowza_gocoder""wowza_streaming_engine""media_ds""axis""epiphan""file""hauppauge""jvc""live_u"
Example: "other_rtmp"
Indicates whether or not the player for the live stream is a Wowza Flowplayer player. True indicates the player is a Wowza Flowplayer player. Our new Wowza Video experience uses Wowza Flowplayer. If you are a Wowza Video legacy subscriber, Wowza Flowplayer is also the player used.
False indicates the player is either an original_html5 player or wowza_player. The original HTML and Wowza players are the players available for Wowza Streaming Cloud subscribers.
Example: true
The unique alphanumeric string that identifies the live stream.
Example: "wdjfqvsv"
For streams whose target_delivery_protocol is hls-https. If true, turns off incoming and sort packet buffers and delivers smaller video packets to the player, which can reduce latency as long as networks can handle the increased overhead. The default is false.
Example: ""
A descriptive name for the live stream. Maximum 200 characters.
Example: "My PAYG Transcoded WSE Live Stream"
The stream name used in the direct playback URL.
Example: "wxyz6789"
The player object is deprecated in 2.0. Create and update player configurations in the user interface.
Any values you send using the player object will be ignored.
The following fields have been moved outside of the player object and reside within the live_stream object where you can still access them through the API:
- embed_code
- hls_playback_url
- logo_image_url
- logo_position
- video_poster_image_url
- width
(Available from version 2.0) The unique alphanumeric string that identifies the player configuration to use for this stream.
When you pass a player configuration ID, Wowza Video uses that player configuration to customize and style the player. If you don't pass a value, the default player configuration for the account is used.
Create and edit player configurations in the user interface. The ID is on the General tab for the player configuration.
Default: Default player configuration
Note: player_id is not returned in the response if it's not explicitly sent and the default player configuration is used instead.
Example: 2205b4e8-b160-43c2-868d-d88698a4e850
Example: "205b4e8-b160-43c2-868d-d88698a4e850"
(Available from version 2.0) The type of player associated with the stream. Streams created in legacy Wowza Video have a player type of wowza_flowplayer_v1. Streams created in later versions of Wowza Video have a player type of wowza_flowplayer_v2.
Knowing the player type is useful if you've migrated streams from legacy Wowza Video. The player for a stream created in the legacy version of Wowza Video isn't editable in the new platform.
Example: wowza_flowplayer_v1
Enum"wowza_flowplayer_v1""wowza_flowplayer_v2"
Example: "wowza_flowplayer_v2"
The HTML code that can be used in an external webpage to host the Wowza Flowplayer.
Example: ""
The address that can be used to configure playback of the stream using the HLS protocol.
Example: "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8"
The month, day, year, and time of day that the countdown timer should stop displaying to the viewer. Specify YYYY-MM-DD HH:MM:SS. The response is in UTC time.
For example, if you set the countdown_at for 2024-12-15T17:00:00:000Z and the countdown_timezone as America/New_York, the viewer would see their current time minus the time remaining until the date and time you set. So, if there's 5 hours to go until 1700 NYC time for the viewer, the viewer sees 5:00:00 on the player indicating their's 5 hours left and the timer counts down from there. The countdown starts as soon as the streamer configures it.
Required when countdown is true.
Example: "countdown_at": "2024-02-01T00:00:00.000Z"
Example: "2024-02-01T00:00:00.000Z"
The time zone the countdown timer runs in.
Required when countdown is true.
Click to expand for the full list of valid values
| Locations | Wowza Video time_zone value |
|---|---|
| International Date Line West | Etc/GMT+12 |
| Midway Island | Pacific/Midway |
| American Samoa | Pacific/Pago_Pago |
| Hawaii | Pacific/Honolulu |
| Alaska | America/Juneau |
| Pacific Time (US & Canada) | America/Los_Angeles |
| Tijuana | America/Tijuana |
| Mountain Time (US & Canada) | America/Denver |
| Arizona | America/Phoenix |
| Chihuahua | America/Chihuahua |
| Mazatlan | America/Mazatlan |
| Central Time (US & Canada) | America/Chicago |
| Saskatchewan | America/Regina |
| Guadalajara | America/Mexico_City |
| Mexico City | America/Mexico_City |
| Monterrey | America/Monterrey |
| Central America | America/Guatemala |
| Eastern Time (US & Canada) | America/New_York |
| Indiana (East) | America/Indiana/Indianapolis |
| Bogota | America/Bogota |
| Lima | America/Lima |
| Quito | America/Lima |
| Atlantic Time (Canada) | America/Halifax |
| Caracas | America/Caracas |
| La Paz | America/La_Paz |
| Santiago | America/Santiago |
| Newfoundland | America/St_Johns |
| Brasilia | America/Sao_Paulo |
| Buenos Aires | America/Argentina/Buenos_Aires |
| Montevideo | America/Montevideo |
| Georgetown | America/Guyana |
| Puerto Rico | America/Puerto_Rico |
| Greenland | America/Godthab |
| Mid-Atlantic | Atlantic/South_Georgia |
| Azores | Atlantic/Azores |
| Cape Verde Is. | Atlantic/Cape_Verde |
| Dublin | Europe/Dublin |
| Edinburgh | Europe/London |
| Lisbon | Europe/Lisbon |
| London | Europe/London |
| Casablanca | Africa/Casablanca |
| Monrovia | Africa/Monrovia |
| UTC | Etc/UTC |
| Belgrade | Europe/Belgrade |
| Bratislava | Europe/Bratislava |
| Budapest | Europe/Budapest |
| Ljubljana | Europe/Ljubljana |
| Prague | Europe/Prague |
| Sarajevo | Europe/Sarajevo |
| Skopje | Europe/Skopje |
| Warsaw | Europe/Warsaw |
| Zagreb | Europe/Zagreb |
| Brussels | Europe/Brussels |
| Copenhagen | Europe/Copenhagen |
| Madrid | Europe/Madrid |
| Paris | Europe/Paris |
| Amsterdam | Europe/Amsterdam |
| Berlin | Europe/Berlin |
| Bern | Europe/Zurich |
| Zurich | Europe/Zurich |
| Rome | Europe/Rome |
| Stockholm | Europe/Stockholm |
| Vienna | Europe/Vienna |
| West Central Africa | Africa/Algiers |
| Bucharest | Europe/Bucharest |
| Cairo | Africa/Cairo |
| Helsinki | Europe/Helsinki |
| Kyiv | Europe/Kiev |
| Riga | Europe/Riga |
| Sofia | Europe/Sofia |
| Tallinn | Europe/Tallinn |
| Vilnius | Europe/Vilnius |
| Athens | Europe/Athens |
| Istanbul | Europe/Istanbul |
| Minsk | Europe/Minsk |
| Jerusalem | Asia/Jerusalem |
| Harare | Africa/Harare |
| Pretoria | Africa/Johannesburg |
| Kaliningrad | Europe/Kaliningrad |
| Moscow | Europe/Moscow |
| St. Petersburg | Europe/Moscow |
| Volgograd | Europe/Volgograd |
| Samara | Europe/Samara |
| Kuwait | Asia/Kuwait |
| Riyadh | Asia/Riyadh |
| Nairobi | Africa/Nairobi |
| Baghdad | Asia/Baghdad |
| Tehran | Asia/Tehran |
| Abu Dhabi | Asia/Muscat |
| Muscat | Asia/Muscat |
| Baku | Asia/Baku |
| Tbilisi | Asia/Tbilisi |
| Yerevan | Asia/Yerevan |
| Kabul | Asia/Kabul |
| Ekaterinburg | Asia/Yekaterinburg |
| Islamabad | Asia/Karachi |
| Karachi | Asia/Karachi |
| Tashkent | Asia/Tashkent |
| Chennai | Asia/Kolkata |
| Kolkata | Asia/Kolkata |
| Mumbai | Asia/Kolkata |
| New Delhi | Asia/Kolkata |
| Kathmandu | Asia/Kathmandu |
| Astana | Asia/Dhaka |
| Dhaka | Asia/Dhaka |
| Sri Jayawardenepura | Asia/Colombo |
| Almaty | Asia/Almaty |
| Novosibirsk | Asia/Novosibirsk |
| Rangoon | Asia/Rangoon |
| Bangkok | Asia/Bangkok |
| Hanoi | Asia/Bangkok |
| Jakarta | Asia/Jakarta |
| Krasnoyarsk | Asia/Krasnoyarsk |
| Beijing | Asia/Shanghai |
| Chongqing | Asia/Chongqing |
| Hong Kong | Asia/Hong_Kong |
| Urumqi | Asia/Urumqi |
| Kuala Lumpur | Asia/Kuala_Lumpur |
| Singapore | Asia/Singapore |
| Taipei | Asia/Taipei |
| Perth | Australia/Perth |
| Irkutsk | Asia/Irkutsk |
| Ulaanbaatar | Asia/Ulaanbaatar |
| Seoul | Asia/Seoul |
| Osaka | Asia/Tokyo |
| Sapporo | Asia/Tokyo |
| Tokyo | Asia/Tokyo |
| Yakutsk | Asia/Yakutsk |
| Darwin | Australia/Darwin |
| Adelaide | Australia/Adelaide |
| Canberra | Australia/Melbourne |
| Melbourne | Australia/Melbourne |
| Sydney | Australia/Sydney |
| Brisbane | Australia/Brisbane |
| Hobart | Australia/Hobart |
| Vladivostok | Asia/Vladivostok |
| Guam | Pacific/Guam |
| Port Moresby | Pacific/Port_Moresby |
| Magadan | Asia/Magadan |
| Srednekolymsk | Asia/Srednekolymsk |
| Solomon Is. | Pacific/Guadalcanal |
| New Caledonia | Pacific/Noumea |
| Fiji | Pacific/Fiji |
| Kamchatka | Asia/Kamchatka |
| Marshall Is. | Pacific/Majuro |
| Auckland | Pacific/Auckland |
| Wellington | Pacific/Auckland |
| Nuku'alofa | Pacific/Tongatapu |
| Tokelau Is. | Pacific/Fakaofo |
| Chatham Is. | Pacific/Chatham |
| Samoa | Pacific/Apia |
Default: Etc/UTC
Example: America/New_York
Example: "America/New_York"
The path to a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.
Example: "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg"
The corner of the player in which you want the player logo to appear. The default is top-left.
Enum"top-left""top-right""bottom-left""bottom-right"
Example: "top-right"
The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.
Example: "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg"
The width, in pixels, of a fixed-size player. The default is 640.
Example: 640
If true, creates a recording of the live stream. The recording starts when the live stream starts and stops automatically when the live stream stops.
Recordings created from a live stream capture up to eight hours of content. If a live stream runs for longer than eight hours, the most recent eight hours are recorded. To record more than eight hours of a single broadcast, stop the live stream and start it again to create multiple recordings.
Default: false.
Note: If save_asset is true, that field overrides a true recording value and the asset is saved in Asset Management.
Example: true
A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with transcoder events that trigger webhooks. Maximum 70 characters. Can only contain: a-z A-Z 0-9 !@#$%^&*()-_+=:;,.?~|
You can't use brackets or quotation marks.
See Wowza Video Webhook Event Reference Documentation to learn about webhooks.
Available from version 1.7.
Example: "mySystemID_01"
If true, saves an MP4 recording and a VOD asset in Asset Management. The default is false. You can't set save_asset for a live stream created from re-streaming an asset in Asset Management.
Note: If this value is true, recording and/or vod_stream are set to false. You need a Wowza Video subscription to access Asset Management.
Available from version 1.8.
Configuration of stream security. These settings only apply to Wowza CDN on Fastly stream targets, not Facebook Live, LinkedIn Live, or custom targets.
Example: {"force_ssl_playback":false,"geoblock_enabled":true,"geoblock_by_location":"allow","geoblock_country_codes":"DE, US","geoblock_ip_override":"deny","geoblock_ip_addresses":"77.12.34.567, 78.23.45.678","token_auth_enabled":false,"token_auth_playlist_only":false}
Details that you can use to manually configure and connect a video source to the live stream.
Example: ""
The state of the live stream.
Enum"starting""stopping""started""stopped""resetting"
Example: "stopped"
The unique alphanumeric string that identifies the stream source, if a stream source is used.
Example: "5skrfpyf"
An array of unique alphanumeric strings that identify the stream targets used by the live stream. A primary_stream_target is a single stream target that automatically gets created for all output renditions (the ABR ladder) created when you create a live stream through a live stream flow. The primary_stream_target cannot be deleted or reassigned.
Example: [{"id":"klbmg2h8"},{"id":"bnjtdmmc"}]
The type of stream being delivered from Wowza Video. The default and only valid value is hls-https.
Value"hls-https"
Example: "hls-https"
The type of transcoder, either transcoded for streams that are transcoded into adaptive bitrate renditions or passthrough for streams that aren't processed by the transcoder.
Note: passthrough isn't supported in the asia_pacific_singapore region.
Default: transcoded.
Enum"transcoded""passthrough"
Example: "transcoded"
The date and time that the live stream was updated.
Example: "2020-01-31T06:12:39.956Z"
If true, uses a stream source to deliver the stream to Wowza Video. The default, false, pushes directly to Wowza Video.
Example: true
If true, creates a VOD stream after the live stream ends. The default is false. VOD streams require a Fastly stream target with HLS as a delivery protocol.
Note: If save_asset is true, that field overrides a true vod_stream value and the asset is saved in Asset Management.
Example: true
Embeds an image into the transcoded stream for copyright protection. Specify true to embed a watermark image.
Example: true
The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height.
Example: 80
The path to a GIF, JPEG, or PNG image that is embedded in all bitrate renditions of the stream. Watermark image files must be 2.5 MB or smaller.
Example: "https://prod.s3.amazonaws.com/uploads/transcoder/watermark_image/12345/4baa13.jpg"
The opacity, or percentage of transparency, of the watermark. 0 is fully transparent; 100 is fully opaque.
Enum0123456789
Example: 75
The corner of the video frame in which you want the watermark to appear. The default is top-left.
Enum"top-left""top-right""bottom-left""bottom-right"
Example: "top-right"
Response
application/json
{ "live_stream": { "aspect_ratio_height": 720, "aspect_ratio_width": 1280, "billing_mode": "pay_as_you_go", "broadcast_location": "us_west_california", "closed_caption_type": "cea", "connection_code": "0e15cb", "connection_code_expires_at": "2020-11-30T17:16:21.956Z", "created_at": "2020-01-29T17:16:21.956Z", "delivery_method": "push", "delivery_protocols": [ … ], "description": "This is my first live stream.", "direct_playback_urls": { … }, "encoder": "other_rtmp", "flowplayer": true, "hosted_page": { … }, "id": "wdjfqvsv", "name": "My PAYG Transcoded WSE Live Stream", "playback_stream_name": "wxyz6789", "player_id": "205b4e8-b160-43c2-868d-d88698a4e850", "player_type": "wowza_flowplayer_v2", "embed_code": null, "hls_playback_url": "https://wowzasubdomain.wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8", "logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg", "logo_position": "top-right", "video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg", "width": 640, "recording": true, "reference_id": "mySystemID_01", "save_asset": false, "security": { … }, "state": "stopped", "stream_source_id": "5skrfpyf", "stream_targets": [ … ], "target_delivery_protocol": "hls-https", "transcoder_type": "transcoded", "updated_at": "2020-01-31T06:12:39.956Z", "use_stream_source": true, "vod_stream": true, "watermark": true, "watermark_height": 80, "watermark_image_url": "https://prod.s3.amazonaws.com/uploads/transcoder/watermark_image/12345/4baa13.jpg", "watermark_opacity": 75, "watermark_position": "top-right", "watermark_width": 100 } }
Operations related to schedules. Schedules allow you to automatically start or stop a live stream or transcoder at a predetermined date and time. You can configure a schedule to start and/or stop a live stream or transcoder just once, or you can configure it to repeat the behavior on a regular basis. See About schedules to learn more.
Operations
Operations related to Real-Time Streaming at Scale. If your audience is fewer than 300 viewers or you want to deliver a stream in near real time alongside other delivery protocols, use our WebRTC solution.
To enable and purchase capacity for Real-Time Streaming at Scale for your account and access the /real_time operations, contact 720.279.8163 or schedule a call.
Operations
Operations related to using advanced token authentication, known in Wowza Video as a default playback token behavior option, with videos.
Use token authentication when distributing valuable or sensitive video content to audiences to ensure that only authorized users can access the content within the intended application. This allows for protection of intellectual property, compliance with regulations, and the ability to maintain control over content distribution. The token is embedded in the videos' embed URLs.
Through the UI or Wowza Video API, you can choose one of the following options for token authentication of a video:
NO_TOKEN - Video files are accessible and can be downloaded and played by anyone at any time. This is the default.
BASIC_TOKEN - The platform automatically creates tokenized video URLs. This setting makes it hard for a viewer to extract the video URL and store it for usage in unintended applications over time since the embed URL, which has the token as part of the URL, will only be playable for 48 hours. The token auto renews after 48 hours when used in the intended application.
ADVANCED_TOKEN - You add the stream's JS embed code (Share Stream) and a token to your site to provide tokenization. The protections are similar to those for the Basic Token option except you customize the time limit, geographical limits, etc. during token creation.
FOLLOW_DEFAULT: - The token behavior is based on the Default Playback Token Behavior setting you selected for your Wowza account. See the Org Settings page in Wowza Video article for where to set this configuration.
Note: You'll use the /videos endpoints to update and review the token authentication enums bulleted above.
Before selecting to use the ADVANCED_TOKEN, you must, first, either:
- Generate a key id via the Wowza Video API, then customize and generate a token via the Wowza Video 2.0 API to add to your site. You'll need the key id to create and sign the token.
- Generate a key id and key via the Wowza Video 2.0 API, then customize and generate a standard common access token (CAT) through the means you usually use to create tokens to add to your site. You'll need the key id and key to create and sign the token.
After you have your playback token, you add the video JS-embed and the playback token to your site if you're going to use the ADVANCED_TOKEN option. The JS-embed code automatically adds the player and related video to your site. See the section on <a href="how to embed the player and video".
Operations
The player operations are deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player operations will be ignored.
Operations related to players, which are created through the /live_streams resource. Players created through Wowza Video live streams can be embedded into your own web page or played through a web page hosted by Wowza Video.
Operations
The recordings operations are deprecated in 2.0. Use the /videos endpoints instead.
Operations related to recordings, which are created through the /live_streams or /transcoders resources. The Wowza Video service can create MP4 recordings of your live streams and transcoded output. Recordings can be downloaded and saved locally. They're based on the highest-bitrate output rendition that Wowza Video generates from your video source. See About recordings to learn more.
Operations
The VOD stream operations are deprecated in 2.0. Use the /videos endpoints instead.
Operations related to video on demand (VOD) streams, which are created through the /live_streams or /transcoders resources. A VOD stream is a recording of a live stream that viewers can replay at a later date. After the broadcast is over and the live stream or transcoder is stopped, Wowza Video creates the VOD stream and generates a playback URL. See About VOD Streams to learn more.
Operations