Transcoders

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

Transcoders

Wowza Video 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.

Create a transcoder

This operation creates a transcoder.

Request
Request Body schema: application/json

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

required
object (transcoder)
billing_mode
required
string

The billing mode for the transcoder. The default is pay_as_you_go.

Enum: "pay_as_you_go" "twentyfour_seven"
broadcast_location
required
string

The location where Wowza Video transcodes your stream. Choose a location as close as possible to your video source.

Enum: "asia_pacific_australia" "asia_pacific_india" "asia_pacific_japan" "asia_pacific_singapore" "asia_pacific_s_korea" "asia_pacific_taiwan" "eu_belgium" "eu_germany" "eu_ireland" "south_america_brazil" "us_central_iowa" "us_east_s_carolina" "us_east_virginia" "us_west_california" "us_west_oregon"
delivery_method
required
string

The type of connection between the source encoder and the transcoder. The default, pull, instructs the transcoder to pull the video from the source. push instructs the source to push the stream to the transcoder. cdn uses a stream source to deliver the stream to the transcoder.

Enum: "pull" "cdn" "push"
name
required
string

A descriptive name for the transcoder. Maximum 200 characters.

protocol
required
string

The transport protocol for the source video. The default is rtmp.

Enum: "file" "rtmp" "rtsp" "srt" "udp" "webrtc"
transcoder_type
required
string

The type of transcoder, either transcoded for streams that are transcoded into adaptive bitrate renditions or passthrough for streams that aren't processed by the transcoder. The default is transcoded.

Enum: "transcoded" "passthrough"
buffer_size
integer <int32>

The size, in milliseconds, of the incoming buffer. 0 means no buffer. The default is 4000 (4 seconds).

Example: "buffer_size": 4000

Enum: 0 1000 2000 3000 4000 5000 6000 7000 8000
closed_caption_type
string

The type of closed caption data being passed from the source. The default, none, indicates that no data is being provided. cea indicates that a CEA closed captioning data stream is being provided. on_text indicates that an onTextData closed captioning data stream is being provided. both indicates that both CEA and onTextData closed captioning data streams are being provided.

Example: "closed_caption_type": "cea"

Enum: "none" "cea" "on_text" "both"
delivery_protocols
Array of strings

An array of playback protocols enabled for this transcoder. By default, rtmp, rtsp, and wowz are returned.

Example: See response body sample

description
string

An optional description of the transcoder.

Example: "description": "This transcoder runs our 24/7 stream."

disable_authentication
boolean

Authentication is required by default for RTMP and RTSP push connections from a video source to the transcoder. Specify true to disable authentication with the video source.

Example: "disable_authentication": false

idle_timeout
integer <int32>

The amount of idle time, in seconds, before the transcoder automatically shuts down. Valid values are the integers 0 (never shuts down) to 172800 (48 hours). The default is 1200 (20 minutes).

Example: "idle_timeout": 1600

low_latency
boolean

If true, turns off the sort packet buffer and speeds the time it takes to decode and deliver video data to the player. The default is false.

Example: "low_latency": false

password
string

A password for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.

Example: "password": 68332313

play_maximum_connections
integer <int32>

The number of users who are allowed to connect directly to the transcoder. The minimum and default value is 10. The maximum number of connections varies by the size of the transcoder, with the maximum value for the largest transcoder being 300 viewers.

Example: "play_maximum_connections": 30

Array of objects (property)

An array of properties to configure. The property configuration consists of a key/value pair and the section of the transcoder configuration table the key/value pair is stored in.

Available from version 1.5.

Example: See response body sample

reference_id
string

A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with transcoder 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.7.

Example: "reference_id": "mySystemID_01"

source_url
string

For the delivery_method pull or protocol file.

For pull, enter the source's web address without the protocol or the trailing slash (/).

For file, enter the source file URL, including the protocol (http, https, gs, s3).

Example: "source_url": "xyz.streamlock.net/vod/mp4:Movie.mov"

stream_extension
string

For the delivery_method push. Some encoders append an extension to their stream names. If the device you're using does this, enter the extension as a period (.) followed by alphanumeric characters.

Example: "stream_extension": ".sdp"

stream_smoother
boolean

A dynamic buffer that helps stabilize streams in rough network conditions, but adds latency. Specify true to enable stream smoothing. The default is false.

Example: "stream_smoother": false

stream_source_id
string

For the delivery_method cdn. The alphanumeric string that identifies the stream source that you want to use to deliver the stream to the transcoder.

