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

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)

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)

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)

Responses

Response Schema: application/json
required
object (live_stream)

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)

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)

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)

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)

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)

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)

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)

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