Transcoders

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

Transcoders

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

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

Output Renditions

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

Output Stream Targets

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

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

Create a transcoder

This operation creates a transcoder.

Request Body schema: application/json

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

required
object (transcoder)
billing_mode
required
string
Enum: "pay_as_you_go" "twentyfour_seven"

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

broadcast_location
required
string
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"

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

delivery_method
required
string
Enum: "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.

name
required
string

A descriptive name for the transcoder. Maximum 200 characters.

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

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

transcoder_type
required
string
Enum: "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. The default is transcoded.

buffer_size
integer <int32>
Enum: 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
string
Enum: "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.

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. Valid values are any number between 10 (default) and 100.

Array of objects (transcoder_property)

Available from version 1.5.

recording
boolean

This parameter is sunset and no longer available.

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

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

watermark_position
string
Enum: "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 <int32>

The width, in pixels, of the watermark image. If blank, Wowza Streaming Cloud 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.

billing_mode
string
Enum: "pay_as_you_go" "twentyfour_seven"

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

broadcast_location
string
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"

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

buffer_size
integer <int32>
Enum: 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
string
Enum: "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
string
Enum: "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
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.

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.

play_maximum_connections
integer <int32>

The number of users who are allowed to connect directly to the transcoder. Valid values are any number between 10 (default) and 100.

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

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

recording
boolean

This parameter is sunset and no longer available.

source_port
integer <int32>

The port used for RTMP pull connections to Wowza Streaming Cloud.

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
Enum: "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. The default is 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 <int32>

The height, in pixels, of the watermark image. If blank, Wowza Streaming Cloud 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>
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

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

watermark_position
string
Enum: "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 <int32>

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

Request samples

Content type
application/json
{
  • "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":
    {
    },
  • "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":
    {
    }
}

Fetch all transcoders

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

query Parameters
filter
string

Restricts the data that gets returned by filtering on one or more values associated with a field. Construct a filter using a two-part expression that specifies the field on which to filter and the logic to use to filter.

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

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

Filters use a zero-based index.

For example:

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

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

page
integer

Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1.

For more information and examples, see Get paginated query results with the Wowza Streaming Cloud REST API.

per_page
integer

For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000.

Responses

Response Schema: application/json
required
Array of objects (transcoders)
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.

workflow
string
Enum: "live_stream" "transcoder"

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.

updated_at
string <date-time>

The date and time that the transcoder was updated.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/transcoders"

Response samples

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

Fetch a transcoder

This operation shows the details of a specific transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

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

The application name from the pull stream source URL.

billing_mode
string
Enum: "pay_as_you_go" "twentyfour_seven"

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

broadcast_location
string
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"

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

buffer_size
integer <int32>
Enum: 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
string
Enum: "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
string
Enum: "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
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.

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.

play_maximum_connections
integer <int32>

The number of users who are allowed to connect directly to the transcoder. Valid values are any number between 10 (default) and 100.

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

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

recording
boolean

This parameter is sunset and no longer available.

source_port
integer <int32>

The port used for RTMP pull connections to Wowza Streaming Cloud.

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
Enum: "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. The default is 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 <int32>

The height, in pixels, of the watermark image. If blank, Wowza Streaming Cloud 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>
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

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

watermark_position
string
Enum: "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 <int32>

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

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17"

Response samples

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

Update a transcoder

This operation updates a transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Request Body schema: application/json

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

required
object (transcoder)
delivery_method
required
string
Enum: "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.

name
required
string

A descriptive name for the transcoder. Maximum 200 characters.

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

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

broadcast_location
string
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"

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

buffer_size
integer <int32>
Enum: 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
string
Enum: "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.

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. Valid values are any number between 10 (default) and 100.

recording
boolean

This parameter is sunset and no longer available.

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 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_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 Streaming Cloud 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>
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

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

watermark_position
string
Enum: "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 <int32>

The width, in pixels, of the watermark image. If blank, Wowza Streaming Cloud 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.

billing_mode
string
Enum: "pay_as_you_go" "twentyfour_seven"

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

broadcast_location
string
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"

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

buffer_size
integer <int32>
Enum: 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
string
Enum: "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
string
Enum: "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
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.

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.

play_maximum_connections
integer <int32>