Example: "stream_source_id": "rxHQQpWw"

suppress_stream_target_start
boolean

If true, disables stream targets when the transcoder starts. If false (the default), the targets start when the transcoder starts.

Example: "suppress_stream_target_start": false

username
string

A username for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.

Example: "username": "client2"

watermark
boolean

Embeds an image into the transcoded stream for copyright protection. Specify true to embed a watermark image.

Example: "watermark": true

watermark_height
integer <int32>

The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height.

Example: "watermark_height": 80

watermark_image
string

A Base64-encoded string representation of a GIF, JPEG, or PNG image that is embedded in all bitrate renditions of the stream. Watermark image files must be 2.5 MB or smaller.

Example: "watermark_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"

watermark_opacity
integer <int32>

The opacity, or percentage of transparency, of the watermark. 0 is fully transparent; 100 is fully opaque.

Example: "watermark_opacity": 75

Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
watermark_position
string

The corner of the video frame in which you want the watermark to appear. The default is top-left.

Example: "watermark_position": "top-left"

Enum: "top-left" "top-right" "bottom-left" "bottom-right"
watermark_width
integer <int32>

The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width.

Example: "watermark_width": 100

Responses
201

Success

Response Schema: application/json
required
object (transcoder)
application_name
string

The application name from the pull stream source URL.

asset_id
string

Only applies to the transcoder of a live stream created from re-streaming an asset in Asset Management. The id for the asset associated with the re-streamed live stream. You can manage this asset in Asset Management.

billing_mode
string

The billing mode for the transcoder. The default is pay_as_you_go.

Enum: "pay_as_you_go" "twentyfour_seven"
broadcast_location
string

The location where Wowza Video transcodes your stream. Choose a location as close as possible to your video source.

Enum: "asia_pacific_australia" "asia_pacific_india" "asia_pacific_japan" "asia_pacific_singapore" "asia_pacific_s_korea" "asia_pacific_taiwan" "eu_belgium" "eu_germany" "eu_ireland" "south_america_brazil" "us_central_iowa" "us_east_s_carolina" "us_east_virginia" "us_west_california" "us_west_oregon"
buffer_size
integer <int32>

The size, in milliseconds, of the incoming buffer. 0 means no buffer. The default is 4000 (4 seconds).

Enum: 0 1000 2000 3000 4000 5000 6000 7000 8000
closed_caption_type
string

The type of closed caption data being passed from the source. The default, none, indicates that no data is being provided. cea indicates that a CEA closed captioning data stream is being provided. on_text indicates that an onTextData closed captioning data stream is being provided. both indicates that both CEA and onTextData closed captioning data streams are being provided.

Enum: "none" "cea" "on_text" "both"
created_at
string <date-time>

The date and time that the transcoder was created.

delivery_method
string

The type of connection between the source encoder and the transcoder. The default, pull, instructs the transcoder to pull the video from the source. push instructs the source to push the stream to the transcoder. cdn uses a stream source to deliver the stream to the transcoder.

Enum: "pull" "cdn" "push"
delivery_protocols
Array of strings

An array of playback protocols enabled for this transcoder. By default, rtmp, rtsp, webrtc, and wowz are returned.

description
string

An optional description of the transcoder.

object

A list of direct playback URLs for the transcoder's delivery protocols. Each protocol has a URL for the source and a URL for each output rendition.

disable_authentication
boolean

Authentication is required by default for RTMP and RTSP push connections from a video source to the transcoder. Specify true to disable authentication with the video source.

domain_name
string

The domain name from the pull stream source URL.

id
string

The unique alphanumeric string that identifies the transcoder.

idle_timeout
integer <int32>

The amount of idle time, in seconds, before the transcoder automatically shuts down. Valid values are the integers 0 (never shuts down) to 172800 (48 hours). The default is 1200 (20 minutes).

low_latency
boolean

If true, turns off the sort packet buffer and speeds the time it takes to decode and deliver video data to the player. The default is false.

name
string

A descriptive name for the transcoder. Maximum 200 characters.

Array of objects (output)

Output renditions associated with the transcoder.

password
string

A password for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.

playback_stream_name
string

The stream name used in the direct playback URL.

play_maximum_connections
integer <int32>

The number of users who are allowed to connect directly to the transcoder. The minimum and default value is 10. The maximum number of connections varies by the size of the transcoder, with the maximum value for the largest transcoder being 300 viewers.

protocol
string

The transport protocol for the source video. The default is rtmp.

Enum: "file" "rtmp" "rtsp" "srt" "udp" "webrtc"
reference_id
string

