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 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). 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"
delivery_protocols	Array of strings An array of playback protocols enabled for this transcoder. By default, rtmp, rtsp, and wowz are returned.
description	string An optional description of the transcoder.
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.
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.
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.
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.
	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.
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_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).
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_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.
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	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.
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.

Responses

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.

Request samples

Payload
Shell
JavaScript

Content type

application/json

{"transcoder": {"billing_mode": "pay_as_you_go",
"broadcast_location": "us_central_iowa",
"delivery_method": "pull",
"name": "My PAYG Transcoder",
"protocol": "rtmp",
"transcoder_type": "transcoded",
"buffer_size": 4000,
"closed_caption_type": "cea",
"description": "My Transcoder Description",
"disable_authentication": false,
"idle_timeout": 1200,
"low_latency": false,
"password": "82e0e971",
"play_maximum_connections": 20,
"properties": [{"key": "fitMode",
"section": "output",
"value": "letterbox"
},
{"key": "rtpIgnoreProfileLevelId",
"section": "rtsp",
"value": true
}
],
"reference_id": "mySystemID_01",
"source_url": "cp12345.live.edgefcs.net/live/redcarpet@123456",
"stream_extension": ".sdp",
"stream_smoother": false,
"stream_source_id": "rxHQQpWw",
"suppress_stream_target_start": false,
"username": "client2",
"watermark": true,
"watermark_height": 80,
"watermark_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
"watermark_opacity": 75,
"watermark_position": "bottom-left",
"watermark_width": 100
}
}

Response samples

Content type

application/json

{"transcoder": {"application_name": "app-B8P6K226",
"billing_mode": "pay_as_you_go",
"broadcast_location": "us_central_iowa",
"buffer_size": 4000,
"closed_caption_type": "cea",
"created_at": "2020-01-28T17:16:22.098Z",
"delivery_method": "push",
"delivery_protocols": ["rtmp",
"rtsp",
"wowz",
"webrtc"
],
"description": "My Transcoder Description",
"direct_playback_urls": {"rtmp": [{"name": "source",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6"
}
],
"rtsp": [{"name": "source",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"
}
],
"wowz": [{"name": "source",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"
}
],
"webrtc": [{"name": "source",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream6"
}
]
},
"disable_authentication": false,
"domain_name": "f92334.entrypoint.video.wowza.com",
"id": "2lsWj3F9",
"idle_timeout": 1200,
"low_latency": false,
"name": "My PAYG Transcoder",
"outputs": [{ }
],
"password": "82e0e971",
"playback_stream_name": "wxyz6789",
"play_maximum_connections": 20,
"protocol": "rtmp",
"reference_id": "mySystemID_01",
"source_port": 1935,
"stream_extension": ".sdp",
"stream_name": "10eb0ed8",
"stream_smoother": false,
"suppress_stream_target_start": false,
"transcoder_type": "transcoded",
"updated_at": "2020-01-31T15:46:50.098Z",
"username": "client2",
"watermark": true,
"watermark_height": 80,
"watermark_image_url": "https://prod.s3.amazonaws.com/uploads/transcoder/watermark_image/12345/4baa13.jpg",
"watermark_opacity": 75,
"watermark_position": "top-right",
"watermark_width": 100
}
}

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

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.

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"transcoders": [{"id": "2lsWj3F9",
"name": "My transcoder",
"workflow": "live_stream",
"state": "stopped",
"created_at": "2020-01-28T17:16:22.097Z",
"updated_at": "2020-01-31T01:17:48.097Z"
},
{"id": "VJbkhjzl",
"name": "My other transcoder",
"workflow": "transcoder",
"state": "started",
"created_at": "2020-01-28T17:16:22.097Z",
"updated_at": "2020-01-30T16:03:28.097Z"
}
]
}

Fetch a transcoder

This operation shows the details of a specific transcoder.

path Parameters

required

string

The unique alphanumeric string that identifies the transcoder.

Responses

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.

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"transcoder": {"application_name": "app-B8P6K226",
"billing_mode": "pay_as_you_go",
"broadcast_location": "us_central_iowa",
"buffer_size": 4000,
"closed_caption_type": "cea",
"created_at": "2020-01-28T17:16:22.098Z",
"delivery_method": "push",
"delivery_protocols": ["rtmp",
"rtsp",
"wowz",
"webrtc"
],
"description": "My Transcoder Description",
"direct_playback_urls": {"rtmp": [{"name": "source",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6"
}
],
"rtsp": [{"name": "source",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"
}
],
"wowz": [{"name": "source",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"
}
],
"webrtc": [{"name": "source",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream6"
}
]
},
"disable_authentication": false,
"domain_name": "f92334.entrypoint.video.wowza.com",
"id": "2lsWj3F9",
"idle_timeout": 1200,
"low_latency": false,
"name": "My PAYG Transcoder",
"outputs": [{ }
],
"password": "82e0e971",
"playback_stream_name": "wxyz6789",
"play_maximum_connections": 20,
"protocol": "rtmp",
"reference_id": "mySystemID_01",
"source_port": 1935,
"stream_extension": ".sdp",
"stream_name": "10eb0ed8",
"stream_smoother": false,
"suppress_stream_target_start": false,
"transcoder_type": "transcoded",
"updated_at": "2020-01-31T15:46:50.098Z",
"username": "client2",
"watermark": true,
"watermark_height": 80,
"watermark_image_url": "https://prod.s3.amazonaws.com/uploads/transcoder/watermark_image/12345/4baa13.jpg",
"watermark_opacity": 75,
"watermark_position": "top-right",
"watermark_width": 100
}
}

Update a transcoder

This operation updates a transcoder.

path Parameters

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 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"
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"
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.
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.
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.
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.
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.
	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.
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.
remove_watermark_image	boolean If true, removes the watermark from the output. The default is false.
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).
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_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.
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	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.
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.

Responses

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.

Request samples

Payload
Shell
JavaScript

Content type

application/json