The number of users who are allowed to connect directly to the transcoder. Valid values are any number between 10 (default) and 100.

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

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

recording
boolean

This parameter is sunset and no longer available.

source_port
integer <int32>

The port used for RTMP pull connections to Wowza Streaming Cloud.

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
Enum: "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. The default is 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 <int32>

The height, in pixels, of the watermark image. If blank, Wowza Streaming Cloud 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>
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

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

watermark_position
string
Enum: "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 <int32>

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

Request samples

Content type
application/json
{
  • "delivery_method": "pull",
  • "name": "My PAYG Transcoder",
  • "protocol": "rtmp",
  • "broadcast_location": "us_central_iowa",
  • "buffer_size": 4000,
  • "closed_caption_type": "cea",
  • "delivery_protocols":
    [
    ],
  • "description": "My Transcoder Description",
  • "disable_authentication": false,
  • "idle_timeout": 1200,
  • "low_latency": false,
  • "password": "82e0e971",
  • "play_maximum_connections": 20,
  • "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":
    {
    }
}

Delete a transcoder

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17"

Response samples

Content type
application/json
{
  • "Example Response 1":
    {
    },
  • "Example Response 2":
    {
    },
  • "Example Response 3":
    {
    },
  • "Example Response 4":
    {
    },
  • "Example Response 5":
    {
    },
  • "Example Response 6":
    {
    },
  • "Example Response 7":
    {
    }
}

Enable a transcoder's stream targets

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)
required
object (stream_targets)
state
string
Enum: "enabled" "disabled"

The state of the transcoder's stream targets.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/enable_all_stream_targets"

Response samples

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

Disable a transcoder's stream targets

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)
required
object (stream_targets)
state
string
Enum: "enabled" "disabled"

The state of the transcoder's stream targets.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/disable_all_stream_targets"

Response samples

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

Start a transcoder

This operation starts a transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)
state
string
Enum: "starting" "stopping" "started" "stopped" "resetting"

The state of the transcoder.

uptime_id
string

The unique identifier associated with a specific uptime period of a transcoder.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/start"

Response samples

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

Stop a transcoder

This operation stops a transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)
state
string
Enum: "starting" "stopping" "started" "stopped" "resetting"

The state of the transcoder.

uptime_id
string

The unique identifier associated with a specific uptime period of a transcoder.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/stop"

Response samples

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

Reset a transcoder

This operation resets a transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)
state
string
Enum: "starting" "stopping" "started" "stopped" "resetting"

The state of the transcoder.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/reset"

Response samples

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

Start recording

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

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

The recording for the transcoder.

state
string
Enum: "started" "stopped"

The state of video capture for the transcoder.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/start_recording"

Response samples

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

Stop recording

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

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

The recording for the transcoder.

state
string
Enum: "started" "stopped"

The state of video capture for the transcoder.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/stop_recording"

Response samples

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

Fetch a transcoder's recordings

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

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

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

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.

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

The state of the recording.

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

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

Response samples

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

Fetch transcoder's schedules

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

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

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

Array ()
action_type
string
Enum: "start" "stop" "start_stop"

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

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
Enum: "sunday" "monday" "tuesday" "wednesday" "thursday" "friday" "saturday"

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

recurrence_type
string
Enum: "once" "recur"

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

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
Enum: "enabled" "disabled" "expired"

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.

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

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

Response samples

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

Fetch the thumbnail URL of a transcoder

This operation shows the thumbnail URL of a started transcoder.

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

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

The URL to receive the preview thumbnail.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/thumbnail_url"

Response samples

Content type
application/json

Fetch the state and uptime ID of a transcoder

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (transcoder)
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
Enum: "starting" "stopping" "started" "stopped" "resetting"

The state of the transcoder.

uptime_id
string

The unique identifier associated with a specific uptime period of a transcoder.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/state"

Response samples

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

Fetch statistics for a current transcoder

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
object (shm_metrics)
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

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

Response samples

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

Fetch all VOD streams for a transcoder

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

path Parameters
id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
Array of objects (vod_streams)
Array ()
id
string

The unique alphanumeric string that identifies the VOD stream.

name
string

A descriptive name for the VOD stream. Maximum 200 characters.

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

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

Response samples

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

Fetch all uptime records for a transcoder

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

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

