Real-Time Streams

Operations related to Real-Time Streaming at Scale. If your audience is fewer than 300 viewers or you want to deliver a stream in near real time alongside other delivery protocols, use our WebRTC solution.

To enable and purchase capacity for Real-Time Streaming at Scale for your account and access the /real_time operations, contact 720.279.8163 or schedule a call.

Create a real-time stream

This operation creates a real-time stream.

Request

Request Body schema: application/json
required

Provide the details of the real-time stream to create in the body of the request.

object (real_time_stream)

name required	string A descriptive name for the real-time stream. Maximum 255 characters. Note: If you record a real-time stream, the name is used to for the recording file name. To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names, so the recording file name might vary from the name you provided here.
description	string An optional description of the real-time stream.
disable_vod_encoder	boolean Skips VOD encoding and only creates an MP4 file for download. No VOD stream is created from the real-time stream. Can only be set when recording is true and you can't change this value after you create the stream. Default: false Example: `"disable_vod_encoder": true`
enable_secure_viewer	boolean Require viewers to pass a security token for playback. Example: `"enable_secure_viewer": false`
expires_on	string <date-time> The date and time the security token expires. Specify YYYY-MM-DD HH:MM:SS, where HH is a 24-hour clock in UTC. If you don't specify HH:MM:SS, the token expires at 12AM UTC on the specified day. Required when enable_secure_viewer is true. Example: `"expires_on": "2021-10-27 23:08:55 UTC"`
region	string An option to set the regional server the stream is distributed through. Select the region closest to your broadcast location for the most reliable stream. If you select the auto option, Wowza Video selects the region based on the publisher's location. Default: phoenix Example: `"region": amsterdam` Enum: "phoenix" "amsterdam" "singapore" "bangalore" "auto"
recording	boolean If true, records the real-time stream so you can download an MP4 later. The recording starts when the stream starts and stops automatically when the stream stops. Recordings for real-time streams capture up to twelve hours of content in a single MP4 file. If the real-time stream recording is longer twelve hours, you'll have multiple files for the recording. Default: false Note: You can't update this value after you create the stream. Example: `"recording": true`
reference_id	string A unique, alphanumeric ID returned in real-time stream webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with real-time stream 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.12. Example:* `"reference_id": "mySystemID_01"`
enable_player_and_hosted_page	boolean If true, enables a player and hosted page for the real-time stream. Default: true Note: You can't update this value after you create the stream. Example: `"enable_player_and_hosted_page": true`
	object The player object is deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player object will be ignored. The following fields have been moved outside of the player object and reside within the real_time_stream object where you can still access them through the API: logo_image logo_position video_poster_image width
player_id	string (Available from version 2.0) The unique alphanumeric string that identifies the player configuration to use for this stream. When you pass a player configuration ID, Wowza Video uses that player configuration to customize and style the player. If you don't pass a value, the default player configuration for the account is used. Create and edit player configurations in the user interface. The ID is on the General tab for the player configuration. Default: Default player configuration Example: 2205b4e8-b160-43c2-868d-d88698a4e850
logo_image	string A Base64-encoded string representation of a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller. Example: `"logo_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"`
logo_position	string The corner of the player in which you want the player logo to appear. The default is top-left. Example: `"logo_position": "top-right"` Enum: "top-left" "top-right" "bottom-left" "bottom-right"
video_poster_image	string The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller. Example: `"video_poster_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"`
width	integer <int32> The width, in pixels, of a fixed-size player. The default is 640. Example: `"width": 640`
	object Configuration of the hosted page.

Responses

201

Success

Response Schema: application/json

required

object (real_time_stream)

