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 Streaming Cloud service and letting Wowza Streaming Cloud 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.

Ultra low latency stream targets don’t work with live streams. See Get started with ultra low latency streaming using the Wowza Streaming Cloud REST API to learn more.

Create a live stream

This operation creates a live stream.

Request Body schema: application/json

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

required
object (live_stream)
aspect_ratio_height
required
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.

aspect_ratio_width
required
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.

billing_mode
required
string

The billing mode for the stream. The default is pay_as_you_go.

Enum: "pay_as_you_go" "twentyfour_seven"
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 Streaming Cloud 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.

transcoder_type
required
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. The default is transcoded.

Enum: "transcoded" "passthrough"
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"
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.

delivery_type
string

For streams whose encoder is wowza_streaming_engine. The default is multi-bitrate, which means you're sending one or more bitrate renditions from Wowza Streaming Engine directly to a Wowza CDN target without transcoding in Wowza Streaming Cloud. The value single-bitrate means you're sending a single source stream to Wowza Streaming Cloud for transcoding and/or to deliver the source stream to multiple stream targets in Wowza Streaming Cloud.

Enum: "single-bitrate" "multi-bitrate"
disable_authentication
boolean

Authentication is required by default for RTMP and RTSP push connections from a video source to Wowza Streaming Cloud. Specify true to disable authentication with the video source.

hosted_page
boolean

A web page hosted by Wowza Streaming Cloud that includes a player for the live stream. The default, true, creates a hosted page. Specify false to not create a hosted web page.

hosted_page_description
string

A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags.

hosted_page_logo_image
string

A Base64-encoded string representation of a GIF, JPEG, or PNG logo file that that appears in the upper-left corner of the hosted page. Logo file must be 2.5 MB or smaller.

hosted_page_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.

hosted_page_title
string

A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags.

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.

This parameter only affects streams played over a stream target whose type is fastly or wowza. If using a wowza target, the provider must be set to akamai_cupertino. This parameter does not reduce latency in streams played over a hosted page and is unrelated to Wowza ultra low latency stream targets.

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.

player_countdown
boolean

A clock that appears in the player before the event and counts down to the start of the stream. Specify true to display the countdown clock. The default is false.

player_countdown_at
string <date-time>

The date and time that the event starts, used by the countdown clock. Specify YYYY-MM-DD HH:MM:SS, where HH is a 24-hour clock in UTC.

player_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.

player_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"
player_responsive
boolean

A player whose size adjusts according to the device on which it's being viewed. If true, creates a responsive player. If false, specify a player_width.

player_type
string

The player you want to use. Valid values are original_html5, which provides HTML5 playback and falls back to Flash on older browsers, and wowza_player, which provides HTML5 playback over HLS. wowza_player requires that target_delivery_protocol be hls-https and closed_caption_type be none. The default is original_html5.

player_video_poster_image
string

A Base64-encoded string representation of 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.

player_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. The default is false.

remove_hosted_page_logo_image
boolean

If true, removes the logo file from the hosted page. The default is false.

remove_player_logo_image
boolean

If true, removes the logo file from the player. The default is false.

remove_player_video_poster_image
boolean

If true, removes the poster image. The default is false.

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 Streaming Cloud. Consult the camera or encoder documentation for the URL syntax.

For file, enter the source file URL, including the protocol (http, https, gs, s3).

target_delivery_protocol
string

The type of stream being delivered from Wowza Streaming Cloud. The default and only valid value is hls-https. To send a stream with HDS, use the transcoder workflow with a Wowza stream target that has a provider of akamai.

Value: "hls-https"
use_stream_source
boolean

If true, uses a stream source to deliver the stream to Wowza Streaming Cloud. The default, false, pushes directly to Wowza Streaming Cloud.

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.

vod_stream
boolean

If true, creates a VOD stream after the live stream ends. The default is false.

Note: VOD streams require a Fastly stream target with HLS as a delivery protocol.

