Transcoders

Operations related to transcoders, output renditions, and output stream targets.

Transcoders

Wowza Streaming Cloud transcoders allow you to customize transcoding processes by creating transcoders that are optimized for various network or streaming conditions. When you create a transcoder through the /transcoders endpoint, you must manually configure output renditions and associated output stream targets.

Transcoders, like live streams, can be adaptive bitrate or passthrough. An adaptive bitrate transcoder generates multiple output renditions of your live stream, at different bitrates. A passthrough transcoder, in contrast, sends the source video to a stream target without performing transcoding. Passthrough transcoders, which can only be created if you have a subscription plan that supports them, accrue processing time, bandwidth, and egress usage, but much less than their adaptive bitrate counterparts.

Output Renditions

Before you can start an adaptive bitrate transcoder, you must use the /transcoders/{transcoder_id}/outputs operations to define the adaptive bitrate output renditions that you want the transcoder to create. Passthrough transcoders require only one output rendition because they send source video to a stream target without transcoding.

Output Stream Targets

Transcoders require output stream targets before you can start them. Although you create and configure stream targets using the different /stream_targets operations, you must associate a stream target to a transcoder's output rendition using the /transcoders/{transcoder_id}/outputs/{output_id}/output_stream_targets operations. For an adaptive bitrate transcoder with multiple output renditions defined, you must create output stream targets to associate a stream target to each output rendition. For a passthrough transcoder, you only need one output stream target.

Ultra low latency stream targets don’t work with transcoders, output renditions, or output stream targets. See Get started with ultra low latency streaming using the Wowza Streaming Cloud REST API to learn more.

Create a transcoder

This operation creates a transcoder.

Request Body schema: application/json

Provide the details of the transcoder to create in the body of the request.

required
object (transcoder)

Responses

Response Schema: application/json
required
object (transcoder)

Request samples

Content type
application/json
{
  • "transcoder": {
    }
}

Response samples

Content type
application/json
{
  • "transcoder": {
    }
}

Fetch all transcoders

This operation shows limited details for all of your transcoders. For detailed information, fetch a single transcoder.

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.

Valid filter fields are created_at, id, name, and state.

Valid filter operators are eq (equals), which accepts one value, and in (equals any of), which accepts a comma-separated string of values.

Filters use a zero-based index.

For example:

filter[0][field]=state&filter[0][eq]=stopped

For more information and examples, see the technical article How to get filtered query results with the Wowza Streaming Cloud REST API.

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 (transcoders)

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

Response samples

Content type
application/json
{
  • "transcoders": [
    ]
}

Fetch a transcoder

This operation shows the details of a specific transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)

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/transcoders/2adffc17"

Response samples

Content type
application/json
{
  • "transcoder": {
    }
}

Update a transcoder

This operation updates a transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Request Body schema: application/json

Provide the details of the transcoder to update in the body of the request.

required
object (transcoder)

Responses

Response Schema: application/json
required
object (transcoder)

Request samples

Content type
application/json
{
  • "transcoder": {
    }
}

Response samples

Content type
application/json
{
  • "transcoder": {
    }
}

Delete a transcoder

This operation deletes a transcoder, including all of its assigned output renditions and stream targets.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

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

Enable a transcoder's stream targets

This operation enables all of the stream targets assigned to a specific transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)

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/transcoders/2adffc17/enable_all_stream_targets"

Response samples

Content type
application/json
{
  • "transcoder": {
    }
}

Disable a transcoder's stream targets

This operation disables all of the stream targets assigned to a specific transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)

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/transcoders/2adffc17/disable_all_stream_targets"

Response samples

Content type
application/json
{
  • "transcoder": {
    }
}

Start a transcoder

This operation starts a transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)

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/transcoders/2adffc17/start"

Response samples

Content type
application/json
{
  • "transcoder": {
    }
}

Stop a transcoder

This operation stops a transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)

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/transcoders/2adffc17/stop"

Response samples

Content type
application/json
{
  • "transcoder": {
    }
}

Reset a transcoder

This operation resets a transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)

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/transcoders/2adffc17/reset"

Response samples

Content type
application/json
{
  • "transcoder": {
    }
}

Start recording

This operation starts the recording of a transcoder after the transcoder has started. If you want the recording to start and stop automatically when you start or stop the transcoder instead, set recording to true when you Create a transcoder or Update a transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)

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/transcoders/2adffc17/start_recording"

Response samples

Content type
application/json
{
  • "transcoder": {
    }
}

Stop recording