created_at	string <date-time> The date and time that the real-time stream was created.
id	string The unique identifier of the real-time stream. Use this ID to perform other operations on the stream, like getting the details of the stream or deleting it.
name	string A descriptive name for the real-time stream.
stream_name	string The generated alphanumeric stream name you pass to the SDK.
token	string The authentication token you pass to the SDK.
subscribe_token	string A secure token that must be passed by viewers for playback. Generated after you set enable_secure_viewer to true.
rtmp_url	string The URL you can use to configure an RTMP encoder as the source.
enable_secure_viewer	boolean Require viewers to pass a security token for playback.
expires_on	string <date-time> The date and time the security token expires. Specify YYYY-MM-DD HH:MM:SS, where HH is a 24-hour clock in UTC. If you don't specify HH:MM:SS, the token expires at 12AM UTC on the specified day. Required when enable_secure_viewer is true.
state	string The state of the stream. Enum: "started" "stopped" "disabled"
region	string An option to set the regional server the stream is distributed through. Select the region closest to your broadcast location for the most reliable stream. If you select the auto option, Wowza Video selects the region based on the publisher's location. Default: phoenix Example: `"region": amsterdam` Enum: "phoenix" "amsterdam" "singapore" "bangalore" "auto"
recording	boolean If true, records the real-time stream so you can download an MP4 later. The recording starts when the stream starts and stops automatically when the stream stops. Recordings for real-time streams capture up to twelve hours of content in a single MP4 file. If the real-time stream recording is longer twelve hours, you'll have multiple files for the recording. Default: false Note: You can't update this value after you create the stream. Example: `"recording": true`
reference_id	string A unique, alphanumeric ID returned in real-time stream webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with real-time stream 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.12. Example:* `"reference_id": "mySystemID_01"`
disable_vod_encoder	boolean Skips VOD encoding and only creates an MP4 file for download. No VOD stream is created from the real-time stream. Can only be set when recording is true and you can't change this value after you create the stream. Default: false Example: `"disable_vod_encoder": true`
description	string An optional description of the real-time stream.
enable_player_and_hosted_page	boolean If true, enables a player and hosted page for the real-time stream. Default: true Note: You can't update this value after you create the stream. Example: `"enable_player_and_hosted_page": true`
	object The player object is deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player object will be ignored. The following fields have been moved outside of the player object and reside within the real_time_stream object where you can still access them through the API: embed_code logo_image_url logo_position video_poster_image_url width
player_id	string (Available from version 2.0) The unique alphanumeric string that identifies the player configuration to use for this stream. When you pass a player configuration ID, Wowza Video uses that player configuration to customize and style the player. If you don't pass a value, the default player configuration for the account is used. Create and edit player configurations in the user interface. The ID is on the General tab for the player configuration. Default: Default player configuration Note: player_id is not returned in the response if it's not explicitly sent and the default player configuration is used instead. Example: 2205b4e8-b160-43c2-868d-d88698a4e850
player_type	string (Available from version 2.0) The type of player associated with the stream. Streams created in legacy Wowza Video have a player type of wowza_flowplayer_v1. Streams created in later versions of Wowza Video have a player type of wowza_flowplayer_v2. Knowing the player type is useful if you've migrated streams from legacy Wowza Video. The player for a stream created in the legacy version of Wowza Video isn't editable in the new platform. Example: wowza_flowplayer_v1 Enum: "wowza_flowplayer_v1" "wowza_flowplayer_v2"
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 and Wowza players are the players available for Wowza Streaming Cloud subscribers.
embed_code	string The HTML code that can be used in an external webpage to host the Wowza Flowplayer.
logo_image_url	string The path to a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.
logo_position	string The corner of the player in which you want the player logo to appear. The default is top-left. Example: `"logo_position": "top-right"` Enum: "top-left" "top-right" "bottom-left" "bottom-right"
video_poster_image_url	string The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.
width	integer <int32> The width, in pixels, of a fixed-size player. The default is 640. Example: `"width": 640`
	object Configuration of the hosted page.
updated_at	string <date-time> The date and time the real-time stream was updated.

401

Unauthorized

422

Unprocessable Entity

post/real_time

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"real_time_stream": {"name": "MyRealTimeStream",
"description": "This is my first real-time stream."
}
}

Response samples

application/json

{"real_time_stream": {"id": "2adffc17",
"name": "MyRealTimeStream",
"stream_name": "8d304b93f1684320a54f2798666eeca7",
"token": "97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc",
"rtmp_url": "rtmp://rtmp-realtime1.wowza.com:1935/v2/pub/8d304b93f1684320a54f2798666eeca7?token=97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc",
"enable_secure_viewer": false,
"state": "started",
"region": "amsterdam",
"recording": true,
"reference_id": "mySystemID_01",
"disable_vod_encoder": true,
"description": "This is my first real-time stream.",
"enable_player_and_hosted_page": true,
"player_id": "2205b4e8-b160-43c2-868d-d88698a4e850",
"player_type": "wowza_flowplayer_v2",
"flowplayer": true,
"embed_code": null,
"logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg",
"logo_position": "top-right",
"video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg",
"width": 640,
"hosted_page": {"title": "MyRealTimeStreamHostedPage",
"url": "https://embed.flowplayer.com/hosted/default/e8dk5bf6",
"description": "My hosted page description",
"sharing_icons": true
},
"created_at": "2021-06-30T18:02:20.000Z",
"updated_at": "2021-06-30T20:03:16.000Z"
}
}

