Operations related to transcoders, output renditions, and output stream targets.
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.
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.
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.
This operation creates a transcoder.
Provide the details of the transcoder to create in the body of the request.
required | object (transcoder) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Success
required | object (transcoder) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Unauthorized
Unprocessable Entity
{- "transcoder": {
- "billing_mode": "pay_as_you_go",
- "broadcast_location": "us_central_iowa",
- "delivery_method": "pull",
- "name": "My PAYG Transcoder",
- "protocol": "rtmp",
- "transcoder_type": "transcoded"
}
}
{- "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,
- "properties": [
- {
- "key": "fitMode",
- "section": "output",
- "value": "letterbox"
}, - {
- "key": "rtpIgnoreProfileLevelId",
- "section": "rtsp",
- "value": true
}
], - "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
}
}
This operation shows limited details for all of your transcoders. For detailed information, fetch a single transcoder.
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. |
Success
Unauthorized
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders"
{- "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"
}
]
}
This operation shows the details of a specific transcoder.
Success
required | object (transcoder) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17"
{- "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,
- "properties": [
- {
- "key": "fitMode",
- "section": "output",
- "value": "letterbox"
}, - {
- "key": "rtpIgnoreProfileLevelId",
- "section": "rtsp",
- "value": true
}
], - "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
}
}
This operation updates a transcoder.
Provide the details of the transcoder to update in the body of the request.
required | object (transcoder) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Success
required | object (transcoder) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
{- "transcoder": {
- "name": "My Updated Transcoder",
- "watermark_position": "bottom-left"
}
}
{- "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,
- "properties": [
- {
- "key": "fitMode",
- "section": "output",
- "value": "letterbox"
}, - {
- "key": "rtpIgnoreProfileLevelId",
- "section": "rtsp",
- "value": true
}
], - "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
}
}
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.
No Content
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17"
{- "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": [ ]
}
}
}
This operation enables all of the stream targets assigned to a specific transcoder.
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/enable_all_stream_targets"
{- "transcoder": {
- "stream_targets": {
- "state": "enabled"
}
}
}
This operation disables all of the stream targets assigned to a specific transcoder.
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/disable_all_stream_targets"
{- "transcoder": {
- "stream_targets": {
- "state": "enabled"
}
}
}
This operation starts a transcoder.
Success
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/start"
{- "transcoder": {
- "state": "starting",
- "uptime_id": "abcd1234"
}
}
This operation stops a transcoder.
Success
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/stop"
{- "transcoder": {
- "state": "starting",
- "uptime_id": "abcd1234"
}
}
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/reset"
{- "transcoder": {
- "state": "resetting"
}
}
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.
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/start_recording"
{- "transcoder": {
- "recording": {
- "state": "started"
}
}
}
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.
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/stop_recording"
{- "transcoder": {
- "recording": {
- "state": "stopped"
}
}
}
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.
Success
required | Array of objects (recordings) Array of recordings of this transcoder. See /recordings for more details. | ||||||||||||||||||
Array
|
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/recordings"
{- "recordings": [
- {
- "created_at": "2020-01-29T17:16:21.993Z",
- "id": "4Jjzstdt",
- "asset_id": "tk1plmzr",
- "file_name": "",
- "real_time_stream_id": "cj39nmrt",
- "reason": "",
- "state": "completed",
- "transcoder_id": "bjaplmrw",
- "updated_at": "2020-01-31T14:14:01.993Z"
}
]
}
This operation shows the details of all of the schedules for a specific transcoder.
Success
required | Array of objects (schedule) Array of schedules of this transcoder. See /schedules for more details. | ||||||||||||||||||||||||||||
Array
|
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/schedules"
{- "schedules": [
- {
- "id": "28bwb5WT",
- "state": "disabled",
- "name": "Scheduled recurring start for my camera",
- "transcoder_id": "VGB21JFJ",
- "transcoder_name": "My Camera",
- "recurrence_type": "recur",
- "recurrence_data": "monday,tuesday,wednesday,thursday,friday",
- "action_type": "start_stop",
- "start_transcoder": "2020-02-01T00:00:00.000Z",
- "stop_transcoder": "2020-02-29T23:59:59.999Z",
- "start_repeat": "2020-02-01T00:00:00.000Z",
- "end_repeat": "2020-02-29T00:00:00.000Z",
- "created_at": "2020-01-29T17:16:21.995Z",
- "updated_at": "2020-01-31T07:00:48.995Z"
}
]
}
This operation shows the thumbnail URL of a started transcoder.
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/thumbnail_url"
{- "transcoder": {
}
}
This operation shows the current state and uptime ID of a transcoder.
Success
required | object (transcoder) | ||||||
|
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/state"
{- "transcoder": {
- "ip_address": "1.2.3.4",
- "state": "started",
- "uptime_id": "abcd1234"
}
}
(Available from version 1.5) This operation shows the details of all VOD streams associated to a specific transcoder.
Success
required | Array of objects (vod_streams) | ||||||||||||||
Array
|
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/vod_streams"
{- "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"
}
]
}
This operation shows all of the uptime records for a specific transcoder. An uptime record identifies a specific transcoding session.
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. |
Success
required | Array of objects (uptime) | ||||||||||||||||
Array
|
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/uptimes"
{- "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"
}
]
}
This operation shows the details of a specific uptime record for a specific transcoder. An uptime record identifies a transcoding session.
Success
required | object (uptime) | ||||||||||||||||
|
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/uptimes/1acfg43d"
{- "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"
}
}
This operation creates an output rendition for a specific transcoder. You can create up to 10 outputs per transcoder.
Provide the details of the output rendition to create in the body of the request.
required | object (output) | ||||||||||||||||||
|
Success
required | object (output) | ||||||||||||||||||||||||||||||
|
Unauthorized
Unprocessable Entity
{- "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"
}
}
{- "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"
}
}
This operation shows the details of all of the output renditions of a specific transcoder.
Success
required | Array of objects (output) | ||||||||||||||||||||||||||||||
Array
|
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/outputs"
{- "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"
}
]
}
This operation shows the details of a specific output rendition for a specific transcoder.
Success
required | object (output) | ||||||||||||||||||||||||||||||
|
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/outputs/1acfg43d"
{- "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"
}
}
This operation updates an output rendition.
Provide the details of the output rendition to update in the body of the request.
required | object (output) | ||||||||||||||||||
|
Success
required | object (output) | ||||||||||||||||||||||||||||||
|
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
{- "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"
}
}
{- "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"
}
}
This operation deletes an output, including all of its assigned targets.
No Content
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/outputs/1acfg43d"
{- "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": [ ]
}
}
}
This operation creates an output stream target, assigning the stream target to the specified output rendition.
Provide the details of the output stream target to create in the body of the request.
required | object (output_stream_target) | ||||
|
Success
required | object (output_stream_target) | ||||||||||||
|
Unauthorized
Unprocessable Entity
{- "output_stream_target": {
- "stream_target_id": "1234abcd",
- "use_stream_target_backup_url": true
}
}
{- "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"
}
}
}
This operation shows the details of all of the output stream targets of an output of a transcoder.
Success
required | Array of objects (output_stream_target) | ||||||||||||
Array
|
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets"
{- "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"
}
}
]
}
This operation shows the details of an output stream target.
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. |
Success
object (output_stream_target) | |||||||||||||
|
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77"
{- "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"
}
}
}
This operation updates an output stream target.
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. |
Provide the details of the output stream target to update in the body of the request.
required | object (output_stream_target) | ||||
|
Success
required | object (output_stream_target) | ||||||||||||
|
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
{- "output_stream_target": {
- "stream_target_id": "1234abcd",
- "use_stream_target_backup_url": true
}
}
{- "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"
}
}
}
This operation deletes an output stream target, including all of its assigned targets.
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. |
No Content
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77"
{- "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": [ ]
}
}
}
This operation enables an output stream target.
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. |
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/enable"
{- "stream_target": {
- "state": "enabled"
}
}
This operation disables an output stream target.
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. |
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/disable"
{- "stream_target": {
- "state": "disabled"
}
}
This operation restarts an output stream target.
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. |
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "PUT" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/restart"
{- "stream_target": {
- "state": "restarted"
}
}
This operation configures a single property or an array of properties for a transcoder.
For a comprehensive resource describing the use of advanced properties, see Set advanced properties with the Wowza Video REST API.
Provide the details of the property or properties to configure in the body of the request. You must include either property or properties in the request as the root object.
required | object (property) The single property 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. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Success
required | object (property) A single property. The property configuration consists of a key/value pair and the section of the transcoder configuration table the key/value pair is stored in. | ||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Unauthorized
Unprocessable Entity
{- "property": {
- "key": "rtpIgnoreProfileLevelId",
- "section": "rtsp",
- "value": "true"
}
}
{- "property": [
- {
- "key": "rtpIgnoreProfileLevelId",
- "section": "rtsp",
- "value": true
}
]
}
This operation shows all of the properties of a specific transcoder.
Success
Array of objects (property) An array of properties. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
Array
|
Unauthorized
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/properties"
{- "properties": [
- {
- "key": "fitMode",
- "section": "output",
- "value": "letterbox"
}, - {
- "key": "rtpIgnoreProfileLevelId",
- "section": "rtsp",
- "value": true
}
]
}
This operation shows the details of a specific property for a specific transcoder.
Success
object (property) A single property. The property configuration consists of a key/value pair and the section of the transcoder configuration table the key/value pair is stored in. | |||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/properties/rtsp-rtpIgnoreProfileLevelId"
{- "property": [
- {
- "key": "rtpIgnoreProfileLevelId",
- "section": "rtsp",
- "value": true
}
]
}
This operation deletes a specific property from a specific transcoder.
No Content
Unauthorized
Forbidden
Not Found
Gone
Unprocessable Entity
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "DELETE" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/properties/cupertino-aes128Secret"
{- "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": [ ]
}
}
}
The GET /transcoders/{id}/stats operation is sunset and no longer available. To retrieve metrics data for a live stream, use GET /analytics/ingest/live_streams/{id}.
Success
required | object (shm_metrics) | ||||||||||||||||||||||||||||||
|
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/stats"
{- "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": "h264"
}, - "width": {
- "status": "warning",
- "text": "Configured width is different from what Wowza Video is receiving from the source: 1280.",
- "units": "px",
- "value": 1280
}
}
}
The GET /transcoders/{transcoder_id}/uptimes/{id}/metrics/current operation is sunset and no longer available. To retrieve metrics data for a live stream, use GET /analytics/ingest/live_streams/{id}.
Success
required | object (shm_metrics) |
required | object (limits) |
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/uptimes/1acfg43d/metrics/current"
{- "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": "h264"
}, - "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"
]
}
}
The GET /transcoders/{transcoder_id}/uptimes/{id}/metrics/historic operation is sunset and no longer available. To retrieve metrics data for a live stream, use GET /analytics/ingest/live_streams/{id}.
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. |
Success
required | Array of objects (shm_historic_metrics) |
required | object (limits) |
Unauthorized
Forbidden
Not Found
Gone
// Using cURL curl -H "Authorization: Bearer ${WV_JWT}" \ -H "Content-Type: application/json" \ -X "GET" \ "${WV_HOST}/api/v1.11/transcoders/2adffc17/uptimes/1acfg43d/metrics/historic"
{- "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": "h264"
}, - "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": "h264"
}, - "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"
}
}