{"transcoder": {"delivery_method": "pull",
"name": "My PAYG Transcoder",
"protocol": "rtmp",
"broadcast_location": "us_central_iowa",
"buffer_size": 4000,
"closed_caption_type": "cea",
"delivery_protocols": ["rtmp",
"rtsp",
"webrtc",
"wowz"
],
"description": "My Transcoder Description",
"disable_authentication": false,
"idle_timeout": 1200,
"low_latency": false,
"password": "82e0e971",
"play_maximum_connections": 20,
"properties": [{"key": "fitMode",
"section": "output",
"value": "letterbox"
},
{"key": "rtpIgnoreProfileLevelId",
"section": "rtsp",
"value": true
}
],
"reference_id": "mySystemID_01",
"remove_watermark_image": true,
"source_url": "cp12345.live.edgefcs.net/live/redcarpet@123456",
"stream_extension": ".sdp",
"stream_smoother": false,
"stream_source_id": "rxHQQpWw",
"suppress_stream_target_start": false,
"username": "client2",
"watermark": true,
"watermark_height": 80,
"watermark_image": "[Base64-encoded string representation of GIF, JPEG, or PNG file]",
"watermark_opacity": 75,
"watermark_position": "bottom-left",
"watermark_width": 100
}
}

Response samples

Content type

application/json

{"transcoder": {"application_name": "app-B8P6K226",
"billing_mode": "pay_as_you_go",
"broadcast_location": "us_central_iowa",
"buffer_size": 4000,
"closed_caption_type": "cea",
"created_at": "2020-01-28T17:16:22.098Z",
"delivery_method": "push",
"delivery_protocols": ["rtmp",
"rtsp",
"wowz",
"webrtc"
],
"description": "My Transcoder Description",
"direct_playback_urls": {"rtmp": [{"name": "source",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "rtmp://abc123.entrypoint.video.wowza.com/app-B8P6K226/wxyz6789_stream6"
}
],
"rtsp": [{"name": "source",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "rtsp://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"
}
],
"wowz": [{"name": "source",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "wowz://abc123.entrypoint.video.wowza.com:1935/app-B8P6K226/wxyz6789_stream6"
}
],
"webrtc": [{"name": "source",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead"
},
{"name": "webrtc",
"output_id": "dcxq5q6c",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream1"
},
{"name": "V:1280x720+A:128K",
"output_id": "0g116zkf",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream2"
},
{"name": "V:854x480+A:128K",
"output_id": "4qqkwndt",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream3"
},
{"name": "V:640x360+A:128K",
"output_id": "0pv8djpg",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream4"
},
{"name": "V:512x288+A:128K",
"output_id": "b09xrxjf",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream5"
},
{"name": "V:320x180+A:128K",
"output_id": "bvkh2nsz",
"url": "wss://abc123.entrypoint.video.wowza.com/webrtc-session.json",
"application_name": "app-B8P6K226",
"stream_name": "1722aead_stream6"
}
]
},
"disable_authentication": false,
"domain_name": "f92334.entrypoint.video.wowza.com",
"id": "2lsWj3F9",
"idle_timeout": 1200,
"low_latency": false,
"name": "My PAYG Transcoder",
"outputs": [{ }
],
"password": "82e0e971",
"playback_stream_name": "wxyz6789",
"play_maximum_connections": 20,
"protocol": "rtmp",
"reference_id": "mySystemID_01",
"source_port": 1935,
"stream_extension": ".sdp",
"stream_name": "10eb0ed8",
"stream_smoother": false,
"suppress_stream_target_start": false,
"transcoder_type": "transcoded",
"updated_at": "2020-01-31T15:46:50.098Z",
"username": "client2",
"watermark": true,
"watermark_height": 80,
"watermark_image_url": "https://prod.s3.amazonaws.com/uploads/transcoder/watermark_image/12345/4baa13.jpg",
"watermark_opacity": 75,
"watermark_position": "top-right",
"watermark_width": 100
}
}

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.

path Parameters

required

string

The unique alphanumeric string that identifies the transcoder.

Responses

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"Example Response 1": {"meta": {"status": 401,
"code": "ERR-401-NoApiKey",
"title": "No API Key Error",
"message": "No API key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 2": {"meta": {"status": 401,
"code": "ERR-401-NoAccessKey",
"title": "No Access Key Error",
"message": "No access key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 3": {"meta": {"status": 401,
"code": "ERR-401-InvalidApiKey",
"title": "Invalid Api Key Error",
"message": "Invalid API key.",
"description": "",
"links": [ ]
}
},
"Example Response 4": {"meta": {"status": 401,
"code": "ERR-401-InvalidAccessKey",
"title": "Invalid Access Key Error",
"message": "Invalid access key.",
"description": "",
"links": [ ]
}
},
"Example Response 5": {"meta": {"status": 401,
"code": "ERR-401-BadAccountStatus",
"title": "Bad Account Status Error",
"message": "Your account's status doesn't allow this action.",
"description": "",
"links": [ ]
}
},
"Example Response 6": {"meta": {"status": 401,
"code": "ERR-401-FeatureNotEnabled",
"title": "Feature Not Enabled Error",
"message": "This feature isn't enabled.",
"description": "",
"links": [ ]
}
},
"Example Response 7": {"meta": {"status": 401,
"code": "ERR-401-TrialExceeded",
"title": "Bad Billing Status Error",
"message": "Your billing status needs attention. You can't start or add live streams until your billing status is updated.",
"description": "",
"links": [ ]
}
},
"Example Response 8": {"meta": {"status": 401,
"code": "ERR-401-ExpiredToken",
"title": "JWT is expired",
"message": "Token has exired.",
"description": "",
"links": [ ]
}
},
"Example Response 9": {"meta": {"status": 401,
"code": "ERR-401-InvalidToken",
"title": "JWT is invalid",
"message": "Token is invalid.",
"description": "",
"links": [ ]
}
}
}

Enable a transcoder's stream targets

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

path Parameters

required

string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json

required

object (transcoder)

required

object (stream_targets)

state

string

The state of the transcoder's stream targets.

Enum: "enabled" "disabled"

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"transcoder": {"stream_targets": {"state": "enabled"
}
}
}

Disable a transcoder's stream targets

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

path Parameters

required

string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json

required

object (transcoder)

required

object (stream_targets)

state

string

The state of the transcoder's stream targets.

Enum: "enabled" "disabled"

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"transcoder": {"stream_targets": {"state": "enabled"
}
}
}

Start a transcoder

This operation starts a transcoder.

path Parameters

required

string

The unique alphanumeric string that identifies the transcoder.

Responses

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.

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"transcoder": {"state": "starting",
"uptime_id": "abcd1234"
}
}

