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

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.

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.

Default: americas

Note: You can't update this value after you create the stream.

Example: "region": emea

Enum: "americas" "emea"
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

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.

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.

Default: americas

Note: You can't update this value after you create the stream.

Example: "region": emea

Enum: "americas" "emea"
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

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
application/json
{
  • "real_time_stream": {
    }
}
Response samples
application/json
{
  • "real_time_stream": {
    }
}

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.

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.

Default: americas

Note: You can't update this value after you create the stream.

Example: "region": emea

Enum: "americas" "emea"
updated_at
string <date-time>

The date and time that the real-time stream was updated.

401

Unauthorized

get/real_time
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.9/real_time"
Response samples
application/json
{
  • "real_time_streams": [
    ]
}

Fetch a real-time stream

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

Request
path Parameters
id
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.

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.

Default: americas

Note: You can't update this value after you create the stream.

Example: "region": emea

Enum: "americas" "emea"
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

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
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.9/real_time/2adffc17"
Response samples
application/json
{
  • "real_time_stream": {
    }
}

Update a real-time stream

This operation updates a real-time stream.

Request
path Parameters
id
required
string

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

Request Body schema: application/json

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.

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"

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.

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.

Default: americas

Note: You can't update this value after you create the stream.

Example: "region": emea

Enum: "americas" "emea"
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

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
application/json
{
  • "real_time_stream": {
    }
}
Response samples
application/json
{
  • "real_time_stream": {
    }
}

Delete a real-time stream

This operation deletes a real-time stream.

Request
path Parameters
id
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
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/v1.9/real_time/2adffc17"
Response samples
application/json
{
  • "Example Response 1": {
    },
  • "Example Response 2": {
    },
  • "Example Response 3": {
    },
  • "Example Response 4": {
    },
  • "Example Response 5": {
    },
  • "Example Response 6": {
    },
  • "Example Response 7": {
    },
  • "Example Response 8": {
    },
  • "Example Response 9": {
    }
}
Copyright © Wowza Video. All right reserved.