A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with transcoder 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.7.

source_port
integer <int32>

The port used for RTMP pull connections to Wowza Video.

source_url
string

For the delivery_method pull or protocol file.

For pull, enter the source's web address without the preceding protocol or the trailing slash (/).

For file, enter the source file URL, including the protocol (http, https, gs, s3).

stream_extension
string

For the delivery_method push. Some encoders append an extension to their stream names. If the device you're using does this, enter the extension as a period (.) followed by alphanumeric characters.

stream_name
string

The stream name from the pull stream source URL.

stream_smoother
boolean

A dynamic buffer that helps stabilize streams in rough network conditions, but adds latency. Specify true to enable stream smoothing. The default is false.

stream_source_id
string

For the delivery_method cdn. The alphanumeric string that identifies the stream source that you want to use to deliver the stream to the transcoder.

suppress_stream_target_start
boolean

If true, disables stream targets when the transcoder starts. If false (the default), the targets start when the transcoder starts.

transcoder_type
string

The type of transcoder, either transcoded for streams that are transcoded into adaptive bitrate renditions or passthrough for streams that aren't processed by the transcoder. The default is transcoded.

Enum: "transcoded" "passthrough"
updated_at
string <date-time>

The date and time that the transcoder was updated.

username
string

A username for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.

watermark
boolean

Embeds an image into the transcoded stream for copyright protection. Specify true to embed a watermark image.

watermark_height
integer <int32>

The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height.

watermark_image_url
string

The path to a GIF, JPEG, or PNG image that is embedded in all bitrate renditions of the stream. Watermark image files must be 2.5 MB or smaller.

watermark_opacity
integer <int32>

The opacity, or percentage of transparency, of the watermark. 0 is fully transparent; 100 is fully opaque.

Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
watermark_position
string

The corner of the video frame in which you want the watermark to appear. The default is top-left.

Enum: "top-left" "top-right" "bottom-left" "bottom-right"
watermark_width
integer <int32>

The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width.

401

Unauthorized

422

Unprocessable Entity

post/transcoders
Request samples
application/json
{
  • "transcoder": {
    }
}
Response samples
application/json
{
  • "transcoder": {
    }
}

Fetch all transcoders

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

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 (transcoders)
Array
created_at
string <date-time>

The date and time that the transcoder was created.

id
string

The unique alphanumeric string that identifies the transcoder.

name
string

A descriptive name for the transcoder. Maximum 200 characters.

state
string

The state of the transcoder.

Enum: "starting" "stopping" "started" "stopped" "resetting"
workflow
string

The method by which the transcoder was created, either transcoder for a transcoder created through the transcoder workflow or live_stream for a transcoder created automatically as part of the live stream workflow.

Enum: "live_stream" "transcoder"
updated_at
string <date-time>

The date and time that the transcoder was updated.

401

Unauthorized

get/transcoders
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.8/transcoders"
Response samples
application/json
{
  • "transcoders": [
    ]
}

Fetch a transcoder

This operation shows the details of a specific transcoder.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses
200

Success

Response Schema: application/json
required
object (transcoder)
application_name
string

The application name from the pull stream source URL.

asset_id
string

Only applies to the transcoder of a live stream created from re-streaming an asset in Asset Management. The id for the asset associated with the re-streamed live stream. You can manage this asset in Asset Management.

billing_mode
string

The billing mode for the transcoder. The default is pay_as_you_go.

Enum: "pay_as_you_go" "twentyfour_seven"
broadcast_location
string

The location where Wowza Video transcodes your stream. Choose a location as close as possible to your video source.

Enum: "asia_pacific_australia" "asia_pacific_india" "asia_pacific_japan" "asia_pacific_singapore" "asia_pacific_s_korea" "asia_pacific_taiwan" "eu_belgium" "eu_germany" "eu_ireland" "south_america_brazil" "us_central_iowa" "us_east_s_carolina" "us_east_virginia" "us_west_california" "us_west_oregon"
buffer_size
integer <int32>

The size, in milliseconds, of the incoming buffer. 0 means no buffer. The default is 4000 (4 seconds).

Enum: 0 1000 2000 3000 4000 5000 6000 7000 8000
closed_caption_type
string

The type of closed caption data being passed from the source. The default, none, indicates that no data is being provided. cea indicates that a CEA closed captioning data stream is being provided. on_text indicates that an onTextData closed captioning data stream is being provided. both indicates that both CEA and onTextData closed captioning data streams are being provided.