Responses

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.

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.

billing_mode
string

The billing mode for the stream. The default is pay_as_you_go.

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 Streaming Cloud. 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.

delivery_type
string

For streams whose encoder is wowza_streaming_engine. The default is multi-bitrate, which means you're sending one or more bitrate renditions from Wowza Streaming Engine directly to a Wowza CDN target without transcoding in Wowza Streaming Cloud. The value single-bitrate means you're sending a single source stream to Wowza Streaming Cloud for transcoding and/or to deliver the source stream to multiple stream targets in Wowza Streaming Cloud.

Enum: "single-bitrate" "multi-bitrate"
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 Streaming Cloud 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"
hosted_page
boolean

A web page hosted by Wowza Streaming Cloud that includes a player for the live stream. The default, true, creates a hosted page. Specify false to not create a hosted web page.

hosted_page_description
string

A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags.

hosted_page_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.

hosted_page_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.

hosted_page_title
string

A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags.

hosted_page_url
string

The URL of the Wowza Streaming Cloud-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.

This parameter only affects streams played over a stream target whose type is fastly or wowza. If using a wowza target, the provider must be set to akamai_cupertino. This parameter does not reduce latency in streams played over a hosted page and is unrelated to Wowza ultra low latency stream targets.

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_countdown
boolean

A clock that appears in the player before the event and counts down to the start of the stream. Specify true to display the countdown clock. The default is false.

player_countdown_at
string <date-time>

The date and time that the event starts, used by the countdown clock. Specify YYYY-MM-DD HH:MM:SS, where HH is a 24-hour clock in UTC.

player_embed_code
string

The HTML code that can be used in an external webpage to host the Wowza Streaming Cloud player.

player_hls_playback_url
string

The address that can be used to configure playback of the stream using the HLS protocol.

player_id
string

The unique alphanumeric string that identifies the player.

player_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.

player_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"
player_responsive
boolean

A player whose size adjusts according to the device on which it's being viewed. If true, creates a responsive player. If false, specify a player_width.

player_type
string

The player you want to use. Valid values are original_html5, which provides HTML5 playback and falls back to Flash on older browsers, and wowza_player, which provides HTML5 playback over HLS. wowza_player requires that target_delivery_protocol be hls-https and closed_caption_type be none. The default is original_html5.

player_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.

player_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. The default is false.

source_connection_information
object

Details that you can use to manually configure and connect a video source to the live stream.

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 Streaming Cloud. The default and only valid value is hls-https. To send a stream with HDS, use the transcoder workflow with a Wowza stream target that has a provider of akamai.

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. The default is 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 Streaming Cloud. The default, false, pushes directly to Wowza Streaming Cloud.

vod_stream
boolean

If true, creates a VOD stream after the live stream ends. The default is false.

Note: VOD streams require a Fastly stream target with HLS as a delivery protocol.

Request samples

Content type
application/json
{
  • "live_stream": {
    }
}

Response samples

Content type
application/json
{
  • "live_stream": {
    }
}

Fetch all live streams

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

query Parameters
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 Streaming Cloud 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

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.

updated_at
string <date-time>

The date and time that the live stream was updated.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/live_streams"

Response samples

Content type
application/json
{
  • "live_streams": [
    ]
}

Fetch a live stream

This operation shows the details of a specific live stream.

path Parameters
id
required
string

The unique alphanumeric string that identifies the live stream.

Responses

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.

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.

billing_mode
string

The billing mode for the stream. The default is pay_as_you_go.

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 Streaming Cloud. 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.

delivery_type
string

For streams whose encoder is wowza_streaming_engine. The default is multi-bitrate, which means you're sending one or more bitrate renditions from Wowza Streaming Engine directly to a Wowza CDN target without transcoding in Wowza Streaming Cloud. The value single-bitrate means you're sending a single source stream to Wowza Streaming Cloud for transcoding and/or to deliver the source stream to multiple stream targets in Wowza Streaming Cloud.