This operation stops the recording of a transcoder before the transcoder has stopped. Wowza Streaming Cloud begins converting the recording to an MP4 file after the transcoder has stopped. You can use this operation to manually stop recording even if recording is set to true on the transcoder, meaning the recording was automatically started at transcoder start. If you want the recording to start and stop automatically when you start and stop the transcoder, set recording to true when you Create a transcoder or Update a transcoder and then don't use the manual stop recording operation.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)

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/transcoders/2adffc17/stop_recording"

Response samples

Content type
application/json
{
  • "transcoder": {
    }
}

Fetch a transcoder's recordings

This operation shows limited details of all of the recordings for a specific transcoder. For detailed information about a recording, use the recording ID to Fetch a recording.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
Array of objects (recordings)

Array of recordings of this transcoder. See /recordings for more details.

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/transcoders/2adffc17/recordings"

Response samples

Content type
application/json
{
  • "recordings": [
    ]
}

Fetch transcoder's schedules

This operation shows the details of all of the schedules for a specific transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
Array of objects (schedule)

Array of schedules of this transcoder. See /schedules for more details.

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/transcoders/2adffc17/schedules"

Response samples

Content type
application/json
{
  • "schedules": [
    ]
}

Fetch the thumbnail URL of a transcoder

This operation shows the thumbnail URL of a started transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)

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/transcoders/2adffc17/thumbnail_url"

Response samples

Content type
application/json

Fetch the state and uptime ID of a transcoder

This operation shows the current state and uptime ID of a transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)

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/transcoders/2adffc17/state"

Response samples

Content type
application/json
{
  • "transcoder": {
    }
}

Fetch statistics for a current transcoder

This operation responds with a hash of metrics (keys) for a currently running transcoder. Each key has a status, text (description), units, and value.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

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/transcoders/2adffc17/stats"

Response samples

Content type
application/json
{
  • "transcoder": {
    }
}

Fetch all VOD streams for a transcoder

