Live Streams

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.

Create a live stream

This operation creates a live stream.

Request

Request Body schema: application/json
required

Provide the details of the live stream to create in the body of the request.

required

object (live_stream)

broadcast_location required	string (broadcast_location) 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" "us_central_iowa" "us_east_s_carolina" "us_east_virginia" "us_west_california" "us_west_oregon"
encoder required	string 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" "matrox" "newtek_tricaster" "osprey" "sony" "telestream_wirecast" "teradek_cube" "vmix" "x_split" "ipcamera" "other_rtmp" "other_rtsp" "other_webrtc" "other_udp" "other_srt"
name required	string A descriptive name for the live stream. Maximum 200 characters.
aspect_ratio_height	integer <int32> 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.
aspect_ratio_width	integer <int32> 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.
billing_mode	string 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"
closed_caption_type	string 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": "none"` Enum: "none" "cea" "on_text" "both"
delivery_method	string 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. Default: push Example: `"delivery_method": "pull"` Enum: "pull" "cdn" "push"
delivery_protocols	Array of strings 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
description	string An optional description of the live stream.
disable_authentication	boolean 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`
	object (hosted_page_request_object_create) Configuration of the hosted page.
low_latency	boolean 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: `"low_latency": false`
password	string 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`
	object (player_request_object_create) 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
player_id	string (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
logo_image	string 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]"`
logo_position	string 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"
video_poster_image	string 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]"`
width	integer <int32> The width, in pixels, of a fixed-size player. The default is 640. Example: `"width": 640`
recording	boolean 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`
reference_id	string 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"`
save_asset	boolean 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`
	object Configuration of stream security. These settings only apply to Wowza CDN on Fastly stream targets, not Facebook Live, LinkedIn Live, or custom targets.
source_url	string 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"`
target_delivery_protocol	string 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"
transcoder_type	string 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. Default: transcoded. Enum: "transcoded" "passthrough"
use_stream_source	boolean 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`
username	string 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"`
vod_stream	boolean 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`
watermark	boolean Embeds an image into the transcoded stream for copyright protection. Specify true to embed a watermark image. Example: `"watermark": true`
watermark_height	integer <int32> The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height. Example: `"watermark_height": 80`
watermark_image	string 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]"`
watermark_opacity	integer <int32> The opacity, or percentage of transparency, of the watermark. 0 is fully transparent; 100 is fully opaque. Example: `"watermark_opacity": 75` Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
watermark_position	string 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"
watermark_width	integer <int32> The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width. Example: `"watermark_width": 100`

Responses

201

Success

Response Schema: application/json

required

object (live_stream)

aspect_ratio_height	integer <int32> 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.
aspect_ratio_width	integer <int32> 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.
asset_id	string 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.
billing_mode	string 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"
broadcast_location	string (broadcast_location) 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" "us_central_iowa" "us_east_s_carolina" "us_east_virginia" "us_west_california" "us_west_oregon"
closed_caption_type	string 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"
connection_code	string 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.
connection_code_expires_at	string <date-time> The date and time that the connection_code expires.
created_at	string <date-time> The date and time that the live stream was created.
delivery_method	string 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"
delivery_protocols	Array of strings An array of direct delivery protocols enabled for this live stream. By default, rtmp, rtsp, webrtc, and wowz are enabled.
description	string An optional description of the live stream.
	object 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.
encoder	string 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" "matrox" "newtek_tricaster" "osprey" "sony" "telestream_wirecast" "teradek_cube" "vmix" "x_split" "ipcamera" "other_rtmp" "other_rtsp" "other_webrtc" "other_udp" "other_srt"
	object (hosted_page_response_object) Configuration of the hosted page.
id	string The unique alphanumeric string that identifies the live stream.
low_latency	boolean 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.
name	string A descriptive name for the live stream. Maximum 200 characters.
playback_stream_name	string The stream name used in the direct playback URL.
	object (player_response_object) 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