Enum: "single-bitrate" "multi-bitrate"
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 Streaming Cloud 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"
hosted_page
boolean

A web page hosted by Wowza Streaming Cloud that includes a player for the live stream. The default, true, creates a hosted page. Specify false to not create a hosted web page.

hosted_page_description
string

A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags.

hosted_page_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.

hosted_page_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.

hosted_page_title
string

A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags.

hosted_page_url
string

The URL of the Wowza Streaming Cloud-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.

This parameter only affects streams played over a stream target whose type is fastly or wowza. If using a wowza target, the provider must be set to akamai_cupertino. This parameter does not reduce latency in streams played over a hosted page and is unrelated to Wowza ultra low latency stream targets.

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_countdown
boolean

A clock that appears in the player before the event and counts down to the start of the stream. Specify true to display the countdown clock. The default is false.

player_countdown_at
string <date-time>

The date and time that the event starts, used by the countdown clock. Specify YYYY-MM-DD HH:MM:SS, where HH is a 24-hour clock in UTC.

player_embed_code
string

The HTML code that can be used in an external webpage to host the Wowza Streaming Cloud player.

player_hls_playback_url
string

The address that can be used to configure playback of the stream using the HLS protocol.

player_id
string

The unique alphanumeric string that identifies the player.

player_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.

player_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"
player_responsive
boolean

A player whose size adjusts according to the device on which it's being viewed. If true, creates a responsive player. If false, specify a player_width.

player_type
string

The player you want to use. Valid values are original_html5, which provides HTML5 playback and falls back to Flash on older browsers, and wowza_player, which provides HTML5 playback over HLS. wowza_player requires that target_delivery_protocol be hls-https and closed_caption_type be none. The default is original_html5.

player_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.

player_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. The default is false.

source_connection_information
object

Details that you can use to manually configure and connect a video source to the live stream.

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 Streaming Cloud. The default and only valid value is hls-https. To send a stream with HDS, use the transcoder workflow with a Wowza stream target that has a provider of akamai.

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. The default is 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 Streaming Cloud. The default, false, pushes directly to Wowza Streaming Cloud.

vod_stream
boolean

If true, creates a VOD stream after the live stream ends. The default is false.

Note: VOD streams require a Fastly stream target with HLS as a delivery protocol.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/live_streams/2adffc17"

Response samples

Content type
application/json
{
  • "live_stream": {
    }
}

Update a live stream

This operation updates a live stream.

path Parameters
id
required
string

The unique alphanumeric string that identifies the live stream.

Request Body schema: application/json

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

required
object (live_stream)
aspect_ratio_height
required
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.

aspect_ratio_width
required
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.

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 Streaming Cloud 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.

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"
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.

disable_authentication
boolean

Authentication is required by default for RTMP and RTSP push connections from a video source to Wowza Streaming Cloud. Specify true to disable authentication with the video source.

hosted_page_description
string

A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags.

hosted_page_logo_image
string

A Base64-encoded string representation of a GIF, JPEG, or PNG logo file that that appears in the upper-left corner of the hosted page. Logo file must be 2.5 MB or smaller.

hosted_page_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.

hosted_page_title
string

A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags.

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.

player_countdown
boolean

A clock that appears in the player before the event and counts down to the start of the stream. Specify true to display the countdown clock. The default is false.

player_countdown_at
string <date-time>

The date and time that the event starts, used by the countdown clock. Specify YYYY-MM-DD HH:MM:SS, where HH is a 24-hour clock in UTC.

player_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.

player_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"
player_responsive
boolean

A player whose size adjusts according to the device on which it's being viewed. If true, creates a responsive player. If false, specify a player_width.

player_type
string

The player you want to use. Valid values are original_html5, which provides HTML5 playback and falls back to Flash on older browsers, and wowza_player, which provides HTML5 playback over HLS. wowza_player requires that target_delivery_protocol be hls-https and closed_caption_type be none. The default is original_html5.