Enum: "none" "cea" "on_text" "both"
created_at
string <date-time>

The date and time that the transcoder was created.

delivery_method
string

The type of connection between the source encoder and the transcoder. The default, pull, instructs the transcoder to pull the video from the source. push instructs the source to push the stream to the transcoder. cdn uses a stream source to deliver the stream to the transcoder.

Enum: "pull" "cdn" "push"
delivery_protocols
Array of strings

An array of playback protocols enabled for this transcoder. By default, rtmp, rtsp, webrtc, and wowz are returned.

description
string

An optional description of the transcoder.

object

A list of direct playback URLs for the transcoder's delivery protocols. Each protocol has a URL for the source and a URL for each output rendition.

disable_authentication
boolean

Authentication is required by default for RTMP and RTSP push connections from a video source to the transcoder. Specify true to disable authentication with the video source.

domain_name
string

The domain name from the pull stream source URL.

id
string

The unique alphanumeric string that identifies the transcoder.

idle_timeout
integer <int32>

The amount of idle time, in seconds, before the transcoder automatically shuts down. Valid values are the integers 0 (never shuts down) to 172800 (48 hours). The default is 1200 (20 minutes).

low_latency
boolean

If true, turns off the sort packet buffer and speeds the time it takes to decode and deliver video data to the player. The default is false.

name
string

A descriptive name for the transcoder. Maximum 200 characters.

Array of objects (output)

Output renditions associated with the transcoder.

password
string

A password for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.

playback_stream_name
string

The stream name used in the direct playback URL.

play_maximum_connections
integer <int32>

The number of users who are allowed to connect directly to the transcoder. The minimum and default value is 10. The maximum number of connections varies by the size of the transcoder, with the maximum value for the largest transcoder being 300 viewers.

protocol
string

The transport protocol for the source video. The default is rtmp.

Enum: "file" "rtmp" "rtsp" "srt" "udp" "webrtc"
reference_id
string

A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with transcoder 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.7.

source_port
integer <int32>

The port used for RTMP pull connections to Wowza Video.

source_url
string

For the delivery_method pull or protocol file.

For pull, enter the source's web address without the preceding protocol or the trailing slash (/).

For file, enter the source file URL, including the protocol (http, https, gs, s3).

stream_extension
string

For the delivery_method push. Some encoders append an extension to their stream names. If the device you're using does this, enter the extension as a period (.) followed by alphanumeric characters.

stream_name
string

The stream name from the pull stream source URL.

stream_smoother
boolean

A dynamic buffer that helps stabilize streams in rough network conditions, but adds latency. Specify true to enable stream smoothing. The default is false.

stream_source_id
string

For the delivery_method cdn. The alphanumeric string that identifies the stream source that you want to use to deliver the stream to the transcoder.

suppress_stream_target_start
boolean

If true, disables stream targets when the transcoder starts. If false (the default), the targets start when the transcoder starts.

transcoder_type
string

The type of transcoder, either transcoded for streams that are transcoded into adaptive bitrate renditions or passthrough for streams that aren't processed by the transcoder. The default is transcoded.

Enum: "transcoded" "passthrough"
updated_at
string <date-time>

The date and time that the transcoder was updated.

username
string

A username for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.

watermark
boolean

Embeds an image into the transcoded stream for copyright protection. Specify true to embed a watermark image.

watermark_height
integer <int32>

The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height.

watermark_image_url
string

The path to a GIF, JPEG, or PNG image that is embedded in all bitrate renditions of the stream. Watermark image files must be 2.5 MB or smaller.

watermark_opacity
integer <int32>

The opacity, or percentage of transparency, of the watermark. 0 is fully transparent; 100 is fully opaque.

Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
watermark_position
string

The corner of the video frame in which you want the watermark to appear. The default is top-left.

Enum: "top-left" "top-right" "bottom-left" "bottom-right"
watermark_width
integer <int32>

The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

get/transcoders/{id}
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.8/transcoders/2adffc17"
Response samples
application/json
{
  • "transcoder": {
    }
}

Update a transcoder

This operation updates a transcoder.

Request
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)
delivery_method
string

The type of connection between the source encoder and the transcoder. The default, pull, instructs the transcoder to pull the video from the source. push instructs the source to push the stream to the transcoder. cdn uses a stream source to deliver the stream to the transcoder.

Example: "delivery_method": "pull"

Enum: "pull" "cdn" "push"
name
string

A descriptive name for the transcoder. Maximum 200 characters.

Example: "name": "My Updated Transcoder"

protocol
string

