Class: AWS.MediaLive

Inherits:
AWS.Service show all
Identifier:
medialive
API Version:
2017-10-14
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

API for AWS Elemental MediaLive

Sending a Request Using MediaLive

var medialive = new AWS.MediaLive();
medialive.batchUpdateSchedule(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the MediaLive object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var medialive = new AWS.MediaLive({apiVersion: '2017-10-14'});

You can also set the API version globally in AWS.config.apiVersions using the medialive service identifier:

AWS.config.apiVersions = {
  medialive: '2017-10-14',
  // other service API versions
};

var medialive = new AWS.MediaLive();

Version:

  • 2017-10-14

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.MediaLive(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a MediaLive object

var medialive = new AWS.MediaLive({apiVersion: '2017-10-14'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com'.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.MediaLive.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.MediaLive.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.MediaLive.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

batchUpdateSchedule(params = {}, callback) ⇒ AWS.Request

Update a channel schedule

Service Reference:

Examples:

Calling the batchUpdateSchedule operation

var params = {
  ChannelId: 'STRING_VALUE', /* required */
  Creates: {
    ScheduleActions: [ /* required */
      {
        ActionName: 'STRING_VALUE', /* required */
        ScheduleActionSettings: { /* required */
          HlsTimedMetadataSettings: {
            Id3: 'STRING_VALUE' /* required */
          },
          InputSwitchSettings: {
            InputAttachmentNameReference: 'STRING_VALUE' /* required */
          },
          PauseStateSettings: {
            Pipelines: [
              {
                PipelineId: PIPELINE_0 | PIPELINE_1 /* required */
              },
              /* more items */
            ]
          },
          Scte35ReturnToNetworkSettings: {
            SpliceEventId: 'NUMBER_VALUE' /* required */
          },
          Scte35SpliceInsertSettings: {
            SpliceEventId: 'NUMBER_VALUE', /* required */
            Duration: 'NUMBER_VALUE'
          },
          Scte35TimeSignalSettings: {
            Scte35Descriptors: [ /* required */
              {
                Scte35DescriptorSettings: { /* required */
                  SegmentationDescriptorScte35DescriptorSettings: { /* required */
                    SegmentationCancelIndicator: SEGMENTATION_EVENT_NOT_CANCELED | SEGMENTATION_EVENT_CANCELED, /* required */
                    SegmentationEventId: 'NUMBER_VALUE', /* required */
                    DeliveryRestrictions: {
                      ArchiveAllowedFlag: ARCHIVE_NOT_ALLOWED | ARCHIVE_ALLOWED, /* required */
                      DeviceRestrictions: NONE | RESTRICT_GROUP0 | RESTRICT_GROUP1 | RESTRICT_GROUP2, /* required */
                      NoRegionalBlackoutFlag: REGIONAL_BLACKOUT | NO_REGIONAL_BLACKOUT, /* required */
                      WebDeliveryAllowedFlag: WEB_DELIVERY_NOT_ALLOWED | WEB_DELIVERY_ALLOWED /* required */
                    },
                    SegmentNum: 'NUMBER_VALUE',
                    SegmentationDuration: 'NUMBER_VALUE',
                    SegmentationTypeId: 'NUMBER_VALUE',
                    SegmentationUpid: 'STRING_VALUE',
                    SegmentationUpidType: 'NUMBER_VALUE',
                    SegmentsExpected: 'NUMBER_VALUE',
                    SubSegmentNum: 'NUMBER_VALUE',
                    SubSegmentsExpected: 'NUMBER_VALUE'
                  }
                }
              },
              /* more items */
            ]
          },
          StaticImageActivateSettings: {
            Image: { /* required */
              Uri: 'STRING_VALUE', /* required */
              PasswordParam: 'STRING_VALUE',
              Username: 'STRING_VALUE'
            },
            Duration: 'NUMBER_VALUE',
            FadeIn: 'NUMBER_VALUE',
            FadeOut: 'NUMBER_VALUE',
            Height: 'NUMBER_VALUE',
            ImageX: 'NUMBER_VALUE',
            ImageY: 'NUMBER_VALUE',
            Layer: 'NUMBER_VALUE',
            Opacity: 'NUMBER_VALUE',
            Width: 'NUMBER_VALUE'
          },
          StaticImageDeactivateSettings: {
            FadeOut: 'NUMBER_VALUE',
            Layer: 'NUMBER_VALUE'
          }
        },
        ScheduleActionStartSettings: { /* required */
          FixedModeScheduleActionStartSettings: {
            Time: 'STRING_VALUE' /* required */
          },
          FollowModeScheduleActionStartSettings: {
            FollowPoint: END | START, /* required */
            ReferenceActionName: 'STRING_VALUE' /* required */
          }
        }
      },
      /* more items */
    ]
  },
  Deletes: {
    ActionNames: [ /* required */
      'STRING_VALUE',
      /* more items */
    ]
  }
};
medialive.batchUpdateSchedule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ChannelId — (String) Id of the channel whose schedule is being updated.
    • Creates — (map) Schedule actions to create in the schedule.
      • ScheduleActions — required — (Array<map>) A list of schedule actions to create.
        • ActionName — required — (String) The name of the action, must be unique within the schedule. This name provides the main reference to an action once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that point a name can be reused.
        • ScheduleActionSettings — required — (map) Settings for this schedule action.
          • HlsTimedMetadataSettings — (map) Action to insert HLS metadata
          • InputSwitchSettings — (map) Action to switch the input
            • InputAttachmentNameReference — required — (String) The name of the input attachment that should be switched to by this action.
          • PauseStateSettings — (map) Action to pause or unpause one or both channel pipelines
            • Pipelines — (Array<map>) Placeholder documentation for __listOfPipelinePauseStateSettings
              • PipelineId — required — (String) Pipeline ID to pause ("PIPELINE_0" or "PIPELINE_1"). Possible values include:
                • "PIPELINE_0"
                • "PIPELINE_1"
          • Scte35ReturnToNetworkSettings — (map) Action to insert SCTE-35 return_to_network message
            • SpliceEventId — required — (Integer) The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
          • Scte35SpliceInsertSettings — (map) Action to insert SCTE-35 splice_insert message
            • Duration — (Integer) Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time.
            • SpliceEventId — required — (Integer) The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
          • Scte35TimeSignalSettings — (map) Action to insert SCTE-35 time_signal message
            • Scte35Descriptors — required — (Array<map>) The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.
              • Scte35DescriptorSettings — required — (map) SCTE-35 Descriptor Settings.
                • SegmentationDescriptorScte35DescriptorSettings — required — (map) SCTE-35 Segmentation Descriptor.
                  • DeliveryRestrictions — (map) Holds the four SCTE-35 delivery restriction parameters.
                    • ArchiveAllowedFlag — required — (String) Corresponds to SCTE-35 archive_allowed_flag. Possible values include:
                      • "ARCHIVE_NOT_ALLOWED"
                      • "ARCHIVE_ALLOWED"
                    • DeviceRestrictions — required — (String) Corresponds to SCTE-35 device_restrictions parameter. Possible values include:
                      • "NONE"
                      • "RESTRICT_GROUP0"
                      • "RESTRICT_GROUP1"
                      • "RESTRICT_GROUP2"
                    • NoRegionalBlackoutFlag — required — (String) Corresponds to SCTE-35 no_regional_blackout_flag parameter. Possible values include:
                      • "REGIONAL_BLACKOUT"
                      • "NO_REGIONAL_BLACKOUT"
                    • WebDeliveryAllowedFlag — required — (String) Corresponds to SCTE-35 web_delivery_allowed_flag parameter. Possible values include:
                      • "WEB_DELIVERY_NOT_ALLOWED"
                      • "WEB_DELIVERY_ALLOWED"
                  • SegmentNum — (Integer) Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.
                  • SegmentationCancelIndicator — required — (String) Corresponds to SCTE-35 segmentation_event_cancel_indicator. Possible values include:
                    • "SEGMENTATION_EVENT_NOT_CANCELED"
                    • "SEGMENTATION_EVENT_CANCELED"
                  • SegmentationDuration — (Integer) Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message.
                  • SegmentationEventId — required — (Integer) Corresponds to SCTE-35 segmentation_event_id.
                  • SegmentationTypeId — (Integer) Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the ID in hex (for example, "0x34") or decimal (for example, "52").
                  • SegmentationUpid — (String) Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex "41445320496e666f726d6174696f6e.
                  • SegmentationUpidType — (Integer) Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, "0x0C" ) or in decimal (for example, "12").
                  • SegmentsExpected — (Integer) Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.
                  • SubSegmentNum — (Integer) Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.
                  • SubSegmentsExpected — (Integer) Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.
          • StaticImageActivateSettings — (map) Action to activate a static image overlay
            • Duration — (Integer) The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated.
            • FadeIn — (Integer) The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in).
            • FadeOut — (Integer) Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out).
            • Height — (Integer) The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay.
            • Image — required — (map) The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • ImageX — (Integer) Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right.
            • ImageY — (Integer) Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom.
            • Layer — (Integer) The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0.
            • Opacity — (Integer) Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.
            • Width — (Integer) The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.
          • StaticImageDeactivateSettings — (map) Action to deactivate a static image overlay
            • FadeOut — (Integer) The time in milliseconds for the image to fade out. Default is 0 (no fade-out).
            • Layer — (Integer) The image overlay layer to deactivate, 0 to 7. Default is 0.
        • ScheduleActionStartSettings — required — (map) The time for the action to start in the channel.
          • FixedModeScheduleActionStartSettings — (map) Holds the start time for the action.
            • Time — required — (String) Start time for the action to start in the channel. (Not the time for the action to be added to the schedule: actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are digits (for example, mm might be 01) except for the two constants "T" for time and "Z" for "UTC format".
          • FollowModeScheduleActionStartSettings — (map) Specifies an action to follow for scheduling this action.
            • FollowPoint — required — (String) Identifies whether this action starts relative to the start or relative to the end of the reference action. Possible values include:
              • "END"
              • "START"
            • ReferenceActionName — required — (String) The action name of another action that this one refers to.
    • Deletes — (map) Schedule actions to delete from the schedule.
      • ActionNames — required — (Array<String>) A list of schedule actions to delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Creates — (map) Schedule actions created in the schedule.
        • ScheduleActions — required — (Array<map>) List of actions that have been created in the schedule.
          • ActionName — required — (String) The name of the action, must be unique within the schedule. This name provides the main reference to an action once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that point a name can be reused.
          • ScheduleActionSettings — required — (map) Settings for this schedule action.
            • HlsTimedMetadataSettings — (map) Action to insert HLS metadata
            • InputSwitchSettings — (map) Action to switch the input
              • InputAttachmentNameReference — required — (String) The name of the input attachment that should be switched to by this action.
            • PauseStateSettings — (map) Action to pause or unpause one or both channel pipelines
              • Pipelines — (Array<map>) Placeholder documentation for __listOfPipelinePauseStateSettings
                • PipelineId — required — (String) Pipeline ID to pause ("PIPELINE_0" or "PIPELINE_1"). Possible values include:
                  • "PIPELINE_0"
                  • "PIPELINE_1"
            • Scte35ReturnToNetworkSettings — (map) Action to insert SCTE-35 return_to_network message
              • SpliceEventId — required — (Integer) The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
            • Scte35SpliceInsertSettings — (map) Action to insert SCTE-35 splice_insert message
              • Duration — (Integer) Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time.
              • SpliceEventId — required — (Integer) The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
            • Scte35TimeSignalSettings — (map) Action to insert SCTE-35 time_signal message
              • Scte35Descriptors — required — (Array<map>) The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.
                • Scte35DescriptorSettings — required — (map) SCTE-35 Descriptor Settings.
                  • SegmentationDescriptorScte35DescriptorSettings — required — (map) SCTE-35 Segmentation Descriptor.
                    • DeliveryRestrictions — (map) Holds the four SCTE-35 delivery restriction parameters.
                      • ArchiveAllowedFlag — required — (String) Corresponds to SCTE-35 archive_allowed_flag. Possible values include:
                        • "ARCHIVE_NOT_ALLOWED"
                        • "ARCHIVE_ALLOWED"
                      • DeviceRestrictions — required — (String) Corresponds to SCTE-35 device_restrictions parameter. Possible values include:
                        • "NONE"
                        • "RESTRICT_GROUP0"
                        • "RESTRICT_GROUP1"
                        • "RESTRICT_GROUP2"
                      • NoRegionalBlackoutFlag — required — (String) Corresponds to SCTE-35 no_regional_blackout_flag parameter. Possible values include:
                        • "REGIONAL_BLACKOUT"
                        • "NO_REGIONAL_BLACKOUT"
                      • WebDeliveryAllowedFlag — required — (String) Corresponds to SCTE-35 web_delivery_allowed_flag parameter. Possible values include:
                        • "WEB_DELIVERY_NOT_ALLOWED"
                        • "WEB_DELIVERY_ALLOWED"
                    • SegmentNum — (Integer) Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.
                    • SegmentationCancelIndicator — required — (String) Corresponds to SCTE-35 segmentation_event_cancel_indicator. Possible values include:
                      • "SEGMENTATION_EVENT_NOT_CANCELED"
                      • "SEGMENTATION_EVENT_CANCELED"
                    • SegmentationDuration — (Integer) Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message.
                    • SegmentationEventId — required — (Integer) Corresponds to SCTE-35 segmentation_event_id.
                    • SegmentationTypeId — (Integer) Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the ID in hex (for example, "0x34") or decimal (for example, "52").
                    • SegmentationUpid — (String) Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex "41445320496e666f726d6174696f6e.
                    • SegmentationUpidType — (Integer) Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, "0x0C" ) or in decimal (for example, "12").
                    • SegmentsExpected — (Integer) Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.
                    • SubSegmentNum — (Integer) Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.
                    • SubSegmentsExpected — (Integer) Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.
            • StaticImageActivateSettings — (map) Action to activate a static image overlay
              • Duration — (Integer) The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated.
              • FadeIn — (Integer) The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in).
              • FadeOut — (Integer) Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out).
              • Height — (Integer) The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay.
              • Image — required — (map) The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video.
                • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                • Username — (String) Documentation update needed
              • ImageX — (Integer) Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right.
              • ImageY — (Integer) Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom.
              • Layer — (Integer) The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0.
              • Opacity — (Integer) Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.
              • Width — (Integer) The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.
            • StaticImageDeactivateSettings — (map) Action to deactivate a static image overlay
              • FadeOut — (Integer) The time in milliseconds for the image to fade out. Default is 0 (no fade-out).
              • Layer — (Integer) The image overlay layer to deactivate, 0 to 7. Default is 0.
          • ScheduleActionStartSettings — required — (map) The time for the action to start in the channel.
            • FixedModeScheduleActionStartSettings — (map) Holds the start time for the action.
              • Time — required — (String) Start time for the action to start in the channel. (Not the time for the action to be added to the schedule: actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are digits (for example, mm might be 01) except for the two constants "T" for time and "Z" for "UTC format".
            • FollowModeScheduleActionStartSettings — (map) Specifies an action to follow for scheduling this action.
              • FollowPoint — required — (String) Identifies whether this action starts relative to the start or relative to the end of the reference action. Possible values include:
                • "END"
                • "START"
              • ReferenceActionName — required — (String) The action name of another action that this one refers to.
      • Deletes — (map) Schedule actions deleted from the schedule.
        • ScheduleActions — required — (Array<map>) List of actions that have been deleted from the schedule.
          • ActionName — required — (String) The name of the action, must be unique within the schedule. This name provides the main reference to an action once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that point a name can be reused.
          • ScheduleActionSettings — required — (map) Settings for this schedule action.
            • HlsTimedMetadataSettings — (map) Action to insert HLS metadata
            • InputSwitchSettings — (map) Action to switch the input
              • InputAttachmentNameReference — required — (String) The name of the input attachment that should be switched to by this action.
            • PauseStateSettings — (map) Action to pause or unpause one or both channel pipelines
              • Pipelines — (Array<map>) Placeholder documentation for __listOfPipelinePauseStateSettings
                • PipelineId — required — (String) Pipeline ID to pause ("PIPELINE_0" or "PIPELINE_1"). Possible values include:
                  • "PIPELINE_0"
                  • "PIPELINE_1"
            • Scte35ReturnToNetworkSettings — (map) Action to insert SCTE-35 return_to_network message
              • SpliceEventId — required — (Integer) The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
            • Scte35SpliceInsertSettings — (map) Action to insert SCTE-35 splice_insert message
              • Duration — (Integer) Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time.
              • SpliceEventId — required — (Integer) The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
            • Scte35TimeSignalSettings — (map) Action to insert SCTE-35 time_signal message
              • Scte35Descriptors — required — (Array<map>) The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.
                • Scte35DescriptorSettings — required — (map) SCTE-35 Descriptor Settings.
                  • SegmentationDescriptorScte35DescriptorSettings — required — (map) SCTE-35 Segmentation Descriptor.
                    • DeliveryRestrictions — (map) Holds the four SCTE-35 delivery restriction parameters.
                      • ArchiveAllowedFlag — required — (String) Corresponds to SCTE-35 archive_allowed_flag. Possible values include:
                        • "ARCHIVE_NOT_ALLOWED"
                        • "ARCHIVE_ALLOWED"
                      • DeviceRestrictions — required — (String) Corresponds to SCTE-35 device_restrictions parameter. Possible values include:
                        • "NONE"
                        • "RESTRICT_GROUP0"
                        • "RESTRICT_GROUP1"
                        • "RESTRICT_GROUP2"
                      • NoRegionalBlackoutFlag — required — (String) Corresponds to SCTE-35 no_regional_blackout_flag parameter. Possible values include:
                        • "REGIONAL_BLACKOUT"
                        • "NO_REGIONAL_BLACKOUT"
                      • WebDeliveryAllowedFlag — required — (String) Corresponds to SCTE-35 web_delivery_allowed_flag parameter. Possible values include:
                        • "WEB_DELIVERY_NOT_ALLOWED"
                        • "WEB_DELIVERY_ALLOWED"
                    • SegmentNum — (Integer) Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.
                    • SegmentationCancelIndicator — required — (String) Corresponds to SCTE-35 segmentation_event_cancel_indicator. Possible values include:
                      • "SEGMENTATION_EVENT_NOT_CANCELED"
                      • "SEGMENTATION_EVENT_CANCELED"
                    • SegmentationDuration — (Integer) Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message.
                    • SegmentationEventId — required — (Integer) Corresponds to SCTE-35 segmentation_event_id.
                    • SegmentationTypeId — (Integer) Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the ID in hex (for example, "0x34") or decimal (for example, "52").
                    • SegmentationUpid — (String) Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex "41445320496e666f726d6174696f6e.
                    • SegmentationUpidType — (Integer) Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, "0x0C" ) or in decimal (for example, "12").
                    • SegmentsExpected — (Integer) Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.
                    • SubSegmentNum — (Integer) Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.
                    • SubSegmentsExpected — (Integer) Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.
            • StaticImageActivateSettings — (map) Action to activate a static image overlay
              • Duration — (Integer) The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated.
              • FadeIn — (Integer) The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in).
              • FadeOut — (Integer) Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out).
              • Height — (Integer) The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay.
              • Image — required — (map) The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video.
                • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                • Username — (String) Documentation update needed
              • ImageX — (Integer) Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right.
              • ImageY — (Integer) Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom.
              • Layer — (Integer) The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0.
              • Opacity — (Integer) Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.
              • Width — (Integer) The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.
            • StaticImageDeactivateSettings — (map) Action to deactivate a static image overlay
              • FadeOut — (Integer) The time in milliseconds for the image to fade out. Default is 0 (no fade-out).
              • Layer — (Integer) The image overlay layer to deactivate, 0 to 7. Default is 0.
          • ScheduleActionStartSettings — required — (map) The time for the action to start in the channel.
            • FixedModeScheduleActionStartSettings — (map) Holds the start time for the action.
              • Time — required — (String) Start time for the action to start in the channel. (Not the time for the action to be added to the schedule: actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are digits (for example, mm might be 01) except for the two constants "T" for time and "Z" for "UTC format".
            • FollowModeScheduleActionStartSettings — (map) Specifies an action to follow for scheduling this action.
              • FollowPoint — required — (String) Identifies whether this action starts relative to the start or relative to the end of the reference action. Possible values include:
                • "END"
                • "START"
              • ReferenceActionName — required — (String) The action name of another action that this one refers to.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createChannel(params = {}, callback) ⇒ AWS.Request

Creates a new channel

Service Reference:

Examples:

Calling the createChannel operation

var params = {
  ChannelClass: STANDARD | SINGLE_PIPELINE,
  Destinations: [
    {
      Id: 'STRING_VALUE',
      MediaPackageSettings: [
        {
          ChannelId: 'STRING_VALUE'
        },
        /* more items */
      ],
      Settings: [
        {
          PasswordParam: 'STRING_VALUE',
          StreamName: 'STRING_VALUE',
          Url: 'STRING_VALUE',
          Username: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  EncoderSettings: {
    AudioDescriptions: [ /* required */
      {
        AudioSelectorName: 'STRING_VALUE', /* required */
        Name: 'STRING_VALUE', /* required */
        AudioNormalizationSettings: {
          Algorithm: ITU_1770_1 | ITU_1770_2,
          AlgorithmControl: CORRECT_AUDIO,
          TargetLkfs: 'NUMBER_VALUE'
        },
        AudioType: CLEAN_EFFECTS | HEARING_IMPAIRED | UNDEFINED | VISUAL_IMPAIRED_COMMENTARY,
        AudioTypeControl: FOLLOW_INPUT | USE_CONFIGURED,
        CodecSettings: {
          AacSettings: {
            Bitrate: 'NUMBER_VALUE',
            CodingMode: AD_RECEIVER_MIX | CODING_MODE_1_0 | CODING_MODE_1_1 | CODING_MODE_2_0 | CODING_MODE_5_1,
            InputType: BROADCASTER_MIXED_AD | NORMAL,
            Profile: HEV1 | HEV2 | LC,
            RateControlMode: CBR | VBR,
            RawFormat: LATM_LOAS | NONE,
            SampleRate: 'NUMBER_VALUE',
            Spec: MPEG2 | MPEG4,
            VbrQuality: HIGH | LOW | MEDIUM_HIGH | MEDIUM_LOW
          },
          Ac3Settings: {
            Bitrate: 'NUMBER_VALUE',
            BitstreamMode: COMMENTARY | COMPLETE_MAIN | DIALOGUE | EMERGENCY | HEARING_IMPAIRED | MUSIC_AND_EFFECTS | VISUALLY_IMPAIRED | VOICE_OVER,
            CodingMode: CODING_MODE_1_0 | CODING_MODE_1_1 | CODING_MODE_2_0 | CODING_MODE_3_2_LFE,
            Dialnorm: 'NUMBER_VALUE',
            DrcProfile: FILM_STANDARD | NONE,
            LfeFilter: DISABLED | ENABLED,
            MetadataControl: FOLLOW_INPUT | USE_CONFIGURED
          },
          Eac3Settings: {
            AttenuationControl: ATTENUATE_3_DB | NONE,
            Bitrate: 'NUMBER_VALUE',
            BitstreamMode: COMMENTARY | COMPLETE_MAIN | EMERGENCY | HEARING_IMPAIRED | VISUALLY_IMPAIRED,
            CodingMode: CODING_MODE_1_0 | CODING_MODE_2_0 | CODING_MODE_3_2,
            DcFilter: DISABLED | ENABLED,
            Dialnorm: 'NUMBER_VALUE',
            DrcLine: FILM_LIGHT | FILM_STANDARD | MUSIC_LIGHT | MUSIC_STANDARD | NONE | SPEECH,
            DrcRf: FILM_LIGHT | FILM_STANDARD | MUSIC_LIGHT | MUSIC_STANDARD | NONE | SPEECH,
            LfeControl: LFE | NO_LFE,
            LfeFilter: DISABLED | ENABLED,
            LoRoCenterMixLevel: 'NUMBER_VALUE',
            LoRoSurroundMixLevel: 'NUMBER_VALUE',
            LtRtCenterMixLevel: 'NUMBER_VALUE',
            LtRtSurroundMixLevel: 'NUMBER_VALUE',
            MetadataControl: FOLLOW_INPUT | USE_CONFIGURED,
            PassthroughControl: NO_PASSTHROUGH | WHEN_POSSIBLE,
            PhaseControl: NO_SHIFT | SHIFT_90_DEGREES,
            StereoDownmix: DPL2 | LO_RO | LT_RT | NOT_INDICATED,
            SurroundExMode: DISABLED | ENABLED | NOT_INDICATED,
            SurroundMode: DISABLED | ENABLED | NOT_INDICATED
          },
          Mp2Settings: {
            Bitrate: 'NUMBER_VALUE',
            CodingMode: CODING_MODE_1_0 | CODING_MODE_2_0,
            SampleRate: 'NUMBER_VALUE'
          },
          PassThroughSettings: {
          }
        },
        LanguageCode: 'STRING_VALUE',
        LanguageCodeControl: FOLLOW_INPUT | USE_CONFIGURED,
        RemixSettings: {
          ChannelMappings: [ /* required */
            {
              InputChannelLevels: [ /* required */
                {
                  Gain: 'NUMBER_VALUE', /* required */
                  InputChannel: 'NUMBER_VALUE' /* required */
                },
                /* more items */
              ],
              OutputChannel: 'NUMBER_VALUE' /* required */
            },
            /* more items */
          ],
          ChannelsIn: 'NUMBER_VALUE',
          ChannelsOut: 'NUMBER_VALUE'
        },
        StreamName: 'STRING_VALUE'
      },
      /* more items */
    ],
    OutputGroups: [ /* required */
      {
        OutputGroupSettings: { /* required */
          ArchiveGroupSettings: {
            Destination: { /* required */
              DestinationRefId: 'STRING_VALUE'
            },
            RolloverInterval: 'NUMBER_VALUE'
          },
          FrameCaptureGroupSettings: {
            Destination: { /* required */
              DestinationRefId: 'STRING_VALUE'
            }
          },
          HlsGroupSettings: {
            Destination: { /* required */
              DestinationRefId: 'STRING_VALUE'
            },
            AdMarkers: [
              ADOBE | ELEMENTAL | ELEMENTAL_SCTE35,
              /* more items */
            ],
            BaseUrlContent: 'STRING_VALUE',
            BaseUrlManifest: 'STRING_VALUE',
            CaptionLanguageMappings: [
              {
                CaptionChannel: 'NUMBER_VALUE', /* required */
                LanguageCode: 'STRING_VALUE', /* required */
                LanguageDescription: 'STRING_VALUE' /* required */
              },
              /* more items */
            ],
            CaptionLanguageSetting: INSERT | NONE | OMIT,
            ClientCache: DISABLED | ENABLED,
            CodecSpecification: RFC_4281 | RFC_6381,
            ConstantIv: 'STRING_VALUE',
            DirectoryStructure: SINGLE_DIRECTORY | SUBDIRECTORY_PER_STREAM,
            EncryptionType: AES128 | SAMPLE_AES,
            HlsCdnSettings: {
              HlsAkamaiSettings: {
                ConnectionRetryInterval: 'NUMBER_VALUE',
                FilecacheDuration: 'NUMBER_VALUE',
                HttpTransferMode: CHUNKED | NON_CHUNKED,
                NumRetries: 'NUMBER_VALUE',
                RestartDelay: 'NUMBER_VALUE',
                Salt: 'STRING_VALUE',
                Token: 'STRING_VALUE'
              },
              HlsBasicPutSettings: {
                ConnectionRetryInterval: 'NUMBER_VALUE',
                FilecacheDuration: 'NUMBER_VALUE',
                NumRetries: 'NUMBER_VALUE',
                RestartDelay: 'NUMBER_VALUE'
              },
              HlsMediaStoreSettings: {
                ConnectionRetryInterval: 'NUMBER_VALUE',
                FilecacheDuration: 'NUMBER_VALUE',
                MediaStoreStorageClass: TEMPORAL,
                NumRetries: 'NUMBER_VALUE',
                RestartDelay: 'NUMBER_VALUE'
              },
              HlsWebdavSettings: {
                ConnectionRetryInterval: 'NUMBER_VALUE',
                FilecacheDuration: 'NUMBER_VALUE',
                HttpTransferMode: CHUNKED | NON_CHUNKED,
                NumRetries: 'NUMBER_VALUE',
                RestartDelay: 'NUMBER_VALUE'
              }
            },
            IFrameOnlyPlaylists: DISABLED | STANDARD,
            IndexNSegments: 'NUMBER_VALUE',
            InputLossAction: EMIT_OUTPUT | PAUSE_OUTPUT,
            IvInManifest: EXCLUDE | INCLUDE,
            IvSource: EXPLICIT | FOLLOWS_SEGMENT_NUMBER,
            KeepSegments: 'NUMBER_VALUE',
            KeyFormat: 'STRING_VALUE',
            KeyFormatVersions: 'STRING_VALUE',
            KeyProviderSettings: {
              StaticKeySettings: {
                StaticKeyValue: 'STRING_VALUE', /* required */
                KeyProviderServer: {
                  Uri: 'STRING_VALUE', /* required */
                  PasswordParam: 'STRING_VALUE',
                  Username: 'STRING_VALUE'
                }
              }
            },
            ManifestCompression: GZIP | NONE,
            ManifestDurationFormat: FLOATING_POINT | INTEGER,
            MinSegmentLength: 'NUMBER_VALUE',
            Mode: LIVE | VOD,
            OutputSelection: MANIFESTS_AND_SEGMENTS | SEGMENTS_ONLY,
            ProgramDateTime: EXCLUDE | INCLUDE,
            ProgramDateTimePeriod: 'NUMBER_VALUE',
            RedundantManifest: DISABLED | ENABLED,
            SegmentLength: 'NUMBER_VALUE',
            SegmentationMode: USE_INPUT_SEGMENTATION | USE_SEGMENT_DURATION,
            SegmentsPerSubdirectory: 'NUMBER_VALUE',
            StreamInfResolution: EXCLUDE | INCLUDE,
            TimedMetadataId3Frame: NONE | PRIV | TDRL,
            TimedMetadataId3Period: 'NUMBER_VALUE',
            TimestampDeltaMilliseconds: 'NUMBER_VALUE',
            TsFileMode: SEGMENTED_FILES | SINGLE_FILE
          },
          MediaPackageGroupSettings: {
            Destination: { /* required */
              DestinationRefId: 'STRING_VALUE'
            }
          },
          MsSmoothGroupSettings: {
            Destination: { /* required */
              DestinationRefId: 'STRING_VALUE'
            },
            AcquisitionPointId: 'STRING_VALUE',
            AudioOnlyTimecodeControl: PASSTHROUGH | USE_CONFIGURED_CLOCK,
            CertificateMode: SELF_SIGNED | VERIFY_AUTHENTICITY,
            ConnectionRetryInterval: 'NUMBER_VALUE',
            EventId: 'STRING_VALUE',
            EventIdMode: NO_EVENT_ID | USE_CONFIGURED | USE_TIMESTAMP,
            EventStopBehavior: NONE | SEND_EOS,
            FilecacheDuration: 'NUMBER_VALUE',
            FragmentLength: 'NUMBER_VALUE',
            InputLossAction: EMIT_OUTPUT | PAUSE_OUTPUT,
            NumRetries: 'NUMBER_VALUE',
            RestartDelay: 'NUMBER_VALUE',
            SegmentationMode: USE_INPUT_SEGMENTATION | USE_SEGMENT_DURATION,
            SendDelayMs: 'NUMBER_VALUE',
            SparseTrackType: NONE | SCTE_35,
            StreamManifestBehavior: DO_NOT_SEND | SEND,
            TimestampOffset: 'STRING_VALUE',
            TimestampOffsetMode: USE_CONFIGURED_OFFSET | USE_EVENT_START_DATE
          },
          RtmpGroupSettings: {
            AuthenticationScheme: AKAMAI | COMMON,
            CacheFullBehavior: DISCONNECT_IMMEDIATELY | WAIT_FOR_SERVER,
            CacheLength: 'NUMBER_VALUE',
            CaptionData: ALL | FIELD1_608 | FIELD1_AND_FIELD2_608,
            InputLossAction: EMIT_OUTPUT | PAUSE_OUTPUT,
            RestartDelay: 'NUMBER_VALUE'
          },
          UdpGroupSettings: {
            InputLossAction: DROP_PROGRAM | DROP_TS | EMIT_PROGRAM,
            TimedMetadataId3Frame: NONE | PRIV | TDRL,
            TimedMetadataId3Period: 'NUMBER_VALUE'
          }
        },
        Outputs: [ /* required */
          {
            OutputSettings: { /* required */
              ArchiveOutputSettings: {
                ContainerSettings: { /* required */
                  M2tsSettings: {
                    AbsentInputAudioBehavior: DROP | ENCODE_SILENCE,
                    Arib: DISABLED | ENABLED,
                    AribCaptionsPid: 'STRING_VALUE',
                    AribCaptionsPidControl: AUTO | USE_CONFIGURED,
                    AudioBufferModel: ATSC | DVB,
                    AudioFramesPerPes: 'NUMBER_VALUE',
                    AudioPids: 'STRING_VALUE',
                    AudioStreamType: ATSC | DVB,
                    Bitrate: 'NUMBER_VALUE',
                    BufferModel: MULTIPLEX | NONE,
                    CcDescriptor: DISABLED | ENABLED,
                    DvbNitSettings: {
                      NetworkId: 'NUMBER_VALUE', /* required */
                      NetworkName: 'STRING_VALUE', /* required */
                      RepInterval: 'NUMBER_VALUE'
                    },
                    DvbSdtSettings: {
                      OutputSdt: SDT_FOLLOW | SDT_FOLLOW_IF_PRESENT | SDT_MANUAL | SDT_NONE,
                      RepInterval: 'NUMBER_VALUE',
                      ServiceName: 'STRING_VALUE',
                      ServiceProviderName: 'STRING_VALUE'
                    },
                    DvbSubPids: 'STRING_VALUE',
                    DvbTdtSettings: {
                      RepInterval: 'NUMBER_VALUE'
                    },
                    DvbTeletextPid: 'STRING_VALUE',
                    Ebif: NONE | PASSTHROUGH,
                    EbpAudioInterval: VIDEO_AND_FIXED_INTERVALS | VIDEO_INTERVAL,
                    EbpLookaheadMs: 'NUMBER_VALUE',
                    EbpPlacement: VIDEO_AND_AUDIO_PIDS | VIDEO_PID,
                    EcmPid: 'STRING_VALUE',
                    EsRateInPes: EXCLUDE | INCLUDE,
                    EtvPlatformPid: 'STRING_VALUE',
                    EtvSignalPid: 'STRING_VALUE',
                    FragmentTime: 'NUMBER_VALUE',
                    Klv: NONE | PASSTHROUGH,
                    KlvDataPids: 'STRING_VALUE',
                    NullPacketBitrate: 'NUMBER_VALUE',
                    PatInterval: 'NUMBER_VALUE',
                    PcrControl: CONFIGURED_PCR_PERIOD | PCR_EVERY_PES_PACKET,
                    PcrPeriod: 'NUMBER_VALUE',
                    PcrPid: 'STRING_VALUE',
                    PmtInterval: 'NUMBER_VALUE',
                    PmtPid: 'STRING_VALUE',
                    ProgramNum: 'NUMBER_VALUE',
                    RateMode: CBR | VBR,
                    Scte27Pids: 'STRING_VALUE',
                    Scte35Control: NONE | PASSTHROUGH,
                    Scte35Pid: 'STRING_VALUE',
                    SegmentationMarkers: EBP | EBP_LEGACY | NONE | PSI_SEGSTART | RAI_ADAPT | RAI_SEGSTART,
                    SegmentationStyle: MAINTAIN_CADENCE | RESET_CADENCE,
                    SegmentationTime: 'NUMBER_VALUE',
                    TimedMetadataBehavior: NO_PASSTHROUGH | PASSTHROUGH,
                    TimedMetadataPid: 'STRING_VALUE',
                    TransportStreamId: 'NUMBER_VALUE',
                    VideoPid: 'STRING_VALUE'
                  }
                },
                Extension: 'STRING_VALUE',
                NameModifier: 'STRING_VALUE'
              },
              FrameCaptureOutputSettings: {
                NameModifier: 'STRING_VALUE'
              },
              HlsOutputSettings: {
                HlsSettings: { /* required */
                  AudioOnlyHlsSettings: {
                    AudioGroupId: 'STRING_VALUE',
                    AudioOnlyImage: {
                      Uri: 'STRING_VALUE', /* required */
                      PasswordParam: 'STRING_VALUE',
                      Username: 'STRING_VALUE'
                    },
                    AudioTrackType: ALTERNATE_AUDIO_AUTO_SELECT | ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT | ALTERNATE_AUDIO_NOT_AUTO_SELECT | AUDIO_ONLY_VARIANT_STREAM
                  },
                  StandardHlsSettings: {
                    M3u8Settings: { /* required */
                      AudioFramesPerPes: 'NUMBER_VALUE',
                      AudioPids: 'STRING_VALUE',
                      EcmPid: 'STRING_VALUE',
                      PatInterval: 'NUMBER_VALUE',
                      PcrControl: CONFIGURED_PCR_PERIOD | PCR_EVERY_PES_PACKET,
                      PcrPeriod: 'NUMBER_VALUE',
                      PcrPid: 'STRING_VALUE',
                      PmtInterval: 'NUMBER_VALUE',
                      PmtPid: 'STRING_VALUE',
                      ProgramNum: 'NUMBER_VALUE',
                      Scte35Behavior: NO_PASSTHROUGH | PASSTHROUGH,
                      Scte35Pid: 'STRING_VALUE',
                      TimedMetadataBehavior: NO_PASSTHROUGH | PASSTHROUGH,
                      TimedMetadataPid: 'STRING_VALUE',
                      TransportStreamId: 'NUMBER_VALUE',
                      VideoPid: 'STRING_VALUE'
                    },
                    AudioRenditionSets: 'STRING_VALUE'
                  }
                },
                NameModifier: 'STRING_VALUE',
                SegmentModifier: 'STRING_VALUE'
              },
              MediaPackageOutputSettings: {
              },
              MsSmoothOutputSettings: {
                NameModifier: 'STRING_VALUE'
              },
              RtmpOutputSettings: {
                Destination: { /* required */
                  DestinationRefId: 'STRING_VALUE'
                },
                CertificateMode: SELF_SIGNED | VERIFY_AUTHENTICITY,
                ConnectionRetryInterval: 'NUMBER_VALUE',
                NumRetries: 'NUMBER_VALUE'
              },
              UdpOutputSettings: {
                ContainerSettings: { /* required */
                  M2tsSettings: {
                    AbsentInputAudioBehavior: DROP | ENCODE_SILENCE,
                    Arib: DISABLED | ENABLED,
                    AribCaptionsPid: 'STRING_VALUE',
                    AribCaptionsPidControl: AUTO | USE_CONFIGURED,
                    AudioBufferModel: ATSC | DVB,
                    AudioFramesPerPes: 'NUMBER_VALUE',
                    AudioPids: 'STRING_VALUE',
                    AudioStreamType: ATSC | DVB,
                    Bitrate: 'NUMBER_VALUE',
                    BufferModel: MULTIPLEX | NONE,
                    CcDescriptor: DISABLED | ENABLED,
                    DvbNitSettings: {
                      NetworkId: 'NUMBER_VALUE', /* required */
                      NetworkName: 'STRING_VALUE', /* required */
                      RepInterval: 'NUMBER_VALUE'
                    },
                    DvbSdtSettings: {
                      OutputSdt: SDT_FOLLOW | SDT_FOLLOW_IF_PRESENT | SDT_MANUAL | SDT_NONE,
                      RepInterval: 'NUMBER_VALUE',
                      ServiceName: 'STRING_VALUE',
                      ServiceProviderName: 'STRING_VALUE'
                    },
                    DvbSubPids: 'STRING_VALUE',
                    DvbTdtSettings: {
                      RepInterval: 'NUMBER_VALUE'
                    },
                    DvbTeletextPid: 'STRING_VALUE',
                    Ebif: NONE | PASSTHROUGH,
                    EbpAudioInterval: VIDEO_AND_FIXED_INTERVALS | VIDEO_INTERVAL,
                    EbpLookaheadMs: 'NUMBER_VALUE',
                    EbpPlacement: VIDEO_AND_AUDIO_PIDS | VIDEO_PID,
                    EcmPid: 'STRING_VALUE',
                    EsRateInPes: EXCLUDE | INCLUDE,
                    EtvPlatformPid: 'STRING_VALUE',
                    EtvSignalPid: 'STRING_VALUE',
                    FragmentTime: 'NUMBER_VALUE',
                    Klv: NONE | PASSTHROUGH,
                    KlvDataPids: 'STRING_VALUE',
                    NullPacketBitrate: 'NUMBER_VALUE',
                    PatInterval: 'NUMBER_VALUE',
                    PcrControl: CONFIGURED_PCR_PERIOD | PCR_EVERY_PES_PACKET,
                    PcrPeriod: 'NUMBER_VALUE',
                    PcrPid: 'STRING_VALUE',
                    PmtInterval: 'NUMBER_VALUE',
                    PmtPid: 'STRING_VALUE',
                    ProgramNum: 'NUMBER_VALUE',
                    RateMode: CBR | VBR,
                    Scte27Pids: 'STRING_VALUE',
                    Scte35Control: NONE | PASSTHROUGH,
                    Scte35Pid: 'STRING_VALUE',
                    SegmentationMarkers: EBP | EBP_LEGACY | NONE | PSI_SEGSTART | RAI_ADAPT | RAI_SEGSTART,
                    SegmentationStyle: MAINTAIN_CADENCE | RESET_CADENCE,
                    SegmentationTime: 'NUMBER_VALUE',
                    TimedMetadataBehavior: NO_PASSTHROUGH | PASSTHROUGH,
                    TimedMetadataPid: 'STRING_VALUE',
                    TransportStreamId: 'NUMBER_VALUE',
                    VideoPid: 'STRING_VALUE'
                  }
                },
                Destination: { /* required */
                  DestinationRefId: 'STRING_VALUE'
                },
                BufferMsec: 'NUMBER_VALUE',
                FecOutputSettings: {
                  ColumnDepth: 'NUMBER_VALUE',
                  IncludeFec: COLUMN | COLUMN_AND_ROW,
                  RowLength: 'NUMBER_VALUE'
                }
              }
            },
            AudioDescriptionNames: [
              'STRING_VALUE',
              /* more items */
            ],
            CaptionDescriptionNames: [
              'STRING_VALUE',
              /* more items */
            ],
            OutputName: 'STRING_VALUE',
            VideoDescriptionName: 'STRING_VALUE'
          },
          /* more items */
        ],
        Name: 'STRING_VALUE'
      },
      /* more items */
    ],
    TimecodeConfig: { /* required */
      Source: EMBEDDED | SYSTEMCLOCK | ZEROBASED, /* required */
      SyncThreshold: 'NUMBER_VALUE'
    },
    VideoDescriptions: [ /* required */
      {
        Name: 'STRING_VALUE', /* required */
        CodecSettings: {
          FrameCaptureSettings: {
            CaptureInterval: 'NUMBER_VALUE' /* required */
          },
          H264Settings: {
            AdaptiveQuantization: HIGH | HIGHER | LOW | MAX | MEDIUM | OFF,
            AfdSignaling: AUTO | FIXED | NONE,
            Bitrate: 'NUMBER_VALUE',
            BufFillPct: 'NUMBER_VALUE',
            BufSize: 'NUMBER_VALUE',
            ColorMetadata: IGNORE | INSERT,
            EntropyEncoding: CABAC | CAVLC,
            FixedAfd: AFD_0000 | AFD_0010 | AFD_0011 | AFD_0100 | AFD_1000 | AFD_1001 | AFD_1010 | AFD_1011 | AFD_1101 | AFD_1110 | AFD_1111,
            FlickerAq: DISABLED | ENABLED,
            FramerateControl: INITIALIZE_FROM_SOURCE | SPECIFIED,
            FramerateDenominator: 'NUMBER_VALUE',
            FramerateNumerator: 'NUMBER_VALUE',
            GopBReference: DISABLED | ENABLED,
            GopClosedCadence: 'NUMBER_VALUE',
            GopNumBFrames: 'NUMBER_VALUE',
            GopSize: 'NUMBER_VALUE',
            GopSizeUnits: FRAMES | SECONDS,
            Level: H264_LEVEL_1 | H264_LEVEL_1_1 | H264_LEVEL_1_2 | H264_LEVEL_1_3 | H264_LEVEL_2 | H264_LEVEL_2_1 | H264_LEVEL_2_2 | H264_LEVEL_3 | H264_LEVEL_3_1 | H264_LEVEL_3_2 | H264_LEVEL_4 | H264_LEVEL_4_1 | H264_LEVEL_4_2 | H264_LEVEL_5 | H264_LEVEL_5_1 | H264_LEVEL_5_2 | H264_LEVEL_AUTO,
            LookAheadRateControl: HIGH | LOW | MEDIUM,
            MaxBitrate: 'NUMBER_VALUE',
            MinIInterval: 'NUMBER_VALUE',
            NumRefFrames: 'NUMBER_VALUE',
            ParControl: INITIALIZE_FROM_SOURCE | SPECIFIED,
            ParDenominator: 'NUMBER_VALUE',
            ParNumerator: 'NUMBER_VALUE',
            Profile: BASELINE | HIGH | HIGH_10BIT | HIGH_422 | HIGH_422_10BIT | MAIN,
            QvbrQualityLevel: 'NUMBER_VALUE',
            RateControlMode: CBR | QVBR | VBR,
            ScanType: INTERLACED | PROGRESSIVE,
            SceneChangeDetect: DISABLED | ENABLED,
            Slices: 'NUMBER_VALUE',
            Softness: 'NUMBER_VALUE',
            SpatialAq: DISABLED | ENABLED,
            SubgopLength: DYNAMIC | FIXED,
            Syntax: DEFAULT | RP2027,
            TemporalAq: DISABLED | ENABLED,
            TimecodeInsertion: DISABLED | PIC_TIMING_SEI
          }
        },
        Height: 'NUMBER_VALUE',
        RespondToAfd: NONE | PASSTHROUGH | RESPOND,
        ScalingBehavior: DEFAULT | STRETCH_TO_OUTPUT,
        Sharpness: 'NUMBER_VALUE',
        Width: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    AvailBlanking: {
      AvailBlankingImage: {
        Uri: 'STRING_VALUE', /* required */
        PasswordParam: 'STRING_VALUE',
        Username: 'STRING_VALUE'
      },
      State: DISABLED | ENABLED
    },
    AvailConfiguration: {
      AvailSettings: {
        Scte35SpliceInsert: {
          AdAvailOffset: 'NUMBER_VALUE',
          NoRegionalBlackoutFlag: FOLLOW | IGNORE,
          WebDeliveryAllowedFlag: FOLLOW | IGNORE
        },
        Scte35TimeSignalApos: {
          AdAvailOffset: 'NUMBER_VALUE',
          NoRegionalBlackoutFlag: FOLLOW | IGNORE,
          WebDeliveryAllowedFlag: FOLLOW | IGNORE
        }
      }
    },
    BlackoutSlate: {
      BlackoutSlateImage: {
        Uri: 'STRING_VALUE', /* required */
        PasswordParam: 'STRING_VALUE',
        Username: 'STRING_VALUE'
      },
      NetworkEndBlackout: DISABLED | ENABLED,
      NetworkEndBlackoutImage: {
        Uri: 'STRING_VALUE', /* required */
        PasswordParam: 'STRING_VALUE',
        Username: 'STRING_VALUE'
      },
      NetworkId: 'STRING_VALUE',
      State: DISABLED | ENABLED
    },
    CaptionDescriptions: [
      {
        CaptionSelectorName: 'STRING_VALUE', /* required */
        Name: 'STRING_VALUE', /* required */
        DestinationSettings: {
          AribDestinationSettings: {
          },
          BurnInDestinationSettings: {
            Alignment: CENTERED | LEFT | SMART,
            BackgroundColor: BLACK | NONE | WHITE,
            BackgroundOpacity: 'NUMBER_VALUE',
            Font: {
              Uri: 'STRING_VALUE', /* required */
              PasswordParam: 'STRING_VALUE',
              Username: 'STRING_VALUE'
            },
            FontColor: BLACK | BLUE | GREEN | RED | WHITE | YELLOW,
            FontOpacity: 'NUMBER_VALUE',
            FontResolution: 'NUMBER_VALUE',
            FontSize: 'STRING_VALUE',
            OutlineColor: BLACK | BLUE | GREEN | RED | WHITE | YELLOW,
            OutlineSize: 'NUMBER_VALUE',
            ShadowColor: BLACK | NONE | WHITE,
            ShadowOpacity: 'NUMBER_VALUE',
            ShadowXOffset: 'NUMBER_VALUE',
            ShadowYOffset: 'NUMBER_VALUE',
            TeletextGridControl: FIXED | SCALED,
            XPosition: 'NUMBER_VALUE',
            YPosition: 'NUMBER_VALUE'
          },
          DvbSubDestinationSettings: {
            Alignment: CENTERED | LEFT | SMART,
            BackgroundColor: BLACK | NONE | WHITE,
            BackgroundOpacity: 'NUMBER_VALUE',
            Font: {
              Uri: 'STRING_VALUE', /* required */
              PasswordParam: 'STRING_VALUE',
              Username: 'STRING_VALUE'
            },
            FontColor: BLACK | BLUE | GREEN | RED | WHITE | YELLOW,
            FontOpacity: 'NUMBER_VALUE',
            FontResolution: 'NUMBER_VALUE',
            FontSize: 'STRING_VALUE',
            OutlineColor: BLACK | BLUE | GREEN | RED | WHITE | YELLOW,
            OutlineSize: 'NUMBER_VALUE',
            ShadowColor: BLACK | NONE | WHITE,
            ShadowOpacity: 'NUMBER_VALUE',
            ShadowXOffset: 'NUMBER_VALUE',
            ShadowYOffset: 'NUMBER_VALUE',
            TeletextGridControl: FIXED | SCALED,
            XPosition: 'NUMBER_VALUE',
            YPosition: 'NUMBER_VALUE'
          },
          EmbeddedDestinationSettings: {
          },
          EmbeddedPlusScte20DestinationSettings: {
          },
          RtmpCaptionInfoDestinationSettings: {
          },
          Scte20PlusEmbeddedDestinationSettings: {
          },
          Scte27DestinationSettings: {
          },
          SmpteTtDestinationSettings: {
          },
          TeletextDestinationSettings: {
          },
          TtmlDestinationSettings: {
            StyleControl: PASSTHROUGH | USE_CONFIGURED
          },
          WebvttDestinationSettings: {
          }
        },
        LanguageCode: 'STRING_VALUE',
        LanguageDescription: 'STRING_VALUE'
      },
      /* more items */
    ],
    GlobalConfiguration: {
      InitialAudioGain: 'NUMBER_VALUE',
      InputEndAction: NONE | SWITCH_AND_LOOP_INPUTS,
      InputLossBehavior: {
        BlackFrameMsec: 'NUMBER_VALUE',
        InputLossImageColor: 'STRING_VALUE',
        InputLossImageSlate: {
          Uri: 'STRING_VALUE', /* required */
          PasswordParam: 'STRING_VALUE',
          Username: 'STRING_VALUE'
        },
        InputLossImageType: COLOR | SLATE,
        RepeatFrameMsec: 'NUMBER_VALUE'
      },
      OutputLockingMode: EPOCH_LOCKING | PIPELINE_LOCKING,
      OutputTimingSource: INPUT_CLOCK | SYSTEM_CLOCK,
      SupportLowFramerateInputs: DISABLED | ENABLED
    }
  },
  InputAttachments: [
    {
      InputAttachmentName: 'STRING_VALUE',
      InputId: 'STRING_VALUE',
      InputSettings: {
        AudioSelectors: [
          {
            Name: 'STRING_VALUE', /* required */
            SelectorSettings: {
              AudioLanguageSelection: {
                LanguageCode: 'STRING_VALUE', /* required */
                LanguageSelectionPolicy: LOOSE | STRICT
              },
              AudioPidSelection: {
                Pid: 'NUMBER_VALUE' /* required */
              }
            }
          },
          /* more items */
        ],
        CaptionSelectors: [
          {
            Name: 'STRING_VALUE', /* required */
            LanguageCode: 'STRING_VALUE',
            SelectorSettings: {
              AribSourceSettings: {
              },
              DvbSubSourceSettings: {
                Pid: 'NUMBER_VALUE'
              },
              EmbeddedSourceSettings: {
                Convert608To708: DISABLED | UPCONVERT,
                Scte20Detection: AUTO | OFF,
                Source608ChannelNumber: 'NUMBER_VALUE',
                Source608TrackNumber: 'NUMBER_VALUE'
              },
              Scte20SourceSettings: {
                Convert608To708: DISABLED | UPCONVERT,
                Source608ChannelNumber: 'NUMBER_VALUE'
              },
              Scte27SourceSettings: {
                Pid: 'NUMBER_VALUE'
              },
              TeletextSourceSettings: {
                PageNumber: 'STRING_VALUE'
              }
            }
          },
          /* more items */
        ],
        DeblockFilter: DISABLED | ENABLED,
        DenoiseFilter: DISABLED | ENABLED,
        FilterStrength: 'NUMBER_VALUE',
        InputFilter: AUTO | DISABLED | FORCED,
        NetworkInputSettings: {
          HlsInputSettings: {
            Bandwidth: 'NUMBER_VALUE',
            BufferSegments: 'NUMBER_VALUE',
            Retries: 'NUMBER_VALUE',
            RetryInterval: 'NUMBER_VALUE'
          },
          ServerValidation: CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME | CHECK_CRYPTOGRAPHY_ONLY
        },
        SourceEndBehavior: CONTINUE | LOOP,
        VideoSelector: {
          ColorSpace: FOLLOW | REC_601 | REC_709,
          ColorSpaceUsage: FALLBACK | FORCE,
          SelectorSettings: {
            VideoSelectorPid: {
              Pid: 'NUMBER_VALUE'
            },
            VideoSelectorProgramId: {
              ProgramId: 'NUMBER_VALUE'
            }
          }
        }
      }
    },
    /* more items */
  ],
  InputSpecification: {
    Codec: MPEG2 | AVC | HEVC,
    MaximumBitrate: MAX_10_MBPS | MAX_20_MBPS | MAX_50_MBPS,
    Resolution: SD | HD | UHD
  },
  LogLevel: ERROR | WARNING | INFO | DEBUG | DISABLED,
  Name: 'STRING_VALUE',
  RequestId: 'STRING_VALUE',
  Reserved: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
medialive.createChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ChannelClass — (String) The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. Possible values include:
      • "STANDARD"
      • "SINGLE_PIPELINE"
    • Destinations — (Array<map>) Placeholder documentation for __listOfOutputDestination
      • Id — (String) User-specified id. This is used in an output group or an output.
      • MediaPackageSettings — (Array<map>) Destination settings for a MediaPackage output; one destination for both encoders.
        • ChannelId — (String) ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
      • Settings — (Array<map>) Destination settings for a standard output; one destination for each redundant encoder.
        • PasswordParam — (String) key used to extract the password from EC2 Parameter store
        • StreamName — (String) Stream name for RTMP destinations (URLs of type rtmp://)
        • Url — (String) A URL specifying a destination
        • Username — (String) username for destination
    • EncoderSettings — (map) Encoder Settings
      • AudioDescriptions — required — (Array<map>) Placeholder documentation for __listOfAudioDescription
        • AudioNormalizationSettings — (map) Advanced audio normalization settings.
          • Algorithm — (String) Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. Possible values include:
            • "ITU_1770_1"
            • "ITU_1770_2"
          • AlgorithmControl — (String) When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. Possible values include:
            • "CORRECT_AUDIO"
          • TargetLkfs — (Float) Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
        • AudioSelectorName — required — (String) The name of the AudioSelector used as the source for this AudioDescription.
        • AudioType — (String) Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. Possible values include:
          • "CLEAN_EFFECTS"
          • "HEARING_IMPAIRED"
          • "UNDEFINED"
          • "VISUAL_IMPAIRED_COMMENTARY"
        • AudioTypeControl — (String) Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. Possible values include:
          • "FOLLOW_INPUT"
          • "USE_CONFIGURED"
        • CodecSettings — (map) Audio codec settings.
          • AacSettings — (map) Aac Settings
            • Bitrate — (Float) Average bitrate in bits/second. Valid values depend on rate control mode and profile.
            • CodingMode — (String) Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. Possible values include:
              • "AD_RECEIVER_MIX"
              • "CODING_MODE_1_0"
              • "CODING_MODE_1_1"
              • "CODING_MODE_2_0"
              • "CODING_MODE_5_1"
            • InputType — (String) Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD. Possible values include:
              • "BROADCASTER_MIXED_AD"
              • "NORMAL"
            • Profile — (String) AAC Profile. Possible values include:
              • "HEV1"
              • "HEV2"
              • "LC"
            • RateControlMode — (String) Rate Control Mode. Possible values include:
              • "CBR"
              • "VBR"
            • RawFormat — (String) Sets LATM / LOAS AAC output for raw containers. Possible values include:
              • "LATM_LOAS"
              • "NONE"
            • SampleRate — (Float) Sample rate in Hz. Valid values depend on rate control mode and profile.
            • Spec — (String) Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. Possible values include:
              • "MPEG2"
              • "MPEG4"
            • VbrQuality — (String) VBR Quality Level - Only used if rateControlMode is VBR. Possible values include:
              • "HIGH"
              • "LOW"
              • "MEDIUM_HIGH"
              • "MEDIUM_LOW"
          • Ac3Settings — (map) Ac3 Settings
            • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
            • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. Possible values include:
              • "COMMENTARY"
              • "COMPLETE_MAIN"
              • "DIALOGUE"
              • "EMERGENCY"
              • "HEARING_IMPAIRED"
              • "MUSIC_AND_EFFECTS"
              • "VISUALLY_IMPAIRED"
              • "VOICE_OVER"
            • CodingMode — (String) Dolby Digital coding mode. Determines number of channels. Possible values include:
              • "CODING_MODE_1_0"
              • "CODING_MODE_1_1"
              • "CODING_MODE_2_0"
              • "CODING_MODE_3_2_LFE"
            • Dialnorm — (Integer) Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
            • DrcProfile — (String) If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. Possible values include:
              • "FILM_STANDARD"
              • "NONE"
            • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • MetadataControl — (String) When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
              • "FOLLOW_INPUT"
              • "USE_CONFIGURED"
          • Eac3Settings — (map) Eac3 Settings
            • AttenuationControl — (String) When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. Possible values include:
              • "ATTENUATE_3_DB"
              • "NONE"
            • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
            • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. Possible values include:
              • "COMMENTARY"
              • "COMPLETE_MAIN"
              • "EMERGENCY"
              • "HEARING_IMPAIRED"
              • "VISUALLY_IMPAIRED"
            • CodingMode — (String) Dolby Digital Plus coding mode. Determines number of channels. Possible values include:
              • "CODING_MODE_1_0"
              • "CODING_MODE_2_0"
              • "CODING_MODE_3_2"
            • DcFilter — (String) When set to enabled, activates a DC highpass filter for all input channels. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • Dialnorm — (Integer) Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
            • DrcLine — (String) Sets the Dolby dynamic range compression profile. Possible values include:
              • "FILM_LIGHT"
              • "FILM_STANDARD"
              • "MUSIC_LIGHT"
              • "MUSIC_STANDARD"
              • "NONE"
              • "SPEECH"
            • DrcRf — (String) Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. Possible values include:
              • "FILM_LIGHT"
              • "FILM_STANDARD"
              • "MUSIC_LIGHT"
              • "MUSIC_STANDARD"
              • "NONE"
              • "SPEECH"
            • LfeControl — (String) When encoding 3/2 audio, setting to lfe enables the LFE channel Possible values include:
              • "LFE"
              • "NO_LFE"
            • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • LoRoCenterMixLevel — (Float) Left only/Right only center mix level. Only used for 3/2 coding mode.
            • LoRoSurroundMixLevel — (Float) Left only/Right only surround mix level. Only used for 3/2 coding mode.
            • LtRtCenterMixLevel — (Float) Left total/Right total center mix level. Only used for 3/2 coding mode.
            • LtRtSurroundMixLevel — (Float) Left total/Right total surround mix level. Only used for 3/2 coding mode.
            • MetadataControl — (String) When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
              • "FOLLOW_INPUT"
              • "USE_CONFIGURED"
            • PassthroughControl — (String) When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding. Possible values include:
              • "NO_PASSTHROUGH"
              • "WHEN_POSSIBLE"
            • PhaseControl — (String) When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. Possible values include:
              • "NO_SHIFT"
              • "SHIFT_90_DEGREES"
            • StereoDownmix — (String) Stereo downmix preference. Only used for 3/2 coding mode. Possible values include:
              • "DPL2"
              • "LO_RO"
              • "LT_RT"
              • "NOT_INDICATED"
            • SurroundExMode — (String) When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. Possible values include:
              • "DISABLED"
              • "ENABLED"
              • "NOT_INDICATED"
            • SurroundMode — (String) When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. Possible values include:
              • "DISABLED"
              • "ENABLED"
              • "NOT_INDICATED"
          • Mp2Settings — (map) Mp2 Settings
            • Bitrate — (Float) Average bitrate in bits/second.
            • CodingMode — (String) The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). Possible values include:
              • "CODING_MODE_1_0"
              • "CODING_MODE_2_0"
            • SampleRate — (Float) Sample rate in Hz.
          • PassThroughSettings — (map) Pass Through Settings
        • LanguageCode — (String) Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
        • LanguageCodeControl — (String) Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. Possible values include:
          • "FOLLOW_INPUT"
          • "USE_CONFIGURED"
        • Name — required — (String) The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
        • RemixSettings — (map) Settings that control how input audio channels are remixed into the output audio channels.
          • ChannelMappings — required — (Array<map>) Mapping of input channels to output channels, with appropriate gain adjustments.
            • InputChannelLevels — required — (Array<map>) Indices and gain values for each input channel that should be remixed into this output channel.
              • Gain — required — (Integer) Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
              • InputChannel — required — (Integer) The index of the input channel used as a source.
            • OutputChannel — required — (Integer) The index of the output channel being produced.
          • ChannelsIn — (Integer) Number of input channels to be used.
          • ChannelsOut — (Integer) Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
        • StreamName — (String) Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
      • AvailBlanking — (map) Settings for ad avail blanking.
        • AvailBlankingImage — (map) Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
          • PasswordParam — (String) key used to extract the password from EC2 Parameter store
          • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
          • Username — (String) Documentation update needed
        • State — (String) When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added. Possible values include:
          • "DISABLED"
          • "ENABLED"
      • AvailConfiguration — (map) Event-wide configuration settings for ad avail insertion.
        • AvailSettings — (map) Ad avail settings.
          • Scte35SpliceInsert — (map) Scte35 Splice Insert
            • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
            • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
              • "FOLLOW"
              • "IGNORE"
            • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
              • "FOLLOW"
              • "IGNORE"
          • Scte35TimeSignalApos — (map) Scte35 Time Signal Apos
            • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
            • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
              • "FOLLOW"
              • "IGNORE"
            • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
              • "FOLLOW"
              • "IGNORE"
      • BlackoutSlate — (map) Settings for blackout slate.
        • BlackoutSlateImage — (map) Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
          • PasswordParam — (String) key used to extract the password from EC2 Parameter store
          • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
          • Username — (String) Documentation update needed
        • NetworkEndBlackout — (String) Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". Possible values include:
          • "DISABLED"
          • "ENABLED"
        • NetworkEndBlackoutImage — (map) Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
          • PasswordParam — (String) key used to extract the password from EC2 Parameter store
          • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
          • Username — (String) Documentation update needed
        • NetworkId — (String) Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
        • State — (String) When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata. Possible values include:
          • "DISABLED"
          • "ENABLED"
      • CaptionDescriptions — (Array<map>) Settings for caption decriptions
        • CaptionSelectorName — required — (String) Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
        • DestinationSettings — (map) Additional settings for captions destination that depend on the destination type.
          • AribDestinationSettings — (map) Arib Destination Settings
          • BurnInDestinationSettings — (map) Burn In Destination Settings
            • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "CENTERED"
              • "LEFT"
              • "SMART"
            • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "NONE"
              • "WHITE"
            • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
            • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "BLUE"
              • "GREEN"
              • "RED"
              • "WHITE"
              • "YELLOW"
            • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
            • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
            • FontSize — (String) When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
            • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "BLUE"
              • "GREEN"
              • "RED"
              • "WHITE"
              • "YELLOW"
            • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
            • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "NONE"
              • "WHITE"
            • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
            • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
            • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
            • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
              • "FIXED"
              • "SCALED"
            • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
            • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
          • DvbSubDestinationSettings — (map) Dvb Sub Destination Settings
            • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "CENTERED"
              • "LEFT"
              • "SMART"
            • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "NONE"
              • "WHITE"
            • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
            • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "BLUE"
              • "GREEN"
              • "RED"
              • "WHITE"
              • "YELLOW"
            • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
            • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
            • FontSize — (String) When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
            • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "BLUE"
              • "GREEN"
              • "RED"
              • "WHITE"
              • "YELLOW"
            • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
            • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "NONE"
              • "WHITE"
            • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
            • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
            • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
            • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
              • "FIXED"
              • "SCALED"
            • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
            • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
          • EmbeddedDestinationSettings — (map) Embedded Destination Settings
          • EmbeddedPlusScte20DestinationSettings — (map) Embedded Plus Scte20 Destination Settings
          • RtmpCaptionInfoDestinationSettings — (map) Rtmp Caption Info Destination Settings
          • Scte20PlusEmbeddedDestinationSettings — (map) Scte20 Plus Embedded Destination Settings
          • Scte27DestinationSettings — (map) Scte27 Destination Settings
          • SmpteTtDestinationSettings — (map) Smpte Tt Destination Settings
          • TeletextDestinationSettings — (map) Teletext Destination Settings
          • TtmlDestinationSettings — (map) Ttml Destination Settings
            • StyleControl — (String) When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. Possible values include:
              • "PASSTHROUGH"
              • "USE_CONFIGURED"
          • WebvttDestinationSettings — (map) Webvtt Destination Settings
        • LanguageCode — (String) ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
        • LanguageDescription — (String) Human readable information to indicate captions available for players (eg. English, or Spanish).
        • Name — required — (String) Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
      • GlobalConfiguration — (map) Configuration settings that apply to the event as a whole.
        • InitialAudioGain — (Integer) Value to set the initial audio gain for the Live Event.
        • InputEndAction — (String) Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). Possible values include:
          • "NONE"
          • "SWITCH_AND_LOOP_INPUTS"
        • InputLossBehavior — (map) Settings for system actions when input is lost.
          • BlackFrameMsec — (Integer) Documentation update needed
          • InputLossImageColor — (String) When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
          • InputLossImageSlate — (map) When input loss image type is "slate" these fields specify the parameters for accessing the slate.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
            • Username — (String) Documentation update needed
          • InputLossImageType — (String) Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. Possible values include:
            • "COLOR"
            • "SLATE"
          • RepeatFrameMsec — (Integer) Documentation update needed
        • OutputLockingMode — (String) Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. Possible values include:
          • "EPOCH_LOCKING"
          • "PIPELINE_LOCKING"
        • OutputTimingSource — (String) Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. Possible values include:
          • "INPUT_CLOCK"
          • "SYSTEM_CLOCK"
        • SupportLowFramerateInputs — (String) Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. Possible values include:
          • "DISABLED"
          • "ENABLED"
      • OutputGroups — required — (Array<map>) Placeholder documentation for __listOfOutputGroup
        • Name — (String) Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
        • OutputGroupSettings — required — (map) Settings associated with the output group.
          • ArchiveGroupSettings — (map) Archive Group Settings
            • Destination — required — (map) A directory and base filename where archive files should be written.
              • DestinationRefId — (String) Placeholder documentation for __string
            • RolloverInterval — (Integer) Number of seconds to write to archive file before closing and starting a new one.
          • FrameCaptureGroupSettings — (map) Frame Capture Group Settings
            • Destination — required — (map) The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
              • DestinationRefId — (String) Placeholder documentation for __string
          • HlsGroupSettings — (map) Hls Group Settings
            • AdMarkers — (Array<String>) Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
            • BaseUrlContent — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
            • BaseUrlManifest — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
            • CaptionLanguageMappings — (Array<map>) Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
              • CaptionChannel — required — (Integer) The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
              • LanguageCode — required — (String) Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
              • LanguageDescription — required — (String) Textual description of language
            • CaptionLanguageSetting — (String) Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest. Possible values include:
              • "INSERT"
              • "NONE"
              • "OMIT"
            • ClientCache — (String) When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • CodecSpecification — (String) Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. Possible values include:
              • "RFC_4281"
              • "RFC_6381"
            • ConstantIv — (String) For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
            • Destination — required — (map) A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
              • DestinationRefId — (String) Placeholder documentation for __string
            • DirectoryStructure — (String) Place segments in subdirectories. Possible values include:
              • "SINGLE_DIRECTORY"
              • "SUBDIRECTORY_PER_STREAM"
            • EncryptionType — (String) Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. Possible values include:
              • "AES128"
              • "SAMPLE_AES"
            • HlsCdnSettings — (map) Parameters that control interactions with the CDN.
              • HlsAkamaiSettings — (map) Hls Akamai Settings
                • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. Possible values include:
                  • "CHUNKED"
                  • "NON_CHUNKED"
                • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                • Salt — (String) Salt for authenticated Akamai.
                • Token — (String) Token parameter for authenticated akamai. If not specified, gda is used.
              • HlsBasicPutSettings — (map) Hls Basic Put Settings
                • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
              • HlsMediaStoreSettings — (map) Hls Media Store Settings
                • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                • MediaStoreStorageClass — (String) When set to temporal, output files are stored in non-persistent memory for faster reading and writing. Possible values include:
                  • "TEMPORAL"
                • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
              • HlsWebdavSettings — (map) Hls Webdav Settings
                • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to WebDAV. Possible values include:
                  • "CHUNKED"
                  • "NON_CHUNKED"
                • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
            • IFrameOnlyPlaylists — (String) DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888" Possible values include:
              • "DISABLED"
              • "STANDARD"
            • IndexNSegments — (Integer) Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
            • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
              • "EMIT_OUTPUT"
              • "PAUSE_OUTPUT"
            • IvInManifest — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. Possible values include:
              • "EXCLUDE"
              • "INCLUDE"
            • IvSource — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. Possible values include:
              • "EXPLICIT"
              • "FOLLOWS_SEGMENT_NUMBER"
            • KeepSegments — (Integer) Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
            • KeyFormat — (String) The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
            • KeyFormatVersions — (String) Either a single positive integer version value or a slash delimited list of version values (1/2/3).
            • KeyProviderSettings — (map) The key provider settings.
              • StaticKeySettings — (map) Static Key Settings
                • KeyProviderServer — (map) The URL of the license server used for protecting content.
                  • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                  • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                  • Username — (String) Documentation update needed
                • StaticKeyValue — required — (String) Static key value as a 32 character hexadecimal string.
            • ManifestCompression — (String) When set to gzip, compresses HLS playlist. Possible values include:
              • "GZIP"
              • "NONE"
            • ManifestDurationFormat — (String) Indicates whether the output manifest should use floating point or integer values for segment duration. Possible values include:
              • "FLOATING_POINT"
              • "INTEGER"
            • MinSegmentLength — (Integer) When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
            • Mode — (String) If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. Possible values include:
              • "LIVE"
              • "VOD"
            • OutputSelection — (String) MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group. Possible values include:
              • "MANIFESTS_AND_SEGMENTS"
              • "SEGMENTS_ONLY"
            • ProgramDateTime — (String) Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset. Possible values include:
              • "EXCLUDE"
              • "INCLUDE"
            • ProgramDateTimePeriod — (Integer) Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
            • RedundantManifest — (String) ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • SegmentLength — (Integer) Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
            • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
              • "USE_INPUT_SEGMENTATION"
              • "USE_SEGMENT_DURATION"
            • SegmentsPerSubdirectory — (Integer) Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
            • StreamInfResolution — (String) Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. Possible values include:
              • "EXCLUDE"
              • "INCLUDE"
            • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
              • "NONE"
              • "PRIV"
              • "TDRL"
            • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
            • TimestampDeltaMilliseconds — (Integer) Provides an extra millisecond delta offset to fine tune the timestamps.
            • TsFileMode — (String) SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching. Possible values include:
              • "SEGMENTED_FILES"
              • "SINGLE_FILE"
          • MediaPackageGroupSettings — (map) Media Package Group Settings
            • Destination — required — (map) MediaPackage channel destination.
              • DestinationRefId — (String) Placeholder documentation for __string
          • MsSmoothGroupSettings — (map) Ms Smooth Group Settings
            • AcquisitionPointId — (String) The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
            • AudioOnlyTimecodeControl — (String) If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. Possible values include:
              • "PASSTHROUGH"
              • "USE_CONFIGURED_CLOCK"
            • CertificateMode — (String) If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. Possible values include:
              • "SELF_SIGNED"
              • "VERIFY_AUTHENTICITY"
            • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
            • Destination — required — (map) Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
              • DestinationRefId — (String) Placeholder documentation for __string
            • EventId — (String) MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
            • EventIdMode — (String) Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server. Possible values include:
              • "NO_EVENT_ID"
              • "USE_CONFIGURED"
              • "USE_TIMESTAMP"
            • EventStopBehavior — (String) When set to sendEos, send EOS signal to IIS server when stopping the event Possible values include:
              • "NONE"
              • "SEND_EOS"
            • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
            • FragmentLength — (Integer) Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
            • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
              • "EMIT_OUTPUT"
              • "PAUSE_OUTPUT"
            • NumRetries — (Integer) Number of retry attempts.
            • RestartDelay — (Integer) Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
            • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
              • "USE_INPUT_SEGMENTATION"
              • "USE_SEGMENT_DURATION"
            • SendDelayMs — (Integer) Number of milliseconds to delay the output from the second pipeline.
            • SparseTrackType — (String) If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs. Possible values include:
              • "NONE"
              • "SCTE_35"
            • StreamManifestBehavior — (String) When set to send, send stream manifest so publishing point doesn't start until all streams start. Possible values include:
              • "DO_NOT_SEND"
              • "SEND"
            • TimestampOffset — (String) Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
            • TimestampOffsetMode — (String) Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset Possible values include:
              • "USE_CONFIGURED_OFFSET"
              • "USE_EVENT_START_DATE"
          • RtmpGroupSettings — (map) Rtmp Group Settings
            • AuthenticationScheme — (String) Authentication scheme to use when connecting with CDN Possible values include:
              • "AKAMAI"
              • "COMMON"
            • CacheFullBehavior — (String) Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. Possible values include:
              • "DISCONNECT_IMMEDIATELY"
              • "WAIT_FOR_SERVER"
            • CacheLength — (Integer) Cache length, in seconds, is used to calculate buffer size.
            • CaptionData — (String) Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. Possible values include:
              • "ALL"
              • "FIELD1_608"
              • "FIELD1_AND_FIELD2_608"
            • InputLossAction — (String) Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. Possible values include:
              • "EMIT_OUTPUT"
              • "PAUSE_OUTPUT"
            • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
          • UdpGroupSettings — (map) Udp Group Settings
            • InputLossAction — (String) Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. Possible values include:
              • "DROP_PROGRAM"
              • "DROP_TS"
              • "EMIT_PROGRAM"
            • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
              • "NONE"
              • "PRIV"
              • "TDRL"
            • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
        • Outputs — required — (Array<map>) Placeholder documentation for __listOfOutput
          • AudioDescriptionNames — (Array<String>) The names of the AudioDescriptions used as audio sources for this output.
          • CaptionDescriptionNames — (Array<String>) The names of the CaptionDescriptions used as caption sources for this output.
          • OutputName — (String) The name used to identify an output.
          • OutputSettings — required — (map) Output type-specific settings.
            • ArchiveOutputSettings — (map) Archive Output Settings
              • ContainerSettings — required — (map) Settings specific to the container type of the file.
                • M2tsSettings — (map) M2ts Settings
                  • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                    • "DROP"
                    • "ENCODE_SILENCE"
                  • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                    • "DISABLED"
                    • "ENABLED"
                  • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                    • "AUTO"
                    • "USE_CONFIGURED"
                  • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                    • "ATSC"
                    • "DVB"
                  • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                  • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                    • "ATSC"
                    • "DVB"
                  • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                  • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                    • "MULTIPLEX"
                    • "NONE"
                  • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                    • "DISABLED"
                    • "ENABLED"
                  • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                    • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                    • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                    • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                  • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                    • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                      • "SDT_FOLLOW"
                      • "SDT_FOLLOW_IF_PRESENT"
                      • "SDT_MANUAL"
                      • "SDT_NONE"
                    • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                    • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                  • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                    • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                  • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                    • "NONE"
                    • "PASSTHROUGH"
                  • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                    • "VIDEO_AND_FIXED_INTERVALS"
                    • "VIDEO_INTERVAL"
                  • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                  • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                    • "VIDEO_AND_AUDIO_PIDS"
                    • "VIDEO_PID"
                  • EcmPid — (String) This field is unused and deprecated.
                  • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                    • "EXCLUDE"
                    • "INCLUDE"
                  • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                  • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                    • "NONE"
                    • "PASSTHROUGH"
                  • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                  • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                  • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                    • "CONFIGURED_PCR_PERIOD"
                    • "PCR_EVERY_PES_PACKET"
                  • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                  • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                  • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                  • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                    • "CBR"
                    • "VBR"
                  • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                    • "NONE"
                    • "PASSTHROUGH"
                  • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                    • "EBP"
                    • "EBP_LEGACY"
                    • "NONE"
                    • "PSI_SEGSTART"
                    • "RAI_ADAPT"
                    • "RAI_SEGSTART"
                  • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                    • "MAINTAIN_CADENCE"
                    • "RESET_CADENCE"
                  • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                  • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                    • "NO_PASSTHROUGH"
                    • "PASSTHROUGH"
                  • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                  • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
              • Extension — (String) Output file extension. If excluded, this will be auto-selected from the container type.
              • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
            • FrameCaptureOutputSettings — (map) Frame Capture Output Settings
              • NameModifier — (String) Required if the output group contains more than one output. This modifier forms part of the output file name.
            • HlsOutputSettings — (map) Hls Output Settings
              • HlsSettings — required — (map) Settings regarding the underlying stream. These settings are different for audio-only outputs.
                • AudioOnlyHlsSettings — (map) Audio Only Hls Settings
                  • AudioGroupId — (String) Specifies the group to which the audio Rendition belongs.
                  • AudioOnlyImage — (map) For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by file size * count * count..
                    • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                    • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                    • Username — (String) Documentation update needed
                  • AudioTrackType — (String) Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO Possible values include:
                    • "ALTERNATE_AUDIO_AUTO_SELECT"
                    • "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT"
                    • "ALTERNATE_AUDIO_NOT_AUTO_SELECT"
                    • "AUDIO_ONLY_VARIANT_STREAM"
                • StandardHlsSettings — (map) Standard Hls Settings
                  • AudioRenditionSets — (String) List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
                  • M3u8Settings — required — (map) Settings information for the .m3u8 container
                    • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                    • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
                    • EcmPid — (String) This parameter is unused and deprecated.
                    • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                    • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                      • "CONFIGURED_PCR_PERIOD"
                      • "PCR_EVERY_PES_PACKET"
                    • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
                    • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
                    • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                    • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
                    • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                    • Scte35Behavior — (String) If set to passthrough, passes any SCTE-35 signals from the input source to this output. Possible values include:
                      • "NO_PASSTHROUGH"
                      • "PASSTHROUGH"
                    • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
                    • TimedMetadataBehavior — (String) When set to passthrough, timed metadata is passed through from input to output. Possible values include:
                      • "NO_PASSTHROUGH"
                      • "PASSTHROUGH"
                    • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                    • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
              • NameModifier — (String) String concatenated to the end of the destination filename. Accepts \"Format Identifiers\":#formatIdentifierParameters.
              • SegmentModifier — (String) String concatenated to end of segment filenames.
            • MediaPackageOutputSettings — (map) Media Package Output Settings
            • MsSmoothOutputSettings — (map) Ms Smooth Output Settings
              • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
            • RtmpOutputSettings — (map) Rtmp Output Settings
              • CertificateMode — (String) If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. Possible values include:
                • "SELF_SIGNED"
                • "VERIFY_AUTHENTICITY"
              • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
              • Destination — required — (map) The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
                • DestinationRefId — (String) Placeholder documentation for __string
              • NumRetries — (Integer) Number of retry attempts.
            • UdpOutputSettings — (map) Udp Output Settings
              • BufferMsec — (Integer) UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
              • ContainerSettings — required — (map) Udp Container Settings
                • M2tsSettings — (map) M2ts Settings
                  • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                    • "DROP"
                    • "ENCODE_SILENCE"
                  • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                    • "DISABLED"
                    • "ENABLED"
                  • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                    • "AUTO"
                    • "USE_CONFIGURED"
                  • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                    • "ATSC"
                    • "DVB"
                  • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                  • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                    • "ATSC"
                    • "DVB"
                  • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                  • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                    • "MULTIPLEX"
                    • "NONE"
                  • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                    • "DISABLED"
                    • "ENABLED"
                  • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                    • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                    • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                    • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                  • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                    • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                      • "SDT_FOLLOW"
                      • "SDT_FOLLOW_IF_PRESENT"
                      • "SDT_MANUAL"
                      • "SDT_NONE"
                    • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                    • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                  • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                    • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                  • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                    • "NONE"
                    • "PASSTHROUGH"
                  • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                    • "VIDEO_AND_FIXED_INTERVALS"
                    • "VIDEO_INTERVAL"
                  • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                  • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                    • "VIDEO_AND_AUDIO_PIDS"
                    • "VIDEO_PID"
                  • EcmPid — (String) This field is unused and deprecated.
                  • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                    • "EXCLUDE"
                    • "INCLUDE"
                  • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                  • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                    • "NONE"
                    • "PASSTHROUGH"
                  • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                  • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                  • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                    • "CONFIGURED_PCR_PERIOD"
                    • "PCR_EVERY_PES_PACKET"
                  • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                  • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                  • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                  • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                    • "CBR"
                    • "VBR"
                  • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                    • "NONE"
                    • "PASSTHROUGH"
                  • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                    • "EBP"
                    • "EBP_LEGACY"
                    • "NONE"
                    • "PSI_SEGSTART"
                    • "RAI_ADAPT"
                    • "RAI_SEGSTART"
                  • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                    • "MAINTAIN_CADENCE"
                    • "RESET_CADENCE"
                  • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                  • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                    • "NO_PASSTHROUGH"
                    • "PASSTHROUGH"
                  • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                  • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
              • Destination — required — (map) Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
                • DestinationRefId — (String) Placeholder documentation for __string
              • FecOutputSettings — (map) Settings for enabling and adjusting Forward Error Correction on UDP outputs.
                • ColumnDepth — (Integer) Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
                • IncludeFec — (String) Enables column only or column and row based FEC Possible values include:
                  • "COLUMN"
                  • "COLUMN_AND_ROW"
                • RowLength — (Integer) Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
          • VideoDescriptionName — (String) The name of the VideoDescription used as the source for this output.
      • TimecodeConfig — required — (map) Contains settings used to acquire and adjust timecode information from inputs.
        • Source — required — (String) Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. Possible values include:
          • "EMBEDDED"
          • "SYSTEMCLOCK"
          • "ZEROBASED"
        • SyncThreshold — (Integer) Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
      • VideoDescriptions — required — (Array<map>) Placeholder documentation for __listOfVideoDescription
        • CodecSettings — (map) Video codec settings.
          • FrameCaptureSettings — (map) Frame Capture Settings
            • CaptureInterval — required — (Integer) The frequency, in seconds, for capturing frames for inclusion in the output. For example, "10" means capture a frame every 10 seconds.
          • H264Settings — (map) H264 Settings
            • AdaptiveQuantization — (String) Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. Possible values include:
              • "HIGH"
              • "HIGHER"
              • "LOW"
              • "MAX"
              • "MEDIUM"
              • "OFF"
            • AfdSignaling — (String) Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. Possible values include:
              • "AUTO"
              • "FIXED"
              • "NONE"
            • Bitrate — (Integer) Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
            • BufFillPct — (Integer) Percentage of the buffer that should initially be filled (HRD buffer model).
            • BufSize — (Integer) Size of buffer (HRD buffer model) in bits/second.
            • ColorMetadata — (String) Includes colorspace metadata in the output. Possible values include:
              • "IGNORE"
              • "INSERT"
            • EntropyEncoding — (String) Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. Possible values include:
              • "CABAC"
              • "CAVLC"
            • FixedAfd — (String) Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. Possible values include:
              • "AFD_0000"
              • "AFD_0010"
              • "AFD_0011"
              • "AFD_0100"
              • "AFD_1000"
              • "AFD_1001"
              • "AFD_1010"
              • "AFD_1011"
              • "AFD_1101"
              • "AFD_1110"
              • "AFD_1111"
            • FlickerAq — (String) If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • FramerateControl — (String) This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. Possible values include:
              • "INITIALIZE_FROM_SOURCE"
              • "SPECIFIED"
            • FramerateDenominator — (Integer) Framerate denominator.
            • FramerateNumerator — (Integer) Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
            • GopBReference — (String) Documentation update needed Possible values include:
              • "DISABLED"
              • "ENABLED"
            • GopClosedCadence — (Integer) Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
            • GopNumBFrames — (Integer) Number of B-frames between reference frames.
            • GopSize — (Float) GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. Must be greater than zero.
            • GopSizeUnits — (String) Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. Possible values include:
              • "FRAMES"
              • "SECONDS"
            • Level — (String) H.264 Level. Possible values include:
              • "H264_LEVEL_1"
              • "H264_LEVEL_1_1"
              • "H264_LEVEL_1_2"
              • "H264_LEVEL_1_3"
              • "H264_LEVEL_2"
              • "H264_LEVEL_2_1"
              • "H264_LEVEL_2_2"
              • "H264_LEVEL_3"
              • "H264_LEVEL_3_1"
              • "H264_LEVEL_3_2"
              • "H264_LEVEL_4"
              • "H264_LEVEL_4_1"
              • "H264_LEVEL_4_2"
              • "H264_LEVEL_5"
              • "H264_LEVEL_5_1"
              • "H264_LEVEL_5_2"
              • "H264_LEVEL_AUTO"
            • LookAheadRateControl — (String) Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. Possible values include:
              • "HIGH"
              • "LOW"
              • "MEDIUM"
            • MaxBitrate — (Integer) For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
            • MinIInterval — (Integer) Only meaningful if sceneChangeDetect is set to enabled. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
            • NumRefFrames — (Integer) Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
            • ParControl — (String) This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. Possible values include:
              • "INITIALIZE_FROM_SOURCE"
              • "SPECIFIED"
            • ParDenominator — (Integer) Pixel Aspect Ratio denominator.
            • ParNumerator — (Integer) Pixel Aspect Ratio numerator.
            • Profile — (String) H.264 Profile. Possible values include:
              • "BASELINE"
              • "HIGH"
              • "HIGH_10BIT"
              • "HIGH_422"
              • "HIGH_422_10BIT"
              • "MAIN"
            • QvbrQualityLevel — (Integer) Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
            • RateControlMode — (String) Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Possible values include:
              • "CBR"
              • "QVBR"
              • "VBR"
            • ScanType — (String) Sets the scan type of the output to progressive or top-field-first interlaced. Possible values include:
              • "INTERLACED"
              • "PROGRESSIVE"
            • SceneChangeDetect — (String) Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • Slices — (Integer) Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
            • Softness — (Integer) Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
            • SpatialAq — (String) If set to enabled, adjust quantization within each frame based on spatial variation of content complexity. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • SubgopLength — (String) If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. Possible values include:
              • "DYNAMIC"
              • "FIXED"
            • Syntax — (String) Produces a bitstream compliant with SMPTE RP-2027. Possible values include:
              • "DEFAULT"
              • "RP2027"
            • TemporalAq — (String) If set to enabled, adjust quantization within each frame based on temporal variation of content complexity. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • TimecodeInsertion — (String) Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config Possible values include:
              • "DISABLED"
              • "PIC_TIMING_SEI"
        • Height — (Integer) Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
        • Name — required — (String) The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
        • RespondToAfd — (String) Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped. Possible values include:
          • "NONE"
          • "PASSTHROUGH"
          • "RESPOND"
        • ScalingBehavior — (String) STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. Possible values include:
          • "DEFAULT"
          • "STRETCH_TO_OUTPUT"
        • Sharpness — (Integer) Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
        • Width — (Integer) Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
    • InputAttachments — (Array<map>) List of input attachments for channel.
      • InputAttachmentName — (String) User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
      • InputId — (String) The ID of the input
      • InputSettings — (map) Settings of an input (caption selector, etc.)
        • AudioSelectors — (Array<map>) Used to select the audio stream to decode for inputs that have multiple available.
          • Name — required — (String) The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
          • SelectorSettings — (map) The audio selector settings.
            • AudioLanguageSelection — (map) Audio Language Selection
              • LanguageCode — required — (String) Selects a specific three-letter language code from within an audio source.
              • LanguageSelectionPolicy — (String) When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. Possible values include:
                • "LOOSE"
                • "STRICT"
            • AudioPidSelection — (map) Audio Pid Selection
              • Pid — required — (Integer) Selects a specific PID from within a source.
        • CaptionSelectors — (Array<map>) Used to select the caption input to use for inputs that have multiple available.
          • LanguageCode — (String) When specified this field indicates the three letter language code of the caption track to extract from the source.
          • Name — required — (String) Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
          • SelectorSettings — (map) Caption selector settings.
            • AribSourceSettings — (map) Arib Source Settings
            • DvbSubSourceSettings — (map) Dvb Sub Source Settings
              • Pid — (Integer) When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
            • EmbeddedSourceSettings — (map) Embedded Source Settings
              • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                • "DISABLED"
                • "UPCONVERT"
              • Scte20Detection — (String) Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. Possible values include:
                • "AUTO"
                • "OFF"
              • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
              • Source608TrackNumber — (Integer) This field is unused and deprecated.
            • Scte20SourceSettings — (map) Scte20 Source Settings
              • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                • "DISABLED"
                • "UPCONVERT"
              • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
            • Scte27SourceSettings — (map) Scte27 Source Settings
              • Pid — (Integer) The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
            • TeletextSourceSettings — (map) Teletext Source Settings
              • PageNumber — (String) Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
        • DeblockFilter — (String) Enable or disable the deblock filter when filtering. Possible values include:
          • "DISABLED"
          • "ENABLED"
        • DenoiseFilter — (String) Enable or disable the denoise filter when filtering. Possible values include:
          • "DISABLED"
          • "ENABLED"
        • FilterStrength — (Integer) Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
        • InputFilter — (String) Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type Possible values include:
          • "AUTO"
          • "DISABLED"
          • "FORCED"
        • NetworkInputSettings — (map) Input settings.
          • HlsInputSettings — (map) Specifies HLS input settings when the uri is for a HLS manifest.
            • Bandwidth — (Integer) When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
            • BufferSegments — (Integer) When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
            • Retries — (Integer) The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
            • RetryInterval — (Integer) The number of seconds between retries when an attempt to read a manifest or segment fails.
          • ServerValidation — (String) Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. Possible values include:
            • "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME"
            • "CHECK_CRYPTOGRAPHY_ONLY"
        • SourceEndBehavior — (String) Loop input if it is a file. This allows a file input to be streamed indefinitely. Possible values include:
          • "CONTINUE"
          • "LOOP"
        • VideoSelector — (map) Informs which video elementary stream to decode for input types that have multiple available.
          • ColorSpace — (String) Specifies the colorspace of an input. This setting works in tandem with colorSpaceConversion to determine if any conversion will be performed. Possible values include:
            • "FOLLOW"
            • "REC_601"
            • "REC_709"
          • ColorSpaceUsage — (String) Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. Possible values include:
            • "FALLBACK"
            • "FORCE"
          • SelectorSettings — (map) The video selector settings.
            • VideoSelectorPid — (map) Video Selector Pid
              • Pid — (Integer) Selects a specific PID from within a video source.
            • VideoSelectorProgramId — (map) Video Selector Program Id
              • ProgramId — (Integer) Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
    • InputSpecification — (map) Specification of input for this channel (max. bitrate, resolution, codec, etc.)
      • Codec — (String) Input codec Possible values include:
        • "MPEG2"
        • "AVC"
        • "HEVC"
      • MaximumBitrate — (String) Maximum input bitrate, categorized coarsely Possible values include:
        • "MAX_10_MBPS"
        • "MAX_20_MBPS"
        • "MAX_50_MBPS"
      • Resolution — (String) Input resolution, categorized coarsely Possible values include:
        • "SD"
        • "HD"
        • "UHD"
    • LogLevel — (String) The log level to write to CloudWatch Logs. Possible values include:
      • "ERROR"
      • "WARNING"
      • "INFO"
      • "DEBUG"
      • "DISABLED"
    • Name — (String) Name of channel.
    • RequestId — (String) Unique request ID to be specified. This is needed to prevent retries from creating multiple resources. If a token is not provided, the SDK will use a version 4 UUID.
    • Reserved — (String) Deprecated field that's only usable by whitelisted customers.
    • RoleArn — (String) An optional Amazon Resource Name (ARN) of the role to assume when running the Channel.
    • Tags — (map<String>) A collection of key-value pairs.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Channel — (map) Placeholder documentation for Channel
        • Arn — (String) The unique arn of the channel.
        • ChannelClass — (String) The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. Possible values include:
          • "STANDARD"
          • "SINGLE_PIPELINE"
        • Destinations — (Array<map>) A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
          • Id — (String) User-specified id. This is used in an output group or an output.
          • MediaPackageSettings — (Array<map>) Destination settings for a MediaPackage output; one destination for both encoders.
            • ChannelId — (String) ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
          • Settings — (Array<map>) Destination settings for a standard output; one destination for each redundant encoder.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • StreamName — (String) Stream name for RTMP destinations (URLs of type rtmp://)
            • Url — (String) A URL specifying a destination
            • Username — (String) username for destination
        • EgressEndpoints — (Array<map>) The endpoints where outgoing connections initiate from
          • SourceIp — (String) Public IP of where a channel's output comes from
        • EncoderSettings — (map) Encoder Settings
          • AudioDescriptions — required — (Array<map>) Placeholder documentation for __listOfAudioDescription
            • AudioNormalizationSettings — (map) Advanced audio normalization settings.
              • Algorithm — (String) Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. Possible values include:
                • "ITU_1770_1"
                • "ITU_1770_2"
              • AlgorithmControl — (String) When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. Possible values include:
                • "CORRECT_AUDIO"
              • TargetLkfs — (Float) Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
            • AudioSelectorName — required — (String) The name of the AudioSelector used as the source for this AudioDescription.
            • AudioType — (String) Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. Possible values include:
              • "CLEAN_EFFECTS"
              • "HEARING_IMPAIRED"
              • "UNDEFINED"
              • "VISUAL_IMPAIRED_COMMENTARY"
            • AudioTypeControl — (String) Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. Possible values include:
              • "FOLLOW_INPUT"
              • "USE_CONFIGURED"
            • CodecSettings — (map) Audio codec settings.
              • AacSettings — (map) Aac Settings
                • Bitrate — (Float) Average bitrate in bits/second. Valid values depend on rate control mode and profile.
                • CodingMode — (String) Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. Possible values include:
                  • "AD_RECEIVER_MIX"
                  • "CODING_MODE_1_0"
                  • "CODING_MODE_1_1"
                  • "CODING_MODE_2_0"
                  • "CODING_MODE_5_1"
                • InputType — (String) Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD. Possible values include:
                  • "BROADCASTER_MIXED_AD"
                  • "NORMAL"
                • Profile — (String) AAC Profile. Possible values include:
                  • "HEV1"
                  • "HEV2"
                  • "LC"
                • RateControlMode — (String) Rate Control Mode. Possible values include:
                  • "CBR"
                  • "VBR"
                • RawFormat — (String) Sets LATM / LOAS AAC output for raw containers. Possible values include:
                  • "LATM_LOAS"
                  • "NONE"
                • SampleRate — (Float) Sample rate in Hz. Valid values depend on rate control mode and profile.
                • Spec — (String) Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. Possible values include:
                  • "MPEG2"
                  • "MPEG4"
                • VbrQuality — (String) VBR Quality Level - Only used if rateControlMode is VBR. Possible values include:
                  • "HIGH"
                  • "LOW"
                  • "MEDIUM_HIGH"
                  • "MEDIUM_LOW"
              • Ac3Settings — (map) Ac3 Settings
                • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
                • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. Possible values include:
                  • "COMMENTARY"
                  • "COMPLETE_MAIN"
                  • "DIALOGUE"
                  • "EMERGENCY"
                  • "HEARING_IMPAIRED"
                  • "MUSIC_AND_EFFECTS"
                  • "VISUALLY_IMPAIRED"
                  • "VOICE_OVER"
                • CodingMode — (String) Dolby Digital coding mode. Determines number of channels. Possible values include:
                  • "CODING_MODE_1_0"
                  • "CODING_MODE_1_1"
                  • "CODING_MODE_2_0"
                  • "CODING_MODE_3_2_LFE"
                • Dialnorm — (Integer) Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
                • DrcProfile — (String) If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. Possible values include:
                  • "FILM_STANDARD"
                  • "NONE"
                • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • MetadataControl — (String) When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
                  • "FOLLOW_INPUT"
                  • "USE_CONFIGURED"
              • Eac3Settings — (map) Eac3 Settings
                • AttenuationControl — (String) When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. Possible values include:
                  • "ATTENUATE_3_DB"
                  • "NONE"
                • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
                • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. Possible values include:
                  • "COMMENTARY"
                  • "COMPLETE_MAIN"
                  • "EMERGENCY"
                  • "HEARING_IMPAIRED"
                  • "VISUALLY_IMPAIRED"
                • CodingMode — (String) Dolby Digital Plus coding mode. Determines number of channels. Possible values include:
                  • "CODING_MODE_1_0"
                  • "CODING_MODE_2_0"
                  • "CODING_MODE_3_2"
                • DcFilter — (String) When set to enabled, activates a DC highpass filter for all input channels. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • Dialnorm — (Integer) Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
                • DrcLine — (String) Sets the Dolby dynamic range compression profile. Possible values include:
                  • "FILM_LIGHT"
                  • "FILM_STANDARD"
                  • "MUSIC_LIGHT"
                  • "MUSIC_STANDARD"
                  • "NONE"
                  • "SPEECH"
                • DrcRf — (String) Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. Possible values include:
                  • "FILM_LIGHT"
                  • "FILM_STANDARD"
                  • "MUSIC_LIGHT"
                  • "MUSIC_STANDARD"
                  • "NONE"
                  • "SPEECH"
                • LfeControl — (String) When encoding 3/2 audio, setting to lfe enables the LFE channel Possible values include:
                  • "LFE"
                  • "NO_LFE"
                • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • LoRoCenterMixLevel — (Float) Left only/Right only center mix level. Only used for 3/2 coding mode.
                • LoRoSurroundMixLevel — (Float) Left only/Right only surround mix level. Only used for 3/2 coding mode.
                • LtRtCenterMixLevel — (Float) Left total/Right total center mix level. Only used for 3/2 coding mode.
                • LtRtSurroundMixLevel — (Float) Left total/Right total surround mix level. Only used for 3/2 coding mode.
                • MetadataControl — (String) When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
                  • "FOLLOW_INPUT"
                  • "USE_CONFIGURED"
                • PassthroughControl — (String) When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding. Possible values include:
                  • "NO_PASSTHROUGH"
                  • "WHEN_POSSIBLE"
                • PhaseControl — (String) When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. Possible values include:
                  • "NO_SHIFT"
                  • "SHIFT_90_DEGREES"
                • StereoDownmix — (String) Stereo downmix preference. Only used for 3/2 coding mode. Possible values include:
                  • "DPL2"
                  • "LO_RO"
                  • "LT_RT"
                  • "NOT_INDICATED"
                • SurroundExMode — (String) When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                  • "NOT_INDICATED"
                • SurroundMode — (String) When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                  • "NOT_INDICATED"
              • Mp2Settings — (map) Mp2 Settings
                • Bitrate — (Float) Average bitrate in bits/second.
                • CodingMode — (String) The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). Possible values include:
                  • "CODING_MODE_1_0"
                  • "CODING_MODE_2_0"
                • SampleRate — (Float) Sample rate in Hz.
              • PassThroughSettings — (map) Pass Through Settings
            • LanguageCode — (String) Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
            • LanguageCodeControl — (String) Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. Possible values include:
              • "FOLLOW_INPUT"
              • "USE_CONFIGURED"
            • Name — required — (String) The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
            • RemixSettings — (map) Settings that control how input audio channels are remixed into the output audio channels.
              • ChannelMappings — required — (Array<map>) Mapping of input channels to output channels, with appropriate gain adjustments.
                • InputChannelLevels — required — (Array<map>) Indices and gain values for each input channel that should be remixed into this output channel.
                  • Gain — required — (Integer) Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
                  • InputChannel — required — (Integer) The index of the input channel used as a source.
                • OutputChannel — required — (Integer) The index of the output channel being produced.
              • ChannelsIn — (Integer) Number of input channels to be used.
              • ChannelsOut — (Integer) Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
            • StreamName — (String) Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
          • AvailBlanking — (map) Settings for ad avail blanking.
            • AvailBlankingImage — (map) Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • State — (String) When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added. Possible values include:
              • "DISABLED"
              • "ENABLED"
          • AvailConfiguration — (map) Event-wide configuration settings for ad avail insertion.
            • AvailSettings — (map) Ad avail settings.
              • Scte35SpliceInsert — (map) Scte35 Splice Insert
                • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
                • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                  • "FOLLOW"
                  • "IGNORE"
                • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                  • "FOLLOW"
                  • "IGNORE"
              • Scte35TimeSignalApos — (map) Scte35 Time Signal Apos
                • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
                • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                  • "FOLLOW"
                  • "IGNORE"
                • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                  • "FOLLOW"
                  • "IGNORE"
          • BlackoutSlate — (map) Settings for blackout slate.
            • BlackoutSlateImage — (map) Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • NetworkEndBlackout — (String) Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". Possible values include:
              • "DISABLED"
              • "ENABLED"
            • NetworkEndBlackoutImage — (map) Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • NetworkId — (String) Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
            • State — (String) When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata. Possible values include:
              • "DISABLED"
              • "ENABLED"
          • CaptionDescriptions — (Array<map>) Settings for caption decriptions
            • CaptionSelectorName — required — (String) Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
            • DestinationSettings — (map) Additional settings for captions destination that depend on the destination type.
              • AribDestinationSettings — (map) Arib Destination Settings
              • BurnInDestinationSettings — (map) Burn In Destination Settings
                • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "CENTERED"
                  • "LEFT"
                  • "SMART"
                • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "NONE"
                  • "WHITE"
                • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
                • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
                  • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                  • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                  • Username — (String) Documentation update needed
                • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "BLUE"
                  • "GREEN"
                  • "RED"
                  • "WHITE"
                  • "YELLOW"
                • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
                • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
                • FontSize — (String) When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
                • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "BLUE"
                  • "GREEN"
                  • "RED"
                  • "WHITE"
                  • "YELLOW"
                • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
                • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "NONE"
                  • "WHITE"
                • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
                • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
                • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
                • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
                  • "FIXED"
                  • "SCALED"
                • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
                • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
              • DvbSubDestinationSettings — (map) Dvb Sub Destination Settings
                • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "CENTERED"
                  • "LEFT"
                  • "SMART"
                • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "NONE"
                  • "WHITE"
                • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
                • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
                  • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                  • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                  • Username — (String) Documentation update needed
                • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "BLUE"
                  • "GREEN"
                  • "RED"
                  • "WHITE"
                  • "YELLOW"
                • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
                • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
                • FontSize — (String) When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
                • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "BLUE"
                  • "GREEN"
                  • "RED"
                  • "WHITE"
                  • "YELLOW"
                • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
                • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "NONE"
                  • "WHITE"
                • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
                • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
                • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
                • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
                  • "FIXED"
                  • "SCALED"
                • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
                • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
              • EmbeddedDestinationSettings — (map) Embedded Destination Settings
              • EmbeddedPlusScte20DestinationSettings — (map) Embedded Plus Scte20 Destination Settings
              • RtmpCaptionInfoDestinationSettings — (map) Rtmp Caption Info Destination Settings
              • Scte20PlusEmbeddedDestinationSettings — (map) Scte20 Plus Embedded Destination Settings
              • Scte27DestinationSettings — (map) Scte27 Destination Settings
              • SmpteTtDestinationSettings — (map) Smpte Tt Destination Settings
              • TeletextDestinationSettings — (map) Teletext Destination Settings
              • TtmlDestinationSettings — (map) Ttml Destination Settings
                • StyleControl — (String) When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. Possible values include:
                  • "PASSTHROUGH"
                  • "USE_CONFIGURED"
              • WebvttDestinationSettings — (map) Webvtt Destination Settings
            • LanguageCode — (String) ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
            • LanguageDescription — (String) Human readable information to indicate captions available for players (eg. English, or Spanish).
            • Name — required — (String) Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
          • GlobalConfiguration — (map) Configuration settings that apply to the event as a whole.
            • InitialAudioGain — (Integer) Value to set the initial audio gain for the Live Event.
            • InputEndAction — (String) Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). Possible values include:
              • "NONE"
              • "SWITCH_AND_LOOP_INPUTS"
            • InputLossBehavior — (map) Settings for system actions when input is lost.
              • BlackFrameMsec — (Integer) Documentation update needed
              • InputLossImageColor — (String) When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
              • InputLossImageSlate — (map) When input loss image type is "slate" these fields specify the parameters for accessing the slate.
                • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                • Username — (String) Documentation update needed
              • InputLossImageType — (String) Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. Possible values include:
                • "COLOR"
                • "SLATE"
              • RepeatFrameMsec — (Integer) Documentation update needed
            • OutputLockingMode — (String) Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. Possible values include:
              • "EPOCH_LOCKING"
              • "PIPELINE_LOCKING"
            • OutputTimingSource — (String) Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. Possible values include:
              • "INPUT_CLOCK"
              • "SYSTEM_CLOCK"
            • SupportLowFramerateInputs — (String) Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. Possible values include:
              • "DISABLED"
              • "ENABLED"
          • OutputGroups — required — (Array<map>) Placeholder documentation for __listOfOutputGroup
            • Name — (String) Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
            • OutputGroupSettings — required — (map) Settings associated with the output group.
              • ArchiveGroupSettings — (map) Archive Group Settings
                • Destination — required — (map) A directory and base filename where archive files should be written.
                  • DestinationRefId — (String) Placeholder documentation for __string
                • RolloverInterval — (Integer) Number of seconds to write to archive file before closing and starting a new one.
              • FrameCaptureGroupSettings — (map) Frame Capture Group Settings
                • Destination — required — (map) The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
                  • DestinationRefId — (String) Placeholder documentation for __string
              • HlsGroupSettings — (map) Hls Group Settings
                • AdMarkers — (Array<String>) Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
                • BaseUrlContent — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
                • BaseUrlManifest — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
                • CaptionLanguageMappings — (Array<map>) Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
                  • CaptionChannel — required — (Integer) The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
                  • LanguageCode — required — (String) Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
                  • LanguageDescription — required — (String) Textual description of language
                • CaptionLanguageSetting — (String) Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest. Possible values include:
                  • "INSERT"
                  • "NONE"
                  • "OMIT"
                • ClientCache — (String) When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • CodecSpecification — (String) Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. Possible values include:
                  • "RFC_4281"
                  • "RFC_6381"
                • ConstantIv — (String) For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
                • Destination — required — (map) A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
                  • DestinationRefId — (String) Placeholder documentation for __string
                • DirectoryStructure — (String) Place segments in subdirectories. Possible values include:
                  • "SINGLE_DIRECTORY"
                  • "SUBDIRECTORY_PER_STREAM"
                • EncryptionType — (String) Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. Possible values include:
                  • "AES128"
                  • "SAMPLE_AES"
                • HlsCdnSettings — (map) Parameters that control interactions with the CDN.
                  • HlsAkamaiSettings — (map) Hls Akamai Settings
                    • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                    • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                    • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. Possible values include:
                      • "CHUNKED"
                      • "NON_CHUNKED"
                    • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                    • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                    • Salt — (String) Salt for authenticated Akamai.
                    • Token — (String) Token parameter for authenticated akamai. If not specified, gda is used.
                  • HlsBasicPutSettings — (map) Hls Basic Put Settings
                    • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                    • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                    • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                    • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                  • HlsMediaStoreSettings — (map) Hls Media Store Settings
                    • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                    • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                    • MediaStoreStorageClass — (String) When set to temporal, output files are stored in non-persistent memory for faster reading and writing. Possible values include:
                      • "TEMPORAL"
                    • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                    • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                  • HlsWebdavSettings — (map) Hls Webdav Settings
                    • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                    • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                    • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to WebDAV. Possible values include:
                      • "CHUNKED"
                      • "NON_CHUNKED"
                    • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                    • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                • IFrameOnlyPlaylists — (String) DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888" Possible values include:
                  • "DISABLED"
                  • "STANDARD"
                • IndexNSegments — (Integer) Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
                • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
                  • "EMIT_OUTPUT"
                  • "PAUSE_OUTPUT"
                • IvInManifest — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. Possible values include:
                  • "EXCLUDE"
                  • "INCLUDE"
                • IvSource — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. Possible values include:
                  • "EXPLICIT"
                  • "FOLLOWS_SEGMENT_NUMBER"
                • KeepSegments — (Integer) Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
                • KeyFormat — (String) The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
                • KeyFormatVersions — (String) Either a single positive integer version value or a slash delimited list of version values (1/2/3).
                • KeyProviderSettings — (map) The key provider settings.
                  • StaticKeySettings — (map) Static Key Settings
                    • KeyProviderServer — (map) The URL of the license server used for protecting content.
                      • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                      • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                      • Username — (String) Documentation update needed
                    • StaticKeyValue — required — (String) Static key value as a 32 character hexadecimal string.
                • ManifestCompression — (String) When set to gzip, compresses HLS playlist. Possible values include:
                  • "GZIP"
                  • "NONE"
                • ManifestDurationFormat — (String) Indicates whether the output manifest should use floating point or integer values for segment duration. Possible values include:
                  • "FLOATING_POINT"
                  • "INTEGER"
                • MinSegmentLength — (Integer) When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
                • Mode — (String) If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. Possible values include:
                  • "LIVE"
                  • "VOD"
                • OutputSelection — (String) MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group. Possible values include:
                  • "MANIFESTS_AND_SEGMENTS"
                  • "SEGMENTS_ONLY"
                • ProgramDateTime — (String) Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset. Possible values include:
                  • "EXCLUDE"
                  • "INCLUDE"
                • ProgramDateTimePeriod — (Integer) Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
                • RedundantManifest — (String) ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • SegmentLength — (Integer) Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
                • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
                  • "USE_INPUT_SEGMENTATION"
                  • "USE_SEGMENT_DURATION"
                • SegmentsPerSubdirectory — (Integer) Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
                • StreamInfResolution — (String) Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. Possible values include:
                  • "EXCLUDE"
                  • "INCLUDE"
                • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
                  • "NONE"
                  • "PRIV"
                  • "TDRL"
                • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
                • TimestampDeltaMilliseconds — (Integer) Provides an extra millisecond delta offset to fine tune the timestamps.
                • TsFileMode — (String) SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching. Possible values include:
                  • "SEGMENTED_FILES"
                  • "SINGLE_FILE"
              • MediaPackageGroupSettings — (map) Media Package Group Settings
                • Destination — required — (map) MediaPackage channel destination.
                  • DestinationRefId — (String) Placeholder documentation for __string
              • MsSmoothGroupSettings — (map) Ms Smooth Group Settings
                • AcquisitionPointId — (String) The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
                • AudioOnlyTimecodeControl — (String) If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. Possible values include:
                  • "PASSTHROUGH"
                  • "USE_CONFIGURED_CLOCK"
                • CertificateMode — (String) If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. Possible values include:
                  • "SELF_SIGNED"
                  • "VERIFY_AUTHENTICITY"
                • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
                • Destination — required — (map) Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
                  • DestinationRefId — (String) Placeholder documentation for __string
                • EventId — (String) MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
                • EventIdMode — (String) Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server. Possible values include:
                  • "NO_EVENT_ID"
                  • "USE_CONFIGURED"
                  • "USE_TIMESTAMP"
                • EventStopBehavior — (String) When set to sendEos, send EOS signal to IIS server when stopping the event Possible values include:
                  • "NONE"
                  • "SEND_EOS"
                • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                • FragmentLength — (Integer) Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
                • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
                  • "EMIT_OUTPUT"
                  • "PAUSE_OUTPUT"
                • NumRetries — (Integer) Number of retry attempts.
                • RestartDelay — (Integer) Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
                • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
                  • "USE_INPUT_SEGMENTATION"
                  • "USE_SEGMENT_DURATION"
                • SendDelayMs — (Integer) Number of milliseconds to delay the output from the second pipeline.
                • SparseTrackType — (String) If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs. Possible values include:
                  • "NONE"
                  • "SCTE_35"
                • StreamManifestBehavior — (String) When set to send, send stream manifest so publishing point doesn't start until all streams start. Possible values include:
                  • "DO_NOT_SEND"
                  • "SEND"
                • TimestampOffset — (String) Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
                • TimestampOffsetMode — (String) Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset Possible values include:
                  • "USE_CONFIGURED_OFFSET"
                  • "USE_EVENT_START_DATE"
              • RtmpGroupSettings — (map) Rtmp Group Settings
                • AuthenticationScheme — (String) Authentication scheme to use when connecting with CDN Possible values include:
                  • "AKAMAI"
                  • "COMMON"
                • CacheFullBehavior — (String) Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. Possible values include:
                  • "DISCONNECT_IMMEDIATELY"
                  • "WAIT_FOR_SERVER"
                • CacheLength — (Integer) Cache length, in seconds, is used to calculate buffer size.
                • CaptionData — (String) Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. Possible values include:
                  • "ALL"
                  • "FIELD1_608"
                  • "FIELD1_AND_FIELD2_608"
                • InputLossAction — (String) Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. Possible values include:
                  • "EMIT_OUTPUT"
                  • "PAUSE_OUTPUT"
                • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
              • UdpGroupSettings — (map) Udp Group Settings
                • InputLossAction — (String) Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. Possible values include:
                  • "DROP_PROGRAM"
                  • "DROP_TS"
                  • "EMIT_PROGRAM"
                • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
                  • "NONE"
                  • "PRIV"
                  • "TDRL"
                • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
            • Outputs — required — (Array<map>) Placeholder documentation for __listOfOutput
              • AudioDescriptionNames — (Array<String>) The names of the AudioDescriptions used as audio sources for this output.
              • CaptionDescriptionNames — (Array<String>) The names of the CaptionDescriptions used as caption sources for this output.
              • OutputName — (String) The name used to identify an output.
              • OutputSettings — required — (map) Output type-specific settings.
                • ArchiveOutputSettings — (map) Archive Output Settings
                  • ContainerSettings — required — (map) Settings specific to the container type of the file.
                    • M2tsSettings — (map) M2ts Settings
                      • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                        • "DROP"
                        • "ENCODE_SILENCE"
                      • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                        • "DISABLED"
                        • "ENABLED"
                      • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                        • "AUTO"
                        • "USE_CONFIGURED"
                      • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                        • "ATSC"
                        • "DVB"
                      • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                      • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                        • "ATSC"
                        • "DVB"
                      • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                      • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                        • "MULTIPLEX"
                        • "NONE"
                      • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                        • "DISABLED"
                        • "ENABLED"
                      • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                        • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                        • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                        • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                        • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                          • "SDT_FOLLOW"
                          • "SDT_FOLLOW_IF_PRESENT"
                          • "SDT_MANUAL"
                          • "SDT_NONE"
                        • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                        • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                        • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                      • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                        • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                        • "NONE"
                        • "PASSTHROUGH"
                      • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                        • "VIDEO_AND_FIXED_INTERVALS"
                        • "VIDEO_INTERVAL"
                      • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                      • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                        • "VIDEO_AND_AUDIO_PIDS"
                        • "VIDEO_PID"
                      • EcmPid — (String) This field is unused and deprecated.
                      • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                        • "EXCLUDE"
                        • "INCLUDE"
                      • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                      • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                        • "NONE"
                        • "PASSTHROUGH"
                      • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                      • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                      • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                        • "CONFIGURED_PCR_PERIOD"
                        • "PCR_EVERY_PES_PACKET"
                      • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                      • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                      • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                      • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                        • "CBR"
                        • "VBR"
                      • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                        • "NONE"
                        • "PASSTHROUGH"
                      • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                        • "EBP"
                        • "EBP_LEGACY"
                        • "NONE"
                        • "PSI_SEGSTART"
                        • "RAI_ADAPT"
                        • "RAI_SEGSTART"
                      • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                        • "MAINTAIN_CADENCE"
                        • "RESET_CADENCE"
                      • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                      • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                        • "NO_PASSTHROUGH"
                        • "PASSTHROUGH"
                      • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                      • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • Extension — (String) Output file extension. If excluded, this will be auto-selected from the container type.
                  • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
                • FrameCaptureOutputSettings — (map) Frame Capture Output Settings
                  • NameModifier — (String) Required if the output group contains more than one output. This modifier forms part of the output file name.
                • HlsOutputSettings — (map) Hls Output Settings
                  • HlsSettings — required — (map) Settings regarding the underlying stream. These settings are different for audio-only outputs.
                    • AudioOnlyHlsSettings — (map) Audio Only Hls Settings
                      • AudioGroupId — (String) Specifies the group to which the audio Rendition belongs.
                      • AudioOnlyImage — (map) For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by file size * count * count..
                        • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                        • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                        • Username — (String) Documentation update needed
                      • AudioTrackType — (String) Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO Possible values include:
                        • "ALTERNATE_AUDIO_AUTO_SELECT"
                        • "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT"
                        • "ALTERNATE_AUDIO_NOT_AUTO_SELECT"
                        • "AUDIO_ONLY_VARIANT_STREAM"
                    • StandardHlsSettings — (map) Standard Hls Settings
                      • AudioRenditionSets — (String) List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
                      • M3u8Settings — required — (map) Settings information for the .m3u8 container
                        • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                        • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
                        • EcmPid — (String) This parameter is unused and deprecated.
                        • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                        • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                          • "CONFIGURED_PCR_PERIOD"
                          • "PCR_EVERY_PES_PACKET"
                        • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
                        • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
                        • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                        • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
                        • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                        • Scte35Behavior — (String) If set to passthrough, passes any SCTE-35 signals from the input source to this output. Possible values include:
                          • "NO_PASSTHROUGH"
                          • "PASSTHROUGH"
                        • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
                        • TimedMetadataBehavior — (String) When set to passthrough, timed metadata is passed through from input to output. Possible values include:
                          • "NO_PASSTHROUGH"
                          • "PASSTHROUGH"
                        • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                        • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                        • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
                  • NameModifier — (String) String concatenated to the end of the destination filename. Accepts \"Format Identifiers\":#formatIdentifierParameters.
                  • SegmentModifier — (String) String concatenated to end of segment filenames.
                • MediaPackageOutputSettings — (map) Media Package Output Settings
                • MsSmoothOutputSettings — (map) Ms Smooth Output Settings
                  • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
                • RtmpOutputSettings — (map) Rtmp Output Settings
                  • CertificateMode — (String) If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. Possible values include:
                    • "SELF_SIGNED"
                    • "VERIFY_AUTHENTICITY"
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
                  • Destination — required — (map) The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
                    • DestinationRefId — (String) Placeholder documentation for __string
                  • NumRetries — (Integer) Number of retry attempts.
                • UdpOutputSettings — (map) Udp Output Settings
                  • BufferMsec — (Integer) UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
                  • ContainerSettings — required — (map) Udp Container Settings
                    • M2tsSettings — (map) M2ts Settings
                      • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                        • "DROP"
                        • "ENCODE_SILENCE"
                      • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                        • "DISABLED"
                        • "ENABLED"
                      • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                        • "AUTO"
                        • "USE_CONFIGURED"
                      • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                        • "ATSC"
                        • "DVB"
                      • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                      • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                        • "ATSC"
                        • "DVB"
                      • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                      • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                        • "MULTIPLEX"
                        • "NONE"
                      • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                        • "DISABLED"
                        • "ENABLED"
                      • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                        • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                        • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                        • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                        • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                          • "SDT_FOLLOW"
                          • "SDT_FOLLOW_IF_PRESENT"
                          • "SDT_MANUAL"
                          • "SDT_NONE"
                        • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                        • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                        • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                      • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                        • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                        • "NONE"
                        • "PASSTHROUGH"
                      • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                        • "VIDEO_AND_FIXED_INTERVALS"
                        • "VIDEO_INTERVAL"
                      • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                      • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                        • "VIDEO_AND_AUDIO_PIDS"
                        • "VIDEO_PID"
                      • EcmPid — (String) This field is unused and deprecated.
                      • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                        • "EXCLUDE"
                        • "INCLUDE"
                      • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                      • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                        • "NONE"
                        • "PASSTHROUGH"
                      • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                      • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                      • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                        • "CONFIGURED_PCR_PERIOD"
                        • "PCR_EVERY_PES_PACKET"
                      • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                      • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                      • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                      • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                        • "CBR"
                        • "VBR"
                      • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                        • "NONE"
                        • "PASSTHROUGH"
                      • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                        • "EBP"
                        • "EBP_LEGACY"
                        • "NONE"
                        • "PSI_SEGSTART"
                        • "RAI_ADAPT"
                        • "RAI_SEGSTART"
                      • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                        • "MAINTAIN_CADENCE"
                        • "RESET_CADENCE"
                      • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                      • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                        • "NO_PASSTHROUGH"
                        • "PASSTHROUGH"
                      • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                      • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • Destination — required — (map) Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
                    • DestinationRefId — (String) Placeholder documentation for __string
                  • FecOutputSettings — (map) Settings for enabling and adjusting Forward Error Correction on UDP outputs.
                    • ColumnDepth — (Integer) Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
                    • IncludeFec — (String) Enables column only or column and row based FEC Possible values include:
                      • "COLUMN"
                      • "COLUMN_AND_ROW"
                    • RowLength — (Integer) Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
              • VideoDescriptionName — (String) The name of the VideoDescription used as the source for this output.
          • TimecodeConfig — required — (map) Contains settings used to acquire and adjust timecode information from inputs.
            • Source — required — (String) Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. Possible values include:
              • "EMBEDDED"
              • "SYSTEMCLOCK"
              • "ZEROBASED"
            • SyncThreshold — (Integer) Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
          • VideoDescriptions — required — (Array<map>) Placeholder documentation for __listOfVideoDescription
            • CodecSettings — (map) Video codec settings.
              • FrameCaptureSettings — (map) Frame Capture Settings
                • CaptureInterval — required — (Integer) The frequency, in seconds, for capturing frames for inclusion in the output. For example, "10" means capture a frame every 10 seconds.
              • H264Settings — (map) H264 Settings
                • AdaptiveQuantization — (String) Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. Possible values include:
                  • "HIGH"
                  • "HIGHER"
                  • "LOW"
                  • "MAX"
                  • "MEDIUM"
                  • "OFF"
                • AfdSignaling — (String) Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. Possible values include:
                  • "AUTO"
                  • "FIXED"
                  • "NONE"
                • Bitrate — (Integer) Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
                • BufFillPct — (Integer) Percentage of the buffer that should initially be filled (HRD buffer model).
                • BufSize — (Integer) Size of buffer (HRD buffer model) in bits/second.
                • ColorMetadata — (String) Includes colorspace metadata in the output. Possible values include:
                  • "IGNORE"
                  • "INSERT"
                • EntropyEncoding — (String) Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. Possible values include:
                  • "CABAC"
                  • "CAVLC"
                • FixedAfd — (String) Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. Possible values include:
                  • "AFD_0000"
                  • "AFD_0010"
                  • "AFD_0011"
                  • "AFD_0100"
                  • "AFD_1000"
                  • "AFD_1001"
                  • "AFD_1010"
                  • "AFD_1011"
                  • "AFD_1101"
                  • "AFD_1110"
                  • "AFD_1111"
                • FlickerAq — (String) If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • FramerateControl — (String) This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. Possible values include:
                  • "INITIALIZE_FROM_SOURCE"
                  • "SPECIFIED"
                • FramerateDenominator — (Integer) Framerate denominator.
                • FramerateNumerator — (Integer) Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
                • GopBReference — (String) Documentation update needed Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • GopClosedCadence — (Integer) Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
                • GopNumBFrames — (Integer) Number of B-frames between reference frames.
                • GopSize — (Float) GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. Must be greater than zero.
                • GopSizeUnits — (String) Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. Possible values include:
                  • "FRAMES"
                  • "SECONDS"
                • Level — (String) H.264 Level. Possible values include:
                  • "H264_LEVEL_1"
                  • "H264_LEVEL_1_1"
                  • "H264_LEVEL_1_2"
                  • "H264_LEVEL_1_3"
                  • "H264_LEVEL_2"
                  • "H264_LEVEL_2_1"
                  • "H264_LEVEL_2_2"
                  • "H264_LEVEL_3"
                  • "H264_LEVEL_3_1"
                  • "H264_LEVEL_3_2"
                  • "H264_LEVEL_4"
                  • "H264_LEVEL_4_1"
                  • "H264_LEVEL_4_2"
                  • "H264_LEVEL_5"
                  • "H264_LEVEL_5_1"
                  • "H264_LEVEL_5_2"
                  • "H264_LEVEL_AUTO"
                • LookAheadRateControl — (String) Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. Possible values include:
                  • "HIGH"
                  • "LOW"
                  • "MEDIUM"
                • MaxBitrate — (Integer) For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
                • MinIInterval — (Integer) Only meaningful if sceneChangeDetect is set to enabled. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
                • NumRefFrames — (Integer) Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
                • ParControl — (String) This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. Possible values include:
                  • "INITIALIZE_FROM_SOURCE"
                  • "SPECIFIED"
                • ParDenominator — (Integer) Pixel Aspect Ratio denominator.
                • ParNumerator — (Integer) Pixel Aspect Ratio numerator.
                • Profile — (String) H.264 Profile. Possible values include:
                  • "BASELINE"
                  • "HIGH"
                  • "HIGH_10BIT"
                  • "HIGH_422"
                  • "HIGH_422_10BIT"
                  • "MAIN"
                • QvbrQualityLevel — (Integer) Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
                • RateControlMode — (String) Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Possible values include:
                  • "CBR"
                  • "QVBR"
                  • "VBR"
                • ScanType — (String) Sets the scan type of the output to progressive or top-field-first interlaced. Possible values include:
                  • "INTERLACED"
                  • "PROGRESSIVE"
                • SceneChangeDetect — (String) Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • Slices — (Integer) Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
                • Softness — (Integer) Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
                • SpatialAq — (String) If set to enabled, adjust quantization within each frame based on spatial variation of content complexity. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • SubgopLength — (String) If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. Possible values include:
                  • "DYNAMIC"
                  • "FIXED"
                • Syntax — (String) Produces a bitstream compliant with SMPTE RP-2027. Possible values include:
                  • "DEFAULT"
                  • "RP2027"
                • TemporalAq — (String) If set to enabled, adjust quantization within each frame based on temporal variation of content complexity. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • TimecodeInsertion — (String) Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config Possible values include:
                  • "DISABLED"
                  • "PIC_TIMING_SEI"
            • Height — (Integer) Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
            • Name — required — (String) The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
            • RespondToAfd — (String) Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped. Possible values include:
              • "NONE"
              • "PASSTHROUGH"
              • "RESPOND"
            • ScalingBehavior — (String) STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. Possible values include:
              • "DEFAULT"
              • "STRETCH_TO_OUTPUT"
            • Sharpness — (Integer) Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
            • Width — (Integer) Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
        • Id — (String) The unique id of the channel.
        • InputAttachments — (Array<map>) List of input attachments for channel.
          • InputAttachmentName — (String) User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
          • InputId — (String) The ID of the input
          • InputSettings — (map) Settings of an input (caption selector, etc.)
            • AudioSelectors — (Array<map>) Used to select the audio stream to decode for inputs that have multiple available.
              • Name — required — (String) The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
              • SelectorSettings — (map) The audio selector settings.
                • AudioLanguageSelection — (map) Audio Language Selection
                  • LanguageCode — required — (String) Selects a specific three-letter language code from within an audio source.
                  • LanguageSelectionPolicy — (String) When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. Possible values include:
                    • "LOOSE"
                    • "STRICT"
                • AudioPidSelection — (map) Audio Pid Selection
                  • Pid — required — (Integer) Selects a specific PID from within a source.
            • CaptionSelectors — (Array<map>) Used to select the caption input to use for inputs that have multiple available.
              • LanguageCode — (String) When specified this field indicates the three letter language code of the caption track to extract from the source.
              • Name — required — (String) Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
              • SelectorSettings — (map) Caption selector settings.
                • AribSourceSettings — (map) Arib Source Settings
                • DvbSubSourceSettings — (map) Dvb Sub Source Settings
                  • Pid — (Integer) When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
                • EmbeddedSourceSettings — (map) Embedded Source Settings
                  • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                    • "DISABLED"
                    • "UPCONVERT"
                  • Scte20Detection — (String) Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. Possible values include:
                    • "AUTO"
                    • "OFF"
                  • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
                  • Source608TrackNumber — (Integer) This field is unused and deprecated.
                • Scte20SourceSettings — (map) Scte20 Source Settings
                  • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                    • "DISABLED"
                    • "UPCONVERT"
                  • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
                • Scte27SourceSettings — (map) Scte27 Source Settings
                  • Pid — (Integer) The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
                • TeletextSourceSettings — (map) Teletext Source Settings
                  • PageNumber — (String) Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
            • DeblockFilter — (String) Enable or disable the deblock filter when filtering. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • DenoiseFilter — (String) Enable or disable the denoise filter when filtering. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • FilterStrength — (Integer) Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
            • InputFilter — (String) Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type Possible values include:
              • "AUTO"
              • "DISABLED"
              • "FORCED"
            • NetworkInputSettings — (map) Input settings.
              • HlsInputSettings — (map) Specifies HLS input settings when the uri is for a HLS manifest.
                • Bandwidth — (Integer) When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
                • BufferSegments — (Integer) When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
                • Retries — (Integer) The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
                • RetryInterval — (Integer) The number of seconds between retries when an attempt to read a manifest or segment fails.
              • ServerValidation — (String) Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. Possible values include:
                • "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME"
                • "CHECK_CRYPTOGRAPHY_ONLY"
            • SourceEndBehavior — (String) Loop input if it is a file. This allows a file input to be streamed indefinitely. Possible values include:
              • "CONTINUE"
              • "LOOP"
            • VideoSelector — (map) Informs which video elementary stream to decode for input types that have multiple available.
              • ColorSpace — (String) Specifies the colorspace of an input. This setting works in tandem with colorSpaceConversion to determine if any conversion will be performed. Possible values include:
                • "FOLLOW"
                • "REC_601"
                • "REC_709"
              • ColorSpaceUsage — (String) Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. Possible values include:
                • "FALLBACK"
                • "FORCE"
              • SelectorSettings — (map) The video selector settings.
                • VideoSelectorPid — (map) Video Selector Pid
                  • Pid — (Integer) Selects a specific PID from within a video source.
                • VideoSelectorProgramId — (map) Video Selector Program Id
                  • ProgramId — (Integer) Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
        • InputSpecification — (map) Placeholder documentation for InputSpecification
          • Codec — (String) Input codec Possible values include:
            • "MPEG2"
            • "AVC"
            • "HEVC"
          • MaximumBitrate — (String) Maximum input bitrate, categorized coarsely Possible values include:
            • "MAX_10_MBPS"
            • "MAX_20_MBPS"
            • "MAX_50_MBPS"
          • Resolution — (String) Input resolution, categorized coarsely Possible values include:
            • "SD"
            • "HD"
            • "UHD"
        • LogLevel — (String) The log level being written to CloudWatch Logs. Possible values include:
          • "ERROR"
          • "WARNING"
          • "INFO"
          • "DEBUG"
          • "DISABLED"
        • Name — (String) The name of the channel. (user-mutable)
        • PipelinesRunningCount — (Integer) The number of currently healthy pipelines.
        • RoleArn — (String) The Amazon Resource Name (ARN) of the role assumed when running the Channel.
        • State — (String) Placeholder documentation for ChannelState Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "IDLE"
          • "STARTING"
          • "RUNNING"
          • "RECOVERING"
          • "STOPPING"
          • "DELETING"
          • "DELETED"
        • Tags — (map<String>) A collection of key-value pairs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createInput(params = {}, callback) ⇒ AWS.Request

Create an input

Service Reference:

Examples:

Calling the createInput operation

var params = {
  Destinations: [
    {
      StreamName: 'STRING_VALUE'
    },
    /* more items */
  ],
  InputSecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  MediaConnectFlows: [
    {
      FlowArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  Name: 'STRING_VALUE',
  RequestId: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  Sources: [
    {
      PasswordParam: 'STRING_VALUE',
      Url: 'STRING_VALUE',
      Username: 'STRING_VALUE'
    },
    /* more items */
  ],
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  },
  Type: UDP_PUSH | RTP_PUSH | RTMP_PUSH | RTMP_PULL | URL_PULL | MP4_FILE | MEDIACONNECT,
  Vpc: {
    SubnetIds: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
medialive.createInput(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Destinations — (Array<map>) Destination settings for PUSH type inputs.
      • StreamName — (String) A unique name for the location the RTMP stream is being pushed to.
    • InputSecurityGroups — (Array<String>) A list of security groups referenced by IDs to attach to the input.
    • MediaConnectFlows — (Array<map>) A list of the MediaConnect Flows that you want to use in this input. You can specify as few as one Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a separate Availability Zone as this ensures your EML input is redundant to AZ issues.
      • FlowArn — (String) The ARN of the MediaConnect Flow that you want to use as a source.
    • Name — (String) Name of the input.
    • RequestId — (String) Unique identifier of the request to ensure the request is handled exactly once in case of retries. If a token is not provided, the SDK will use a version 4 UUID.
    • RoleArn — (String) The Amazon Resource Name (ARN) of the role this input assumes during and after creation.
    • Sources — (Array<map>) The source URLs for a PULL-type input. Every PULL type input needs exactly two source URLs for redundancy. Only specify sources for PULL type Inputs. Leave Destinations empty.
      • PasswordParam — (String) The key used to extract the password from EC2 Parameter store.
      • Url — (String) This represents the customer's source URL where stream is pulled from.
      • Username — (String) The username for the input source.
    • Tags — (map<String>) A collection of key-value pairs.
    • Type — (String) Placeholder documentation for InputType Possible values include:
      • "UDP_PUSH"
      • "RTP_PUSH"
      • "RTMP_PUSH"
      • "RTMP_PULL"
      • "URL_PULL"
      • "MP4_FILE"
      • "MEDIACONNECT"
    • Vpc — (map) Settings for a private VPC Input. When this property is specified, the input destination addresses will be created in a VPC rather than with public Internet addresses. This property requires setting the roleArn property on Input creation. Not compatible with the inputSecurityGroups property.
      • SecurityGroupIds — (Array<String>) A list of up to 5 EC2 VPC security group IDs to attach to the Input VPC network interfaces. Requires subnetIds. If none are specified then the VPC default security group will be used.
      • SubnetIds — required — (Array<String>) A list of 2 VPC subnet IDs from the same VPC. Subnet IDs must be mapped to two unique availability zones (AZ).

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Input — (map) Placeholder documentation for Input
        • Arn — (String) The Unique ARN of the input (generated, immutable).
        • AttachedChannels — (Array<String>) A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).
        • Destinations — (Array<map>) A list of the destinations of the input (PUSH-type).
          • Ip — (String) The system-generated static IP address of endpoint. It remains fixed for the lifetime of the input.
          • Port — (String) The port number for the input.
          • Url — (String) This represents the endpoint that the customer stream will be pushed to.
          • Vpc — (map) The properties for a VPC type input destination.
            • AvailabilityZone — (String) The availability zone of the Input destination.
            • NetworkInterfaceId — (String) The network interface ID of the Input destination in the VPC.
        • Id — (String) The generated ID of the input (unique for user account, immutable).
        • InputClass — (String) STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input. Possible values include:
          • "STANDARD"
          • "SINGLE_PIPELINE"
        • MediaConnectFlows — (Array<map>) A list of MediaConnect Flows for this input.
          • FlowArn — (String) The unique ARN of the MediaConnect Flow being used as a source.
        • Name — (String) The user-assigned name (This is a mutable value).
        • RoleArn — (String) The Amazon Resource Name (ARN) of the role this input assumes during and after creation.
        • SecurityGroups — (Array<String>) A list of IDs for all the Input Security Groups attached to the input.
        • Sources — (Array<map>) A list of the sources of the input (PULL-type).
          • PasswordParam — (String) The key used to extract the password from EC2 Parameter store.
          • Url — (String) This represents the customer's source URL where stream is pulled from.
          • Username — (String) The username for the input source.
        • State — (String) Placeholder documentation for InputState Possible values include:
          • "CREATING"
          • "DETACHED"
          • "ATTACHED"
          • "DELETING"
          • "DELETED"
        • Tags — (map<String>) A collection of key-value pairs.
        • Type — (String) Placeholder documentation for InputType Possible values include:
          • "UDP_PUSH"
          • "RTP_PUSH"
          • "RTMP_PUSH"
          • "RTMP_PULL"
          • "URL_PULL"
          • "MP4_FILE"
          • "MEDIACONNECT"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createInputSecurityGroup(params = {}, callback) ⇒ AWS.Request

Creates a Input Security Group

Service Reference:

Examples:

Calling the createInputSecurityGroup operation

var params = {
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  },
  WhitelistRules: [
    {
      Cidr: 'STRING_VALUE'
    },
    /* more items */
  ]
};
medialive.createInputSecurityGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Tags — (map<String>) A collection of key-value pairs.
    • WhitelistRules — (Array<map>) List of IPv4 CIDR addresses to whitelist
      • Cidr — (String) The IPv4 CIDR to whitelist.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SecurityGroup — (map) An Input Security Group
        • Arn — (String) Unique ARN of Input Security Group
        • Id — (String) The Id of the Input Security Group
        • Inputs — (Array<String>) The list of inputs currently using this Input Security Group.
        • State — (String) The current state of the Input Security Group. Possible values include:
          • "IDLE"
          • "IN_USE"
          • "UPDATING"
          • "DELETED"
        • Tags — (map<String>) A collection of key-value pairs.
        • WhitelistRules — (Array<map>) Whitelist rules and their sync status
          • Cidr — (String) The IPv4 CIDR that's whitelisted.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

createTags(params = {}, callback) ⇒ AWS.Request

Create tags for a resource

Service Reference:

Examples:

Calling the createTags operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
medialive.createTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String) Placeholder documentation for __string
    • Tags — (map<String>) Placeholder documentation for Tags

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteChannel(params = {}, callback) ⇒ AWS.Request

Starts deletion of channel. The associated outputs are also deleted.

Service Reference:

Examples:

Calling the deleteChannel operation

var params = {
  ChannelId: 'STRING_VALUE' /* required */
};
medialive.deleteChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ChannelId — (String) Unique ID of the channel.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) The unique arn of the channel.
      • ChannelClass — (String) The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. Possible values include:
        • "STANDARD"
        • "SINGLE_PIPELINE"
      • Destinations — (Array<map>) A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
        • Id — (String) User-specified id. This is used in an output group or an output.
        • MediaPackageSettings — (Array<map>) Destination settings for a MediaPackage output; one destination for both encoders.
          • ChannelId — (String) ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
        • Settings — (Array<map>) Destination settings for a standard output; one destination for each redundant encoder.
          • PasswordParam — (String) key used to extract the password from EC2 Parameter store
          • StreamName — (String) Stream name for RTMP destinations (URLs of type rtmp://)
          • Url — (String) A URL specifying a destination
          • Username — (String) username for destination
      • EgressEndpoints — (Array<map>) The endpoints where outgoing connections initiate from
        • SourceIp — (String) Public IP of where a channel's output comes from
      • EncoderSettings — (map) Encoder Settings
        • AudioDescriptions — required — (Array<map>) Placeholder documentation for __listOfAudioDescription
          • AudioNormalizationSettings — (map) Advanced audio normalization settings.
            • Algorithm — (String) Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. Possible values include:
              • "ITU_1770_1"
              • "ITU_1770_2"
            • AlgorithmControl — (String) When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. Possible values include:
              • "CORRECT_AUDIO"
            • TargetLkfs — (Float) Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
          • AudioSelectorName — required — (String) The name of the AudioSelector used as the source for this AudioDescription.
          • AudioType — (String) Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. Possible values include:
            • "CLEAN_EFFECTS"
            • "HEARING_IMPAIRED"
            • "UNDEFINED"
            • "VISUAL_IMPAIRED_COMMENTARY"
          • AudioTypeControl — (String) Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. Possible values include:
            • "FOLLOW_INPUT"
            • "USE_CONFIGURED"
          • CodecSettings — (map) Audio codec settings.
            • AacSettings — (map) Aac Settings
              • Bitrate — (Float) Average bitrate in bits/second. Valid values depend on rate control mode and profile.
              • CodingMode — (String) Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. Possible values include:
                • "AD_RECEIVER_MIX"
                • "CODING_MODE_1_0"
                • "CODING_MODE_1_1"
                • "CODING_MODE_2_0"
                • "CODING_MODE_5_1"
              • InputType — (String) Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD. Possible values include:
                • "BROADCASTER_MIXED_AD"
                • "NORMAL"
              • Profile — (String) AAC Profile. Possible values include:
                • "HEV1"
                • "HEV2"
                • "LC"
              • RateControlMode — (String) Rate Control Mode. Possible values include:
                • "CBR"
                • "VBR"
              • RawFormat — (String) Sets LATM / LOAS AAC output for raw containers. Possible values include:
                • "LATM_LOAS"
                • "NONE"
              • SampleRate — (Float) Sample rate in Hz. Valid values depend on rate control mode and profile.
              • Spec — (String) Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. Possible values include:
                • "MPEG2"
                • "MPEG4"
              • VbrQuality — (String) VBR Quality Level - Only used if rateControlMode is VBR. Possible values include:
                • "HIGH"
                • "LOW"
                • "MEDIUM_HIGH"
                • "MEDIUM_LOW"
            • Ac3Settings — (map) Ac3 Settings
              • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
              • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. Possible values include:
                • "COMMENTARY"
                • "COMPLETE_MAIN"
                • "DIALOGUE"
                • "EMERGENCY"
                • "HEARING_IMPAIRED"
                • "MUSIC_AND_EFFECTS"
                • "VISUALLY_IMPAIRED"
                • "VOICE_OVER"
              • CodingMode — (String) Dolby Digital coding mode. Determines number of channels. Possible values include:
                • "CODING_MODE_1_0"
                • "CODING_MODE_1_1"
                • "CODING_MODE_2_0"
                • "CODING_MODE_3_2_LFE"
              • Dialnorm — (Integer) Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
              • DrcProfile — (String) If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. Possible values include:
                • "FILM_STANDARD"
                • "NONE"
              • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • MetadataControl — (String) When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
                • "FOLLOW_INPUT"
                • "USE_CONFIGURED"
            • Eac3Settings — (map) Eac3 Settings
              • AttenuationControl — (String) When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. Possible values include:
                • "ATTENUATE_3_DB"
                • "NONE"
              • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
              • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. Possible values include:
                • "COMMENTARY"
                • "COMPLETE_MAIN"
                • "EMERGENCY"
                • "HEARING_IMPAIRED"
                • "VISUALLY_IMPAIRED"
              • CodingMode — (String) Dolby Digital Plus coding mode. Determines number of channels. Possible values include:
                • "CODING_MODE_1_0"
                • "CODING_MODE_2_0"
                • "CODING_MODE_3_2"
              • DcFilter — (String) When set to enabled, activates a DC highpass filter for all input channels. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • Dialnorm — (Integer) Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
              • DrcLine — (String) Sets the Dolby dynamic range compression profile. Possible values include:
                • "FILM_LIGHT"
                • "FILM_STANDARD"
                • "MUSIC_LIGHT"
                • "MUSIC_STANDARD"
                • "NONE"
                • "SPEECH"
              • DrcRf — (String) Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. Possible values include:
                • "FILM_LIGHT"
                • "FILM_STANDARD"
                • "MUSIC_LIGHT"
                • "MUSIC_STANDARD"
                • "NONE"
                • "SPEECH"
              • LfeControl — (String) When encoding 3/2 audio, setting to lfe enables the LFE channel Possible values include:
                • "LFE"
                • "NO_LFE"
              • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • LoRoCenterMixLevel — (Float) Left only/Right only center mix level. Only used for 3/2 coding mode.
              • LoRoSurroundMixLevel — (Float) Left only/Right only surround mix level. Only used for 3/2 coding mode.
              • LtRtCenterMixLevel — (Float) Left total/Right total center mix level. Only used for 3/2 coding mode.
              • LtRtSurroundMixLevel — (Float) Left total/Right total surround mix level. Only used for 3/2 coding mode.
              • MetadataControl — (String) When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
                • "FOLLOW_INPUT"
                • "USE_CONFIGURED"
              • PassthroughControl — (String) When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding. Possible values include:
                • "NO_PASSTHROUGH"
                • "WHEN_POSSIBLE"
              • PhaseControl — (String) When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. Possible values include:
                • "NO_SHIFT"
                • "SHIFT_90_DEGREES"
              • StereoDownmix — (String) Stereo downmix preference. Only used for 3/2 coding mode. Possible values include:
                • "DPL2"
                • "LO_RO"
                • "LT_RT"
                • "NOT_INDICATED"
              • SurroundExMode — (String) When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. Possible values include:
                • "DISABLED"
                • "ENABLED"
                • "NOT_INDICATED"
              • SurroundMode — (String) When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. Possible values include:
                • "DISABLED"
                • "ENABLED"
                • "NOT_INDICATED"
            • Mp2Settings — (map) Mp2 Settings
              • Bitrate — (Float) Average bitrate in bits/second.
              • CodingMode — (String) The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). Possible values include:
                • "CODING_MODE_1_0"
                • "CODING_MODE_2_0"
              • SampleRate — (Float) Sample rate in Hz.
            • PassThroughSettings — (map) Pass Through Settings
          • LanguageCode — (String) Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
          • LanguageCodeControl — (String) Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. Possible values include:
            • "FOLLOW_INPUT"
            • "USE_CONFIGURED"
          • Name — required — (String) The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
          • RemixSettings — (map) Settings that control how input audio channels are remixed into the output audio channels.
            • ChannelMappings — required — (Array<map>) Mapping of input channels to output channels, with appropriate gain adjustments.
              • InputChannelLevels — required — (Array<map>) Indices and gain values for each input channel that should be remixed into this output channel.
                • Gain — required — (Integer) Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
                • InputChannel — required — (Integer) The index of the input channel used as a source.
              • OutputChannel — required — (Integer) The index of the output channel being produced.
            • ChannelsIn — (Integer) Number of input channels to be used.
            • ChannelsOut — (Integer) Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
          • StreamName — (String) Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
        • AvailBlanking — (map) Settings for ad avail blanking.
          • AvailBlankingImage — (map) Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
            • Username — (String) Documentation update needed
          • State — (String) When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added. Possible values include:
            • "DISABLED"
            • "ENABLED"
        • AvailConfiguration — (map) Event-wide configuration settings for ad avail insertion.
          • AvailSettings — (map) Ad avail settings.
            • Scte35SpliceInsert — (map) Scte35 Splice Insert
              • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
              • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
              • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
            • Scte35TimeSignalApos — (map) Scte35 Time Signal Apos
              • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
              • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
              • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
        • BlackoutSlate — (map) Settings for blackout slate.
          • BlackoutSlateImage — (map) Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
            • Username — (String) Documentation update needed
          • NetworkEndBlackout — (String) Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". Possible values include:
            • "DISABLED"
            • "ENABLED"
          • NetworkEndBlackoutImage — (map) Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
            • Username — (String) Documentation update needed
          • NetworkId — (String) Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
          • State — (String) When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata. Possible values include:
            • "DISABLED"
            • "ENABLED"
        • CaptionDescriptions — (Array<map>) Settings for caption decriptions
          • CaptionSelectorName — required — (String) Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
          • DestinationSettings — (map) Additional settings for captions destination that depend on the destination type.
            • AribDestinationSettings — (map) Arib Destination Settings
            • BurnInDestinationSettings — (map) Burn In Destination Settings
              • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "CENTERED"
                • "LEFT"
                • "SMART"
              • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
                • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                • Username — (String) Documentation update needed
              • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
              • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
              • FontSize — (String) When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
              • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
              • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
              • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
              • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
                • "FIXED"
                • "SCALED"
              • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
              • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
            • DvbSubDestinationSettings — (map) Dvb Sub Destination Settings
              • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "CENTERED"
                • "LEFT"
                • "SMART"
              • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
                • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                • Username — (String) Documentation update needed
              • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
              • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
              • FontSize — (String) When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
              • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
              • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
              • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
              • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
                • "FIXED"
                • "SCALED"
              • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
              • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
            • EmbeddedDestinationSettings — (map) Embedded Destination Settings
            • EmbeddedPlusScte20DestinationSettings — (map) Embedded Plus Scte20 Destination Settings
            • RtmpCaptionInfoDestinationSettings — (map) Rtmp Caption Info Destination Settings
            • Scte20PlusEmbeddedDestinationSettings — (map) Scte20 Plus Embedded Destination Settings
            • Scte27DestinationSettings — (map) Scte27 Destination Settings
            • SmpteTtDestinationSettings — (map) Smpte Tt Destination Settings
            • TeletextDestinationSettings — (map) Teletext Destination Settings
            • TtmlDestinationSettings — (map) Ttml Destination Settings
              • StyleControl — (String) When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. Possible values include:
                • "PASSTHROUGH"
                • "USE_CONFIGURED"
            • WebvttDestinationSettings — (map) Webvtt Destination Settings
          • LanguageCode — (String) ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
          • LanguageDescription — (String) Human readable information to indicate captions available for players (eg. English, or Spanish).
          • Name — required — (String) Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
        • GlobalConfiguration — (map) Configuration settings that apply to the event as a whole.
          • InitialAudioGain — (Integer) Value to set the initial audio gain for the Live Event.
          • InputEndAction — (String) Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). Possible values include:
            • "NONE"
            • "SWITCH_AND_LOOP_INPUTS"
          • InputLossBehavior — (map) Settings for system actions when input is lost.
            • BlackFrameMsec — (Integer) Documentation update needed
            • InputLossImageColor — (String) When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
            • InputLossImageSlate — (map) When input loss image type is "slate" these fields specify the parameters for accessing the slate.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • InputLossImageType — (String) Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. Possible values include:
              • "COLOR"
              • "SLATE"
            • RepeatFrameMsec — (Integer) Documentation update needed
          • OutputLockingMode — (String) Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. Possible values include:
            • "EPOCH_LOCKING"
            • "PIPELINE_LOCKING"
          • OutputTimingSource — (String) Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. Possible values include:
            • "INPUT_CLOCK"
            • "SYSTEM_CLOCK"
          • SupportLowFramerateInputs — (String) Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. Possible values include:
            • "DISABLED"
            • "ENABLED"
        • OutputGroups — required — (Array<map>) Placeholder documentation for __listOfOutputGroup
          • Name — (String) Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
          • OutputGroupSettings — required — (map) Settings associated with the output group.
            • ArchiveGroupSettings — (map) Archive Group Settings
              • Destination — required — (map) A directory and base filename where archive files should be written.
                • DestinationRefId — (String) Placeholder documentation for __string
              • RolloverInterval — (Integer) Number of seconds to write to archive file before closing and starting a new one.
            • FrameCaptureGroupSettings — (map) Frame Capture Group Settings
              • Destination — required — (map) The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
                • DestinationRefId — (String) Placeholder documentation for __string
            • HlsGroupSettings — (map) Hls Group Settings
              • AdMarkers — (Array<String>) Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
              • BaseUrlContent — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
              • BaseUrlManifest — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
              • CaptionLanguageMappings — (Array<map>) Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
                • CaptionChannel — required — (Integer) The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
                • LanguageCode — required — (String) Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
                • LanguageDescription — required — (String) Textual description of language
              • CaptionLanguageSetting — (String) Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest. Possible values include:
                • "INSERT"
                • "NONE"
                • "OMIT"
              • ClientCache — (String) When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • CodecSpecification — (String) Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. Possible values include:
                • "RFC_4281"
                • "RFC_6381"
              • ConstantIv — (String) For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
              • Destination — required — (map) A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
                • DestinationRefId — (String) Placeholder documentation for __string
              • DirectoryStructure — (String) Place segments in subdirectories. Possible values include:
                • "SINGLE_DIRECTORY"
                • "SUBDIRECTORY_PER_STREAM"
              • EncryptionType — (String) Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. Possible values include:
                • "AES128"
                • "SAMPLE_AES"
              • HlsCdnSettings — (map) Parameters that control interactions with the CDN.
                • HlsAkamaiSettings — (map) Hls Akamai Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. Possible values include:
                    • "CHUNKED"
                    • "NON_CHUNKED"
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                  • Salt — (String) Salt for authenticated Akamai.
                  • Token — (String) Token parameter for authenticated akamai. If not specified, gda is used.
                • HlsBasicPutSettings — (map) Hls Basic Put Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                • HlsMediaStoreSettings — (map) Hls Media Store Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • MediaStoreStorageClass — (String) When set to temporal, output files are stored in non-persistent memory for faster reading and writing. Possible values include:
                    • "TEMPORAL"
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                • HlsWebdavSettings — (map) Hls Webdav Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to WebDAV. Possible values include:
                    • "CHUNKED"
                    • "NON_CHUNKED"
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
              • IFrameOnlyPlaylists — (String) DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888" Possible values include:
                • "DISABLED"
                • "STANDARD"
              • IndexNSegments — (Integer) Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
              • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
                • "EMIT_OUTPUT"
                • "PAUSE_OUTPUT"
              • IvInManifest — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. Possible values include:
                • "EXCLUDE"
                • "INCLUDE"
              • IvSource — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. Possible values include:
                • "EXPLICIT"
                • "FOLLOWS_SEGMENT_NUMBER"
              • KeepSegments — (Integer) Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
              • KeyFormat — (String) The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
              • KeyFormatVersions — (String) Either a single positive integer version value or a slash delimited list of version values (1/2/3).
              • KeyProviderSettings — (map) The key provider settings.
                • StaticKeySettings — (map) Static Key Settings
                  • KeyProviderServer — (map) The URL of the license server used for protecting content.
                    • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                    • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                    • Username — (String) Documentation update needed
                  • StaticKeyValue — required — (String) Static key value as a 32 character hexadecimal string.
              • ManifestCompression — (String) When set to gzip, compresses HLS playlist. Possible values include:
                • "GZIP"
                • "NONE"
              • ManifestDurationFormat — (String) Indicates whether the output manifest should use floating point or integer values for segment duration. Possible values include:
                • "FLOATING_POINT"
                • "INTEGER"
              • MinSegmentLength — (Integer) When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
              • Mode — (String) If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. Possible values include:
                • "LIVE"
                • "VOD"
              • OutputSelection — (String) MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group. Possible values include:
                • "MANIFESTS_AND_SEGMENTS"
                • "SEGMENTS_ONLY"
              • ProgramDateTime — (String) Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset. Possible values include:
                • "EXCLUDE"
                • "INCLUDE"
              • ProgramDateTimePeriod — (Integer) Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
              • RedundantManifest — (String) ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • SegmentLength — (Integer) Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
              • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
                • "USE_INPUT_SEGMENTATION"
                • "USE_SEGMENT_DURATION"
              • SegmentsPerSubdirectory — (Integer) Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
              • StreamInfResolution — (String) Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. Possible values include:
                • "EXCLUDE"
                • "INCLUDE"
              • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
                • "NONE"
                • "PRIV"
                • "TDRL"
              • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
              • TimestampDeltaMilliseconds — (Integer) Provides an extra millisecond delta offset to fine tune the timestamps.
              • TsFileMode — (String) SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching. Possible values include:
                • "SEGMENTED_FILES"
                • "SINGLE_FILE"
            • MediaPackageGroupSettings — (map) Media Package Group Settings
              • Destination — required — (map) MediaPackage channel destination.
                • DestinationRefId — (String) Placeholder documentation for __string
            • MsSmoothGroupSettings — (map) Ms Smooth Group Settings
              • AcquisitionPointId — (String) The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
              • AudioOnlyTimecodeControl — (String) If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. Possible values include:
                • "PASSTHROUGH"
                • "USE_CONFIGURED_CLOCK"
              • CertificateMode — (String) If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. Possible values include:
                • "SELF_SIGNED"
                • "VERIFY_AUTHENTICITY"
              • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
              • Destination — required — (map) Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
                • DestinationRefId — (String) Placeholder documentation for __string
              • EventId — (String) MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
              • EventIdMode — (String) Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server. Possible values include:
                • "NO_EVENT_ID"
                • "USE_CONFIGURED"
                • "USE_TIMESTAMP"
              • EventStopBehavior — (String) When set to sendEos, send EOS signal to IIS server when stopping the event Possible values include:
                • "NONE"
                • "SEND_EOS"
              • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
              • FragmentLength — (Integer) Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
              • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
                • "EMIT_OUTPUT"
                • "PAUSE_OUTPUT"
              • NumRetries — (Integer) Number of retry attempts.
              • RestartDelay — (Integer) Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
              • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
                • "USE_INPUT_SEGMENTATION"
                • "USE_SEGMENT_DURATION"
              • SendDelayMs — (Integer) Number of milliseconds to delay the output from the second pipeline.
              • SparseTrackType — (String) If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs. Possible values include:
                • "NONE"
                • "SCTE_35"
              • StreamManifestBehavior — (String) When set to send, send stream manifest so publishing point doesn't start until all streams start. Possible values include:
                • "DO_NOT_SEND"
                • "SEND"
              • TimestampOffset — (String) Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
              • TimestampOffsetMode — (String) Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset Possible values include:
                • "USE_CONFIGURED_OFFSET"
                • "USE_EVENT_START_DATE"
            • RtmpGroupSettings — (map) Rtmp Group Settings
              • AuthenticationScheme — (String) Authentication scheme to use when connecting with CDN Possible values include:
                • "AKAMAI"
                • "COMMON"
              • CacheFullBehavior — (String) Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. Possible values include:
                • "DISCONNECT_IMMEDIATELY"
                • "WAIT_FOR_SERVER"
              • CacheLength — (Integer) Cache length, in seconds, is used to calculate buffer size.
              • CaptionData — (String) Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. Possible values include:
                • "ALL"
                • "FIELD1_608"
                • "FIELD1_AND_FIELD2_608"
              • InputLossAction — (String) Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. Possible values include:
                • "EMIT_OUTPUT"
                • "PAUSE_OUTPUT"
              • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
            • UdpGroupSettings — (map) Udp Group Settings
              • InputLossAction — (String) Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. Possible values include:
                • "DROP_PROGRAM"
                • "DROP_TS"
                • "EMIT_PROGRAM"
              • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
                • "NONE"
                • "PRIV"
                • "TDRL"
              • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
          • Outputs — required — (Array<map>) Placeholder documentation for __listOfOutput
            • AudioDescriptionNames — (Array<String>) The names of the AudioDescriptions used as audio sources for this output.
            • CaptionDescriptionNames — (Array<String>) The names of the CaptionDescriptions used as caption sources for this output.
            • OutputName — (String) The name used to identify an output.
            • OutputSettings — required — (map) Output type-specific settings.
              • ArchiveOutputSettings — (map) Archive Output Settings
                • ContainerSettings — required — (map) Settings specific to the container type of the file.
                  • M2tsSettings — (map) M2ts Settings
                    • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                      • "DROP"
                      • "ENCODE_SILENCE"
                    • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                      • "AUTO"
                      • "USE_CONFIGURED"
                    • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                    • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                    • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                      • "MULTIPLEX"
                      • "NONE"
                    • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                      • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                      • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                      • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                        • "SDT_FOLLOW"
                        • "SDT_FOLLOW_IF_PRESENT"
                        • "SDT_MANUAL"
                        • "SDT_NONE"
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                      • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                    • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                      • "VIDEO_AND_FIXED_INTERVALS"
                      • "VIDEO_INTERVAL"
                    • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                    • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                      • "VIDEO_AND_AUDIO_PIDS"
                      • "VIDEO_PID"
                    • EcmPid — (String) This field is unused and deprecated.
                    • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                      • "EXCLUDE"
                      • "INCLUDE"
                    • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                    • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                    • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                      • "CONFIGURED_PCR_PERIOD"
                      • "PCR_EVERY_PES_PACKET"
                    • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                    • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                    • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                      • "CBR"
                      • "VBR"
                    • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                      • "EBP"
                      • "EBP_LEGACY"
                      • "NONE"
                      • "PSI_SEGSTART"
                      • "RAI_ADAPT"
                      • "RAI_SEGSTART"
                    • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                      • "MAINTAIN_CADENCE"
                      • "RESET_CADENCE"
                    • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                    • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                      • "NO_PASSTHROUGH"
                      • "PASSTHROUGH"
                    • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                    • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                • Extension — (String) Output file extension. If excluded, this will be auto-selected from the container type.
                • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
              • FrameCaptureOutputSettings — (map) Frame Capture Output Settings
                • NameModifier — (String) Required if the output group contains more than one output. This modifier forms part of the output file name.
              • HlsOutputSettings — (map) Hls Output Settings
                • HlsSettings — required — (map) Settings regarding the underlying stream. These settings are different for audio-only outputs.
                  • AudioOnlyHlsSettings — (map) Audio Only Hls Settings
                    • AudioGroupId — (String) Specifies the group to which the audio Rendition belongs.
                    • AudioOnlyImage — (map) For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by file size * count * count..
                      • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                      • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                      • Username — (String) Documentation update needed
                    • AudioTrackType — (String) Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO Possible values include:
                      • "ALTERNATE_AUDIO_AUTO_SELECT"
                      • "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT"
                      • "ALTERNATE_AUDIO_NOT_AUTO_SELECT"
                      • "AUDIO_ONLY_VARIANT_STREAM"
                  • StandardHlsSettings — (map) Standard Hls Settings
                    • AudioRenditionSets — (String) List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
                    • M3u8Settings — required — (map) Settings information for the .m3u8 container
                      • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                      • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
                      • EcmPid — (String) This parameter is unused and deprecated.
                      • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                      • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                        • "CONFIGURED_PCR_PERIOD"
                        • "PCR_EVERY_PES_PACKET"
                      • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
                      • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
                      • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                      • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
                      • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                      • Scte35Behavior — (String) If set to passthrough, passes any SCTE-35 signals from the input source to this output. Possible values include:
                        • "NO_PASSTHROUGH"
                        • "PASSTHROUGH"
                      • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
                      • TimedMetadataBehavior — (String) When set to passthrough, timed metadata is passed through from input to output. Possible values include:
                        • "NO_PASSTHROUGH"
                        • "PASSTHROUGH"
                      • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                      • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
                • NameModifier — (String) String concatenated to the end of the destination filename. Accepts \"Format Identifiers\":#formatIdentifierParameters.
                • SegmentModifier — (String) String concatenated to end of segment filenames.
              • MediaPackageOutputSettings — (map) Media Package Output Settings
              • MsSmoothOutputSettings — (map) Ms Smooth Output Settings
                • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
              • RtmpOutputSettings — (map) Rtmp Output Settings
                • CertificateMode — (String) If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. Possible values include:
                  • "SELF_SIGNED"
                  • "VERIFY_AUTHENTICITY"
                • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
                • Destination — required — (map) The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
                  • DestinationRefId — (String) Placeholder documentation for __string
                • NumRetries — (Integer) Number of retry attempts.
              • UdpOutputSettings — (map) Udp Output Settings
                • BufferMsec — (Integer) UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
                • ContainerSettings — required — (map) Udp Container Settings
                  • M2tsSettings — (map) M2ts Settings
                    • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                      • "DROP"
                      • "ENCODE_SILENCE"
                    • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                      • "AUTO"
                      • "USE_CONFIGURED"
                    • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                    • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                    • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                      • "MULTIPLEX"
                      • "NONE"
                    • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                      • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                      • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                      • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                        • "SDT_FOLLOW"
                        • "SDT_FOLLOW_IF_PRESENT"
                        • "SDT_MANUAL"
                        • "SDT_NONE"
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                      • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                    • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                      • "VIDEO_AND_FIXED_INTERVALS"
                      • "VIDEO_INTERVAL"
                    • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                    • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                      • "VIDEO_AND_AUDIO_PIDS"
                      • "VIDEO_PID"
                    • EcmPid — (String) This field is unused and deprecated.
                    • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                      • "EXCLUDE"
                      • "INCLUDE"
                    • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                    • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                    • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                      • "CONFIGURED_PCR_PERIOD"
                      • "PCR_EVERY_PES_PACKET"
                    • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                    • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                    • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                      • "CBR"
                      • "VBR"
                    • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                      • "EBP"
                      • "EBP_LEGACY"
                      • "NONE"
                      • "PSI_SEGSTART"
                      • "RAI_ADAPT"
                      • "RAI_SEGSTART"
                    • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                      • "MAINTAIN_CADENCE"
                      • "RESET_CADENCE"
                    • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                    • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                      • "NO_PASSTHROUGH"
                      • "PASSTHROUGH"
                    • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                    • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                • Destination — required — (map) Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
                  • DestinationRefId — (String) Placeholder documentation for __string
                • FecOutputSettings — (map) Settings for enabling and adjusting Forward Error Correction on UDP outputs.
                  • ColumnDepth — (Integer) Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
                  • IncludeFec — (String) Enables column only or column and row based FEC Possible values include:
                    • "COLUMN"
                    • "COLUMN_AND_ROW"
                  • RowLength — (Integer) Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
            • VideoDescriptionName — (String) The name of the VideoDescription used as the source for this output.
        • TimecodeConfig — required — (map) Contains settings used to acquire and adjust timecode information from inputs.
          • Source — required — (String) Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. Possible values include:
            • "EMBEDDED"
            • "SYSTEMCLOCK"
            • "ZEROBASED"
          • SyncThreshold — (Integer) Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
        • VideoDescriptions — required — (Array<map>) Placeholder documentation for __listOfVideoDescription
          • CodecSettings — (map) Video codec settings.
            • FrameCaptureSettings — (map) Frame Capture Settings
              • CaptureInterval — required — (Integer) The frequency, in seconds, for capturing frames for inclusion in the output. For example, "10" means capture a frame every 10 seconds.
            • H264Settings — (map) H264 Settings
              • AdaptiveQuantization — (String) Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. Possible values include:
                • "HIGH"
                • "HIGHER"
                • "LOW"
                • "MAX"
                • "MEDIUM"
                • "OFF"
              • AfdSignaling — (String) Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. Possible values include:
                • "AUTO"
                • "FIXED"
                • "NONE"
              • Bitrate — (Integer) Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
              • BufFillPct — (Integer) Percentage of the buffer that should initially be filled (HRD buffer model).
              • BufSize — (Integer) Size of buffer (HRD buffer model) in bits/second.
              • ColorMetadata — (String) Includes colorspace metadata in the output. Possible values include:
                • "IGNORE"
                • "INSERT"
              • EntropyEncoding — (String) Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. Possible values include:
                • "CABAC"
                • "CAVLC"
              • FixedAfd — (String) Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. Possible values include:
                • "AFD_0000"
                • "AFD_0010"
                • "AFD_0011"
                • "AFD_0100"
                • "AFD_1000"
                • "AFD_1001"
                • "AFD_1010"
                • "AFD_1011"
                • "AFD_1101"
                • "AFD_1110"
                • "AFD_1111"
              • FlickerAq — (String) If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • FramerateControl — (String) This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. Possible values include:
                • "INITIALIZE_FROM_SOURCE"
                • "SPECIFIED"
              • FramerateDenominator — (Integer) Framerate denominator.
              • FramerateNumerator — (Integer) Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
              • GopBReference — (String) Documentation update needed Possible values include:
                • "DISABLED"
                • "ENABLED"
              • GopClosedCadence — (Integer) Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
              • GopNumBFrames — (Integer) Number of B-frames between reference frames.
              • GopSize — (Float) GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. Must be greater than zero.
              • GopSizeUnits — (String) Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. Possible values include:
                • "FRAMES"
                • "SECONDS"
              • Level — (String) H.264 Level. Possible values include:
                • "H264_LEVEL_1"
                • "H264_LEVEL_1_1"
                • "H264_LEVEL_1_2"
                • "H264_LEVEL_1_3"
                • "H264_LEVEL_2"
                • "H264_LEVEL_2_1"
                • "H264_LEVEL_2_2"
                • "H264_LEVEL_3"
                • "H264_LEVEL_3_1"
                • "H264_LEVEL_3_2"
                • "H264_LEVEL_4"
                • "H264_LEVEL_4_1"
                • "H264_LEVEL_4_2"
                • "H264_LEVEL_5"
                • "H264_LEVEL_5_1"
                • "H264_LEVEL_5_2"
                • "H264_LEVEL_AUTO"
              • LookAheadRateControl — (String) Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. Possible values include:
                • "HIGH"
                • "LOW"
                • "MEDIUM"
              • MaxBitrate — (Integer) For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
              • MinIInterval — (Integer) Only meaningful if sceneChangeDetect is set to enabled. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
              • NumRefFrames — (Integer) Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
              • ParControl — (String) This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. Possible values include:
                • "INITIALIZE_FROM_SOURCE"
                • "SPECIFIED"
              • ParDenominator — (Integer) Pixel Aspect Ratio denominator.
              • ParNumerator — (Integer) Pixel Aspect Ratio numerator.
              • Profile — (String) H.264 Profile. Possible values include:
                • "BASELINE"
                • "HIGH"
                • "HIGH_10BIT"
                • "HIGH_422"
                • "HIGH_422_10BIT"
                • "MAIN"
              • QvbrQualityLevel — (Integer) Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
              • RateControlMode — (String) Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Possible values include:
                • "CBR"
                • "QVBR"
                • "VBR"
              • ScanType — (String) Sets the scan type of the output to progressive or top-field-first interlaced. Possible values include:
                • "INTERLACED"
                • "PROGRESSIVE"
              • SceneChangeDetect — (String) Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • Slices — (Integer) Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
              • Softness — (Integer) Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
              • SpatialAq — (String) If set to enabled, adjust quantization within each frame based on spatial variation of content complexity. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • SubgopLength — (String) If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. Possible values include:
                • "DYNAMIC"
                • "FIXED"
              • Syntax — (String) Produces a bitstream compliant with SMPTE RP-2027. Possible values include:
                • "DEFAULT"
                • "RP2027"
              • TemporalAq — (String) If set to enabled, adjust quantization within each frame based on temporal variation of content complexity. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • TimecodeInsertion — (String) Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config Possible values include:
                • "DISABLED"
                • "PIC_TIMING_SEI"
          • Height — (Integer) Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
          • Name — required — (String) The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
          • RespondToAfd — (String) Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped. Possible values include:
            • "NONE"
            • "PASSTHROUGH"
            • "RESPOND"
          • ScalingBehavior — (String) STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. Possible values include:
            • "DEFAULT"
            • "STRETCH_TO_OUTPUT"
          • Sharpness — (Integer) Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
          • Width — (Integer) Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
      • Id — (String) The unique id of the channel.
      • InputAttachments — (Array<map>) List of input attachments for channel.
        • InputAttachmentName — (String) User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
        • InputId — (String) The ID of the input
        • InputSettings — (map) Settings of an input (caption selector, etc.)
          • AudioSelectors — (Array<map>) Used to select the audio stream to decode for inputs that have multiple available.
            • Name — required — (String) The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
            • SelectorSettings — (map) The audio selector settings.
              • AudioLanguageSelection — (map) Audio Language Selection
                • LanguageCode — required — (String) Selects a specific three-letter language code from within an audio source.
                • LanguageSelectionPolicy — (String) When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. Possible values include:
                  • "LOOSE"
                  • "STRICT"
              • AudioPidSelection — (map) Audio Pid Selection
                • Pid — required — (Integer) Selects a specific PID from within a source.
          • CaptionSelectors — (Array<map>) Used to select the caption input to use for inputs that have multiple available.
            • LanguageCode — (String) When specified this field indicates the three letter language code of the caption track to extract from the source.
            • Name — required — (String) Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
            • SelectorSettings — (map) Caption selector settings.
              • AribSourceSettings — (map) Arib Source Settings
              • DvbSubSourceSettings — (map) Dvb Sub Source Settings
                • Pid — (Integer) When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
              • EmbeddedSourceSettings — (map) Embedded Source Settings
                • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                  • "DISABLED"
                  • "UPCONVERT"
                • Scte20Detection — (String) Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. Possible values include:
                  • "AUTO"
                  • "OFF"
                • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
                • Source608TrackNumber — (Integer) This field is unused and deprecated.
              • Scte20SourceSettings — (map) Scte20 Source Settings
                • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                  • "DISABLED"
                  • "UPCONVERT"
                • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
              • Scte27SourceSettings — (map) Scte27 Source Settings
                • Pid — (Integer) The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
              • TeletextSourceSettings — (map) Teletext Source Settings
                • PageNumber — (String) Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
          • DeblockFilter — (String) Enable or disable the deblock filter when filtering. Possible values include:
            • "DISABLED"
            • "ENABLED"
          • DenoiseFilter — (String) Enable or disable the denoise filter when filtering. Possible values include:
            • "DISABLED"
            • "ENABLED"
          • FilterStrength — (Integer) Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
          • InputFilter — (String) Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type Possible values include:
            • "AUTO"
            • "DISABLED"
            • "FORCED"
          • NetworkInputSettings — (map) Input settings.
            • HlsInputSettings — (map) Specifies HLS input settings when the uri is for a HLS manifest.
              • Bandwidth — (Integer) When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
              • BufferSegments — (Integer) When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
              • Retries — (Integer) The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
              • RetryInterval — (Integer) The number of seconds between retries when an attempt to read a manifest or segment fails.
            • ServerValidation — (String) Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. Possible values include:
              • "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME"
              • "CHECK_CRYPTOGRAPHY_ONLY"
          • SourceEndBehavior — (String) Loop input if it is a file. This allows a file input to be streamed indefinitely. Possible values include:
            • "CONTINUE"
            • "LOOP"
          • VideoSelector — (map) Informs which video elementary stream to decode for input types that have multiple available.
            • ColorSpace — (String) Specifies the colorspace of an input. This setting works in tandem with colorSpaceConversion to determine if any conversion will be performed. Possible values include:
              • "FOLLOW"
              • "REC_601"
              • "REC_709"
            • ColorSpaceUsage — (String) Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. Possible values include:
              • "FALLBACK"
              • "FORCE"
            • SelectorSettings — (map) The video selector settings.
              • VideoSelectorPid — (map) Video Selector Pid
                • Pid — (Integer) Selects a specific PID from within a video source.
              • VideoSelectorProgramId — (map) Video Selector Program Id
                • ProgramId — (Integer) Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
      • InputSpecification — (map) Placeholder documentation for InputSpecification
        • Codec — (String) Input codec Possible values include:
          • "MPEG2"
          • "AVC"
          • "HEVC"
        • MaximumBitrate — (String) Maximum input bitrate, categorized coarsely Possible values include:
          • "MAX_10_MBPS"
          • "MAX_20_MBPS"
          • "MAX_50_MBPS"
        • Resolution — (String) Input resolution, categorized coarsely Possible values include:
          • "SD"
          • "HD"
          • "UHD"
      • LogLevel — (String) The log level being written to CloudWatch Logs. Possible values include:
        • "ERROR"
        • "WARNING"
        • "INFO"
        • "DEBUG"
        • "DISABLED"
      • Name — (String) The name of the channel. (user-mutable)
      • PipelinesRunningCount — (Integer) The number of currently healthy pipelines.
      • RoleArn — (String) The Amazon Resource Name (ARN) of the role assumed when running the Channel.
      • State — (String) Placeholder documentation for ChannelState Possible values include:
        • "CREATING"
        • "CREATE_FAILED"
        • "IDLE"
        • "STARTING"
        • "RUNNING"
        • "RECOVERING"
        • "STOPPING"
        • "DELETING"
        • "DELETED"
      • Tags — (map<String>) A collection of key-value pairs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteInput(params = {}, callback) ⇒ AWS.Request

Deletes the input end point

Service Reference:

Examples:

Calling the deleteInput operation

var params = {
  InputId: 'STRING_VALUE' /* required */
};
medialive.deleteInput(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • InputId — (String) Unique ID of the input

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteInputSecurityGroup(params = {}, callback) ⇒ AWS.Request

Deletes an Input Security Group

Service Reference:

Examples:

Calling the deleteInputSecurityGroup operation

var params = {
  InputSecurityGroupId: 'STRING_VALUE' /* required */
};
medialive.deleteInputSecurityGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • InputSecurityGroupId — (String) The Input Security Group to delete

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteReservation(params = {}, callback) ⇒ AWS.Request

Delete an expired reservation.

Service Reference:

Examples:

Calling the deleteReservation operation

var params = {
  ReservationId: 'STRING_VALUE' /* required */
};
medialive.deleteReservation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ReservationId — (String) Unique reservation ID, e.g. '1234567'

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
      • Count — (Integer) Number of reserved resources
      • CurrencyCode — (String) Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
      • Duration — (Integer) Lease duration, e.g. '12'
      • DurationUnits — (String) Units for duration, e.g. 'MONTHS' Possible values include:
        • "MONTHS"
      • End — (String) Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
      • FixedPrice — (Float) One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
      • Name — (String) User specified reservation name
      • OfferingDescription — (String) Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
      • OfferingId — (String) Unique offering ID, e.g. '87654321'
      • OfferingType — (String) Offering type, e.g. 'NO_UPFRONT' Possible values include:
        • "NO_UPFRONT"
      • Region — (String) AWS region, e.g. 'us-west-2'
      • ReservationId — (String) Unique reservation ID, e.g. '1234567'
      • ResourceSpecification — (map) Resource configuration details
        • ChannelClass — (String) Channel class, e.g. 'STANDARD' Possible values include:
          • "STANDARD"
          • "SINGLE_PIPELINE"
        • Codec — (String) Codec, e.g. 'AVC' Possible values include:
          • "MPEG2"
          • "AVC"
          • "HEVC"
          • "AUDIO"
        • MaximumBitrate — (String) Maximum bitrate, e.g. 'MAX_20_MBPS' Possible values include:
          • "MAX_10_MBPS"
          • "MAX_20_MBPS"
          • "MAX_50_MBPS"
        • MaximumFramerate — (String) Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only) Possible values include:
          • "MAX_30_FPS"
          • "MAX_60_FPS"
        • Resolution — (String) Resolution, e.g. 'HD' Possible values include:
          • "SD"
          • "HD"
          • "UHD"
        • ResourceType — (String) Resource type, 'INPUT', 'OUTPUT', or 'CHANNEL' Possible values include:
          • "INPUT"
          • "OUTPUT"
          • "CHANNEL"
        • SpecialFeature — (String) Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only) Possible values include:
          • "ADVANCED_AUDIO"
          • "AUDIO_NORMALIZATION"
        • VideoQuality — (String) Video quality, e.g. 'STANDARD' (Outputs only) Possible values include:
          • "STANDARD"
          • "ENHANCED"
          • "PREMIUM"
      • Start — (String) Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
      • State — (String) Current state of reservation, e.g. 'ACTIVE' Possible values include:
        • "ACTIVE"
        • "EXPIRED"
        • "CANCELED"
        • "DELETED"
      • Tags — (map<String>) A collection of key-value pairs
      • UsagePrice — (Float) Recurring usage charge for each reserved resource, e.g. '157.0'

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

deleteTags(params = {}, callback) ⇒ AWS.Request

Removes tags for a resource

Service Reference:

Examples:

Calling the deleteTags operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
medialive.deleteTags(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String) Placeholder documentation for __string
    • TagKeys — (Array<String>) An array of tag keys to delete

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeChannel(params = {}, callback) ⇒ AWS.Request

Gets details about a channel

Service Reference:

Examples:

Calling the describeChannel operation

var params = {
  ChannelId: 'STRING_VALUE' /* required */
};
medialive.describeChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ChannelId — (String) channel ID

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) The unique arn of the channel.
      • ChannelClass — (String) The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. Possible values include:
        • "STANDARD"
        • "SINGLE_PIPELINE"
      • Destinations — (Array<map>) A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
        • Id — (String) User-specified id. This is used in an output group or an output.
        • MediaPackageSettings — (Array<map>) Destination settings for a MediaPackage output; one destination for both encoders.
          • ChannelId — (String) ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
        • Settings — (Array<map>) Destination settings for a standard output; one destination for each redundant encoder.
          • PasswordParam — (String) key used to extract the password from EC2 Parameter store
          • StreamName — (String) Stream name for RTMP destinations (URLs of type rtmp://)
          • Url — (String) A URL specifying a destination
          • Username — (String) username for destination
      • EgressEndpoints — (Array<map>) The endpoints where outgoing connections initiate from
        • SourceIp — (String) Public IP of where a channel's output comes from
      • EncoderSettings — (map) Encoder Settings
        • AudioDescriptions — required — (Array<map>) Placeholder documentation for __listOfAudioDescription
          • AudioNormalizationSettings — (map) Advanced audio normalization settings.
            • Algorithm — (String) Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. Possible values include:
              • "ITU_1770_1"
              • "ITU_1770_2"
            • AlgorithmControl — (String) When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. Possible values include:
              • "CORRECT_AUDIO"
            • TargetLkfs — (Float) Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
          • AudioSelectorName — required — (String) The name of the AudioSelector used as the source for this AudioDescription.
          • AudioType — (String) Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. Possible values include:
            • "CLEAN_EFFECTS"
            • "HEARING_IMPAIRED"
            • "UNDEFINED"
            • "VISUAL_IMPAIRED_COMMENTARY"
          • AudioTypeControl — (String) Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. Possible values include:
            • "FOLLOW_INPUT"
            • "USE_CONFIGURED"
          • CodecSettings — (map) Audio codec settings.
            • AacSettings — (map) Aac Settings
              • Bitrate — (Float) Average bitrate in bits/second. Valid values depend on rate control mode and profile.
              • CodingMode — (String) Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. Possible values include:
                • "AD_RECEIVER_MIX"
                • "CODING_MODE_1_0"
                • "CODING_MODE_1_1"
                • "CODING_MODE_2_0"
                • "CODING_MODE_5_1"
              • InputType — (String) Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD. Possible values include:
                • "BROADCASTER_MIXED_AD"
                • "NORMAL"
              • Profile — (String) AAC Profile. Possible values include:
                • "HEV1"
                • "HEV2"
                • "LC"
              • RateControlMode — (String) Rate Control Mode. Possible values include:
                • "CBR"
                • "VBR"
              • RawFormat — (String) Sets LATM / LOAS AAC output for raw containers. Possible values include:
                • "LATM_LOAS"
                • "NONE"
              • SampleRate — (Float) Sample rate in Hz. Valid values depend on rate control mode and profile.
              • Spec — (String) Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. Possible values include:
                • "MPEG2"
                • "MPEG4"
              • VbrQuality — (String) VBR Quality Level - Only used if rateControlMode is VBR. Possible values include:
                • "HIGH"
                • "LOW"
                • "MEDIUM_HIGH"
                • "MEDIUM_LOW"
            • Ac3Settings — (map) Ac3 Settings
              • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
              • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. Possible values include:
                • "COMMENTARY"
                • "COMPLETE_MAIN"
                • "DIALOGUE"
                • "EMERGENCY"
                • "HEARING_IMPAIRED"
                • "MUSIC_AND_EFFECTS"
                • "VISUALLY_IMPAIRED"
                • "VOICE_OVER"
              • CodingMode — (String) Dolby Digital coding mode. Determines number of channels. Possible values include:
                • "CODING_MODE_1_0"
                • "CODING_MODE_1_1"
                • "CODING_MODE_2_0"
                • "CODING_MODE_3_2_LFE"
              • Dialnorm — (Integer) Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
              • DrcProfile — (String) If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. Possible values include:
                • "FILM_STANDARD"
                • "NONE"
              • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • MetadataControl — (String) When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
                • "FOLLOW_INPUT"
                • "USE_CONFIGURED"
            • Eac3Settings — (map) Eac3 Settings
              • AttenuationControl — (String) When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. Possible values include:
                • "ATTENUATE_3_DB"
                • "NONE"
              • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
              • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. Possible values include:
                • "COMMENTARY"
                • "COMPLETE_MAIN"
                • "EMERGENCY"
                • "HEARING_IMPAIRED"
                • "VISUALLY_IMPAIRED"
              • CodingMode — (String) Dolby Digital Plus coding mode. Determines number of channels. Possible values include:
                • "CODING_MODE_1_0"
                • "CODING_MODE_2_0"
                • "CODING_MODE_3_2"
              • DcFilter — (String) When set to enabled, activates a DC highpass filter for all input channels. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • Dialnorm — (Integer) Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
              • DrcLine — (String) Sets the Dolby dynamic range compression profile. Possible values include:
                • "FILM_LIGHT"
                • "FILM_STANDARD"
                • "MUSIC_LIGHT"
                • "MUSIC_STANDARD"
                • "NONE"
                • "SPEECH"
              • DrcRf — (String) Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. Possible values include:
                • "FILM_LIGHT"
                • "FILM_STANDARD"
                • "MUSIC_LIGHT"
                • "MUSIC_STANDARD"
                • "NONE"
                • "SPEECH"
              • LfeControl — (String) When encoding 3/2 audio, setting to lfe enables the LFE channel Possible values include:
                • "LFE"
                • "NO_LFE"
              • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • LoRoCenterMixLevel — (Float) Left only/Right only center mix level. Only used for 3/2 coding mode.
              • LoRoSurroundMixLevel — (Float) Left only/Right only surround mix level. Only used for 3/2 coding mode.
              • LtRtCenterMixLevel — (Float) Left total/Right total center mix level. Only used for 3/2 coding mode.
              • LtRtSurroundMixLevel — (Float) Left total/Right total surround mix level. Only used for 3/2 coding mode.
              • MetadataControl — (String) When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
                • "FOLLOW_INPUT"
                • "USE_CONFIGURED"
              • PassthroughControl — (String) When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding. Possible values include:
                • "NO_PASSTHROUGH"
                • "WHEN_POSSIBLE"
              • PhaseControl — (String) When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. Possible values include:
                • "NO_SHIFT"
                • "SHIFT_90_DEGREES"
              • StereoDownmix — (String) Stereo downmix preference. Only used for 3/2 coding mode. Possible values include:
                • "DPL2"
                • "LO_RO"
                • "LT_RT"
                • "NOT_INDICATED"
              • SurroundExMode — (String) When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. Possible values include:
                • "DISABLED"
                • "ENABLED"
                • "NOT_INDICATED"
              • SurroundMode — (String) When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. Possible values include:
                • "DISABLED"
                • "ENABLED"
                • "NOT_INDICATED"
            • Mp2Settings — (map) Mp2 Settings
              • Bitrate — (Float) Average bitrate in bits/second.
              • CodingMode — (String) The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). Possible values include:
                • "CODING_MODE_1_0"
                • "CODING_MODE_2_0"
              • SampleRate — (Float) Sample rate in Hz.
            • PassThroughSettings — (map) Pass Through Settings
          • LanguageCode — (String) Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
          • LanguageCodeControl — (String) Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. Possible values include:
            • "FOLLOW_INPUT"
            • "USE_CONFIGURED"
          • Name — required — (String) The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
          • RemixSettings — (map) Settings that control how input audio channels are remixed into the output audio channels.
            • ChannelMappings — required — (Array<map>) Mapping of input channels to output channels, with appropriate gain adjustments.
              • InputChannelLevels — required — (Array<map>) Indices and gain values for each input channel that should be remixed into this output channel.
                • Gain — required — (Integer) Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
                • InputChannel — required — (Integer) The index of the input channel used as a source.
              • OutputChannel — required — (Integer) The index of the output channel being produced.
            • ChannelsIn — (Integer) Number of input channels to be used.
            • ChannelsOut — (Integer) Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
          • StreamName — (String) Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
        • AvailBlanking — (map) Settings for ad avail blanking.
          • AvailBlankingImage — (map) Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
            • Username — (String) Documentation update needed
          • State — (String) When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added. Possible values include:
            • "DISABLED"
            • "ENABLED"
        • AvailConfiguration — (map) Event-wide configuration settings for ad avail insertion.
          • AvailSettings — (map) Ad avail settings.
            • Scte35SpliceInsert — (map) Scte35 Splice Insert
              • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
              • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
              • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
            • Scte35TimeSignalApos — (map) Scte35 Time Signal Apos
              • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
              • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
              • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
        • BlackoutSlate — (map) Settings for blackout slate.
          • BlackoutSlateImage — (map) Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
            • Username — (String) Documentation update needed
          • NetworkEndBlackout — (String) Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". Possible values include:
            • "DISABLED"
            • "ENABLED"
          • NetworkEndBlackoutImage — (map) Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
            • Username — (String) Documentation update needed
          • NetworkId — (String) Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
          • State — (String) When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata. Possible values include:
            • "DISABLED"
            • "ENABLED"
        • CaptionDescriptions — (Array<map>) Settings for caption decriptions
          • CaptionSelectorName — required — (String) Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
          • DestinationSettings — (map) Additional settings for captions destination that depend on the destination type.
            • AribDestinationSettings — (map) Arib Destination Settings
            • BurnInDestinationSettings — (map) Burn In Destination Settings
              • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "CENTERED"
                • "LEFT"
                • "SMART"
              • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
                • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                • Username — (String) Documentation update needed
              • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
              • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
              • FontSize — (String) When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
              • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
              • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
              • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
              • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
                • "FIXED"
                • "SCALED"
              • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
              • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
            • DvbSubDestinationSettings — (map) Dvb Sub Destination Settings
              • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "CENTERED"
                • "LEFT"
                • "SMART"
              • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
                • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                • Username — (String) Documentation update needed
              • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
              • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
              • FontSize — (String) When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
              • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
              • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
              • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
              • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
                • "FIXED"
                • "SCALED"
              • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
              • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
            • EmbeddedDestinationSettings — (map) Embedded Destination Settings
            • EmbeddedPlusScte20DestinationSettings — (map) Embedded Plus Scte20 Destination Settings
            • RtmpCaptionInfoDestinationSettings — (map) Rtmp Caption Info Destination Settings
            • Scte20PlusEmbeddedDestinationSettings — (map) Scte20 Plus Embedded Destination Settings
            • Scte27DestinationSettings — (map) Scte27 Destination Settings
            • SmpteTtDestinationSettings — (map) Smpte Tt Destination Settings
            • TeletextDestinationSettings — (map) Teletext Destination Settings
            • TtmlDestinationSettings — (map) Ttml Destination Settings
              • StyleControl — (String) When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. Possible values include:
                • "PASSTHROUGH"
                • "USE_CONFIGURED"
            • WebvttDestinationSettings — (map) Webvtt Destination Settings
          • LanguageCode — (String) ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
          • LanguageDescription — (String) Human readable information to indicate captions available for players (eg. English, or Spanish).
          • Name — required — (String) Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
        • GlobalConfiguration — (map) Configuration settings that apply to the event as a whole.
          • InitialAudioGain — (Integer) Value to set the initial audio gain for the Live Event.
          • InputEndAction — (String) Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). Possible values include:
            • "NONE"
            • "SWITCH_AND_LOOP_INPUTS"
          • InputLossBehavior — (map) Settings for system actions when input is lost.
            • BlackFrameMsec — (Integer) Documentation update needed
            • InputLossImageColor — (String) When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
            • InputLossImageSlate — (map) When input loss image type is "slate" these fields specify the parameters for accessing the slate.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • InputLossImageType — (String) Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. Possible values include:
              • "COLOR"
              • "SLATE"
            • RepeatFrameMsec — (Integer) Documentation update needed
          • OutputLockingMode — (String) Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. Possible values include:
            • "EPOCH_LOCKING"
            • "PIPELINE_LOCKING"
          • OutputTimingSource — (String) Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. Possible values include:
            • "INPUT_CLOCK"
            • "SYSTEM_CLOCK"
          • SupportLowFramerateInputs — (String) Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. Possible values include:
            • "DISABLED"
            • "ENABLED"
        • OutputGroups — required — (Array<map>) Placeholder documentation for __listOfOutputGroup
          • Name — (String) Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
          • OutputGroupSettings — required — (map) Settings associated with the output group.
            • ArchiveGroupSettings — (map) Archive Group Settings
              • Destination — required — (map) A directory and base filename where archive files should be written.
                • DestinationRefId — (String) Placeholder documentation for __string
              • RolloverInterval — (Integer) Number of seconds to write to archive file before closing and starting a new one.
            • FrameCaptureGroupSettings — (map) Frame Capture Group Settings
              • Destination — required — (map) The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
                • DestinationRefId — (String) Placeholder documentation for __string
            • HlsGroupSettings — (map) Hls Group Settings
              • AdMarkers — (Array<String>) Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
              • BaseUrlContent — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
              • BaseUrlManifest — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
              • CaptionLanguageMappings — (Array<map>) Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
                • CaptionChannel — required — (Integer) The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
                • LanguageCode — required — (String) Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
                • LanguageDescription — required — (String) Textual description of language
              • CaptionLanguageSetting — (String) Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest. Possible values include:
                • "INSERT"
                • "NONE"
                • "OMIT"
              • ClientCache — (String) When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • CodecSpecification — (String) Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. Possible values include:
                • "RFC_4281"
                • "RFC_6381"
              • ConstantIv — (String) For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
              • Destination — required — (map) A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
                • DestinationRefId — (String) Placeholder documentation for __string
              • DirectoryStructure — (String) Place segments in subdirectories. Possible values include:
                • "SINGLE_DIRECTORY"
                • "SUBDIRECTORY_PER_STREAM"
              • EncryptionType — (String) Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. Possible values include:
                • "AES128"
                • "SAMPLE_AES"
              • HlsCdnSettings — (map) Parameters that control interactions with the CDN.
                • HlsAkamaiSettings — (map) Hls Akamai Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. Possible values include:
                    • "CHUNKED"
                    • "NON_CHUNKED"
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                  • Salt — (String) Salt for authenticated Akamai.
                  • Token — (String) Token parameter for authenticated akamai. If not specified, gda is used.
                • HlsBasicPutSettings — (map) Hls Basic Put Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                • HlsMediaStoreSettings — (map) Hls Media Store Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • MediaStoreStorageClass — (String) When set to temporal, output files are stored in non-persistent memory for faster reading and writing. Possible values include:
                    • "TEMPORAL"
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                • HlsWebdavSettings — (map) Hls Webdav Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to WebDAV. Possible values include:
                    • "CHUNKED"
                    • "NON_CHUNKED"
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
              • IFrameOnlyPlaylists — (String) DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888" Possible values include:
                • "DISABLED"
                • "STANDARD"
              • IndexNSegments — (Integer) Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
              • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
                • "EMIT_OUTPUT"
                • "PAUSE_OUTPUT"
              • IvInManifest — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. Possible values include:
                • "EXCLUDE"
                • "INCLUDE"
              • IvSource — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. Possible values include:
                • "EXPLICIT"
                • "FOLLOWS_SEGMENT_NUMBER"
              • KeepSegments — (Integer) Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
              • KeyFormat — (String) The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
              • KeyFormatVersions — (String) Either a single positive integer version value or a slash delimited list of version values (1/2/3).
              • KeyProviderSettings — (map) The key provider settings.
                • StaticKeySettings — (map) Static Key Settings
                  • KeyProviderServer — (map) The URL of the license server used for protecting content.
                    • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                    • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                    • Username — (String) Documentation update needed
                  • StaticKeyValue — required — (String) Static key value as a 32 character hexadecimal string.
              • ManifestCompression — (String) When set to gzip, compresses HLS playlist. Possible values include:
                • "GZIP"
                • "NONE"
              • ManifestDurationFormat — (String) Indicates whether the output manifest should use floating point or integer values for segment duration. Possible values include:
                • "FLOATING_POINT"
                • "INTEGER"
              • MinSegmentLength — (Integer) When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
              • Mode — (String) If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. Possible values include:
                • "LIVE"
                • "VOD"
              • OutputSelection — (String) MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group. Possible values include:
                • "MANIFESTS_AND_SEGMENTS"
                • "SEGMENTS_ONLY"
              • ProgramDateTime — (String) Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset. Possible values include:
                • "EXCLUDE"
                • "INCLUDE"
              • ProgramDateTimePeriod — (Integer) Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
              • RedundantManifest — (String) ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • SegmentLength — (Integer) Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
              • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
                • "USE_INPUT_SEGMENTATION"
                • "USE_SEGMENT_DURATION"
              • SegmentsPerSubdirectory — (Integer) Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
              • StreamInfResolution — (String) Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. Possible values include:
                • "EXCLUDE"
                • "INCLUDE"
              • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
                • "NONE"
                • "PRIV"
                • "TDRL"
              • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
              • TimestampDeltaMilliseconds — (Integer) Provides an extra millisecond delta offset to fine tune the timestamps.
              • TsFileMode — (String) SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching. Possible values include:
                • "SEGMENTED_FILES"
                • "SINGLE_FILE"
            • MediaPackageGroupSettings — (map) Media Package Group Settings
              • Destination — required — (map) MediaPackage channel destination.
                • DestinationRefId — (String) Placeholder documentation for __string
            • MsSmoothGroupSettings — (map) Ms Smooth Group Settings
              • AcquisitionPointId — (String) The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
              • AudioOnlyTimecodeControl — (String) If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. Possible values include:
                • "PASSTHROUGH"
                • "USE_CONFIGURED_CLOCK"
              • CertificateMode — (String) If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. Possible values include:
                • "SELF_SIGNED"
                • "VERIFY_AUTHENTICITY"
              • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
              • Destination — required — (map) Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
                • DestinationRefId — (String) Placeholder documentation for __string
              • EventId — (String) MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
              • EventIdMode — (String) Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server. Possible values include:
                • "NO_EVENT_ID"
                • "USE_CONFIGURED"
                • "USE_TIMESTAMP"
              • EventStopBehavior — (String) When set to sendEos, send EOS signal to IIS server when stopping the event Possible values include:
                • "NONE"
                • "SEND_EOS"
              • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
              • FragmentLength — (Integer) Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
              • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
                • "EMIT_OUTPUT"
                • "PAUSE_OUTPUT"
              • NumRetries — (Integer) Number of retry attempts.
              • RestartDelay — (Integer) Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
              • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
                • "USE_INPUT_SEGMENTATION"
                • "USE_SEGMENT_DURATION"
              • SendDelayMs — (Integer) Number of milliseconds to delay the output from the second pipeline.
              • SparseTrackType — (String) If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs. Possible values include:
                • "NONE"
                • "SCTE_35"
              • StreamManifestBehavior — (String) When set to send, send stream manifest so publishing point doesn't start until all streams start. Possible values include:
                • "DO_NOT_SEND"
                • "SEND"
              • TimestampOffset — (String) Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
              • TimestampOffsetMode — (String) Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset Possible values include:
                • "USE_CONFIGURED_OFFSET"
                • "USE_EVENT_START_DATE"
            • RtmpGroupSettings — (map) Rtmp Group Settings
              • AuthenticationScheme — (String) Authentication scheme to use when connecting with CDN Possible values include:
                • "AKAMAI"
                • "COMMON"
              • CacheFullBehavior — (String) Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. Possible values include:
                • "DISCONNECT_IMMEDIATELY"
                • "WAIT_FOR_SERVER"
              • CacheLength — (Integer) Cache length, in seconds, is used to calculate buffer size.
              • CaptionData — (String) Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. Possible values include:
                • "ALL"
                • "FIELD1_608"
                • "FIELD1_AND_FIELD2_608"
              • InputLossAction — (String) Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. Possible values include:
                • "EMIT_OUTPUT"
                • "PAUSE_OUTPUT"
              • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
            • UdpGroupSettings — (map) Udp Group Settings
              • InputLossAction — (String) Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. Possible values include:
                • "DROP_PROGRAM"
                • "DROP_TS"
                • "EMIT_PROGRAM"
              • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
                • "NONE"
                • "PRIV"
                • "TDRL"
              • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
          • Outputs — required — (Array<map>) Placeholder documentation for __listOfOutput
            • AudioDescriptionNames — (Array<String>) The names of the AudioDescriptions used as audio sources for this output.
            • CaptionDescriptionNames — (Array<String>) The names of the CaptionDescriptions used as caption sources for this output.
            • OutputName — (String) The name used to identify an output.
            • OutputSettings — required — (map) Output type-specific settings.
              • ArchiveOutputSettings — (map) Archive Output Settings
                • ContainerSettings — required — (map) Settings specific to the container type of the file.
                  • M2tsSettings — (map) M2ts Settings
                    • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                      • "DROP"
                      • "ENCODE_SILENCE"
                    • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                      • "AUTO"
                      • "USE_CONFIGURED"
                    • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                    • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                    • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                      • "MULTIPLEX"
                      • "NONE"
                    • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                      • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                      • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                      • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                        • "SDT_FOLLOW"
                        • "SDT_FOLLOW_IF_PRESENT"
                        • "SDT_MANUAL"
                        • "SDT_NONE"
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                      • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                    • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                      • "VIDEO_AND_FIXED_INTERVALS"
                      • "VIDEO_INTERVAL"
                    • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                    • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                      • "VIDEO_AND_AUDIO_PIDS"
                      • "VIDEO_PID"
                    • EcmPid — (String) This field is unused and deprecated.
                    • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                      • "EXCLUDE"
                      • "INCLUDE"
                    • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                    • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                    • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                      • "CONFIGURED_PCR_PERIOD"
                      • "PCR_EVERY_PES_PACKET"
                    • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                    • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                    • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                      • "CBR"
                      • "VBR"
                    • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                      • "EBP"
                      • "EBP_LEGACY"
                      • "NONE"
                      • "PSI_SEGSTART"
                      • "RAI_ADAPT"
                      • "RAI_SEGSTART"
                    • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                      • "MAINTAIN_CADENCE"
                      • "RESET_CADENCE"
                    • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                    • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                      • "NO_PASSTHROUGH"
                      • "PASSTHROUGH"
                    • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                    • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                • Extension — (String) Output file extension. If excluded, this will be auto-selected from the container type.
                • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
              • FrameCaptureOutputSettings — (map) Frame Capture Output Settings
                • NameModifier — (String) Required if the output group contains more than one output. This modifier forms part of the output file name.
              • HlsOutputSettings — (map) Hls Output Settings
                • HlsSettings — required — (map) Settings regarding the underlying stream. These settings are different for audio-only outputs.
                  • AudioOnlyHlsSettings — (map) Audio Only Hls Settings
                    • AudioGroupId — (String) Specifies the group to which the audio Rendition belongs.
                    • AudioOnlyImage — (map) For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by file size * count * count..
                      • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                      • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                      • Username — (String) Documentation update needed
                    • AudioTrackType — (String) Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO Possible values include:
                      • "ALTERNATE_AUDIO_AUTO_SELECT"
                      • "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT"
                      • "ALTERNATE_AUDIO_NOT_AUTO_SELECT"
                      • "AUDIO_ONLY_VARIANT_STREAM"
                  • StandardHlsSettings — (map) Standard Hls Settings
                    • AudioRenditionSets — (String) List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
                    • M3u8Settings — required — (map) Settings information for the .m3u8 container
                      • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                      • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
                      • EcmPid — (String) This parameter is unused and deprecated.
                      • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                      • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                        • "CONFIGURED_PCR_PERIOD"
                        • "PCR_EVERY_PES_PACKET"
                      • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
                      • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
                      • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                      • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
                      • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                      • Scte35Behavior — (String) If set to passthrough, passes any SCTE-35 signals from the input source to this output. Possible values include:
                        • "NO_PASSTHROUGH"
                        • "PASSTHROUGH"
                      • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
                      • TimedMetadataBehavior — (String) When set to passthrough, timed metadata is passed through from input to output. Possible values include:
                        • "NO_PASSTHROUGH"
                        • "PASSTHROUGH"
                      • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                      • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
                • NameModifier — (String) String concatenated to the end of the destination filename. Accepts \"Format Identifiers\":#formatIdentifierParameters.
                • SegmentModifier — (String) String concatenated to end of segment filenames.
              • MediaPackageOutputSettings — (map) Media Package Output Settings
              • MsSmoothOutputSettings — (map) Ms Smooth Output Settings
                • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
              • RtmpOutputSettings — (map) Rtmp Output Settings
                • CertificateMode — (String) If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. Possible values include:
                  • "SELF_SIGNED"
                  • "VERIFY_AUTHENTICITY"
                • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
                • Destination — required — (map) The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
                  • DestinationRefId — (String) Placeholder documentation for __string
                • NumRetries — (Integer) Number of retry attempts.
              • UdpOutputSettings — (map) Udp Output Settings
                • BufferMsec — (Integer) UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
                • ContainerSettings — required — (map) Udp Container Settings
                  • M2tsSettings — (map) M2ts Settings
                    • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                      • "DROP"
                      • "ENCODE_SILENCE"
                    • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                      • "AUTO"
                      • "USE_CONFIGURED"
                    • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                    • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                    • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                      • "MULTIPLEX"
                      • "NONE"
                    • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                      • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                      • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                      • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                        • "SDT_FOLLOW"
                        • "SDT_FOLLOW_IF_PRESENT"
                        • "SDT_MANUAL"
                        • "SDT_NONE"
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                      • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                    • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                      • "VIDEO_AND_FIXED_INTERVALS"
                      • "VIDEO_INTERVAL"
                    • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                    • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                      • "VIDEO_AND_AUDIO_PIDS"
                      • "VIDEO_PID"
                    • EcmPid — (String) This field is unused and deprecated.
                    • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                      • "EXCLUDE"
                      • "INCLUDE"
                    • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                    • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                    • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                      • "CONFIGURED_PCR_PERIOD"
                      • "PCR_EVERY_PES_PACKET"
                    • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                    • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                    • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                      • "CBR"
                      • "VBR"
                    • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                      • "EBP"
                      • "EBP_LEGACY"
                      • "NONE"
                      • "PSI_SEGSTART"
                      • "RAI_ADAPT"
                      • "RAI_SEGSTART"
                    • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                      • "MAINTAIN_CADENCE"
                      • "RESET_CADENCE"
                    • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                    • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                      • "NO_PASSTHROUGH"
                      • "PASSTHROUGH"
                    • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                    • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                • Destination — required — (map) Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
                  • DestinationRefId — (String) Placeholder documentation for __string
                • FecOutputSettings — (map) Settings for enabling and adjusting Forward Error Correction on UDP outputs.
                  • ColumnDepth — (Integer) Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
                  • IncludeFec — (String) Enables column only or column and row based FEC Possible values include:
                    • "COLUMN"
                    • "COLUMN_AND_ROW"
                  • RowLength — (Integer) Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
            • VideoDescriptionName — (String) The name of the VideoDescription used as the source for this output.
        • TimecodeConfig — required — (map) Contains settings used to acquire and adjust timecode information from inputs.
          • Source — required — (String) Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. Possible values include:
            • "EMBEDDED"
            • "SYSTEMCLOCK"
            • "ZEROBASED"
          • SyncThreshold — (Integer) Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
        • VideoDescriptions — required — (Array<map>) Placeholder documentation for __listOfVideoDescription
          • CodecSettings — (map) Video codec settings.
            • FrameCaptureSettings — (map) Frame Capture Settings
              • CaptureInterval — required — (Integer) The frequency, in seconds, for capturing frames for inclusion in the output. For example, "10" means capture a frame every 10 seconds.
            • H264Settings — (map) H264 Settings
              • AdaptiveQuantization — (String) Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. Possible values include:
                • "HIGH"
                • "HIGHER"
                • "LOW"
                • "MAX"
                • "MEDIUM"
                • "OFF"
              • AfdSignaling — (String) Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. Possible values include:
                • "AUTO"
                • "FIXED"
                • "NONE"
              • Bitrate — (Integer) Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
              • BufFillPct — (Integer) Percentage of the buffer that should initially be filled (HRD buffer model).
              • BufSize — (Integer) Size of buffer (HRD buffer model) in bits/second.
              • ColorMetadata — (String) Includes colorspace metadata in the output. Possible values include:
                • "IGNORE"
                • "INSERT"
              • EntropyEncoding — (String) Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. Possible values include:
                • "CABAC"
                • "CAVLC"
              • FixedAfd — (String) Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. Possible values include:
                • "AFD_0000"
                • "AFD_0010"
                • "AFD_0011"
                • "AFD_0100"
                • "AFD_1000"
                • "AFD_1001"
                • "AFD_1010"
                • "AFD_1011"
                • "AFD_1101"
                • "AFD_1110"
                • "AFD_1111"
              • FlickerAq — (String) If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • FramerateControl — (String) This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. Possible values include:
                • "INITIALIZE_FROM_SOURCE"
                • "SPECIFIED"
              • FramerateDenominator — (Integer) Framerate denominator.
              • FramerateNumerator — (Integer) Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
              • GopBReference — (String) Documentation update needed Possible values include:
                • "DISABLED"
                • "ENABLED"
              • GopClosedCadence — (Integer) Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
              • GopNumBFrames — (Integer) Number of B-frames between reference frames.
              • GopSize — (Float) GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. Must be greater than zero.
              • GopSizeUnits — (String) Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. Possible values include:
                • "FRAMES"
                • "SECONDS"
              • Level — (String) H.264 Level. Possible values include:
                • "H264_LEVEL_1"
                • "H264_LEVEL_1_1"
                • "H264_LEVEL_1_2"
                • "H264_LEVEL_1_3"
                • "H264_LEVEL_2"
                • "H264_LEVEL_2_1"
                • "H264_LEVEL_2_2"
                • "H264_LEVEL_3"
                • "H264_LEVEL_3_1"
                • "H264_LEVEL_3_2"
                • "H264_LEVEL_4"
                • "H264_LEVEL_4_1"
                • "H264_LEVEL_4_2"
                • "H264_LEVEL_5"
                • "H264_LEVEL_5_1"
                • "H264_LEVEL_5_2"
                • "H264_LEVEL_AUTO"
              • LookAheadRateControl — (String) Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. Possible values include:
                • "HIGH"
                • "LOW"
                • "MEDIUM"
              • MaxBitrate — (Integer) For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
              • MinIInterval — (Integer) Only meaningful if sceneChangeDetect is set to enabled. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
              • NumRefFrames — (Integer) Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
              • ParControl — (String) This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. Possible values include:
                • "INITIALIZE_FROM_SOURCE"
                • "SPECIFIED"
              • ParDenominator — (Integer) Pixel Aspect Ratio denominator.
              • ParNumerator — (Integer) Pixel Aspect Ratio numerator.
              • Profile — (String) H.264 Profile. Possible values include:
                • "BASELINE"
                • "HIGH"
                • "HIGH_10BIT"
                • "HIGH_422"
                • "HIGH_422_10BIT"
                • "MAIN"
              • QvbrQualityLevel — (Integer) Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
              • RateControlMode — (String) Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Possible values include:
                • "CBR"
                • "QVBR"
                • "VBR"
              • ScanType — (String) Sets the scan type of the output to progressive or top-field-first interlaced. Possible values include:
                • "INTERLACED"
                • "PROGRESSIVE"
              • SceneChangeDetect — (String) Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • Slices — (Integer) Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
              • Softness — (Integer) Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
              • SpatialAq — (String) If set to enabled, adjust quantization within each frame based on spatial variation of content complexity. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • SubgopLength — (String) If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. Possible values include:
                • "DYNAMIC"
                • "FIXED"
              • Syntax — (String) Produces a bitstream compliant with SMPTE RP-2027. Possible values include:
                • "DEFAULT"
                • "RP2027"
              • TemporalAq — (String) If set to enabled, adjust quantization within each frame based on temporal variation of content complexity. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • TimecodeInsertion — (String) Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config Possible values include:
                • "DISABLED"
                • "PIC_TIMING_SEI"
          • Height — (Integer) Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
          • Name — required — (String) The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
          • RespondToAfd — (String) Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped. Possible values include:
            • "NONE"
            • "PASSTHROUGH"
            • "RESPOND"
          • ScalingBehavior — (String) STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. Possible values include:
            • "DEFAULT"
            • "STRETCH_TO_OUTPUT"
          • Sharpness — (Integer) Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
          • Width — (Integer) Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
      • Id — (String) The unique id of the channel.
      • InputAttachments — (Array<map>) List of input attachments for channel.
        • InputAttachmentName — (String) User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
        • InputId — (String) The ID of the input
        • InputSettings — (map) Settings of an input (caption selector, etc.)
          • AudioSelectors — (Array<map>) Used to select the audio stream to decode for inputs that have multiple available.
            • Name — required — (String) The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
            • SelectorSettings — (map) The audio selector settings.
              • AudioLanguageSelection — (map) Audio Language Selection
                • LanguageCode — required — (String) Selects a specific three-letter language code from within an audio source.
                • LanguageSelectionPolicy — (String) When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. Possible values include:
                  • "LOOSE"
                  • "STRICT"
              • AudioPidSelection — (map) Audio Pid Selection
                • Pid — required — (Integer) Selects a specific PID from within a source.
          • CaptionSelectors — (Array<map>) Used to select the caption input to use for inputs that have multiple available.
            • LanguageCode — (String) When specified this field indicates the three letter language code of the caption track to extract from the source.
            • Name — required — (String) Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
            • SelectorSettings — (map) Caption selector settings.
              • AribSourceSettings — (map) Arib Source Settings
              • DvbSubSourceSettings — (map) Dvb Sub Source Settings
                • Pid — (Integer) When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
              • EmbeddedSourceSettings — (map) Embedded Source Settings
                • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                  • "DISABLED"
                  • "UPCONVERT"
                • Scte20Detection — (String) Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. Possible values include:
                  • "AUTO"
                  • "OFF"
                • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
                • Source608TrackNumber — (Integer) This field is unused and deprecated.
              • Scte20SourceSettings — (map) Scte20 Source Settings
                • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                  • "DISABLED"
                  • "UPCONVERT"
                • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
              • Scte27SourceSettings — (map) Scte27 Source Settings
                • Pid — (Integer) The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
              • TeletextSourceSettings — (map) Teletext Source Settings
                • PageNumber — (String) Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
          • DeblockFilter — (String) Enable or disable the deblock filter when filtering. Possible values include:
            • "DISABLED"
            • "ENABLED"
          • DenoiseFilter — (String) Enable or disable the denoise filter when filtering. Possible values include:
            • "DISABLED"
            • "ENABLED"
          • FilterStrength — (Integer) Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
          • InputFilter — (String) Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type Possible values include:
            • "AUTO"
            • "DISABLED"
            • "FORCED"
          • NetworkInputSettings — (map) Input settings.
            • HlsInputSettings — (map) Specifies HLS input settings when the uri is for a HLS manifest.
              • Bandwidth — (Integer) When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
              • BufferSegments — (Integer) When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
              • Retries — (Integer) The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
              • RetryInterval — (Integer) The number of seconds between retries when an attempt to read a manifest or segment fails.
            • ServerValidation — (String) Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. Possible values include:
              • "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME"
              • "CHECK_CRYPTOGRAPHY_ONLY"
          • SourceEndBehavior — (String) Loop input if it is a file. This allows a file input to be streamed indefinitely. Possible values include:
            • "CONTINUE"
            • "LOOP"
          • VideoSelector — (map) Informs which video elementary stream to decode for input types that have multiple available.
            • ColorSpace — (String) Specifies the colorspace of an input. This setting works in tandem with colorSpaceConversion to determine if any conversion will be performed. Possible values include:
              • "FOLLOW"
              • "REC_601"
              • "REC_709"
            • ColorSpaceUsage — (String) Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. Possible values include:
              • "FALLBACK"
              • "FORCE"
            • SelectorSettings — (map) The video selector settings.
              • VideoSelectorPid — (map) Video Selector Pid
                • Pid — (Integer) Selects a specific PID from within a video source.
              • VideoSelectorProgramId — (map) Video Selector Program Id
                • ProgramId — (Integer) Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
      • InputSpecification — (map) Placeholder documentation for InputSpecification
        • Codec — (String) Input codec Possible values include:
          • "MPEG2"
          • "AVC"
          • "HEVC"
        • MaximumBitrate — (String) Maximum input bitrate, categorized coarsely Possible values include:
          • "MAX_10_MBPS"
          • "MAX_20_MBPS"
          • "MAX_50_MBPS"
        • Resolution — (String) Input resolution, categorized coarsely Possible values include:
          • "SD"
          • "HD"
          • "UHD"
      • LogLevel — (String) The log level being written to CloudWatch Logs. Possible values include:
        • "ERROR"
        • "WARNING"
        • "INFO"
        • "DEBUG"
        • "DISABLED"
      • Name — (String) The name of the channel. (user-mutable)
      • PipelinesRunningCount — (Integer) The number of currently healthy pipelines.
      • RoleArn — (String) The Amazon Resource Name (ARN) of the role assumed when running the Channel.
      • State — (String) Placeholder documentation for ChannelState Possible values include:
        • "CREATING"
        • "CREATE_FAILED"
        • "IDLE"
        • "STARTING"
        • "RUNNING"
        • "RECOVERING"
        • "STOPPING"
        • "DELETING"
        • "DELETED"
      • Tags — (map<String>) A collection of key-value pairs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeInput(params = {}, callback) ⇒ AWS.Request

Produces details about an input

Service Reference:

Examples:

Calling the describeInput operation

var params = {
  InputId: 'STRING_VALUE' /* required */
};
medialive.describeInput(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • InputId — (String) Unique ID of the input

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) The Unique ARN of the input (generated, immutable).
      • AttachedChannels — (Array<String>) A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).
      • Destinations — (Array<map>) A list of the destinations of the input (PUSH-type).
        • Ip — (String) The system-generated static IP address of endpoint. It remains fixed for the lifetime of the input.
        • Port — (String) The port number for the input.
        • Url — (String) This represents the endpoint that the customer stream will be pushed to.
        • Vpc — (map) The properties for a VPC type input destination.
          • AvailabilityZone — (String) The availability zone of the Input destination.
          • NetworkInterfaceId — (String) The network interface ID of the Input destination in the VPC.
      • Id — (String) The generated ID of the input (unique for user account, immutable).
      • InputClass — (String) STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input. Possible values include:
        • "STANDARD"
        • "SINGLE_PIPELINE"
      • MediaConnectFlows — (Array<map>) A list of MediaConnect Flows for this input.
        • FlowArn — (String) The unique ARN of the MediaConnect Flow being used as a source.
      • Name — (String) The user-assigned name (This is a mutable value).
      • RoleArn — (String) The Amazon Resource Name (ARN) of the role this input assumes during and after creation.
      • SecurityGroups — (Array<String>) A list of IDs for all the Input Security Groups attached to the input.
      • Sources — (Array<map>) A list of the sources of the input (PULL-type).
        • PasswordParam — (String) The key used to extract the password from EC2 Parameter store.
        • Url — (String) This represents the customer's source URL where stream is pulled from.
        • Username — (String) The username for the input source.
      • State — (String) Placeholder documentation for InputState Possible values include:
        • "CREATING"
        • "DETACHED"
        • "ATTACHED"
        • "DELETING"
        • "DELETED"
      • Tags — (map<String>) A collection of key-value pairs.
      • Type — (String) Placeholder documentation for InputType Possible values include:
        • "UDP_PUSH"
        • "RTP_PUSH"
        • "RTMP_PUSH"
        • "RTMP_PULL"
        • "URL_PULL"
        • "MP4_FILE"
        • "MEDIACONNECT"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeInputSecurityGroup(params = {}, callback) ⇒ AWS.Request

Produces a summary of an Input Security Group

Service Reference:

Examples:

Calling the describeInputSecurityGroup operation

var params = {
  InputSecurityGroupId: 'STRING_VALUE' /* required */
};
medialive.describeInputSecurityGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • InputSecurityGroupId — (String) The id of the Input Security Group to describe

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) Unique ARN of Input Security Group
      • Id — (String) The Id of the Input Security Group
      • Inputs — (Array<String>) The list of inputs currently using this Input Security Group.
      • State — (String) The current state of the Input Security Group. Possible values include:
        • "IDLE"
        • "IN_USE"
        • "UPDATING"
        • "DELETED"
      • Tags — (map<String>) A collection of key-value pairs.
      • WhitelistRules — (Array<map>) Whitelist rules and their sync status
        • Cidr — (String) The IPv4 CIDR that's whitelisted.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeOffering(params = {}, callback) ⇒ AWS.Request

Get details for an offering.

Service Reference:

Examples:

Calling the describeOffering operation

var params = {
  OfferingId: 'STRING_VALUE' /* required */
};
medialive.describeOffering(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • OfferingId — (String) Unique offering ID, e.g. '87654321'

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'
      • CurrencyCode — (String) Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
      • Duration — (Integer) Lease duration, e.g. '12'
      • DurationUnits — (String) Units for duration, e.g. 'MONTHS' Possible values include:
        • "MONTHS"
      • FixedPrice — (Float) One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
      • OfferingDescription — (String) Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
      • OfferingId — (String) Unique offering ID, e.g. '87654321'
      • OfferingType — (String) Offering type, e.g. 'NO_UPFRONT' Possible values include:
        • "NO_UPFRONT"
      • Region — (String) AWS region, e.g. 'us-west-2'
      • ResourceSpecification — (map) Resource configuration details
        • ChannelClass — (String) Channel class, e.g. 'STANDARD' Possible values include:
          • "STANDARD"
          • "SINGLE_PIPELINE"
        • Codec — (String) Codec, e.g. 'AVC' Possible values include:
          • "MPEG2"
          • "AVC"
          • "HEVC"
          • "AUDIO"
        • MaximumBitrate — (String) Maximum bitrate, e.g. 'MAX_20_MBPS' Possible values include:
          • "MAX_10_MBPS"
          • "MAX_20_MBPS"
          • "MAX_50_MBPS"
        • MaximumFramerate — (String) Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only) Possible values include:
          • "MAX_30_FPS"
          • "MAX_60_FPS"
        • Resolution — (String) Resolution, e.g. 'HD' Possible values include:
          • "SD"
          • "HD"
          • "UHD"
        • ResourceType — (String) Resource type, 'INPUT', 'OUTPUT', or 'CHANNEL' Possible values include:
          • "INPUT"
          • "OUTPUT"
          • "CHANNEL"
        • SpecialFeature — (String) Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only) Possible values include:
          • "ADVANCED_AUDIO"
          • "AUDIO_NORMALIZATION"
        • VideoQuality — (String) Video quality, e.g. 'STANDARD' (Outputs only) Possible values include:
          • "STANDARD"
          • "ENHANCED"
          • "PREMIUM"
      • UsagePrice — (Float) Recurring usage charge for each reserved resource, e.g. '157.0'

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeReservation(params = {}, callback) ⇒ AWS.Request

Get details for a reservation.

Service Reference:

Examples:

Calling the describeReservation operation

var params = {
  ReservationId: 'STRING_VALUE' /* required */
};
medialive.describeReservation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ReservationId — (String) Unique reservation ID, e.g. '1234567'

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
      • Count — (Integer) Number of reserved resources
      • CurrencyCode — (String) Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
      • Duration — (Integer) Lease duration, e.g. '12'
      • DurationUnits — (String) Units for duration, e.g. 'MONTHS' Possible values include:
        • "MONTHS"
      • End — (String) Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
      • FixedPrice — (Float) One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
      • Name — (String) User specified reservation name
      • OfferingDescription — (String) Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
      • OfferingId — (String) Unique offering ID, e.g. '87654321'
      • OfferingType — (String) Offering type, e.g. 'NO_UPFRONT' Possible values include:
        • "NO_UPFRONT"
      • Region — (String) AWS region, e.g. 'us-west-2'
      • ReservationId — (String) Unique reservation ID, e.g. '1234567'
      • ResourceSpecification — (map) Resource configuration details
        • ChannelClass — (String) Channel class, e.g. 'STANDARD' Possible values include:
          • "STANDARD"
          • "SINGLE_PIPELINE"
        • Codec — (String) Codec, e.g. 'AVC' Possible values include:
          • "MPEG2"
          • "AVC"
          • "HEVC"
          • "AUDIO"
        • MaximumBitrate — (String) Maximum bitrate, e.g. 'MAX_20_MBPS' Possible values include:
          • "MAX_10_MBPS"
          • "MAX_20_MBPS"
          • "MAX_50_MBPS"
        • MaximumFramerate — (String) Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only) Possible values include:
          • "MAX_30_FPS"
          • "MAX_60_FPS"
        • Resolution — (String) Resolution, e.g. 'HD' Possible values include:
          • "SD"
          • "HD"
          • "UHD"
        • ResourceType — (String) Resource type, 'INPUT', 'OUTPUT', or 'CHANNEL' Possible values include:
          • "INPUT"
          • "OUTPUT"
          • "CHANNEL"
        • SpecialFeature — (String) Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only) Possible values include:
          • "ADVANCED_AUDIO"
          • "AUDIO_NORMALIZATION"
        • VideoQuality — (String) Video quality, e.g. 'STANDARD' (Outputs only) Possible values include:
          • "STANDARD"
          • "ENHANCED"
          • "PREMIUM"
      • Start — (String) Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
      • State — (String) Current state of reservation, e.g. 'ACTIVE' Possible values include:
        • "ACTIVE"
        • "EXPIRED"
        • "CANCELED"
        • "DELETED"
      • Tags — (map<String>) A collection of key-value pairs
      • UsagePrice — (Float) Recurring usage charge for each reserved resource, e.g. '157.0'

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeSchedule(params = {}, callback) ⇒ AWS.Request

Get a channel schedule

Service Reference:

Examples:

Calling the describeSchedule operation

var params = {
  ChannelId: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
medialive.describeSchedule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ChannelId — (String) Id of the channel whose schedule is being updated.
    • MaxResults — (Integer) Placeholder documentation for MaxResults
    • NextToken — (String) Placeholder documentation for __string

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String) The next token; for use in pagination.
      • ScheduleActions — (Array<map>) The list of actions in the schedule.
        • ActionName — required — (String) The name of the action, must be unique within the schedule. This name provides the main reference to an action once it is added to the schedule. A name is unique if it is no longer in the schedule. The schedule is automatically cleaned up to remove actions with a start time of more than 1 hour ago (approximately) so at that point a name can be reused.
        • ScheduleActionSettings — required — (map) Settings for this schedule action.
          • HlsTimedMetadataSettings — (map) Action to insert HLS metadata
          • InputSwitchSettings — (map) Action to switch the input
            • InputAttachmentNameReference — required — (String) The name of the input attachment that should be switched to by this action.
          • PauseStateSettings — (map) Action to pause or unpause one or both channel pipelines
            • Pipelines — (Array<map>) Placeholder documentation for __listOfPipelinePauseStateSettings
              • PipelineId — required — (String) Pipeline ID to pause ("PIPELINE_0" or "PIPELINE_1"). Possible values include:
                • "PIPELINE_0"
                • "PIPELINE_1"
          • Scte35ReturnToNetworkSettings — (map) Action to insert SCTE-35 return_to_network message
            • SpliceEventId — required — (Integer) The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
          • Scte35SpliceInsertSettings — (map) Action to insert SCTE-35 splice_insert message
            • Duration — (Integer) Optional, the duration for the splice_insert, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. If you enter a duration, there is an expectation that the downstream system can read the duration and cue in at that time. If you do not enter a duration, the splice_insert will continue indefinitely and there is an expectation that you will enter a return_to_network to end the splice_insert at the appropriate time.
            • SpliceEventId — required — (Integer) The splice_event_id for the SCTE-35 splice_insert, as defined in SCTE-35.
          • Scte35TimeSignalSettings — (map) Action to insert SCTE-35 time_signal message
            • Scte35Descriptors — required — (Array<map>) The list of SCTE-35 descriptors accompanying the SCTE-35 time_signal.
              • Scte35DescriptorSettings — required — (map) SCTE-35 Descriptor Settings.
                • SegmentationDescriptorScte35DescriptorSettings — required — (map) SCTE-35 Segmentation Descriptor.
                  • DeliveryRestrictions — (map) Holds the four SCTE-35 delivery restriction parameters.
                    • ArchiveAllowedFlag — required — (String) Corresponds to SCTE-35 archive_allowed_flag. Possible values include:
                      • "ARCHIVE_NOT_ALLOWED"
                      • "ARCHIVE_ALLOWED"
                    • DeviceRestrictions — required — (String) Corresponds to SCTE-35 device_restrictions parameter. Possible values include:
                      • "NONE"
                      • "RESTRICT_GROUP0"
                      • "RESTRICT_GROUP1"
                      • "RESTRICT_GROUP2"
                    • NoRegionalBlackoutFlag — required — (String) Corresponds to SCTE-35 no_regional_blackout_flag parameter. Possible values include:
                      • "REGIONAL_BLACKOUT"
                      • "NO_REGIONAL_BLACKOUT"
                    • WebDeliveryAllowedFlag — required — (String) Corresponds to SCTE-35 web_delivery_allowed_flag parameter. Possible values include:
                      • "WEB_DELIVERY_NOT_ALLOWED"
                      • "WEB_DELIVERY_ALLOWED"
                  • SegmentNum — (Integer) Corresponds to SCTE-35 segment_num. A value that is valid for the specified segmentation_type_id.
                  • SegmentationCancelIndicator — required — (String) Corresponds to SCTE-35 segmentation_event_cancel_indicator. Possible values include:
                    • "SEGMENTATION_EVENT_NOT_CANCELED"
                    • "SEGMENTATION_EVENT_CANCELED"
                  • SegmentationDuration — (Integer) Corresponds to SCTE-35 segmentation_duration. Optional. The duration for the time_signal, in 90 KHz ticks. To convert seconds to ticks, multiple the seconds by 90,000. Enter time in 90 KHz clock ticks. If you do not enter a duration, the time_signal will continue until you insert a cancellation message.
                  • SegmentationEventId — required — (Integer) Corresponds to SCTE-35 segmentation_event_id.
                  • SegmentationTypeId — (Integer) Corresponds to SCTE-35 segmentation_type_id. One of the segmentation_type_id values listed in the SCTE-35 specification. On the console, enter the ID in decimal (for example, "52"). In the CLI, API, or an SDK, enter the ID in hex (for example, "0x34") or decimal (for example, "52").
                  • SegmentationUpid — (String) Corresponds to SCTE-35 segmentation_upid. Enter a string containing the hexadecimal representation of the characters that make up the SCTE-35 segmentation_upid value. Must contain an even number of hex characters. Do not include spaces between each hex pair. For example, the ASCII "ADS Information" becomes hex "41445320496e666f726d6174696f6e.
                  • SegmentationUpidType — (Integer) Corresponds to SCTE-35 segmentation_upid_type. On the console, enter one of the types listed in the SCTE-35 specification, converted to a decimal. For example, "0x0C" hex from the specification is "12" in decimal. In the CLI, API, or an SDK, enter one of the types listed in the SCTE-35 specification, in either hex (for example, "0x0C" ) or in decimal (for example, "12").
                  • SegmentsExpected — (Integer) Corresponds to SCTE-35 segments_expected. A value that is valid for the specified segmentation_type_id.
                  • SubSegmentNum — (Integer) Corresponds to SCTE-35 sub_segment_num. A value that is valid for the specified segmentation_type_id.
                  • SubSegmentsExpected — (Integer) Corresponds to SCTE-35 sub_segments_expected. A value that is valid for the specified segmentation_type_id.
          • StaticImageActivateSettings — (map) Action to activate a static image overlay
            • Duration — (Integer) The duration in milliseconds for the image to remain on the video. If omitted or set to 0 the duration is unlimited and the image will remain until it is explicitly deactivated.
            • FadeIn — (Integer) The time in milliseconds for the image to fade in. The fade-in starts at the start time of the overlay. Default is 0 (no fade-in).
            • FadeOut — (Integer) Applies only if a duration is specified. The time in milliseconds for the image to fade out. The fade-out starts when the duration time is hit, so it effectively extends the duration. Default is 0 (no fade-out).
            • Height — (Integer) The height of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified height. Leave blank to use the native height of the overlay.
            • Image — required — (map) The location and filename of the image file to overlay on the video. The file must be a 32-bit BMP, PNG, or TGA file, and must not be larger (in pixels) than the input video.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • ImageX — (Integer) Placement of the left edge of the overlay relative to the left edge of the video frame, in pixels. 0 (the default) is the left edge of the frame. If the placement causes the overlay to extend beyond the right edge of the underlying video, then the overlay is cropped on the right.
            • ImageY — (Integer) Placement of the top edge of the overlay relative to the top edge of the video frame, in pixels. 0 (the default) is the top edge of the frame. If the placement causes the overlay to extend beyond the bottom edge of the underlying video, then the overlay is cropped on the bottom.
            • Layer — (Integer) The number of the layer, 0 to 7. There are 8 layers that can be overlaid on the video, each layer with a different image. The layers are in Z order, which means that overlays with higher values of layer are inserted on top of overlays with lower values of layer. Default is 0.
            • Opacity — (Integer) Opacity of image where 0 is transparent and 100 is fully opaque. Default is 100.
            • Width — (Integer) The width of the image when inserted into the video, in pixels. The overlay will be scaled up or down to the specified width. Leave blank to use the native width of the overlay.
          • StaticImageDeactivateSettings — (map) Action to deactivate a static image overlay
            • FadeOut — (Integer) The time in milliseconds for the image to fade out. Default is 0 (no fade-out).
            • Layer — (Integer) The image overlay layer to deactivate, 0 to 7. Default is 0.
        • ScheduleActionStartSettings — required — (map) The time for the action to start in the channel.
          • FixedModeScheduleActionStartSettings — (map) Holds the start time for the action.
            • Time — required — (String) Start time for the action to start in the channel. (Not the time for the action to be added to the schedule: actions are always added to the schedule immediately.) UTC format: yyyy-mm-ddThh:mm:ss.nnnZ. All the letters are digits (for example, mm might be 01) except for the two constants "T" for time and "Z" for "UTC format".
          • FollowModeScheduleActionStartSettings — (map) Specifies an action to follow for scheduling this action.
            • FollowPoint — required — (String) Identifies whether this action starts relative to the start or relative to the end of the reference action. Possible values include:
              • "END"
              • "START"
            • ReferenceActionName — required — (String) The action name of another action that this one refers to.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listChannels(params = {}, callback) ⇒ AWS.Request

Produces list of channels that have been created

Service Reference:

Examples:

Calling the listChannels operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
medialive.listChannels(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer) Placeholder documentation for MaxResults
    • NextToken — (String) Placeholder documentation for __string

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Channels — (Array<map>) Placeholder documentation for __listOfChannelSummary
        • Arn — (String) The unique arn of the channel.
        • ChannelClass — (String) The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. Possible values include:
          • "STANDARD"
          • "SINGLE_PIPELINE"
        • Destinations — (Array<map>) A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
          • Id — (String) User-specified id. This is used in an output group or an output.
          • MediaPackageSettings — (Array<map>) Destination settings for a MediaPackage output; one destination for both encoders.
            • ChannelId — (String) ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
          • Settings — (Array<map>) Destination settings for a standard output; one destination for each redundant encoder.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • StreamName — (String) Stream name for RTMP destinations (URLs of type rtmp://)
            • Url — (String) A URL specifying a destination
            • Username — (String) username for destination
        • EgressEndpoints — (Array<map>) The endpoints where outgoing connections initiate from
          • SourceIp — (String) Public IP of where a channel's output comes from
        • Id — (String) The unique id of the channel.
        • InputAttachments — (Array<map>) List of input attachments for channel.
          • InputAttachmentName — (String) User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
          • InputId — (String) The ID of the input
          • InputSettings — (map) Settings of an input (caption selector, etc.)
            • AudioSelectors — (Array<map>) Used to select the audio stream to decode for inputs that have multiple available.
              • Name — required — (String) The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
              • SelectorSettings — (map) The audio selector settings.
                • AudioLanguageSelection — (map) Audio Language Selection
                  • LanguageCode — required — (String) Selects a specific three-letter language code from within an audio source.
                  • LanguageSelectionPolicy — (String) When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. Possible values include:
                    • "LOOSE"
                    • "STRICT"
                • AudioPidSelection — (map) Audio Pid Selection
                  • Pid — required — (Integer) Selects a specific PID from within a source.
            • CaptionSelectors — (Array<map>) Used to select the caption input to use for inputs that have multiple available.
              • LanguageCode — (String) When specified this field indicates the three letter language code of the caption track to extract from the source.
              • Name — required — (String) Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
              • SelectorSettings — (map) Caption selector settings.
                • AribSourceSettings — (map) Arib Source Settings
                • DvbSubSourceSettings — (map) Dvb Sub Source Settings
                  • Pid — (Integer) When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
                • EmbeddedSourceSettings — (map) Embedded Source Settings
                  • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                    • "DISABLED"
                    • "UPCONVERT"
                  • Scte20Detection — (String) Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. Possible values include:
                    • "AUTO"
                    • "OFF"
                  • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
                  • Source608TrackNumber — (Integer) This field is unused and deprecated.
                • Scte20SourceSettings — (map) Scte20 Source Settings
                  • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                    • "DISABLED"
                    • "UPCONVERT"
                  • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
                • Scte27SourceSettings — (map) Scte27 Source Settings
                  • Pid — (Integer) The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
                • TeletextSourceSettings — (map) Teletext Source Settings
                  • PageNumber — (String) Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
            • DeblockFilter — (String) Enable or disable the deblock filter when filtering. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • DenoiseFilter — (String) Enable or disable the denoise filter when filtering. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • FilterStrength — (Integer) Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
            • InputFilter — (String) Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type Possible values include:
              • "AUTO"
              • "DISABLED"
              • "FORCED"
            • NetworkInputSettings — (map) Input settings.
              • HlsInputSettings — (map) Specifies HLS input settings when the uri is for a HLS manifest.
                • Bandwidth — (Integer) When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
                • BufferSegments — (Integer) When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
                • Retries — (Integer) The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
                • RetryInterval — (Integer) The number of seconds between retries when an attempt to read a manifest or segment fails.
              • ServerValidation — (String) Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. Possible values include:
                • "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME"
                • "CHECK_CRYPTOGRAPHY_ONLY"
            • SourceEndBehavior — (String) Loop input if it is a file. This allows a file input to be streamed indefinitely. Possible values include:
              • "CONTINUE"
              • "LOOP"
            • VideoSelector — (map) Informs which video elementary stream to decode for input types that have multiple available.
              • ColorSpace — (String) Specifies the colorspace of an input. This setting works in tandem with colorSpaceConversion to determine if any conversion will be performed. Possible values include:
                • "FOLLOW"
                • "REC_601"
                • "REC_709"
              • ColorSpaceUsage — (String) Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. Possible values include:
                • "FALLBACK"
                • "FORCE"
              • SelectorSettings — (map) The video selector settings.
                • VideoSelectorPid — (map) Video Selector Pid
                  • Pid — (Integer) Selects a specific PID from within a video source.
                • VideoSelectorProgramId — (map) Video Selector Program Id
                  • ProgramId — (Integer) Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
        • InputSpecification — (map) Placeholder documentation for InputSpecification
          • Codec — (String) Input codec Possible values include:
            • "MPEG2"
            • "AVC"
            • "HEVC"
          • MaximumBitrate — (String) Maximum input bitrate, categorized coarsely Possible values include:
            • "MAX_10_MBPS"
            • "MAX_20_MBPS"
            • "MAX_50_MBPS"
          • Resolution — (String) Input resolution, categorized coarsely Possible values include:
            • "SD"
            • "HD"
            • "UHD"
        • LogLevel — (String) The log level being written to CloudWatch Logs. Possible values include:
          • "ERROR"
          • "WARNING"
          • "INFO"
          • "DEBUG"
          • "DISABLED"
        • Name — (String) The name of the channel. (user-mutable)
        • PipelinesRunningCount — (Integer) The number of currently healthy pipelines.
        • RoleArn — (String) The Amazon Resource Name (ARN) of the role assumed when running the Channel.
        • State — (String) Placeholder documentation for ChannelState Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "IDLE"
          • "STARTING"
          • "RUNNING"
          • "RECOVERING"
          • "STOPPING"
          • "DELETING"
          • "DELETED"
        • Tags — (map<String>) A collection of key-value pairs.
      • NextToken — (String) Placeholder documentation for __string

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listInputs(params = {}, callback) ⇒ AWS.Request

Produces list of inputs that have been created

Service Reference:

Examples:

Calling the listInputs operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
medialive.listInputs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer) Placeholder documentation for MaxResults
    • NextToken — (String) Placeholder documentation for __string

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Inputs — (Array<map>) Placeholder documentation for __listOfInput
        • Arn — (String) The Unique ARN of the input (generated, immutable).
        • AttachedChannels — (Array<String>) A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).
        • Destinations — (Array<map>) A list of the destinations of the input (PUSH-type).
          • Ip — (String) The system-generated static IP address of endpoint. It remains fixed for the lifetime of the input.
          • Port — (String) The port number for the input.
          • Url — (String) This represents the endpoint that the customer stream will be pushed to.
          • Vpc — (map) The properties for a VPC type input destination.
            • AvailabilityZone — (String) The availability zone of the Input destination.
            • NetworkInterfaceId — (String) The network interface ID of the Input destination in the VPC.
        • Id — (String) The generated ID of the input (unique for user account, immutable).
        • InputClass — (String) STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input. Possible values include:
          • "STANDARD"
          • "SINGLE_PIPELINE"
        • MediaConnectFlows — (Array<map>) A list of MediaConnect Flows for this input.
          • FlowArn — (String) The unique ARN of the MediaConnect Flow being used as a source.
        • Name — (String) The user-assigned name (This is a mutable value).
        • RoleArn — (String) The Amazon Resource Name (ARN) of the role this input assumes during and after creation.
        • SecurityGroups — (Array<String>) A list of IDs for all the Input Security Groups attached to the input.
        • Sources — (Array<map>) A list of the sources of the input (PULL-type).
          • PasswordParam — (String) The key used to extract the password from EC2 Parameter store.
          • Url — (String) This represents the customer's source URL where stream is pulled from.
          • Username — (String) The username for the input source.
        • State — (String) Placeholder documentation for InputState Possible values include:
          • "CREATING"
          • "DETACHED"
          • "ATTACHED"
          • "DELETING"
          • "DELETED"
        • Tags — (map<String>) A collection of key-value pairs.
        • Type — (String) Placeholder documentation for InputType Possible values include:
          • "UDP_PUSH"
          • "RTP_PUSH"
          • "RTMP_PUSH"
          • "RTMP_PULL"
          • "URL_PULL"
          • "MP4_FILE"
          • "MEDIACONNECT"
      • NextToken — (String) Placeholder documentation for __string

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listInputSecurityGroups(params = {}, callback) ⇒ AWS.Request

Produces a list of Input Security Groups for an account

Service Reference:

Examples:

Calling the listInputSecurityGroups operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
medialive.listInputSecurityGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • MaxResults — (Integer) Placeholder documentation for MaxResults
    • NextToken — (String) Placeholder documentation for __string

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • InputSecurityGroups — (Array<map>) List of input security groups
        • Arn — (String) Unique ARN of Input Security Group
        • Id — (String) The Id of the Input Security Group
        • Inputs — (Array<String>) The list of inputs currently using this Input Security Group.
        • State — (String) The current state of the Input Security Group. Possible values include:
          • "IDLE"
          • "IN_USE"
          • "UPDATING"
          • "DELETED"
        • Tags — (map<String>) A collection of key-value pairs.
        • WhitelistRules — (Array<map>) Whitelist rules and their sync status
          • Cidr — (String) The IPv4 CIDR that's whitelisted.
      • NextToken — (String) Placeholder documentation for __string

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listOfferings(params = {}, callback) ⇒ AWS.Request

List offerings available for purchase.

Service Reference:

Examples:

Calling the listOfferings operation

var params = {
  ChannelClass: 'STRING_VALUE',
  ChannelConfiguration: 'STRING_VALUE',
  Codec: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  MaximumBitrate: 'STRING_VALUE',
  MaximumFramerate: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  Resolution: 'STRING_VALUE',
  ResourceType: 'STRING_VALUE',
  SpecialFeature: 'STRING_VALUE',
  VideoQuality: 'STRING_VALUE'
};
medialive.listOfferings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ChannelClass — (String) Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'
    • ChannelConfiguration — (String) Filter to offerings that match the configuration of an existing channel, e.g. '2345678' (a channel ID)
    • Codec — (String) Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO'
    • MaxResults — (Integer) Placeholder documentation for MaxResults
    • MaximumBitrate — (String) Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'
    • MaximumFramerate — (String) Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'
    • NextToken — (String) Placeholder documentation for __string
    • Resolution — (String) Filter by resolution, 'SD', 'HD', or 'UHD'
    • ResourceType — (String) Filter by resource type, 'INPUT', 'OUTPUT', or 'CHANNEL'
    • SpecialFeature — (String) Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'
    • VideoQuality — (String) Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String) Token to retrieve the next page of results
      • Offerings — (Array<map>) List of offerings
        • Arn — (String) Unique offering ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:offering:87654321'
        • CurrencyCode — (String) Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
        • Duration — (Integer) Lease duration, e.g. '12'
        • DurationUnits — (String) Units for duration, e.g. 'MONTHS' Possible values include:
          • "MONTHS"
        • FixedPrice — (Float) One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
        • OfferingDescription — (String) Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
        • OfferingId — (String) Unique offering ID, e.g. '87654321'
        • OfferingType — (String) Offering type, e.g. 'NO_UPFRONT' Possible values include:
          • "NO_UPFRONT"
        • Region — (String) AWS region, e.g. 'us-west-2'
        • ResourceSpecification — (map) Resource configuration details
          • ChannelClass — (String) Channel class, e.g. 'STANDARD' Possible values include:
            • "STANDARD"
            • "SINGLE_PIPELINE"
          • Codec — (String) Codec, e.g. 'AVC' Possible values include:
            • "MPEG2"
            • "AVC"
            • "HEVC"
            • "AUDIO"
          • MaximumBitrate — (String) Maximum bitrate, e.g. 'MAX_20_MBPS' Possible values include:
            • "MAX_10_MBPS"
            • "MAX_20_MBPS"
            • "MAX_50_MBPS"
          • MaximumFramerate — (String) Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only) Possible values include:
            • "MAX_30_FPS"
            • "MAX_60_FPS"
          • Resolution — (String) Resolution, e.g. 'HD' Possible values include:
            • "SD"
            • "HD"
            • "UHD"
          • ResourceType — (String) Resource type, 'INPUT', 'OUTPUT', or 'CHANNEL' Possible values include:
            • "INPUT"
            • "OUTPUT"
            • "CHANNEL"
          • SpecialFeature — (String) Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only) Possible values include:
            • "ADVANCED_AUDIO"
            • "AUDIO_NORMALIZATION"
          • VideoQuality — (String) Video quality, e.g. 'STANDARD' (Outputs only) Possible values include:
            • "STANDARD"
            • "ENHANCED"
            • "PREMIUM"
        • UsagePrice — (Float) Recurring usage charge for each reserved resource, e.g. '157.0'

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listReservations(params = {}, callback) ⇒ AWS.Request

List purchased reservations.

Service Reference:

Examples:

Calling the listReservations operation

var params = {
  ChannelClass: 'STRING_VALUE',
  Codec: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  MaximumBitrate: 'STRING_VALUE',
  MaximumFramerate: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  Resolution: 'STRING_VALUE',
  ResourceType: 'STRING_VALUE',
  SpecialFeature: 'STRING_VALUE',
  VideoQuality: 'STRING_VALUE'
};
medialive.listReservations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ChannelClass — (String) Filter by channel class, 'STANDARD' or 'SINGLE_PIPELINE'
    • Codec — (String) Filter by codec, 'AVC', 'HEVC', 'MPEG2', or 'AUDIO'
    • MaxResults — (Integer) Placeholder documentation for MaxResults
    • MaximumBitrate — (String) Filter by bitrate, 'MAX_10_MBPS', 'MAX_20_MBPS', or 'MAX_50_MBPS'
    • MaximumFramerate — (String) Filter by framerate, 'MAX_30_FPS' or 'MAX_60_FPS'
    • NextToken — (String) Placeholder documentation for __string
    • Resolution — (String) Filter by resolution, 'SD', 'HD', or 'UHD'
    • ResourceType — (String) Filter by resource type, 'INPUT', 'OUTPUT', or 'CHANNEL'
    • SpecialFeature — (String) Filter by special feature, 'ADVANCED_AUDIO' or 'AUDIO_NORMALIZATION'
    • VideoQuality — (String) Filter by video quality, 'STANDARD', 'ENHANCED', or 'PREMIUM'

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextToken — (String) Token to retrieve the next page of results
      • Reservations — (Array<map>) List of reservations
        • Arn — (String) Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
        • Count — (Integer) Number of reserved resources
        • CurrencyCode — (String) Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
        • Duration — (Integer) Lease duration, e.g. '12'
        • DurationUnits — (String) Units for duration, e.g. 'MONTHS' Possible values include:
          • "MONTHS"
        • End — (String) Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
        • FixedPrice — (Float) One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
        • Name — (String) User specified reservation name
        • OfferingDescription — (String) Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
        • OfferingId — (String) Unique offering ID, e.g. '87654321'
        • OfferingType — (String) Offering type, e.g. 'NO_UPFRONT' Possible values include:
          • "NO_UPFRONT"
        • Region — (String) AWS region, e.g. 'us-west-2'
        • ReservationId — (String) Unique reservation ID, e.g. '1234567'
        • ResourceSpecification — (map) Resource configuration details
          • ChannelClass — (String) Channel class, e.g. 'STANDARD' Possible values include:
            • "STANDARD"
            • "SINGLE_PIPELINE"
          • Codec — (String) Codec, e.g. 'AVC' Possible values include:
            • "MPEG2"
            • "AVC"
            • "HEVC"
            • "AUDIO"
          • MaximumBitrate — (String) Maximum bitrate, e.g. 'MAX_20_MBPS' Possible values include:
            • "MAX_10_MBPS"
            • "MAX_20_MBPS"
            • "MAX_50_MBPS"
          • MaximumFramerate — (String) Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only) Possible values include:
            • "MAX_30_FPS"
            • "MAX_60_FPS"
          • Resolution — (String) Resolution, e.g. 'HD' Possible values include:
            • "SD"
            • "HD"
            • "UHD"
          • ResourceType — (String) Resource type, 'INPUT', 'OUTPUT', or 'CHANNEL' Possible values include:
            • "INPUT"
            • "OUTPUT"
            • "CHANNEL"
          • SpecialFeature — (String) Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only) Possible values include:
            • "ADVANCED_AUDIO"
            • "AUDIO_NORMALIZATION"
          • VideoQuality — (String) Video quality, e.g. 'STANDARD' (Outputs only) Possible values include:
            • "STANDARD"
            • "ENHANCED"
            • "PREMIUM"
        • Start — (String) Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
        • State — (String) Current state of reservation, e.g. 'ACTIVE' Possible values include:
          • "ACTIVE"
          • "EXPIRED"
          • "CANCELED"
          • "DELETED"
        • Tags — (map<String>) A collection of key-value pairs
        • UsagePrice — (Float) Recurring usage charge for each reserved resource, e.g. '157.0'

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Produces list of tags that have been created for a resource

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
medialive.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String) Placeholder documentation for __string

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (map<String>) Placeholder documentation for Tags

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

purchaseOffering(params = {}, callback) ⇒ AWS.Request

Purchase an offering and create a reservation.

Service Reference:

Examples:

Calling the purchaseOffering operation

var params = {
  Count: 'NUMBER_VALUE', /* required */
  OfferingId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE',
  RequestId: 'STRING_VALUE',
  Start: 'STRING_VALUE',
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
medialive.purchaseOffering(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Count — (Integer) Number of resources
    • Name — (String) Name for the new reservation
    • OfferingId — (String) Offering to purchase, e.g. '87654321'
    • RequestId — (String) Unique request ID to be specified. This is needed to prevent retries from creating multiple resources. If a token is not provided, the SDK will use a version 4 UUID.
    • Start — (String) Requested reservation start time (UTC) in ISO-8601 format. The specified time must be between the first day of the current month and one year from now. If no value is given, the default is now.
    • Tags — (map<String>) A collection of key-value pairs

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Reservation — (map) Reserved resources available to use
        • Arn — (String) Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
        • Count — (Integer) Number of reserved resources
        • CurrencyCode — (String) Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
        • Duration — (Integer) Lease duration, e.g. '12'
        • DurationUnits — (String) Units for duration, e.g. 'MONTHS' Possible values include:
          • "MONTHS"
        • End — (String) Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
        • FixedPrice — (Float) One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
        • Name — (String) User specified reservation name
        • OfferingDescription — (String) Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
        • OfferingId — (String) Unique offering ID, e.g. '87654321'
        • OfferingType — (String) Offering type, e.g. 'NO_UPFRONT' Possible values include:
          • "NO_UPFRONT"
        • Region — (String) AWS region, e.g. 'us-west-2'
        • ReservationId — (String) Unique reservation ID, e.g. '1234567'
        • ResourceSpecification — (map) Resource configuration details
          • ChannelClass — (String) Channel class, e.g. 'STANDARD' Possible values include:
            • "STANDARD"
            • "SINGLE_PIPELINE"
          • Codec — (String) Codec, e.g. 'AVC' Possible values include:
            • "MPEG2"
            • "AVC"
            • "HEVC"
            • "AUDIO"
          • MaximumBitrate — (String) Maximum bitrate, e.g. 'MAX_20_MBPS' Possible values include:
            • "MAX_10_MBPS"
            • "MAX_20_MBPS"
            • "MAX_50_MBPS"
          • MaximumFramerate — (String) Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only) Possible values include:
            • "MAX_30_FPS"
            • "MAX_60_FPS"
          • Resolution — (String) Resolution, e.g. 'HD' Possible values include:
            • "SD"
            • "HD"
            • "UHD"
          • ResourceType — (String) Resource type, 'INPUT', 'OUTPUT', or 'CHANNEL' Possible values include:
            • "INPUT"
            • "OUTPUT"
            • "CHANNEL"
          • SpecialFeature — (String) Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only) Possible values include:
            • "ADVANCED_AUDIO"
            • "AUDIO_NORMALIZATION"
          • VideoQuality — (String) Video quality, e.g. 'STANDARD' (Outputs only) Possible values include:
            • "STANDARD"
            • "ENHANCED"
            • "PREMIUM"
        • Start — (String) Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
        • State — (String) Current state of reservation, e.g. 'ACTIVE' Possible values include:
          • "ACTIVE"
          • "EXPIRED"
          • "CANCELED"
          • "DELETED"
        • Tags — (map<String>) A collection of key-value pairs
        • UsagePrice — (Float) Recurring usage charge for each reserved resource, e.g. '157.0'

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

startChannel(params = {}, callback) ⇒ AWS.Request

Starts an existing channel

Service Reference:

Examples:

Calling the startChannel operation

var params = {
  ChannelId: 'STRING_VALUE' /* required */
};
medialive.startChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ChannelId — (String) A request to start a channel

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) The unique arn of the channel.
      • ChannelClass — (String) The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. Possible values include:
        • "STANDARD"
        • "SINGLE_PIPELINE"
      • Destinations — (Array<map>) A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
        • Id — (String) User-specified id. This is used in an output group or an output.
        • MediaPackageSettings — (Array<map>) Destination settings for a MediaPackage output; one destination for both encoders.
          • ChannelId — (String) ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
        • Settings — (Array<map>) Destination settings for a standard output; one destination for each redundant encoder.
          • PasswordParam — (String) key used to extract the password from EC2 Parameter store
          • StreamName — (String) Stream name for RTMP destinations (URLs of type rtmp://)
          • Url — (String) A URL specifying a destination
          • Username — (String) username for destination
      • EgressEndpoints — (Array<map>) The endpoints where outgoing connections initiate from
        • SourceIp — (String) Public IP of where a channel's output comes from
      • EncoderSettings — (map) Encoder Settings
        • AudioDescriptions — required — (Array<map>) Placeholder documentation for __listOfAudioDescription
          • AudioNormalizationSettings — (map) Advanced audio normalization settings.
            • Algorithm — (String) Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. Possible values include:
              • "ITU_1770_1"
              • "ITU_1770_2"
            • AlgorithmControl — (String) When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. Possible values include:
              • "CORRECT_AUDIO"
            • TargetLkfs — (Float) Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
          • AudioSelectorName — required — (String) The name of the AudioSelector used as the source for this AudioDescription.
          • AudioType — (String) Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. Possible values include:
            • "CLEAN_EFFECTS"
            • "HEARING_IMPAIRED"
            • "UNDEFINED"
            • "VISUAL_IMPAIRED_COMMENTARY"
          • AudioTypeControl — (String) Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. Possible values include:
            • "FOLLOW_INPUT"
            • "USE_CONFIGURED"
          • CodecSettings — (map) Audio codec settings.
            • AacSettings — (map) Aac Settings
              • Bitrate — (Float) Average bitrate in bits/second. Valid values depend on rate control mode and profile.
              • CodingMode — (String) Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. Possible values include:
                • "AD_RECEIVER_MIX"
                • "CODING_MODE_1_0"
                • "CODING_MODE_1_1"
                • "CODING_MODE_2_0"
                • "CODING_MODE_5_1"
              • InputType — (String) Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD. Possible values include:
                • "BROADCASTER_MIXED_AD"
                • "NORMAL"
              • Profile — (String) AAC Profile. Possible values include:
                • "HEV1"
                • "HEV2"
                • "LC"
              • RateControlMode — (String) Rate Control Mode. Possible values include:
                • "CBR"
                • "VBR"
              • RawFormat — (String) Sets LATM / LOAS AAC output for raw containers. Possible values include:
                • "LATM_LOAS"
                • "NONE"
              • SampleRate — (Float) Sample rate in Hz. Valid values depend on rate control mode and profile.
              • Spec — (String) Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. Possible values include:
                • "MPEG2"
                • "MPEG4"
              • VbrQuality — (String) VBR Quality Level - Only used if rateControlMode is VBR. Possible values include:
                • "HIGH"
                • "LOW"
                • "MEDIUM_HIGH"
                • "MEDIUM_LOW"
            • Ac3Settings — (map) Ac3 Settings
              • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
              • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. Possible values include:
                • "COMMENTARY"
                • "COMPLETE_MAIN"
                • "DIALOGUE"
                • "EMERGENCY"
                • "HEARING_IMPAIRED"
                • "MUSIC_AND_EFFECTS"
                • "VISUALLY_IMPAIRED"
                • "VOICE_OVER"
              • CodingMode — (String) Dolby Digital coding mode. Determines number of channels. Possible values include:
                • "CODING_MODE_1_0"
                • "CODING_MODE_1_1"
                • "CODING_MODE_2_0"
                • "CODING_MODE_3_2_LFE"
              • Dialnorm — (Integer) Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
              • DrcProfile — (String) If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. Possible values include:
                • "FILM_STANDARD"
                • "NONE"
              • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • MetadataControl — (String) When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
                • "FOLLOW_INPUT"
                • "USE_CONFIGURED"
            • Eac3Settings — (map) Eac3 Settings
              • AttenuationControl — (String) When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. Possible values include:
                • "ATTENUATE_3_DB"
                • "NONE"
              • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
              • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. Possible values include:
                • "COMMENTARY"
                • "COMPLETE_MAIN"
                • "EMERGENCY"
                • "HEARING_IMPAIRED"
                • "VISUALLY_IMPAIRED"
              • CodingMode — (String) Dolby Digital Plus coding mode. Determines number of channels. Possible values include:
                • "CODING_MODE_1_0"
                • "CODING_MODE_2_0"
                • "CODING_MODE_3_2"
              • DcFilter — (String) When set to enabled, activates a DC highpass filter for all input channels. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • Dialnorm — (Integer) Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
              • DrcLine — (String) Sets the Dolby dynamic range compression profile. Possible values include:
                • "FILM_LIGHT"
                • "FILM_STANDARD"
                • "MUSIC_LIGHT"
                • "MUSIC_STANDARD"
                • "NONE"
                • "SPEECH"
              • DrcRf — (String) Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. Possible values include:
                • "FILM_LIGHT"
                • "FILM_STANDARD"
                • "MUSIC_LIGHT"
                • "MUSIC_STANDARD"
                • "NONE"
                • "SPEECH"
              • LfeControl — (String) When encoding 3/2 audio, setting to lfe enables the LFE channel Possible values include:
                • "LFE"
                • "NO_LFE"
              • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • LoRoCenterMixLevel — (Float) Left only/Right only center mix level. Only used for 3/2 coding mode.
              • LoRoSurroundMixLevel — (Float) Left only/Right only surround mix level. Only used for 3/2 coding mode.
              • LtRtCenterMixLevel — (Float) Left total/Right total center mix level. Only used for 3/2 coding mode.
              • LtRtSurroundMixLevel — (Float) Left total/Right total surround mix level. Only used for 3/2 coding mode.
              • MetadataControl — (String) When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
                • "FOLLOW_INPUT"
                • "USE_CONFIGURED"
              • PassthroughControl — (String) When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding. Possible values include:
                • "NO_PASSTHROUGH"
                • "WHEN_POSSIBLE"
              • PhaseControl — (String) When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. Possible values include:
                • "NO_SHIFT"
                • "SHIFT_90_DEGREES"
              • StereoDownmix — (String) Stereo downmix preference. Only used for 3/2 coding mode. Possible values include:
                • "DPL2"
                • "LO_RO"
                • "LT_RT"
                • "NOT_INDICATED"
              • SurroundExMode — (String) When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. Possible values include:
                • "DISABLED"
                • "ENABLED"
                • "NOT_INDICATED"
              • SurroundMode — (String) When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. Possible values include:
                • "DISABLED"
                • "ENABLED"
                • "NOT_INDICATED"
            • Mp2Settings — (map) Mp2 Settings
              • Bitrate — (Float) Average bitrate in bits/second.
              • CodingMode — (String) The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). Possible values include:
                • "CODING_MODE_1_0"
                • "CODING_MODE_2_0"
              • SampleRate — (Float) Sample rate in Hz.
            • PassThroughSettings — (map) Pass Through Settings
          • LanguageCode — (String) Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
          • LanguageCodeControl — (String) Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. Possible values include:
            • "FOLLOW_INPUT"
            • "USE_CONFIGURED"
          • Name — required — (String) The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
          • RemixSettings — (map) Settings that control how input audio channels are remixed into the output audio channels.
            • ChannelMappings — required — (Array<map>) Mapping of input channels to output channels, with appropriate gain adjustments.
              • InputChannelLevels — required — (Array<map>) Indices and gain values for each input channel that should be remixed into this output channel.
                • Gain — required — (Integer) Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
                • InputChannel — required — (Integer) The index of the input channel used as a source.
              • OutputChannel — required — (Integer) The index of the output channel being produced.
            • ChannelsIn — (Integer) Number of input channels to be used.
            • ChannelsOut — (Integer) Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
          • StreamName — (String) Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
        • AvailBlanking — (map) Settings for ad avail blanking.
          • AvailBlankingImage — (map) Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
            • Username — (String) Documentation update needed
          • State — (String) When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added. Possible values include:
            • "DISABLED"
            • "ENABLED"
        • AvailConfiguration — (map) Event-wide configuration settings for ad avail insertion.
          • AvailSettings — (map) Ad avail settings.
            • Scte35SpliceInsert — (map) Scte35 Splice Insert
              • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
              • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
              • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
            • Scte35TimeSignalApos — (map) Scte35 Time Signal Apos
              • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
              • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
              • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
        • BlackoutSlate — (map) Settings for blackout slate.
          • BlackoutSlateImage — (map) Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
            • Username — (String) Documentation update needed
          • NetworkEndBlackout — (String) Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". Possible values include:
            • "DISABLED"
            • "ENABLED"
          • NetworkEndBlackoutImage — (map) Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
            • Username — (String) Documentation update needed
          • NetworkId — (String) Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
          • State — (String) When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata. Possible values include:
            • "DISABLED"
            • "ENABLED"
        • CaptionDescriptions — (Array<map>) Settings for caption decriptions
          • CaptionSelectorName — required — (String) Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
          • DestinationSettings — (map) Additional settings for captions destination that depend on the destination type.
            • AribDestinationSettings — (map) Arib Destination Settings
            • BurnInDestinationSettings — (map) Burn In Destination Settings
              • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "CENTERED"
                • "LEFT"
                • "SMART"
              • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
                • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                • Username — (String) Documentation update needed
              • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
              • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
              • FontSize — (String) When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
              • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
              • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
              • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
              • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
                • "FIXED"
                • "SCALED"
              • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
              • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
            • DvbSubDestinationSettings — (map) Dvb Sub Destination Settings
              • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "CENTERED"
                • "LEFT"
                • "SMART"
              • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
                • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                • Username — (String) Documentation update needed
              • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
              • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
              • FontSize — (String) When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
              • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
              • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
              • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
              • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
                • "FIXED"
                • "SCALED"
              • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
              • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
            • EmbeddedDestinationSettings — (map) Embedded Destination Settings
            • EmbeddedPlusScte20DestinationSettings — (map) Embedded Plus Scte20 Destination Settings
            • RtmpCaptionInfoDestinationSettings — (map) Rtmp Caption Info Destination Settings
            • Scte20PlusEmbeddedDestinationSettings — (map) Scte20 Plus Embedded Destination Settings
            • Scte27DestinationSettings — (map) Scte27 Destination Settings
            • SmpteTtDestinationSettings — (map) Smpte Tt Destination Settings
            • TeletextDestinationSettings — (map) Teletext Destination Settings
            • TtmlDestinationSettings — (map) Ttml Destination Settings
              • StyleControl — (String) When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. Possible values include:
                • "PASSTHROUGH"
                • "USE_CONFIGURED"
            • WebvttDestinationSettings — (map) Webvtt Destination Settings
          • LanguageCode — (String) ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
          • LanguageDescription — (String) Human readable information to indicate captions available for players (eg. English, or Spanish).
          • Name — required — (String) Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
        • GlobalConfiguration — (map) Configuration settings that apply to the event as a whole.
          • InitialAudioGain — (Integer) Value to set the initial audio gain for the Live Event.
          • InputEndAction — (String) Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). Possible values include:
            • "NONE"
            • "SWITCH_AND_LOOP_INPUTS"
          • InputLossBehavior — (map) Settings for system actions when input is lost.
            • BlackFrameMsec — (Integer) Documentation update needed
            • InputLossImageColor — (String) When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
            • InputLossImageSlate — (map) When input loss image type is "slate" these fields specify the parameters for accessing the slate.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • InputLossImageType — (String) Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. Possible values include:
              • "COLOR"
              • "SLATE"
            • RepeatFrameMsec — (Integer) Documentation update needed
          • OutputLockingMode — (String) Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. Possible values include:
            • "EPOCH_LOCKING"
            • "PIPELINE_LOCKING"
          • OutputTimingSource — (String) Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. Possible values include:
            • "INPUT_CLOCK"
            • "SYSTEM_CLOCK"
          • SupportLowFramerateInputs — (String) Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. Possible values include:
            • "DISABLED"
            • "ENABLED"
        • OutputGroups — required — (Array<map>) Placeholder documentation for __listOfOutputGroup
          • Name — (String) Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
          • OutputGroupSettings — required — (map) Settings associated with the output group.
            • ArchiveGroupSettings — (map) Archive Group Settings
              • Destination — required — (map) A directory and base filename where archive files should be written.
                • DestinationRefId — (String) Placeholder documentation for __string
              • RolloverInterval — (Integer) Number of seconds to write to archive file before closing and starting a new one.
            • FrameCaptureGroupSettings — (map) Frame Capture Group Settings
              • Destination — required — (map) The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
                • DestinationRefId — (String) Placeholder documentation for __string
            • HlsGroupSettings — (map) Hls Group Settings
              • AdMarkers — (Array<String>) Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
              • BaseUrlContent — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
              • BaseUrlManifest — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
              • CaptionLanguageMappings — (Array<map>) Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
                • CaptionChannel — required — (Integer) The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
                • LanguageCode — required — (String) Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
                • LanguageDescription — required — (String) Textual description of language
              • CaptionLanguageSetting — (String) Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest. Possible values include:
                • "INSERT"
                • "NONE"
                • "OMIT"
              • ClientCache — (String) When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • CodecSpecification — (String) Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. Possible values include:
                • "RFC_4281"
                • "RFC_6381"
              • ConstantIv — (String) For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
              • Destination — required — (map) A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
                • DestinationRefId — (String) Placeholder documentation for __string
              • DirectoryStructure — (String) Place segments in subdirectories. Possible values include:
                • "SINGLE_DIRECTORY"
                • "SUBDIRECTORY_PER_STREAM"
              • EncryptionType — (String) Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. Possible values include:
                • "AES128"
                • "SAMPLE_AES"
              • HlsCdnSettings — (map) Parameters that control interactions with the CDN.
                • HlsAkamaiSettings — (map) Hls Akamai Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. Possible values include:
                    • "CHUNKED"
                    • "NON_CHUNKED"
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                  • Salt — (String) Salt for authenticated Akamai.
                  • Token — (String) Token parameter for authenticated akamai. If not specified, gda is used.
                • HlsBasicPutSettings — (map) Hls Basic Put Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                • HlsMediaStoreSettings — (map) Hls Media Store Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • MediaStoreStorageClass — (String) When set to temporal, output files are stored in non-persistent memory for faster reading and writing. Possible values include:
                    • "TEMPORAL"
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                • HlsWebdavSettings — (map) Hls Webdav Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to WebDAV. Possible values include:
                    • "CHUNKED"
                    • "NON_CHUNKED"
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
              • IFrameOnlyPlaylists — (String) DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888" Possible values include:
                • "DISABLED"
                • "STANDARD"
              • IndexNSegments — (Integer) Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
              • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
                • "EMIT_OUTPUT"
                • "PAUSE_OUTPUT"
              • IvInManifest — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. Possible values include:
                • "EXCLUDE"
                • "INCLUDE"
              • IvSource — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. Possible values include:
                • "EXPLICIT"
                • "FOLLOWS_SEGMENT_NUMBER"
              • KeepSegments — (Integer) Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
              • KeyFormat — (String) The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
              • KeyFormatVersions — (String) Either a single positive integer version value or a slash delimited list of version values (1/2/3).
              • KeyProviderSettings — (map) The key provider settings.
                • StaticKeySettings — (map) Static Key Settings
                  • KeyProviderServer — (map) The URL of the license server used for protecting content.
                    • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                    • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                    • Username — (String) Documentation update needed
                  • StaticKeyValue — required — (String) Static key value as a 32 character hexadecimal string.
              • ManifestCompression — (String) When set to gzip, compresses HLS playlist. Possible values include:
                • "GZIP"
                • "NONE"
              • ManifestDurationFormat — (String) Indicates whether the output manifest should use floating point or integer values for segment duration. Possible values include:
                • "FLOATING_POINT"
                • "INTEGER"
              • MinSegmentLength — (Integer) When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
              • Mode — (String) If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. Possible values include:
                • "LIVE"
                • "VOD"
              • OutputSelection — (String) MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group. Possible values include:
                • "MANIFESTS_AND_SEGMENTS"
                • "SEGMENTS_ONLY"
              • ProgramDateTime — (String) Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset. Possible values include:
                • "EXCLUDE"
                • "INCLUDE"
              • ProgramDateTimePeriod — (Integer) Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
              • RedundantManifest — (String) ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • SegmentLength — (Integer) Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
              • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
                • "USE_INPUT_SEGMENTATION"
                • "USE_SEGMENT_DURATION"
              • SegmentsPerSubdirectory — (Integer) Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
              • StreamInfResolution — (String) Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. Possible values include:
                • "EXCLUDE"
                • "INCLUDE"
              • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
                • "NONE"
                • "PRIV"
                • "TDRL"
              • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
              • TimestampDeltaMilliseconds — (Integer) Provides an extra millisecond delta offset to fine tune the timestamps.
              • TsFileMode — (String) SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching. Possible values include:
                • "SEGMENTED_FILES"
                • "SINGLE_FILE"
            • MediaPackageGroupSettings — (map) Media Package Group Settings
              • Destination — required — (map) MediaPackage channel destination.
                • DestinationRefId — (String) Placeholder documentation for __string
            • MsSmoothGroupSettings — (map) Ms Smooth Group Settings
              • AcquisitionPointId — (String) The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
              • AudioOnlyTimecodeControl — (String) If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. Possible values include:
                • "PASSTHROUGH"
                • "USE_CONFIGURED_CLOCK"
              • CertificateMode — (String) If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. Possible values include:
                • "SELF_SIGNED"
                • "VERIFY_AUTHENTICITY"
              • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
              • Destination — required — (map) Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
                • DestinationRefId — (String) Placeholder documentation for __string
              • EventId — (String) MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
              • EventIdMode — (String) Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server. Possible values include:
                • "NO_EVENT_ID"
                • "USE_CONFIGURED"
                • "USE_TIMESTAMP"
              • EventStopBehavior — (String) When set to sendEos, send EOS signal to IIS server when stopping the event Possible values include:
                • "NONE"
                • "SEND_EOS"
              • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
              • FragmentLength — (Integer) Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
              • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
                • "EMIT_OUTPUT"
                • "PAUSE_OUTPUT"
              • NumRetries — (Integer) Number of retry attempts.
              • RestartDelay — (Integer) Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
              • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
                • "USE_INPUT_SEGMENTATION"
                • "USE_SEGMENT_DURATION"
              • SendDelayMs — (Integer) Number of milliseconds to delay the output from the second pipeline.
              • SparseTrackType — (String) If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs. Possible values include:
                • "NONE"
                • "SCTE_35"
              • StreamManifestBehavior — (String) When set to send, send stream manifest so publishing point doesn't start until all streams start. Possible values include:
                • "DO_NOT_SEND"
                • "SEND"
              • TimestampOffset — (String) Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
              • TimestampOffsetMode — (String) Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset Possible values include:
                • "USE_CONFIGURED_OFFSET"
                • "USE_EVENT_START_DATE"
            • RtmpGroupSettings — (map) Rtmp Group Settings
              • AuthenticationScheme — (String) Authentication scheme to use when connecting with CDN Possible values include:
                • "AKAMAI"
                • "COMMON"
              • CacheFullBehavior — (String) Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. Possible values include:
                • "DISCONNECT_IMMEDIATELY"
                • "WAIT_FOR_SERVER"
              • CacheLength — (Integer) Cache length, in seconds, is used to calculate buffer size.
              • CaptionData — (String) Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. Possible values include:
                • "ALL"
                • "FIELD1_608"
                • "FIELD1_AND_FIELD2_608"
              • InputLossAction — (String) Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. Possible values include:
                • "EMIT_OUTPUT"
                • "PAUSE_OUTPUT"
              • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
            • UdpGroupSettings — (map) Udp Group Settings
              • InputLossAction — (String) Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. Possible values include:
                • "DROP_PROGRAM"
                • "DROP_TS"
                • "EMIT_PROGRAM"
              • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
                • "NONE"
                • "PRIV"
                • "TDRL"
              • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
          • Outputs — required — (Array<map>) Placeholder documentation for __listOfOutput
            • AudioDescriptionNames — (Array<String>) The names of the AudioDescriptions used as audio sources for this output.
            • CaptionDescriptionNames — (Array<String>) The names of the CaptionDescriptions used as caption sources for this output.
            • OutputName — (String) The name used to identify an output.
            • OutputSettings — required — (map) Output type-specific settings.
              • ArchiveOutputSettings — (map) Archive Output Settings
                • ContainerSettings — required — (map) Settings specific to the container type of the file.
                  • M2tsSettings — (map) M2ts Settings
                    • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                      • "DROP"
                      • "ENCODE_SILENCE"
                    • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                      • "AUTO"
                      • "USE_CONFIGURED"
                    • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                    • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                    • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                      • "MULTIPLEX"
                      • "NONE"
                    • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                      • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                      • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                      • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                        • "SDT_FOLLOW"
                        • "SDT_FOLLOW_IF_PRESENT"
                        • "SDT_MANUAL"
                        • "SDT_NONE"
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                      • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                    • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                      • "VIDEO_AND_FIXED_INTERVALS"
                      • "VIDEO_INTERVAL"
                    • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                    • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                      • "VIDEO_AND_AUDIO_PIDS"
                      • "VIDEO_PID"
                    • EcmPid — (String) This field is unused and deprecated.
                    • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                      • "EXCLUDE"
                      • "INCLUDE"
                    • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                    • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                    • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                      • "CONFIGURED_PCR_PERIOD"
                      • "PCR_EVERY_PES_PACKET"
                    • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                    • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                    • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                      • "CBR"
                      • "VBR"
                    • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                      • "EBP"
                      • "EBP_LEGACY"
                      • "NONE"
                      • "PSI_SEGSTART"
                      • "RAI_ADAPT"
                      • "RAI_SEGSTART"
                    • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                      • "MAINTAIN_CADENCE"
                      • "RESET_CADENCE"
                    • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                    • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                      • "NO_PASSTHROUGH"
                      • "PASSTHROUGH"
                    • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                    • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                • Extension — (String) Output file extension. If excluded, this will be auto-selected from the container type.
                • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
              • FrameCaptureOutputSettings — (map) Frame Capture Output Settings
                • NameModifier — (String) Required if the output group contains more than one output. This modifier forms part of the output file name.
              • HlsOutputSettings — (map) Hls Output Settings
                • HlsSettings — required — (map) Settings regarding the underlying stream. These settings are different for audio-only outputs.
                  • AudioOnlyHlsSettings — (map) Audio Only Hls Settings
                    • AudioGroupId — (String) Specifies the group to which the audio Rendition belongs.
                    • AudioOnlyImage — (map) For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by file size * count * count..
                      • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                      • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                      • Username — (String) Documentation update needed
                    • AudioTrackType — (String) Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO Possible values include:
                      • "ALTERNATE_AUDIO_AUTO_SELECT"
                      • "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT"
                      • "ALTERNATE_AUDIO_NOT_AUTO_SELECT"
                      • "AUDIO_ONLY_VARIANT_STREAM"
                  • StandardHlsSettings — (map) Standard Hls Settings
                    • AudioRenditionSets — (String) List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
                    • M3u8Settings — required — (map) Settings information for the .m3u8 container
                      • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                      • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
                      • EcmPid — (String) This parameter is unused and deprecated.
                      • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                      • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                        • "CONFIGURED_PCR_PERIOD"
                        • "PCR_EVERY_PES_PACKET"
                      • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
                      • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
                      • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                      • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
                      • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                      • Scte35Behavior — (String) If set to passthrough, passes any SCTE-35 signals from the input source to this output. Possible values include:
                        • "NO_PASSTHROUGH"
                        • "PASSTHROUGH"
                      • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
                      • TimedMetadataBehavior — (String) When set to passthrough, timed metadata is passed through from input to output. Possible values include:
                        • "NO_PASSTHROUGH"
                        • "PASSTHROUGH"
                      • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                      • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
                • NameModifier — (String) String concatenated to the end of the destination filename. Accepts \"Format Identifiers\":#formatIdentifierParameters.
                • SegmentModifier — (String) String concatenated to end of segment filenames.
              • MediaPackageOutputSettings — (map) Media Package Output Settings
              • MsSmoothOutputSettings — (map) Ms Smooth Output Settings
                • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
              • RtmpOutputSettings — (map) Rtmp Output Settings
                • CertificateMode — (String) If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. Possible values include:
                  • "SELF_SIGNED"
                  • "VERIFY_AUTHENTICITY"
                • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
                • Destination — required — (map) The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
                  • DestinationRefId — (String) Placeholder documentation for __string
                • NumRetries — (Integer) Number of retry attempts.
              • UdpOutputSettings — (map) Udp Output Settings
                • BufferMsec — (Integer) UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
                • ContainerSettings — required — (map) Udp Container Settings
                  • M2tsSettings — (map) M2ts Settings
                    • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                      • "DROP"
                      • "ENCODE_SILENCE"
                    • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                      • "AUTO"
                      • "USE_CONFIGURED"
                    • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                    • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                    • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                      • "MULTIPLEX"
                      • "NONE"
                    • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                      • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                      • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                      • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                        • "SDT_FOLLOW"
                        • "SDT_FOLLOW_IF_PRESENT"
                        • "SDT_MANUAL"
                        • "SDT_NONE"
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                      • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                    • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                      • "VIDEO_AND_FIXED_INTERVALS"
                      • "VIDEO_INTERVAL"
                    • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                    • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                      • "VIDEO_AND_AUDIO_PIDS"
                      • "VIDEO_PID"
                    • EcmPid — (String) This field is unused and deprecated.
                    • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                      • "EXCLUDE"
                      • "INCLUDE"
                    • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                    • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                    • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                      • "CONFIGURED_PCR_PERIOD"
                      • "PCR_EVERY_PES_PACKET"
                    • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                    • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                    • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                      • "CBR"
                      • "VBR"
                    • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                      • "EBP"
                      • "EBP_LEGACY"
                      • "NONE"
                      • "PSI_SEGSTART"
                      • "RAI_ADAPT"
                      • "RAI_SEGSTART"
                    • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                      • "MAINTAIN_CADENCE"
                      • "RESET_CADENCE"
                    • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                    • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                      • "NO_PASSTHROUGH"
                      • "PASSTHROUGH"
                    • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                    • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                • Destination — required — (map) Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
                  • DestinationRefId — (String) Placeholder documentation for __string
                • FecOutputSettings — (map) Settings for enabling and adjusting Forward Error Correction on UDP outputs.
                  • ColumnDepth — (Integer) Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
                  • IncludeFec — (String) Enables column only or column and row based FEC Possible values include:
                    • "COLUMN"
                    • "COLUMN_AND_ROW"
                  • RowLength — (Integer) Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
            • VideoDescriptionName — (String) The name of the VideoDescription used as the source for this output.
        • TimecodeConfig — required — (map) Contains settings used to acquire and adjust timecode information from inputs.
          • Source — required — (String) Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. Possible values include:
            • "EMBEDDED"
            • "SYSTEMCLOCK"
            • "ZEROBASED"
          • SyncThreshold — (Integer) Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
        • VideoDescriptions — required — (Array<map>) Placeholder documentation for __listOfVideoDescription
          • CodecSettings — (map) Video codec settings.
            • FrameCaptureSettings — (map) Frame Capture Settings
              • CaptureInterval — required — (Integer) The frequency, in seconds, for capturing frames for inclusion in the output. For example, "10" means capture a frame every 10 seconds.
            • H264Settings — (map) H264 Settings
              • AdaptiveQuantization — (String) Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. Possible values include:
                • "HIGH"
                • "HIGHER"
                • "LOW"
                • "MAX"
                • "MEDIUM"
                • "OFF"
              • AfdSignaling — (String) Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. Possible values include:
                • "AUTO"
                • "FIXED"
                • "NONE"
              • Bitrate — (Integer) Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
              • BufFillPct — (Integer) Percentage of the buffer that should initially be filled (HRD buffer model).
              • BufSize — (Integer) Size of buffer (HRD buffer model) in bits/second.
              • ColorMetadata — (String) Includes colorspace metadata in the output. Possible values include:
                • "IGNORE"
                • "INSERT"
              • EntropyEncoding — (String) Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. Possible values include:
                • "CABAC"
                • "CAVLC"
              • FixedAfd — (String) Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. Possible values include:
                • "AFD_0000"
                • "AFD_0010"
                • "AFD_0011"
                • "AFD_0100"
                • "AFD_1000"
                • "AFD_1001"
                • "AFD_1010"
                • "AFD_1011"
                • "AFD_1101"
                • "AFD_1110"
                • "AFD_1111"
              • FlickerAq — (String) If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • FramerateControl — (String) This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. Possible values include:
                • "INITIALIZE_FROM_SOURCE"
                • "SPECIFIED"
              • FramerateDenominator — (Integer) Framerate denominator.
              • FramerateNumerator — (Integer) Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
              • GopBReference — (String) Documentation update needed Possible values include:
                • "DISABLED"
                • "ENABLED"
              • GopClosedCadence — (Integer) Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
              • GopNumBFrames — (Integer) Number of B-frames between reference frames.
              • GopSize — (Float) GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. Must be greater than zero.
              • GopSizeUnits — (String) Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. Possible values include:
                • "FRAMES"
                • "SECONDS"
              • Level — (String) H.264 Level. Possible values include:
                • "H264_LEVEL_1"
                • "H264_LEVEL_1_1"
                • "H264_LEVEL_1_2"
                • "H264_LEVEL_1_3"
                • "H264_LEVEL_2"
                • "H264_LEVEL_2_1"
                • "H264_LEVEL_2_2"
                • "H264_LEVEL_3"
                • "H264_LEVEL_3_1"
                • "H264_LEVEL_3_2"
                • "H264_LEVEL_4"
                • "H264_LEVEL_4_1"
                • "H264_LEVEL_4_2"
                • "H264_LEVEL_5"
                • "H264_LEVEL_5_1"
                • "H264_LEVEL_5_2"
                • "H264_LEVEL_AUTO"
              • LookAheadRateControl — (String) Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. Possible values include:
                • "HIGH"
                • "LOW"
                • "MEDIUM"
              • MaxBitrate — (Integer) For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
              • MinIInterval — (Integer) Only meaningful if sceneChangeDetect is set to enabled. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
              • NumRefFrames — (Integer) Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
              • ParControl — (String) This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. Possible values include:
                • "INITIALIZE_FROM_SOURCE"
                • "SPECIFIED"
              • ParDenominator — (Integer) Pixel Aspect Ratio denominator.
              • ParNumerator — (Integer) Pixel Aspect Ratio numerator.
              • Profile — (String) H.264 Profile. Possible values include:
                • "BASELINE"
                • "HIGH"
                • "HIGH_10BIT"
                • "HIGH_422"
                • "HIGH_422_10BIT"
                • "MAIN"
              • QvbrQualityLevel — (Integer) Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
              • RateControlMode — (String) Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Possible values include:
                • "CBR"
                • "QVBR"
                • "VBR"
              • ScanType — (String) Sets the scan type of the output to progressive or top-field-first interlaced. Possible values include:
                • "INTERLACED"
                • "PROGRESSIVE"
              • SceneChangeDetect — (String) Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • Slices — (Integer) Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
              • Softness — (Integer) Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
              • SpatialAq — (String) If set to enabled, adjust quantization within each frame based on spatial variation of content complexity. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • SubgopLength — (String) If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. Possible values include:
                • "DYNAMIC"
                • "FIXED"
              • Syntax — (String) Produces a bitstream compliant with SMPTE RP-2027. Possible values include:
                • "DEFAULT"
                • "RP2027"
              • TemporalAq — (String) If set to enabled, adjust quantization within each frame based on temporal variation of content complexity. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • TimecodeInsertion — (String) Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config Possible values include:
                • "DISABLED"
                • "PIC_TIMING_SEI"
          • Height — (Integer) Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
          • Name — required — (String) The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
          • RespondToAfd — (String) Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped. Possible values include:
            • "NONE"
            • "PASSTHROUGH"
            • "RESPOND"
          • ScalingBehavior — (String) STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. Possible values include:
            • "DEFAULT"
            • "STRETCH_TO_OUTPUT"
          • Sharpness — (Integer) Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
          • Width — (Integer) Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
      • Id — (String) The unique id of the channel.
      • InputAttachments — (Array<map>) List of input attachments for channel.
        • InputAttachmentName — (String) User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
        • InputId — (String) The ID of the input
        • InputSettings — (map) Settings of an input (caption selector, etc.)
          • AudioSelectors — (Array<map>) Used to select the audio stream to decode for inputs that have multiple available.
            • Name — required — (String) The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
            • SelectorSettings — (map) The audio selector settings.
              • AudioLanguageSelection — (map) Audio Language Selection
                • LanguageCode — required — (String) Selects a specific three-letter language code from within an audio source.
                • LanguageSelectionPolicy — (String) When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. Possible values include:
                  • "LOOSE"
                  • "STRICT"
              • AudioPidSelection — (map) Audio Pid Selection
                • Pid — required — (Integer) Selects a specific PID from within a source.
          • CaptionSelectors — (Array<map>) Used to select the caption input to use for inputs that have multiple available.
            • LanguageCode — (String) When specified this field indicates the three letter language code of the caption track to extract from the source.
            • Name — required — (String) Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
            • SelectorSettings — (map) Caption selector settings.
              • AribSourceSettings — (map) Arib Source Settings
              • DvbSubSourceSettings — (map) Dvb Sub Source Settings
                • Pid — (Integer) When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
              • EmbeddedSourceSettings — (map) Embedded Source Settings
                • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                  • "DISABLED"
                  • "UPCONVERT"
                • Scte20Detection — (String) Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. Possible values include:
                  • "AUTO"
                  • "OFF"
                • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
                • Source608TrackNumber — (Integer) This field is unused and deprecated.
              • Scte20SourceSettings — (map) Scte20 Source Settings
                • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                  • "DISABLED"
                  • "UPCONVERT"
                • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
              • Scte27SourceSettings — (map) Scte27 Source Settings
                • Pid — (Integer) The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
              • TeletextSourceSettings — (map) Teletext Source Settings
                • PageNumber — (String) Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
          • DeblockFilter — (String) Enable or disable the deblock filter when filtering. Possible values include:
            • "DISABLED"
            • "ENABLED"
          • DenoiseFilter — (String) Enable or disable the denoise filter when filtering. Possible values include:
            • "DISABLED"
            • "ENABLED"
          • FilterStrength — (Integer) Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
          • InputFilter — (String) Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type Possible values include:
            • "AUTO"
            • "DISABLED"
            • "FORCED"
          • NetworkInputSettings — (map) Input settings.
            • HlsInputSettings — (map) Specifies HLS input settings when the uri is for a HLS manifest.
              • Bandwidth — (Integer) When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
              • BufferSegments — (Integer) When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
              • Retries — (Integer) The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
              • RetryInterval — (Integer) The number of seconds between retries when an attempt to read a manifest or segment fails.
            • ServerValidation — (String) Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. Possible values include:
              • "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME"
              • "CHECK_CRYPTOGRAPHY_ONLY"
          • SourceEndBehavior — (String) Loop input if it is a file. This allows a file input to be streamed indefinitely. Possible values include:
            • "CONTINUE"
            • "LOOP"
          • VideoSelector — (map) Informs which video elementary stream to decode for input types that have multiple available.
            • ColorSpace — (String) Specifies the colorspace of an input. This setting works in tandem with colorSpaceConversion to determine if any conversion will be performed. Possible values include:
              • "FOLLOW"
              • "REC_601"
              • "REC_709"
            • ColorSpaceUsage — (String) Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. Possible values include:
              • "FALLBACK"
              • "FORCE"
            • SelectorSettings — (map) The video selector settings.
              • VideoSelectorPid — (map) Video Selector Pid
                • Pid — (Integer) Selects a specific PID from within a video source.
              • VideoSelectorProgramId — (map) Video Selector Program Id
                • ProgramId — (Integer) Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
      • InputSpecification — (map) Placeholder documentation for InputSpecification
        • Codec — (String) Input codec Possible values include:
          • "MPEG2"
          • "AVC"
          • "HEVC"
        • MaximumBitrate — (String) Maximum input bitrate, categorized coarsely Possible values include:
          • "MAX_10_MBPS"
          • "MAX_20_MBPS"
          • "MAX_50_MBPS"
        • Resolution — (String) Input resolution, categorized coarsely Possible values include:
          • "SD"
          • "HD"
          • "UHD"
      • LogLevel — (String) The log level being written to CloudWatch Logs. Possible values include:
        • "ERROR"
        • "WARNING"
        • "INFO"
        • "DEBUG"
        • "DISABLED"
      • Name — (String) The name of the channel. (user-mutable)
      • PipelinesRunningCount — (Integer) The number of currently healthy pipelines.
      • RoleArn — (String) The Amazon Resource Name (ARN) of the role assumed when running the Channel.
      • State — (String) Placeholder documentation for ChannelState Possible values include:
        • "CREATING"
        • "CREATE_FAILED"
        • "IDLE"
        • "STARTING"
        • "RUNNING"
        • "RECOVERING"
        • "STOPPING"
        • "DELETING"
        • "DELETED"
      • Tags — (map<String>) A collection of key-value pairs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

stopChannel(params = {}, callback) ⇒ AWS.Request

Stops a running channel

Service Reference:

Examples:

Calling the stopChannel operation

var params = {
  ChannelId: 'STRING_VALUE' /* required */
};
medialive.stopChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ChannelId — (String) A request to stop a running channel

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Arn — (String) The unique arn of the channel.
      • ChannelClass — (String) The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. Possible values include:
        • "STANDARD"
        • "SINGLE_PIPELINE"
      • Destinations — (Array<map>) A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
        • Id — (String) User-specified id. This is used in an output group or an output.
        • MediaPackageSettings — (Array<map>) Destination settings for a MediaPackage output; one destination for both encoders.
          • ChannelId — (String) ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
        • Settings — (Array<map>) Destination settings for a standard output; one destination for each redundant encoder.
          • PasswordParam — (String) key used to extract the password from EC2 Parameter store
          • StreamName — (String) Stream name for RTMP destinations (URLs of type rtmp://)
          • Url — (String) A URL specifying a destination
          • Username — (String) username for destination
      • EgressEndpoints — (Array<map>) The endpoints where outgoing connections initiate from
        • SourceIp — (String) Public IP of where a channel's output comes from
      • EncoderSettings — (map) Encoder Settings
        • AudioDescriptions — required — (Array<map>) Placeholder documentation for __listOfAudioDescription
          • AudioNormalizationSettings — (map) Advanced audio normalization settings.
            • Algorithm — (String) Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. Possible values include:
              • "ITU_1770_1"
              • "ITU_1770_2"
            • AlgorithmControl — (String) When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. Possible values include:
              • "CORRECT_AUDIO"
            • TargetLkfs — (Float) Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
          • AudioSelectorName — required — (String) The name of the AudioSelector used as the source for this AudioDescription.
          • AudioType — (String) Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. Possible values include:
            • "CLEAN_EFFECTS"
            • "HEARING_IMPAIRED"
            • "UNDEFINED"
            • "VISUAL_IMPAIRED_COMMENTARY"
          • AudioTypeControl — (String) Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. Possible values include:
            • "FOLLOW_INPUT"
            • "USE_CONFIGURED"
          • CodecSettings — (map) Audio codec settings.
            • AacSettings — (map) Aac Settings
              • Bitrate — (Float) Average bitrate in bits/second. Valid values depend on rate control mode and profile.
              • CodingMode — (String) Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. Possible values include:
                • "AD_RECEIVER_MIX"
                • "CODING_MODE_1_0"
                • "CODING_MODE_1_1"
                • "CODING_MODE_2_0"
                • "CODING_MODE_5_1"
              • InputType — (String) Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD. Possible values include:
                • "BROADCASTER_MIXED_AD"
                • "NORMAL"
              • Profile — (String) AAC Profile. Possible values include:
                • "HEV1"
                • "HEV2"
                • "LC"
              • RateControlMode — (String) Rate Control Mode. Possible values include:
                • "CBR"
                • "VBR"
              • RawFormat — (String) Sets LATM / LOAS AAC output for raw containers. Possible values include:
                • "LATM_LOAS"
                • "NONE"
              • SampleRate — (Float) Sample rate in Hz. Valid values depend on rate control mode and profile.
              • Spec — (String) Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. Possible values include:
                • "MPEG2"
                • "MPEG4"
              • VbrQuality — (String) VBR Quality Level - Only used if rateControlMode is VBR. Possible values include:
                • "HIGH"
                • "LOW"
                • "MEDIUM_HIGH"
                • "MEDIUM_LOW"
            • Ac3Settings — (map) Ac3 Settings
              • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
              • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. Possible values include:
                • "COMMENTARY"
                • "COMPLETE_MAIN"
                • "DIALOGUE"
                • "EMERGENCY"
                • "HEARING_IMPAIRED"
                • "MUSIC_AND_EFFECTS"
                • "VISUALLY_IMPAIRED"
                • "VOICE_OVER"
              • CodingMode — (String) Dolby Digital coding mode. Determines number of channels. Possible values include:
                • "CODING_MODE_1_0"
                • "CODING_MODE_1_1"
                • "CODING_MODE_2_0"
                • "CODING_MODE_3_2_LFE"
              • Dialnorm — (Integer) Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
              • DrcProfile — (String) If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. Possible values include:
                • "FILM_STANDARD"
                • "NONE"
              • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • MetadataControl — (String) When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
                • "FOLLOW_INPUT"
                • "USE_CONFIGURED"
            • Eac3Settings — (map) Eac3 Settings
              • AttenuationControl — (String) When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. Possible values include:
                • "ATTENUATE_3_DB"
                • "NONE"
              • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
              • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. Possible values include:
                • "COMMENTARY"
                • "COMPLETE_MAIN"
                • "EMERGENCY"
                • "HEARING_IMPAIRED"
                • "VISUALLY_IMPAIRED"
              • CodingMode — (String) Dolby Digital Plus coding mode. Determines number of channels. Possible values include:
                • "CODING_MODE_1_0"
                • "CODING_MODE_2_0"
                • "CODING_MODE_3_2"
              • DcFilter — (String) When set to enabled, activates a DC highpass filter for all input channels. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • Dialnorm — (Integer) Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
              • DrcLine — (String) Sets the Dolby dynamic range compression profile. Possible values include:
                • "FILM_LIGHT"
                • "FILM_STANDARD"
                • "MUSIC_LIGHT"
                • "MUSIC_STANDARD"
                • "NONE"
                • "SPEECH"
              • DrcRf — (String) Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. Possible values include:
                • "FILM_LIGHT"
                • "FILM_STANDARD"
                • "MUSIC_LIGHT"
                • "MUSIC_STANDARD"
                • "NONE"
                • "SPEECH"
              • LfeControl — (String) When encoding 3/2 audio, setting to lfe enables the LFE channel Possible values include:
                • "LFE"
                • "NO_LFE"
              • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • LoRoCenterMixLevel — (Float) Left only/Right only center mix level. Only used for 3/2 coding mode.
              • LoRoSurroundMixLevel — (Float) Left only/Right only surround mix level. Only used for 3/2 coding mode.
              • LtRtCenterMixLevel — (Float) Left total/Right total center mix level. Only used for 3/2 coding mode.
              • LtRtSurroundMixLevel — (Float) Left total/Right total surround mix level. Only used for 3/2 coding mode.
              • MetadataControl — (String) When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
                • "FOLLOW_INPUT"
                • "USE_CONFIGURED"
              • PassthroughControl — (String) When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding. Possible values include:
                • "NO_PASSTHROUGH"
                • "WHEN_POSSIBLE"
              • PhaseControl — (String) When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. Possible values include:
                • "NO_SHIFT"
                • "SHIFT_90_DEGREES"
              • StereoDownmix — (String) Stereo downmix preference. Only used for 3/2 coding mode. Possible values include:
                • "DPL2"
                • "LO_RO"
                • "LT_RT"
                • "NOT_INDICATED"
              • SurroundExMode — (String) When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. Possible values include:
                • "DISABLED"
                • "ENABLED"
                • "NOT_INDICATED"
              • SurroundMode — (String) When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. Possible values include:
                • "DISABLED"
                • "ENABLED"
                • "NOT_INDICATED"
            • Mp2Settings — (map) Mp2 Settings
              • Bitrate — (Float) Average bitrate in bits/second.
              • CodingMode — (String) The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). Possible values include:
                • "CODING_MODE_1_0"
                • "CODING_MODE_2_0"
              • SampleRate — (Float) Sample rate in Hz.
            • PassThroughSettings — (map) Pass Through Settings
          • LanguageCode — (String) Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
          • LanguageCodeControl — (String) Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. Possible values include:
            • "FOLLOW_INPUT"
            • "USE_CONFIGURED"
          • Name — required — (String) The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
          • RemixSettings — (map) Settings that control how input audio channels are remixed into the output audio channels.
            • ChannelMappings — required — (Array<map>) Mapping of input channels to output channels, with appropriate gain adjustments.
              • InputChannelLevels — required — (Array<map>) Indices and gain values for each input channel that should be remixed into this output channel.
                • Gain — required — (Integer) Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
                • InputChannel — required — (Integer) The index of the input channel used as a source.
              • OutputChannel — required — (Integer) The index of the output channel being produced.
            • ChannelsIn — (Integer) Number of input channels to be used.
            • ChannelsOut — (Integer) Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
          • StreamName — (String) Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
        • AvailBlanking — (map) Settings for ad avail blanking.
          • AvailBlankingImage — (map) Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
            • Username — (String) Documentation update needed
          • State — (String) When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added. Possible values include:
            • "DISABLED"
            • "ENABLED"
        • AvailConfiguration — (map) Event-wide configuration settings for ad avail insertion.
          • AvailSettings — (map) Ad avail settings.
            • Scte35SpliceInsert — (map) Scte35 Splice Insert
              • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
              • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
              • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
            • Scte35TimeSignalApos — (map) Scte35 Time Signal Apos
              • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
              • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
              • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                • "FOLLOW"
                • "IGNORE"
        • BlackoutSlate — (map) Settings for blackout slate.
          • BlackoutSlateImage — (map) Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
            • Username — (String) Documentation update needed
          • NetworkEndBlackout — (String) Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". Possible values include:
            • "DISABLED"
            • "ENABLED"
          • NetworkEndBlackoutImage — (map) Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
            • Username — (String) Documentation update needed
          • NetworkId — (String) Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
          • State — (String) When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata. Possible values include:
            • "DISABLED"
            • "ENABLED"
        • CaptionDescriptions — (Array<map>) Settings for caption decriptions
          • CaptionSelectorName — required — (String) Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
          • DestinationSettings — (map) Additional settings for captions destination that depend on the destination type.
            • AribDestinationSettings — (map) Arib Destination Settings
            • BurnInDestinationSettings — (map) Burn In Destination Settings
              • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "CENTERED"
                • "LEFT"
                • "SMART"
              • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
                • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                • Username — (String) Documentation update needed
              • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
              • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
              • FontSize — (String) When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
              • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
              • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
              • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
              • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
                • "FIXED"
                • "SCALED"
              • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
              • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
            • DvbSubDestinationSettings — (map) Dvb Sub Destination Settings
              • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "CENTERED"
                • "LEFT"
                • "SMART"
              • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
                • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                • Username — (String) Documentation update needed
              • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
              • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
              • FontSize — (String) When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
              • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "BLUE"
                • "GREEN"
                • "RED"
                • "WHITE"
                • "YELLOW"
              • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
              • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                • "BLACK"
                • "NONE"
                • "WHITE"
              • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
              • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
              • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
              • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
                • "FIXED"
                • "SCALED"
              • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
              • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
            • EmbeddedDestinationSettings — (map) Embedded Destination Settings
            • EmbeddedPlusScte20DestinationSettings — (map) Embedded Plus Scte20 Destination Settings
            • RtmpCaptionInfoDestinationSettings — (map) Rtmp Caption Info Destination Settings
            • Scte20PlusEmbeddedDestinationSettings — (map) Scte20 Plus Embedded Destination Settings
            • Scte27DestinationSettings — (map) Scte27 Destination Settings
            • SmpteTtDestinationSettings — (map) Smpte Tt Destination Settings
            • TeletextDestinationSettings — (map) Teletext Destination Settings
            • TtmlDestinationSettings — (map) Ttml Destination Settings
              • StyleControl — (String) When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. Possible values include:
                • "PASSTHROUGH"
                • "USE_CONFIGURED"
            • WebvttDestinationSettings — (map) Webvtt Destination Settings
          • LanguageCode — (String) ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
          • LanguageDescription — (String) Human readable information to indicate captions available for players (eg. English, or Spanish).
          • Name — required — (String) Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
        • GlobalConfiguration — (map) Configuration settings that apply to the event as a whole.
          • InitialAudioGain — (Integer) Value to set the initial audio gain for the Live Event.
          • InputEndAction — (String) Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). Possible values include:
            • "NONE"
            • "SWITCH_AND_LOOP_INPUTS"
          • InputLossBehavior — (map) Settings for system actions when input is lost.
            • BlackFrameMsec — (Integer) Documentation update needed
            • InputLossImageColor — (String) When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
            • InputLossImageSlate — (map) When input loss image type is "slate" these fields specify the parameters for accessing the slate.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • InputLossImageType — (String) Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. Possible values include:
              • "COLOR"
              • "SLATE"
            • RepeatFrameMsec — (Integer) Documentation update needed
          • OutputLockingMode — (String) Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. Possible values include:
            • "EPOCH_LOCKING"
            • "PIPELINE_LOCKING"
          • OutputTimingSource — (String) Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. Possible values include:
            • "INPUT_CLOCK"
            • "SYSTEM_CLOCK"
          • SupportLowFramerateInputs — (String) Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. Possible values include:
            • "DISABLED"
            • "ENABLED"
        • OutputGroups — required — (Array<map>) Placeholder documentation for __listOfOutputGroup
          • Name — (String) Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
          • OutputGroupSettings — required — (map) Settings associated with the output group.
            • ArchiveGroupSettings — (map) Archive Group Settings
              • Destination — required — (map) A directory and base filename where archive files should be written.
                • DestinationRefId — (String) Placeholder documentation for __string
              • RolloverInterval — (Integer) Number of seconds to write to archive file before closing and starting a new one.
            • FrameCaptureGroupSettings — (map) Frame Capture Group Settings
              • Destination — required — (map) The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
                • DestinationRefId — (String) Placeholder documentation for __string
            • HlsGroupSettings — (map) Hls Group Settings
              • AdMarkers — (Array<String>) Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
              • BaseUrlContent — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
              • BaseUrlManifest — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
              • CaptionLanguageMappings — (Array<map>) Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
                • CaptionChannel — required — (Integer) The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
                • LanguageCode — required — (String) Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
                • LanguageDescription — required — (String) Textual description of language
              • CaptionLanguageSetting — (String) Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest. Possible values include:
                • "INSERT"
                • "NONE"
                • "OMIT"
              • ClientCache — (String) When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • CodecSpecification — (String) Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. Possible values include:
                • "RFC_4281"
                • "RFC_6381"
              • ConstantIv — (String) For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
              • Destination — required — (map) A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
                • DestinationRefId — (String) Placeholder documentation for __string
              • DirectoryStructure — (String) Place segments in subdirectories. Possible values include:
                • "SINGLE_DIRECTORY"
                • "SUBDIRECTORY_PER_STREAM"
              • EncryptionType — (String) Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. Possible values include:
                • "AES128"
                • "SAMPLE_AES"
              • HlsCdnSettings — (map) Parameters that control interactions with the CDN.
                • HlsAkamaiSettings — (map) Hls Akamai Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. Possible values include:
                    • "CHUNKED"
                    • "NON_CHUNKED"
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                  • Salt — (String) Salt for authenticated Akamai.
                  • Token — (String) Token parameter for authenticated akamai. If not specified, gda is used.
                • HlsBasicPutSettings — (map) Hls Basic Put Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                • HlsMediaStoreSettings — (map) Hls Media Store Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • MediaStoreStorageClass — (String) When set to temporal, output files are stored in non-persistent memory for faster reading and writing. Possible values include:
                    • "TEMPORAL"
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                • HlsWebdavSettings — (map) Hls Webdav Settings
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                  • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                  • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to WebDAV. Possible values include:
                    • "CHUNKED"
                    • "NON_CHUNKED"
                  • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                  • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
              • IFrameOnlyPlaylists — (String) DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888" Possible values include:
                • "DISABLED"
                • "STANDARD"
              • IndexNSegments — (Integer) Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
              • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
                • "EMIT_OUTPUT"
                • "PAUSE_OUTPUT"
              • IvInManifest — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. Possible values include:
                • "EXCLUDE"
                • "INCLUDE"
              • IvSource — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. Possible values include:
                • "EXPLICIT"
                • "FOLLOWS_SEGMENT_NUMBER"
              • KeepSegments — (Integer) Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
              • KeyFormat — (String) The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
              • KeyFormatVersions — (String) Either a single positive integer version value or a slash delimited list of version values (1/2/3).
              • KeyProviderSettings — (map) The key provider settings.
                • StaticKeySettings — (map) Static Key Settings
                  • KeyProviderServer — (map) The URL of the license server used for protecting content.
                    • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                    • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                    • Username — (String) Documentation update needed
                  • StaticKeyValue — required — (String) Static key value as a 32 character hexadecimal string.
              • ManifestCompression — (String) When set to gzip, compresses HLS playlist. Possible values include:
                • "GZIP"
                • "NONE"
              • ManifestDurationFormat — (String) Indicates whether the output manifest should use floating point or integer values for segment duration. Possible values include:
                • "FLOATING_POINT"
                • "INTEGER"
              • MinSegmentLength — (Integer) When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
              • Mode — (String) If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. Possible values include:
                • "LIVE"
                • "VOD"
              • OutputSelection — (String) MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group. Possible values include:
                • "MANIFESTS_AND_SEGMENTS"
                • "SEGMENTS_ONLY"
              • ProgramDateTime — (String) Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset. Possible values include:
                • "EXCLUDE"
                • "INCLUDE"
              • ProgramDateTimePeriod — (Integer) Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
              • RedundantManifest — (String) ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • SegmentLength — (Integer) Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
              • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
                • "USE_INPUT_SEGMENTATION"
                • "USE_SEGMENT_DURATION"
              • SegmentsPerSubdirectory — (Integer) Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
              • StreamInfResolution — (String) Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. Possible values include:
                • "EXCLUDE"
                • "INCLUDE"
              • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
                • "NONE"
                • "PRIV"
                • "TDRL"
              • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
              • TimestampDeltaMilliseconds — (Integer) Provides an extra millisecond delta offset to fine tune the timestamps.
              • TsFileMode — (String) SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching. Possible values include:
                • "SEGMENTED_FILES"
                • "SINGLE_FILE"
            • MediaPackageGroupSettings — (map) Media Package Group Settings
              • Destination — required — (map) MediaPackage channel destination.
                • DestinationRefId — (String) Placeholder documentation for __string
            • MsSmoothGroupSettings — (map) Ms Smooth Group Settings
              • AcquisitionPointId — (String) The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
              • AudioOnlyTimecodeControl — (String) If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. Possible values include:
                • "PASSTHROUGH"
                • "USE_CONFIGURED_CLOCK"
              • CertificateMode — (String) If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. Possible values include:
                • "SELF_SIGNED"
                • "VERIFY_AUTHENTICITY"
              • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
              • Destination — required — (map) Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
                • DestinationRefId — (String) Placeholder documentation for __string
              • EventId — (String) MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
              • EventIdMode — (String) Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server. Possible values include:
                • "NO_EVENT_ID"
                • "USE_CONFIGURED"
                • "USE_TIMESTAMP"
              • EventStopBehavior — (String) When set to sendEos, send EOS signal to IIS server when stopping the event Possible values include:
                • "NONE"
                • "SEND_EOS"
              • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
              • FragmentLength — (Integer) Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
              • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
                • "EMIT_OUTPUT"
                • "PAUSE_OUTPUT"
              • NumRetries — (Integer) Number of retry attempts.
              • RestartDelay — (Integer) Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
              • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
                • "USE_INPUT_SEGMENTATION"
                • "USE_SEGMENT_DURATION"
              • SendDelayMs — (Integer) Number of milliseconds to delay the output from the second pipeline.
              • SparseTrackType — (String) If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs. Possible values include:
                • "NONE"
                • "SCTE_35"
              • StreamManifestBehavior — (String) When set to send, send stream manifest so publishing point doesn't start until all streams start. Possible values include:
                • "DO_NOT_SEND"
                • "SEND"
              • TimestampOffset — (String) Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
              • TimestampOffsetMode — (String) Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset Possible values include:
                • "USE_CONFIGURED_OFFSET"
                • "USE_EVENT_START_DATE"
            • RtmpGroupSettings — (map) Rtmp Group Settings
              • AuthenticationScheme — (String) Authentication scheme to use when connecting with CDN Possible values include:
                • "AKAMAI"
                • "COMMON"
              • CacheFullBehavior — (String) Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. Possible values include:
                • "DISCONNECT_IMMEDIATELY"
                • "WAIT_FOR_SERVER"
              • CacheLength — (Integer) Cache length, in seconds, is used to calculate buffer size.
              • CaptionData — (String) Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. Possible values include:
                • "ALL"
                • "FIELD1_608"
                • "FIELD1_AND_FIELD2_608"
              • InputLossAction — (String) Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. Possible values include:
                • "EMIT_OUTPUT"
                • "PAUSE_OUTPUT"
              • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
            • UdpGroupSettings — (map) Udp Group Settings
              • InputLossAction — (String) Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. Possible values include:
                • "DROP_PROGRAM"
                • "DROP_TS"
                • "EMIT_PROGRAM"
              • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
                • "NONE"
                • "PRIV"
                • "TDRL"
              • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
          • Outputs — required — (Array<map>) Placeholder documentation for __listOfOutput
            • AudioDescriptionNames — (Array<String>) The names of the AudioDescriptions used as audio sources for this output.
            • CaptionDescriptionNames — (Array<String>) The names of the CaptionDescriptions used as caption sources for this output.
            • OutputName — (String) The name used to identify an output.
            • OutputSettings — required — (map) Output type-specific settings.
              • ArchiveOutputSettings — (map) Archive Output Settings
                • ContainerSettings — required — (map) Settings specific to the container type of the file.
                  • M2tsSettings — (map) M2ts Settings
                    • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                      • "DROP"
                      • "ENCODE_SILENCE"
                    • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                      • "AUTO"
                      • "USE_CONFIGURED"
                    • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                    • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                    • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                      • "MULTIPLEX"
                      • "NONE"
                    • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                      • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                      • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                      • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                        • "SDT_FOLLOW"
                        • "SDT_FOLLOW_IF_PRESENT"
                        • "SDT_MANUAL"
                        • "SDT_NONE"
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                      • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                    • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                      • "VIDEO_AND_FIXED_INTERVALS"
                      • "VIDEO_INTERVAL"
                    • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                    • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                      • "VIDEO_AND_AUDIO_PIDS"
                      • "VIDEO_PID"
                    • EcmPid — (String) This field is unused and deprecated.
                    • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                      • "EXCLUDE"
                      • "INCLUDE"
                    • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                    • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                    • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                      • "CONFIGURED_PCR_PERIOD"
                      • "PCR_EVERY_PES_PACKET"
                    • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                    • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                    • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                      • "CBR"
                      • "VBR"
                    • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                      • "EBP"
                      • "EBP_LEGACY"
                      • "NONE"
                      • "PSI_SEGSTART"
                      • "RAI_ADAPT"
                      • "RAI_SEGSTART"
                    • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                      • "MAINTAIN_CADENCE"
                      • "RESET_CADENCE"
                    • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                    • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                      • "NO_PASSTHROUGH"
                      • "PASSTHROUGH"
                    • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                    • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                • Extension — (String) Output file extension. If excluded, this will be auto-selected from the container type.
                • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
              • FrameCaptureOutputSettings — (map) Frame Capture Output Settings
                • NameModifier — (String) Required if the output group contains more than one output. This modifier forms part of the output file name.
              • HlsOutputSettings — (map) Hls Output Settings
                • HlsSettings — required — (map) Settings regarding the underlying stream. These settings are different for audio-only outputs.
                  • AudioOnlyHlsSettings — (map) Audio Only Hls Settings
                    • AudioGroupId — (String) Specifies the group to which the audio Rendition belongs.
                    • AudioOnlyImage — (map) For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by file size * count * count..
                      • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                      • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                      • Username — (String) Documentation update needed
                    • AudioTrackType — (String) Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO Possible values include:
                      • "ALTERNATE_AUDIO_AUTO_SELECT"
                      • "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT"
                      • "ALTERNATE_AUDIO_NOT_AUTO_SELECT"
                      • "AUDIO_ONLY_VARIANT_STREAM"
                  • StandardHlsSettings — (map) Standard Hls Settings
                    • AudioRenditionSets — (String) List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
                    • M3u8Settings — required — (map) Settings information for the .m3u8 container
                      • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                      • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
                      • EcmPid — (String) This parameter is unused and deprecated.
                      • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                      • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                        • "CONFIGURED_PCR_PERIOD"
                        • "PCR_EVERY_PES_PACKET"
                      • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
                      • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
                      • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                      • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
                      • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                      • Scte35Behavior — (String) If set to passthrough, passes any SCTE-35 signals from the input source to this output. Possible values include:
                        • "NO_PASSTHROUGH"
                        • "PASSTHROUGH"
                      • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
                      • TimedMetadataBehavior — (String) When set to passthrough, timed metadata is passed through from input to output. Possible values include:
                        • "NO_PASSTHROUGH"
                        • "PASSTHROUGH"
                      • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                      • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
                • NameModifier — (String) String concatenated to the end of the destination filename. Accepts \"Format Identifiers\":#formatIdentifierParameters.
                • SegmentModifier — (String) String concatenated to end of segment filenames.
              • MediaPackageOutputSettings — (map) Media Package Output Settings
              • MsSmoothOutputSettings — (map) Ms Smooth Output Settings
                • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
              • RtmpOutputSettings — (map) Rtmp Output Settings
                • CertificateMode — (String) If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. Possible values include:
                  • "SELF_SIGNED"
                  • "VERIFY_AUTHENTICITY"
                • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
                • Destination — required — (map) The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
                  • DestinationRefId — (String) Placeholder documentation for __string
                • NumRetries — (Integer) Number of retry attempts.
              • UdpOutputSettings — (map) Udp Output Settings
                • BufferMsec — (Integer) UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
                • ContainerSettings — required — (map) Udp Container Settings
                  • M2tsSettings — (map) M2ts Settings
                    • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                      • "DROP"
                      • "ENCODE_SILENCE"
                    • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                      • "AUTO"
                      • "USE_CONFIGURED"
                    • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                    • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                      • "ATSC"
                      • "DVB"
                    • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                    • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                      • "MULTIPLEX"
                      • "NONE"
                    • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                      • "DISABLED"
                      • "ENABLED"
                    • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                      • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                      • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                      • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                        • "SDT_FOLLOW"
                        • "SDT_FOLLOW_IF_PRESENT"
                        • "SDT_MANUAL"
                        • "SDT_NONE"
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                      • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                    • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                      • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                      • "VIDEO_AND_FIXED_INTERVALS"
                      • "VIDEO_INTERVAL"
                    • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                    • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                      • "VIDEO_AND_AUDIO_PIDS"
                      • "VIDEO_PID"
                    • EcmPid — (String) This field is unused and deprecated.
                    • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                      • "EXCLUDE"
                      • "INCLUDE"
                    • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                    • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                    • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                      • "CONFIGURED_PCR_PERIOD"
                      • "PCR_EVERY_PES_PACKET"
                    • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                    • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                    • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                    • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                      • "CBR"
                      • "VBR"
                    • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                    • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                      • "NONE"
                      • "PASSTHROUGH"
                    • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                      • "EBP"
                      • "EBP_LEGACY"
                      • "NONE"
                      • "PSI_SEGSTART"
                      • "RAI_ADAPT"
                      • "RAI_SEGSTART"
                    • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                      • "MAINTAIN_CADENCE"
                      • "RESET_CADENCE"
                    • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                    • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                      • "NO_PASSTHROUGH"
                      • "PASSTHROUGH"
                    • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                    • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                • Destination — required — (map) Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
                  • DestinationRefId — (String) Placeholder documentation for __string
                • FecOutputSettings — (map) Settings for enabling and adjusting Forward Error Correction on UDP outputs.
                  • ColumnDepth — (Integer) Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
                  • IncludeFec — (String) Enables column only or column and row based FEC Possible values include:
                    • "COLUMN"
                    • "COLUMN_AND_ROW"
                  • RowLength — (Integer) Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
            • VideoDescriptionName — (String) The name of the VideoDescription used as the source for this output.
        • TimecodeConfig — required — (map) Contains settings used to acquire and adjust timecode information from inputs.
          • Source — required — (String) Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. Possible values include:
            • "EMBEDDED"
            • "SYSTEMCLOCK"
            • "ZEROBASED"
          • SyncThreshold — (Integer) Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
        • VideoDescriptions — required — (Array<map>) Placeholder documentation for __listOfVideoDescription
          • CodecSettings — (map) Video codec settings.
            • FrameCaptureSettings — (map) Frame Capture Settings
              • CaptureInterval — required — (Integer) The frequency, in seconds, for capturing frames for inclusion in the output. For example, "10" means capture a frame every 10 seconds.
            • H264Settings — (map) H264 Settings
              • AdaptiveQuantization — (String) Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. Possible values include:
                • "HIGH"
                • "HIGHER"
                • "LOW"
                • "MAX"
                • "MEDIUM"
                • "OFF"
              • AfdSignaling — (String) Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. Possible values include:
                • "AUTO"
                • "FIXED"
                • "NONE"
              • Bitrate — (Integer) Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
              • BufFillPct — (Integer) Percentage of the buffer that should initially be filled (HRD buffer model).
              • BufSize — (Integer) Size of buffer (HRD buffer model) in bits/second.
              • ColorMetadata — (String) Includes colorspace metadata in the output. Possible values include:
                • "IGNORE"
                • "INSERT"
              • EntropyEncoding — (String) Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. Possible values include:
                • "CABAC"
                • "CAVLC"
              • FixedAfd — (String) Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. Possible values include:
                • "AFD_0000"
                • "AFD_0010"
                • "AFD_0011"
                • "AFD_0100"
                • "AFD_1000"
                • "AFD_1001"
                • "AFD_1010"
                • "AFD_1011"
                • "AFD_1101"
                • "AFD_1110"
                • "AFD_1111"
              • FlickerAq — (String) If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • FramerateControl — (String) This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. Possible values include:
                • "INITIALIZE_FROM_SOURCE"
                • "SPECIFIED"
              • FramerateDenominator — (Integer) Framerate denominator.
              • FramerateNumerator — (Integer) Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
              • GopBReference — (String) Documentation update needed Possible values include:
                • "DISABLED"
                • "ENABLED"
              • GopClosedCadence — (Integer) Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
              • GopNumBFrames — (Integer) Number of B-frames between reference frames.
              • GopSize — (Float) GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. Must be greater than zero.
              • GopSizeUnits — (String) Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. Possible values include:
                • "FRAMES"
                • "SECONDS"
              • Level — (String) H.264 Level. Possible values include:
                • "H264_LEVEL_1"
                • "H264_LEVEL_1_1"
                • "H264_LEVEL_1_2"
                • "H264_LEVEL_1_3"
                • "H264_LEVEL_2"
                • "H264_LEVEL_2_1"
                • "H264_LEVEL_2_2"
                • "H264_LEVEL_3"
                • "H264_LEVEL_3_1"
                • "H264_LEVEL_3_2"
                • "H264_LEVEL_4"
                • "H264_LEVEL_4_1"
                • "H264_LEVEL_4_2"
                • "H264_LEVEL_5"
                • "H264_LEVEL_5_1"
                • "H264_LEVEL_5_2"
                • "H264_LEVEL_AUTO"
              • LookAheadRateControl — (String) Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. Possible values include:
                • "HIGH"
                • "LOW"
                • "MEDIUM"
              • MaxBitrate — (Integer) For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
              • MinIInterval — (Integer) Only meaningful if sceneChangeDetect is set to enabled. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
              • NumRefFrames — (Integer) Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
              • ParControl — (String) This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. Possible values include:
                • "INITIALIZE_FROM_SOURCE"
                • "SPECIFIED"
              • ParDenominator — (Integer) Pixel Aspect Ratio denominator.
              • ParNumerator — (Integer) Pixel Aspect Ratio numerator.
              • Profile — (String) H.264 Profile. Possible values include:
                • "BASELINE"
                • "HIGH"
                • "HIGH_10BIT"
                • "HIGH_422"
                • "HIGH_422_10BIT"
                • "MAIN"
              • QvbrQualityLevel — (Integer) Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
              • RateControlMode — (String) Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Possible values include:
                • "CBR"
                • "QVBR"
                • "VBR"
              • ScanType — (String) Sets the scan type of the output to progressive or top-field-first interlaced. Possible values include:
                • "INTERLACED"
                • "PROGRESSIVE"
              • SceneChangeDetect — (String) Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • Slices — (Integer) Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
              • Softness — (Integer) Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
              • SpatialAq — (String) If set to enabled, adjust quantization within each frame based on spatial variation of content complexity. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • SubgopLength — (String) If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. Possible values include:
                • "DYNAMIC"
                • "FIXED"
              • Syntax — (String) Produces a bitstream compliant with SMPTE RP-2027. Possible values include:
                • "DEFAULT"
                • "RP2027"
              • TemporalAq — (String) If set to enabled, adjust quantization within each frame based on temporal variation of content complexity. Possible values include:
                • "DISABLED"
                • "ENABLED"
              • TimecodeInsertion — (String) Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config Possible values include:
                • "DISABLED"
                • "PIC_TIMING_SEI"
          • Height — (Integer) Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
          • Name — required — (String) The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
          • RespondToAfd — (String) Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped. Possible values include:
            • "NONE"
            • "PASSTHROUGH"
            • "RESPOND"
          • ScalingBehavior — (String) STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. Possible values include:
            • "DEFAULT"
            • "STRETCH_TO_OUTPUT"
          • Sharpness — (Integer) Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
          • Width — (Integer) Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
      • Id — (String) The unique id of the channel.
      • InputAttachments — (Array<map>) List of input attachments for channel.
        • InputAttachmentName — (String) User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
        • InputId — (String) The ID of the input
        • InputSettings — (map) Settings of an input (caption selector, etc.)
          • AudioSelectors — (Array<map>) Used to select the audio stream to decode for inputs that have multiple available.
            • Name — required — (String) The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
            • SelectorSettings — (map) The audio selector settings.
              • AudioLanguageSelection — (map) Audio Language Selection
                • LanguageCode — required — (String) Selects a specific three-letter language code from within an audio source.
                • LanguageSelectionPolicy — (String) When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. Possible values include:
                  • "LOOSE"
                  • "STRICT"
              • AudioPidSelection — (map) Audio Pid Selection
                • Pid — required — (Integer) Selects a specific PID from within a source.
          • CaptionSelectors — (Array<map>) Used to select the caption input to use for inputs that have multiple available.
            • LanguageCode — (String) When specified this field indicates the three letter language code of the caption track to extract from the source.
            • Name — required — (String) Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
            • SelectorSettings — (map) Caption selector settings.
              • AribSourceSettings — (map) Arib Source Settings
              • DvbSubSourceSettings — (map) Dvb Sub Source Settings
                • Pid — (Integer) When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
              • EmbeddedSourceSettings — (map) Embedded Source Settings
                • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                  • "DISABLED"
                  • "UPCONVERT"
                • Scte20Detection — (String) Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. Possible values include:
                  • "AUTO"
                  • "OFF"
                • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
                • Source608TrackNumber — (Integer) This field is unused and deprecated.
              • Scte20SourceSettings — (map) Scte20 Source Settings
                • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                  • "DISABLED"
                  • "UPCONVERT"
                • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
              • Scte27SourceSettings — (map) Scte27 Source Settings
                • Pid — (Integer) The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
              • TeletextSourceSettings — (map) Teletext Source Settings
                • PageNumber — (String) Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
          • DeblockFilter — (String) Enable or disable the deblock filter when filtering. Possible values include:
            • "DISABLED"
            • "ENABLED"
          • DenoiseFilter — (String) Enable or disable the denoise filter when filtering. Possible values include:
            • "DISABLED"
            • "ENABLED"
          • FilterStrength — (Integer) Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
          • InputFilter — (String) Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type Possible values include:
            • "AUTO"
            • "DISABLED"
            • "FORCED"
          • NetworkInputSettings — (map) Input settings.
            • HlsInputSettings — (map) Specifies HLS input settings when the uri is for a HLS manifest.
              • Bandwidth — (Integer) When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
              • BufferSegments — (Integer) When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
              • Retries — (Integer) The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
              • RetryInterval — (Integer) The number of seconds between retries when an attempt to read a manifest or segment fails.
            • ServerValidation — (String) Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. Possible values include:
              • "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME"
              • "CHECK_CRYPTOGRAPHY_ONLY"
          • SourceEndBehavior — (String) Loop input if it is a file. This allows a file input to be streamed indefinitely. Possible values include:
            • "CONTINUE"
            • "LOOP"
          • VideoSelector — (map) Informs which video elementary stream to decode for input types that have multiple available.
            • ColorSpace — (String) Specifies the colorspace of an input. This setting works in tandem with colorSpaceConversion to determine if any conversion will be performed. Possible values include:
              • "FOLLOW"
              • "REC_601"
              • "REC_709"
            • ColorSpaceUsage — (String) Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. Possible values include:
              • "FALLBACK"
              • "FORCE"
            • SelectorSettings — (map) The video selector settings.
              • VideoSelectorPid — (map) Video Selector Pid
                • Pid — (Integer) Selects a specific PID from within a video source.
              • VideoSelectorProgramId — (map) Video Selector Program Id
                • ProgramId — (Integer) Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
      • InputSpecification — (map) Placeholder documentation for InputSpecification
        • Codec — (String) Input codec Possible values include:
          • "MPEG2"
          • "AVC"
          • "HEVC"
        • MaximumBitrate — (String) Maximum input bitrate, categorized coarsely Possible values include:
          • "MAX_10_MBPS"
          • "MAX_20_MBPS"
          • "MAX_50_MBPS"
        • Resolution — (String) Input resolution, categorized coarsely Possible values include:
          • "SD"
          • "HD"
          • "UHD"
      • LogLevel — (String) The log level being written to CloudWatch Logs. Possible values include:
        • "ERROR"
        • "WARNING"
        • "INFO"
        • "DEBUG"
        • "DISABLED"
      • Name — (String) The name of the channel. (user-mutable)
      • PipelinesRunningCount — (Integer) The number of currently healthy pipelines.
      • RoleArn — (String) The Amazon Resource Name (ARN) of the role assumed when running the Channel.
      • State — (String) Placeholder documentation for ChannelState Possible values include:
        • "CREATING"
        • "CREATE_FAILED"
        • "IDLE"
        • "STARTING"
        • "RUNNING"
        • "RECOVERING"
        • "STOPPING"
        • "DELETING"
        • "DELETED"
      • Tags — (map<String>) A collection of key-value pairs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateChannel(params = {}, callback) ⇒ AWS.Request

Updates a channel.

Service Reference:

Examples:

Calling the updateChannel operation

var params = {
  ChannelId: 'STRING_VALUE', /* required */
  Destinations: [
    {
      Id: 'STRING_VALUE',
      MediaPackageSettings: [
        {
          ChannelId: 'STRING_VALUE'
        },
        /* more items */
      ],
      Settings: [
        {
          PasswordParam: 'STRING_VALUE',
          StreamName: 'STRING_VALUE',
          Url: 'STRING_VALUE',
          Username: 'STRING_VALUE'
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  EncoderSettings: {
    AudioDescriptions: [ /* required */
      {
        AudioSelectorName: 'STRING_VALUE', /* required */
        Name: 'STRING_VALUE', /* required */
        AudioNormalizationSettings: {
          Algorithm: ITU_1770_1 | ITU_1770_2,
          AlgorithmControl: CORRECT_AUDIO,
          TargetLkfs: 'NUMBER_VALUE'
        },
        AudioType: CLEAN_EFFECTS | HEARING_IMPAIRED | UNDEFINED | VISUAL_IMPAIRED_COMMENTARY,
        AudioTypeControl: FOLLOW_INPUT | USE_CONFIGURED,
        CodecSettings: {
          AacSettings: {
            Bitrate: 'NUMBER_VALUE',
            CodingMode: AD_RECEIVER_MIX | CODING_MODE_1_0 | CODING_MODE_1_1 | CODING_MODE_2_0 | CODING_MODE_5_1,
            InputType: BROADCASTER_MIXED_AD | NORMAL,
            Profile: HEV1 | HEV2 | LC,
            RateControlMode: CBR | VBR,
            RawFormat: LATM_LOAS | NONE,
            SampleRate: 'NUMBER_VALUE',
            Spec: MPEG2 | MPEG4,
            VbrQuality: HIGH | LOW | MEDIUM_HIGH | MEDIUM_LOW
          },
          Ac3Settings: {
            Bitrate: 'NUMBER_VALUE',
            BitstreamMode: COMMENTARY | COMPLETE_MAIN | DIALOGUE | EMERGENCY | HEARING_IMPAIRED | MUSIC_AND_EFFECTS | VISUALLY_IMPAIRED | VOICE_OVER,
            CodingMode: CODING_MODE_1_0 | CODING_MODE_1_1 | CODING_MODE_2_0 | CODING_MODE_3_2_LFE,
            Dialnorm: 'NUMBER_VALUE',
            DrcProfile: FILM_STANDARD | NONE,
            LfeFilter: DISABLED | ENABLED,
            MetadataControl: FOLLOW_INPUT | USE_CONFIGURED
          },
          Eac3Settings: {
            AttenuationControl: ATTENUATE_3_DB | NONE,
            Bitrate: 'NUMBER_VALUE',
            BitstreamMode: COMMENTARY | COMPLETE_MAIN | EMERGENCY | HEARING_IMPAIRED | VISUALLY_IMPAIRED,
            CodingMode: CODING_MODE_1_0 | CODING_MODE_2_0 | CODING_MODE_3_2,
            DcFilter: DISABLED | ENABLED,
            Dialnorm: 'NUMBER_VALUE',
            DrcLine: FILM_LIGHT | FILM_STANDARD | MUSIC_LIGHT | MUSIC_STANDARD | NONE | SPEECH,
            DrcRf: FILM_LIGHT | FILM_STANDARD | MUSIC_LIGHT | MUSIC_STANDARD | NONE | SPEECH,
            LfeControl: LFE | NO_LFE,
            LfeFilter: DISABLED | ENABLED,
            LoRoCenterMixLevel: 'NUMBER_VALUE',
            LoRoSurroundMixLevel: 'NUMBER_VALUE',
            LtRtCenterMixLevel: 'NUMBER_VALUE',
            LtRtSurroundMixLevel: 'NUMBER_VALUE',
            MetadataControl: FOLLOW_INPUT | USE_CONFIGURED,
            PassthroughControl: NO_PASSTHROUGH | WHEN_POSSIBLE,
            PhaseControl: NO_SHIFT | SHIFT_90_DEGREES,
            StereoDownmix: DPL2 | LO_RO | LT_RT | NOT_INDICATED,
            SurroundExMode: DISABLED | ENABLED | NOT_INDICATED,
            SurroundMode: DISABLED | ENABLED | NOT_INDICATED
          },
          Mp2Settings: {
            Bitrate: 'NUMBER_VALUE',
            CodingMode: CODING_MODE_1_0 | CODING_MODE_2_0,
            SampleRate: 'NUMBER_VALUE'
          },
          PassThroughSettings: {
          }
        },
        LanguageCode: 'STRING_VALUE',
        LanguageCodeControl: FOLLOW_INPUT | USE_CONFIGURED,
        RemixSettings: {
          ChannelMappings: [ /* required */
            {
              InputChannelLevels: [ /* required */
                {
                  Gain: 'NUMBER_VALUE', /* required */
                  InputChannel: 'NUMBER_VALUE' /* required */
                },
                /* more items */
              ],
              OutputChannel: 'NUMBER_VALUE' /* required */
            },
            /* more items */
          ],
          ChannelsIn: 'NUMBER_VALUE',
          ChannelsOut: 'NUMBER_VALUE'
        },
        StreamName: 'STRING_VALUE'
      },
      /* more items */
    ],
    OutputGroups: [ /* required */
      {
        OutputGroupSettings: { /* required */
          ArchiveGroupSettings: {
            Destination: { /* required */
              DestinationRefId: 'STRING_VALUE'
            },
            RolloverInterval: 'NUMBER_VALUE'
          },
          FrameCaptureGroupSettings: {
            Destination: { /* required */
              DestinationRefId: 'STRING_VALUE'
            }
          },
          HlsGroupSettings: {
            Destination: { /* required */
              DestinationRefId: 'STRING_VALUE'
            },
            AdMarkers: [
              ADOBE | ELEMENTAL | ELEMENTAL_SCTE35,
              /* more items */
            ],
            BaseUrlContent: 'STRING_VALUE',
            BaseUrlManifest: 'STRING_VALUE',
            CaptionLanguageMappings: [
              {
                CaptionChannel: 'NUMBER_VALUE', /* required */
                LanguageCode: 'STRING_VALUE', /* required */
                LanguageDescription: 'STRING_VALUE' /* required */
              },
              /* more items */
            ],
            CaptionLanguageSetting: INSERT | NONE | OMIT,
            ClientCache: DISABLED | ENABLED,
            CodecSpecification: RFC_4281 | RFC_6381,
            ConstantIv: 'STRING_VALUE',
            DirectoryStructure: SINGLE_DIRECTORY | SUBDIRECTORY_PER_STREAM,
            EncryptionType: AES128 | SAMPLE_AES,
            HlsCdnSettings: {
              HlsAkamaiSettings: {
                ConnectionRetryInterval: 'NUMBER_VALUE',
                FilecacheDuration: 'NUMBER_VALUE',
                HttpTransferMode: CHUNKED | NON_CHUNKED,
                NumRetries: 'NUMBER_VALUE',
                RestartDelay: 'NUMBER_VALUE',
                Salt: 'STRING_VALUE',
                Token: 'STRING_VALUE'
              },
              HlsBasicPutSettings: {
                ConnectionRetryInterval: 'NUMBER_VALUE',
                FilecacheDuration: 'NUMBER_VALUE',
                NumRetries: 'NUMBER_VALUE',
                RestartDelay: 'NUMBER_VALUE'
              },
              HlsMediaStoreSettings: {
                ConnectionRetryInterval: 'NUMBER_VALUE',
                FilecacheDuration: 'NUMBER_VALUE',
                MediaStoreStorageClass: TEMPORAL,
                NumRetries: 'NUMBER_VALUE',
                RestartDelay: 'NUMBER_VALUE'
              },
              HlsWebdavSettings: {
                ConnectionRetryInterval: 'NUMBER_VALUE',
                FilecacheDuration: 'NUMBER_VALUE',
                HttpTransferMode: CHUNKED | NON_CHUNKED,
                NumRetries: 'NUMBER_VALUE',
                RestartDelay: 'NUMBER_VALUE'
              }
            },
            IFrameOnlyPlaylists: DISABLED | STANDARD,
            IndexNSegments: 'NUMBER_VALUE',
            InputLossAction: EMIT_OUTPUT | PAUSE_OUTPUT,
            IvInManifest: EXCLUDE | INCLUDE,
            IvSource: EXPLICIT | FOLLOWS_SEGMENT_NUMBER,
            KeepSegments: 'NUMBER_VALUE',
            KeyFormat: 'STRING_VALUE',
            KeyFormatVersions: 'STRING_VALUE',
            KeyProviderSettings: {
              StaticKeySettings: {
                StaticKeyValue: 'STRING_VALUE', /* required */
                KeyProviderServer: {
                  Uri: 'STRING_VALUE', /* required */
                  PasswordParam: 'STRING_VALUE',
                  Username: 'STRING_VALUE'
                }
              }
            },
            ManifestCompression: GZIP | NONE,
            ManifestDurationFormat: FLOATING_POINT | INTEGER,
            MinSegmentLength: 'NUMBER_VALUE',
            Mode: LIVE | VOD,
            OutputSelection: MANIFESTS_AND_SEGMENTS | SEGMENTS_ONLY,
            ProgramDateTime: EXCLUDE | INCLUDE,
            ProgramDateTimePeriod: 'NUMBER_VALUE',
            RedundantManifest: DISABLED | ENABLED,
            SegmentLength: 'NUMBER_VALUE',
            SegmentationMode: USE_INPUT_SEGMENTATION | USE_SEGMENT_DURATION,
            SegmentsPerSubdirectory: 'NUMBER_VALUE',
            StreamInfResolution: EXCLUDE | INCLUDE,
            TimedMetadataId3Frame: NONE | PRIV | TDRL,
            TimedMetadataId3Period: 'NUMBER_VALUE',
            TimestampDeltaMilliseconds: 'NUMBER_VALUE',
            TsFileMode: SEGMENTED_FILES | SINGLE_FILE
          },
          MediaPackageGroupSettings: {
            Destination: { /* required */
              DestinationRefId: 'STRING_VALUE'
            }
          },
          MsSmoothGroupSettings: {
            Destination: { /* required */
              DestinationRefId: 'STRING_VALUE'
            },
            AcquisitionPointId: 'STRING_VALUE',
            AudioOnlyTimecodeControl: PASSTHROUGH | USE_CONFIGURED_CLOCK,
            CertificateMode: SELF_SIGNED | VERIFY_AUTHENTICITY,
            ConnectionRetryInterval: 'NUMBER_VALUE',
            EventId: 'STRING_VALUE',
            EventIdMode: NO_EVENT_ID | USE_CONFIGURED | USE_TIMESTAMP,
            EventStopBehavior: NONE | SEND_EOS,
            FilecacheDuration: 'NUMBER_VALUE',
            FragmentLength: 'NUMBER_VALUE',
            InputLossAction: EMIT_OUTPUT | PAUSE_OUTPUT,
            NumRetries: 'NUMBER_VALUE',
            RestartDelay: 'NUMBER_VALUE',
            SegmentationMode: USE_INPUT_SEGMENTATION | USE_SEGMENT_DURATION,
            SendDelayMs: 'NUMBER_VALUE',
            SparseTrackType: NONE | SCTE_35,
            StreamManifestBehavior: DO_NOT_SEND | SEND,
            TimestampOffset: 'STRING_VALUE',
            TimestampOffsetMode: USE_CONFIGURED_OFFSET | USE_EVENT_START_DATE
          },
          RtmpGroupSettings: {
            AuthenticationScheme: AKAMAI | COMMON,
            CacheFullBehavior: DISCONNECT_IMMEDIATELY | WAIT_FOR_SERVER,
            CacheLength: 'NUMBER_VALUE',
            CaptionData: ALL | FIELD1_608 | FIELD1_AND_FIELD2_608,
            InputLossAction: EMIT_OUTPUT | PAUSE_OUTPUT,
            RestartDelay: 'NUMBER_VALUE'
          },
          UdpGroupSettings: {
            InputLossAction: DROP_PROGRAM | DROP_TS | EMIT_PROGRAM,
            TimedMetadataId3Frame: NONE | PRIV | TDRL,
            TimedMetadataId3Period: 'NUMBER_VALUE'
          }
        },
        Outputs: [ /* required */
          {
            OutputSettings: { /* required */
              ArchiveOutputSettings: {
                ContainerSettings: { /* required */
                  M2tsSettings: {
                    AbsentInputAudioBehavior: DROP | ENCODE_SILENCE,
                    Arib: DISABLED | ENABLED,
                    AribCaptionsPid: 'STRING_VALUE',
                    AribCaptionsPidControl: AUTO | USE_CONFIGURED,
                    AudioBufferModel: ATSC | DVB,
                    AudioFramesPerPes: 'NUMBER_VALUE',
                    AudioPids: 'STRING_VALUE',
                    AudioStreamType: ATSC | DVB,
                    Bitrate: 'NUMBER_VALUE',
                    BufferModel: MULTIPLEX | NONE,
                    CcDescriptor: DISABLED | ENABLED,
                    DvbNitSettings: {
                      NetworkId: 'NUMBER_VALUE', /* required */
                      NetworkName: 'STRING_VALUE', /* required */
                      RepInterval: 'NUMBER_VALUE'
                    },
                    DvbSdtSettings: {
                      OutputSdt: SDT_FOLLOW | SDT_FOLLOW_IF_PRESENT | SDT_MANUAL | SDT_NONE,
                      RepInterval: 'NUMBER_VALUE',
                      ServiceName: 'STRING_VALUE',
                      ServiceProviderName: 'STRING_VALUE'
                    },
                    DvbSubPids: 'STRING_VALUE',
                    DvbTdtSettings: {
                      RepInterval: 'NUMBER_VALUE'
                    },
                    DvbTeletextPid: 'STRING_VALUE',
                    Ebif: NONE | PASSTHROUGH,
                    EbpAudioInterval: VIDEO_AND_FIXED_INTERVALS | VIDEO_INTERVAL,
                    EbpLookaheadMs: 'NUMBER_VALUE',
                    EbpPlacement: VIDEO_AND_AUDIO_PIDS | VIDEO_PID,
                    EcmPid: 'STRING_VALUE',
                    EsRateInPes: EXCLUDE | INCLUDE,
                    EtvPlatformPid: 'STRING_VALUE',
                    EtvSignalPid: 'STRING_VALUE',
                    FragmentTime: 'NUMBER_VALUE',
                    Klv: NONE | PASSTHROUGH,
                    KlvDataPids: 'STRING_VALUE',
                    NullPacketBitrate: 'NUMBER_VALUE',
                    PatInterval: 'NUMBER_VALUE',
                    PcrControl: CONFIGURED_PCR_PERIOD | PCR_EVERY_PES_PACKET,
                    PcrPeriod: 'NUMBER_VALUE',
                    PcrPid: 'STRING_VALUE',
                    PmtInterval: 'NUMBER_VALUE',
                    PmtPid: 'STRING_VALUE',
                    ProgramNum: 'NUMBER_VALUE',
                    RateMode: CBR | VBR,
                    Scte27Pids: 'STRING_VALUE',
                    Scte35Control: NONE | PASSTHROUGH,
                    Scte35Pid: 'STRING_VALUE',
                    SegmentationMarkers: EBP | EBP_LEGACY | NONE | PSI_SEGSTART | RAI_ADAPT | RAI_SEGSTART,
                    SegmentationStyle: MAINTAIN_CADENCE | RESET_CADENCE,
                    SegmentationTime: 'NUMBER_VALUE',
                    TimedMetadataBehavior: NO_PASSTHROUGH | PASSTHROUGH,
                    TimedMetadataPid: 'STRING_VALUE',
                    TransportStreamId: 'NUMBER_VALUE',
                    VideoPid: 'STRING_VALUE'
                  }
                },
                Extension: 'STRING_VALUE',
                NameModifier: 'STRING_VALUE'
              },
              FrameCaptureOutputSettings: {
                NameModifier: 'STRING_VALUE'
              },
              HlsOutputSettings: {
                HlsSettings: { /* required */
                  AudioOnlyHlsSettings: {
                    AudioGroupId: 'STRING_VALUE',
                    AudioOnlyImage: {
                      Uri: 'STRING_VALUE', /* required */
                      PasswordParam: 'STRING_VALUE',
                      Username: 'STRING_VALUE'
                    },
                    AudioTrackType: ALTERNATE_AUDIO_AUTO_SELECT | ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT | ALTERNATE_AUDIO_NOT_AUTO_SELECT | AUDIO_ONLY_VARIANT_STREAM
                  },
                  StandardHlsSettings: {
                    M3u8Settings: { /* required */
                      AudioFramesPerPes: 'NUMBER_VALUE',
                      AudioPids: 'STRING_VALUE',
                      EcmPid: 'STRING_VALUE',
                      PatInterval: 'NUMBER_VALUE',
                      PcrControl: CONFIGURED_PCR_PERIOD | PCR_EVERY_PES_PACKET,
                      PcrPeriod: 'NUMBER_VALUE',
                      PcrPid: 'STRING_VALUE',
                      PmtInterval: 'NUMBER_VALUE',
                      PmtPid: 'STRING_VALUE',
                      ProgramNum: 'NUMBER_VALUE',
                      Scte35Behavior: NO_PASSTHROUGH | PASSTHROUGH,
                      Scte35Pid: 'STRING_VALUE',
                      TimedMetadataBehavior: NO_PASSTHROUGH | PASSTHROUGH,
                      TimedMetadataPid: 'STRING_VALUE',
                      TransportStreamId: 'NUMBER_VALUE',
                      VideoPid: 'STRING_VALUE'
                    },
                    AudioRenditionSets: 'STRING_VALUE'
                  }
                },
                NameModifier: 'STRING_VALUE',
                SegmentModifier: 'STRING_VALUE'
              },
              MediaPackageOutputSettings: {
              },
              MsSmoothOutputSettings: {
                NameModifier: 'STRING_VALUE'
              },
              RtmpOutputSettings: {
                Destination: { /* required */
                  DestinationRefId: 'STRING_VALUE'
                },
                CertificateMode: SELF_SIGNED | VERIFY_AUTHENTICITY,
                ConnectionRetryInterval: 'NUMBER_VALUE',
                NumRetries: 'NUMBER_VALUE'
              },
              UdpOutputSettings: {
                ContainerSettings: { /* required */
                  M2tsSettings: {
                    AbsentInputAudioBehavior: DROP | ENCODE_SILENCE,
                    Arib: DISABLED | ENABLED,
                    AribCaptionsPid: 'STRING_VALUE',
                    AribCaptionsPidControl: AUTO | USE_CONFIGURED,
                    AudioBufferModel: ATSC | DVB,
                    AudioFramesPerPes: 'NUMBER_VALUE',
                    AudioPids: 'STRING_VALUE',
                    AudioStreamType: ATSC | DVB,
                    Bitrate: 'NUMBER_VALUE',
                    BufferModel: MULTIPLEX | NONE,
                    CcDescriptor: DISABLED | ENABLED,
                    DvbNitSettings: {
                      NetworkId: 'NUMBER_VALUE', /* required */
                      NetworkName: 'STRING_VALUE', /* required */
                      RepInterval: 'NUMBER_VALUE'
                    },
                    DvbSdtSettings: {
                      OutputSdt: SDT_FOLLOW | SDT_FOLLOW_IF_PRESENT | SDT_MANUAL | SDT_NONE,
                      RepInterval: 'NUMBER_VALUE',
                      ServiceName: 'STRING_VALUE',
                      ServiceProviderName: 'STRING_VALUE'
                    },
                    DvbSubPids: 'STRING_VALUE',
                    DvbTdtSettings: {
                      RepInterval: 'NUMBER_VALUE'
                    },
                    DvbTeletextPid: 'STRING_VALUE',
                    Ebif: NONE | PASSTHROUGH,
                    EbpAudioInterval: VIDEO_AND_FIXED_INTERVALS | VIDEO_INTERVAL,
                    EbpLookaheadMs: 'NUMBER_VALUE',
                    EbpPlacement: VIDEO_AND_AUDIO_PIDS | VIDEO_PID,
                    EcmPid: 'STRING_VALUE',
                    EsRateInPes: EXCLUDE | INCLUDE,
                    EtvPlatformPid: 'STRING_VALUE',
                    EtvSignalPid: 'STRING_VALUE',
                    FragmentTime: 'NUMBER_VALUE',
                    Klv: NONE | PASSTHROUGH,
                    KlvDataPids: 'STRING_VALUE',
                    NullPacketBitrate: 'NUMBER_VALUE',
                    PatInterval: 'NUMBER_VALUE',
                    PcrControl: CONFIGURED_PCR_PERIOD | PCR_EVERY_PES_PACKET,
                    PcrPeriod: 'NUMBER_VALUE',
                    PcrPid: 'STRING_VALUE',
                    PmtInterval: 'NUMBER_VALUE',
                    PmtPid: 'STRING_VALUE',
                    ProgramNum: 'NUMBER_VALUE',
                    RateMode: CBR | VBR,
                    Scte27Pids: 'STRING_VALUE',
                    Scte35Control: NONE | PASSTHROUGH,
                    Scte35Pid: 'STRING_VALUE',
                    SegmentationMarkers: EBP | EBP_LEGACY | NONE | PSI_SEGSTART | RAI_ADAPT | RAI_SEGSTART,
                    SegmentationStyle: MAINTAIN_CADENCE | RESET_CADENCE,
                    SegmentationTime: 'NUMBER_VALUE',
                    TimedMetadataBehavior: NO_PASSTHROUGH | PASSTHROUGH,
                    TimedMetadataPid: 'STRING_VALUE',
                    TransportStreamId: 'NUMBER_VALUE',
                    VideoPid: 'STRING_VALUE'
                  }
                },
                Destination: { /* required */
                  DestinationRefId: 'STRING_VALUE'
                },
                BufferMsec: 'NUMBER_VALUE',
                FecOutputSettings: {
                  ColumnDepth: 'NUMBER_VALUE',
                  IncludeFec: COLUMN | COLUMN_AND_ROW,
                  RowLength: 'NUMBER_VALUE'
                }
              }
            },
            AudioDescriptionNames: [
              'STRING_VALUE',
              /* more items */
            ],
            CaptionDescriptionNames: [
              'STRING_VALUE',
              /* more items */
            ],
            OutputName: 'STRING_VALUE',
            VideoDescriptionName: 'STRING_VALUE'
          },
          /* more items */
        ],
        Name: 'STRING_VALUE'
      },
      /* more items */
    ],
    TimecodeConfig: { /* required */
      Source: EMBEDDED | SYSTEMCLOCK | ZEROBASED, /* required */
      SyncThreshold: 'NUMBER_VALUE'
    },
    VideoDescriptions: [ /* required */
      {
        Name: 'STRING_VALUE', /* required */
        CodecSettings: {
          FrameCaptureSettings: {
            CaptureInterval: 'NUMBER_VALUE' /* required */
          },
          H264Settings: {
            AdaptiveQuantization: HIGH | HIGHER | LOW | MAX | MEDIUM | OFF,
            AfdSignaling: AUTO | FIXED | NONE,
            Bitrate: 'NUMBER_VALUE',
            BufFillPct: 'NUMBER_VALUE',
            BufSize: 'NUMBER_VALUE',
            ColorMetadata: IGNORE | INSERT,
            EntropyEncoding: CABAC | CAVLC,
            FixedAfd: AFD_0000 | AFD_0010 | AFD_0011 | AFD_0100 | AFD_1000 | AFD_1001 | AFD_1010 | AFD_1011 | AFD_1101 | AFD_1110 | AFD_1111,
            FlickerAq: DISABLED | ENABLED,
            FramerateControl: INITIALIZE_FROM_SOURCE | SPECIFIED,
            FramerateDenominator: 'NUMBER_VALUE',
            FramerateNumerator: 'NUMBER_VALUE',
            GopBReference: DISABLED | ENABLED,
            GopClosedCadence: 'NUMBER_VALUE',
            GopNumBFrames: 'NUMBER_VALUE',
            GopSize: 'NUMBER_VALUE',
            GopSizeUnits: FRAMES | SECONDS,
            Level: H264_LEVEL_1 | H264_LEVEL_1_1 | H264_LEVEL_1_2 | H264_LEVEL_1_3 | H264_LEVEL_2 | H264_LEVEL_2_1 | H264_LEVEL_2_2 | H264_LEVEL_3 | H264_LEVEL_3_1 | H264_LEVEL_3_2 | H264_LEVEL_4 | H264_LEVEL_4_1 | H264_LEVEL_4_2 | H264_LEVEL_5 | H264_LEVEL_5_1 | H264_LEVEL_5_2 | H264_LEVEL_AUTO,
            LookAheadRateControl: HIGH | LOW | MEDIUM,
            MaxBitrate: 'NUMBER_VALUE',
            MinIInterval: 'NUMBER_VALUE',
            NumRefFrames: 'NUMBER_VALUE',
            ParControl: INITIALIZE_FROM_SOURCE | SPECIFIED,
            ParDenominator: 'NUMBER_VALUE',
            ParNumerator: 'NUMBER_VALUE',
            Profile: BASELINE | HIGH | HIGH_10BIT | HIGH_422 | HIGH_422_10BIT | MAIN,
            QvbrQualityLevel: 'NUMBER_VALUE',
            RateControlMode: CBR | QVBR | VBR,
            ScanType: INTERLACED | PROGRESSIVE,
            SceneChangeDetect: DISABLED | ENABLED,
            Slices: 'NUMBER_VALUE',
            Softness: 'NUMBER_VALUE',
            SpatialAq: DISABLED | ENABLED,
            SubgopLength: DYNAMIC | FIXED,
            Syntax: DEFAULT | RP2027,
            TemporalAq: DISABLED | ENABLED,
            TimecodeInsertion: DISABLED | PIC_TIMING_SEI
          }
        },
        Height: 'NUMBER_VALUE',
        RespondToAfd: NONE | PASSTHROUGH | RESPOND,
        ScalingBehavior: DEFAULT | STRETCH_TO_OUTPUT,
        Sharpness: 'NUMBER_VALUE',
        Width: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    AvailBlanking: {
      AvailBlankingImage: {
        Uri: 'STRING_VALUE', /* required */
        PasswordParam: 'STRING_VALUE',
        Username: 'STRING_VALUE'
      },
      State: DISABLED | ENABLED
    },
    AvailConfiguration: {
      AvailSettings: {
        Scte35SpliceInsert: {
          AdAvailOffset: 'NUMBER_VALUE',
          NoRegionalBlackoutFlag: FOLLOW | IGNORE,
          WebDeliveryAllowedFlag: FOLLOW | IGNORE
        },
        Scte35TimeSignalApos: {
          AdAvailOffset: 'NUMBER_VALUE',
          NoRegionalBlackoutFlag: FOLLOW | IGNORE,
          WebDeliveryAllowedFlag: FOLLOW | IGNORE
        }
      }
    },
    BlackoutSlate: {
      BlackoutSlateImage: {
        Uri: 'STRING_VALUE', /* required */
        PasswordParam: 'STRING_VALUE',
        Username: 'STRING_VALUE'
      },
      NetworkEndBlackout: DISABLED | ENABLED,
      NetworkEndBlackoutImage: {
        Uri: 'STRING_VALUE', /* required */
        PasswordParam: 'STRING_VALUE',
        Username: 'STRING_VALUE'
      },
      NetworkId: 'STRING_VALUE',
      State: DISABLED | ENABLED
    },
    CaptionDescriptions: [
      {
        CaptionSelectorName: 'STRING_VALUE', /* required */
        Name: 'STRING_VALUE', /* required */
        DestinationSettings: {
          AribDestinationSettings: {
          },
          BurnInDestinationSettings: {
            Alignment: CENTERED | LEFT | SMART,
            BackgroundColor: BLACK | NONE | WHITE,
            BackgroundOpacity: 'NUMBER_VALUE',
            Font: {
              Uri: 'STRING_VALUE', /* required */
              PasswordParam: 'STRING_VALUE',
              Username: 'STRING_VALUE'
            },
            FontColor: BLACK | BLUE | GREEN | RED | WHITE | YELLOW,
            FontOpacity: 'NUMBER_VALUE',
            FontResolution: 'NUMBER_VALUE',
            FontSize: 'STRING_VALUE',
            OutlineColor: BLACK | BLUE | GREEN | RED | WHITE | YELLOW,
            OutlineSize: 'NUMBER_VALUE',
            ShadowColor: BLACK | NONE | WHITE,
            ShadowOpacity: 'NUMBER_VALUE',
            ShadowXOffset: 'NUMBER_VALUE',
            ShadowYOffset: 'NUMBER_VALUE',
            TeletextGridControl: FIXED | SCALED,
            XPosition: 'NUMBER_VALUE',
            YPosition: 'NUMBER_VALUE'
          },
          DvbSubDestinationSettings: {
            Alignment: CENTERED | LEFT | SMART,
            BackgroundColor: BLACK | NONE | WHITE,
            BackgroundOpacity: 'NUMBER_VALUE',
            Font: {
              Uri: 'STRING_VALUE', /* required */
              PasswordParam: 'STRING_VALUE',
              Username: 'STRING_VALUE'
            },
            FontColor: BLACK | BLUE | GREEN | RED | WHITE | YELLOW,
            FontOpacity: 'NUMBER_VALUE',
            FontResolution: 'NUMBER_VALUE',
            FontSize: 'STRING_VALUE',
            OutlineColor: BLACK | BLUE | GREEN | RED | WHITE | YELLOW,
            OutlineSize: 'NUMBER_VALUE',
            ShadowColor: BLACK | NONE | WHITE,
            ShadowOpacity: 'NUMBER_VALUE',
            ShadowXOffset: 'NUMBER_VALUE',
            ShadowYOffset: 'NUMBER_VALUE',
            TeletextGridControl: FIXED | SCALED,
            XPosition: 'NUMBER_VALUE',
            YPosition: 'NUMBER_VALUE'
          },
          EmbeddedDestinationSettings: {
          },
          EmbeddedPlusScte20DestinationSettings: {
          },
          RtmpCaptionInfoDestinationSettings: {
          },
          Scte20PlusEmbeddedDestinationSettings: {
          },
          Scte27DestinationSettings: {
          },
          SmpteTtDestinationSettings: {
          },
          TeletextDestinationSettings: {
          },
          TtmlDestinationSettings: {
            StyleControl: PASSTHROUGH | USE_CONFIGURED
          },
          WebvttDestinationSettings: {
          }
        },
        LanguageCode: 'STRING_VALUE',
        LanguageDescription: 'STRING_VALUE'
      },
      /* more items */
    ],
    GlobalConfiguration: {
      InitialAudioGain: 'NUMBER_VALUE',
      InputEndAction: NONE | SWITCH_AND_LOOP_INPUTS,
      InputLossBehavior: {
        BlackFrameMsec: 'NUMBER_VALUE',
        InputLossImageColor: 'STRING_VALUE',
        InputLossImageSlate: {
          Uri: 'STRING_VALUE', /* required */
          PasswordParam: 'STRING_VALUE',
          Username: 'STRING_VALUE'
        },
        InputLossImageType: COLOR | SLATE,
        RepeatFrameMsec: 'NUMBER_VALUE'
      },
      OutputLockingMode: EPOCH_LOCKING | PIPELINE_LOCKING,
      OutputTimingSource: INPUT_CLOCK | SYSTEM_CLOCK,
      SupportLowFramerateInputs: DISABLED | ENABLED
    }
  },
  InputAttachments: [
    {
      InputAttachmentName: 'STRING_VALUE',
      InputId: 'STRING_VALUE',
      InputSettings: {
        AudioSelectors: [
          {
            Name: 'STRING_VALUE', /* required */
            SelectorSettings: {
              AudioLanguageSelection: {
                LanguageCode: 'STRING_VALUE', /* required */
                LanguageSelectionPolicy: LOOSE | STRICT
              },
              AudioPidSelection: {
                Pid: 'NUMBER_VALUE' /* required */
              }
            }
          },
          /* more items */
        ],
        CaptionSelectors: [
          {
            Name: 'STRING_VALUE', /* required */
            LanguageCode: 'STRING_VALUE',
            SelectorSettings: {
              AribSourceSettings: {
              },
              DvbSubSourceSettings: {
                Pid: 'NUMBER_VALUE'
              },
              EmbeddedSourceSettings: {
                Convert608To708: DISABLED | UPCONVERT,
                Scte20Detection: AUTO | OFF,
                Source608ChannelNumber: 'NUMBER_VALUE',
                Source608TrackNumber: 'NUMBER_VALUE'
              },
              Scte20SourceSettings: {
                Convert608To708: DISABLED | UPCONVERT,
                Source608ChannelNumber: 'NUMBER_VALUE'
              },
              Scte27SourceSettings: {
                Pid: 'NUMBER_VALUE'
              },
              TeletextSourceSettings: {
                PageNumber: 'STRING_VALUE'
              }
            }
          },
          /* more items */
        ],
        DeblockFilter: DISABLED | ENABLED,
        DenoiseFilter: DISABLED | ENABLED,
        FilterStrength: 'NUMBER_VALUE',
        InputFilter: AUTO | DISABLED | FORCED,
        NetworkInputSettings: {
          HlsInputSettings: {
            Bandwidth: 'NUMBER_VALUE',
            BufferSegments: 'NUMBER_VALUE',
            Retries: 'NUMBER_VALUE',
            RetryInterval: 'NUMBER_VALUE'
          },
          ServerValidation: CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME | CHECK_CRYPTOGRAPHY_ONLY
        },
        SourceEndBehavior: CONTINUE | LOOP,
        VideoSelector: {
          ColorSpace: FOLLOW | REC_601 | REC_709,
          ColorSpaceUsage: FALLBACK | FORCE,
          SelectorSettings: {
            VideoSelectorPid: {
              Pid: 'NUMBER_VALUE'
            },
            VideoSelectorProgramId: {
              ProgramId: 'NUMBER_VALUE'
            }
          }
        }
      }
    },
    /* more items */
  ],
  InputSpecification: {
    Codec: MPEG2 | AVC | HEVC,
    MaximumBitrate: MAX_10_MBPS | MAX_20_MBPS | MAX_50_MBPS,
    Resolution: SD | HD | UHD
  },
  LogLevel: ERROR | WARNING | INFO | DEBUG | DISABLED,
  Name: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE'
};
medialive.updateChannel(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ChannelId — (String) channel ID
    • Destinations — (Array<map>) A list of output destinations for this channel.
      • Id — (String) User-specified id. This is used in an output group or an output.
      • MediaPackageSettings — (Array<map>) Destination settings for a MediaPackage output; one destination for both encoders.
        • ChannelId — (String) ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
      • Settings — (Array<map>) Destination settings for a standard output; one destination for each redundant encoder.
        • PasswordParam — (String) key used to extract the password from EC2 Parameter store
        • StreamName — (String) Stream name for RTMP destinations (URLs of type rtmp://)
        • Url — (String) A URL specifying a destination
        • Username — (String) username for destination
    • EncoderSettings — (map) The encoder settings for this channel.
      • AudioDescriptions — required — (Array<map>) Placeholder documentation for __listOfAudioDescription
        • AudioNormalizationSettings — (map) Advanced audio normalization settings.
          • Algorithm — (String) Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. Possible values include:
            • "ITU_1770_1"
            • "ITU_1770_2"
          • AlgorithmControl — (String) When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. Possible values include:
            • "CORRECT_AUDIO"
          • TargetLkfs — (Float) Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
        • AudioSelectorName — required — (String) The name of the AudioSelector used as the source for this AudioDescription.
        • AudioType — (String) Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. Possible values include:
          • "CLEAN_EFFECTS"
          • "HEARING_IMPAIRED"
          • "UNDEFINED"
          • "VISUAL_IMPAIRED_COMMENTARY"
        • AudioTypeControl — (String) Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. Possible values include:
          • "FOLLOW_INPUT"
          • "USE_CONFIGURED"
        • CodecSettings — (map) Audio codec settings.
          • AacSettings — (map) Aac Settings
            • Bitrate — (Float) Average bitrate in bits/second. Valid values depend on rate control mode and profile.
            • CodingMode — (String) Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. Possible values include:
              • "AD_RECEIVER_MIX"
              • "CODING_MODE_1_0"
              • "CODING_MODE_1_1"
              • "CODING_MODE_2_0"
              • "CODING_MODE_5_1"
            • InputType — (String) Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD. Possible values include:
              • "BROADCASTER_MIXED_AD"
              • "NORMAL"
            • Profile — (String) AAC Profile. Possible values include:
              • "HEV1"
              • "HEV2"
              • "LC"
            • RateControlMode — (String) Rate Control Mode. Possible values include:
              • "CBR"
              • "VBR"
            • RawFormat — (String) Sets LATM / LOAS AAC output for raw containers. Possible values include:
              • "LATM_LOAS"
              • "NONE"
            • SampleRate — (Float) Sample rate in Hz. Valid values depend on rate control mode and profile.
            • Spec — (String) Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. Possible values include:
              • "MPEG2"
              • "MPEG4"
            • VbrQuality — (String) VBR Quality Level - Only used if rateControlMode is VBR. Possible values include:
              • "HIGH"
              • "LOW"
              • "MEDIUM_HIGH"
              • "MEDIUM_LOW"
          • Ac3Settings — (map) Ac3 Settings
            • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
            • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. Possible values include:
              • "COMMENTARY"
              • "COMPLETE_MAIN"
              • "DIALOGUE"
              • "EMERGENCY"
              • "HEARING_IMPAIRED"
              • "MUSIC_AND_EFFECTS"
              • "VISUALLY_IMPAIRED"
              • "VOICE_OVER"
            • CodingMode — (String) Dolby Digital coding mode. Determines number of channels. Possible values include:
              • "CODING_MODE_1_0"
              • "CODING_MODE_1_1"
              • "CODING_MODE_2_0"
              • "CODING_MODE_3_2_LFE"
            • Dialnorm — (Integer) Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
            • DrcProfile — (String) If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. Possible values include:
              • "FILM_STANDARD"
              • "NONE"
            • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • MetadataControl — (String) When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
              • "FOLLOW_INPUT"
              • "USE_CONFIGURED"
          • Eac3Settings — (map) Eac3 Settings
            • AttenuationControl — (String) When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. Possible values include:
              • "ATTENUATE_3_DB"
              • "NONE"
            • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
            • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. Possible values include:
              • "COMMENTARY"
              • "COMPLETE_MAIN"
              • "EMERGENCY"
              • "HEARING_IMPAIRED"
              • "VISUALLY_IMPAIRED"
            • CodingMode — (String) Dolby Digital Plus coding mode. Determines number of channels. Possible values include:
              • "CODING_MODE_1_0"
              • "CODING_MODE_2_0"
              • "CODING_MODE_3_2"
            • DcFilter — (String) When set to enabled, activates a DC highpass filter for all input channels. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • Dialnorm — (Integer) Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
            • DrcLine — (String) Sets the Dolby dynamic range compression profile. Possible values include:
              • "FILM_LIGHT"
              • "FILM_STANDARD"
              • "MUSIC_LIGHT"
              • "MUSIC_STANDARD"
              • "NONE"
              • "SPEECH"
            • DrcRf — (String) Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. Possible values include:
              • "FILM_LIGHT"
              • "FILM_STANDARD"
              • "MUSIC_LIGHT"
              • "MUSIC_STANDARD"
              • "NONE"
              • "SPEECH"
            • LfeControl — (String) When encoding 3/2 audio, setting to lfe enables the LFE channel Possible values include:
              • "LFE"
              • "NO_LFE"
            • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • LoRoCenterMixLevel — (Float) Left only/Right only center mix level. Only used for 3/2 coding mode.
            • LoRoSurroundMixLevel — (Float) Left only/Right only surround mix level. Only used for 3/2 coding mode.
            • LtRtCenterMixLevel — (Float) Left total/Right total center mix level. Only used for 3/2 coding mode.
            • LtRtSurroundMixLevel — (Float) Left total/Right total surround mix level. Only used for 3/2 coding mode.
            • MetadataControl — (String) When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
              • "FOLLOW_INPUT"
              • "USE_CONFIGURED"
            • PassthroughControl — (String) When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding. Possible values include:
              • "NO_PASSTHROUGH"
              • "WHEN_POSSIBLE"
            • PhaseControl — (String) When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. Possible values include:
              • "NO_SHIFT"
              • "SHIFT_90_DEGREES"
            • StereoDownmix — (String) Stereo downmix preference. Only used for 3/2 coding mode. Possible values include:
              • "DPL2"
              • "LO_RO"
              • "LT_RT"
              • "NOT_INDICATED"
            • SurroundExMode — (String) When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. Possible values include:
              • "DISABLED"
              • "ENABLED"
              • "NOT_INDICATED"
            • SurroundMode — (String) When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. Possible values include:
              • "DISABLED"
              • "ENABLED"
              • "NOT_INDICATED"
          • Mp2Settings — (map) Mp2 Settings
            • Bitrate — (Float) Average bitrate in bits/second.
            • CodingMode — (String) The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). Possible values include:
              • "CODING_MODE_1_0"
              • "CODING_MODE_2_0"
            • SampleRate — (Float) Sample rate in Hz.
          • PassThroughSettings — (map) Pass Through Settings
        • LanguageCode — (String) Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
        • LanguageCodeControl — (String) Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. Possible values include:
          • "FOLLOW_INPUT"
          • "USE_CONFIGURED"
        • Name — required — (String) The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
        • RemixSettings — (map) Settings that control how input audio channels are remixed into the output audio channels.
          • ChannelMappings — required — (Array<map>) Mapping of input channels to output channels, with appropriate gain adjustments.
            • InputChannelLevels — required — (Array<map>) Indices and gain values for each input channel that should be remixed into this output channel.
              • Gain — required — (Integer) Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
              • InputChannel — required — (Integer) The index of the input channel used as a source.
            • OutputChannel — required — (Integer) The index of the output channel being produced.
          • ChannelsIn — (Integer) Number of input channels to be used.
          • ChannelsOut — (Integer) Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
        • StreamName — (String) Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
      • AvailBlanking — (map) Settings for ad avail blanking.
        • AvailBlankingImage — (map) Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
          • PasswordParam — (String) key used to extract the password from EC2 Parameter store
          • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
          • Username — (String) Documentation update needed
        • State — (String) When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added. Possible values include:
          • "DISABLED"
          • "ENABLED"
      • AvailConfiguration — (map) Event-wide configuration settings for ad avail insertion.
        • AvailSettings — (map) Ad avail settings.
          • Scte35SpliceInsert — (map) Scte35 Splice Insert
            • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
            • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
              • "FOLLOW"
              • "IGNORE"
            • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
              • "FOLLOW"
              • "IGNORE"
          • Scte35TimeSignalApos — (map) Scte35 Time Signal Apos
            • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
            • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
              • "FOLLOW"
              • "IGNORE"
            • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
              • "FOLLOW"
              • "IGNORE"
      • BlackoutSlate — (map) Settings for blackout slate.
        • BlackoutSlateImage — (map) Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
          • PasswordParam — (String) key used to extract the password from EC2 Parameter store
          • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
          • Username — (String) Documentation update needed
        • NetworkEndBlackout — (String) Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". Possible values include:
          • "DISABLED"
          • "ENABLED"
        • NetworkEndBlackoutImage — (map) Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
          • PasswordParam — (String) key used to extract the password from EC2 Parameter store
          • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
          • Username — (String) Documentation update needed
        • NetworkId — (String) Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
        • State — (String) When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata. Possible values include:
          • "DISABLED"
          • "ENABLED"
      • CaptionDescriptions — (Array<map>) Settings for caption decriptions
        • CaptionSelectorName — required — (String) Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
        • DestinationSettings — (map) Additional settings for captions destination that depend on the destination type.
          • AribDestinationSettings — (map) Arib Destination Settings
          • BurnInDestinationSettings — (map) Burn In Destination Settings
            • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "CENTERED"
              • "LEFT"
              • "SMART"
            • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "NONE"
              • "WHITE"
            • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
            • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "BLUE"
              • "GREEN"
              • "RED"
              • "WHITE"
              • "YELLOW"
            • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
            • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
            • FontSize — (String) When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
            • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "BLUE"
              • "GREEN"
              • "RED"
              • "WHITE"
              • "YELLOW"
            • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
            • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "NONE"
              • "WHITE"
            • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
            • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
            • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
            • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
              • "FIXED"
              • "SCALED"
            • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
            • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
          • DvbSubDestinationSettings — (map) Dvb Sub Destination Settings
            • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "CENTERED"
              • "LEFT"
              • "SMART"
            • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "NONE"
              • "WHITE"
            • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
            • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "BLUE"
              • "GREEN"
              • "RED"
              • "WHITE"
              • "YELLOW"
            • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
            • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
            • FontSize — (String) When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
            • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "BLUE"
              • "GREEN"
              • "RED"
              • "WHITE"
              • "YELLOW"
            • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
            • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
              • "BLACK"
              • "NONE"
              • "WHITE"
            • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
            • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
            • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
            • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
              • "FIXED"
              • "SCALED"
            • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
            • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
          • EmbeddedDestinationSettings — (map) Embedded Destination Settings
          • EmbeddedPlusScte20DestinationSettings — (map) Embedded Plus Scte20 Destination Settings
          • RtmpCaptionInfoDestinationSettings — (map) Rtmp Caption Info Destination Settings
          • Scte20PlusEmbeddedDestinationSettings — (map) Scte20 Plus Embedded Destination Settings
          • Scte27DestinationSettings — (map) Scte27 Destination Settings
          • SmpteTtDestinationSettings — (map) Smpte Tt Destination Settings
          • TeletextDestinationSettings — (map) Teletext Destination Settings
          • TtmlDestinationSettings — (map) Ttml Destination Settings
            • StyleControl — (String) When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. Possible values include:
              • "PASSTHROUGH"
              • "USE_CONFIGURED"
          • WebvttDestinationSettings — (map) Webvtt Destination Settings
        • LanguageCode — (String) ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
        • LanguageDescription — (String) Human readable information to indicate captions available for players (eg. English, or Spanish).
        • Name — required — (String) Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
      • GlobalConfiguration — (map) Configuration settings that apply to the event as a whole.
        • InitialAudioGain — (Integer) Value to set the initial audio gain for the Live Event.
        • InputEndAction — (String) Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). Possible values include:
          • "NONE"
          • "SWITCH_AND_LOOP_INPUTS"
        • InputLossBehavior — (map) Settings for system actions when input is lost.
          • BlackFrameMsec — (Integer) Documentation update needed
          • InputLossImageColor — (String) When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
          • InputLossImageSlate — (map) When input loss image type is "slate" these fields specify the parameters for accessing the slate.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
            • Username — (String) Documentation update needed
          • InputLossImageType — (String) Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. Possible values include:
            • "COLOR"
            • "SLATE"
          • RepeatFrameMsec — (Integer) Documentation update needed
        • OutputLockingMode — (String) Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. Possible values include:
          • "EPOCH_LOCKING"
          • "PIPELINE_LOCKING"
        • OutputTimingSource — (String) Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. Possible values include:
          • "INPUT_CLOCK"
          • "SYSTEM_CLOCK"
        • SupportLowFramerateInputs — (String) Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. Possible values include:
          • "DISABLED"
          • "ENABLED"
      • OutputGroups — required — (Array<map>) Placeholder documentation for __listOfOutputGroup
        • Name — (String) Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
        • OutputGroupSettings — required — (map) Settings associated with the output group.
          • ArchiveGroupSettings — (map) Archive Group Settings
            • Destination — required — (map) A directory and base filename where archive files should be written.
              • DestinationRefId — (String) Placeholder documentation for __string
            • RolloverInterval — (Integer) Number of seconds to write to archive file before closing and starting a new one.
          • FrameCaptureGroupSettings — (map) Frame Capture Group Settings
            • Destination — required — (map) The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
              • DestinationRefId — (String) Placeholder documentation for __string
          • HlsGroupSettings — (map) Hls Group Settings
            • AdMarkers — (Array<String>) Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
            • BaseUrlContent — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
            • BaseUrlManifest — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
            • CaptionLanguageMappings — (Array<map>) Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
              • CaptionChannel — required — (Integer) The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
              • LanguageCode — required — (String) Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
              • LanguageDescription — required — (String) Textual description of language
            • CaptionLanguageSetting — (String) Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest. Possible values include:
              • "INSERT"
              • "NONE"
              • "OMIT"
            • ClientCache — (String) When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • CodecSpecification — (String) Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. Possible values include:
              • "RFC_4281"
              • "RFC_6381"
            • ConstantIv — (String) For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
            • Destination — required — (map) A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
              • DestinationRefId — (String) Placeholder documentation for __string
            • DirectoryStructure — (String) Place segments in subdirectories. Possible values include:
              • "SINGLE_DIRECTORY"
              • "SUBDIRECTORY_PER_STREAM"
            • EncryptionType — (String) Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. Possible values include:
              • "AES128"
              • "SAMPLE_AES"
            • HlsCdnSettings — (map) Parameters that control interactions with the CDN.
              • HlsAkamaiSettings — (map) Hls Akamai Settings
                • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. Possible values include:
                  • "CHUNKED"
                  • "NON_CHUNKED"
                • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                • Salt — (String) Salt for authenticated Akamai.
                • Token — (String) Token parameter for authenticated akamai. If not specified, gda is used.
              • HlsBasicPutSettings — (map) Hls Basic Put Settings
                • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
              • HlsMediaStoreSettings — (map) Hls Media Store Settings
                • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                • MediaStoreStorageClass — (String) When set to temporal, output files are stored in non-persistent memory for faster reading and writing. Possible values include:
                  • "TEMPORAL"
                • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
              • HlsWebdavSettings — (map) Hls Webdav Settings
                • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to WebDAV. Possible values include:
                  • "CHUNKED"
                  • "NON_CHUNKED"
                • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
            • IFrameOnlyPlaylists — (String) DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888" Possible values include:
              • "DISABLED"
              • "STANDARD"
            • IndexNSegments — (Integer) Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
            • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
              • "EMIT_OUTPUT"
              • "PAUSE_OUTPUT"
            • IvInManifest — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. Possible values include:
              • "EXCLUDE"
              • "INCLUDE"
            • IvSource — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. Possible values include:
              • "EXPLICIT"
              • "FOLLOWS_SEGMENT_NUMBER"
            • KeepSegments — (Integer) Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
            • KeyFormat — (String) The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
            • KeyFormatVersions — (String) Either a single positive integer version value or a slash delimited list of version values (1/2/3).
            • KeyProviderSettings — (map) The key provider settings.
              • StaticKeySettings — (map) Static Key Settings
                • KeyProviderServer — (map) The URL of the license server used for protecting content.
                  • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                  • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                  • Username — (String) Documentation update needed
                • StaticKeyValue — required — (String) Static key value as a 32 character hexadecimal string.
            • ManifestCompression — (String) When set to gzip, compresses HLS playlist. Possible values include:
              • "GZIP"
              • "NONE"
            • ManifestDurationFormat — (String) Indicates whether the output manifest should use floating point or integer values for segment duration. Possible values include:
              • "FLOATING_POINT"
              • "INTEGER"
            • MinSegmentLength — (Integer) When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
            • Mode — (String) If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. Possible values include:
              • "LIVE"
              • "VOD"
            • OutputSelection — (String) MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group. Possible values include:
              • "MANIFESTS_AND_SEGMENTS"
              • "SEGMENTS_ONLY"
            • ProgramDateTime — (String) Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset. Possible values include:
              • "EXCLUDE"
              • "INCLUDE"
            • ProgramDateTimePeriod — (Integer) Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
            • RedundantManifest — (String) ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • SegmentLength — (Integer) Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
            • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
              • "USE_INPUT_SEGMENTATION"
              • "USE_SEGMENT_DURATION"
            • SegmentsPerSubdirectory — (Integer) Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
            • StreamInfResolution — (String) Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. Possible values include:
              • "EXCLUDE"
              • "INCLUDE"
            • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
              • "NONE"
              • "PRIV"
              • "TDRL"
            • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
            • TimestampDeltaMilliseconds — (Integer) Provides an extra millisecond delta offset to fine tune the timestamps.
            • TsFileMode — (String) SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching. Possible values include:
              • "SEGMENTED_FILES"
              • "SINGLE_FILE"
          • MediaPackageGroupSettings — (map) Media Package Group Settings
            • Destination — required — (map) MediaPackage channel destination.
              • DestinationRefId — (String) Placeholder documentation for __string
          • MsSmoothGroupSettings — (map) Ms Smooth Group Settings
            • AcquisitionPointId — (String) The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
            • AudioOnlyTimecodeControl — (String) If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. Possible values include:
              • "PASSTHROUGH"
              • "USE_CONFIGURED_CLOCK"
            • CertificateMode — (String) If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. Possible values include:
              • "SELF_SIGNED"
              • "VERIFY_AUTHENTICITY"
            • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
            • Destination — required — (map) Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
              • DestinationRefId — (String) Placeholder documentation for __string
            • EventId — (String) MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
            • EventIdMode — (String) Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server. Possible values include:
              • "NO_EVENT_ID"
              • "USE_CONFIGURED"
              • "USE_TIMESTAMP"
            • EventStopBehavior — (String) When set to sendEos, send EOS signal to IIS server when stopping the event Possible values include:
              • "NONE"
              • "SEND_EOS"
            • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
            • FragmentLength — (Integer) Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
            • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
              • "EMIT_OUTPUT"
              • "PAUSE_OUTPUT"
            • NumRetries — (Integer) Number of retry attempts.
            • RestartDelay — (Integer) Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
            • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
              • "USE_INPUT_SEGMENTATION"
              • "USE_SEGMENT_DURATION"
            • SendDelayMs — (Integer) Number of milliseconds to delay the output from the second pipeline.
            • SparseTrackType — (String) If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs. Possible values include:
              • "NONE"
              • "SCTE_35"
            • StreamManifestBehavior — (String) When set to send, send stream manifest so publishing point doesn't start until all streams start. Possible values include:
              • "DO_NOT_SEND"
              • "SEND"
            • TimestampOffset — (String) Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
            • TimestampOffsetMode — (String) Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset Possible values include:
              • "USE_CONFIGURED_OFFSET"
              • "USE_EVENT_START_DATE"
          • RtmpGroupSettings — (map) Rtmp Group Settings
            • AuthenticationScheme — (String) Authentication scheme to use when connecting with CDN Possible values include:
              • "AKAMAI"
              • "COMMON"
            • CacheFullBehavior — (String) Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. Possible values include:
              • "DISCONNECT_IMMEDIATELY"
              • "WAIT_FOR_SERVER"
            • CacheLength — (Integer) Cache length, in seconds, is used to calculate buffer size.
            • CaptionData — (String) Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. Possible values include:
              • "ALL"
              • "FIELD1_608"
              • "FIELD1_AND_FIELD2_608"
            • InputLossAction — (String) Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. Possible values include:
              • "EMIT_OUTPUT"
              • "PAUSE_OUTPUT"
            • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
          • UdpGroupSettings — (map) Udp Group Settings
            • InputLossAction — (String) Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. Possible values include:
              • "DROP_PROGRAM"
              • "DROP_TS"
              • "EMIT_PROGRAM"
            • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
              • "NONE"
              • "PRIV"
              • "TDRL"
            • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
        • Outputs — required — (Array<map>) Placeholder documentation for __listOfOutput
          • AudioDescriptionNames — (Array<String>) The names of the AudioDescriptions used as audio sources for this output.
          • CaptionDescriptionNames — (Array<String>) The names of the CaptionDescriptions used as caption sources for this output.
          • OutputName — (String) The name used to identify an output.
          • OutputSettings — required — (map) Output type-specific settings.
            • ArchiveOutputSettings — (map) Archive Output Settings
              • ContainerSettings — required — (map) Settings specific to the container type of the file.
                • M2tsSettings — (map) M2ts Settings
                  • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                    • "DROP"
                    • "ENCODE_SILENCE"
                  • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                    • "DISABLED"
                    • "ENABLED"
                  • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                    • "AUTO"
                    • "USE_CONFIGURED"
                  • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                    • "ATSC"
                    • "DVB"
                  • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                  • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                    • "ATSC"
                    • "DVB"
                  • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                  • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                    • "MULTIPLEX"
                    • "NONE"
                  • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                    • "DISABLED"
                    • "ENABLED"
                  • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                    • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                    • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                    • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                  • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                    • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                      • "SDT_FOLLOW"
                      • "SDT_FOLLOW_IF_PRESENT"
                      • "SDT_MANUAL"
                      • "SDT_NONE"
                    • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                    • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                  • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                    • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                  • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                    • "NONE"
                    • "PASSTHROUGH"
                  • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                    • "VIDEO_AND_FIXED_INTERVALS"
                    • "VIDEO_INTERVAL"
                  • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                  • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                    • "VIDEO_AND_AUDIO_PIDS"
                    • "VIDEO_PID"
                  • EcmPid — (String) This field is unused and deprecated.
                  • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                    • "EXCLUDE"
                    • "INCLUDE"
                  • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                  • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                    • "NONE"
                    • "PASSTHROUGH"
                  • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                  • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                  • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                    • "CONFIGURED_PCR_PERIOD"
                    • "PCR_EVERY_PES_PACKET"
                  • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                  • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                  • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                  • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                    • "CBR"
                    • "VBR"
                  • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                    • "NONE"
                    • "PASSTHROUGH"
                  • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                    • "EBP"
                    • "EBP_LEGACY"
                    • "NONE"
                    • "PSI_SEGSTART"
                    • "RAI_ADAPT"
                    • "RAI_SEGSTART"
                  • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                    • "MAINTAIN_CADENCE"
                    • "RESET_CADENCE"
                  • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                  • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                    • "NO_PASSTHROUGH"
                    • "PASSTHROUGH"
                  • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                  • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
              • Extension — (String) Output file extension. If excluded, this will be auto-selected from the container type.
              • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
            • FrameCaptureOutputSettings — (map) Frame Capture Output Settings
              • NameModifier — (String) Required if the output group contains more than one output. This modifier forms part of the output file name.
            • HlsOutputSettings — (map) Hls Output Settings
              • HlsSettings — required — (map) Settings regarding the underlying stream. These settings are different for audio-only outputs.
                • AudioOnlyHlsSettings — (map) Audio Only Hls Settings
                  • AudioGroupId — (String) Specifies the group to which the audio Rendition belongs.
                  • AudioOnlyImage — (map) For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by file size * count * count..
                    • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                    • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                    • Username — (String) Documentation update needed
                  • AudioTrackType — (String) Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO Possible values include:
                    • "ALTERNATE_AUDIO_AUTO_SELECT"
                    • "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT"
                    • "ALTERNATE_AUDIO_NOT_AUTO_SELECT"
                    • "AUDIO_ONLY_VARIANT_STREAM"
                • StandardHlsSettings — (map) Standard Hls Settings
                  • AudioRenditionSets — (String) List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
                  • M3u8Settings — required — (map) Settings information for the .m3u8 container
                    • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                    • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
                    • EcmPid — (String) This parameter is unused and deprecated.
                    • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                    • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                      • "CONFIGURED_PCR_PERIOD"
                      • "PCR_EVERY_PES_PACKET"
                    • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
                    • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
                    • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                    • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
                    • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                    • Scte35Behavior — (String) If set to passthrough, passes any SCTE-35 signals from the input source to this output. Possible values include:
                      • "NO_PASSTHROUGH"
                      • "PASSTHROUGH"
                    • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
                    • TimedMetadataBehavior — (String) When set to passthrough, timed metadata is passed through from input to output. Possible values include:
                      • "NO_PASSTHROUGH"
                      • "PASSTHROUGH"
                    • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                    • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                    • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
              • NameModifier — (String) String concatenated to the end of the destination filename. Accepts \"Format Identifiers\":#formatIdentifierParameters.
              • SegmentModifier — (String) String concatenated to end of segment filenames.
            • MediaPackageOutputSettings — (map) Media Package Output Settings
            • MsSmoothOutputSettings — (map) Ms Smooth Output Settings
              • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
            • RtmpOutputSettings — (map) Rtmp Output Settings
              • CertificateMode — (String) If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. Possible values include:
                • "SELF_SIGNED"
                • "VERIFY_AUTHENTICITY"
              • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
              • Destination — required — (map) The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
                • DestinationRefId — (String) Placeholder documentation for __string
              • NumRetries — (Integer) Number of retry attempts.
            • UdpOutputSettings — (map) Udp Output Settings
              • BufferMsec — (Integer) UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
              • ContainerSettings — required — (map) Udp Container Settings
                • M2tsSettings — (map) M2ts Settings
                  • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                    • "DROP"
                    • "ENCODE_SILENCE"
                  • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                    • "DISABLED"
                    • "ENABLED"
                  • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                    • "AUTO"
                    • "USE_CONFIGURED"
                  • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                    • "ATSC"
                    • "DVB"
                  • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                  • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                    • "ATSC"
                    • "DVB"
                  • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                  • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                    • "MULTIPLEX"
                    • "NONE"
                  • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                    • "DISABLED"
                    • "ENABLED"
                  • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                    • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                    • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                    • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                  • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                    • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                      • "SDT_FOLLOW"
                      • "SDT_FOLLOW_IF_PRESENT"
                      • "SDT_MANUAL"
                      • "SDT_NONE"
                    • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                    • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                    • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                  • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                    • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                  • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                    • "NONE"
                    • "PASSTHROUGH"
                  • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                    • "VIDEO_AND_FIXED_INTERVALS"
                    • "VIDEO_INTERVAL"
                  • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                  • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                    • "VIDEO_AND_AUDIO_PIDS"
                    • "VIDEO_PID"
                  • EcmPid — (String) This field is unused and deprecated.
                  • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                    • "EXCLUDE"
                    • "INCLUDE"
                  • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                  • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                    • "NONE"
                    • "PASSTHROUGH"
                  • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                  • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                  • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                    • "CONFIGURED_PCR_PERIOD"
                    • "PCR_EVERY_PES_PACKET"
                  • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                  • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                  • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                  • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                    • "CBR"
                    • "VBR"
                  • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                  • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                    • "NONE"
                    • "PASSTHROUGH"
                  • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                    • "EBP"
                    • "EBP_LEGACY"
                    • "NONE"
                    • "PSI_SEGSTART"
                    • "RAI_ADAPT"
                    • "RAI_SEGSTART"
                  • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                    • "MAINTAIN_CADENCE"
                    • "RESET_CADENCE"
                  • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                  • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                    • "NO_PASSTHROUGH"
                    • "PASSTHROUGH"
                  • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                  • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
              • Destination — required — (map) Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
                • DestinationRefId — (String) Placeholder documentation for __string
              • FecOutputSettings — (map) Settings for enabling and adjusting Forward Error Correction on UDP outputs.
                • ColumnDepth — (Integer) Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
                • IncludeFec — (String) Enables column only or column and row based FEC Possible values include:
                  • "COLUMN"
                  • "COLUMN_AND_ROW"
                • RowLength — (Integer) Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
          • VideoDescriptionName — (String) The name of the VideoDescription used as the source for this output.
      • TimecodeConfig — required — (map) Contains settings used to acquire and adjust timecode information from inputs.
        • Source — required — (String) Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. Possible values include:
          • "EMBEDDED"
          • "SYSTEMCLOCK"
          • "ZEROBASED"
        • SyncThreshold — (Integer) Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
      • VideoDescriptions — required — (Array<map>) Placeholder documentation for __listOfVideoDescription
        • CodecSettings — (map) Video codec settings.
          • FrameCaptureSettings — (map) Frame Capture Settings
            • CaptureInterval — required — (Integer) The frequency, in seconds, for capturing frames for inclusion in the output. For example, "10" means capture a frame every 10 seconds.
          • H264Settings — (map) H264 Settings
            • AdaptiveQuantization — (String) Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. Possible values include:
              • "HIGH"
              • "HIGHER"
              • "LOW"
              • "MAX"
              • "MEDIUM"
              • "OFF"
            • AfdSignaling — (String) Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. Possible values include:
              • "AUTO"
              • "FIXED"
              • "NONE"
            • Bitrate — (Integer) Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
            • BufFillPct — (Integer) Percentage of the buffer that should initially be filled (HRD buffer model).
            • BufSize — (Integer) Size of buffer (HRD buffer model) in bits/second.
            • ColorMetadata — (String) Includes colorspace metadata in the output. Possible values include:
              • "IGNORE"
              • "INSERT"
            • EntropyEncoding — (String) Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. Possible values include:
              • "CABAC"
              • "CAVLC"
            • FixedAfd — (String) Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. Possible values include:
              • "AFD_0000"
              • "AFD_0010"
              • "AFD_0011"
              • "AFD_0100"
              • "AFD_1000"
              • "AFD_1001"
              • "AFD_1010"
              • "AFD_1011"
              • "AFD_1101"
              • "AFD_1110"
              • "AFD_1111"
            • FlickerAq — (String) If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • FramerateControl — (String) This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. Possible values include:
              • "INITIALIZE_FROM_SOURCE"
              • "SPECIFIED"
            • FramerateDenominator — (Integer) Framerate denominator.
            • FramerateNumerator — (Integer) Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
            • GopBReference — (String) Documentation update needed Possible values include:
              • "DISABLED"
              • "ENABLED"
            • GopClosedCadence — (Integer) Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
            • GopNumBFrames — (Integer) Number of B-frames between reference frames.
            • GopSize — (Float) GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. Must be greater than zero.
            • GopSizeUnits — (String) Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. Possible values include:
              • "FRAMES"
              • "SECONDS"
            • Level — (String) H.264 Level. Possible values include:
              • "H264_LEVEL_1"
              • "H264_LEVEL_1_1"
              • "H264_LEVEL_1_2"
              • "H264_LEVEL_1_3"
              • "H264_LEVEL_2"
              • "H264_LEVEL_2_1"
              • "H264_LEVEL_2_2"
              • "H264_LEVEL_3"
              • "H264_LEVEL_3_1"
              • "H264_LEVEL_3_2"
              • "H264_LEVEL_4"
              • "H264_LEVEL_4_1"
              • "H264_LEVEL_4_2"
              • "H264_LEVEL_5"
              • "H264_LEVEL_5_1"
              • "H264_LEVEL_5_2"
              • "H264_LEVEL_AUTO"
            • LookAheadRateControl — (String) Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. Possible values include:
              • "HIGH"
              • "LOW"
              • "MEDIUM"
            • MaxBitrate — (Integer) For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
            • MinIInterval — (Integer) Only meaningful if sceneChangeDetect is set to enabled. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
            • NumRefFrames — (Integer) Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
            • ParControl — (String) This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. Possible values include:
              • "INITIALIZE_FROM_SOURCE"
              • "SPECIFIED"
            • ParDenominator — (Integer) Pixel Aspect Ratio denominator.
            • ParNumerator — (Integer) Pixel Aspect Ratio numerator.
            • Profile — (String) H.264 Profile. Possible values include:
              • "BASELINE"
              • "HIGH"
              • "HIGH_10BIT"
              • "HIGH_422"
              • "HIGH_422_10BIT"
              • "MAIN"
            • QvbrQualityLevel — (Integer) Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
            • RateControlMode — (String) Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Possible values include:
              • "CBR"
              • "QVBR"
              • "VBR"
            • ScanType — (String) Sets the scan type of the output to progressive or top-field-first interlaced. Possible values include:
              • "INTERLACED"
              • "PROGRESSIVE"
            • SceneChangeDetect — (String) Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • Slices — (Integer) Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
            • Softness — (Integer) Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
            • SpatialAq — (String) If set to enabled, adjust quantization within each frame based on spatial variation of content complexity. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • SubgopLength — (String) If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. Possible values include:
              • "DYNAMIC"
              • "FIXED"
            • Syntax — (String) Produces a bitstream compliant with SMPTE RP-2027. Possible values include:
              • "DEFAULT"
              • "RP2027"
            • TemporalAq — (String) If set to enabled, adjust quantization within each frame based on temporal variation of content complexity. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • TimecodeInsertion — (String) Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config Possible values include:
              • "DISABLED"
              • "PIC_TIMING_SEI"
        • Height — (Integer) Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
        • Name — required — (String) The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
        • RespondToAfd — (String) Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped. Possible values include:
          • "NONE"
          • "PASSTHROUGH"
          • "RESPOND"
        • ScalingBehavior — (String) STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. Possible values include:
          • "DEFAULT"
          • "STRETCH_TO_OUTPUT"
        • Sharpness — (Integer) Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
        • Width — (Integer) Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
    • InputAttachments — (Array<map>) Placeholder documentation for __listOfInputAttachment
      • InputAttachmentName — (String) User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
      • InputId — (String) The ID of the input
      • InputSettings — (map) Settings of an input (caption selector, etc.)
        • AudioSelectors — (Array<map>) Used to select the audio stream to decode for inputs that have multiple available.
          • Name — required — (String) The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
          • SelectorSettings — (map) The audio selector settings.
            • AudioLanguageSelection — (map) Audio Language Selection
              • LanguageCode — required — (String) Selects a specific three-letter language code from within an audio source.
              • LanguageSelectionPolicy — (String) When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. Possible values include:
                • "LOOSE"
                • "STRICT"
            • AudioPidSelection — (map) Audio Pid Selection
              • Pid — required — (Integer) Selects a specific PID from within a source.
        • CaptionSelectors — (Array<map>) Used to select the caption input to use for inputs that have multiple available.
          • LanguageCode — (String) When specified this field indicates the three letter language code of the caption track to extract from the source.
          • Name — required — (String) Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
          • SelectorSettings — (map) Caption selector settings.
            • AribSourceSettings — (map) Arib Source Settings
            • DvbSubSourceSettings — (map) Dvb Sub Source Settings
              • Pid — (Integer) When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
            • EmbeddedSourceSettings — (map) Embedded Source Settings
              • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                • "DISABLED"
                • "UPCONVERT"
              • Scte20Detection — (String) Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. Possible values include:
                • "AUTO"
                • "OFF"
              • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
              • Source608TrackNumber — (Integer) This field is unused and deprecated.
            • Scte20SourceSettings — (map) Scte20 Source Settings
              • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                • "DISABLED"
                • "UPCONVERT"
              • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
            • Scte27SourceSettings — (map) Scte27 Source Settings
              • Pid — (Integer) The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
            • TeletextSourceSettings — (map) Teletext Source Settings
              • PageNumber — (String) Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
        • DeblockFilter — (String) Enable or disable the deblock filter when filtering. Possible values include:
          • "DISABLED"
          • "ENABLED"
        • DenoiseFilter — (String) Enable or disable the denoise filter when filtering. Possible values include:
          • "DISABLED"
          • "ENABLED"
        • FilterStrength — (Integer) Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
        • InputFilter — (String) Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type Possible values include:
          • "AUTO"
          • "DISABLED"
          • "FORCED"
        • NetworkInputSettings — (map) Input settings.
          • HlsInputSettings — (map) Specifies HLS input settings when the uri is for a HLS manifest.
            • Bandwidth — (Integer) When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
            • BufferSegments — (Integer) When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
            • Retries — (Integer) The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
            • RetryInterval — (Integer) The number of seconds between retries when an attempt to read a manifest or segment fails.
          • ServerValidation — (String) Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. Possible values include:
            • "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME"
            • "CHECK_CRYPTOGRAPHY_ONLY"
        • SourceEndBehavior — (String) Loop input if it is a file. This allows a file input to be streamed indefinitely. Possible values include:
          • "CONTINUE"
          • "LOOP"
        • VideoSelector — (map) Informs which video elementary stream to decode for input types that have multiple available.
          • ColorSpace — (String) Specifies the colorspace of an input. This setting works in tandem with colorSpaceConversion to determine if any conversion will be performed. Possible values include:
            • "FOLLOW"
            • "REC_601"
            • "REC_709"
          • ColorSpaceUsage — (String) Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. Possible values include:
            • "FALLBACK"
            • "FORCE"
          • SelectorSettings — (map) The video selector settings.
            • VideoSelectorPid — (map) Video Selector Pid
              • Pid — (Integer) Selects a specific PID from within a video source.
            • VideoSelectorProgramId — (map) Video Selector Program Id
              • ProgramId — (Integer) Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
    • InputSpecification — (map) Specification of input for this channel (max. bitrate, resolution, codec, etc.)
      • Codec — (String) Input codec Possible values include:
        • "MPEG2"
        • "AVC"
        • "HEVC"
      • MaximumBitrate — (String) Maximum input bitrate, categorized coarsely Possible values include:
        • "MAX_10_MBPS"
        • "MAX_20_MBPS"
        • "MAX_50_MBPS"
      • Resolution — (String) Input resolution, categorized coarsely Possible values include:
        • "SD"
        • "HD"
        • "UHD"
    • LogLevel — (String) The log level to write to CloudWatch Logs. Possible values include:
      • "ERROR"
      • "WARNING"
      • "INFO"
      • "DEBUG"
      • "DISABLED"
    • Name — (String) The name of the channel.
    • RoleArn — (String) An optional Amazon Resource Name (ARN) of the role to assume when running the Channel. If you do not specify this on an update call but the role was previously set that role will be removed.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Channel — (map) Placeholder documentation for Channel
        • Arn — (String) The unique arn of the channel.
        • ChannelClass — (String) The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline. Possible values include:
          • "STANDARD"
          • "SINGLE_PIPELINE"
        • Destinations — (Array<map>) A list of destinations of the channel. For UDP outputs, there is one destination per output. For other types (HLS, for example), there is one destination per packager.
          • Id — (String) User-specified id. This is used in an output group or an output.
          • MediaPackageSettings — (Array<map>) Destination settings for a MediaPackage output; one destination for both encoders.
            • ChannelId — (String) ID of the channel in MediaPackage that is the destination for this output group. You do not need to specify the individual inputs in MediaPackage; MediaLive will handle the connection of the two MediaLive pipelines to the two MediaPackage inputs. The MediaPackage channel and MediaLive channel must be in the same region.
          • Settings — (Array<map>) Destination settings for a standard output; one destination for each redundant encoder.
            • PasswordParam — (String) key used to extract the password from EC2 Parameter store
            • StreamName — (String) Stream name for RTMP destinations (URLs of type rtmp://)
            • Url — (String) A URL specifying a destination
            • Username — (String) username for destination
        • EgressEndpoints — (Array<map>) The endpoints where outgoing connections initiate from
          • SourceIp — (String) Public IP of where a channel's output comes from
        • EncoderSettings — (map) Encoder Settings
          • AudioDescriptions — required — (Array<map>) Placeholder documentation for __listOfAudioDescription
            • AudioNormalizationSettings — (map) Advanced audio normalization settings.
              • Algorithm — (String) Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification. Possible values include:
                • "ITU_1770_1"
                • "ITU_1770_2"
              • AlgorithmControl — (String) When set to correctAudio the output audio is corrected using the chosen algorithm. If set to measureOnly, the audio will be measured but not adjusted. Possible values include:
                • "CORRECT_AUDIO"
              • TargetLkfs — (Float) Target LKFS(loudness) to adjust volume to. If no value is entered, a default value will be used according to the chosen algorithm. The CALM Act (1770-1) recommends a target of -24 LKFS. The EBU R-128 specification (1770-2) recommends a target of -23 LKFS.
            • AudioSelectorName — required — (String) The name of the AudioSelector used as the source for this AudioDescription.
            • AudioType — (String) Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1. Possible values include:
              • "CLEAN_EFFECTS"
              • "HEARING_IMPAIRED"
              • "UNDEFINED"
              • "VISUAL_IMPAIRED_COMMENTARY"
            • AudioTypeControl — (String) Determines how audio type is determined. followInput: If the input contains an ISO 639 audioType, then that value is passed through to the output. If the input contains no ISO 639 audioType, the value in Audio Type is included in the output. useConfigured: The value in Audio Type is included in the output. Note that this field and audioType are both ignored if inputType is broadcasterMixedAd. Possible values include:
              • "FOLLOW_INPUT"
              • "USE_CONFIGURED"
            • CodecSettings — (map) Audio codec settings.
              • AacSettings — (map) Aac Settings
                • Bitrate — (Float) Average bitrate in bits/second. Valid values depend on rate control mode and profile.
                • CodingMode — (String) Mono, Stereo, or 5.1 channel layout. Valid values depend on rate control mode and profile. The adReceiverMix setting receives a stereo description plus control track and emits a mono AAC encode of the description track, with control data emitted in the PES header as per ETSI TS 101 154 Annex E. Possible values include:
                  • "AD_RECEIVER_MIX"
                  • "CODING_MODE_1_0"
                  • "CODING_MODE_1_1"
                  • "CODING_MODE_2_0"
                  • "CODING_MODE_5_1"
                • InputType — (String) Set to "broadcasterMixedAd" when input contains pre-mixed main audio + AD (narration) as a stereo pair. The Audio Type field (audioType) will be set to 3, which signals to downstream systems that this stream contains "broadcaster mixed AD". Note that the input received by the encoder must contain pre-mixed audio; the encoder does not perform the mixing. The values in audioTypeControl and audioType (in AudioDescription) are ignored when set to broadcasterMixedAd. Leave set to "normal" when input does not contain pre-mixed audio + AD. Possible values include:
                  • "BROADCASTER_MIXED_AD"
                  • "NORMAL"
                • Profile — (String) AAC Profile. Possible values include:
                  • "HEV1"
                  • "HEV2"
                  • "LC"
                • RateControlMode — (String) Rate Control Mode. Possible values include:
                  • "CBR"
                  • "VBR"
                • RawFormat — (String) Sets LATM / LOAS AAC output for raw containers. Possible values include:
                  • "LATM_LOAS"
                  • "NONE"
                • SampleRate — (Float) Sample rate in Hz. Valid values depend on rate control mode and profile.
                • Spec — (String) Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers. Possible values include:
                  • "MPEG2"
                  • "MPEG4"
                • VbrQuality — (String) VBR Quality Level - Only used if rateControlMode is VBR. Possible values include:
                  • "HIGH"
                  • "LOW"
                  • "MEDIUM_HIGH"
                  • "MEDIUM_LOW"
              • Ac3Settings — (map) Ac3 Settings
                • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
                • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values. Possible values include:
                  • "COMMENTARY"
                  • "COMPLETE_MAIN"
                  • "DIALOGUE"
                  • "EMERGENCY"
                  • "HEARING_IMPAIRED"
                  • "MUSIC_AND_EFFECTS"
                  • "VISUALLY_IMPAIRED"
                  • "VOICE_OVER"
                • CodingMode — (String) Dolby Digital coding mode. Determines number of channels. Possible values include:
                  • "CODING_MODE_1_0"
                  • "CODING_MODE_1_1"
                  • "CODING_MODE_2_0"
                  • "CODING_MODE_3_2_LFE"
                • Dialnorm — (Integer) Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.
                • DrcProfile — (String) If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification. Possible values include:
                  • "FILM_STANDARD"
                  • "NONE"
                • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • MetadataControl — (String) When set to "followInput", encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
                  • "FOLLOW_INPUT"
                  • "USE_CONFIGURED"
              • Eac3Settings — (map) Eac3 Settings
                • AttenuationControl — (String) When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode. Possible values include:
                  • "ATTENUATE_3_DB"
                  • "NONE"
                • Bitrate — (Float) Average bitrate in bits/second. Valid bitrates depend on the coding mode.
                • BitstreamMode — (String) Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values. Possible values include:
                  • "COMMENTARY"
                  • "COMPLETE_MAIN"
                  • "EMERGENCY"
                  • "HEARING_IMPAIRED"
                  • "VISUALLY_IMPAIRED"
                • CodingMode — (String) Dolby Digital Plus coding mode. Determines number of channels. Possible values include:
                  • "CODING_MODE_1_0"
                  • "CODING_MODE_2_0"
                  • "CODING_MODE_3_2"
                • DcFilter — (String) When set to enabled, activates a DC highpass filter for all input channels. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • Dialnorm — (Integer) Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.
                • DrcLine — (String) Sets the Dolby dynamic range compression profile. Possible values include:
                  • "FILM_LIGHT"
                  • "FILM_STANDARD"
                  • "MUSIC_LIGHT"
                  • "MUSIC_STANDARD"
                  • "NONE"
                  • "SPEECH"
                • DrcRf — (String) Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels. Possible values include:
                  • "FILM_LIGHT"
                  • "FILM_STANDARD"
                  • "MUSIC_LIGHT"
                  • "MUSIC_STANDARD"
                  • "NONE"
                  • "SPEECH"
                • LfeControl — (String) When encoding 3/2 audio, setting to lfe enables the LFE channel Possible values include:
                  • "LFE"
                  • "NO_LFE"
                • LfeFilter — (String) When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • LoRoCenterMixLevel — (Float) Left only/Right only center mix level. Only used for 3/2 coding mode.
                • LoRoSurroundMixLevel — (Float) Left only/Right only surround mix level. Only used for 3/2 coding mode.
                • LtRtCenterMixLevel — (Float) Left total/Right total center mix level. Only used for 3/2 coding mode.
                • LtRtSurroundMixLevel — (Float) Left total/Right total surround mix level. Only used for 3/2 coding mode.
                • MetadataControl — (String) When set to followInput, encoder metadata will be sourced from the DD, DD+, or DolbyE decoder that supplied this audio data. If audio was not supplied from one of these streams, then the static metadata settings will be used. Possible values include:
                  • "FOLLOW_INPUT"
                  • "USE_CONFIGURED"
                • PassthroughControl — (String) When set to whenPossible, input DD+ audio will be passed through if it is present on the input. This detection is dynamic over the life of the transcode. Inputs that alternate between DD+ and non-DD+ content will have a consistent DD+ output as the system alternates between passthrough and encoding. Possible values include:
                  • "NO_PASSTHROUGH"
                  • "WHEN_POSSIBLE"
                • PhaseControl — (String) When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode. Possible values include:
                  • "NO_SHIFT"
                  • "SHIFT_90_DEGREES"
                • StereoDownmix — (String) Stereo downmix preference. Only used for 3/2 coding mode. Possible values include:
                  • "DPL2"
                  • "LO_RO"
                  • "LT_RT"
                  • "NOT_INDICATED"
                • SurroundExMode — (String) When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                  • "NOT_INDICATED"
                • SurroundMode — (String) When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                  • "NOT_INDICATED"
              • Mp2Settings — (map) Mp2 Settings
                • Bitrate — (Float) Average bitrate in bits/second.
                • CodingMode — (String) The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo). Possible values include:
                  • "CODING_MODE_1_0"
                  • "CODING_MODE_2_0"
                • SampleRate — (Float) Sample rate in Hz.
              • PassThroughSettings — (map) Pass Through Settings
            • LanguageCode — (String) Indicates the language of the audio output track. Only used if languageControlMode is useConfigured, or there is no ISO 639 language code specified in the input.
            • LanguageCodeControl — (String) Choosing followInput will cause the ISO 639 language code of the output to follow the ISO 639 language code of the input. The languageCode will be used when useConfigured is set, or when followInput is selected but there is no ISO 639 language code specified by the input. Possible values include:
              • "FOLLOW_INPUT"
              • "USE_CONFIGURED"
            • Name — required — (String) The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.
            • RemixSettings — (map) Settings that control how input audio channels are remixed into the output audio channels.
              • ChannelMappings — required — (Array<map>) Mapping of input channels to output channels, with appropriate gain adjustments.
                • InputChannelLevels — required — (Array<map>) Indices and gain values for each input channel that should be remixed into this output channel.
                  • Gain — required — (Integer) Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.
                  • InputChannel — required — (Integer) The index of the input channel used as a source.
                • OutputChannel — required — (Integer) The index of the output channel being produced.
              • ChannelsIn — (Integer) Number of input channels to be used.
              • ChannelsOut — (Integer) Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8
            • StreamName — (String) Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).
          • AvailBlanking — (map) Settings for ad avail blanking.
            • AvailBlankingImage — (map) Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • State — (String) When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added. Possible values include:
              • "DISABLED"
              • "ENABLED"
          • AvailConfiguration — (map) Event-wide configuration settings for ad avail insertion.
            • AvailSettings — (map) Ad avail settings.
              • Scte35SpliceInsert — (map) Scte35 Splice Insert
                • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
                • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                  • "FOLLOW"
                  • "IGNORE"
                • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                  • "FOLLOW"
                  • "IGNORE"
              • Scte35TimeSignalApos — (map) Scte35 Time Signal Apos
                • AdAvailOffset — (Integer) When specified, this offset (in milliseconds) is added to the input Ad Avail PTS time. This only applies to embedded SCTE 104/35 messages and does not apply to OOB messages.
                • NoRegionalBlackoutFlag — (String) When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                  • "FOLLOW"
                  • "IGNORE"
                • WebDeliveryAllowedFlag — (String) When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates Possible values include:
                  • "FOLLOW"
                  • "IGNORE"
          • BlackoutSlate — (map) Settings for blackout slate.
            • BlackoutSlateImage — (map) Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • NetworkEndBlackout — (String) Setting to enabled causes the encoder to blackout the video, audio, and captions, and raise the "Network Blackout Image" slate when an SCTE104/35 Network End Segmentation Descriptor is encountered. The blackout will be lifted when the Network Start Segmentation Descriptor is encountered. The Network End and Network Start descriptors must contain a network ID that matches the value entered in "Network ID". Possible values include:
              • "DISABLED"
              • "ENABLED"
            • NetworkEndBlackoutImage — (map) Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.
              • PasswordParam — (String) key used to extract the password from EC2 Parameter store
              • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
              • Username — (String) Documentation update needed
            • NetworkId — (String) Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").
            • State — (String) When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata. Possible values include:
              • "DISABLED"
              • "ENABLED"
          • CaptionDescriptions — (Array<map>) Settings for caption decriptions
            • CaptionSelectorName — required — (String) Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.
            • DestinationSettings — (map) Additional settings for captions destination that depend on the destination type.
              • AribDestinationSettings — (map) Arib Destination Settings
              • BurnInDestinationSettings — (map) Burn In Destination Settings
                • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "CENTERED"
                  • "LEFT"
                  • "SMART"
                • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "NONE"
                  • "WHITE"
                • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
                • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
                  • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                  • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                  • Username — (String) Documentation update needed
                • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "BLUE"
                  • "GREEN"
                  • "RED"
                  • "WHITE"
                  • "YELLOW"
                • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
                • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
                • FontSize — (String) When set to 'auto' fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
                • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "BLUE"
                  • "GREEN"
                  • "RED"
                  • "WHITE"
                  • "YELLOW"
                • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
                • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "NONE"
                  • "WHITE"
                • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter out is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
                • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
                • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
                • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
                  • "FIXED"
                  • "SCALED"
                • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. All burn-in and DVB-Sub font settings must match.
                • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. All burn-in and DVB-Sub font settings must match.
              • DvbSubDestinationSettings — (map) Dvb Sub Destination Settings
                • Alignment — (String) If no explicit xPosition or yPosition is provided, setting alignment to centered will place the captions at the bottom center of the output. Similarly, setting a left alignment will align captions to the bottom left of the output. If x and y positions are given in conjunction with the alignment parameter, the font will be justified (either left or centered) relative to those coordinates. Selecting "smart" justification will left-justify live subtitles and center-justify pre-recorded subtitles. This option is not valid for source captions that are STL or 608/embedded. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "CENTERED"
                  • "LEFT"
                  • "SMART"
                • BackgroundColor — (String) Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "NONE"
                  • "WHITE"
                • BackgroundOpacity — (Integer) Specifies the opacity of the background rectangle. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
                • Font — (map) External font file used for caption burn-in. File extension must be 'ttf' or 'tte'. Although the user can select output fonts for many different types of input captions, embedded, STL and teletext sources use a strict grid system. Using external fonts with these caption sources could cause unexpected display of proportional fonts. All burn-in and DVB-Sub font settings must match.
                  • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                  • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                  • Username — (String) Documentation update needed
                • FontColor — (String) Specifies the color of the burned-in captions. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "BLUE"
                  • "GREEN"
                  • "RED"
                  • "WHITE"
                  • "YELLOW"
                • FontOpacity — (Integer) Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.
                • FontResolution — (Integer) Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.
                • FontSize — (String) When set to auto fontSize will scale depending on the size of the output. Giving a positive integer will specify the exact font size in points. All burn-in and DVB-Sub font settings must match.
                • OutlineColor — (String) Specifies font outline color. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "BLUE"
                  • "GREEN"
                  • "RED"
                  • "WHITE"
                  • "YELLOW"
                • OutlineSize — (Integer) Specifies font outline size in pixels. This option is not valid for source captions that are either 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
                • ShadowColor — (String) Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match. Possible values include:
                  • "BLACK"
                  • "NONE"
                  • "WHITE"
                • ShadowOpacity — (Integer) Specifies the opacity of the shadow. 255 is opaque; 0 is transparent. Leaving this parameter blank is equivalent to setting it to 0 (transparent). All burn-in and DVB-Sub font settings must match.
                • ShadowXOffset — (Integer) Specifies the horizontal offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels to the left. All burn-in and DVB-Sub font settings must match.
                • ShadowYOffset — (Integer) Specifies the vertical offset of the shadow relative to the captions in pixels. A value of -2 would result in a shadow offset 2 pixels above the text. All burn-in and DVB-Sub font settings must match.
                • TeletextGridControl — (String) Controls whether a fixed grid size will be used to generate the output subtitles bitmap. Only applicable for Teletext inputs and DVB-Sub/Burn-in outputs. Possible values include:
                  • "FIXED"
                  • "SCALED"
                • XPosition — (Integer) Specifies the horizontal position of the caption relative to the left side of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the left of the output. If no explicit xPosition is provided, the horizontal caption position will be determined by the alignment parameter. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
                • YPosition — (Integer) Specifies the vertical position of the caption relative to the top of the output in pixels. A value of 10 would result in the captions starting 10 pixels from the top of the output. If no explicit yPosition is provided, the caption will be positioned towards the bottom of the output. This option is not valid for source captions that are STL, 608/embedded or teletext. These source settings are already pre-defined by the caption stream. All burn-in and DVB-Sub font settings must match.
              • EmbeddedDestinationSettings — (map) Embedded Destination Settings
              • EmbeddedPlusScte20DestinationSettings — (map) Embedded Plus Scte20 Destination Settings
              • RtmpCaptionInfoDestinationSettings — (map) Rtmp Caption Info Destination Settings
              • Scte20PlusEmbeddedDestinationSettings — (map) Scte20 Plus Embedded Destination Settings
              • Scte27DestinationSettings — (map) Scte27 Destination Settings
              • SmpteTtDestinationSettings — (map) Smpte Tt Destination Settings
              • TeletextDestinationSettings — (map) Teletext Destination Settings
              • TtmlDestinationSettings — (map) Ttml Destination Settings
                • StyleControl — (String) When set to passthrough, passes through style and position information from a TTML-like input source (TTML, SMPTE-TT, CFF-TT) to the CFF-TT output or TTML output. Possible values include:
                  • "PASSTHROUGH"
                  • "USE_CONFIGURED"
              • WebvttDestinationSettings — (map) Webvtt Destination Settings
            • LanguageCode — (String) ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/
            • LanguageDescription — (String) Human readable information to indicate captions available for players (eg. English, or Spanish).
            • Name — required — (String) Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.
          • GlobalConfiguration — (map) Configuration settings that apply to the event as a whole.
            • InitialAudioGain — (Integer) Value to set the initial audio gain for the Live Event.
            • InputEndAction — (String) Indicates the action to take when the current input completes (e.g. end-of-file). When switchAndLoopInputs is configured the encoder will restart at the beginning of the first input. When "none" is configured the encoder will transcode either black, a solid color, or a user specified slate images per the "Input Loss Behavior" configuration until the next input switch occurs (which is controlled through the Channel Schedule API). Possible values include:
              • "NONE"
              • "SWITCH_AND_LOOP_INPUTS"
            • InputLossBehavior — (map) Settings for system actions when input is lost.
              • BlackFrameMsec — (Integer) Documentation update needed
              • InputLossImageColor — (String) When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.
              • InputLossImageSlate — (map) When input loss image type is "slate" these fields specify the parameters for accessing the slate.
                • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                • Username — (String) Documentation update needed
              • InputLossImageType — (String) Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec. Possible values include:
                • "COLOR"
                • "SLATE"
              • RepeatFrameMsec — (Integer) Documentation update needed
            • OutputLockingMode — (String) Indicates how MediaLive pipelines are synchronized. PIPELINELOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCHLOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch. Possible values include:
              • "EPOCH_LOCKING"
              • "PIPELINE_LOCKING"
            • OutputTimingSource — (String) Indicates whether the rate of frames emitted by the Live encoder should be paced by its system clock (which optionally may be locked to another source via NTP) or should be locked to the clock of the source that is providing the input stream. Possible values include:
              • "INPUT_CLOCK"
              • "SYSTEM_CLOCK"
            • SupportLowFramerateInputs — (String) Adjusts video input buffer for streams with very low video framerates. This is commonly set to enabled for music channels with less than one video frame per second. Possible values include:
              • "DISABLED"
              • "ENABLED"
          • OutputGroups — required — (Array<map>) Placeholder documentation for __listOfOutputGroup
            • Name — (String) Custom output group name optionally defined by the user. Only letters, numbers, and the underscore character allowed; only 32 characters allowed.
            • OutputGroupSettings — required — (map) Settings associated with the output group.
              • ArchiveGroupSettings — (map) Archive Group Settings
                • Destination — required — (map) A directory and base filename where archive files should be written.
                  • DestinationRefId — (String) Placeholder documentation for __string
                • RolloverInterval — (Integer) Number of seconds to write to archive file before closing and starting a new one.
              • FrameCaptureGroupSettings — (map) Frame Capture Group Settings
                • Destination — required — (map) The destination for the frame capture files. Either the URI for an Amazon S3 bucket and object, plus a file name prefix (for example, s3ssl://sportsDelivery/highlights/20180820/curling) or the URI for a MediaStore container, plus a file name prefix (for example, mediastoressl://sportsDelivery/20180820/curling). The final file names consist of the prefix from the destination field (for example, "curling_") + name modifier + the counter (5 digits, starting from 00001) + extension (which is always .jpg). For example, curlingLow.00001.jpg
                  • DestinationRefId — (String) Placeholder documentation for __string
              • HlsGroupSettings — (map) Hls Group Settings
                • AdMarkers — (Array<String>) Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.
                • BaseUrlContent — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
                • BaseUrlManifest — (String) A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.
                • CaptionLanguageMappings — (Array<map>) Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".
                  • CaptionChannel — required — (Integer) The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)
                  • LanguageCode — required — (String) Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)
                  • LanguageDescription — required — (String) Textual description of language
                • CaptionLanguageSetting — (String) Applies only to 608 Embedded output captions. insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions. none: Include CLOSED-CAPTIONS=NONE line in the manifest. omit: Omit any CLOSED-CAPTIONS line from the manifest. Possible values include:
                  • "INSERT"
                  • "NONE"
                  • "OMIT"
                • ClientCache — (String) When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • CodecSpecification — (String) Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation. Possible values include:
                  • "RFC_4281"
                  • "RFC_6381"
                • ConstantIv — (String) For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.
                • Destination — required — (map) A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).
                  • DestinationRefId — (String) Placeholder documentation for __string
                • DirectoryStructure — (String) Place segments in subdirectories. Possible values include:
                  • "SINGLE_DIRECTORY"
                  • "SUBDIRECTORY_PER_STREAM"
                • EncryptionType — (String) Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired. Possible values include:
                  • "AES128"
                  • "SAMPLE_AES"
                • HlsCdnSettings — (map) Parameters that control interactions with the CDN.
                  • HlsAkamaiSettings — (map) Hls Akamai Settings
                    • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                    • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                    • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature. Possible values include:
                      • "CHUNKED"
                      • "NON_CHUNKED"
                    • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                    • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                    • Salt — (String) Salt for authenticated Akamai.
                    • Token — (String) Token parameter for authenticated akamai. If not specified, gda is used.
                  • HlsBasicPutSettings — (map) Hls Basic Put Settings
                    • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                    • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                    • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                    • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                  • HlsMediaStoreSettings — (map) Hls Media Store Settings
                    • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                    • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                    • MediaStoreStorageClass — (String) When set to temporal, output files are stored in non-persistent memory for faster reading and writing. Possible values include:
                      • "TEMPORAL"
                    • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                    • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                  • HlsWebdavSettings — (map) Hls Webdav Settings
                    • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the CDN if the connection is lost.
                    • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                    • HttpTransferMode — (String) Specify whether or not to use chunked transfer encoding to WebDAV. Possible values include:
                      • "CHUNKED"
                      • "NON_CHUNKED"
                    • NumRetries — (Integer) Number of retry attempts that will be made before the Live Event is put into an error state.
                    • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
                • IFrameOnlyPlaylists — (String) DISABLED: Do not create an I-frame-only manifest, but do create the master and media manifests (according to the Output Selection field). STANDARD: Create an I-frame-only manifest for each output that contains video, as well as the other manifests (according to the Output Selection field). The I-frame manifest contains a #EXT-X-I-FRAMES-ONLY tag to indicate it is I-frame only, and one or more #EXT-X-BYTERANGE entries identifying the I-frame position. For example, #EXT-X-BYTERANGE:160364@1461888" Possible values include:
                  • "DISABLED"
                  • "STANDARD"
                • IndexNSegments — (Integer) Applies only if Mode field is LIVE. Specifies the maximum number of segments in the media manifest file. After this maximum, older segments are removed from the media manifest. This number must be less than or equal to the Keep Segments field.
                • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
                  • "EMIT_OUTPUT"
                  • "PAUSE_OUTPUT"
                • IvInManifest — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest. Possible values include:
                  • "EXCLUDE"
                  • "INCLUDE"
                • IvSource — (String) For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value. Possible values include:
                  • "EXPLICIT"
                  • "FOLLOWS_SEGMENT_NUMBER"
                • KeepSegments — (Integer) Applies only if Mode field is LIVE. Specifies the number of media segments (.ts files) to retain in the destination directory.
                • KeyFormat — (String) The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.
                • KeyFormatVersions — (String) Either a single positive integer version value or a slash delimited list of version values (1/2/3).
                • KeyProviderSettings — (map) The key provider settings.
                  • StaticKeySettings — (map) Static Key Settings
                    • KeyProviderServer — (map) The URL of the license server used for protecting content.
                      • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                      • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                      • Username — (String) Documentation update needed
                    • StaticKeyValue — required — (String) Static key value as a 32 character hexadecimal string.
                • ManifestCompression — (String) When set to gzip, compresses HLS playlist. Possible values include:
                  • "GZIP"
                  • "NONE"
                • ManifestDurationFormat — (String) Indicates whether the output manifest should use floating point or integer values for segment duration. Possible values include:
                  • "FLOATING_POINT"
                  • "INTEGER"
                • MinSegmentLength — (Integer) When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.
                • Mode — (String) If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event. VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream. Possible values include:
                  • "LIVE"
                  • "VOD"
                • OutputSelection — (String) MANIFESTSANDSEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. SEGMENTSONLY: Does not generate any manifests for this output group. Possible values include:
                  • "MANIFESTS_AND_SEGMENTS"
                  • "SEGMENTS_ONLY"
                • ProgramDateTime — (String) Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset. Possible values include:
                  • "EXCLUDE"
                  • "INCLUDE"
                • ProgramDateTimePeriod — (Integer) Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.
                • RedundantManifest — (String) ENABLED: The master manifest (.m3u8 file) for each pipeline includes information about both pipelines: first its own media files, then the media files of the other pipeline. This feature allows playout device that support stale manifest detection to switch from one manifest to the other, when the current manifest seems to be stale. There are still two destinations and two master manifests, but both master manifests reference the media files from both pipelines. DISABLED: The master manifest (.m3u8 file) for each pipeline includes information about its own pipeline only. For an HLS output group with MediaPackage as the destination, the DISABLED behavior is always followed. MediaPackage regenerates the manifests it serves to players so a redundant manifest from MediaLive is irrelevant. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • SegmentLength — (Integer) Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.
                • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
                  • "USE_INPUT_SEGMENTATION"
                  • "USE_SEGMENT_DURATION"
                • SegmentsPerSubdirectory — (Integer) Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.
                • StreamInfResolution — (String) Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest. Possible values include:
                  • "EXCLUDE"
                  • "INCLUDE"
                • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
                  • "NONE"
                  • "PRIV"
                  • "TDRL"
                • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
                • TimestampDeltaMilliseconds — (Integer) Provides an extra millisecond delta offset to fine tune the timestamps.
                • TsFileMode — (String) SEGMENTEDFILES: Emit the program as segments - multiple .ts media files. SINGLEFILE: Applies only if Mode field is VOD. Emit the program as a single .ts media file. The media manifest includes #EXT-X-BYTERANGE tags to index segments for playback. A typical use for this value is when sending the output to AWS Elemental MediaConvert, which can accept only a single media file. Playback while the channel is running is not guaranteed due to HTTP server caching. Possible values include:
                  • "SEGMENTED_FILES"
                  • "SINGLE_FILE"
              • MediaPackageGroupSettings — (map) Media Package Group Settings
                • Destination — required — (map) MediaPackage channel destination.
                  • DestinationRefId — (String) Placeholder documentation for __string
              • MsSmoothGroupSettings — (map) Ms Smooth Group Settings
                • AcquisitionPointId — (String) The value of the "Acquisition Point Identity" element used in each message placed in the sparse track. Only enabled if sparseTrackType is not "none".
                • AudioOnlyTimecodeControl — (String) If set to passthrough for an audio-only MS Smooth output, the fragment absolute time will be set to the current timecode. This option does not write timecodes to the audio elementary stream. Possible values include:
                  • "PASSTHROUGH"
                  • "USE_CONFIGURED_CLOCK"
                • CertificateMode — (String) If set to verifyAuthenticity, verify the https certificate chain to a trusted Certificate Authority (CA). This will cause https outputs to self-signed certificates to fail. Possible values include:
                  • "SELF_SIGNED"
                  • "VERIFY_AUTHENTICITY"
                • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying connection to the IIS server if the connection is lost. Content will be cached during this time and the cache will be be delivered to the IIS server once the connection is re-established.
                • Destination — required — (map) Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.
                  • DestinationRefId — (String) Placeholder documentation for __string
                • EventId — (String) MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.
                • EventIdMode — (String) Specifies whether or not to send an event ID to the IIS server. If no event ID is sent and the same Live Event is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send an event ID based on the current timestamp - "noEventId" - do not send an event ID to the IIS server. Possible values include:
                  • "NO_EVENT_ID"
                  • "USE_CONFIGURED"
                  • "USE_TIMESTAMP"
                • EventStopBehavior — (String) When set to sendEos, send EOS signal to IIS server when stopping the event Possible values include:
                  • "NONE"
                  • "SEND_EOS"
                • FilecacheDuration — (Integer) Size in seconds of file cache for streaming outputs.
                • FragmentLength — (Integer) Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.
                • InputLossAction — (String) Parameter that control output group behavior on input loss. Possible values include:
                  • "EMIT_OUTPUT"
                  • "PAUSE_OUTPUT"
                • NumRetries — (Integer) Number of retry attempts.
                • RestartDelay — (Integer) Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.
                • SegmentationMode — (String) useInputSegmentation has been deprecated. The configured segment size is always used. Possible values include:
                  • "USE_INPUT_SEGMENTATION"
                  • "USE_SEGMENT_DURATION"
                • SendDelayMs — (Integer) Number of milliseconds to delay the output from the second pipeline.
                • SparseTrackType — (String) If set to scte35, use incoming SCTE-35 messages to generate a sparse track in this group of MS-Smooth outputs. Possible values include:
                  • "NONE"
                  • "SCTE_35"
                • StreamManifestBehavior — (String) When set to send, send stream manifest so publishing point doesn't start until all streams start. Possible values include:
                  • "DO_NOT_SEND"
                  • "SEND"
                • TimestampOffset — (String) Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.
                • TimestampOffsetMode — (String) Type of timestamp date offset to use. - useEventStartDate: Use the date the event was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset Possible values include:
                  • "USE_CONFIGURED_OFFSET"
                  • "USE_EVENT_START_DATE"
              • RtmpGroupSettings — (map) Rtmp Group Settings
                • AuthenticationScheme — (String) Authentication scheme to use when connecting with CDN Possible values include:
                  • "AKAMAI"
                  • "COMMON"
                • CacheFullBehavior — (String) Controls behavior when content cache fills up. If remote origin server stalls the RTMP connection and does not accept content fast enough the 'Media Cache' will fill up. When the cache reaches the duration specified by cacheLength the cache will stop accepting new content. If set to disconnectImmediately, the RTMP output will force a disconnect. Clear the media cache, and reconnect after restartDelay seconds. If set to waitForServer, the RTMP output will wait up to 5 minutes to allow the origin server to begin accepting data again. Possible values include:
                  • "DISCONNECT_IMMEDIATELY"
                  • "WAIT_FOR_SERVER"
                • CacheLength — (Integer) Cache length, in seconds, is used to calculate buffer size.
                • CaptionData — (String) Controls the types of data that passes to onCaptionInfo outputs. If set to 'all' then 608 and 708 carried DTVCC data will be passed. If set to 'field1AndField2608' then DTVCC data will be stripped out, but 608 data from both fields will be passed. If set to 'field1608' then only the data carried in 608 from field 1 video will be passed. Possible values include:
                  • "ALL"
                  • "FIELD1_608"
                  • "FIELD1_AND_FIELD2_608"
                • InputLossAction — (String) Controls the behavior of this RTMP group if input becomes unavailable. - emitOutput: Emit a slate until input returns. - pauseOutput: Stop transmitting data until input returns. This does not close the underlying RTMP connection. Possible values include:
                  • "EMIT_OUTPUT"
                  • "PAUSE_OUTPUT"
                • RestartDelay — (Integer) If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.
              • UdpGroupSettings — (map) Udp Group Settings
                • InputLossAction — (String) Specifies behavior of last resort when input video is lost, and no more backup inputs are available. When dropTs is selected the entire transport stream will stop being emitted. When dropProgram is selected the program can be dropped from the transport stream (and replaced with null packets to meet the TS bitrate requirement). Or, when emitProgram is chosen the transport stream will continue to be produced normally with repeat frames, black frames, or slate frames substituted for the absent input video. Possible values include:
                  • "DROP_PROGRAM"
                  • "DROP_TS"
                  • "EMIT_PROGRAM"
                • TimedMetadataId3Frame — (String) Indicates ID3 frame that has the timecode. Possible values include:
                  • "NONE"
                  • "PRIV"
                  • "TDRL"
                • TimedMetadataId3Period — (Integer) Timed Metadata interval in seconds.
            • Outputs — required — (Array<map>) Placeholder documentation for __listOfOutput
              • AudioDescriptionNames — (Array<String>) The names of the AudioDescriptions used as audio sources for this output.
              • CaptionDescriptionNames — (Array<String>) The names of the CaptionDescriptions used as caption sources for this output.
              • OutputName — (String) The name used to identify an output.
              • OutputSettings — required — (map) Output type-specific settings.
                • ArchiveOutputSettings — (map) Archive Output Settings
                  • ContainerSettings — required — (map) Settings specific to the container type of the file.
                    • M2tsSettings — (map) M2ts Settings
                      • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                        • "DROP"
                        • "ENCODE_SILENCE"
                      • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                        • "DISABLED"
                        • "ENABLED"
                      • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                        • "AUTO"
                        • "USE_CONFIGURED"
                      • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                        • "ATSC"
                        • "DVB"
                      • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                      • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                        • "ATSC"
                        • "DVB"
                      • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                      • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                        • "MULTIPLEX"
                        • "NONE"
                      • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                        • "DISABLED"
                        • "ENABLED"
                      • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                        • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                        • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                        • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                        • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                          • "SDT_FOLLOW"
                          • "SDT_FOLLOW_IF_PRESENT"
                          • "SDT_MANUAL"
                          • "SDT_NONE"
                        • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                        • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                        • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                      • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                        • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                        • "NONE"
                        • "PASSTHROUGH"
                      • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                        • "VIDEO_AND_FIXED_INTERVALS"
                        • "VIDEO_INTERVAL"
                      • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                      • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                        • "VIDEO_AND_AUDIO_PIDS"
                        • "VIDEO_PID"
                      • EcmPid — (String) This field is unused and deprecated.
                      • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                        • "EXCLUDE"
                        • "INCLUDE"
                      • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                      • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                        • "NONE"
                        • "PASSTHROUGH"
                      • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                      • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                      • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                        • "CONFIGURED_PCR_PERIOD"
                        • "PCR_EVERY_PES_PACKET"
                      • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                      • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                      • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                      • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                        • "CBR"
                        • "VBR"
                      • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                        • "NONE"
                        • "PASSTHROUGH"
                      • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                        • "EBP"
                        • "EBP_LEGACY"
                        • "NONE"
                        • "PSI_SEGSTART"
                        • "RAI_ADAPT"
                        • "RAI_SEGSTART"
                      • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                        • "MAINTAIN_CADENCE"
                        • "RESET_CADENCE"
                      • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                      • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                        • "NO_PASSTHROUGH"
                        • "PASSTHROUGH"
                      • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                      • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • Extension — (String) Output file extension. If excluded, this will be auto-selected from the container type.
                  • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
                • FrameCaptureOutputSettings — (map) Frame Capture Output Settings
                  • NameModifier — (String) Required if the output group contains more than one output. This modifier forms part of the output file name.
                • HlsOutputSettings — (map) Hls Output Settings
                  • HlsSettings — required — (map) Settings regarding the underlying stream. These settings are different for audio-only outputs.
                    • AudioOnlyHlsSettings — (map) Audio Only Hls Settings
                      • AudioGroupId — (String) Specifies the group to which the audio Rendition belongs.
                      • AudioOnlyImage — (map) For use with an audio only Stream. Must be a .jpg or .png file. If given, this image will be used as the cover-art for the audio only output. Ideally, it should be formatted for an iPhone screen for two reasons. The iPhone does not resize the image, it crops a centered image on the top/bottom and left/right. Additionally, this image file gets saved bit-for-bit into every 10-second segment file, so will increase bandwidth by file size * count * count..
                        • PasswordParam — (String) key used to extract the password from EC2 Parameter store
                        • Uri — required — (String) Uniform Resource Identifier - This should be a path to a file accessible to the Live system (eg. a http:// URI) depending on the output type. For example, a RTMP destination should have a uri simliar to: "rtmp://fmsserver/live".
                        • Username — (String) Documentation update needed
                      • AudioTrackType — (String) Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO Possible values include:
                        • "ALTERNATE_AUDIO_AUTO_SELECT"
                        • "ALTERNATE_AUDIO_AUTO_SELECT_DEFAULT"
                        • "ALTERNATE_AUDIO_NOT_AUTO_SELECT"
                        • "AUDIO_ONLY_VARIANT_STREAM"
                    • StandardHlsSettings — (map) Standard Hls Settings
                      • AudioRenditionSets — (String) List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ','.
                      • M3u8Settings — required — (map) Settings information for the .m3u8 container
                        • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                        • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values.
                        • EcmPid — (String) This parameter is unused and deprecated.
                        • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                        • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                          • "CONFIGURED_PCR_PERIOD"
                          • "PCR_EVERY_PES_PACKET"
                        • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.
                        • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value.
                        • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. A value of \"0\" writes out the PMT once per segment file.
                        • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.
                        • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                        • Scte35Behavior — (String) If set to passthrough, passes any SCTE-35 signals from the input source to this output. Possible values include:
                          • "NO_PASSTHROUGH"
                          • "PASSTHROUGH"
                        • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.
                        • TimedMetadataBehavior — (String) When set to passthrough, timed metadata is passed through from input to output. Possible values include:
                          • "NO_PASSTHROUGH"
                          • "PASSTHROUGH"
                        • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                        • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                        • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.
                  • NameModifier — (String) String concatenated to the end of the destination filename. Accepts \"Format Identifiers\":#formatIdentifierParameters.
                  • SegmentModifier — (String) String concatenated to end of segment filenames.
                • MediaPackageOutputSettings — (map) Media Package Output Settings
                • MsSmoothOutputSettings — (map) Ms Smooth Output Settings
                  • NameModifier — (String) String concatenated to the end of the destination filename. Required for multiple outputs of the same type.
                • RtmpOutputSettings — (map) Rtmp Output Settings
                  • CertificateMode — (String) If set to verifyAuthenticity, verify the tls certificate chain to a trusted Certificate Authority (CA). This will cause rtmps outputs with self-signed certificates to fail. Possible values include:
                    • "SELF_SIGNED"
                    • "VERIFY_AUTHENTICITY"
                  • ConnectionRetryInterval — (Integer) Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.
                  • Destination — required — (map) The RTMP endpoint excluding the stream name (eg. rtmp://host/appname). For connection to Akamai, a username and password must be supplied. URI fields accept format identifiers.
                    • DestinationRefId — (String) Placeholder documentation for __string
                  • NumRetries — (Integer) Number of retry attempts.
                • UdpOutputSettings — (map) Udp Output Settings
                  • BufferMsec — (Integer) UDP output buffering in milliseconds. Larger values increase latency through the transcoder but simultaneously assist the transcoder in maintaining a constant, low-jitter UDP/RTP output while accommodating clock recovery, input switching, input disruptions, picture reordering, etc.
                  • ContainerSettings — required — (map) Udp Container Settings
                    • M2tsSettings — (map) M2ts Settings
                      • AbsentInputAudioBehavior — (String) When set to drop, output audio streams will be removed from the program if the selected input audio stream is removed from the input. This allows the output audio configuration to dynamically change based on input configuration. If this is set to encodeSilence, all output audio streams will output encoded silence when not connected to an active input stream. Possible values include:
                        • "DROP"
                        • "ENCODE_SILENCE"
                      • Arib — (String) When set to enabled, uses ARIB-compliant field muxing and removes video descriptor. Possible values include:
                        • "DISABLED"
                        • "ENABLED"
                      • AribCaptionsPid — (String) Packet Identifier (PID) for ARIB Captions in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • AribCaptionsPidControl — (String) If set to auto, pid number used for ARIB Captions will be auto-selected from unused pids. If set to useConfigured, ARIB Captions will be on the configured pid number. Possible values include:
                        • "AUTO"
                        • "USE_CONFIGURED"
                      • AudioBufferModel — (String) When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used. Possible values include:
                        • "ATSC"
                        • "DVB"
                      • AudioFramesPerPes — (Integer) The number of audio frames to insert for each PES packet.
                      • AudioPids — (String) Packet Identifier (PID) of the elementary audio stream(s) in the transport stream. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • AudioStreamType — (String) When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06. Possible values include:
                        • "ATSC"
                        • "DVB"
                      • Bitrate — (Integer) The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.
                      • BufferModel — (String) If set to multiplex, use multiplex buffer model for accurate interleaving. Setting to bufferModel to none can lead to lower latency, but low-memory devices may not be able to play back the stream without interruptions. Possible values include:
                        • "MULTIPLEX"
                        • "NONE"
                      • CcDescriptor — (String) When set to enabled, generates captionServiceDescriptor in PMT. Possible values include:
                        • "DISABLED"
                        • "ENABLED"
                      • DvbNitSettings — (map) Inserts DVB Network Information Table (NIT) at the specified table repetition interval.
                        • NetworkId — required — (Integer) The numeric value placed in the Network Information Table (NIT).
                        • NetworkName — required — (String) The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.
                        • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • DvbSdtSettings — (map) Inserts DVB Service Description Table (SDT) at the specified table repetition interval.
                        • OutputSdt — (String) Selects method of inserting SDT information into output stream. The sdtFollow setting copies SDT information from input stream to output stream. The sdtFollowIfPresent setting copies SDT information from input stream to output stream if SDT information is present in the input, otherwise it will fall back on the user-defined values. The sdtManual setting means user will enter the SDT information. The sdtNone setting means output stream will not contain SDT information. Possible values include:
                          • "SDT_FOLLOW"
                          • "SDT_FOLLOW_IF_PRESENT"
                          • "SDT_MANUAL"
                          • "SDT_NONE"
                        • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                        • ServiceName — (String) The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                        • ServiceProviderName — (String) The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.
                      • DvbSubPids — (String) Packet Identifier (PID) for input source DVB Subtitle data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • DvbTdtSettings — (map) Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.
                        • RepInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream.
                      • DvbTeletextPid — (String) Packet Identifier (PID) for input source DVB Teletext data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • Ebif — (String) If set to passthrough, passes any EBIF data from the input source to this output. Possible values include:
                        • "NONE"
                        • "PASSTHROUGH"
                      • EbpAudioInterval — (String) When videoAndFixedIntervals is selected, audio EBP markers will be added to partitions 3 and 4. The interval between these additional markers will be fixed, and will be slightly shorter than the video EBP marker interval. Only available when EBP Cablelabs segmentation markers are selected. Partitions 1 and 2 will always follow the video interval. Possible values include:
                        • "VIDEO_AND_FIXED_INTERVALS"
                        • "VIDEO_INTERVAL"
                      • EbpLookaheadMs — (Integer) When set, enforces that Encoder Boundary Points do not come within the specified time interval of each other by looking ahead at input video. If another EBP is going to come in within the specified time interval, the current EBP is not emitted, and the segment is "stretched" to the next marker. The lookahead value does not add latency to the system. The Live Event must be configured elsewhere to create sufficient latency to make the lookahead accurate.
                      • EbpPlacement — (String) Controls placement of EBP on Audio PIDs. If set to videoAndAudioPids, EBP markers will be placed on the video PID and all audio PIDs. If set to videoPid, EBP markers will be placed on only the video PID. Possible values include:
                        • "VIDEO_AND_AUDIO_PIDS"
                        • "VIDEO_PID"
                      • EcmPid — (String) This field is unused and deprecated.
                      • EsRateInPes — (String) Include or exclude the ES Rate field in the PES header. Possible values include:
                        • "EXCLUDE"
                        • "INCLUDE"
                      • EtvPlatformPid — (String) Packet Identifier (PID) for input source ETV Platform data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • EtvSignalPid — (String) Packet Identifier (PID) for input source ETV Signal data to this output. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • FragmentTime — (Float) The length in seconds of each fragment. Only used with EBP markers.
                      • Klv — (String) If set to passthrough, passes any KLV data from the input source to this output. Possible values include:
                        • "NONE"
                        • "PASSTHROUGH"
                      • KlvDataPids — (String) Packet Identifier (PID) for input source KLV data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • NullPacketBitrate — (Float) Value in bits per second of extra null packets to insert into the transport stream. This can be used if a downstream encryption system requires periodic null packets.
                      • PatInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                      • PcrControl — (String) When set to pcrEveryPesPacket, a Program Clock Reference value is inserted for every Packetized Elementary Stream (PES) header. This parameter is effective only when the PCR PID is the same as the video or audio elementary stream. Possible values include:
                        • "CONFIGURED_PCR_PERIOD"
                        • "PCR_EVERY_PES_PACKET"
                      • PcrPeriod — (Integer) Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.
                      • PcrPid — (String) Packet Identifier (PID) of the Program Clock Reference (PCR) in the transport stream. When no value is given, the encoder will assign the same value as the Video PID. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • PmtInterval — (Integer) The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.
                      • PmtPid — (String) Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • ProgramNum — (Integer) The value of the program number field in the Program Map Table.
                      • RateMode — (String) When vbr, does not insert null packets into transport stream to fill specified bitrate. The bitrate setting acts as the maximum bitrate when vbr is set. Possible values include:
                        • "CBR"
                        • "VBR"
                      • Scte27Pids — (String) Packet Identifier (PID) for input source SCTE-27 data to this output. Multiple values are accepted, and can be entered in ranges and/or by comma separation. Can be entered as decimal or hexadecimal values. Each PID specified must be in the range of 32 (or 0x20)..8182 (or 0x1ff6).
                      • Scte35Control — (String) Optionally pass SCTE-35 signals from the input source to this output. Possible values include:
                        • "NONE"
                        • "PASSTHROUGH"
                      • Scte35Pid — (String) Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • SegmentationMarkers — (String) Inserts segmentation markers at each segmentationTime period. raiSegstart sets the Random Access Indicator bit in the adaptation field. raiAdapt sets the RAI bit and adds the current timecode in the private data bytes. psiSegstart inserts PAT and PMT tables at the start of segments. ebp adds Encoder Boundary Point information to the adaptation field as per OpenCable specification OC-SP-EBP-I01-130118. ebpLegacy adds Encoder Boundary Point information to the adaptation field using a legacy proprietary format. Possible values include:
                        • "EBP"
                        • "EBP_LEGACY"
                        • "NONE"
                        • "PSI_SEGSTART"
                        • "RAI_ADAPT"
                        • "RAI_SEGSTART"
                      • SegmentationStyle — (String) The segmentation style parameter controls how segmentation markers are inserted into the transport stream. With avails, it is possible that segments may be truncated, which can influence where future segmentation markers are inserted. When a segmentation style of "resetCadence" is selected and a segment is truncated due to an avail, we will reset the segmentation cadence. This means the subsequent segment will have a duration of $segmentationTime seconds. When a segmentation style of "maintainCadence" is selected and a segment is truncated due to an avail, we will not reset the segmentation cadence. This means the subsequent segment will likely be truncated as well. However, all segments after that will have a duration of $segmentationTime seconds. Note that EBP lookahead is a slight exception to this rule. Possible values include:
                        • "MAINTAIN_CADENCE"
                        • "RESET_CADENCE"
                      • SegmentationTime — (Float) The length in seconds of each segment. Required unless markers is set to None_.
                      • TimedMetadataBehavior — (String) When set to passthrough, timed metadata will be passed through from input to output. Possible values include:
                        • "NO_PASSTHROUGH"
                        • "PASSTHROUGH"
                      • TimedMetadataPid — (String) Packet Identifier (PID) of the timed metadata stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                      • TransportStreamId — (Integer) The value of the transport stream ID field in the Program Map Table.
                      • VideoPid — (String) Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value. Valid values are 32 (or 0x20)..8182 (or 0x1ff6).
                  • Destination — required — (map) Destination address and port number for RTP or UDP packets. Can be unicast or multicast RTP or UDP (eg. rtp://239.10.10.10:5001 or udp://10.100.100.100:5002).
                    • DestinationRefId — (String) Placeholder documentation for __string
                  • FecOutputSettings — (map) Settings for enabling and adjusting Forward Error Correction on UDP outputs.
                    • ColumnDepth — (Integer) Parameter D from SMPTE 2022-1. The height of the FEC protection matrix. The number of transport stream packets per column error correction packet. Must be between 4 and 20, inclusive.
                    • IncludeFec — (String) Enables column only or column and row based FEC Possible values include:
                      • "COLUMN"
                      • "COLUMN_AND_ROW"
                    • RowLength — (Integer) Parameter L from SMPTE 2022-1. The width of the FEC protection matrix. Must be between 1 and 20, inclusive. If only Column FEC is used, then larger values increase robustness. If Row FEC is used, then this is the number of transport stream packets per row error correction packet, and the value must be between 4 and 20, inclusive, if includeFec is columnAndRow. If includeFec is column, this value must be 1 to 20, inclusive.
              • VideoDescriptionName — (String) The name of the VideoDescription used as the source for this output.
          • TimecodeConfig — required — (map) Contains settings used to acquire and adjust timecode information from inputs.
            • Source — required — (String) Identifies the source for the timecode that will be associated with the events outputs. -Embedded (embedded): Initialize the output timecode with timecode from the the source. If no embedded timecode is detected in the source, the system falls back to using "Start at 0" (zerobased). -System Clock (systemclock): Use the UTC time. -Start at 0 (zerobased): The time of the first frame of the event will be 00:00:00:00. Possible values include:
              • "EMBEDDED"
              • "SYSTEMCLOCK"
              • "ZEROBASED"
            • SyncThreshold — (Integer) Threshold in frames beyond which output timecode is resynchronized to the input timecode. Discrepancies below this threshold are permitted to avoid unnecessary discontinuities in the output timecode. No timecode sync when this is not specified.
          • VideoDescriptions — required — (Array<map>) Placeholder documentation for __listOfVideoDescription
            • CodecSettings — (map) Video codec settings.
              • FrameCaptureSettings — (map) Frame Capture Settings
                • CaptureInterval — required — (Integer) The frequency, in seconds, for capturing frames for inclusion in the output. For example, "10" means capture a frame every 10 seconds.
              • H264Settings — (map) H264 Settings
                • AdaptiveQuantization — (String) Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality. Possible values include:
                  • "HIGH"
                  • "HIGHER"
                  • "LOW"
                  • "MAX"
                  • "MEDIUM"
                  • "OFF"
                • AfdSignaling — (String) Indicates that AFD values will be written into the output stream. If afdSignaling is "auto", the system will try to preserve the input AFD value (in cases where multiple AFD values are valid). If set to "fixed", the AFD value will be the value configured in the fixedAfd parameter. Possible values include:
                  • "AUTO"
                  • "FIXED"
                  • "NONE"
                • Bitrate — (Integer) Average bitrate in bits/second. Required when the rate control mode is VBR or CBR. Not used for QVBR. In an MS Smooth output group, each output must have a unique value when its bitrate is rounded down to the nearest multiple of 1000.
                • BufFillPct — (Integer) Percentage of the buffer that should initially be filled (HRD buffer model).
                • BufSize — (Integer) Size of buffer (HRD buffer model) in bits/second.
                • ColorMetadata — (String) Includes colorspace metadata in the output. Possible values include:
                  • "IGNORE"
                  • "INSERT"
                • EntropyEncoding — (String) Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc. Possible values include:
                  • "CABAC"
                  • "CAVLC"
                • FixedAfd — (String) Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'. Possible values include:
                  • "AFD_0000"
                  • "AFD_0010"
                  • "AFD_0011"
                  • "AFD_0100"
                  • "AFD_1000"
                  • "AFD_1001"
                  • "AFD_1010"
                  • "AFD_1011"
                  • "AFD_1101"
                  • "AFD_1110"
                  • "AFD_1111"
                • FlickerAq — (String) If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • FramerateControl — (String) This field indicates how the output video frame rate is specified. If "specified" is selected then the output video frame rate is determined by framerateNumerator and framerateDenominator, else if "initializeFromSource" is selected then the output video frame rate will be set equal to the input video frame rate of the first input. Possible values include:
                  • "INITIALIZE_FROM_SOURCE"
                  • "SPECIFIED"
                • FramerateDenominator — (Integer) Framerate denominator.
                • FramerateNumerator — (Integer) Framerate numerator - framerate is a fraction, e.g. 24000 / 1001 = 23.976 fps.
                • GopBReference — (String) Documentation update needed Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • GopClosedCadence — (Integer) Frequency of closed GOPs. In streaming applications, it is recommended that this be set to 1 so a decoder joining mid-stream will receive an IDR frame as quickly as possible. Setting this value to 0 will break output segmenting.
                • GopNumBFrames — (Integer) Number of B-frames between reference frames.
                • GopSize — (Float) GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. Must be greater than zero.
                • GopSizeUnits — (String) Indicates if the gopSize is specified in frames or seconds. If seconds the system will convert the gopSize into a frame count at run time. Possible values include:
                  • "FRAMES"
                  • "SECONDS"
                • Level — (String) H.264 Level. Possible values include:
                  • "H264_LEVEL_1"
                  • "H264_LEVEL_1_1"
                  • "H264_LEVEL_1_2"
                  • "H264_LEVEL_1_3"
                  • "H264_LEVEL_2"
                  • "H264_LEVEL_2_1"
                  • "H264_LEVEL_2_2"
                  • "H264_LEVEL_3"
                  • "H264_LEVEL_3_1"
                  • "H264_LEVEL_3_2"
                  • "H264_LEVEL_4"
                  • "H264_LEVEL_4_1"
                  • "H264_LEVEL_4_2"
                  • "H264_LEVEL_5"
                  • "H264_LEVEL_5_1"
                  • "H264_LEVEL_5_2"
                  • "H264_LEVEL_AUTO"
                • LookAheadRateControl — (String) Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content. Possible values include:
                  • "HIGH"
                  • "LOW"
                  • "MEDIUM"
                • MaxBitrate — (Integer) For QVBR: See the tooltip for Quality level For VBR: Set the maximum bitrate in order to accommodate expected spikes in the complexity of the video.
                • MinIInterval — (Integer) Only meaningful if sceneChangeDetect is set to enabled. Enforces separation between repeated (cadence) I-frames and I-frames inserted by Scene Change Detection. If a scene change I-frame is within I-interval frames of a cadence I-frame, the GOP is shrunk and/or stretched to the scene change I-frame. GOP stretch requires enabling lookahead as well as setting I-interval. The normal cadence resumes for the next GOP. Note: Maximum GOP stretch = GOP size + Min-I-interval - 1
                • NumRefFrames — (Integer) Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.
                • ParControl — (String) This field indicates how the output pixel aspect ratio is specified. If "specified" is selected then the output video pixel aspect ratio is determined by parNumerator and parDenominator, else if "initializeFromSource" is selected then the output pixsel aspect ratio will be set equal to the input video pixel aspect ratio of the first input. Possible values include:
                  • "INITIALIZE_FROM_SOURCE"
                  • "SPECIFIED"
                • ParDenominator — (Integer) Pixel Aspect Ratio denominator.
                • ParNumerator — (Integer) Pixel Aspect Ratio numerator.
                • Profile — (String) H.264 Profile. Possible values include:
                  • "BASELINE"
                  • "HIGH"
                  • "HIGH_10BIT"
                  • "HIGH_422"
                  • "HIGH_422_10BIT"
                  • "MAIN"
                • QvbrQualityLevel — (Integer) Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. Set values for the QVBR quality level field and Max bitrate field that suit your most important viewing devices. Recommended values are: - Primary screen: Quality level: 8 to 10. Max bitrate: 4M - PC or tablet: Quality level: 7. Max bitrate: 1.5M to 3M - Smartphone: Quality level: 6. Max bitrate: 1M to 1.5M
                • RateControlMode — (String) Rate control mode. QVBR: Quality will match the specified quality level except when it is constrained by the maximum bitrate. Recommended if you or your viewers pay for bandwidth. VBR: Quality and bitrate vary, depending on the video complexity. Recommended instead of QVBR if you want to maintain a specific average bitrate over the duration of the channel. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Possible values include:
                  • "CBR"
                  • "QVBR"
                  • "VBR"
                • ScanType — (String) Sets the scan type of the output to progressive or top-field-first interlaced. Possible values include:
                  • "INTERLACED"
                  • "PROGRESSIVE"
                • SceneChangeDetect — (String) Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • Slices — (Integer) Number of slices per picture. Must be less than or equal to the number of macroblock rows for progressive pictures, and less than or equal to half the number of macroblock rows for interlaced pictures. This field is optional; when no value is specified the encoder will choose the number of slices based on encode resolution.
                • Softness — (Integer) Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image.
                • SpatialAq — (String) If set to enabled, adjust quantization within each frame based on spatial variation of content complexity. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • SubgopLength — (String) If set to fixed, use gopNumBFrames B-frames per sub-GOP. If set to dynamic, optimize the number of B-frames used for each sub-GOP to improve visual quality. Possible values include:
                  • "DYNAMIC"
                  • "FIXED"
                • Syntax — (String) Produces a bitstream compliant with SMPTE RP-2027. Possible values include:
                  • "DEFAULT"
                  • "RP2027"
                • TemporalAq — (String) If set to enabled, adjust quantization within each frame based on temporal variation of content complexity. Possible values include:
                  • "DISABLED"
                  • "ENABLED"
                • TimecodeInsertion — (String) Determines how timecodes should be inserted into the video elementary stream. - 'disabled': Do not include timecodes - 'picTimingSei': Pass through picture timing SEI messages from the source specified in Timecode Config Possible values include:
                  • "DISABLED"
                  • "PIC_TIMING_SEI"
            • Height — (Integer) Output video height, in pixels. Must be an even number. For most codecs, you can leave this field and width blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
            • Name — required — (String) The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.
            • RespondToAfd — (String) Indicates how to respond to the AFD values in the input stream. RESPOND causes input video to be clipped, depending on the AFD value, input display aspect ratio, and output display aspect ratio, and (except for FRAMECAPTURE codec) includes the values in the output. PASSTHROUGH (does not apply to FRAMECAPTURE codec) ignores the AFD values and includes the values in the output, so input video is not clipped. NONE ignores the AFD values and does not include the values through to the output, so input video is not clipped. Possible values include:
              • "NONE"
              • "PASSTHROUGH"
              • "RESPOND"
            • ScalingBehavior — (String) STRETCHTOOUTPUT configures the output position to stretch the video to the specified output resolution (height and width). This option will override any position value. DEFAULT may insert black boxes (pillar boxes or letter boxes) around the video to provide the specified output resolution. Possible values include:
              • "DEFAULT"
              • "STRETCH_TO_OUTPUT"
            • Sharpness — (Integer) Changes the strength of the anti-alias filter used for scaling. 0 is the softest setting, 100 is the sharpest. A setting of 50 is recommended for most content.
            • Width — (Integer) Output video width, in pixels. Must be an even number. For most codecs, you can leave this field and height blank in order to use the height and width (resolution) from the source. Note, however, that leaving blank is not recommended. For the Frame Capture codec, height and width are required.
        • Id — (String) The unique id of the channel.
        • InputAttachments — (Array<map>) List of input attachments for channel.
          • InputAttachmentName — (String) User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.
          • InputId — (String) The ID of the input
          • InputSettings — (map) Settings of an input (caption selector, etc.)
            • AudioSelectors — (Array<map>) Used to select the audio stream to decode for inputs that have multiple available.
              • Name — required — (String) The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.
              • SelectorSettings — (map) The audio selector settings.
                • AudioLanguageSelection — (map) Audio Language Selection
                  • LanguageCode — required — (String) Selects a specific three-letter language code from within an audio source.
                  • LanguageSelectionPolicy — (String) When set to "strict", the transport stream demux strictly identifies audio streams by their language descriptor. If a PMT update occurs such that an audio stream matching the initially selected language is no longer present then mute will be encoded until the language returns. If "loose", then on a PMT update the demux will choose another audio stream in the program with the same stream type if it can't find one with the same language. Possible values include:
                    • "LOOSE"
                    • "STRICT"
                • AudioPidSelection — (map) Audio Pid Selection
                  • Pid — required — (Integer) Selects a specific PID from within a source.
            • CaptionSelectors — (Array<map>) Used to select the caption input to use for inputs that have multiple available.
              • LanguageCode — (String) When specified this field indicates the three letter language code of the caption track to extract from the source.
              • Name — required — (String) Name identifier for a caption selector. This name is used to associate this caption selector with one or more caption descriptions. Names must be unique within an event.
              • SelectorSettings — (map) Caption selector settings.
                • AribSourceSettings — (map) Arib Source Settings
                • DvbSubSourceSettings — (map) Dvb Sub Source Settings
                  • Pid — (Integer) When using DVB-Sub with Burn-In or SMPTE-TT, use this PID for the source content. Unused for DVB-Sub passthrough. All DVB-Sub content is passed through, regardless of selectors.
                • EmbeddedSourceSettings — (map) Embedded Source Settings
                  • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                    • "DISABLED"
                    • "UPCONVERT"
                  • Scte20Detection — (String) Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions. Possible values include:
                    • "AUTO"
                    • "OFF"
                  • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
                  • Source608TrackNumber — (Integer) This field is unused and deprecated.
                • Scte20SourceSettings — (map) Scte20 Source Settings
                  • Convert608To708 — (String) If upconvert, 608 data is both passed through via the "608 compatibility bytes" fields of the 708 wrapper as well as translated into 708. 708 data present in the source content will be discarded. Possible values include:
                    • "DISABLED"
                    • "UPCONVERT"
                  • Source608ChannelNumber — (Integer) Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.
                • Scte27SourceSettings — (map) Scte27 Source Settings
                  • Pid — (Integer) The pid field is used in conjunction with the caption selector languageCode field as follows: - Specify PID and Language: Extracts captions from that PID; the language is "informational". - Specify PID and omit Language: Extracts the specified PID. - Omit PID and specify Language: Extracts the specified language, whichever PID that happens to be. - Omit PID and omit Language: Valid only if source is DVB-Sub that is being passed through; all languages will be passed through.
                • TeletextSourceSettings — (map) Teletext Source Settings
                  • PageNumber — (String) Specifies the teletext page number within the data stream from which to extract captions. Range of 0x100 (256) to 0x8FF (2303). Unused for passthrough. Should be specified as a hexadecimal string with no "0x" prefix.
            • DeblockFilter — (String) Enable or disable the deblock filter when filtering. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • DenoiseFilter — (String) Enable or disable the denoise filter when filtering. Possible values include:
              • "DISABLED"
              • "ENABLED"
            • FilterStrength — (Integer) Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).
            • InputFilter — (String) Turns on the filter for this input. MPEG-2 inputs have the deblocking filter enabled by default. 1) auto - filtering will be applied depending on input type/quality 2) disabled - no filtering will be applied to the input 3) forced - filtering will be applied regardless of input type Possible values include:
              • "AUTO"
              • "DISABLED"
              • "FORCED"
            • NetworkInputSettings — (map) Input settings.
              • HlsInputSettings — (map) Specifies HLS input settings when the uri is for a HLS manifest.
                • Bandwidth — (Integer) When specified the HLS stream with the m3u8 BANDWIDTH that most closely matches this value will be chosen, otherwise the highest bandwidth stream in the m3u8 will be chosen. The bitrate is specified in bits per second, as in an HLS manifest.
                • BufferSegments — (Integer) When specified, reading of the HLS input will begin this many buffer segments from the end (most recently written segment). When not specified, the HLS input will begin with the first segment specified in the m3u8.
                • Retries — (Integer) The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.
                • RetryInterval — (Integer) The number of seconds between retries when an attempt to read a manifest or segment fails.
              • ServerValidation — (String) Check HTTPS server certificates. When set to checkCryptographyOnly, cryptography in the certificate will be checked, but not the server's name. Certain subdomains (notably S3 buckets that use dots in the bucket name) do not strictly match the corresponding certificate's wildcard pattern and would otherwise cause the event to error. This setting is ignored for protocols that do not use https. Possible values include:
                • "CHECK_CRYPTOGRAPHY_AND_VALIDATE_NAME"
                • "CHECK_CRYPTOGRAPHY_ONLY"
            • SourceEndBehavior — (String) Loop input if it is a file. This allows a file input to be streamed indefinitely. Possible values include:
              • "CONTINUE"
              • "LOOP"
            • VideoSelector — (map) Informs which video elementary stream to decode for input types that have multiple available.
              • ColorSpace — (String) Specifies the colorspace of an input. This setting works in tandem with colorSpaceConversion to determine if any conversion will be performed. Possible values include:
                • "FOLLOW"
                • "REC_601"
                • "REC_709"
              • ColorSpaceUsage — (String) Applies only if colorSpace is a value other than follow. This field controls how the value in the colorSpace field will be used. fallback means that when the input does include color space data, that data will be used, but when the input has no color space data, the value in colorSpace will be used. Choose fallback if your input is sometimes missing color space data, but when it does have color space data, that data is correct. force means to always use the value in colorSpace. Choose force if your input usually has no color space data or might have unreliable color space data. Possible values include:
                • "FALLBACK"
                • "FORCE"
              • SelectorSettings — (map) The video selector settings.
                • VideoSelectorPid — (map) Video Selector Pid
                  • Pid — (Integer) Selects a specific PID from within a video source.
                • VideoSelectorProgramId — (map) Video Selector Program Id
                  • ProgramId — (Integer) Selects a specific program from within a multi-program transport stream. If the program doesn't exist, the first program within the transport stream will be selected by default.
        • InputSpecification — (map) Placeholder documentation for InputSpecification
          • Codec — (String) Input codec Possible values include:
            • "MPEG2"
            • "AVC"
            • "HEVC"
          • MaximumBitrate — (String) Maximum input bitrate, categorized coarsely Possible values include:
            • "MAX_10_MBPS"
            • "MAX_20_MBPS"
            • "MAX_50_MBPS"
          • Resolution — (String) Input resolution, categorized coarsely Possible values include:
            • "SD"
            • "HD"
            • "UHD"
        • LogLevel — (String) The log level being written to CloudWatch Logs. Possible values include:
          • "ERROR"
          • "WARNING"
          • "INFO"
          • "DEBUG"
          • "DISABLED"
        • Name — (String) The name of the channel. (user-mutable)
        • PipelinesRunningCount — (Integer) The number of currently healthy pipelines.
        • RoleArn — (String) The Amazon Resource Name (ARN) of the role assumed when running the Channel.
        • State — (String) Placeholder documentation for ChannelState Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "IDLE"
          • "STARTING"
          • "RUNNING"
          • "RECOVERING"
          • "STOPPING"
          • "DELETING"
          • "DELETED"
        • Tags — (map<String>) A collection of key-value pairs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateInput(params = {}, callback) ⇒ AWS.Request

Updates an input.

Service Reference:

Examples:

Calling the updateInput operation

var params = {
  InputId: 'STRING_VALUE', /* required */
  Destinations: [
    {
      StreamName: 'STRING_VALUE'
    },
    /* more items */
  ],
  InputSecurityGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  MediaConnectFlows: [
    {
      FlowArn: 'STRING_VALUE'
    },
    /* more items */
  ],
  Name: 'STRING_VALUE',
  RoleArn: 'STRING_VALUE',
  Sources: [
    {
      PasswordParam: 'STRING_VALUE',
      Url: 'STRING_VALUE',
      Username: 'STRING_VALUE'
    },
    /* more items */
  ]
};
medialive.updateInput(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Destinations — (Array<map>) Destination settings for PUSH type inputs.
      • StreamName — (String) A unique name for the location the RTMP stream is being pushed to.
    • InputId — (String) Unique ID of the input.
    • InputSecurityGroups — (Array<String>) A list of security groups referenced by IDs to attach to the input.
    • MediaConnectFlows — (Array<map>) A list of the MediaConnect Flow ARNs that you want to use as the source of the input. You can specify as few as one Flow and presently, as many as two. The only requirement is when you have more than one is that each Flow is in a separate Availability Zone as this ensures your EML input is redundant to AZ issues.
      • FlowArn — (String) The ARN of the MediaConnect Flow that you want to use as a source.
    • Name — (String) Name of the input.
    • RoleArn — (String) The Amazon Resource Name (ARN) of the role this input assumes during and after creation.
    • Sources — (Array<map>) The source URLs for a PULL-type input. Every PULL type input needs exactly two source URLs for redundancy. Only specify sources for PULL type Inputs. Leave Destinations empty.
      • PasswordParam — (String) The key used to extract the password from EC2 Parameter store.
      • Url — (String) This represents the customer's source URL where stream is pulled from.
      • Username — (String) The username for the input source.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Input — (map) Placeholder documentation for Input
        • Arn — (String) The Unique ARN of the input (generated, immutable).
        • AttachedChannels — (Array<String>) A list of channel IDs that that input is attached to (currently an input can only be attached to one channel).
        • Destinations — (Array<map>) A list of the destinations of the input (PUSH-type).
          • Ip — (String) The system-generated static IP address of endpoint. It remains fixed for the lifetime of the input.
          • Port — (String) The port number for the input.
          • Url — (String) This represents the endpoint that the customer stream will be pushed to.
          • Vpc — (map) The properties for a VPC type input destination.
            • AvailabilityZone — (String) The availability zone of the Input destination.
            • NetworkInterfaceId — (String) The network interface ID of the Input destination in the VPC.
        • Id — (String) The generated ID of the input (unique for user account, immutable).
        • InputClass — (String) STANDARD - MediaLive expects two sources to be connected to this input. If the channel is also STANDARD, both sources will be ingested. If the channel is SINGLE_PIPELINE, only the first source will be ingested; the second source will always be ignored, even if the first source fails. SINGLE_PIPELINE - You can connect only one source to this input. If the ChannelClass is also SINGLE_PIPELINE, this value is valid. If the ChannelClass is STANDARD, this value is not valid because the channel requires two sources in the input. Possible values include:
          • "STANDARD"
          • "SINGLE_PIPELINE"
        • MediaConnectFlows — (Array<map>) A list of MediaConnect Flows for this input.
          • FlowArn — (String) The unique ARN of the MediaConnect Flow being used as a source.
        • Name — (String) The user-assigned name (This is a mutable value).
        • RoleArn — (String) The Amazon Resource Name (ARN) of the role this input assumes during and after creation.
        • SecurityGroups — (Array<String>) A list of IDs for all the Input Security Groups attached to the input.
        • Sources — (Array<map>) A list of the sources of the input (PULL-type).
          • PasswordParam — (String) The key used to extract the password from EC2 Parameter store.
          • Url — (String) This represents the customer's source URL where stream is pulled from.
          • Username — (String) The username for the input source.
        • State — (String) Placeholder documentation for InputState Possible values include:
          • "CREATING"
          • "DETACHED"
          • "ATTACHED"
          • "DELETING"
          • "DELETED"
        • Tags — (map<String>) A collection of key-value pairs.
        • Type — (String) Placeholder documentation for InputType Possible values include:
          • "UDP_PUSH"
          • "RTP_PUSH"
          • "RTMP_PUSH"
          • "RTMP_PULL"
          • "URL_PULL"
          • "MP4_FILE"
          • "MEDIACONNECT"

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateInputSecurityGroup(params = {}, callback) ⇒ AWS.Request

Update an Input Security Group's Whilelists.

Service Reference:

Examples:

Calling the updateInputSecurityGroup operation

var params = {
  InputSecurityGroupId: 'STRING_VALUE', /* required */
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  },
  WhitelistRules: [
    {
      Cidr: 'STRING_VALUE'
    },
    /* more items */
  ]
};
medialive.updateInputSecurityGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • InputSecurityGroupId — (String) The id of the Input Security Group to update.
    • Tags — (map<String>) A collection of key-value pairs.
    • WhitelistRules — (Array<map>) List of IPv4 CIDR addresses to whitelist
      • Cidr — (String) The IPv4 CIDR to whitelist.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SecurityGroup — (map) An Input Security Group
        • Arn — (String) Unique ARN of Input Security Group
        • Id — (String) The Id of the Input Security Group
        • Inputs — (Array<String>) The list of inputs currently using this Input Security Group.
        • State — (String) The current state of the Input Security Group. Possible values include:
          • "IDLE"
          • "IN_USE"
          • "UPDATING"
          • "DELETED"
        • Tags — (map<String>) A collection of key-value pairs.
        • WhitelistRules — (Array<map>) Whitelist rules and their sync status
          • Cidr — (String) The IPv4 CIDR that's whitelisted.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateReservation(params = {}, callback) ⇒ AWS.Request

Update reservation.

Service Reference:

Examples:

Calling the updateReservation operation

var params = {
  ReservationId: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE'
};
medialive.updateReservation(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • Name — (String) Name of the reservation
    • ReservationId — (String) Unique reservation ID, e.g. '1234567'

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Reservation — (map) Reserved resources available to use
        • Arn — (String) Unique reservation ARN, e.g. 'arn:aws:medialive:us-west-2:123456789012:reservation:1234567'
        • Count — (Integer) Number of reserved resources
        • CurrencyCode — (String) Currency code for usagePrice and fixedPrice in ISO-4217 format, e.g. 'USD'
        • Duration — (Integer) Lease duration, e.g. '12'
        • DurationUnits — (String) Units for duration, e.g. 'MONTHS' Possible values include:
          • "MONTHS"
        • End — (String) Reservation UTC end date and time in ISO-8601 format, e.g. '2019-03-01T00:00:00'
        • FixedPrice — (Float) One-time charge for each reserved resource, e.g. '0.0' for a NO_UPFRONT offering
        • Name — (String) User specified reservation name
        • OfferingDescription — (String) Offering description, e.g. 'HD AVC output at 10-20 Mbps, 30 fps, and standard VQ in US West (Oregon)'
        • OfferingId — (String) Unique offering ID, e.g. '87654321'
        • OfferingType — (String) Offering type, e.g. 'NO_UPFRONT' Possible values include:
          • "NO_UPFRONT"
        • Region — (String) AWS region, e.g. 'us-west-2'
        • ReservationId — (String) Unique reservation ID, e.g. '1234567'
        • ResourceSpecification — (map) Resource configuration details
          • ChannelClass — (String) Channel class, e.g. 'STANDARD' Possible values include:
            • "STANDARD"
            • "SINGLE_PIPELINE"
          • Codec — (String) Codec, e.g. 'AVC' Possible values include:
            • "MPEG2"
            • "AVC"
            • "HEVC"
            • "AUDIO"
          • MaximumBitrate — (String) Maximum bitrate, e.g. 'MAX_20_MBPS' Possible values include:
            • "MAX_10_MBPS"
            • "MAX_20_MBPS"
            • "MAX_50_MBPS"
          • MaximumFramerate — (String) Maximum framerate, e.g. 'MAX_30_FPS' (Outputs only) Possible values include:
            • "MAX_30_FPS"
            • "MAX_60_FPS"
          • Resolution — (String) Resolution, e.g. 'HD' Possible values include:
            • "SD"
            • "HD"
            • "UHD"
          • ResourceType — (String) Resource type, 'INPUT', 'OUTPUT', or 'CHANNEL' Possible values include:
            • "INPUT"
            • "OUTPUT"
            • "CHANNEL"
          • SpecialFeature — (String) Special feature, e.g. 'AUDIO_NORMALIZATION' (Channels only) Possible values include:
            • "ADVANCED_AUDIO"
            • "AUDIO_NORMALIZATION"
          • VideoQuality — (String) Video quality, e.g. 'STANDARD' (Outputs only) Possible values include:
            • "STANDARD"
            • "ENHANCED"
            • "PREMIUM"
        • Start — (String) Reservation UTC start date and time in ISO-8601 format, e.g. '2018-03-01T00:00:00'
        • State — (String) Current state of reservation, e.g. 'ACTIVE' Possible values include:
          • "ACTIVE"
          • "EXPIRED"
          • "CANCELED"
          • "DELETED"
        • Tags — (map<String>) A collection of key-value pairs
        • UsagePrice — (Float) Recurring usage charge for each reserved resource, e.g. '157.0'

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.