Fetch all real-time streams

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

Request

query Parameters

filter	string Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter. Filters use a zero-based index. For valid filter operators and filter fields, see How to get filtered query results with the Wowza Video REST API. Example: filter[0][field]=state&filter[0][eq]=stopped
page	integer Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1. For more information and examples, see Get paginated query results with the Wowza Video REST API.
per_page	integer For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000.

Responses

200

Success

Response Schema: application/json

required

Array of objects (real_time_streams)

Array

created_at	string <date-time> The date and time that the real-time stream was created.
id	string The unique alphanumeric string that identifies the real-time stream.
name	string A descriptive name for the real-time stream.
state	string The state of the stream. Enum: "active" "archived" "disabled" "stopped"
updated_at	string <date-time> The date and time that the real-time stream was updated.

401

Unauthorized

get/real_time

Request samples

Shell
JavaScript
Java
Python

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

Response samples

application/json

{"real_time_streams": [{"id": "2adffc17",
"name": "MyRealTimeStream",
"state": "started",
"created_at": "2021-01-29T17:16:21.849Z",
"updated_at": "2021-01-31T16:06:47.849Z"
},
{"id": "if7le8ip",
"name": "MyRealTimeStream2",
"state": "started",
"created_at": "2020-01-29T17:16:21.849Z",
"updated_at": "2020-01-31T02:26:05.849Z"
},
{"id": "dd4udt1b",
"name": "MyRealTimeStream3",
"state": "started",
"created_at": "2020-01-29T17:16:21.849Z",
"updated_at": "2020-01-30T18:13:18.849Z"
}
]
}

Fetch a real-time stream

This operation shows the details of a specific real-time stream.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the real-time stream.

Responses

200

Success

Response Schema: application/json

required

object (real_time_stream)

created_at	string <date-time> The date and time that the real-time stream was created.
id	string The unique identifier of the real-time stream. Use this ID to perform other operations on the stream, like getting the details of the stream or deleting it.
name	string A descriptive name for the real-time stream.
stream_name	string The generated alphanumeric stream name you pass to the SDK.
token	string The authentication token you pass to the SDK.
subscribe_token	string A secure token that must be passed by viewers for playback. Generated after you set enable_secure_viewer to true.
rtmp_url	string The URL you can use to configure an RTMP encoder as the source.
enable_secure_viewer	boolean Require viewers to pass a security token for playback.
expires_on	string <date-time> The date and time the security token expires. Specify YYYY-MM-DD HH:MM:SS, where HH is a 24-hour clock in UTC. If you don't specify HH:MM:SS, the token expires at 12AM UTC on the specified day. Required when enable_secure_viewer is true.
state	string The state of the stream. Enum: "started" "stopped" "disabled"
region	string An option to set the regional server the stream is distributed through. Select the region closest to your broadcast location for the most reliable stream. If you select the auto option, Wowza Video selects the region based on the publisher's location. Default: phoenix Example: `"region": amsterdam` Enum: "phoenix" "amsterdam" "singapore" "bangalore" "auto"
recording	boolean If true, records the real-time stream so you can download an MP4 later. The recording starts when the stream starts and stops automatically when the stream stops. Recordings for real-time streams capture up to twelve hours of content in a single MP4 file. If the real-time stream recording is longer twelve hours, you'll have multiple files for the recording. Default: false Note: You can't update this value after you create the stream. Example: `"recording": true`
reference_id	string A unique, alphanumeric ID returned in real-time stream webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with real-time stream 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.12. Example:* `"reference_id": "mySystemID_01"`
disable_vod_encoder	boolean Skips VOD encoding and only creates an MP4 file for download. No VOD stream is created from the real-time stream. Can only be set when recording is true and you can't change this value after you create the stream. Default: false Example: `"disable_vod_encoder": true`
description	string An optional description of the real-time stream.
enable_player_and_hosted_page	boolean If true, enables a player and hosted page for the real-time stream. Default: true Note: You can't update this value after you create the stream. Example: `"enable_player_and_hosted_page": true`
	object The player object is deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player object will be ignored. The following fields have been moved outside of the player object and reside within the real_time_stream object where you can still access them through the API: embed_code logo_image_url logo_position video_poster_image_url width