query Parameters
page
integer

Returns a paginated view of results from the HTTP request. Specify a positive integer to indicate which page of the results should be displayed. The default is 1.

For more information and examples, see Get paginated query results with the Wowza Streaming Cloud REST API.

per_page
integer

For use with the page parameter. Indicates how many records should be included in a page of results. A valid value is any positive integer. The default and maximum value is 1000.

Responses

Response Schema: application/json
required
Array of objects (uptime)
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

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

Response samples

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

Fetch an uptime record

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

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

The unique alphanumeric string that identifies the uptime record.

Responses

Response Schema: application/json
required
object (uptime)
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

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

Response samples

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

Fetch current stream health metrics for an active transcoder

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

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

The unique alphanumeric string that identifies the uptime record.

query Parameters
fields
string

A comma-separated list of fields to return.

Responses

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

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/uptimes/1acfg43d/metrics/current"

Response samples

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

Fetch historic stream health metrics for a transcoder

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

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

The unique alphanumeric string that identifies the uptime record.

query Parameters
fields
string

A comma-separated list of fields to return.

from
string

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

to
string

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

Responses

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

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/uptimes/1acfg43d/metrics/historic"

Response samples

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

Create an output

This operation creates an output rendition for a specific transcoder.

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)
stream_format
required
string
Enum: "audiovideo" "videoonly" "audioonly"

The contents of the stream. The default is both audio and video (audiovideo).

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

bitrate_audio
integer <int32>

The audio bitrate, in kilobits per second (Kbps). Must be between 0 (for passthrough audio) and 1000. The default is 128.

bitrate_video
integer <int32>

The video bitrate, in kilobits per second (Kbps). Must be between 0 (for passthrough video) and 10240. The default is 4000.

framerate_reduction
string
Enum: "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
string
Enum: "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.

keyframes
string
Enum: "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.

passthrough_audio
boolean

If true, sends the audio track to the target without transcoding. The default is false.

passthrough_video
boolean

If true, sends the video track to the target without transcoding. The default is false.

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

bitrate_audio
integer <int32>

The audio bitrate, in kilobits per second (Kbps). Must be between 0 (for passthrough audio) and 1000. The default is 128.

bitrate_video
integer <int32>

The video bitrate, in kilobits per second (Kbps). Must be between 0 (for passthrough video) and 10240. The default is 4000.

created_at
string <date-time>

The date and time that the output rendition was created.

framerate_reduction
string
Enum: "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
string
Enum: "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.

keyframes
string
Enum: "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).

Array of objects (output_stream_target)
passthrough_audio
boolean

If true, sends the audio track to the target without transcoding. The default is false.

passthrough_video
boolean

If true, sends the video track to the target without transcoding. The default is false.

stream_format
string
Enum: "audiovideo" "videoonly" "audioonly"

The contents of the stream. The default is both audio and video (audiovideo).

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

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

Response samples

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

Fetch all outputs of a transcoder

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

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

Response Schema: application/json
required
Array of objects (output)
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 1980.

bitrate_audio
integer <int32>

The audio bitrate, in kilobits per second (Kbps). Must be between 0 (for passthrough audio) and 1000. The default is 128.

bitrate_video
integer <int32>

The video bitrate, in kilobits per second (Kbps). Must be between 0 (for passthrough video) and 10240. The default is 4000.

created_at
string <date-time>

The date and time that the output rendition was created.

framerate_reduction
string
Enum: "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
string
Enum: "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.

keyframes
string
Enum: "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).

Array of objects (output_stream_target)
passthrough_audio
boolean

If true, sends the audio track to the target without transcoding. The default is false.

passthrough_video
boolean

If true, sends the video track to the target without transcoding. The default is false.

stream_format
string
Enum: "audiovideo" "videoonly" "audioonly"

The contents of the stream. The default is both audio and video (audiovideo).

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

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

Response samples

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

Fetch an output

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

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

The unique alphanumeric string that identifies the output rendition.

Responses

Response Schema: application/json
required
object (output)
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 1980.

bitrate_audio
integer <int32>

The audio bitrate, in kilobits per second (Kbps). Must be between 0 (for passthrough audio) and 1000. The default is 128.

bitrate_video
integer <int32>