The transport protocol for the source video. The default is rtmp.

Example: "protocol": "webrtc"

Enum: "file" "rtmp" "rtsp" "srt" "udp" "webrtc"
broadcast_location
string

The location where Wowza Video transcodes your stream. Choose a location as close as possible to your video source.

Example: "broadcast_location": "us_central_iowa"

Enum: "asia_pacific_australia" "asia_pacific_india" "asia_pacific_japan" "asia_pacific_singapore" "asia_pacific_s_korea" "asia_pacific_taiwan" "eu_belgium" "eu_germany" "eu_ireland" "south_america_brazil" "us_central_iowa" "us_east_s_carolina" "us_east_virginia" "us_west_california" "us_west_oregon"
buffer_size
integer <int32>

The size, in milliseconds, of the incoming buffer. 0 means no buffer. The default is 4000 (4 seconds).

Example: "buffer_size": 4000

Enum: 0 1000 2000 3000 4000 5000 6000 7000 8000
closed_caption_type
string

The type of closed caption data being passed from the source. The default, none, indicates that no data is being provided. cea indicates that a CEA closed captioning data stream is being provided. on_text indicates that an onTextData closed captioning data stream is being provided. both indicates that both CEA and onTextData closed captioning data streams are being provided.

Example: "closed_caption_type": "cea"

Enum: "none" "cea" "on_text" "both"
delivery_protocols
Array of strings

An array of playback protocols enabled for this transcoder. By default, rtmp, rtsp, webrtc, and wowz are returned.

Example: See response body sample

description
string

An optional description of the transcoder.

Example: "description": "This transcoder runs our 24/7 stream."

disable_authentication
boolean

Authentication is required by default for RTMP and RTSP push connections from a video source to the transcoder. Specify true to disable authentication with the video source.

Example: "disable_authentication": false

idle_timeout
integer <int32>

The amount of idle time, in seconds, before the transcoder automatically shuts down. Valid values are the integers 0 (never shuts down) to 172800 (48 hours). The default is 1200 (20 minutes).

Example: "idle_timeout": 1600

low_latency
boolean

If true, turns off the sort packet buffer and speeds the time it takes to decode and deliver video data to the player. The default is false.

Example: "low_latency": false

password
string

A password for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.

Example: "password": 68332313

play_maximum_connections
integer <int32>

The number of users who are allowed to connect directly to the transcoder. The minimum and default value is 10. The maximum number of connections varies by the size of the transcoder, with the maximum value for the largest transcoder being 300 viewers.

Example: "play_maximum_connections": 30

Array of objects (property)

An array of properties to configure. The property configuration consists of a key/value pair and the section of the transcoder configuration table the key/value pair is stored in.

Available from version 1.5.

Example: See response body sample

reference_id
string

A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with transcoder 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.7.

Example: "reference_id": "mySystemID_01"

remove_watermark_image
boolean

If true, removes the watermark from the output. The default is false.

Example: "remove_watermark_image": true

source_url
string

For the delivery_method pull or protocol file.

For pull, enter the source's web address without the protocol or the trailing slash (/).

For file, enter the source file URL, including the protocol (http, https, gs, s3).

Example: "source_url": "xyz.streamlock.net/vod/mp4:Movie.mov"

stream_extension
string

For the delivery_method push. Some encoders append an extension to their stream names. If the device you're using does this, enter the extension as a period (.) followed by alphanumeric characters.

Example: "stream_extension": ".sdp"

stream_smoother
boolean

A dynamic buffer that helps stabilize streams in rough network conditions, but adds latency. Specify true to enable stream smoothing. The default is false.

Example: "stream_smoother": false

stream_source_id
string

For the delivery_method cdn. The alphanumeric string that identifies the stream source that you want to use to deliver the stream to the transcoder.

Example: "stream_source_id": "rxHQQpWw"

suppress_stream_target_start
boolean

If true, disables stream targets when the transcoder starts. If false (the default), the targets start when the transcoder starts.

Example: "suppress_stream_target_start": false

username
string

A username for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.

Example: "username": "client2"

watermark
boolean

Embeds an image into the transcoded stream for copyright protection. Specify true to embed a watermark image.

Example: "watermark": true

watermark_height
integer <int32>

The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height.

Example: "watermark_height": 80

watermark_image
string

A Base64-encoded string representation of a GIF, JPEG, or PNG image that is embedded in all bitrate renditions of the stream. Watermark image files must be 2.5 MB or smaller.

Example: "watermark_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]"

watermark_opacity
integer <int32>

