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)

Responses

Response Schema: application/json

required

object (live_stream)

Request samples

Payload
Shell
JavaScript

Content type

application/json

{"live_stream": {"aspect_ratio_height": 1080,
"aspect_ratio_width": 1920,
"billing_mode": "pay_as_you_go",
"broadcast_location": "eu_germany",
"encoder": "wowza_gocoder",
"name": "My Live Stream",
"transcoder_type": "transcoded",
"closed_caption_type": "none",
"delivery_method": "push",
"delivery_protocols": ["string"
],
"delivery_type": "single-bitrate",
"disable_authentication": false,
"hosted_page": true,
"hosted_page_description": "My Hosted Page Description",
"hosted_page_logo_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
"hosted_page_sharing_icons": true,
"hosted_page_title": "My Hosted Page",
"low_latency": false,
"password": "68332313",
"player_countdown": true,
"player_countdown_at": "2020-02-01T17:00:00.000Z",
"player_logo_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
"player_logo_position": "top-right",
"player_responsive": false,
"player_type": "wowza_player",
"player_video_poster_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
"player_width": 640,
"recording": true,
"remove_hosted_page_logo_image": true,
"remove_player_logo_image": true,
"remove_player_video_poster_image": true,
"source_url": "xyz.streamlock.net/vod/mp4:Movie.mov",
"target_delivery_protocol": "hls-https",
"use_stream_source": false,
"username": "client2",
"vod_stream": true
}
}

Response samples

Content type

application/json

{"live_stream": {"aspect_ratio_height": 1080,
"aspect_ratio_width": 1920,
"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"
],
"delivery_type": "multi-bitrate",
"direct_playback_urls": {"rtmp": [{"name": "source",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream6"
}
],
"rtsp": [{"name": "source",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"
}
],
"wowz": [{"name": "source",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"
}
],
"webrtc": [{"name": "source",
"url": "wss://abc123.entrypoint.cloud.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "wss://abc123.entrypoint.cloud.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.cloud.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.cloud.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.cloud.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.cloud.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.cloud.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream6"
}
]
},
"encoder": "wowza_streaming_engine",
"hosted_page": true,
"hosted_page_description": "My Hosted Page Description",
"hosted_page_logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg",
"hosted_page_sharing_icons": true,
"hosted_page_title": "My Hosted Page",
"hosted_page_url": "https://player.cloud.wowza.com/hosted/e8dk5bf6/player.html",
"id": "wdjfqvsv",
"name": "My PAYG Transcoded WSE Live Stream",
"playback_stream_name": "wxyz6789",
"player_countdown": true,
"player_countdown_at": "2020-02-01T17:00:00.000Z",
"player_embed_code": null,
"player_hls_playback_url": "https://[wowzasubdomain].wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8",
"player_id": "kwb6pwnv",
"player_logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg",
"player_logo_position": "top-right",
"player_responsive": false,
"player_type": "original_html5",
"player_video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg",
"player_width": 640,
"recording": true,
"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
}
}

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)

Request samples

Shell
JavaScript

// 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": [{"id": "wdjfqvsv",
"name": "My PAYG Transcoded WSE Live Stream",
"created_at": "2020-01-29T17:16:21.849Z",
"updated_at": "2020-01-31T16:06:47.849Z"
},
{"id": "KyxWKtHQ",
"name": "My 24x7 Passthrough GoCoder Live Stream",
"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",
"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.

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

Response Schema: application/json

required

object (live_stream)

Request samples

Shell
JavaScript

// 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": {"aspect_ratio_height": 1080,
"aspect_ratio_width": 1920,
"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"
],
"delivery_type": "multi-bitrate",
"direct_playback_urls": {"rtmp": [{"name": "source",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream6"
}
],
"rtsp": [{"name": "source",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"
}
],
"wowz": [{"name": "source",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"
}
],
"webrtc": [{"name": "source",
"url": "wss://abc123.entrypoint.cloud.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "wss://abc123.entrypoint.cloud.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.cloud.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.cloud.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.cloud.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.cloud.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.cloud.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream6"
}
]
},
"encoder": "wowza_streaming_engine",
"hosted_page": true,
"hosted_page_description": "My Hosted Page Description",
"hosted_page_logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg",
"hosted_page_sharing_icons": true,
"hosted_page_title": "My Hosted Page",
"hosted_page_url": "https://player.cloud.wowza.com/hosted/e8dk5bf6/player.html",
"id": "wdjfqvsv",
"name": "My PAYG Transcoded WSE Live Stream",
"playback_stream_name": "wxyz6789",
"player_countdown": true,
"player_countdown_at": "2020-02-01T17:00:00.000Z",
"player_embed_code": null,
"player_hls_playback_url": "https://[wowzasubdomain].wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8",
"player_id": "kwb6pwnv",
"player_logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg",
"player_logo_position": "top-right",
"player_responsive": false,
"player_type": "original_html5",
"player_video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg",
"player_width": 640,
"recording": true,
"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
}
}

Update a live stream

This operation updates a live stream.

path Parameters

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)

Responses

Response Schema: application/json

required

object (live_stream)

Request samples

Payload
Shell
JavaScript

Content type

application/json

{"live_stream": {"aspect_ratio_height": 1080,
"aspect_ratio_width": 1920,
"encoder": "wowza_gocoder",
"name": "My Live Stream",
"closed_caption_type": "cea",
"delivery_method": "push",
"delivery_protocols": ["string"
],
"disable_authentication": false,
"hosted_page_description": "My Hosted Page Description",
"hosted_page_logo_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
"hosted_page_sharing_icons": true,
"hosted_page_title": "My Hosted Page",
"password": "68332313",
"player_countdown": true,
"player_countdown_at": "2020-02-01T17:00:00.000Z",
"player_logo_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
"player_logo_position": "top-right",
"player_responsive": false,
"player_type": "wowza_player",
"player_video_poster_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
"player_width": 640,
"recording": true,
"remove_hosted_page_logo_image": true,
"remove_player_logo_image": true,
"remove_player_video_poster_image": true,
"source_url": "xyz.streamlock.net/vod/mp4:Movie.mov",
"target_delivery_protocol": "hls-https",
"use_stream_source": false,
"username": "client2",
"vod_stream": true
}
}