Stop a transcoder

This operation stops a transcoder.

path Parameters

required

string

The unique alphanumeric string that identifies the transcoder.

Responses

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.

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"transcoder": {"state": "starting",
"uptime_id": "abcd1234"
}
}

Reset a transcoder

This operation resets a transcoder.

path Parameters

required

string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json

required

object (transcoder)

state

string

The state of the transcoder.

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

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"transcoder": {"state": "resetting"
}
}

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

required

string

The unique alphanumeric string that identifies the transcoder.

Responses

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"

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"transcoder": {"recording": {"state": "started"
}
}
}

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.

path Parameters

required

string

The unique alphanumeric string that identifies the transcoder.

Responses

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"

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"transcoder": {"recording": {"state": "stopped"
}
}
}

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

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.

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.

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"recordings": [{"created_at": "2020-01-29T17:16:21.993Z",
"id": "4Jjzstdt",
"reason": "",
"file_name": "",
"state": "completed",
"transcoder_id": "bjaplmrw",
"updated_at": "2020-01-31T14:14:01.993Z"
}
]
}

Fetch transcoder's schedules

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

path Parameters

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.

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.

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"schedules": [{"action_type": "start_stop",
"begins_at": "2020-02-01T00:00:00.000Z",
"created_at": "2020-01-29T17:16:21.995Z",
"end_repeat": "2020-02-29T00:00:00.000Z",
"ends_at": "2020-02-29T23:59:59.999Z",
"id": "28bwb5WT",
"name": "Scheduled recurring start for my camera",
"recurrence_data": "monday,tuesday,wednesday,thursday,friday",
"recurrence_type": "recur",
"start_repeat": "2020-02-01T00:00:00.000Z",
"state": "disabled",
"transcoder_id": "VGB21JFJ",
"transcoder_name": "My Camera",
"updated_at": "2020-01-31T07:00:48.995Z"
}
]
}

Fetch the thumbnail URL of a transcoder

This operation shows the thumbnail URL of a started transcoder.

path Parameters

required

string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json

required

object (transcoder)

thumbnail_url

string

The URL to receive the preview thumbnail.

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"transcoder": {"thumbnail_url": "https://cloud.wowza.com/proxy/stats/?target=10.11.12.13&app=app-B8P6K226&stream=99b62146@130135.stream&media=json"
}
}

Fetch the state and uptime ID of a transcoder

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

path Parameters

required

string

The unique alphanumeric string that identifies the transcoder.

Responses

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.

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"transcoder": {"ip_address": "1.2.3.4",
"state": "started",
"uptime_id": "abcd1234"
}
}

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

required

string

The unique alphanumeric string that identifies the transcoder.

Responses

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)

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"transcoder": {"audio_codec": {"status": "normal",
"text": "",
"units": "",
"value": "aac"
},
"bits_in_rate": {"status": "normal",
"text": "",
"units": "Kbps",
"value": 317.3
},
"bits_out_rate": {"status": "normal",
"text": "",
"units": "Kbps",
"value": 856
},
"bytes_in_rate": {"status": "normal",
"text": "",
"units": "KBps",
"value": 317.3
},
"bytes_out_rate": {"status": "normal",
"text": "",
"units": "KBps",
"value": 856
},
"configured_bytes_out_rate": {"status": "warning",
"text": "Outbound bitrate is lower than the configured bitrate. There might be a problem with the stream targets.",
"units": "Kbps",
"value": 8192
},
"connected": {"status": "normal",
"text": "",
"units": "",
"value": "Yes"
},
"frame_size": {"status": "warning",
"text": "Configured frame size is different from what Wowza Video is receiving from the source: 1280x720.",
"units": "",
"value": "1280x720"
},
"frame_rate": {"status": "normal",
"text": "",
"units": "FPS",
"value": 30
},
"height": {"status": "warning",
"text": "Configured height is different from what Wowza Video is receiving from the source: 720.",
"units": "px",
"value": 720
},
"keyframe_interval": {"status": "normal",
"text": "",
"units": "GOP",
"value": 69
},
"stream_target_status_OUTPUTIDX_STREAMTARGETIDX": {"status": "normal",
"text": "",
"units": "",
"value": "Active"
},
"unique_views": {"status": "normal",
"text": "",
"units": "%",
"value": 1030
},
"video_codec": {"status": "normal",
"text": "",
"units": "",
"value": "avc1"
},
"width": {"status": "warning",
"text": "Configured width is different from what Wowza Video is receiving from the source: 1280.",
"units": "px",
"value": 1280
}
}
}

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

required

string

The unique alphanumeric string that identifies the transcoder.

Responses

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.

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"vod_streams": [{"id": "wdjfqvsv",
"name": "My VOD Stream 1",
"state": "failed",
"playback_enabled": false,
"created_at": "2020-02-25T17:16:25.849Z",
"updated_at": "2020-01-28T16:06:47.849Z"
},
{"id": "XyxZKqHO",
"name": "My VOD Stream 2",
"state": "completed",
"playback_enabled": true,
"created_at": "2020-01-29T17:16:21.849Z",
"updated_at": "2020-01-31T02:26:05.849Z"
},
{"id": "Pz21DRSt",
"name": "My VOD Stream 3",
"state": "completed",
"playback_enabled": true,
"created_at": "2020-01-29T17:16:21.849Z",
"updated_at": "2020-01-30T18:13:18.849Z"
}
]
}

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 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

Response Schema: application/json

required

Array of objects (uptime)

Array ()