player_id	string (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
embed_code	string The HTML code that can be used in an external webpage to host the Wowza Flowplayer.
hls_playback_url	string The address that can be used to configure playback of the stream using the HLS protocol.
logo_image_url	string 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.
logo_position	string 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"
video_poster_image_url	string 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.
width	integer <int32> The width, in pixels, of a fixed-size player. The default is 640.
recording	boolean 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.
reference_id	string 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.
save_asset	boolean 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.
	object Configuration of stream security. These settings only apply to Wowza CDN on Fastly stream targets, not Facebook Live, LinkedIn Live, or custom targets.
source_connection_information	object Details that you can use to manually configure and connect a video source to the live stream.
state	string The state of the live stream. Enum: "starting" "stopping" "started" "stopped" "resetting"
stream_source_id	string The unique alphanumeric string that identifies the stream source, if a stream source is used.
	Array of objects (stream_targets) An array of unique alphanumeric strings that identify the stream targets used by the live stream.
target_delivery_protocol	string The type of stream being delivered from Wowza Video. The default and only valid value is hls-https. Value: "hls-https"
transcoder_type	string 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. Default: transcoded. Enum: "transcoded" "passthrough"
updated_at	string <date-time> The date and time that the live stream was updated.
use_stream_source	boolean If true, uses a stream source to deliver the stream to Wowza Video. The default, false, pushes directly to Wowza Video.
vod_stream	boolean 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.
watermark	boolean Embeds an image into the transcoded stream for copyright protection. Specify true to embed a watermark image.
watermark_height	integer <int32> The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height.
watermark_image_url	string 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.
watermark_opacity	integer <int32> The opacity, or percentage of transparency, of the watermark. 0 is fully transparent; 100 is fully opaque. Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
watermark_position	string 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"
watermark_width	integer <int32> The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width.

401

Unauthorized

422

Unprocessable Entity

post/live_streams

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"live_stream": {"billing_mode": "pay_as_you_go",
"broadcast_location": "us_west_oregon",
"description": "This is my first live stream.",
"encoder": "other_webrtc",
"name": "My Live Stream",
"transcoder_type": "transcoded"
}
}

Response samples

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": ["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",
"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://player.video.wowza.com/hosted/e8dk5bf6/player.html"
},
"id": "wdjfqvsv",
"name": "My PAYG Transcoded WSE Live Stream",
"playback_stream_name": "wxyz6789",
"player_id": "205b4e8-b160-43c2-868d-d88698a4e850",
"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
}
}

Fetch all live streams

This operation shows limited details for all of your live streams. For detailed information, fetch a single live stream.

Request

query Parameters

filter	string 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
page	integer 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.
per_page	integer For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000.

Responses

200

Success

Response Schema: application/json

required

Array of objects (live_streams)

Array

created_at	string <date-time> The date and time that the live stream was created.
id	string The unique alphanumeric string that identifies the live stream.
name	string A descriptive name for the live stream. Maximum 200 characters.
state	string The state of the live stream. Enum: "starting" "stopping" "started" "stopped" "resetting"
updated_at	string <date-time> The date and time that the live stream was updated.

401

Unauthorized

get/live_streams

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/live_streams"

Response samples

application/json

{"live_streams": [{"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"
}
]
}

Fetch a live stream

This operation shows the details of a specific live stream.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

200

Success

Response Schema: application/json

required

object (live_stream)

aspect_ratio_height	integer <int32> 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.
aspect_ratio_width	integer <int32> 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.
asset_id	string 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.
billing_mode	string 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"
broadcast_location	string (broadcast_location) 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" "us_central_iowa" "us_east_s_carolina" "us_east_virginia" "us_west_california" "us_west_oregon"
closed_caption_type	string 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"
connection_code	string 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.
connection_code_expires_at	string <date-time> The date and time that the connection_code expires.
created_at	string <date-time> The date and time that the live stream was created.
delivery_method	string 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"
delivery_protocols	Array of strings An array of direct delivery protocols enabled for this live stream. By default, rtmp, rtsp, webrtc, and wowz are enabled.
description	string An optional description of the live stream.
	object 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.
encoder	string 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" "matrox" "newtek_tricaster" "osprey" "sony" "telestream_wirecast" "teradek_cube" "vmix" "x_split" "ipcamera" "other_rtmp" "other_rtsp" "other_webrtc" "other_udp" "other_srt"
	object (hosted_page_response_object) Configuration of the hosted page.
id	string The unique alphanumeric string that identifies the live stream.
low_latency	boolean 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.
name	string A descriptive name for the live stream. Maximum 200 characters.
playback_stream_name	string The stream name used in the direct playback URL.
	object (player_response_object) 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
