---
title: "Fetch a transcoder"
method: GET
path: "/transcoders/{id}"
tags: ["transcoders"]
---

# Fetch a transcoder

`GET /transcoders/{id}`

This operation shows the details of a specific transcoder.

## Path parameters

- `id` string, required

## Response `200`

Success

- object
  - `transcoder` Transcoder, required
    - `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` 'pay_as_you_go' | 'twentyfour_seven' — The billing mode for the transcoder. The default is **pay_as_you_go**. **pay_as_you_go** — Billed as a single event. A single event is use-based and you incur charges for the time spent streaming. **twentyfour_seven** — Billed as a 24x7 channel. A 24x7 channel is unlimited stream time for one channel. This billing mode doesn't incur overages, since it's unlimited.
    - `broadcast_location` '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' — The location where Wowza Video transcodes your stream. Choose a location as close as possible to your video source.
    - `buffer_size` 0 | 1000 | 2000 | 3000 | 4000 | 5000 | 6000 | 7000 | 8000 — The size, in milliseconds, of the incoming buffer. **0** means no buffer. The default is **4000** (4 seconds).
    - `closed_caption_type` 'none' | 'cea' | 'on_text' | 'both' — 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.
    - `created_at` string, date-time — The date and time that the transcoder was created.
    - `delivery_method` 'pull' | 'cdn' | 'push' — 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.
    - `delivery_protocols` string[] — 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.
    - `direct_playback_urls` 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.
      - `delivery_protocol` object[] — The name of the direct playback protocol.
        - `name` string — The name of the playback URL: **source**, **default**, or the output rendition's resolution.
        - `output_id` string — Only for output rendition-based playback URLs, not source playback URLs. The unique alphanumeric string that identifies the output rendition.
        - `url` string — The playback URL for the source or output rendition.
        - `application_name` string — (WebRTC only) The application name for the WebRTC output.
        - `stream_name` string — (WebRTC only) The stream name for the WebRTC 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 — 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.
    - `outputs` Output[] — Output renditions associated with the transcoder.
      - `aspect_ratio_height` integer — 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**. Combined with **aspect_ratio_width**, makes up the input resolution.
      - `aspect_ratio_width` integer — 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**. Combined with **aspect_ratio_height**, makes up the input resolution.
      - `bitrate_audio` integer — 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 — 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` '0' | '1/2' | '1/4' | '1/25' | '1/30' | '1/50' | '1/60' — Reduce the frame rate of the transcoded output rendition. The default, **0**, uses the encoded stream's frame rate without reduction.
      - `h264_profile` 'main' | 'baseline' | 'high' — The encoding method. Specify **main** for desktop streaming, **baseline** for playback on mobile devices, or **high** for HD playback. The default is **high**.
      - `id` string — The unique alphanumeric string that identifies the output rendition.
      - `type` 'WebRtcOutput' | 'Output' — The type of output rendition, be it WebRTC to use with a transcoder that uses WebRTC as the protocol or a normal output rendition.
      - `keyframes` 'follow_source' | '25' | '30' | '50' | '60' | '100' | '120' — 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.
      - `name` string — A descriptive name for the output (generated, not writable).
      - `delete_restrictions` string[] — The reasons why the output cannot be deleted.
      - `output_stream_targets` OutputStreamTarget[]
        - `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.
        - `stream_target` IndexStreamTarget
          - `created_at` string, date-time — The date and time that the stream target was created.
          - `id` string — The unique alphanumeric string that identifies the stream target.
          - `name` string — A descriptive name for the stream target. Maximum 255 characters.
          - `state` 'activated' | 'archived' — The state of the stream target.
          - `type` 'custom' | 'wowza_cdn' — **custom** is an external, third-party destination and **wowza_cdn** is a Wowza CDN target.
          - `updated_at` string, date-time — The date and time that the stream target was updated.
        - `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.
        - `target_state` 'enabled' | 'disabled' — Specifies whether the stream target is **enabled** or **disabled**. This parameter displays in the response when the transcoder or live stream associated with the stream target is running and receiving a stream. **Enabled** means the stream target is enabled and streaming video to its destination. **Disabled** means the stream target is disabled and is not streaming video to its destination.
      - `video_codec` 'h264' | 'passthrough' | 'disabled' — 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.
      - `audio_codec` 'aac' | 'opus' | 'passthrough' | 'disabled' — 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.
      - `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.
    - `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 — 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` 'file' | 'rtmp' | 'rtsp' | 'srt' | 'udp' | 'webrtc' — The transport protocol for the source video. The default is **rtmp**.
    - `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 <a href="https://www.wowza.com/docs/wowza-video-webhook-event-reference-documentation">Wowza Video Webhook Event Reference Documentation</a> to learn about webhooks. Available from version 1.7.
    - `source_port` integer — 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_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` 'transcoded' | 'passthrough' — 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. > **Note**: **passthrough** isn't supported in the **asia_pacific_singapore** region. Default: **transcoded**
    - `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 — 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` 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 — The opacity, or percentage of transparency, of the watermark. **0** is fully transparent; **100** is fully opaque.
    - `watermark_position` 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' — The corner of the video frame in which you want the watermark to appear. The default is **top-left**.
    - `watermark_width` integer — The width, in pixels, of the watermark image. If blank, Wowza Video uses the original image width.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `410` — Gone
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/wowza/apis/wowza-video-rest-api-reference-documentation.md) · [All operations](https://skmtc.net/wowza/apis/wowza-video-rest-api-reference-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wowza/wowza-video-rest-api-reference-documentation/versions/157b6f741f2a/schema)