billed	boolean A Boolean value that indicates if the usage generated by this uptime has been sent for billing processing.
created_at	string <date-time> The date and time that the uptime record was created.
ended_at	string <date-time> The date and time that the transcoder was stopped for this uptime. If this value is not present, it indicates that the transcoder is currently running.
id	string The unique alphanumeric string that identifies the uptime record.
running	boolean A Boolean value that indicates if the transcoder is still running for this uptime.
started_at	string <date-time> The date and time that the transcoder started for this uptime.
transcoder_id	string The unique alphanumeric string that identifies the transcoder.
updated_at	string The date and time that the uptime record was updated.

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"uptimes": [{"billed": false,
"created_at": "2017-07-06T14:22:00.000Z",
"id": "1234abcd",
"running": true,
"started_at": "2017-07-06T14:22:00.000Z",
"transcoder_id": "2adffc17",
"updated_at": "2017-07-06T14:22:00.000Z"
},
{"billed": true,
"created_at": "2017-07-08T14:22:00.000Z",
"ended_at": "2017-07-08T16:40:00.000Z",
"id": "5679wxyz",
"running": false,
"started_at": "2017-07-08T14:22:00.000Z",
"transcoder_id": "ff9l4838",
"updated_at": "2017-07-08T16:40:00.000Z"
}
]
}

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)

billed	boolean A Boolean value that indicates if the usage generated by this uptime has been sent for billing processing.
created_at	string <date-time> The date and time that the uptime record was created.
ended_at	string <date-time> The date and time that the transcoder was stopped for this uptime. If this value is not present, it indicates that the transcoder is currently running.
id	string The unique alphanumeric string that identifies the uptime record.
running	boolean A Boolean value that indicates if the transcoder is still running for this uptime.
started_at	string <date-time> The date and time that the transcoder started for this uptime.
transcoder_id	string The unique alphanumeric string that identifies the transcoder.
updated_at	string The date and time that the uptime record was updated.

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"uptime": {"billed": false,
"created_at": "2017-07-06T14:22:00.000Z",
"id": "1234abcd",
"running": true,
"started_at": "2017-07-06T14:22:00.000Z",
"transcoder_id": "2adffc17",
"updated_at": "2017-07-06T14:22:00.000Z"
}
}

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

Shell
JavaScript

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

Response samples

Content type

application/json

{"current": {"audio_codec": {"status": "normal",
"text": "",
"units": "",
"value": "aac"
},
"bits_in_rate": {"status": "normal",
"text": "",
"units": "Kbps",
"value": 317.3
},
"bits_out_rate": {"status": "normal",
"text": "",
"units": "Kbps",
"value": 856
},
"bytes_in_rate": {"status": "normal",
"text": "",
"units": "KBps",
"value": 317.3
},
"bytes_out_rate": {"status": "normal",
"text": "",
"units": "KBps",
"value": 856
},
"configured_bytes_out_rate": {"status": "warning",
"text": "Outbound bitrate is lower than the configured bitrate. There might be a problem with the stream targets.",
"value": 8192,
"units": "Kbps"
},
"connected": {"status": "normal",
"text": "",
"units": "",
"value": "Yes"
},
"frame_size": {"status": "warning",
"text": "Configured frame size is different from what Wowza Video is receiving from the source: 1280x720.",
"units": "",
"value": "1280x720"
},
"frame_rate": {"status": "normal",
"text": "",
"units": "FPS",
"value": 30
},
"height": {"status": "warning",
"text": "Configured height is different from what Wowza Video is receiving from the source: 720.",
"units": "px",
"value": 720
},
"keyframe_interval": {"status": "normal",
"text": "",
"units": "GOP",
"value": 69
},
"stream_target_status_OUTPUTIDX_STREAMTARGETIDX": {"status": "normal",
"text": "",
"units": "",
"value": "Active"
},
"unique_views": {"status": "normal",
"text": "",
"units": "%",
"value": 1030
},
"video_codec": {"status": "normal",
"text": "",
"units": "",
"value": "avc1"
},
"width": {"status": "warning",
"text": "Configured width is different from what Wowza Video is receiving from the source: 1280.",
"units": "px",
"value": 1280
}
},
"limits": {"fields": ["audio_codec",
"bits_in_rate",
"bits_out_rate",
"bytes_in_rate",
"bytes_out_rate",
"configured_bytes_out_rate",
"connected",
"frame_size",
"frame_rate",
"height",
"width",
"keyframe_interval",
"unique_views",
"video_codec",
"width",
"stream_target_status_OUTPUTIDX_STREAMTARGETIDX"
]
}
}

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

Shell
JavaScript

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

Response samples

Content type

application/json

{"historic": [{"audio_codec": {"status": "normal",
"text": "",
"units": "",
"value": "aac"
},
"bits_in_rate": {"status": "normal",
"text": "",
"units": "Kbps",
"value": 317.3
},
"bits_out_rate": {"status": "normal",
"text": "",
"units": "Kbps",
"value": 856
},
"frame_rate": {"status": "normal",
"text": "",
"units": "FPS",
"value": 30
},
"height": {"status": "warning",
"text": "Configured height is different from what Wowza Video is receiving from the source: 720.",
"units": "px",
"value": 720
},
"keyframe_interval": {"status": "normal",
"text": "",
"units": "GOP",
"value": 69
},
"video_codec": {"status": "normal",
"text": "",
"units": "",
"value": "avc1"
},
"width": {"status": "warning",
"text": "Configured width is different from what Wowza Video is receiving from the source: 1280.",
"units": "px",
"value": 1280
},
"created_at": "2017-07-06T14:20:00.000Z"
},
{"audio_codec": {"status": "normal",
"text": "",
"units": "",
"value": "aac"
},
"bits_in_rate": {"status": "normal",
"text": "",
"units": "Kbps",
"value": 317.3
},
"bits_out_rate": {"status": "normal",
"text": "",
"units": "Kbps",
"value": 856
},
"frame_rate": {"status": "normal",
"text": "",
"units": "FPS",
"value": 30
},
"height": {"status": "warning",
"text": "Configured height is different from what Wowza Video is receiving from the source: 720.",
"units": "px",
"value": 720
},
"keyframe_interval": {"status": "normal",
"text": "",
"units": "GOP",
"value": 69
},
"video_codec": {"status": "normal",
"text": "",
"units": "",
"value": "avc1"
},
"width": {"status": "warning",
"text": "Configured width is different from what Wowza Video is receiving from the source: 1280.",
"units": "px",
"value": 1280
},
"created_at": "2017-07-06T14:20:20.000Z"
}
],
"limits": {"fields": ["audio_codec",
"bits_in_rate",
"bits_out_rate",
"frame_rate",
"height",
"keyframe_interval",
"width",
"video_codec"
],
"from": "2017-07-06T14:20:00.000Z",
"to": "2017-07-06T14:20:20.000Z"
}
}

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)