The video bitrate, in kilobits per second (Kbps). Must be between 0 (for passthrough video) and 10240. The default is 4000.

created_at
string <date-time>

The date and time that the output rendition was created.

framerate_reduction
string
Enum: "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
string
Enum: "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.

keyframes
string
Enum: "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).

Array of objects (output_stream_target)
passthrough_audio
boolean

If true, sends the audio track to the target without transcoding. The default is false.

passthrough_video
boolean

If true, sends the video track to the target without transcoding. The default is false.

stream_format
string
Enum: "audiovideo" "videoonly" "audioonly"

The contents of the stream. The default is both audio and video (audiovideo).

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

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

Response samples

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

Update an output

This operation updates an output rendition.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

The unique alphanumeric string that identifies the output rendition.

Request Body schema: application/json

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

required
object (output)
stream_format
required
string
Enum: "audiovideo" "videoonly" "audioonly"

The contents of the stream. The default is both audio and video (audiovideo).

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

bitrate_audio
integer <int32>

The audio bitrate, in kilobits per second (Kbps). Must be between 0 (for passthrough audio) and 1000. The default is 128.

bitrate_video
integer <int32>

The video bitrate, in kilobits per second (Kbps). Must be between 0 (for passthrough video) and 10240. The default is 4000.

framerate_reduction
string
Enum: "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
string
Enum: "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.

keyframes
string
Enum: "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.

passthrough_audio
boolean

If true, sends the audio track to the target without transcoding. The default is false.

passthrough_video
boolean

If true, sends the video track to the target without transcoding. The default is false.

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

bitrate_audio
integer <int32>

The audio bitrate, in kilobits per second (Kbps). Must be between 0 (for passthrough audio) and 1000. The default is 128.

bitrate_video
integer <int32>

The video bitrate, in kilobits per second (Kbps). Must be between 0 (for passthrough video) and 10240. The default is 4000.

created_at
string <date-time>

The date and time that the output rendition was created.

framerate_reduction
string
Enum: "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
string
Enum: "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.

keyframes
string
Enum: "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).

Array of objects (output_stream_target)
passthrough_audio
boolean

If true, sends the audio track to the target without transcoding. The default is false.

passthrough_video
boolean

If true, sends the video track to the target without transcoding. The default is false.

stream_format
string
Enum: "audiovideo" "videoonly" "audioonly"

The contents of the stream. The default is both audio and video (audiovideo).

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

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

Response samples

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

Delete an output

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

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

The unique alphanumeric string that identifies the output rendition.

Responses

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d"

Response samples

Content type
application/json
{
  • "Example Response 1":
    {
    },
  • "Example Response 2":
    {
    },
  • "Example Response 3":
    {
    },
  • "Example Response 4":
    {
    },
  • "Example Response 5":
    {
    },
  • "Example Response 6":
    {
    },
  • "Example Response 7":
    {
    }
}

Create an output stream target

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

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

Request Body schema: application/json

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

required
object (output_stream_target)
stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

use_stream_target_backup_url
boolean

Specifies whether to use 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 to use the stream target's primary or backup URL.

Request samples

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

Response samples

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

Fetch all output stream targets of an output of a transcoder

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

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

Responses

Response Schema: application/json
required
Array of objects (output_stream_target)
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 to use the stream target's primary or backup URL.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets"

Response samples

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

Fetch an output stream target

This operation shows the details of an output stream target.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
object (output_stream_target)
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 to use the stream target's primary or backup URL.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77"

Response samples

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

Update an output stream target

This operation updates an output stream target.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

Request Body schema: application/json

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

required
object (output_stream_target)
stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

use_stream_target_backup_url
boolean

Specifies whether to use 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 to use the stream target's primary or backup URL.

Request samples

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

Response samples

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

Delete an output stream target

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

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77"

Response samples

Content type
application/json
{
  • "Example Response 1":
    {
    },
  • "Example Response 2":
    {
    },
  • "Example Response 3":
    {
    },
  • "Example Response 4":
    {
    },
  • "Example Response 5":
    {
    },
  • "Example Response 6":
    {
    },
  • "Example Response 7":
    {
    }
}

Enable an output stream target

This operation enables an output stream target.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
required
object (stream_target)
state
string
Enum: "enabled" "disabled" "restarted"

The state of the output stream target.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/enable"