player_id	string (Available from version 2.0) The unique alphanumeric string that identifies the player configuration to use for this stream. When you pass a player configuration ID, Wowza Video uses that player configuration to customize and style the player. If you don't pass a value, the default player configuration for the account is used. Create and edit player configurations in the user interface. The ID is on the General tab for the player configuration. Default: Default player configuration Note: player_id is not returned in the response if it's not explicitly sent and the default player configuration is used instead. Example: 2205b4e8-b160-43c2-868d-d88698a4e850
player_type	string (Available from version 2.0) The type of player associated with the stream. Streams created in legacy Wowza Video have a player type of wowza_flowplayer_v1. Streams created in later versions of Wowza Video have a player type of wowza_flowplayer_v2. Knowing the player type is useful if you've migrated streams from legacy Wowza Video. The player for a stream created in the legacy version of Wowza Video isn't editable in the new platform. Example: wowza_flowplayer_v1 Enum: "wowza_flowplayer_v1" "wowza_flowplayer_v2"
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 and Wowza players are the players available for Wowza Streaming Cloud subscribers.
embed_code	string The HTML code that can be used in an external webpage to host the Wowza Flowplayer.
logo_image_url	string The path to a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.
logo_position	string The corner of the player in which you want the player logo to appear. The default is top-left. Example: `"logo_position": "top-right"` Enum: "top-left" "top-right" "bottom-left" "bottom-right"
video_poster_image_url	string The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.
width	integer <int32> The width, in pixels, of a fixed-size player. The default is 640. Example: `"width": 640`
	object Configuration of the hosted page.
updated_at	string <date-time> The date and time the real-time stream was updated.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/real_time/{id}

Request samples

Shell
JavaScript
Java
Python

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

Response samples

application/json

{"real_time_stream": {"id": "2adffc17",
"name": "MyRealTimeStream",
"stream_name": "8d304b93f1684320a54f2798666eeca7",
"token": "97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc",
"rtmp_url": "rtmp://rtmp-realtime1.wowza.com:1935/v2/pub/8d304b93f1684320a54f2798666eeca7?token=97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc",
"enable_secure_viewer": false,
"state": "started",
"region": "amsterdam",
"recording": true,
"reference_id": "mySystemID_01",
"disable_vod_encoder": true,
"description": "This is my first real-time stream.",
"enable_player_and_hosted_page": true,
"player_id": "2205b4e8-b160-43c2-868d-d88698a4e850",
"player_type": "wowza_flowplayer_v2",
"flowplayer": true,
"embed_code": null,
"logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg",
"logo_position": "top-right",
"video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg",
"width": 640,
"hosted_page": {"title": "MyRealTimeStreamHostedPage",
"url": "https://embed.flowplayer.com/hosted/default/e8dk5bf6",
"description": "My hosted page description",
"sharing_icons": true
},
"created_at": "2021-06-30T18:02:20.000Z",
"updated_at": "2021-06-30T20:03:16.000Z"
}
}

Update a real-time stream

This operation updates a real-time stream.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the real-time stream.

Request Body schema: application/json
required

Provide the details of the real-time stream to update in the body of the request.

object (real_time_stream)

name required	string A descriptive name for the real-time stream. Maximum 255 characters. Note: If you record a real-time stream, the name is used to for the recording file name. To avoid file management issues in storage, Wowza Video removes or replaces special characters in file names, so the recording file name might vary from the name you provided here.
description	string An optional description of the real-time stream.
enable_secure_viewer	boolean Require viewers to pass a security token for playback. Example: `"enable_secure_viewer": false`
expires_on	string <date-time> The date and time the security token expires. Specify YYYY-MM-DD HH:MM:SS, where HH is a 24-hour clock in UTC. If you don't specify HH:MM:SS, the token expires at 12AM UTC on the specified day. Required when enable_secure_viewer is true. Example: `"expires_on": "2021-10-27 23:08:55 UTC"`
region	string An option to set the regional server the stream is distributed through. Select the region closest to your broadcast location for the most reliable stream. If you select the auto option, Wowza Video selects the region based on the publisher's location. Default: phoenix Example: `"region": amsterdam` Enum: "phoenix" "amsterdam" "singapore" "bangalore" "auto"
reference_id	string A unique, alphanumeric ID returned in real-time stream webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with real-time stream 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.12. Example:* `"reference_id": "mySystemID_01"`
	object The player object is deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player object will be ignored. The following fields have been moved outside of the player object and reside within the real_time_stream object where you can still access them through the API: logo_image logo_position video_poster_image remove_video_poster_image remove_logo_image width