video_codec required	string The codec used to encode the video stream. disabled sends the stream without a video track and passthrough sends the stream without transcoding the video track. Available from version 1.6. Enum: "h264" "passthrough" "disabled"
audio_codec required	string The codec used to encode the audio stream. disabled sends the stream without an audio track and passthrough sends the stream without transcoding the audio track. aac is the most commonly compatible audio codec for protocols, while opus is for WebRTC streams. Available from version 1.6. Enum: "aac" "opus" "passthrough" "disabled"
aspect_ratio_height	integer <int32> The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1080.
aspect_ratio_width	integer <int32> The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1920.
bitrate_audio	integer <int32> The audio bitrate, in kilobits per second (Kbps). Must be between 1 and 9999. If the audio_codec is opus, the default is 510, otherwise the default is 128.
bitrate_video	integer <int32> The video bitrate, in kilobits per second (Kbps). Must be between 1 and 10240. The default is 4000.
framerate_reduction	string Reduce the frame rate of the transcoded output rendition. The default, 0, uses the encoded stream's frame rate without reduction. Enum: "0" "1/2" "1/4" "1/25" "1/30" "1/50" "1/60"
h264_profile	string The encoding method. Specify main for desktop streaming, baseline for playback on mobile devices, or high for HD playback. The default is high. Enum: "main" "baseline" "high"
keyframes	string The interval used to define the compression applied to a group of frames. The default, follow_source, uses the keyframe interval of the source video. Enum: "follow_source" "25" "30" "50" "60" "100" "120"

Responses

Response Schema: application/json

required

object (output)

aspect_ratio_height	integer <int32> The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1080.
aspect_ratio_width	integer <int32> The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1920.
bitrate_audio	integer <int32> The audio bitrate, in kilobits per second (Kbps). Must be between 1 and 9999. If the audio_codec is opus, the default is 510, otherwise the default is 128.
bitrate_video	integer <int32> The video bitrate, in kilobits per second (Kbps). Must be between 1 and 10240. The default is 4000.
created_at	string <date-time> The date and time that the output rendition was created.
framerate_reduction	string Reduce the frame rate of the transcoded output rendition. The default, 0, uses the encoded stream's frame rate without reduction. Enum: "0" "1/2" "1/4" "1/25" "1/30" "1/50" "1/60"
h264_profile	string The encoding method. Specify main for desktop streaming, baseline for playback on mobile devices, or high for HD playback. The default is high. Enum: "main" "baseline" "high"
id	string The unique alphanumeric string that identifies the output rendition.
keyframes	string The interval used to define the compression applied to a group of frames. The default, follow_source, uses the keyframe interval of the source video. Enum: "follow_source" "25" "30" "50" "60" "100" "120"
name	string A descriptive name for the output (generated, not writable).
	Array of objects (output_stream_target)
video_codec	string The codec used to encode the video stream. disabled sends the stream without a video track and passthrough sends the stream without transcoding the video track. Available from version 1.6. Enum: "h264" "passthrough" "disabled"
audio_codec	string The codec used to encode the audio stream. disabled sends the stream without an audio track and passthrough sends the stream without transcoding the audio track. aac is the most commonly compatible audio codec for protocols, while opus is for WebRTC streams. Available from version 1.6. Enum: "aac" "opus" "passthrough" "disabled"
transcoder_id	string The unique alphanumeric string that identifies the transcoder.
updated_at	string <date-time> The date and time that the output rendition was updated.

Request samples

Payload
Shell
JavaScript

Content type

application/json

{"output": {"video_codec": "h264",
"audio_codec": "aac",
"aspect_ratio_height": 480,
"aspect_ratio_width": 848,
"bitrate_audio": 128,
"bitrate_video": 1600,
"framerate_reduction": "1/2",
"h264_profile": "main",
"keyframes": "follow_source"
}
}

Response samples

Content type

application/json

{"output": {"aspect_ratio_height": 480,
"aspect_ratio_width": 848,
"bitrate_audio": 128,
"bitrate_video": 1600,
"created_at": "2020-01-29T17:16:21.964Z",
"framerate_reduction": "1/2",
"h264_profile": "main",
"id": "w9vJm3BJ",
"keyframes": "follow_source",
"name": "Standard Output: Video (848 x 480) + Audio",
"output_stream_targets": [{ }
],
"video_codec": "h264",
"audio_codec": "aac",
"transcoder_id": "PblTJm1t",
"updated_at": "2020-01-31T13:47:33.964Z"
}
}

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)

Array ()

aspect_ratio_height	integer <int32> The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1080.
aspect_ratio_width	integer <int32> The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1920.
bitrate_audio	integer <int32> The audio bitrate, in kilobits per second (Kbps). Must be between 1 and 9999. If the audio_codec is opus, the default is 510, otherwise the default is 128.
bitrate_video	integer <int32> The video bitrate, in kilobits per second (Kbps). Must be between 1 and 10240. The default is 4000.
created_at	string <date-time> The date and time that the output rendition was created.
framerate_reduction	string Reduce the frame rate of the transcoded output rendition. The default, 0, uses the encoded stream's frame rate without reduction. Enum: "0" "1/2" "1/4" "1/25" "1/30" "1/50" "1/60"
h264_profile	string The encoding method. Specify main for desktop streaming, baseline for playback on mobile devices, or high for HD playback. The default is high. Enum: "main" "baseline" "high"
id	string The unique alphanumeric string that identifies the output rendition.
keyframes	string The interval used to define the compression applied to a group of frames. The default, follow_source, uses the keyframe interval of the source video. Enum: "follow_source" "25" "30" "50" "60" "100" "120"
name	string A descriptive name for the output (generated, not writable).
	Array of objects (output_stream_target)
