VOD Streams

Operations related to video on demand (VOD) streams, which are created through the /live_streams or /transcoders resources. A VOD stream is a recording of a live stream that viewers can replay at a later date. After the broadcast is over and the live stream or transcoder is stopped, Wowza Video creates the VOD stream and generates a playback URL. See About VOD Streams to learn more.

Fetch all VOD streams

(Available from version 1.5) This operation shows limited details for VOD streams. For detailed information, fetch a single VOD 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 (vod_streams)
Array
id
string

The unique alphanumeric string that identifies the VOD stream.

name
string

A descriptive name for the VOD stream. Maximum 200 characters.

state
string

The state of the VOD stream.

Enum: "processing" "completed" "failed"
playback_enabled
boolean

Specifies whether playback is enabled for the VOD stream.

Enum: true false
created_at
string

The date and time that the VOD stream was created.

updated_at
string

The date and time that the VOD stream was updated.

401

Unauthorized

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

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

Fetch a VOD stream

(Available from version 1.5) This operation shows the details of a specific VOD stream.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the VOD stream.

Responses
200

Success

Response Schema: application/json
required
object (vod_stream)
asset_id
string

Only applies to VOD streams created for Asset Management. The id for the asset associated with your VOD stream. You can manage your asset in Asset Management.

created_at
string <date-time>

The date and time that the VOD stream was created.

duration
integer

The duration of the VOD stream.

end_segment
integer

The media sequence number of the last media segment in the chunklist.

id
string

The unique alphanumeric string that identifies the VOD stream.

name
string

A descriptive name for the VOD stream. Maximum 200 characters.

percent_complete
integer

The processing progress of the VOD stream.

playback_enabled
boolean

Specifies whether playback is enabled for the VOD stream.

Enum: true false
playback_url
string

The address that can be used to configure playback of the VOD stream.

size
integer

The size of the VOD stream.

started_at
string <date-time>

The date and time that the stream was started.

start_segment
integer

The media sequence number of the first media segment in the chunklist.

state
string

The state of the VOD stream.

Enum: "processing" "completed" "failed"
stream_target_id
integer

The unique alphanumeric string that identifies the stream target associated with the VOD stream.

source
string

The source from which the VOD stream was created. The default is live.

type
string

The VOD stream type.

updated_at
string <date-time>

The date and time that the VOD stream was updated.

uptime_id
string

The unique identifier associated with a specific uptime period of a transcoder.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

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

  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.9/vod_streams/1kfgc39"
Response samples
application/json
{
  • "vod_stream": {
    }
}

Update a VOD stream

(Available from version 1.5) This operation updates a VOD stream.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the VOD stream.

Request Body schema: application/json

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

required
object (vod_stream)
name
required
string

A descriptive name for the VOD stream. Maximum 200 characters.

Example: "name": "My updated VOD stream"

playback_enabled
boolean

Specifies whether playback is enabled for the VOD stream.

Example: "playback_enabled": true

Enum: true false
Responses
200

Success

Response Schema: application/json
required
object (vod_stream)
asset_id
string

Only applies to VOD streams created for Asset Management. The id for the asset associated with your VOD stream. You can manage your asset in Asset Management.

created_at
string <date-time>

The date and time that the VOD stream was created.

duration
integer

The duration of the VOD stream.

end_segment
integer

The media sequence number of the last media segment in the chunklist.

id
string

The unique alphanumeric string that identifies the VOD stream.

name
string

A descriptive name for the VOD stream. Maximum 200 characters.

percent_complete
integer

The processing progress of the VOD stream.

playback_enabled
boolean

Specifies whether playback is enabled for the VOD stream.

Enum: true false
playback_url
string

The address that can be used to configure playback of the VOD stream.

size
integer

The size of the VOD stream.

started_at
string <date-time>

The date and time that the stream was started.

start_segment
integer

The media sequence number of the first media segment in the chunklist.

state
string

The state of the VOD stream.

Enum: "processing" "completed" "failed"
stream_target_id
integer

The unique alphanumeric string that identifies the stream target associated with the VOD stream.

source
string

The source from which the VOD stream was created. The default is live.

type
string

The VOD stream type.

updated_at
string <date-time>

The date and time that the VOD stream was updated.

uptime_id
string

The unique identifier associated with a specific uptime period of a transcoder.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

patch/vod_streams/{id}
Request samples
application/json
{
  • "vod_stream": {
    }
}
Response samples
application/json
{
  • "vod_stream": {
    }
}

Delete a VOD stream

(Available from version 1.5) This operation deletes a VOD stream.

Note: You can't remove VOD streams that have an asset_id. Assets must be removed by sending a DEL request to the /assets endpoint.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the VOD stream.

Responses
204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

delete/vod_streams/{id}
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \

  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/v1.9/vod_streams/1kfgc39"
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.