player_video_poster_image
string

A Base64-encoded string representation of 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.

player_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. The default is false.

remove_hosted_page_logo_image
boolean

If true, removes the logo file from the hosted page. The default is false.

remove_player_logo_image
boolean

If true, removes the logo file from the player. The default is false.

remove_player_video_poster_image
boolean

If true, removes the poster image. The default is false.

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 Streaming Cloud. Consult the camera or encoder documentation for the URL syntax.

For file, enter the source file URL, including the protocol (http, https, gs, s3).

target_delivery_protocol
string

The type of stream being delivered from Wowza Streaming Cloud. The default and only valid value is hls-https. To send a stream with HDS, use the transcoder workflow with a Wowza stream target that has a provider of akamai.

Value: "hls-https"
use_stream_source
boolean

If true, uses a stream source to deliver the stream to Wowza Streaming Cloud. The default, false, pushes directly to Wowza Streaming Cloud.

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.

vod_stream
boolean

If true, creates a VOD stream after the live stream ends. The default is false.

Note: VOD streams require a Fastly stream target with HLS as a delivery protocol.

Responses

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.

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.

billing_mode
string

The billing mode for the stream. The default is pay_as_you_go.

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 Streaming Cloud. 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.

delivery_type
string

For streams whose encoder is wowza_streaming_engine. The default is multi-bitrate, which means you're sending one or more bitrate renditions from Wowza Streaming Engine directly to a Wowza CDN target without transcoding in Wowza Streaming Cloud. The value single-bitrate means you're sending a single source stream to Wowza Streaming Cloud for transcoding and/or to deliver the source stream to multiple stream targets in Wowza Streaming Cloud.

Enum: "single-bitrate" "multi-bitrate"
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 Streaming Cloud 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"
hosted_page
boolean

A web page hosted by Wowza Streaming Cloud that includes a player for the live stream. The default, true, creates a hosted page. Specify false to not create a hosted web page.

hosted_page_description
string

A description that appears on the hosted page below the player. Can't include custom HTML, JavaScript, or other tags.

hosted_page_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.

hosted_page_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.

hosted_page_title
string

A title for the page that appears above the player. Can't include custom HTML, JavaScript, or other tags.

hosted_page_url
string

The URL of the Wowza Streaming Cloud-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.

This parameter only affects streams played over a stream target whose type is fastly or wowza. If using a wowza target, the provider must be set to akamai_cupertino. This parameter does not reduce latency in streams played over a hosted page and is unrelated to Wowza ultra low latency stream targets.

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_countdown
boolean

A clock that appears in the player before the event and counts down to the start of the stream. Specify true to display the countdown clock. The default is false.

player_countdown_at
string <date-time>

The date and time that the event starts, used by the countdown clock. Specify YYYY-MM-DD HH:MM:SS, where HH is a 24-hour clock in UTC.

player_embed_code
string

The HTML code that can be used in an external webpage to host the Wowza Streaming Cloud player.

player_hls_playback_url
string

The address that can be used to configure playback of the stream using the HLS protocol.

player_id
string

The unique alphanumeric string that identifies the player.

player_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.

player_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"
player_responsive
boolean

A player whose size adjusts according to the device on which it's being viewed. If true, creates a responsive player. If false, specify a player_width.

player_type
string

The player you want to use. Valid values are original_html5, which provides HTML5 playback and falls back to Flash on older browsers, and wowza_player, which provides HTML5 playback over HLS. wowza_player requires that target_delivery_protocol be hls-https and closed_caption_type be none. The default is original_html5.

player_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.

player_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. The default is false.

source_connection_information
object

Details that you can use to manually configure and connect a video source to the live stream.

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 Streaming Cloud. The default and only valid value is hls-https. To send a stream with HDS, use the transcoder workflow with a Wowza stream target that has a provider of akamai.

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. The default is 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 Streaming Cloud. The default, false, pushes directly to Wowza Streaming Cloud.