video_codec	string The codec used to encode the video stream. disabled sends the stream without a video track and passthrough sends the stream without transcoding the video track. Available from version 1.6. Enum: "h264" "passthrough" "disabled"
audio_codec	string The codec used to encode the audio stream. disabled sends the stream without an audio track and passthrough sends the stream without transcoding the audio track. aac is the most commonly compatible audio codec for protocols, while opus is for WebRTC streams. Available from version 1.6. Enum: "aac" "opus" "passthrough" "disabled"
transcoder_id	string The unique alphanumeric string that identifies the transcoder.
updated_at	string <date-time> The date and time that the output rendition was updated.

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"outputs": [{"aspect_ratio_height": 480,
"aspect_ratio_width": 848,
"bitrate_audio": 128,
"bitrate_video": 1600,
"created_at": "2020-01-29T17:16:21.958Z",
"framerate_reduction": "1/2",
"h264_profile": "main",
"id": "w9vJm3BJ",
"keyframes": "follow_source",
"name": "Standard Output: Video (848 x 480) + Audio",
"output_stream_targets": [{ }
],
"video_codec": "h264",
"audio_codec": "aac",
"transcoder_id": "PblTJm1t",
"updated_at": "2020-01-31T03:29:50.958Z"
},
{"created_at": "2020-01-29T17:16:21.958Z",
"id": "PPqV0kcm",
"name": "Standard Output: Video + Audio",
"output_stream_targets": [{ }
],
"video_codec": "passthrough",
"audio_codec": "passthrough",
"transcoder_id": "Yf5lyjCV",
"updated_at": "2020-01-31T03:55:05.958Z"
}
]
}

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)

aspect_ratio_height	integer <int32> The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1080.
aspect_ratio_width	integer <int32> The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1920.
bitrate_audio	integer <int32> The audio bitrate, in kilobits per second (Kbps). Must be between 1 and 9999. If the audio_codec is opus, the default is 510, otherwise the default is 128.
bitrate_video	integer <int32> The video bitrate, in kilobits per second (Kbps). Must be between 1 and 10240. The default is 4000.
created_at	string <date-time> The date and time that the output rendition was created.
framerate_reduction	string Reduce the frame rate of the transcoded output rendition. The default, 0, uses the encoded stream's frame rate without reduction. Enum: "0" "1/2" "1/4" "1/25" "1/30" "1/50" "1/60"
h264_profile	string The encoding method. Specify main for desktop streaming, baseline for playback on mobile devices, or high for HD playback. The default is high. Enum: "main" "baseline" "high"
id	string The unique alphanumeric string that identifies the output rendition.
keyframes	string The interval used to define the compression applied to a group of frames. The default, follow_source, uses the keyframe interval of the source video. Enum: "follow_source" "25" "30" "50" "60" "100" "120"
name	string A descriptive name for the output (generated, not writable).
	Array of objects (output_stream_target)
video_codec	string The codec used to encode the video stream. disabled sends the stream without a video track and passthrough sends the stream without transcoding the video track. Available from version 1.6. Enum: "h264" "passthrough" "disabled"
audio_codec	string The codec used to encode the audio stream. disabled sends the stream without an audio track and passthrough sends the stream without transcoding the audio track. aac is the most commonly compatible audio codec for protocols, while opus is for WebRTC streams. Available from version 1.6. Enum: "aac" "opus" "passthrough" "disabled"
transcoder_id	string The unique alphanumeric string that identifies the transcoder.
updated_at	string <date-time> The date and time that the output rendition was updated.

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"output": {"aspect_ratio_height": 480,
"aspect_ratio_width": 848,
"bitrate_audio": 128,
"bitrate_video": 1600,
"created_at": "2020-01-29T17:16:21.964Z",
"framerate_reduction": "1/2",
"h264_profile": "main",
"id": "w9vJm3BJ",
"keyframes": "follow_source",
"name": "Standard Output: Video (848 x 480) + Audio",
"output_stream_targets": [{ }
],
"video_codec": "h264",
"audio_codec": "aac",
"transcoder_id": "PblTJm1t",
"updated_at": "2020-01-31T13:47:33.964Z"
}
}

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)

video_codec required	string The codec used to encode the video stream. disabled sends the stream without a video track and passthrough sends the stream without transcoding the video track. Available from version 1.6. Enum: "h264" "passthrough" "disabled"
audio_codec required	string The codec used to encode the audio stream. disabled sends the stream without an audio track and passthrough sends the stream without transcoding the audio track. aac is the most commonly compatible audio codec for protocols, while opus is for WebRTC streams. Available from version 1.6. Enum: "aac" "opus" "passthrough" "disabled"
aspect_ratio_height	integer <int32> The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1080.
aspect_ratio_width	integer <int32> The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1920.
bitrate_audio	integer <int32> The audio bitrate, in kilobits per second (Kbps). Must be between 1 and 9999. If the audio_codec is opus, the default is 510, otherwise the default is 128.
bitrate_video	integer <int32> The video bitrate, in kilobits per second (Kbps). Must be between 1 and 10240. The default is 4000.
framerate_reduction	string Reduce the frame rate of the transcoded output rendition. The default, 0, uses the encoded stream's frame rate without reduction. Enum: "0" "1/2" "1/4" "1/25" "1/30" "1/50" "1/60"
h264_profile	string The encoding method. Specify main for desktop streaming, baseline for playback on mobile devices, or high for HD playback. The default is high. Enum: "main" "baseline" "high"
keyframes	string The interval used to define the compression applied to a group of frames. The default, follow_source, uses the keyframe interval of the source video. Enum: "follow_source" "25" "30" "50" "60" "100" "120"

Responses

Response Schema: application/json

required

object (output)