player_id	string (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
embed_code	string The HTML code that can be used in an external webpage to host the Wowza Flowplayer.
hls_playback_url	string The address that can be used to configure playback of the stream using the HLS protocol.
logo_image_url	string 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.
logo_position	string 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"
video_poster_image_url	string 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.
width	integer <int32> The width, in pixels, of a fixed-size player. The default is 640.
recording	boolean 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.
reference_id	string 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.
save_asset	boolean 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.
	object Configuration of stream security. These settings only apply to Wowza CDN on Fastly stream targets, not Facebook Live, LinkedIn Live, or custom targets.
source_connection_information	object Details that you can use to manually configure and connect a video source to the live stream.
state	string The state of the live stream. Enum: "starting" "stopping" "started" "stopped" "resetting"
stream_source_id	string The unique alphanumeric string that identifies the stream source, if a stream source is used.
	Array of objects (stream_targets) An array of unique alphanumeric strings that identify the stream targets used by the live stream.
target_delivery_protocol	string The type of stream being delivered from Wowza Video. The default and only valid value is hls-https. Value: "hls-https"
transcoder_type	string 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. Default: transcoded. Enum: "transcoded" "passthrough"
updated_at	string <date-time> The date and time that the live stream was updated.
use_stream_source	boolean If true, uses a stream source to deliver the stream to Wowza Video. The default, false, pushes directly to Wowza Video.
vod_stream	boolean 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.
watermark	boolean Embeds an image into the transcoded stream for copyright protection. Specify true to embed a watermark image.
watermark_height	integer <int32> The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height.
watermark_image_url	string 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.
watermark_opacity	integer <int32> The opacity, or percentage of transparency, of the watermark. 0 is fully transparent; 100 is fully opaque. Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
watermark_position	string 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"
watermark_width	integer <int32> The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/live_streams/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/live_streams/2adffc17"

Response samples

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": ["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",
"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://player.video.wowza.com/hosted/e8dk5bf6/player.html"
},
"id": "wdjfqvsv",
"name": "My PAYG Transcoded WSE Live Stream",
"playback_stream_name": "wxyz6789",
"player_id": "205b4e8-b160-43c2-868d-d88698a4e850",
"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
}
}

Update a live stream

This operation updates a live stream.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Request Body schema: application/json
required

Provide the details of the live stream to update in the body of the request.

required

object (live_stream)

aspect_ratio_height	integer <int32> 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`
aspect_ratio_width	integer <int32> 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`
encoder	string 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" "matrox" "newtek_tricaster" "osprey" "sony" "telestream_wirecast" "teradek_cube" "vmix" "x_split" "ipcamera" "other_rtmp" "other_rtsp" "other_webrtc" "other_udp" "other_srt"
name	string A descriptive name for the live stream. Maximum 200 characters. Example: `"name": "My Updated Live Stream"`
closed_caption_type	string 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"
delivery_method	string 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"
delivery_protocols	Array of strings 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
description	string An optional description of the live stream.
disable_authentication	boolean 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`
	object (hosted_page_request_object) Configuration of the hosted page.
password	string 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`
	object (player_request_object) 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
player_id	string (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
logo_image	string 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]"`
logo_position	string 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"
video_poster_image	string 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]"`
width	integer <int32> The width, in pixels, of a fixed-size player. The default is 640. Example: `"width": 640`
remove_logo_image	boolean If true, removes the logo file from the player. The default is false. Example: `"remove_logo_image": true`
remove_video_poster_image	boolean If true, removes the poster image. The default is false. Example: `"remove_video_poster_image": true`
recording	boolean 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`
reference_id	string 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"`
save_asset	boolean 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`
	object Configuration of stream security. These settings only apply to Wowza CDN on Fastly stream targets, not Facebook Live, LinkedIn Live, or custom targets.
source_url	string 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"`
target_delivery_protocol	string 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"
use_stream_source	boolean 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`
username	string 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"`
vod_stream	boolean 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`
watermark	boolean Embeds an image into the transcoded stream for copyright protection. Specify true to embed a watermark image. Example: `"watermark": true`
watermark_height	integer <int32> The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height. Example: `"watermark_height": 80`
watermark_image	string 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]"`
watermark_opacity	integer <int32> The opacity, or percentage of transparency, of the watermark. 0 is fully transparent; 100 is fully opaque. Example: `"watermark_opacity": 75` Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
watermark_position	string 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"
watermark_width	integer <int32> The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width. Example: `"watermark_width": 100`

Responses

200

Success

Response Schema: application/json

required

object (live_stream)