The opacity, or percentage of transparency, of the watermark. 0 is fully transparent; 100 is fully opaque.

Example: "watermark_opacity": 75

Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
watermark_position
string

The corner of the video frame in which you want the watermark to appear. The default is top-left.

Example: "watermark_position": "top-left"

Enum: "top-left" "top-right" "bottom-left" "bottom-right"
watermark_width
integer <int32>

The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width.

Example: "watermark_width": 100

Responses
200

Success

Response Schema: application/json
required
object (transcoder)
application_name
string

The application name from the pull stream source URL.

asset_id
string

Only applies to the transcoder of a live stream created from re-streaming an asset in Asset Management. The id for the asset associated with the re-streamed live stream. You can manage this asset in Asset Management.

billing_mode
string

The billing mode for the transcoder. The default is pay_as_you_go.

Enum: "pay_as_you_go" "twentyfour_seven"
broadcast_location
string

The location where Wowza Video transcodes your stream. Choose a location as close as possible to your video source.

Enum: "asia_pacific_australia" "asia_pacific_india" "asia_pacific_japan" "asia_pacific_singapore" "asia_pacific_s_korea" "asia_pacific_taiwan" "eu_belgium" "eu_germany" "eu_ireland" "south_america_brazil" "us_central_iowa" "us_east_s_carolina" "us_east_virginia" "us_west_california" "us_west_oregon"
buffer_size
integer <int32>

The size, in milliseconds, of the incoming buffer. 0 means no buffer. The default is 4000 (4 seconds).

Enum: 0 1000 2000 3000 4000 5000 6000 7000 8000
closed_caption_type
string

The type of closed caption data being passed from the source. The default, none, indicates that no data is being provided. cea indicates that a CEA closed captioning data stream is being provided. on_text indicates that an onTextData closed captioning data stream is being provided. both indicates that both CEA and onTextData closed captioning data streams are being provided.

Enum: "none" "cea" "on_text" "both"
created_at
string <date-time>

The date and time that the transcoder was created.

delivery_method
string

The type of connection between the source encoder and the transcoder. The default, pull, instructs the transcoder to pull the video from the source. push instructs the source to push the stream to the transcoder. cdn uses a stream source to deliver the stream to the transcoder.

Enum: "pull" "cdn" "push"
delivery_protocols
Array of strings

An array of playback protocols enabled for this transcoder. By default, rtmp, rtsp, webrtc, and wowz are returned.

description
string

An optional description of the transcoder.

object

A list of direct playback URLs for the transcoder's delivery protocols. Each protocol has a URL for the source and a URL for each output rendition.

disable_authentication
boolean

Authentication is required by default for RTMP and RTSP push connections from a video source to the transcoder. Specify true to disable authentication with the video source.

domain_name
string

The domain name from the pull stream source URL.

id
string

The unique alphanumeric string that identifies the transcoder.

idle_timeout
integer <int32>

The amount of idle time, in seconds, before the transcoder automatically shuts down. Valid values are the integers 0 (never shuts down) to 172800 (48 hours). The default is 1200 (20 minutes).

low_latency
boolean

If true, turns off the sort packet buffer and speeds the time it takes to decode and deliver video data to the player. The default is false.

name
string

A descriptive name for the transcoder. Maximum 200 characters.

Array of objects (output)

Output renditions associated with the transcoder.

password
string

A password for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.

playback_stream_name
string

The stream name used in the direct playback URL.

play_maximum_connections
integer <int32>

The number of users who are allowed to connect directly to the transcoder. The minimum and default value is 10. The maximum number of connections varies by the size of the transcoder, with the maximum value for the largest transcoder being 300 viewers.

protocol
string

The transport protocol for the source video. The default is rtmp.

Enum: "file" "rtmp" "rtsp" "srt" "udp" "webrtc"
reference_id
string

A unique, alphanumeric ID returned in transcoder webhook payloads. Setting a reference_id is useful if you have an ID in your system or application you want to associate with transcoder 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.7.

source_port
integer <int32>

The port used for RTMP pull connections to Wowza Video.

source_url
string

For the delivery_method pull or protocol file.

For pull, enter the source's web address without the preceding protocol or the trailing slash (/).

For file, enter the source file URL, including the protocol (http, https, gs, s3).

stream_extension
string

For the delivery_method push. Some encoders append an extension to their stream names. If the device you're using does this, enter the extension as a period (.) followed by alphanumeric characters.

stream_name
string

The stream name from the pull stream source URL.

stream_smoother
boolean