Response samples

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

Disable an output stream target

This operation disables an output stream target.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
required
object (stream_target)
state
string
Enum: "enabled" "disabled" "restarted"

The state of the output stream target.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/disable"

Response samples

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

Restart an output stream target

This operation restarts an output stream target.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

output_id
required
string

The unique alphanumeric string that identifies the output rendition.

stream_target_id
required
string

The unique alphanumeric string that identifies the stream target.

Responses

Response Schema: application/json
required
object (stream_target)
state
string
Enum: "enabled" "disabled" "restarted"

The state of the output stream target.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "PUT" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/outputs/1acfg43d/output_stream_targets/82daaf77/restart"

Response samples

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

Configure a property for a transcoder

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

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

Request Body schema: application/json

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

required
object (property)
key
required
string

The key of the property.

For cupertino, valid values are aes128Host, aes128Secret, cupertinoEnableProgramDateTime, cupertinoEnableId3ProgramDateTime, and cupertinoProgramDateTimeOffset.

For file, valid values are repeat and start_streaming_at.

For output, valid values are fitMode and record.

For recording, the only valid value is mp4.

For rtsp, valid values are avSyncMethod, debugRtspSession, maxRtcpWaitTime, rtpDePacketizerPacketSorterBufferTime, rtpDePacketizerPacketSorterFlushTime, rtpDePacketizerWrapper, rtpIgnoreSpropParameterSets, rtpIgnoreProfileLevelId, rtpTransportMode, rtspValidationFrequency, and rtspFilterUnknownTracks.

For vod_stream, the only valid value is hls.

section
required
string
Enum: "cupertino" "file" "output" "recording" "rtsp" "vod_stream"

The section of the transcoder configuration table that contains the property.

value
required
string

The value of the property.

For aes128Host, specify the URL that devices will use to fetch the key to decrypt the stream.

For aes128Secret, specify the 16-byte key that will be used to decrypt the stream. The key must be 32 characters in length and can only contain hex characters (a-z, A-Z, 0-9). The key must match the key returned by the aes128Host.

For avSyncMethod, debugRtspSession, hls, mp4, repeat, rtspFilterUnknownTracks, rtpIgnoreSpropParameterSets, rtpIgnoreProfileLevelId, cupertinoEnableProgramDateTime, and cupertinoEnableId3ProgramDateTime, use true or false, expressed as a string or a Boolean.

For cupertinoProgramDateTimeOffset, use an integer, expressed as a string or an integer. The default is 0 (ms).

For fitMode, use letterbox, fit-width, fit-height, crop, stretch, or match-source. The default is fit-height.

For maxRtcpWaitTime, use a whole number, expressed as a string or an integer. The default is 2000 (ms).

For record, use an output ID associated with the transcoder.

For rtpDePacketizerPacketSorterBufferTime use an integer, expressed as a string or an integer. The default is 500 (ms).

For rtpDePacketizerPacketSorterFlushTime, use an integer, expressed as a string or an integer. The default is 10 (ms).

For rtpDePacketizerWrapper, use the string RTPDePacketizerWrapperPacketSorter.

For rtpTransportMode, use the string udp or interleave (the default).

For rtspValidationFrequency, use a whole number, expressed as a string or an integer. The default is 15000 (ms).

For start_streaming_at, specify the month, day, year, and time of day that the file should start streaming, expressed as a string. 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
object (transcoder_property)
key
string

The key of the property.

For cupertino, valid values are aes128Host, aes128Secret, cupertinoEnableProgramDateTime, cupertinoEnableId3ProgramDateTime, and cupertinoProgramDateTimeOffset.

For file, valid values are repeat and start_streaming_at.

For output, valid values are fitMode and record.

For recording, the only valid value is mp4.

For rtsp, valid values are avSyncMethod, debugRtspSession, maxRtcpWaitTime, rtpDePacketizerPacketSorterBufferTime, rtpDePacketizerPacketSorterFlushTime, rtpDePacketizerWrapper, rtpIgnoreSpropParameterSets, rtpIgnoreProfileLevelId, rtpTransportMode, rtspValidationFrequency, and rtspFilterUnknownTracks.

For vod_stream, the only valid value is hls.

section
string
Enum: "cupertino" "file" "output" "recording" "rtsp" "vod_stream"