aspect_ratio_height	integer <int32> The height, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1080.
aspect_ratio_width	integer <int32> The width, in pixels, of the output rendition. Should correspond to a widescreen or standard aspect ratio and be divisible by 8. The default is 1920.
bitrate_audio	integer <int32> The audio bitrate, in kilobits per second (Kbps). Must be between 1 and 9999. If the audio_codec is opus, the default is 510, otherwise the default is 128.
bitrate_video	integer <int32> The video bitrate, in kilobits per second (Kbps). Must be between 1 and 10240. The default is 4000.
created_at	string <date-time> The date and time that the output rendition was created.
framerate_reduction	string Reduce the frame rate of the transcoded output rendition. The default, 0, uses the encoded stream's frame rate without reduction. Enum: "0" "1/2" "1/4" "1/25" "1/30" "1/50" "1/60"
h264_profile	string The encoding method. Specify main for desktop streaming, baseline for playback on mobile devices, or high for HD playback. The default is high. Enum: "main" "baseline" "high"
id	string The unique alphanumeric string that identifies the output rendition.
keyframes	string The interval used to define the compression applied to a group of frames. The default, follow_source, uses the keyframe interval of the source video. Enum: "follow_source" "25" "30" "50" "60" "100" "120"
name	string A descriptive name for the output (generated, not writable).
	Array of objects (output_stream_target)
video_codec	string The codec used to encode the video stream. disabled sends the stream without a video track and passthrough sends the stream without transcoding the video track. Available from version 1.6. Enum: "h264" "passthrough" "disabled"
audio_codec	string The codec used to encode the audio stream. disabled sends the stream without an audio track and passthrough sends the stream without transcoding the audio track. aac is the most commonly compatible audio codec for protocols, while opus is for WebRTC streams. Available from version 1.6. Enum: "aac" "opus" "passthrough" "disabled"
transcoder_id	string The unique alphanumeric string that identifies the transcoder.
updated_at	string <date-time> The date and time that the output rendition was updated.

Request samples

Payload
Shell
JavaScript

Content type

application/json

{"output": {"video_codec": "h264",
"audio_codec": "aac",
"aspect_ratio_height": 480,
"aspect_ratio_width": 848,
"bitrate_audio": 128,
"bitrate_video": 1600,
"framerate_reduction": "1/2",
"h264_profile": "main",
"keyframes": "follow_source"
}
}

Response samples

Content type

application/json

{"output": {"aspect_ratio_height": 480,
"aspect_ratio_width": 848,
"bitrate_audio": 128,
"bitrate_video": 1600,
"created_at": "2020-01-29T17:16:21.964Z",
"framerate_reduction": "1/2",
"h264_profile": "main",
"id": "w9vJm3BJ",
"keyframes": "follow_source",
"name": "Standard Output: Video (848 x 480) + Audio",
"output_stream_targets": [{ }
],
"video_codec": "h264",
"audio_codec": "aac",
"transcoder_id": "PblTJm1t",
"updated_at": "2020-01-31T13:47:33.964Z"
}
}

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

Shell
JavaScript

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

Response samples

Content type

application/json