aspect_ratio_height	integer <int32> 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.
aspect_ratio_width	integer <int32> 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.
asset_id	string 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.
billing_mode	string 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"
broadcast_location	string (broadcast_location) 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" "us_central_iowa" "us_east_s_carolina" "us_east_virginia" "us_west_california" "us_west_oregon"
closed_caption_type	string 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"
connection_code	string 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.
connection_code_expires_at	string <date-time> The date and time that the connection_code expires.
created_at	string <date-time> The date and time that the live stream was created.
delivery_method	string 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"
delivery_protocols	Array of strings An array of direct delivery protocols enabled for this live stream. By default, rtmp, rtsp, webrtc, and wowz are enabled.
description	string An optional description of the live stream.
	object 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.
encoder	string 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" "matrox" "newtek_tricaster" "osprey" "sony" "telestream_wirecast" "teradek_cube" "vmix" "x_split" "ipcamera" "other_rtmp" "other_rtsp" "other_webrtc" "other_udp" "other_srt"
	object (hosted_page_response_object) Configuration of the hosted page.
id	string The unique alphanumeric string that identifies the live stream.
low_latency	boolean 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.
name	string A descriptive name for the live stream. Maximum 200 characters.
playback_stream_name	string The stream name used in the direct playback URL.
	object (player_response_object) 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
player_id	string (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
embed_code	string The HTML code that can be used in an external webpage to host the Wowza Flowplayer.
hls_playback_url	string The address that can be used to configure playback of the stream using the HLS protocol.
logo_image_url	string 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.
logo_position	string 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"
video_poster_image_url	string 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.
width	integer <int32> The width, in pixels, of a fixed-size player. The default is 640.
recording	boolean 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.
reference_id	string 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.
save_asset	boolean 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.
	object Configuration of stream security. These settings only apply to Wowza CDN on Fastly stream targets, not Facebook Live, LinkedIn Live, or custom targets.
source_connection_information	object Details that you can use to manually configure and connect a video source to the live stream.
state	string The state of the live stream. Enum: "starting" "stopping" "started" "stopped" "resetting"
stream_source_id	string The unique alphanumeric string that identifies the stream source, if a stream source is used.
	Array of objects (stream_targets) An array of unique alphanumeric strings that identify the stream targets used by the live stream.
target_delivery_protocol	string The type of stream being delivered from Wowza Video. The default and only valid value is hls-https. Value: "hls-https"
transcoder_type	string 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. Default: transcoded. Enum: "transcoded" "passthrough"
updated_at	string <date-time> The date and time that the live stream was updated.
use_stream_source	boolean If true, uses a stream source to deliver the stream to Wowza Video. The default, false, pushes directly to Wowza Video.
vod_stream	boolean 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.
watermark	boolean Embeds an image into the transcoded stream for copyright protection. Specify true to embed a watermark image.
watermark_height	integer <int32> The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height.
watermark_image_url	string 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.
watermark_opacity	integer <int32> The opacity, or percentage of transparency, of the watermark. 0 is fully transparent; 100 is fully opaque. Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
watermark_position	string 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"
watermark_width	integer <int32> The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

patch/live_streams/{id}

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"live_stream": {"name": "My Updated Live Stream",
"description": "This is my first live stream.",
"recording": true
}
}

Response samples

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": ["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",
"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://player.video.wowza.com/hosted/e8dk5bf6/player.html"
},
"id": "wdjfqvsv",
"name": "My PAYG Transcoded WSE Live Stream",
"playback_stream_name": "wxyz6789",
"player_id": "205b4e8-b160-43c2-868d-d88698a4e850",
"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
}
}

Delete a live stream

This operation deletes a live stream, including all assigned outputs and targets.

Note: You can't remove live streams that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

delete/live_streams/{id}

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/v2.0/live_streams/2adffc17"

Response samples

application/json