A dynamic buffer that helps stabilize streams in rough network conditions, but adds latency. Specify true to enable stream smoothing. The default is false.

stream_source_id
string

For the delivery_method cdn. The alphanumeric string that identifies the stream source that you want to use to deliver the stream to the transcoder.

suppress_stream_target_start
boolean

If true, disables stream targets when the transcoder starts. If false (the default), the targets start when the transcoder starts.

transcoder_type
string

The type of transcoder, either transcoded for streams that are transcoded into adaptive bitrate renditions or passthrough for streams that aren't processed by the transcoder. The default is transcoded.

Enum: "transcoded" "passthrough"
updated_at
string <date-time>

The date and time that the transcoder was updated.

username
string

A username for authenticating an RTMP or RTSP push connection. Can contain only uppercase and lowercase letters; numbers; and the period (.), underscore (_), and hyphen (-) characters. No other special characters can be used.

watermark
boolean

Embeds an image into the transcoded stream for copyright protection. Specify true to embed a watermark image.

watermark_height
integer <int32>

The height, in pixels, of the watermark image. If blank, Wowza Video uses the original image height.

watermark_image_url
string

The path to a GIF, JPEG, or PNG image that is embedded in all bitrate renditions of the stream. Watermark image files must be 2.5 MB or smaller.

watermark_opacity
integer <int32>

The opacity, or percentage of transparency, of the watermark. 0 is fully transparent; 100 is fully opaque.

Enum: 0 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100
watermark_position
string

The corner of the video frame in which you want the watermark to appear. The default is top-left.

Enum: "top-left" "top-right" "bottom-left" "bottom-right"
watermark_width
integer <int32>

The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

patch/transcoders/{id}
Request samples
application/json
{
  • "transcoder": {
    }
}
Response samples
application/json
{
  • "transcoder": {
    }
}

Delete a transcoder

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

Note: You can't remove transcoders 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 transcoder.

Responses
204

No Content

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

delete/transcoders/{id}
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WV_HOST}/api/v1.8/transcoders/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": {
    }
}

Enable a transcoder's stream targets

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

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses
200

Success

Response Schema: application/json
required
object (transcoder)
required
object (stream_targets)
state
string

The state of the transcoder's stream targets.

Enum: "enabled" "disabled"
401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

put/transcoders/{id}/enable_all_stream_targets
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v1.8/transcoders/2adffc17/enable_all_stream_targets"
Response samples
application/json
{
  • "transcoder": {
    }
}

Disable a transcoder's stream targets

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

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses
200

Success

Response Schema: application/json
required
object (transcoder)
required
object (stream_targets)
state
string

The state of the transcoder's stream targets.

Enum: "enabled" "disabled"
401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

put/transcoders/{id}/disable_all_stream_targets
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v1.8/transcoders/2adffc17/disable_all_stream_targets"
Response samples
application/json
{
  • "transcoder": {
    }
}

Start a transcoder

This operation starts a transcoder.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses
200

Success

Response Schema: application/json
required
object (transcoder)
state
string

The state of the transcoder.

Enum: "starting" "stopping" "started" "stopped" "resetting"
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

put/transcoders/{id}/start
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v1.8/transcoders/2adffc17/start"
Response samples
application/json
{
  • "transcoder": {
    }
}

Stop a transcoder

This operation stops a transcoder.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses
200

Success

Response Schema: application/json
required
object (transcoder)
state
string

The state of the transcoder.

Enum: "starting" "stopping" "started" "stopped" "resetting"
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

put/transcoders/{id}/stop
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v1.8/transcoders/2adffc17/stop"
Response samples
application/json
{
  • "transcoder": {
    }
}

Reset a transcoder

This operation resets a transcoder.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses
200

Success

Response Schema: application/json
required
object (transcoder)
state
string

The state of the transcoder.

Enum: "starting" "stopping" "started" "stopped" "resetting"
401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

put/transcoders/{id}/reset
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v1.8/transcoders/2adffc17/reset"
Response samples
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.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses
200

Success

Response Schema: application/json
required
object (transcoder)
object

The recording for the transcoder.

state
string

The state of video capture for the transcoder.

Enum: "started" "stopped"
401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

put/transcoders/{id}/start_recording
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v1.8/transcoders/2adffc17/start_recording"
Response samples
application/json
{
  • "transcoder": {
    }
}

Stop recording

This operation stops the recording of a transcoder before the transcoder has stopped. Wowza Video 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.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses
200

Success