The section of the transcoder configuration table that contains the property.

value
string

The value of the property.

For aes128Host, specify the URL that devices will use to fetch the key to decrypt the stream.

For aes128Secret, specify the 16-byte key that will be used to decrypt the stream. The key must be 32 characters in length and can only contain hex characters (a-z, A-Z, 0-9). The key must match the key returned by the aes128Host.

For avSyncMethod, debugRtspSession, hls, mp4, repeat, rtspFilterUnknownTracks, rtpIgnoreSpropParameterSets, rtpIgnoreProfileLevelId, cupertinoEnableProgramDateTime, and cupertinoEnableId3ProgramDateTime, valid values are the Booleans true and false.

For cupertinoProgramDateTimeOffset, valid values are any integer (ms), expressed as an integer.

For fitMode, valid values are letterbox, fit-width, fit-height, crop, stretch, and match-source. The default is fit-height.

For maxRtcpWaitTime, valid values are 0 (ms) and greater, expressed as an integer.

For record, a valid value is an output ID associated with the transcoder.

For rtpDePacketizerPacketSorterBufferTime valid values are an integer, expressed as a string or an integer. The default is 500 (ms).

For rtpDePacketizerPacketSorterFlushTime, valid values are an integer, expressed as a string or an integer. The default is 10 (ms).

For rtpDePacketizerWrapper, the valid value is the string RTPDePacketizerWrapperPacketSorter.

For rtpTransportMode, valid values are the strings udp and interleave.

For rtspValidationFrequency, valid values are 0 (ms) and greater, expressed as an integer.

For start_streaming_at, specify the month, day, year, and time of day that the file should start streaming, expressed as a string. Express the value by using the ISO 8601 standard of YYYY-MM-DDTHH:MM:SSZ where HH is a 24-hour clock in UTC.

Request samples

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

Response samples

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

Fetch a transcoder's properties

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

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

Responses

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

The key of the property.

For cupertino, valid values are aes128Host, aes128Secret, cupertinoEnableProgramDateTime, cupertinoEnableId3ProgramDateTime, and cupertinoProgramDateTimeOffset.

For file, valid values are repeat and start_streaming_at.

For output, valid values are fitMode and record.

For recording, the only valid value is mp4.

For rtsp, valid values are avSyncMethod, debugRtspSession, maxRtcpWaitTime, rtpDePacketizerPacketSorterBufferTime, rtpDePacketizerPacketSorterFlushTime, rtpDePacketizerWrapper, rtpIgnoreSpropParameterSets, rtpIgnoreProfileLevelId, rtpTransportMode, rtspValidationFrequency, and rtspFilterUnknownTracks.

For vod_stream, the only valid value is hls.

section
string
Enum: "cupertino" "file" "output" "recording" "rtsp" "vod_stream"

The section of the transcoder configuration table that contains the property.

value
string

The value of the property.

For aes128Host, specify the URL that devices will use to fetch the key to decrypt the stream.

For aes128Secret, specify the 16-byte key that will be used to decrypt the stream. The key must be 32 characters in length and can only contain hex characters (a-z, A-Z, 0-9). The key must match the key returned by the aes128Host.

For avSyncMethod, debugRtspSession, hls, mp4, repeat, rtspFilterUnknownTracks, rtpIgnoreSpropParameterSets, rtpIgnoreProfileLevelId, cupertinoEnableProgramDateTime, and cupertinoEnableId3ProgramDateTime, valid values are the Booleans true and false.

For cupertinoProgramDateTimeOffset, valid values are any integer (ms), expressed as an integer.

For fitMode, valid values are letterbox, fit-width, fit-height, crop, stretch, and match-source. The default is fit-height.

For maxRtcpWaitTime, valid values are 0 (ms) and greater, expressed as an integer.

For record, a valid value is an output ID associated with the transcoder.

For rtpDePacketizerPacketSorterBufferTime valid values are an integer, expressed as a string or an integer. The default is 500 (ms).

For rtpDePacketizerPacketSorterFlushTime, valid values are an integer, expressed as a string or an integer. The default is 10 (ms).

For rtpDePacketizerWrapper, the valid value is the string RTPDePacketizerWrapperPacketSorter.