(Available from version 1.5) This operation shows the details of all VOD streams associated to a specific transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
Array of objects (vod_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/transcoders/2adffc17/vod_streams"

Response samples

Content type
application/json
{
  • "vod_streams": [
    ]
}

Fetch all uptime records for a transcoder

This operation shows all of the uptime records for a specific transcoder. An uptime record identifies a specific transcoding session.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

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 (uptime)

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/transcoders/2adffc17/uptimes"

Response samples

Content type
application/json
{
  • "uptimes": [
    ]
}

Fetch an uptime record

This operation shows the details of a specific uptime record for a specific transcoder. An uptime record identifies a transcoding session.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

The unique alphanumeric string that identifies the uptime record.

Responses

Response Schema: application/json
required
object (uptime)

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/transcoders/2adffc17/uptimes/1acfg43d"

Response samples

Content type
application/json
{
  • "uptime": {
    }
}

Fetch current stream health metrics for an active transcoder

This operation returns a snapshot of the current source connection and processing details of an active (running) transcoder.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

The unique alphanumeric string that identifies the uptime record.

query Parameters
fields
string

A comma-separated list of fields to return.

Responses

Response Schema: application/json
required
object (shm_metrics)
required
object (limits)

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/transcoders/2adffc17/uptimes/1acfg43d/metrics/current"

Response samples

Content type
application/json
{
  • "current": {
    },
  • "limits": {
    }
}

Fetch historic stream health metrics for a transcoder

This operation shows the historic source connection and processing details for a transcoding session (uptime record). The transcoder can be running or stopped. Metrics are recorded every 20 seconds.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

The unique alphanumeric string that identifies the uptime record.

query Parameters
fields
string

A comma-separated list of fields to return.

from
string

The start of the range of time used to aggregate the metrics. Express the value by using the ISO 8601 standard of YYYY-MM-DDTHH:MM:SSZ where HH is a 24-hour clock in UTC.

to
string

The end of the range of time used to aggregate the metrics. Express the value by using the ISO 8601 standard of YYYY-MM-DDTHH:MM:SSZ where HH is a 24-hour clock in UTC.

Responses

Response Schema: application/json
required
Array of objects (shm_historic_metrics)
required
object (limits)

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/transcoders/2adffc17/uptimes/1acfg43d/metrics/historic"

Response samples

Content type
application/json
{
  • "historic": [
    ],
  • "limits": {
    }
}

Create an output

This operation creates an output rendition for a specific transcoder. You can create up to 10 outputs per transcoder.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

Request Body schema: application/json

Provide the details of the output rendition to create in the body of the request.

required
object (output)

Responses

Response Schema: application/json
required
object (output)

Request samples

Content type
application/json
{
  • "output": {
    }
}

Response samples

Content type
application/json
{
  • "output": {
    }
}

Fetch all outputs of a transcoder

This operation shows the details of all of the output renditions of a specific transcoder.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
Array of objects (output)

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/transcoders/2adffc17/outputs"

Response samples

Content type
application/json
{
  • "outputs": [
    ]
}

Fetch an output

This operation shows the details of a specific output rendition for a specific transcoder.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

The unique alphanumeric string that identifies the output rendition.

Responses

Response Schema: application/json
required
object (output)

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/transcoders/2adffc17/outputs/1acfg43d"

Response samples

Content type
application/json
{
  • "output": {
    }
}

Update an output

This operation updates an output rendition.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

The unique alphanumeric string that identifies the output rendition.

Request Body schema: application/json

Provide the details of the output rendition to update in the body of the request.

required
object (output)

Responses

Response Schema: application/json
required
object (output)

Request samples

Content type
application/json
{
  • "output": {
    }
}

Response samples

Content type
application/json
{
  • "output": {
    }
}

Delete an output

This operation deletes an output, including all of its assigned targets.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

The unique alphanumeric string that identifies the output rendition.

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/transcoders/2adffc17/outputs/1acfg43d"

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

Create an output stream target

This operation creates an output stream target. Ultra low latency stream targets can't be added to output renditions.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

Request Body schema: application/json

Provide the details of the output stream target to create in the body of the request. Ultra low latency stream targets can't be added to output renditions.

required
object (output_stream_target)

Responses

Response Schema: application/json
required
object (output_stream_target)

Request samples

Content type
application/json
{
  • "output_stream_target": {
    }
}

Response samples

Content type
application/json
{
  • "output_stream_target": {
    }
}

Fetch all output stream targets of an output of a transcoder

This operation shows the details of all of the output stream targets of an output of a transcoder.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

Responses

Response Schema: application/json
required
Array of objects (output_stream_target)

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/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets"

Response samples

Content type
application/json
{
  • "output_stream_targets": [
    ]
}

Fetch an output stream target

This operation shows the details of an output stream target.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
object (output_stream_target)

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/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77"

Response samples

Content type
application/json
{
  • "output_stream_target": {
    }
}

Update an output stream target

This operation updates an output stream target.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

Request Body schema: application/json

Provide the details of the output stream target to update in the body of the request.

required
object (output_stream_target)

Responses

Response Schema: application/json
required
object (output_stream_target)

Request samples

Content type
application/json
{
  • "output_stream_target": {
    }
}

Response samples

Content type
application/json
{
  • "output_stream_target": {
    }
}

Delete an output stream target

This operation deletes an output stream target, including all of its assigned targets.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

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/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77"

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

Enable an output stream target

This operation enables an output stream target.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
required
object (stream_target)

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/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/enable"

Response samples

Content type
application/json
{
  • "stream_target": {
    }
}

Disable an output stream target

This operation disables an output stream target.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
required
object (stream_target)

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/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/disable"

Response samples

Content type
application/json
{
  • "stream_target": {
    }
}

Restart an output stream target

This operation restarts an output stream target.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
required
object (stream_target)

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/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/restart"

Response samples

Content type
application/json
{
  • "stream_target": {
    }
}

Configure a property for a transcoder

This operation configures a property for a transcoder. For more information see Set advanced properties with the Wowza Streaming Cloud REST API.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

Request Body schema: application/json

Provide the details of the property to configure in the body of the request.

required
object (property)

Responses

Response Schema: application/json
required
object (transcoder_property)

Request samples

Content type
application/json
{
  • "property": {
    }
}

Response samples

Content type
application/json
{
  • "property": {
    }
}

Fetch a transcoder's properties

This operation shows all of the properties of a specific transcoder.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
Array of objects (transcoder_property)

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/transcoders/2adffc17/properties"

Response samples

Content type
application/json
{
  • "properties": [
    ]
}

Fetch a property for a transcoder

This operation shows the details of a specific property for a specific transcoder.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

The unique string that identifies the transcoder property. The string contains the section and the key, connected by a dash. For example, cupertino-cupertinoProgramDateTimeOffset.

Responses

Response Schema: application/json
object (transcoder_property)

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/transcoders/2adffc17/properties/cupertino-cupertinoProgramDateTimeOffset"

Response samples

Content type
application/json
{
  • "property": {
    }
}

Delete a transcoder's property

This operation deletes a specific property from a specific transcoder.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

The unique string that identifies the transcoder property. The string contains the section and the key, connected by a dash. For example, cupertino-cupertinoProgramDateTimeOffset.

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/transcoders/2adffc17/properties/cupertino-cupertinoProgramDateTimeOffset"

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": {
    }
}
➔ Next to Stream Sources