Response samples

Content type

application/json

{"live_stream": {"aspect_ratio_height": 1080,
"aspect_ratio_width": 1920,
"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"
],
"delivery_type": "multi-bitrate",
"direct_playback_urls": {"rtmp": [{"name": "source",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "rtmp://abc123.entrypoint.cloud.wowza.com/app-B8P6K226/wxyz6789_stream6"
}
],
"rtsp": [{"name": "source",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "rtsp://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"
}
],
"wowz": [{"name": "source",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "wowz://abc123.entrypoint.cloud.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"
}
],
"webrtc": [{"name": "source",
"url": "wss://abc123.entrypoint.cloud.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "wss://abc123.entrypoint.cloud.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.cloud.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.cloud.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.cloud.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.cloud.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.cloud.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream6"
}
]
},
"encoder": "wowza_streaming_engine",
"hosted_page": true,
"hosted_page_description": "My Hosted Page Description",
"hosted_page_logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/hosted_page_logo_image/23424/5bad28.jpg",
"hosted_page_sharing_icons": true,
"hosted_page_title": "My Hosted Page",
"hosted_page_url": "https://player.cloud.wowza.com/hosted/e8dk5bf6/player.html",
"id": "wdjfqvsv",
"name": "My PAYG Transcoded WSE Live Stream",
"playback_stream_name": "wxyz6789",
"player_countdown": true,
"player_countdown_at": "2020-02-01T17:00:00.000Z",
"player_embed_code": null,
"player_hls_playback_url": "https://[wowzasubdomain].wowza.com/1/TWhoL3BiZnJXMFhmNzZVN3JrZDAwUT09/ZmYxSXRrTERrUlk9/hls/live/playlist.m3u8",
"player_id": "kwb6pwnv",
"player_logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg",
"player_logo_position": "top-right",
"player_responsive": false,
"player_type": "original_html5",
"player_video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg",
"player_width": 640,
"recording": true,
"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
}
}

Delete a live stream

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

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

Request samples

Shell
JavaScript

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

Start a live stream

This operation starts a live stream.

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

Response Schema: application/json

required

object (live_stream)

Request samples

Shell
JavaScript

// 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": {"state": "starting"
}
}

Stop a live stream

This operation stops a live stream.

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

Response Schema: application/json

required

object (live_stream)

Request samples

Shell
JavaScript

// 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": {"state": "stopped"
}
}

Reset a live stream

This operation resets a live stream.

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

Response Schema: application/json

required

object (live_stream)

Request samples

Shell
JavaScript

// 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": {"state": "resetting"
}
}

Regenerate the connection code for a live stream

This operation regenerates the connection code of a live stream.

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

Response Schema: application/json

required

object (live_stream)

Request samples

Shell
JavaScript

// 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": {"connection_code": "0cd2e8"
}
}

Fetch the thumbnail URL of a live stream

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

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

Response Schema: application/json

required

object (live_stream)

Request samples

Shell
JavaScript

// 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

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

path Parameters

required

string

The unique alphanumeric string that identifies the live stream.

Responses

Response Schema: application/json

required

object (live_stream)

Request samples

Shell
JavaScript

// 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": {"ip_address": "0.0.0.0",
"state": "stopped"
}
}

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

required

string

The unique alphanumeric string that identifies the live stream.

Responses

Response Schema: application/json

required

object (shm_metrics)

Request samples

Shell
JavaScript

// 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": {"audio_codec": {"status": "normal",
"text": "",
"units": "",
"value": "aac"
},
"bits_in_rate": {"status": "normal",
"text": "",
"units": "Kbps",
"value": 317.3
},
"bits_out_rate": {"status": "normal",
"text": "",
"units": "Kbps",
"value": 856
},
"bytes_in_rate": {"status": "normal",
"text": "",
"units": "KBps",
"value": 317.3
},
"bytes_out_rate": {"status": "normal",
"text": "",
"units": "KBps",
"value": 856
},
"configured_bytes_out_rate": {"status": "warning",
"text": "Outbound bitrate is lower than the configured bitrate. There might be a problem with the stream targets.",
"units": "Kbps",
"value": 8192
},
"connected": {"status": "normal",
"text": "",
"units": "",
"value": "Yes"
},
"frame_size": {"status": "warning",
"text": "Configured frame size is different from what Wowza Streaming Cloud is receiving from the source: 1280x720.",
"units": "",
"value": "1280x720"
},
"frame_rate": {"status": "normal",
"text": "",
"units": "FPS",
"value": 30
},
"height": {"status": "warning",
"text": "Configured height is different from what Wowza Streaming Cloud is receiving from the source: 720.",
"units": "px",
"value": 720
},
"keyframe_interval": {"status": "normal",
"text": "",
"units": "GOP",
"value": 69
},
"stream_target_status_OUTPUTIDX_STREAMTARGETIDX": {"status": "normal",
"text": "",
"units": "",
"value": "Active"
},
"unique_views": {"status": "normal",
"text": "",
"units": "%",
"value": 1030
},
"video_codec": {"status": "normal",
"text": "",
"units": "",
"value": "avc1"
},
"width": {"status": "warning",
"text": "Configured width is different from what Wowza Streaming Cloud is receiving from the source: 1280.",
"units": "px",
"value": 1280
}
}
}

➔ Next to Players