{"Example Response 1": {"meta": {"status": 401,
"code": "ERR-401-NoApiKey",
"title": "No API Key Error",
"message": "No API key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 2": {"meta": {"status": 401,
"code": "ERR-401-NoAccessKey",
"title": "No Access Key Error",
"message": "No access key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 3": {"meta": {"status": 401,
"code": "ERR-401-InvalidApiKey",
"title": "Invalid Api Key Error",
"message": "Invalid API key.",
"description": "",
"links": [ ]
}
},
"Example Response 4": {"meta": {"status": 401,
"code": "ERR-401-InvalidAccessKey",
"title": "Invalid Access Key Error",
"message": "Invalid access key.",
"description": "",
"links": [ ]
}
},
"Example Response 5": {"meta": {"status": 401,
"code": "ERR-401-BadAccountStatus",
"title": "Bad Account Status Error",
"message": "Your account's status doesn't allow this action.",
"description": "",
"links": [ ]
}
},
"Example Response 6": {"meta": {"status": 401,
"code": "ERR-401-FeatureNotEnabled",
"title": "Feature Not Enabled Error",
"message": "This feature isn't enabled.",
"description": "",
"links": [ ]
}
},
"Example Response 7": {"meta": {"status": 401,
"code": "ERR-401-TrialExceeded",
"title": "Bad Billing Status Error",
"message": "Your billing status needs attention. You can't start or add live streams until your billing status is updated.",
"description": "",
"links": [ ]
}
},
"Example Response 8": {"meta": {"status": 401,
"code": "ERR-401-ExpiredToken",
"title": "JWT is expired",
"message": "Token has exired.",
"description": "",
"links": [ ]
}
},
"Example Response 9": {"meta": {"status": 401,
"code": "ERR-401-InvalidToken",
"title": "JWT is invalid",
"message": "Token is invalid.",
"description": "",
"links": [ ]
}
}
}

Create an output stream target

This operation creates an output stream target, assigning the stream target to the specified output rendition.

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.

required

object (output_stream_target)

stream_target_id

required

string

The unique alphanumeric string that identifies the stream target.

use_stream_target_backup_url

boolean

Specifies whether the output stream target uses the stream target's primary or backup URL.

When both the primary and backup URLs are used, Wowza Video sends the stream to both URLs, allowing a provider or 3rd party CDN to improve reliability and prevent playback disruption. If you want to use both URLs, make sure you add the stream target to the output rendition twice, once with use_stream_target_backup_url as false (the default) and once with use_stream_target_backup_url as true.

Responses

Response Schema: application/json

required

object (output_stream_target)

created_at	string <date-time> The date and time that the output stream target was created.
id	string The unique alphanumeric string that identifies the output stream target.
	object (stream_targets)
stream_target_id	string The unique alphanumeric string that identifies the stream target.
updated_at	string <date-time> The date and time that the output stream target was updated.
use_stream_target_backup_url	boolean Specifies whether the output stream target uses the stream target's primary or backup URL.

Request samples

Payload
Shell
JavaScript

Content type

application/json

{"output_stream_target": {"stream_target_id": "1234abcd",
"use_stream_target_backup_url": true
}
}

Response samples

Content type

application/json

{"output_stream_target": {"id": "4Gp5rF23",
"stream_target_id": "QvvJYJjk",
"use_stream_target_backup_url": true,
"stream_target": {"id": "QvvJYJjk",
"name": "My provisioned RTMP Stream Target",
"type": "wowza",
"created_at": "2020-01-29T17:16:21.965Z",
"updated_at": "2020-01-31T04:06:40.965Z"
}
}
}

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)

Array ()

created_at	string <date-time> The date and time that the output stream target was created.
id	string The unique alphanumeric string that identifies the output stream target.
	object (stream_targets)
stream_target_id	string The unique alphanumeric string that identifies the stream target.
updated_at	string <date-time> The date and time that the output stream target was updated.
use_stream_target_backup_url	boolean Specifies whether the output stream target uses the stream target's primary or backup URL.

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"output_stream_targets": [{"id": "4Gp5rF23",
"stream_target_id": "QvvJYJjk",
"use_stream_target_backup_url": false,
"stream_target": {"id": "QvvJYJjk",
"name": "My provisioned RTMP Stream Target",
"type": "wowza",
"created_at": "2020-01-29T17:16:21.965Z",
"updated_at": "2020-01-31T05:45:33.965Z"
}
},
{"id": "345Gd9Hs",
"stream_target_id": "R32u8HDk",
"use_stream_target_backup_url": false,
"stream_target": {"id": "R32u8HDk",
"name": "My other provisioned RTMP Stream Target",
"type": "wowza",
"created_at": "2020-01-29T17:16:21.965Z",
"updated_at": "2020-01-31T12:19:50.965Z"
}
}
]
}

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. Tip: If you're using both the primary and backup URL for a stream target, send output_stream_target_id in the path instead. output_stream_target_id was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target.

Responses

Response Schema: application/json

object (output_stream_target)

created_at	string <date-time> The date and time that the output stream target was created.
id	string The unique alphanumeric string that identifies the output stream target.
	object (stream_targets)
stream_target_id	string The unique alphanumeric string that identifies the stream target.
updated_at	string <date-time> The date and time that the output stream target was updated.
use_stream_target_backup_url	boolean Specifies whether the output stream target uses the stream target's primary or backup URL.

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"output_stream_target": {"id": "4Gp5rF23",
"stream_target_id": "QvvJYJjk",
"use_stream_target_backup_url": true,
"stream_target": {"id": "QvvJYJjk",
"name": "My provisioned RTMP Stream Target",
"type": "wowza",
"created_at": "2020-01-29T17:16:21.965Z",
"updated_at": "2020-01-31T04:06:40.965Z"
}
}
}

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. Tip: If you're using both the primary and backup URL for a stream target, send output_stream_target_id in the path instead. output_stream_target_id was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of 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)

stream_target_id

required

string

The unique alphanumeric string that identifies the stream target.

use_stream_target_backup_url

boolean

Specifies whether the output stream target uses the stream target's primary or backup URL.

Responses

Response Schema: application/json

required

object (output_stream_target)

created_at	string <date-time> The date and time that the output stream target was created.
id	string The unique alphanumeric string that identifies the output stream target.
	object (stream_targets)
stream_target_id	string The unique alphanumeric string that identifies the stream target.
updated_at	string <date-time> The date and time that the output stream target was updated.
use_stream_target_backup_url	boolean Specifies whether the output stream target uses the stream target's primary or backup URL.

Request samples

Payload
Shell
JavaScript

Content type

application/json

{"output_stream_target": {"stream_target_id": "1234abcd",
"use_stream_target_backup_url": true
}
}

Response samples

Content type

application/json

{"output_stream_target": {"id": "4Gp5rF23",
"stream_target_id": "QvvJYJjk",
"use_stream_target_backup_url": true,
"stream_target": {"id": "QvvJYJjk",
"name": "My provisioned RTMP Stream Target",
"type": "wowza",
"created_at": "2020-01-29T17:16:21.965Z",
"updated_at": "2020-01-31T04:06:40.965Z"
}
}
}

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. Tip: If you're using both the primary and backup URL for a stream target, send output_stream_target_id in the path instead. output_stream_target_id was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target.

Responses

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{"Example Response 1": {"meta": {"status": 401,
"code": "ERR-401-NoApiKey",
"title": "No API Key Error",
"message": "No API key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 2": {"meta": {"status": 401,
"code": "ERR-401-NoAccessKey",
"title": "No Access Key Error",
"message": "No access key sent in header.",
"description": "",
"links": [ ]
}
},
"Example Response 3": {"meta": {"status": 401,
"code": "ERR-401-InvalidApiKey",
"title": "Invalid Api Key Error",
"message": "Invalid API key.",
"description": "",
"links": [ ]
}
},
"Example Response 4": {"meta": {"status": 401,
"code": "ERR-401-InvalidAccessKey",
"title": "Invalid Access Key Error",
"message": "Invalid access key.",
"description": "",
"links": [ ]
}
},
"Example Response 5": {"meta": {"status": 401,
"code": "ERR-401-BadAccountStatus",
"title": "Bad Account Status Error",
"message": "Your account's status doesn't allow this action.",
"description": "",
"links": [ ]
}
},
"Example Response 6": {"meta": {"status": 401,
"code": "ERR-401-FeatureNotEnabled",
"title": "Feature Not Enabled Error",
"message": "This feature isn't enabled.",
"description": "",
"links": [ ]
}
},
"Example Response 7": {"meta": {"status": 401,
"code": "ERR-401-TrialExceeded",
"title": "Bad Billing Status Error",
"message": "Your billing status needs attention. You can't start or add live streams until your billing status is updated.",
"description": "",
"links": [ ]
}
},
"Example Response 8": {"meta": {"status": 401,
"code": "ERR-401-ExpiredToken",
"title": "JWT is expired",
"message": "Token has exired.",
"description": "",
"links": [ ]
}
},
"Example Response 9": {"meta": {"status": 401,
"code": "ERR-401-InvalidToken",
"title": "JWT is invalid",
"message": "Token is invalid.",
"description": "",
"links": [ ]
}
}
}

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. Tip: If you're using both the primary and backup URL for a stream target, send output_stream_target_id in the path instead. output_stream_target_id was returned when you added the stream target to the ouput rendition. This allows you to differentiate between the primary and backup URL versions of the stream target.

Responses

Response Schema: application/json

required

object (stream_target)

state

string

The state of the output stream target.

Enum: "enabled" "disabled" "restarted"

Request samples

Shell
JavaScript

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

Response samples

Content type

application/json

{