vod_stream
boolean

If true, creates a VOD stream after the live stream ends. The default is false.

Note: VOD streams require a Fastly stream target with HLS as a delivery protocol.

Request samples

Content type
application/json
{
  • "live_stream": {
    }
}

Response samples

Content type
application/json
{
  • "live_stream": {
    }
}

Delete a live stream

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the live stream.

Responses

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WSC_HOST}/api/v1.6/live_streams/2adffc17"

Response samples

Content type
application/json
{
  • "Example Response 1": {
    },
  • "Example Response 2": {
    },
  • "Example Response 3": {
    },
  • "Example Response 4": {
    },
  • "Example Response 5": {
    },
  • "Example Response 6": {
    },
  • "Example Response 7": {
    }
}

Start a live stream

This operation starts a live stream.

path Parameters
id
required
string

The unique alphanumeric string that identifies the live stream.

Responses

Response Schema: application/json
required
object (live_stream)
state
string

The state of the live stream.

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

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WSC_HOST}/api/v1.6/live_streams/2adffc17/start"

Response samples

Content type
application/json
{
  • "live_stream": {
    }
}

Stop a live stream

This operation stops a live stream.

path Parameters
id
required
string

The unique alphanumeric string that identifies the live stream.

Responses

Response Schema: application/json
required
object (live_stream)
state
string

The state of the live stream.

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

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WSC_HOST}/api/v1.6/live_streams/2adffc17/stop"

Response samples

Content type
application/json
{
  • "live_stream": {
    }
}

Reset a live stream

This operation resets a live stream.

path Parameters
id
required
string

The unique alphanumeric string that identifies the live stream.

Responses

Response Schema: application/json
required
object (live_stream)
state
string

The state of the live stream.

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

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WSC_HOST}/api/v1.6/live_streams/2adffc17/reset"

Response samples

Content type
application/json
{
  • "live_stream": {
    }
}

Regenerate the connection code for a live stream

This operation regenerates the connection code of a live stream.

path Parameters
id
required
string

The unique alphanumeric string that identifies the live stream.

Responses

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 Streaming Cloud. The code can be used once and expires 24 hours after it's created.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WSC_HOST}/api/v1.6/live_streams/2adffc17/regenerate_connection_code"

Response samples

Content type
application/json
{
  • "live_stream": {
    }
}

Fetch the thumbnail URL of a live stream

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the live stream.

Responses

Response Schema: application/json
required
object (live_stream)
thumbnail_url
string

The URL to receive the preview thumbnail.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/live_streams/2adffc17/thumbnail_url"

Response samples

Content type
application/json

Fetch the state of a live stream

This operation shows the current state of a live stream.

path Parameters
id
required
string

The unique alphanumeric string that identifies the live stream.

Responses

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"

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/live_streams/2adffc17/state"

Response samples

Content type
application/json
{
  • "live_stream": {
    }
}

Fetch metrics for an active live stream

This operation returns a hash of metrics keys, each of which identifies a status, text description, unit, and value.

path Parameters
id
required
string

The unique alphanumeric string that identifies the live stream.

Responses

Response Schema: application/json
required
object (shm_metrics)
object (audio_codec_metric)
object (bits_in_rate_metric)
object (bits_out_rate_metric)
object (bytes_in_rate_metric)
object (bytes_out_rate_metric)
object (configured_bytes_out_rate_metric)
object (connected_metric)
object (frame_size_metric)
object (frame_rate_metric)
object (height_metric)
object (keyframe_interval_metric)
object (stream_target_status_OUTPUTIDX_STREAMTARGETIDX_metric)
object (unique_views_metric)

The number of unique viewers in the last 5 minutes.

Note: This parameter only returns data for Fastly stream targets.

object (video_codec_metric)
object (width_metric)

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/v1.6/live_streams/2adffc17/stats"

Response samples

Content type
application/json
{
  • "live_stream": {
    }
}
➔ Next to Players