player_id	string (Available from version 2.0) The unique alphanumeric string that identifies the player configuration to use for this stream. When you pass a player configuration ID, Wowza Video uses that player configuration to customize and style the player. If you don't pass a value, the default player configuration for the account is used. Create and edit player configurations in the user interface. The ID is on the General tab for the player configuration. Default: Default player configuration Example: 2205b4e8-b160-43c2-868d-d88698a4e850
video_poster_image	string The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller. Example: `"video_poster_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"`
logo_image	string A Base64-encoded string representation of a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller. Example: `"logo_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"`
logo_position	string The corner of the player in which you want the player logo to appear. The default is top-left. Example: `"logo_position": "top-right"` Enum: "top-left" "top-right" "bottom-left" "bottom-right"
remove_logo_image	boolean If true, removes the logo file from the player. The default is false. Example: `"remove_logo_image": true`
remove_video_poster_image	boolean If true, removes the poster image. The default is false. Example: `"remove_video_poster_image": true`
width	integer <int32> The width, in pixels, of a fixed-size player. The default is 640. Example: `"width": 640`
	object Configuration of the hosted page.

Responses

200

Success

Response Schema: application/json

required

object (real_time_stream)

created_at	string <date-time> The date and time that the real-time stream was created.
id	string The unique identifier of the real-time stream. Use this ID to perform other operations on the stream, like getting the details of the stream or deleting it.
name	string A descriptive name for the real-time stream.
stream_name	string The generated alphanumeric stream name you pass to the SDK.
token	string The authentication token you pass to the SDK.
subscribe_token	string A secure token that must be passed by viewers for playback. Generated after you set enable_secure_viewer to true.
rtmp_url	string The URL you can use to configure an RTMP encoder as the source.
enable_secure_viewer	boolean Require viewers to pass a security token for playback.
expires_on	string <date-time> The date and time the security token expires. Specify YYYY-MM-DD HH:MM:SS, where HH is a 24-hour clock in UTC. If you don't specify HH:MM:SS, the token expires at 12AM UTC on the specified day. Required when enable_secure_viewer is true.
state	string The state of the stream. Enum: "started" "stopped" "disabled"
region	string An option to set the regional server the stream is distributed through. Select the region closest to your broadcast location for the most reliable stream. If you select the auto option, Wowza Video selects the region based on the publisher's location. Default: phoenix Example: `"region": amsterdam` Enum: "phoenix" "amsterdam" "singapore" "bangalore" "auto"
recording	boolean If true, records the real-time stream so you can download an MP4 later. The recording starts when the stream starts and stops automatically when the stream stops. Recordings for real-time streams capture up to twelve hours of content in a single MP4 file. If the real-time stream recording is longer twelve hours, you'll have multiple files for the recording. Default: false Note: You can't update this value after you create the stream. Example: `"recording": true`
reference_id	string A unique, alphanumeric ID returned in real-time stream webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with real-time stream 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.12. Example:* `"reference_id": "mySystemID_01"`
disable_vod_encoder	boolean Skips VOD encoding and only creates an MP4 file for download. No VOD stream is created from the real-time stream. Can only be set when recording is true and you can't change this value after you create the stream. Default: false Example: `"disable_vod_encoder": true`
description	string An optional description of the real-time stream.
enable_player_and_hosted_page	boolean If true, enables a player and hosted page for the real-time stream. Default: true Note: You can't update this value after you create the stream. Example: `"enable_player_and_hosted_page": true`
	object The player object is deprecated in 2.0. Create and update player configurations in the user interface. Any values you send using the player object will be ignored. The following fields have been moved outside of the player object and reside within the real_time_stream object where you can still access them through the API: embed_code logo_image_url logo_position video_poster_image_url width
