--- title: "Fetch a live stream" method: GET path: "/live_streams/{id}" tags: ["live_streams"] --- # Fetch a live stream `GET /live_streams/{id}` This operation shows the details of a specific live stream. ## Path parameters - `id` string, required ## Response `200` Success - object - `live_stream` LiveStream, required - `aspect_ratio_height` integer — 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 — 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` 'pay_as_you_go' | 'twentyfour_seven' — 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. - `broadcast_location` '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' — The location of your stream. Choose a location as close as possible to your video source. - `closed_caption_type` 'none' | 'cea' | 'on_text' | 'both' — 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. - `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` 'pull' | 'cdn' | 'push' — 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. - `delivery_protocols` string[] — 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. - `direct_playback_urls` 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. - `delivery_protocol` object[] — The name of the direct playback protocol. - `name` string — The name of the playback URL: **source**, **default**, or the output rendition's resolution. - `output_id` string — Only for output rendition-based playback URLs, not source playback URLs. The unique alphanumeric string that identifies the output rendition. - `url` string — The playback URL for the source or output rendition. - `application_name` string — (WebRTC only) The application name for the WebRTC output. - `stream_name` string — (WebRTC only) The stream name for the WebRTC output rendition. - `encoder` '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' — 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**. - `flowplayer` boolean — 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 5 and Wowza players are the players available for Wowza Streaming Cloud subscribers. - `hosted_page` HostedPageResponseObject — Configuration of the hosted page. - `enabled` boolean — A web page hosted by Wowza Video that includes a player for the live stream. The default, **true**, creates a hosted page. Specify **false** to not create a hosted web page. - `description` string — A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags. - `logo_image_url` string — The path to a GIF, JPEG, or PNG logo file that appears in the upper-left corner of the hosted page. Logo file must be 2.5 MB or smaller. - `sharing_icons` boolean — Icons that let viewers share the stream on Facebook, Google+, Twitter, and by email. The default, **true**, includes sharing icons on the hosted page. Specify **false** to omit sharing icons. - `title` string — A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags. - `url` string — The URL of the Wowza Video-hosted webpage that viewers can visit to watch the stream. - `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. - `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 - `player_type` 'wowza_flowplayer_v1' | 'wowza_flowplayer_v2' — (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 - `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. - `countdown_at` string, date-time — 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** where **HH** is a 24-hour clock. 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 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" - `countdown_timezone` string — 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` - `countdown` boolean — Enables or disables a countdown timer. - `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` 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' — The corner of the player in which you want the player logo to appear. The default is **top-left**. - `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 — 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. - `security` object — Configuration of stream security. These settings only apply to Wowza CDN on Fastly stream targets, not Facebook Live, LinkedIn Live, or custom targets. - `force_ssl_playback` boolean — If **true**, requires users to play the stream over HTTPS. If **false**, the default, users can play the stream over HTTPS or HTTP. - `geoblock_enabled` boolean — If **true**, controls access to the stream from specific locations and, optionally, IP addresses. The default is **false**. - `geoblock_by_location` 'allow' | 'deny' | 'disabled' — Specifies whether to **allow** or **deny** access to the stream from specific locations. The default is **disabled**. - `geoblock_country_codes` string — Required when *geoblock_by_location* is **allow** or **deny**. The locations affected by the geo-blocking. Enter a comma-separated list of capitalized two-letter ISO 3166-1 country codes. For a list, see [ISO 3166-1](https://en.wikipedia.org/wiki/ISO_3166-1) on Wikipedia. - `geoblock_ip_override` 'allow' | 'deny' | 'disabled' — Specifies whether specific IP addresses can override the locations that are allowed or restricted. **allow** permits access from IP addresses within a location that's been blocked, while **deny** restricts access from IP addresses within locations that are allowed. The default is **disabled**. - `geoblock_ip_addresses` string — Required when *geoblock_ip_override* is **allow** or **deny**. Addresses that can access or restrict the stream even if they're within a specified geo-blocked location. Enter a comma-separated list of IPv4 and IPv6 IP addresses that always allow or deny streaming based on the *geoblock_ip_override* value. - `token_auth_enabled` boolean — If **true**, token authentication protects the stream by ensuring that it's delivered only to authorized viewers and can't be shared by unauthorized links or player hijacking attacks. The default is **false**. - `token_auth_shared_secret` string — The shared secret of the token authentication. Must contain only hexadecimal characters and be an even number of total characters not exceeding 32. - `token_auth_playlist_only` boolean — If **true**, Wowza Video uses token authentication to protect the master playlist only and leaves individual media playlists and media segments unprotected. This feature enables playback compatibility with media players that don’t support the *withCredentials* property. It may also be useful when addressing token auth compatibility issues with specific browsers. The default is **false**. **Note**: If you've enabled MPEG-DASH on your stream target, `token_auth_playlist_only` applies to both the `playlist.m3u8` for HLS and `manifest.mpd` for MPEG-DASH. - `source_connection_information` object — Details that you can use to manually configure and connect a video source to the live stream. - `state` 'starting' | 'stopping' | 'started' | 'stopped' | 'resetting' — The state of the live stream. - `stream_source_id` string — The unique alphanumeric string that identifies the stream source, if a stream source is used. - `stream_targets` object[] — 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. - `id` string — The unique alphanumeric string that identifies the stream target. - `target_delivery_protocol` 'hls-https' — The type of stream being delivered from Wowza Video. The default and only valid value is **hls-https**. - `transcoder_type` 'transcoded' | 'passthrough' — 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**. - `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 — 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` 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 — The opacity, or percentage of transparency, of the watermark. **0** is fully transparent; **100** is fully opaque. - `watermark_position` 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' — The corner of the video frame in which you want the watermark to appear. The default is **top-left**. - `watermark_width` integer — The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width. ## Other responses - `401` — Unauthorized - `403` — Forbidden - `404` — Not Found - `410` — Gone --- [API](https://skmtc.net/wowza/apis/wowza-video-rest-api-reference-documentation.md) · [All operations](https://skmtc.net/wowza/apis/wowza-video-rest-api-reference-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wowza/wowza-video-rest-api-reference-documentation/versions/157b6f741f2a/schema)