Response Schema: application/json
required
object (transcoder)
object

The recording for the transcoder.

state
string

The state of video capture for the transcoder.

Enum: "started" "stopped"
401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

422

Unprocessable Entity

put/transcoders/{id}/stop_recording
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WV_HOST}/api/v1.8/transcoders/2adffc17/stop_recording"
Response samples
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.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses
200

Success

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

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

Array
created_at
string <date-time>

The date and time that the recording was created.

id
string

The unique alphanumeric string that identifies the recording.

reason
string

The reason that a recording has the state failed.

file_name
string

The file name of the recording.

state
string

The state of the recording.

Enum: "uploading" "converting" "removing" "completed" "failed"
transcoder_id
string

The unique alphanumeric string that identifies the transcoder that was recorded.

updated_at
string <date-time>

The date and time that the recording was updated.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/transcoders/{id}/recordings
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.8/transcoders/2adffc17/recordings"
Response samples
application/json
{
  • "recordings": [
    ]
}

Fetch transcoder's schedules

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

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses
200

Success

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

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

Array
action_type
string

The type of action that the schedule should trigger on the transcoder. The default is start.

Enum: "start" "stop" "start_stop"
created_at
string <date-time>

The date and time that the schedule was created.

end_repeat
string <date>

The month, day, and year that a recurring schedule should stop running. Specify YYYY-MM-DD.

id
string

The unique alphanumeric string that identifies the schedule.

name
string

A descriptive name for the schedule. Maximum 255 characters.

recurrence_data
string

The day or days of the week that a recurring schedule should run.

Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"
recurrence_type
string

A schedule can run one time only (once) or repeat (recur) until a specified end_repeat date. The default is once.

Enum: "once" "recur"
start_repeat
string <date>

The month, day, and year that the recurring schedule should go into effect. Specify YYYY-MM-DD.

start_transcoder
string <date-time>

The month, day, year, and time of day that the action_type start should occur. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC.

state
string

A schedule must be enabled to run. Specify enabled to run the schedule or disabled to turn off the schedule so that it doesn't run.

Enum: "enabled" "disabled" "expired"
stop_transcoder
string <date-time>

The month, day, year, and time of day that the action_type stop should occur. Specify YYYY-MM-DD HH:MM:SS where HH is a 24-hour clock in UTC.

transcoder_id
string

The unique alphanumeric string that identifies the transcoder being scheduled.

transcoder_name
string

The name of the transcoder being scheduled.

updated_at
string <date-time>

The date and time that the schedule was updated.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/transcoders/{id}/schedules
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.8/transcoders/2adffc17/schedules"
Response samples
application/json
{
  • "schedules": [
    ]
}

Fetch the thumbnail URL of a transcoder

This operation shows the thumbnail URL of a started transcoder.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses
200

Success

Response Schema: application/json
required
object (transcoder)
thumbnail_url
string

The URL to receive the preview thumbnail.

401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/transcoders/{id}/thumbnail_url
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.8/transcoders/2adffc17/thumbnail_url"
Response samples
application/json

Fetch the state and uptime ID of a transcoder

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

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses
200

Success

Response Schema: application/json
required
object (transcoder)
ip_address
string

The IP address of the transcoder instance. If the transcoder state is anything other than started, the ip_address is 0.0.0.0.

state
string

The state of the transcoder.

Enum: "starting" "stopping" "started" "stopped" "resetting"
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/transcoders/{id}/state
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.8/transcoders/2adffc17/state"
Response samples
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.

Request
path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses
200

Success

Response Schema: application/json
required
object (shm_metrics)
object (audio_codec_metric)
object (bits_in_rate_metric)
object (bits_out_rate_metric)
object (bytes_in_rate_metric)
object (bytes_out_rate_metric)
object (configured_bytes_out_rate_metric)
object (connected_metric)
object (frame_size_metric)
object (frame_rate_metric)
object (height_metric)
object (keyframe_interval_metric)
object (stream_target_status_OUTPUTIDX_STREAMTARGETIDX_metric)
object (unique_views_metric)

The number of unique viewers in the last 5 minutes.

Note: This parameter only returns data for Fastly stream targets.

object (video_codec_metric)
object (width_metric)
401

Unauthorized

403

Forbidden

404

Not Found

410

Gone

get/transcoders/{id}/stats
Request samples
// Using cURL
curl -H "Authorization: Bearer ${WV_JWT}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WV_HOST}/api/v1.8/transcoders/2adffc17/stats"
Response samples
application/json
{
  • "transcoder": {