{"Example Response 1": {"meta": {"status": 401,
"code": "ERR-401-NoApiKey",
"title": "No API Key Error",
"message": "No API key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 2": {"meta": {"status": 401,
"code": "ERR-401-NoAccessKey",
"title": "No Access Key Error",
"message": "No access key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 3": {"meta": {"status": 401,
"code": "ERR-401-InvalidApiKey",
"title": "Invalid Api Key Error",
"message": "Invalid API key.",
"description": "",
"links": [ ]
}
},
"Example Response 4": {"meta": {"status": 401,
"code": "ERR-401-InvalidAccessKey",
"title": "Invalid Access Key Error",
"message": "Invalid access key.",
"description": "",
"links": [ ]
}
},
"Example Response 5": {"meta": {"status": 401,
"code": "ERR-401-BadAccountStatus",
"title": "Bad Account Status Error",
"message": "Your account's status doesn't allow this action.",
"description": "",
"links": [ ]
}
},
"Example Response 6": {"meta": {"status": 401,
"code": "ERR-401-FeatureNotEnabled",
"title": "Feature Not Enabled Error",
"message": "This feature isn't enabled.",
"description": "",
"links": [ ]
}
},
"Example Response 7": {"meta": {"status": 401,
"code": "ERR-401-TrialExceeded",
"title": "Bad Billing Status Error",
"message": "Your billing status needs attention. You can't start or add live streams until your billing status is updated.",
"description": "",
"links": [ ]
}
},
"Example Response 8": {"meta": {"status": 401,
"code": "ERR-401-ExpiredToken",
"title": "JWT is expired",
"message": "Token has exired.",
"description": "",
"links": [ ]
}
},
"Example Response 9": {"meta": {"status": 401,
"code": "ERR-401-InvalidToken",
"title": "JWT is invalid",
"message": "Token is invalid.",
"description": "",
"links": [ ]
}
}
}

Start a live stream

This operation starts a live stream.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

200

Success

Response Schema: application/json

required

object (live_stream)

state

string

The state of the live stream.

Enum: "started" "stopped" "starting" "stopping" "resetting"

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

put/live_streams/{id}/start

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v2.0/live_streams/2adffc17/start"

Response samples

application/json

{"live_stream": {"state": "starting"
}
}

Stop a live stream

This operation stops a live stream.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

200

Success

Response Schema: application/json

required

object (live_stream)

state

string

The state of the live stream.

Enum: "started" "stopped" "starting" "stopping" "resetting"

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

put/live_streams/{id}/stop

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v2.0/live_streams/2adffc17/stop"

Response samples

application/json

{"live_stream": {"state": "stopped"
}
}

Reset a live stream

This operation resets a live stream.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

200

Success

Response Schema: application/json

required

object (live_stream)

state

string

The state of the live stream.

Enum: "started" "stopped" "starting" "stopping" "resetting"

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

put/live_streams/{id}/reset

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v2.0/live_streams/2adffc17/reset"

Response samples

application/json

{"live_stream": {"state": "resetting"
}
}

Regenerate the connection code for a live stream

This operation regenerates the connection code of a live stream.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

200

Success

Response Schema: application/json

required

object (live_stream)

connection_code

string

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.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

put/live_streams/{id}/regenerate_connection_code

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v2.0/live_streams/2adffc17/regenerate_connection_code"

Response samples

application/json

{"live_stream": {"connection_code": "0cd2e8"
}
}

Fetch the thumbnail URL of a live stream

This operation shows the thumbnail URL of a started live stream.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

200

Success

Response Schema: application/json

required

object (live_stream)

thumbnail_url

string

The URL to receive the preview thumbnail.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/live_streams/{id}/thumbnail_url

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/live_streams/2adffc17/thumbnail_url"

Response samples

application/json

{"live_stream": {"thumbnail_url": "https://cloud.wowza.com/proxy/stats/?target=10.11.12.13&app=app-B8P6K226&stream=99b62146@130135.stream&media=json"
}
}

Fetch the state of a live stream

This operation shows the current state of a live stream.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

200

Success

Response Schema: application/json

required

object (live_stream)

ip_address	string The IP address of the live stream instance. If the live stream state is anything other than started, the ip_address is 0.0.0.0.
state	string The state of the live stream. Enum: "started" "stopped" "starting" "stopping" "resetting"

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/live_streams/{id}/state

Request samples

Shell
JavaScript
Java
Python

// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v2.0/live_streams/2adffc17/state"

Response samples

application/json

{"live_stream": {"ip_address": "0.0.0.0",
"state": "stopped"
}
}

Live Streams

Create a live stream

Request Body schema: application/jsonrequired

Response Schema: application/json

Fetch all live streams

query Parameters

Response Schema: application/json

Fetch a live stream

path Parameters

Response Schema: application/json

Update a live stream

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Delete a live stream

path Parameters

Start a live stream

path Parameters

Response Schema: application/json

Stop a live stream

path Parameters

Response Schema: application/json

Reset a live stream

path Parameters

Response Schema: application/json

Regenerate the connection code for a live stream

path Parameters

Response Schema: application/json

Fetch the thumbnail URL of a live stream

path Parameters

Response Schema: application/json

Fetch the state of a live stream

path Parameters

Response Schema: application/json

Request Body schema: application/json
required

Request Body schema: application/json
required