player_id	string (Available from version 2.0) The unique alphanumeric string that identifies the player configuration to use for this stream. When you pass a player configuration ID, Wowza Video uses that player configuration to customize and style the player. If you don't pass a value, the default player configuration for the account is used. Create and edit player configurations in the user interface. The ID is on the General tab for the player configuration. Default: Default player configuration Note: player_id is not returned in the response if it's not explicitly sent and the default player configuration is used instead. Example: 2205b4e8-b160-43c2-868d-d88698a4e850
player_type	string (Available from version 2.0) The type of player associated with the stream. Streams created in legacy Wowza Video have a player type of wowza_flowplayer_v1. Streams created in later versions of Wowza Video have a player type of wowza_flowplayer_v2. Knowing the player type is useful if you've migrated streams from legacy Wowza Video. The player for a stream created in the legacy version of Wowza Video isn't editable in the new platform. Example: wowza_flowplayer_v1 Enum: "wowza_flowplayer_v1" "wowza_flowplayer_v2"
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 and Wowza players are the players available for Wowza Streaming Cloud subscribers.
embed_code	string The HTML code that can be used in an external webpage to host the Wowza Flowplayer.
logo_image_url	string The path to a GIF, JPEG, or PNG logo file that appears partially transparent in a corner of the player throughout playback. Logo file must be 2.5 MB or smaller.
logo_position	string The corner of the player in which you want the player logo to appear. The default is top-left. Example: `"logo_position": "top-right"` Enum: "top-left" "top-right" "bottom-left" "bottom-right"
video_poster_image_url	string The path to a GIF, JPEG, or PNG poster image that appears in the player before the stream begins. Poster image files must be 2.5 MB or smaller.
width	integer <int32> The width, in pixels, of a fixed-size player. The default is 640. Example: `"width": 640`
	object Configuration of the hosted page.
updated_at	string <date-time> The date and time the real-time stream was updated.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

patch/real_time/{id}

Request samples

Payload
Shell
JavaScript
Java
Python

application/json

{"real_time_stream": {"name": "MyUpdatedRealTimeStream",
"description": "This is my first real-time stream."
}
}

Response samples

application/json

{"real_time_stream": {"id": "2adffc17",
"name": "MyRealTimeStream",
"stream_name": "8d304b93f1684320a54f2798666eeca7",
"token": "97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc",
"rtmp_url": "rtmp://rtmp-realtime1.wowza.com:1935/v2/pub/8d304b93f1684320a54f2798666eeca7?token=97e52731bc21ef66e4c05a8ee1e28b64bf5f9db728573d94e690277cea9215bc",
"enable_secure_viewer": false,
"state": "started",
"region": "amsterdam",
"recording": true,
"reference_id": "mySystemID_01",
"disable_vod_encoder": true,
"description": "This is my first real-time stream.",
"enable_player_and_hosted_page": true,
"player_id": "2205b4e8-b160-43c2-868d-d88698a4e850",
"player_type": "wowza_flowplayer_v2",
"flowplayer": true,
"embed_code": null,
"logo_image_url": "https://prod.s3.amazonaws.com/uploads/player/logo_image/23424/5bad28.jpg",
"logo_position": "top-right",
"video_poster_image_url": "https://prod.s3.amazonaws.com/uploads/player/video_poster_image/23424/5bad28.jpg",
"width": 640,
"hosted_page": {"title": "MyRealTimeStreamHostedPage",
"url": "https://embed.flowplayer.com/hosted/default/e8dk5bf6",
"description": "My hosted page description",
"sharing_icons": true
},
"created_at": "2021-06-30T18:02:20.000Z",
"updated_at": "2021-06-30T20:03:16.000Z"
}
}

Delete a real-time stream

This operation deletes a real-time stream.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the real-time stream.

Responses

204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

delete/real_time/{id}

Request samples

Shell
JavaScript
Java
Python

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

Response samples

application/json

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

Fetch the state of a real-time stream

This operation shows the current state of a real-time stream.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the real-time stream.

Responses

200

Success

Response Schema: application/json

required

object (real_time)

state

string

The state of the real-time stream.

Enum: "started" "stopped" "disabled"

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/real_time/{id}/state

Request samples

Shell
JavaScript
Java
Python

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

Response samples

application/json

{"real_time": {"state": "stopped"
}
}

Stop a real-time stream

This operation stops a real-time stream.

Request

path Parameters

required

string

The unique alphanumeric string that identifies the real-time stream.

Responses

200

Success

Response Schema: application/json

required

object (real_time_stream)

state

string

The state of the real-time stream.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

423

Locked

put/real_time/stop/{id}

Request samples

Shell
JavaScript
Java
Python

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

Response samples

application/json

{"real_time_stream": {"state": "stopped"
}
}

Real-Time Streams

Create a real-time stream

Request Body schema: application/jsonrequired

Response Schema: application/json

Fetch all real-time streams

query Parameters

Response Schema: application/json

Fetch a real-time stream

path Parameters

Response Schema: application/json

Update a real-time stream

path Parameters

Request Body schema: application/jsonrequired

Response Schema: application/json

Delete a real-time stream

path Parameters

Fetch the state of a real-time stream

path Parameters

Response Schema: application/json

Stop a real-time stream

path Parameters

Response Schema: application/json

Request Body schema: application/json
required

Request Body schema: application/json
required