For rtpTransportMode, valid values are the strings udp and interleave.

For rtspValidationFrequency, valid values are 0 (ms) and greater, expressed as an integer.

For start_streaming_at, specify the month, day, year, and time of day that the file should start streaming, expressed as a string. Express the value by using the ISO 8601 standard of YYYY-MM-DDTHH:MM:SSZ where HH is a 24-hour clock in UTC.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/properties"

Response samples

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

Fetch a property for a transcoder

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

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

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

Responses

Response Schema: application/json
object (transcoder_property)
key
string

The key of the property.

For cupertino, valid values are aes128Host, aes128Secret, cupertinoEnableProgramDateTime, cupertinoEnableId3ProgramDateTime, and cupertinoProgramDateTimeOffset.

For file, valid values are repeat and start_streaming_at.

For output, valid values are fitMode and record.

For recording, the only valid value is mp4.

For rtsp, valid values are avSyncMethod, debugRtspSession, maxRtcpWaitTime, rtpDePacketizerPacketSorterBufferTime, rtpDePacketizerPacketSorterFlushTime, rtpDePacketizerWrapper, rtpIgnoreSpropParameterSets, rtpIgnoreProfileLevelId, rtpTransportMode, rtspValidationFrequency, and rtspFilterUnknownTracks.

For vod_stream, the only valid value is hls.

section
string
Enum: "cupertino" "file" "output" "recording" "rtsp" "vod_stream"

The section of the transcoder configuration table that contains the property.

value
string

The value of the property.

For aes128Host, specify the URL that devices will use to fetch the key to decrypt the stream.

For aes128Secret, specify the 16-byte key that will be used to decrypt the stream. The key must be 32 characters in length and can only contain hex characters (a-z, A-Z, 0-9). The key must match the key returned by the aes128Host.

For avSyncMethod, debugRtspSession, hls, mp4, repeat, rtspFilterUnknownTracks, rtpIgnoreSpropParameterSets, rtpIgnoreProfileLevelId, cupertinoEnableProgramDateTime, and cupertinoEnableId3ProgramDateTime, valid values are the Booleans true and false.

For cupertinoProgramDateTimeOffset, valid values are any integer (ms), expressed as an integer.

For fitMode, valid values are letterbox, fit-width, fit-height, crop, stretch, and match-source. The default is fit-height.

For maxRtcpWaitTime, valid values are 0 (ms) and greater, expressed as an integer.

For record, a valid value is an output ID associated with the transcoder.

For rtpDePacketizerPacketSorterBufferTime valid values are an integer, expressed as a string or an integer. The default is 500 (ms).

For rtpDePacketizerPacketSorterFlushTime, valid values are an integer, expressed as a string or an integer. The default is 10 (ms).

For rtpDePacketizerWrapper, the valid value is the string RTPDePacketizerWrapperPacketSorter.

For rtpTransportMode, valid values are the strings udp and interleave.

For rtspValidationFrequency, valid values are 0 (ms) and greater, expressed as an integer.

For start_streaming_at, specify the month, day, year, and time of day that the file should start streaming, expressed as a string. Express the value by using the ISO 8601 standard of YYYY-MM-DDTHH:MM:SSZ where HH is a 24-hour clock in UTC.

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "GET" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/properties/cupertino-cupertinoProgramDateTimeOffset"

Response samples

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

Delete a transcoder's property

This operation deletes a specific property from a specific transcoder.

path Parameters
transcoder_id
required
string

The unique alphanumeric string that identifies the transcoder.

id
required
string

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

Responses

Request samples

// Using cURL
curl -H "wsc-api-key: ${WSC_API_KEY}" \
  -H "wsc-access-key: ${WSC_ACCESS_KEY}" \
  -H "Content-Type: application/json" \
  -X "DELETE" \
  "${WSC_HOST}/api/beta/transcoders/2adffc17/properties/cupertino-cupertinoProgramDateTimeOffset"

Response samples

Content type
application/json
{
  • "Example Response 1":
    {
    },
  • "Example Response 2":
    {
    },
  • "Example Response 3":
    {
    },
  • "Example Response 4":
    {
    },
  • "Example Response 5":
    {
    },
  • "Example Response 6":
    {
    },
  • "Example Response 7":
    {
    }
}
➔ Next to Stream Sources