Skip to content

aws.medialive.describe_channel

Example SQL Queries

SELECT * FROM
aws.medialive.describe_channel
WHERE
"channel_id" = 'VALUE';

Description

Gets details about a channel

Table Definition

Column NameColumn Data Type
channel_id Required Input Column

channel ID

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
arn

The unique arn of the channel.

VARCHAR
cdi_input_specification

Specification of CDI inputs for this channel

STRUCT(
"resolution" VARCHAR
)
Show child fields
cdi_input_specification.resolution

Maximum CDI input resolution

channel_class

The class for this channel. STANDARD for a channel with two pipelines or SINGLE_PIPELINE for a channel with one pipeline.

VARCHAR
destinations

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.

STRUCT(
"id" VARCHAR,
"media_package_settings" STRUCT(
"channel_id" VARCHAR
)[],
"multiplex_settings" STRUCT(
"multiplex_id" VARCHAR,
"program_name" VARCHAR
),
"settings" STRUCT(
"password_param" VARCHAR,
"stream_name" VARCHAR,
"url" VARCHAR,
"username" VARCHAR
)[]
)[]
Show child fields
destinations[]
Show child fields
destinations[].id

User-specified id. This is used in an output group or an output.

destinations[].media_package_settings[]
Show child fields
destinations[].media_package_settings[].channel_id

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.

destinations[].multiplex_settings

Destination settings for a Multiplex output; one destination for both encoders.

Show child fields
destinations[].multiplex_settings.multiplex_id

The ID of the Multiplex that the encoder is providing output to. You do not need to specify the individual inputs to the Multiplex; MediaLive will handle the connection of the two MediaLive pipelines to the two Multiplex instances. The Multiplex must be in the same region as the Channel.

destinations[].multiplex_settings.program_name

The program name of the Multiplex program that the encoder is providing output to.

destinations[].settings[]
Show child fields
destinations[].settings[].password_param

key used to extract the password from EC2 Parameter store

destinations[].settings[].stream_name

Stream name for RTMP destinations (URLs of type rtmp://)

destinations[].settings[].url

A URL specifying a destination

destinations[].settings[].username

username for destination

egress_endpoints

The endpoints where outgoing connections initiate from

STRUCT(
"source_ip" VARCHAR
)[]
Show child fields
egress_endpoints[]
Show child fields
egress_endpoints[].source_ip

Public IP of where a channel's output comes from

encoder_settings

Encoder Settings

STRUCT(
"audio_descriptions" STRUCT(
"audio_normalization_settings" STRUCT(
"algorithm" VARCHAR,
"algorithm_control" VARCHAR,
"target_lkfs" DOUBLE
),
"audio_selector_name" VARCHAR,
"audio_type" VARCHAR,
"audio_type_control" VARCHAR,
"audio_watermarking_settings" STRUCT(
"nielsen_watermarks_settings" STRUCT(
"nielsen_cbet_settings" STRUCT(
"cbet_check_digit_string" VARCHAR,
"cbet_stepaside" VARCHAR,
"csid" VARCHAR
),
"nielsen_distribution_type" VARCHAR,
"nielsen_naes_ii_nw_settings" STRUCT(
"check_digit_string" VARCHAR,
"sid" DOUBLE,
"timezone" VARCHAR
)
)
),
"codec_settings" STRUCT(
"aac_settings" STRUCT(
"bitrate" DOUBLE,
"coding_mode" VARCHAR,
"input_type" VARCHAR,
"profile" VARCHAR,
"rate_control_mode" VARCHAR,
"raw_format" VARCHAR,
"sample_rate" DOUBLE,
"spec" VARCHAR,
"vbr_quality" VARCHAR
),
"ac3_settings" STRUCT(
"bitrate" DOUBLE,
"bitstream_mode" VARCHAR,
"coding_mode" VARCHAR,
"dialnorm" BIGINT,
"drc_profile" VARCHAR,
"lfe_filter" VARCHAR,
"metadata_control" VARCHAR,
"attenuation_control" VARCHAR
),
"eac3_atmos_settings" STRUCT(
"bitrate" DOUBLE,
"coding_mode" VARCHAR,
"dialnorm" BIGINT,
"drc_line" VARCHAR,
"drc_rf" VARCHAR,
"height_trim" DOUBLE,
"surround_trim" DOUBLE
),
"eac3_settings" STRUCT(
"attenuation_control" VARCHAR,
"bitrate" DOUBLE,
"bitstream_mode" VARCHAR,
"coding_mode" VARCHAR,
"dc_filter" VARCHAR,
"dialnorm" BIGINT,
"drc_line" VARCHAR,
"drc_rf" VARCHAR,
"lfe_control" VARCHAR,
"lfe_filter" VARCHAR,
"lo_ro_center_mix_level" DOUBLE,
"lo_ro_surround_mix_level" DOUBLE,
"lt_rt_center_mix_level" DOUBLE,
"lt_rt_surround_mix_level" DOUBLE,
"metadata_control" VARCHAR,
"passthrough_control" VARCHAR,
"phase_control" VARCHAR,
"stereo_downmix" VARCHAR,
"surround_ex_mode" VARCHAR,
"surround_mode" VARCHAR
),
"mp2_settings" STRUCT(
"bitrate" DOUBLE,
"coding_mode" VARCHAR,
"sample_rate" DOUBLE
),
"pass_through_settings" BOOLEAN,
"wav_settings" STRUCT(
"bit_depth" DOUBLE,
"coding_mode" VARCHAR,
"sample_rate" DOUBLE
)
),
"language_code" VARCHAR,
"language_code_control" VARCHAR,
"name" VARCHAR,
"remix_settings" STRUCT(
"channel_mappings" STRUCT(
"input_channel_levels" STRUCT(
"gain" BIGINT,
"input_channel" BIGINT
)[],
"output_channel" BIGINT
)[],
"channels_in" BIGINT,
"channels_out" BIGINT
),
"stream_name" VARCHAR,
"audio_dash_roles" VARCHAR[],
"dvb_dash_accessibility" VARCHAR
)[],
"avail_blanking" STRUCT(
"avail_blanking_image" STRUCT(
"password_param" VARCHAR,
"uri" VARCHAR,
"username" VARCHAR
),
"state" VARCHAR
),
"avail_configuration" STRUCT(
"avail_settings" STRUCT(
"esam" STRUCT(
"acquisition_point_id" VARCHAR,
"ad_avail_offset" BIGINT,
"password_param" VARCHAR,
"pois_endpoint" VARCHAR,
"username" VARCHAR,
"zone_identity" VARCHAR
),
"scte35_splice_insert" STRUCT(
"ad_avail_offset" BIGINT,
"no_regional_blackout_flag" VARCHAR,
"web_delivery_allowed_flag" VARCHAR
),
"scte35_time_signal_apos" STRUCT(
"ad_avail_offset" BIGINT,
"no_regional_blackout_flag" VARCHAR,
"web_delivery_allowed_flag" VARCHAR
)
),
"scte35_segmentation_scope" VARCHAR
),
"blackout_slate" STRUCT(
"blackout_slate_image" STRUCT(
"password_param" VARCHAR,
"uri" VARCHAR,
"username" VARCHAR
),
"network_end_blackout" VARCHAR,
"network_end_blackout_image" STRUCT(
"password_param" VARCHAR,
"uri" VARCHAR,
"username" VARCHAR
),
"network_id" VARCHAR,
"state" VARCHAR
),
"caption_descriptions" STRUCT(
"accessibility" VARCHAR,
"caption_selector_name" VARCHAR,
"destination_settings" STRUCT(
"arib_destination_settings" BOOLEAN,
"burn_in_destination_settings" STRUCT(
"alignment" VARCHAR,
"background_color" VARCHAR,
"background_opacity" BIGINT,
"font" STRUCT(
"password_param" VARCHAR,
"uri" VARCHAR,
"username" VARCHAR
),
"font_color" VARCHAR,
"font_opacity" BIGINT,
"font_resolution" BIGINT,
"font_size" VARCHAR,
"outline_color" VARCHAR,
"outline_size" BIGINT,
"shadow_color" VARCHAR,
"shadow_opacity" BIGINT,
"shadow_x_offset" BIGINT,
"shadow_y_offset" BIGINT,
"teletext_grid_control" VARCHAR,
"x_position" BIGINT,
"y_position" BIGINT
),
"dvb_sub_destination_settings" STRUCT(
"alignment" VARCHAR,
"background_color" VARCHAR,
"background_opacity" BIGINT,
"font" STRUCT(
"password_param" VARCHAR,
"uri" VARCHAR,
"username" VARCHAR
),
"font_color" VARCHAR,
"font_opacity" BIGINT,
"font_resolution" BIGINT,
"font_size" VARCHAR,
"outline_color" VARCHAR,
"outline_size" BIGINT,
"shadow_color" VARCHAR,
"shadow_opacity" BIGINT,
"shadow_x_offset" BIGINT,
"shadow_y_offset" BIGINT,
"teletext_grid_control" VARCHAR,
"x_position" BIGINT,
"y_position" BIGINT
),
"ebu_tt_d_destination_settings" STRUCT(
"copyright_holder" VARCHAR,
"fill_line_gap" VARCHAR,
"font_family" VARCHAR,
"style_control" VARCHAR
),
"embedded_destination_settings" BOOLEAN,
"embedded_plus_scte20_destination_settings" BOOLEAN,
"rtmp_caption_info_destination_settings" BOOLEAN,
"scte20_plus_embedded_destination_settings" BOOLEAN,
"scte27_destination_settings" BOOLEAN,
"smpte_tt_destination_settings" BOOLEAN,
"teletext_destination_settings" BOOLEAN,
"ttml_destination_settings" STRUCT(
"style_control" VARCHAR
),
"webvtt_destination_settings" STRUCT(
"style_control" VARCHAR
)
),
"language_code" VARCHAR,
"language_description" VARCHAR,
"name" VARCHAR,
"caption_dash_roles" VARCHAR[],
"dvb_dash_accessibility" VARCHAR
)[],
"feature_activations" STRUCT(
"input_prepare_schedule_actions" VARCHAR,
"output_static_image_overlay_schedule_actions" VARCHAR
),
"global_configuration" STRUCT(
"initial_audio_gain" BIGINT,
"input_end_action" VARCHAR,
"input_loss_behavior" STRUCT(
"black_frame_msec" BIGINT,
"input_loss_image_color" VARCHAR,
"input_loss_image_slate" STRUCT(
"password_param" VARCHAR,
"uri" VARCHAR,
"username" VARCHAR
),
"input_loss_image_type" VARCHAR,
"repeat_frame_msec" BIGINT
),
"output_locking_mode" VARCHAR,
"output_timing_source" VARCHAR,
"support_low_framerate_inputs" VARCHAR,
"output_locking_settings" STRUCT(
"epoch_locking_settings" STRUCT(
"custom_epoch" VARCHAR,
"jam_sync_time" VARCHAR
),
"pipeline_locking_settings" BOOLEAN
)
),
"motion_graphics_configuration" STRUCT(
"motion_graphics_insertion" VARCHAR,
"motion_graphics_settings" STRUCT(
"html_motion_graphics_settings" BOOLEAN
)
),
"nielsen_configuration" STRUCT(
"distributor_id" VARCHAR,
"nielsen_pcm_to_id3_tagging" VARCHAR
),
"output_groups" STRUCT(
"name" VARCHAR,
"output_group_settings" STRUCT(
"archive_group_settings" STRUCT(
"archive_cdn_settings" STRUCT(
"archive_s3_settings" STRUCT(
"canned_acl" VARCHAR
)
),
"destination" STRUCT(
"destination_ref_id" VARCHAR
),
"rollover_interval" BIGINT
),
"frame_capture_group_settings" STRUCT(
"destination" STRUCT(
"destination_ref_id" VARCHAR
),
"frame_capture_cdn_settings" STRUCT(
"frame_capture_s3_settings" STRUCT(
"canned_acl" VARCHAR
)
)
),
"hls_group_settings" STRUCT(
"ad_markers" VARCHAR[],
"base_url_content" VARCHAR,
"base_url_content1" VARCHAR,
"base_url_manifest" VARCHAR,
"base_url_manifest1" VARCHAR,
"caption_language_mappings" STRUCT(
"caption_channel" BIGINT,
"language_code" VARCHAR,
"language_description" VARCHAR
)[],
"caption_language_setting" VARCHAR,
"client_cache" VARCHAR,
"codec_specification" VARCHAR,
"constant_iv" VARCHAR,
"destination" STRUCT(
"destination_ref_id" VARCHAR
),
"directory_structure" VARCHAR,
"discontinuity_tags" VARCHAR,
"encryption_type" VARCHAR,
"hls_cdn_settings" STRUCT(
"hls_akamai_settings" STRUCT(
"connection_retry_interval" BIGINT,
"filecache_duration" BIGINT,
"http_transfer_mode" VARCHAR,
"num_retries" BIGINT,
"restart_delay" BIGINT,
"salt" VARCHAR,
"token" VARCHAR
),
"hls_basic_put_settings" STRUCT(
"connection_retry_interval" BIGINT,
"filecache_duration" BIGINT,
"num_retries" BIGINT,
"restart_delay" BIGINT
),
"hls_media_store_settings" STRUCT(
"connection_retry_interval" BIGINT,
"filecache_duration" BIGINT,
"media_store_storage_class" VARCHAR,
"num_retries" BIGINT,
"restart_delay" BIGINT
),
"hls_s3_settings" STRUCT(
"canned_acl" VARCHAR
),
"hls_webdav_settings" STRUCT(
"connection_retry_interval" BIGINT,
"filecache_duration" BIGINT,
"http_transfer_mode" VARCHAR,
"num_retries" BIGINT,
"restart_delay" BIGINT
)
),
"hls_id3_segment_tagging" VARCHAR,
"i_frame_only_playlists" VARCHAR,
"incomplete_segment_behavior" VARCHAR,
"index_n_segments" BIGINT,
"input_loss_action" VARCHAR,
"iv_in_manifest" VARCHAR,
"iv_source" VARCHAR,
"keep_segments" BIGINT,
"key_format" VARCHAR,
"key_format_versions" VARCHAR,
"key_provider_settings" STRUCT(
"static_key_settings" STRUCT(
"key_provider_server" STRUCT(
"password_param" VARCHAR,
"uri" VARCHAR,
"username" VARCHAR
),
"static_key_value" VARCHAR
)
),
"manifest_compression" VARCHAR,
"manifest_duration_format" VARCHAR,
"min_segment_length" BIGINT,
"mode" VARCHAR,
"output_selection" VARCHAR,
"program_date_time" VARCHAR,
"program_date_time_clock" VARCHAR,
"program_date_time_period" BIGINT,
"redundant_manifest" VARCHAR,
"segment_length" BIGINT,
"segmentation_mode" VARCHAR,
"segments_per_subdirectory" BIGINT,
"stream_inf_resolution" VARCHAR,
"timed_metadata_id3_frame" VARCHAR,
"timed_metadata_id3_period" BIGINT,
"timestamp_delta_milliseconds" BIGINT,
"ts_file_mode" VARCHAR
),
"media_package_group_settings" STRUCT(
"destination" STRUCT(
"destination_ref_id" VARCHAR
)
),
"ms_smooth_group_settings" STRUCT(
"acquisition_point_id" VARCHAR,
"audio_only_timecode_control" VARCHAR,
"certificate_mode" VARCHAR,
"connection_retry_interval" BIGINT,
"destination" STRUCT(
"destination_ref_id" VARCHAR
),
"event_id" VARCHAR,
"event_id_mode" VARCHAR,
"event_stop_behavior" VARCHAR,
"filecache_duration" BIGINT,
"fragment_length" BIGINT,
"input_loss_action" VARCHAR,
"num_retries" BIGINT,
"restart_delay" BIGINT,
"segmentation_mode" VARCHAR,
"send_delay_ms" BIGINT,
"sparse_track_type" VARCHAR,
"stream_manifest_behavior" VARCHAR,
"timestamp_offset" VARCHAR,
"timestamp_offset_mode" VARCHAR
),
"multiplex_group_settings" BOOLEAN,
"rtmp_group_settings" STRUCT(
"ad_markers" VARCHAR[],
"authentication_scheme" VARCHAR,
"cache_full_behavior" VARCHAR,
"cache_length" BIGINT,
"caption_data" VARCHAR,
"input_loss_action" VARCHAR,
"restart_delay" BIGINT,
"include_filler_nal_units" VARCHAR
),
"udp_group_settings" STRUCT(
"input_loss_action" VARCHAR,
"timed_metadata_id3_frame" VARCHAR,
"timed_metadata_id3_period" BIGINT
),
"cmaf_ingest_group_settings" STRUCT(
"destination" STRUCT(
"destination_ref_id" VARCHAR
),
"nielsen_id3_behavior" VARCHAR,
"scte35_type" VARCHAR,
"segment_length" BIGINT,
"segment_length_units" VARCHAR,
"send_delay_ms" BIGINT
)
),
"outputs" STRUCT(
"audio_description_names" VARCHAR[],
"caption_description_names" VARCHAR[],
"output_name" VARCHAR,
"output_settings" STRUCT(
"archive_output_settings" STRUCT(
"container_settings" STRUCT(
"m2ts_settings" STRUCT(
"absent_input_audio_behavior" VARCHAR,
"arib" VARCHAR,
"arib_captions_pid" VARCHAR,
"arib_captions_pid_control" VARCHAR,
"audio_buffer_model" VARCHAR,
"audio_frames_per_pes" BIGINT,
"audio_pids" VARCHAR,
"audio_stream_type" VARCHAR,
"bitrate" BIGINT,
"buffer_model" VARCHAR,
"cc_descriptor" VARCHAR,
"dvb_nit_settings" STRUCT(
"network_id" BIGINT,
"network_name" VARCHAR,
"rep_interval" BIGINT
),
"dvb_sdt_settings" STRUCT(
"output_sdt" VARCHAR,
"rep_interval" BIGINT,
"service_name" VARCHAR,
"service_provider_name" VARCHAR
),
"dvb_sub_pids" VARCHAR,
"dvb_tdt_settings" STRUCT(
"rep_interval" BIGINT
),
"dvb_teletext_pid" VARCHAR,
"ebif" VARCHAR,
"ebp_audio_interval" VARCHAR,
"ebp_lookahead_ms" BIGINT,
"ebp_placement" VARCHAR,
"ecm_pid" VARCHAR,
"es_rate_in_pes" VARCHAR,
"etv_platform_pid" VARCHAR,
"etv_signal_pid" VARCHAR,
"fragment_time" DOUBLE,
"klv" VARCHAR,
"klv_data_pids" VARCHAR,
"nielsen_id3_behavior" VARCHAR,
"null_packet_bitrate" DOUBLE,
"pat_interval" BIGINT,
"pcr_control" VARCHAR,
"pcr_period" BIGINT,
"pcr_pid" VARCHAR,
"pmt_interval" BIGINT,
"pmt_pid" VARCHAR,
"program_num" BIGINT,
"rate_mode" VARCHAR,
"scte27_pids" VARCHAR,
"scte35_control" VARCHAR,
"scte35_pid" VARCHAR,
"segmentation_markers" VARCHAR,
"segmentation_style" VARCHAR,
"segmentation_time" DOUBLE,
"timed_metadata_behavior" VARCHAR,
"timed_metadata_pid" VARCHAR,
"transport_stream_id" BIGINT,
"video_pid" VARCHAR,
"scte35_preroll_pullup_milliseconds" DOUBLE
),
"raw_settings" BOOLEAN
),
"extension" VARCHAR,
"name_modifier" VARCHAR
),
"frame_capture_output_settings" STRUCT(
"name_modifier" VARCHAR
),
"hls_output_settings" STRUCT(
"h265_packaging_type" VARCHAR,
"hls_settings" STRUCT(
"audio_only_hls_settings" STRUCT(
"audio_group_id" VARCHAR,
"audio_only_image" STRUCT(
"password_param" VARCHAR,
"uri" VARCHAR,
"username" VARCHAR
),
"audio_track_type" VARCHAR,
"segment_type" VARCHAR
),
"fmp4_hls_settings" STRUCT(
"audio_rendition_sets" VARCHAR,
"nielsen_id3_behavior" VARCHAR,
"timed_metadata_behavior" VARCHAR
),
"frame_capture_hls_settings" BOOLEAN,
"standard_hls_settings" STRUCT(
"audio_rendition_sets" VARCHAR,
"m3u8_settings" STRUCT(
"audio_frames_per_pes" BIGINT,
"audio_pids" VARCHAR,
"ecm_pid" VARCHAR,
"nielsen_id3_behavior" VARCHAR,
"pat_interval" BIGINT,
"pcr_control" VARCHAR,
"pcr_period" BIGINT,
"pcr_pid" VARCHAR,
"pmt_interval" BIGINT,
"pmt_pid" VARCHAR,
"program_num" BIGINT,
"scte35_behavior" VARCHAR,
"scte35_pid" VARCHAR,
"timed_metadata_behavior" VARCHAR,
"timed_metadata_pid" VARCHAR,
"transport_stream_id" BIGINT,
"video_pid" VARCHAR,
"klv_behavior" VARCHAR,
"klv_data_pids" VARCHAR
)
)
),
"name_modifier" VARCHAR,
"segment_modifier" VARCHAR
),
"media_package_output_settings" BOOLEAN,
"ms_smooth_output_settings" STRUCT(
"h265_packaging_type" VARCHAR,
"name_modifier" VARCHAR
),
"multiplex_output_settings" STRUCT(
"destination" STRUCT(
"destination_ref_id" VARCHAR
)
),
"rtmp_output_settings" STRUCT(
"certificate_mode" VARCHAR,
"connection_retry_interval" BIGINT,
"destination" STRUCT(
"destination_ref_id" VARCHAR
),
"num_retries" BIGINT
),
"udp_output_settings" STRUCT(
"buffer_msec" BIGINT,
"container_settings" STRUCT(
"m2ts_settings" STRUCT(
"absent_input_audio_behavior" VARCHAR,
"arib" VARCHAR,
"arib_captions_pid" VARCHAR,
"arib_captions_pid_control" VARCHAR,
"audio_buffer_model" VARCHAR,
"audio_frames_per_pes" BIGINT,
"audio_pids" VARCHAR,
"audio_stream_type" VARCHAR,
"bitrate" BIGINT,
"buffer_model" VARCHAR,
"cc_descriptor" VARCHAR,
"dvb_nit_settings" STRUCT(
"network_id" BIGINT,
"network_name" VARCHAR,
"rep_interval" BIGINT
),
"dvb_sdt_settings" STRUCT(
"output_sdt" VARCHAR,
"rep_interval" BIGINT,
"service_name" VARCHAR,
"service_provider_name" VARCHAR
),
"dvb_sub_pids" VARCHAR,
"dvb_tdt_settings" STRUCT(
"rep_interval" BIGINT
),
"dvb_teletext_pid" VARCHAR,
"ebif" VARCHAR,
"ebp_audio_interval" VARCHAR,
"ebp_lookahead_ms" BIGINT,
"ebp_placement" VARCHAR,
"ecm_pid" VARCHAR,
"es_rate_in_pes" VARCHAR,
"etv_platform_pid" VARCHAR,
"etv_signal_pid" VARCHAR,
"fragment_time" DOUBLE,
"klv" VARCHAR,
"klv_data_pids" VARCHAR,
"nielsen_id3_behavior" VARCHAR,
"null_packet_bitrate" DOUBLE,
"pat_interval" BIGINT,
"pcr_control" VARCHAR,
"pcr_period" BIGINT,
"pcr_pid" VARCHAR,
"pmt_interval" BIGINT,
"pmt_pid" VARCHAR,
"program_num" BIGINT,
"rate_mode" VARCHAR,
"scte27_pids" VARCHAR,
"scte35_control" VARCHAR,
"scte35_pid" VARCHAR,
"segmentation_markers" VARCHAR,
"segmentation_style" VARCHAR,
"segmentation_time" DOUBLE,
"timed_metadata_behavior" VARCHAR,
"timed_metadata_pid" VARCHAR,
"transport_stream_id" BIGINT,
"video_pid" VARCHAR,
"scte35_preroll_pullup_milliseconds" DOUBLE
)
),
"destination" STRUCT(
"destination_ref_id" VARCHAR
),
"fec_output_settings" STRUCT(
"column_depth" BIGINT,
"include_fec" VARCHAR,
"row_length" BIGINT
)
),
"cmaf_ingest_output_settings" STRUCT(
"name_modifier" VARCHAR
)
),
"video_description_name" VARCHAR
)[]
)[],
"timecode_config" STRUCT(
"source" VARCHAR,
"sync_threshold" BIGINT
),
"video_descriptions" STRUCT(
"codec_settings" STRUCT(
"frame_capture_settings" STRUCT(
"capture_interval" BIGINT,
"capture_interval_units" VARCHAR,
"timecode_burnin_settings" STRUCT(
"font_size" VARCHAR,
"position" VARCHAR,
"prefix" VARCHAR
)
),
"h264_settings" STRUCT(
"adaptive_quantization" VARCHAR,
"afd_signaling" VARCHAR,
"bitrate" BIGINT,
"buf_fill_pct" BIGINT,
"buf_size" BIGINT,
"color_metadata" VARCHAR,
"color_space_settings" STRUCT(
"color_space_passthrough_settings" BOOLEAN,
"rec601_settings" BOOLEAN,
"rec709_settings" BOOLEAN
),
"entropy_encoding" VARCHAR,
"filter_settings" STRUCT(
"temporal_filter_settings" STRUCT(
"post_filter_sharpening" VARCHAR,
"strength" VARCHAR
)
),
"fixed_afd" VARCHAR,
"flicker_aq" VARCHAR,
"force_field_pictures" VARCHAR,
"framerate_control" VARCHAR,
"framerate_denominator" BIGINT,
"framerate_numerator" BIGINT,
"gop_b_reference" VARCHAR,
"gop_closed_cadence" BIGINT,
"gop_num_b_frames" BIGINT,
"gop_size" DOUBLE,
"gop_size_units" VARCHAR,
"level" VARCHAR,
"look_ahead_rate_control" VARCHAR,
"max_bitrate" BIGINT,
"min_i_interval" BIGINT,
"num_ref_frames" BIGINT,
"par_control" VARCHAR,
"par_denominator" BIGINT,
"par_numerator" BIGINT,
"profile" VARCHAR,
"quality_level" VARCHAR,
"qvbr_quality_level" BIGINT,
"rate_control_mode" VARCHAR,
"scan_type" VARCHAR,
"scene_change_detect" VARCHAR,
"slices" BIGINT,
"softness" BIGINT,
"spatial_aq" VARCHAR,
"subgop_length" VARCHAR,
"syntax" VARCHAR,
"temporal_aq" VARCHAR,
"timecode_insertion" VARCHAR,
"timecode_burnin_settings" STRUCT(
"font_size" VARCHAR,
"position" VARCHAR,
"prefix" VARCHAR
)
),
"h265_settings" STRUCT(
"adaptive_quantization" VARCHAR,
"afd_signaling" VARCHAR,
"alternative_transfer_function" VARCHAR,
"bitrate" BIGINT,
"buf_size" BIGINT,
"color_metadata" VARCHAR,
"color_space_settings" STRUCT(
"color_space_passthrough_settings" BOOLEAN,
"dolby_vision81_settings" BOOLEAN,
"hdr10_settings" STRUCT(
"max_cll" BIGINT,
"max_fall" BIGINT
),
"rec601_settings" BOOLEAN,
"rec709_settings" BOOLEAN
),
"filter_settings" STRUCT(
"temporal_filter_settings" STRUCT(
"post_filter_sharpening" VARCHAR,
"strength" VARCHAR
)
),
"fixed_afd" VARCHAR,
"flicker_aq" VARCHAR,
"framerate_denominator" BIGINT,
"framerate_numerator" BIGINT,
"gop_closed_cadence" BIGINT,
"gop_size" DOUBLE,
"gop_size_units" VARCHAR,
"level" VARCHAR,
"look_ahead_rate_control" VARCHAR,
"max_bitrate" BIGINT,
"min_i_interval" BIGINT,
"par_denominator" BIGINT,
"par_numerator" BIGINT,
"profile" VARCHAR,
"qvbr_quality_level" BIGINT,
"rate_control_mode" VARCHAR,
"scan_type" VARCHAR,
"scene_change_detect" VARCHAR,
"slices" BIGINT,
"tier" VARCHAR,
"timecode_insertion" VARCHAR,
"timecode_burnin_settings" STRUCT(
"font_size" VARCHAR,
"position" VARCHAR,
"prefix" VARCHAR
),
"mv_over_picture_boundaries" VARCHAR,
"mv_temporal_predictor" VARCHAR,
"tile_height" BIGINT,
"tile_padding" VARCHAR,
"tile_width" BIGINT,
"treeblock_size" VARCHAR
),
"mpeg2_settings" STRUCT(
"adaptive_quantization" VARCHAR,
"afd_signaling" VARCHAR,
"color_metadata" VARCHAR,
"color_space" VARCHAR,
"display_aspect_ratio" VARCHAR,
"filter_settings" STRUCT(
"temporal_filter_settings" STRUCT(
"post_filter_sharpening" VARCHAR,
"strength" VARCHAR
)
),
"fixed_afd" VARCHAR,
"framerate_denominator" BIGINT,
"framerate_numerator" BIGINT,
"gop_closed_cadence" BIGINT,
"gop_num_b_frames" BIGINT,
"gop_size" DOUBLE,
"gop_size_units" VARCHAR,
"scan_type" VARCHAR,
"subgop_length" VARCHAR,
"timecode_insertion" VARCHAR,
"timecode_burnin_settings" STRUCT(
"font_size" VARCHAR,
"position" VARCHAR,
"prefix" VARCHAR
)
)
),
"height" BIGINT,
"name" VARCHAR,
"respond_to_afd" VARCHAR,
"scaling_behavior" VARCHAR,
"sharpness" BIGINT,
"width" BIGINT
)[],
"thumbnail_configuration" STRUCT(
"state" VARCHAR
),
"color_correction_settings" STRUCT(
"global_color_corrections" STRUCT(
"input_color_space" VARCHAR,
"output_color_space" VARCHAR,
"uri" VARCHAR
)[]
)
)
Show child fields
encoder_settings.audio_descriptions[]
Show child fields
encoder_settings.audio_descriptions[].audio_dash_roles[]
encoder_settings.audio_descriptions[].audio_normalization_settings

Advanced audio normalization settings.

Show child fields
encoder_settings.audio_descriptions[].audio_normalization_settings.algorithm

Audio normalization algorithm to use. itu17701 conforms to the CALM Act specification, itu17702 conforms to the EBU R-128 specification.

encoder_settings.audio_descriptions[].audio_normalization_settings.algorithm_control

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.

encoder_settings.audio_descriptions[].audio_normalization_settings.target_lkfs

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.

encoder_settings.audio_descriptions[].audio_selector_name

The name of the AudioSelector used as the source for this AudioDescription.

encoder_settings.audio_descriptions[].audio_type

Applies only if audioTypeControl is useConfigured. The values for audioType are defined in ISO-IEC 13818-1.

encoder_settings.audio_descriptions[].audio_type_control

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.

encoder_settings.audio_descriptions[].audio_watermarking_settings

Settings to configure one or more solutions that insert audio watermarks in the audio encode

Show child fields
encoder_settings.audio_descriptions[].audio_watermarking_settings.nielsen_watermarks_settings

Settings to configure Nielsen Watermarks in the audio encode

Show child fields
encoder_settings.audio_descriptions[].audio_watermarking_settings.nielsen_watermarks_settings.nielsen_cbet_settings

Complete these fields only if you want to insert watermarks of type Nielsen CBET

Show child fields
encoder_settings.audio_descriptions[].audio_watermarking_settings.nielsen_watermarks_settings.nielsen_cbet_settings.cbet_check_digit_string

Enter the CBET check digits to use in the watermark.

encoder_settings.audio_descriptions[].audio_watermarking_settings.nielsen_watermarks_settings.nielsen_cbet_settings.cbet_stepaside

Determines the method of CBET insertion mode when prior encoding is detected on the same layer.

encoder_settings.audio_descriptions[].audio_watermarking_settings.nielsen_watermarks_settings.nielsen_cbet_settings.csid

Enter the CBET Source ID (CSID) to use in the watermark

encoder_settings.audio_descriptions[].audio_watermarking_settings.nielsen_watermarks_settings.nielsen_distribution_type

Choose the distribution types that you want to assign to the watermarks: - PROGRAM_CONTENT - FINAL_DISTRIBUTOR

encoder_settings.audio_descriptions[].audio_watermarking_settings.nielsen_watermarks_settings.nielsen_naes_ii_nw_settings

Complete these fields only if you want to insert watermarks of type Nielsen NAES II (N2) and Nielsen NAES VI (NW).

Show child fields
encoder_settings.audio_descriptions[].audio_watermarking_settings.nielsen_watermarks_settings.nielsen_naes_ii_nw_settings.check_digit_string

Enter the check digit string for the watermark

encoder_settings.audio_descriptions[].audio_watermarking_settings.nielsen_watermarks_settings.nielsen_naes_ii_nw_settings.sid

Enter the Nielsen Source ID (SID) to include in the watermark

encoder_settings.audio_descriptions[].audio_watermarking_settings.nielsen_watermarks_settings.nielsen_naes_ii_nw_settings.timezone

Choose the timezone for the time stamps in the watermark. If not provided, the timestamps will be in Coordinated Universal Time (UTC)

encoder_settings.audio_descriptions[].codec_settings

Audio codec settings.

Show child fields
encoder_settings.audio_descriptions[].codec_settings.aac_settings

Aac Settings

Show child fields
encoder_settings.audio_descriptions[].codec_settings.aac_settings.bitrate

Average bitrate in bits/second. Valid values depend on rate control mode and profile.

encoder_settings.audio_descriptions[].codec_settings.aac_settings.coding_mode

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.

encoder_settings.audio_descriptions[].codec_settings.aac_settings.input_type

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.

encoder_settings.audio_descriptions[].codec_settings.aac_settings.profile

AAC Profile.

encoder_settings.audio_descriptions[].codec_settings.aac_settings.rate_control_mode

Rate Control Mode.

encoder_settings.audio_descriptions[].codec_settings.aac_settings.raw_format

Sets LATM/LOAS AAC output for raw containers.

encoder_settings.audio_descriptions[].codec_settings.aac_settings.sample_rate

Sample rate in Hz. Valid values depend on rate control mode and profile.

encoder_settings.audio_descriptions[].codec_settings.aac_settings.spec

Use MPEG-2 AAC audio instead of MPEG-4 AAC audio for raw or MPEG-2 Transport Stream containers.

encoder_settings.audio_descriptions[].codec_settings.aac_settings.vbr_quality

VBR Quality Level - Only used if rateControlMode is VBR.

encoder_settings.audio_descriptions[].codec_settings.ac3_settings

Ac3 Settings

Show child fields
encoder_settings.audio_descriptions[].codec_settings.ac3_settings.attenuation_control

Applies a 3 dB attenuation to the surround channels. Applies only when the coding mode parameter is CODING_MODE_3_2_LFE.

encoder_settings.audio_descriptions[].codec_settings.ac3_settings.bitrate

Average bitrate in bits/second. Valid bitrates depend on the coding mode.

encoder_settings.audio_descriptions[].codec_settings.ac3_settings.bitstream_mode

Specifies the bitstream mode (bsmod) for the emitted AC-3 stream. See ATSC A/52-2012 for background on these values.

encoder_settings.audio_descriptions[].codec_settings.ac3_settings.coding_mode

Dolby Digital coding mode. Determines number of channels.

encoder_settings.audio_descriptions[].codec_settings.ac3_settings.dialnorm

Sets the dialnorm for the output. If excluded and input audio is Dolby Digital, dialnorm will be passed through.

encoder_settings.audio_descriptions[].codec_settings.ac3_settings.drc_profile

If set to filmStandard, adds dynamic range compression signaling to the output bitstream as defined in the Dolby Digital specification.

encoder_settings.audio_descriptions[].codec_settings.ac3_settings.lfe_filter

When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid in codingMode32Lfe mode.

encoder_settings.audio_descriptions[].codec_settings.ac3_settings.metadata_control

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.

encoder_settings.audio_descriptions[].codec_settings.eac3_atmos_settings

Eac3 Atmos Settings

Show child fields
encoder_settings.audio_descriptions[].codec_settings.eac3_atmos_settings.bitrate

Average bitrate in bits/second. Valid bitrates depend on the coding mode.

encoder_settings.audio_descriptions[].codec_settings.eac3_atmos_settings.coding_mode

Dolby Digital Plus with Dolby Atmos coding mode. Determines number of channels.

encoder_settings.audio_descriptions[].codec_settings.eac3_atmos_settings.dialnorm

Sets the dialnorm for the output. Default 23.

encoder_settings.audio_descriptions[].codec_settings.eac3_atmos_settings.drc_line

Sets the Dolby dynamic range compression profile.

encoder_settings.audio_descriptions[].codec_settings.eac3_atmos_settings.drc_rf

Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.

encoder_settings.audio_descriptions[].codec_settings.eac3_atmos_settings.height_trim

Height dimensional trim. Sets the maximum amount to attenuate the height channels when the downstream player isn??t configured to handle Dolby Digital Plus with Dolby Atmos and must remix the channels.

encoder_settings.audio_descriptions[].codec_settings.eac3_atmos_settings.surround_trim

Surround dimensional trim. Sets the maximum amount to attenuate the surround channels when the downstream player isn't configured to handle Dolby Digital Plus with Dolby Atmos and must remix the channels.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings

Eac3 Settings

Show child fields
encoder_settings.audio_descriptions[].codec_settings.eac3_settings.attenuation_control

When set to attenuate3Db, applies a 3 dB attenuation to the surround channels. Only used for 3/2 coding mode.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.bitrate

Average bitrate in bits/second. Valid bitrates depend on the coding mode.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.bitstream_mode

Specifies the bitstream mode (bsmod) for the emitted E-AC-3 stream. See ATSC A/52-2012 (Annex E) for background on these values.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.coding_mode

Dolby Digital Plus coding mode. Determines number of channels.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.dc_filter

When set to enabled, activates a DC highpass filter for all input channels.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.dialnorm

Sets the dialnorm for the output. If blank and input audio is Dolby Digital Plus, dialnorm will be passed through.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.drc_line

Sets the Dolby dynamic range compression profile.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.drc_rf

Sets the profile for heavy Dolby dynamic range compression, ensures that the instantaneous signal peaks do not exceed specified levels.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.lfe_control

When encoding 3/2 audio, setting to lfe enables the LFE channel

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.lfe_filter

When set to enabled, applies a 120Hz lowpass filter to the LFE channel prior to encoding. Only valid with codingMode32 coding mode.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.lo_ro_center_mix_level

Left only/Right only center mix level. Only used for 3/2 coding mode.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.lo_ro_surround_mix_level

Left only/Right only surround mix level. Only used for 3/2 coding mode.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.lt_rt_center_mix_level

Left total/Right total center mix level. Only used for 3/2 coding mode.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.lt_rt_surround_mix_level

Left total/Right total surround mix level. Only used for 3/2 coding mode.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.metadata_control

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.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.passthrough_control

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.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.phase_control

When set to shift90Degrees, applies a 90-degree phase shift to the surround channels. Only used for 3/2 coding mode.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.stereo_downmix

Stereo downmix preference. Only used for 3/2 coding mode.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.surround_ex_mode

When encoding 3/2 audio, sets whether an extra center back surround channel is matrix encoded into the left and right surround channels.

encoder_settings.audio_descriptions[].codec_settings.eac3_settings.surround_mode

When encoding 2/0 audio, sets whether Dolby Surround is matrix encoded into the two channels.

encoder_settings.audio_descriptions[].codec_settings.mp2_settings

Mp2 Settings

Show child fields
encoder_settings.audio_descriptions[].codec_settings.mp2_settings.bitrate

Average bitrate in bits/second.

encoder_settings.audio_descriptions[].codec_settings.mp2_settings.coding_mode

The MPEG2 Audio coding mode. Valid values are codingMode10 (for mono) or codingMode20 (for stereo).

encoder_settings.audio_descriptions[].codec_settings.mp2_settings.sample_rate

Sample rate in Hz.

encoder_settings.audio_descriptions[].codec_settings.pass_through_settings

Pass Through Settings

encoder_settings.audio_descriptions[].codec_settings.wav_settings

Wav Settings

Show child fields
encoder_settings.audio_descriptions[].codec_settings.wav_settings.bit_depth

Bits per sample.

encoder_settings.audio_descriptions[].codec_settings.wav_settings.coding_mode

The audio coding mode for the WAV audio. The mode determines the number of channels in the audio.

encoder_settings.audio_descriptions[].codec_settings.wav_settings.sample_rate

Sample rate in Hz.

encoder_settings.audio_descriptions[].dvb_dash_accessibility

Identifies DVB DASH accessibility signaling in this audio output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.

encoder_settings.audio_descriptions[].language_code

RFC 5646 language code representing 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.

encoder_settings.audio_descriptions[].language_code_control

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.

encoder_settings.audio_descriptions[].name

The name of this AudioDescription. Outputs will use this name to uniquely identify this AudioDescription. Description names should be unique within this Live Event.

encoder_settings.audio_descriptions[].remix_settings

Settings that control how input audio channels are remixed into the output audio channels.

Show child fields
encoder_settings.audio_descriptions[].remix_settings.channel_mappings[]
Show child fields
encoder_settings.audio_descriptions[].remix_settings.channel_mappings[].input_channel_levels[]
Show child fields
encoder_settings.audio_descriptions[].remix_settings.channel_mappings[].input_channel_levels[].gain

Remixing value. Units are in dB and acceptable values are within the range from -60 (mute) and 6 dB.

encoder_settings.audio_descriptions[].remix_settings.channel_mappings[].input_channel_levels[].input_channel

The index of the input channel used as a source.

encoder_settings.audio_descriptions[].remix_settings.channel_mappings[].output_channel

The index of the output channel being produced.

encoder_settings.audio_descriptions[].remix_settings.channels_in

Number of input channels to be used.

encoder_settings.audio_descriptions[].remix_settings.channels_out

Number of output channels to be produced. Valid values: 1, 2, 4, 6, 8

encoder_settings.audio_descriptions[].stream_name

Used for MS Smooth and Apple HLS outputs. Indicates the name displayed by the player (eg. English, or Director Commentary).

encoder_settings.avail_blanking

Settings for ad avail blanking.

Show child fields
encoder_settings.avail_blanking.avail_blanking_image

Blanking image to be used. Leave empty for solid black. Only bmp and png images are supported.

Show child fields
encoder_settings.avail_blanking.avail_blanking_image.password_param

key used to extract the password from EC2 Parameter store

encoder_settings.avail_blanking.avail_blanking_image.uri

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

encoder_settings.avail_blanking.avail_blanking_image.username

Documentation update needed

encoder_settings.avail_blanking.state

When set to enabled, causes video, audio and captions to be blanked when insertion metadata is added.

encoder_settings.avail_configuration

Event-wide configuration settings for ad avail insertion.

Show child fields
encoder_settings.avail_configuration.avail_settings

Controls how SCTE-35 messages create cues. Splice Insert mode treats all segmentation signals traditionally. With Time Signal APOS mode only Time Signal Placement Opportunity and Break messages create segment breaks. With ESAM mode, signals are forwarded to an ESAM server for possible update.

Show child fields
encoder_settings.avail_configuration.avail_settings.esam

Esam

Show child fields
encoder_settings.avail_configuration.avail_settings.esam.acquisition_point_id

Sent as acquisitionPointIdentity to identify the MediaLive channel to the POIS.

encoder_settings.avail_configuration.avail_settings.esam.ad_avail_offset

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.

encoder_settings.avail_configuration.avail_settings.esam.password_param

Documentation update needed

encoder_settings.avail_configuration.avail_settings.esam.pois_endpoint

The URL of the signal conditioner endpoint on the Placement Opportunity Information System (POIS). MediaLive sends SignalProcessingEvents here when SCTE-35 messages are read.

encoder_settings.avail_configuration.avail_settings.esam.username

Documentation update needed

encoder_settings.avail_configuration.avail_settings.esam.zone_identity

Optional data sent as zoneIdentity to identify the MediaLive channel to the POIS.

encoder_settings.avail_configuration.avail_settings.scte35_splice_insert

Typical configuration that applies breaks on splice inserts in addition to time signal placement opportunities, breaks, and advertisements.

Show child fields
encoder_settings.avail_configuration.avail_settings.scte35_splice_insert.ad_avail_offset

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.

encoder_settings.avail_configuration.avail_settings.scte35_splice_insert.no_regional_blackout_flag

When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates

encoder_settings.avail_configuration.avail_settings.scte35_splice_insert.web_delivery_allowed_flag

When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates

encoder_settings.avail_configuration.avail_settings.scte35_time_signal_apos

Atypical configuration that applies segment breaks only on SCTE-35 time signal placement opportunities and breaks.

Show child fields
encoder_settings.avail_configuration.avail_settings.scte35_time_signal_apos.ad_avail_offset

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.

encoder_settings.avail_configuration.avail_settings.scte35_time_signal_apos.no_regional_blackout_flag

When set to ignore, Segment Descriptors with noRegionalBlackoutFlag set to 0 will no longer trigger blackouts or Ad Avail slates

encoder_settings.avail_configuration.avail_settings.scte35_time_signal_apos.web_delivery_allowed_flag

When set to ignore, Segment Descriptors with webDeliveryAllowedFlag set to 0 will no longer trigger blackouts or Ad Avail slates

encoder_settings.avail_configuration.scte35_segmentation_scope

Configures whether SCTE 35 passthrough triggers segment breaks in all output groups that use segmented outputs. Insertion of a SCTE 35 message typically results in a segment break, in addition to the regular cadence of breaks. The segment breaks appear in video outputs, audio outputs, and captions outputs (if any). ALL_OUTPUT_GROUPS: Default. Insert the segment break in in all output groups that have segmented outputs. This is the legacy behavior. SCTE35_ENABLED_OUTPUT_GROUPS: Insert the segment break only in output groups that have SCTE 35 passthrough enabled. This is the recommended value, because it reduces unnecessary segment breaks.

encoder_settings.blackout_slate

Settings for blackout slate.

Show child fields
encoder_settings.blackout_slate.blackout_slate_image

Blackout slate image to be used. Leave empty for solid black. Only bmp and png images are supported.

Show child fields
encoder_settings.blackout_slate.blackout_slate_image.password_param

key used to extract the password from EC2 Parameter store

encoder_settings.blackout_slate.blackout_slate_image.uri

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

encoder_settings.blackout_slate.blackout_slate_image.username

Documentation update needed

encoder_settings.blackout_slate.network_end_blackout

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

encoder_settings.blackout_slate.network_end_blackout_image

Path to local file to use as Network End Blackout image. Image will be scaled to fill the entire output raster.

Show child fields
encoder_settings.blackout_slate.network_end_blackout_image.password_param

key used to extract the password from EC2 Parameter store

encoder_settings.blackout_slate.network_end_blackout_image.uri

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

encoder_settings.blackout_slate.network_end_blackout_image.username

Documentation update needed

encoder_settings.blackout_slate.network_id

Provides Network ID that matches EIDR ID format (e.g., "10.XXXX/XXXX-XXXX-XXXX-XXXX-XXXX-C").

encoder_settings.blackout_slate.state

When set to enabled, causes video, audio and captions to be blanked when indicated by program metadata.

encoder_settings.caption_descriptions[]
Show child fields
encoder_settings.caption_descriptions[].accessibility

Indicates whether the caption track implements accessibility features such as written descriptions of spoken dialog, music, and sounds. This signaling is added to HLS output group and MediaPackage output group.

encoder_settings.caption_descriptions[].caption_dash_roles[]
encoder_settings.caption_descriptions[].caption_selector_name

Specifies which input caption selector to use as a caption source when generating output captions. This field should match a captionSelector name.

encoder_settings.caption_descriptions[].destination_settings

Additional settings for captions destination that depend on the destination type.

Show child fields
encoder_settings.caption_descriptions[].destination_settings.arib_destination_settings

Arib Destination Settings

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings

Burn In Destination Settings

Show child fields
encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.alignment

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.

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.background_color

Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.background_opacity

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.

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.font

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.

Show child fields
encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.font.password_param

key used to extract the password from EC2 Parameter store

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.font.uri

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

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.font.username

Documentation update needed

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.font_color

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.

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.font_opacity

Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.font_resolution

Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.font_size

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.

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.outline_color

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.

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.outline_size

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.

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.shadow_color

Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.shadow_opacity

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.

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.shadow_x_offset

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.

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.shadow_y_offset

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.

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.teletext_grid_control

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.

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.x_position

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.

encoder_settings.caption_descriptions[].destination_settings.burn_in_destination_settings.y_position

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.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings

Dvb Sub Destination Settings

Show child fields
encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.alignment

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.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.background_color

Specifies the color of the rectangle behind the captions. All burn-in and DVB-Sub font settings must match.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.background_opacity

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.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.font

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.

Show child fields
encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.font.password_param

key used to extract the password from EC2 Parameter store

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.font.uri

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

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.font.username

Documentation update needed

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.font_color

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.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.font_opacity

Specifies the opacity of the burned-in captions. 255 is opaque; 0 is transparent. All burn-in and DVB-Sub font settings must match.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.font_resolution

Font resolution in DPI (dots per inch); default is 96 dpi. All burn-in and DVB-Sub font settings must match.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.font_size

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.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.outline_color

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.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.outline_size

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.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.shadow_color

Specifies the color of the shadow cast by the captions. All burn-in and DVB-Sub font settings must match.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.shadow_opacity

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.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.shadow_x_offset

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.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.shadow_y_offset

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.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.teletext_grid_control

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.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.x_position

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.

encoder_settings.caption_descriptions[].destination_settings.dvb_sub_destination_settings.y_position

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.

encoder_settings.caption_descriptions[].destination_settings.ebu_tt_d_destination_settings

Ebu Tt DDestination Settings

Show child fields
encoder_settings.caption_descriptions[].destination_settings.ebu_tt_d_destination_settings.copyright_holder

Complete this field if you want to include the name of the copyright holder in the copyright tag in the captions metadata.

encoder_settings.caption_descriptions[].destination_settings.ebu_tt_d_destination_settings.fill_line_gap

Specifies how to handle the gap between the lines (in multi-line captions). - enabled: Fill with the captions background color (as specified in the input captions). - disabled: Leave the gap unfilled.

encoder_settings.caption_descriptions[].destination_settings.ebu_tt_d_destination_settings.font_family

Specifies the font family to include in the font data attached to the EBU-TT captions. Valid only if styleControl is set to include. If you leave this field empty, the font family is set to "monospaced". (If styleControl is set to exclude, the font family is always set to "monospaced".) You specify only the font family. All other style information (color, bold, position and so on) is copied from the input captions. The size is always set to 100% to allow the downstream player to choose the size. - Enter a list of font families, as a comma-separated list of font names, in order of preference. The name can be a font family (such as “Arial”), or a generic font family (such as “serif”), or “default” (to let the downstream player choose the font). - Leave blank to set the family to “monospace”.

encoder_settings.caption_descriptions[].destination_settings.ebu_tt_d_destination_settings.style_control

Specifies the style information (font color, font position, and so on) to include in the font data that is attached to the EBU-TT captions. - include: Take the style information (font color, font position, and so on) from the source captions and include that information in the font data attached to the EBU-TT captions. This option is valid only if the source captions are Embedded or Teletext. - exclude: In the font data attached to the EBU-TT captions, set the font family to "monospaced". Do not include any other style information.

encoder_settings.caption_descriptions[].destination_settings.embedded_destination_settings

Embedded Destination Settings

encoder_settings.caption_descriptions[].destination_settings.embedded_plus_scte20_destination_settings

Embedded Plus Scte20 Destination Settings

encoder_settings.caption_descriptions[].destination_settings.rtmp_caption_info_destination_settings

Rtmp Caption Info Destination Settings

encoder_settings.caption_descriptions[].destination_settings.scte20_plus_embedded_destination_settings

Scte20 Plus Embedded Destination Settings

encoder_settings.caption_descriptions[].destination_settings.scte27_destination_settings

Scte27 Destination Settings

encoder_settings.caption_descriptions[].destination_settings.smpte_tt_destination_settings

Smpte Tt Destination Settings

encoder_settings.caption_descriptions[].destination_settings.teletext_destination_settings

Teletext Destination Settings

encoder_settings.caption_descriptions[].destination_settings.ttml_destination_settings

Ttml Destination Settings

Show child fields
encoder_settings.caption_descriptions[].destination_settings.ttml_destination_settings.style_control

This field is not currently supported and will not affect the output styling. Leave the default value.

encoder_settings.caption_descriptions[].destination_settings.webvtt_destination_settings

Webvtt Destination Settings

Show child fields
encoder_settings.caption_descriptions[].destination_settings.webvtt_destination_settings.style_control

Controls whether the color and position of the source captions is passed through to the WebVTT output captions. PASSTHROUGH - Valid only if the source captions are EMBEDDED or TELETEXT. NO_STYLE_DATA - Don't pass through the style. The output captions will not contain any font styling information.

encoder_settings.caption_descriptions[].dvb_dash_accessibility

Identifies DVB DASH accessibility signaling in this captions output. Used in Microsoft Smooth Streaming outputs to signal accessibility information to packagers.

encoder_settings.caption_descriptions[].language_code

ISO 639-2 three-digit code: http://www.loc.gov/standards/iso639-2/

encoder_settings.caption_descriptions[].language_description

Human readable information to indicate captions available for players (eg. English, or Spanish).

encoder_settings.caption_descriptions[].name

Name of the caption description. Used to associate a caption description with an output. Names must be unique within an event.

encoder_settings.color_correction_settings

Color Correction Settings

Show child fields
encoder_settings.color_correction_settings.global_color_corrections[]
Show child fields
encoder_settings.color_correction_settings.global_color_corrections[].input_color_space

The color space of the input.

encoder_settings.color_correction_settings.global_color_corrections[].output_color_space

The color space of the output.

encoder_settings.color_correction_settings.global_color_corrections[].uri

The URI of the 3D LUT file. The protocol must be 's3:' or 's3ssl:':.

encoder_settings.feature_activations

Feature Activations

Show child fields
encoder_settings.feature_activations.input_prepare_schedule_actions

Enables the Input Prepare feature. You can create Input Prepare actions in the schedule only if this feature is enabled. If you disable the feature on an existing schedule, make sure that you first delete all input prepare actions from the schedule.

encoder_settings.feature_activations.output_static_image_overlay_schedule_actions

Enables the output static image overlay feature. Enabling this feature allows you to send channel schedule updates to display/clear/modify image overlays on an output-by-output bases.

encoder_settings.global_configuration

Configuration settings that apply to the event as a whole.

Show child fields
encoder_settings.global_configuration.initial_audio_gain

Value to set the initial audio gain for the Live Event.

encoder_settings.global_configuration.input_end_action

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

encoder_settings.global_configuration.input_loss_behavior

Settings for system actions when input is lost.

Show child fields
encoder_settings.global_configuration.input_loss_behavior.black_frame_msec

Documentation update needed

encoder_settings.global_configuration.input_loss_behavior.input_loss_image_color

When input loss image type is "color" this field specifies the color to use. Value: 6 hex characters representing the values of RGB.

encoder_settings.global_configuration.input_loss_behavior.input_loss_image_slate

When input loss image type is "slate" these fields specify the parameters for accessing the slate.

Show child fields
encoder_settings.global_configuration.input_loss_behavior.input_loss_image_slate.password_param

key used to extract the password from EC2 Parameter store

encoder_settings.global_configuration.input_loss_behavior.input_loss_image_slate.uri

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

encoder_settings.global_configuration.input_loss_behavior.input_loss_image_slate.username

Documentation update needed

encoder_settings.global_configuration.input_loss_behavior.input_loss_image_type

Indicates whether to substitute a solid color or a slate into the output after input loss exceeds blackFrameMsec.

encoder_settings.global_configuration.input_loss_behavior.repeat_frame_msec

Documentation update needed

encoder_settings.global_configuration.output_locking_mode

Indicates how MediaLive pipelines are synchronized. PIPELINE_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the other. EPOCH_LOCKING - MediaLive will attempt to synchronize the output of each pipeline to the Unix epoch.

encoder_settings.global_configuration.output_locking_settings

Advanced output locking settings

Show child fields
encoder_settings.global_configuration.output_locking_settings.epoch_locking_settings

Epoch Locking Settings

Show child fields
encoder_settings.global_configuration.output_locking_settings.epoch_locking_settings.custom_epoch

Optional. Enter a value here to use a custom epoch, instead of the standard epoch (which started at 1970-01-01T00:00:00 UTC). Specify the start time of the custom epoch, in YYYY-MM-DDTHH:MM:SS in UTC. The time must be 2000-01-01T00:00:00 or later. Always set the MM:SS portion to 00:00.

encoder_settings.global_configuration.output_locking_settings.epoch_locking_settings.jam_sync_time

Optional. Enter a time for the jam sync. The default is midnight UTC. When epoch locking is enabled, MediaLive performs a daily jam sync on every output encode to ensure timecodes don’t diverge from the wall clock. The jam sync applies only to encodes with frame rate of 29.97 or 59.94 FPS. To override, enter a time in HH:MM:SS in UTC. Always set the MM:SS portion to 00:00.

encoder_settings.global_configuration.output_locking_settings.pipeline_locking_settings

Pipeline Locking Settings

encoder_settings.global_configuration.output_timing_source

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.

encoder_settings.global_configuration.support_low_framerate_inputs

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.

encoder_settings.motion_graphics_configuration

Settings for motion graphics.

Show child fields
encoder_settings.motion_graphics_configuration.motion_graphics_insertion

Motion Graphics Insertion

encoder_settings.motion_graphics_configuration.motion_graphics_settings

Motion Graphics Settings

Show child fields
encoder_settings.motion_graphics_configuration.motion_graphics_settings.html_motion_graphics_settings

Html Motion Graphics Settings

encoder_settings.nielsen_configuration

Nielsen configuration settings.

Show child fields
encoder_settings.nielsen_configuration.distributor_id

Enter the Distributor ID assigned to your organization by Nielsen.

encoder_settings.nielsen_configuration.nielsen_pcm_to_id3_tagging

Enables Nielsen PCM to ID3 tagging

encoder_settings.output_groups[]
Show child fields
encoder_settings.output_groups[].name

Custom output group name optionally defined by the user.

encoder_settings.output_groups[].output_group_settings

Settings associated with the output group.

Show child fields
encoder_settings.output_groups[].output_group_settings.archive_group_settings

Archive Group Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.archive_group_settings.archive_cdn_settings

Parameters that control interactions with the CDN.

Show child fields
encoder_settings.output_groups[].output_group_settings.archive_group_settings.archive_cdn_settings.archive_s3_settings

Archive S3 Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.archive_group_settings.archive_cdn_settings.archive_s3_settings.canned_acl

Specify the canned ACL to apply to each S3 request. Defaults to none.

encoder_settings.output_groups[].output_group_settings.archive_group_settings.destination

A directory and base filename where archive files should be written.

Show child fields
encoder_settings.output_groups[].output_group_settings.archive_group_settings.destination.destination_ref_id

Placeholder documentation for __string

encoder_settings.output_groups[].output_group_settings.archive_group_settings.rollover_interval

Number of seconds to write to archive file before closing and starting a new one.

encoder_settings.output_groups[].output_group_settings.cmaf_ingest_group_settings

Cmaf Ingest Group Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.cmaf_ingest_group_settings.destination

A HTTP destination for the tracks

Show child fields
encoder_settings.output_groups[].output_group_settings.cmaf_ingest_group_settings.destination.destination_ref_id

Placeholder documentation for __string

encoder_settings.output_groups[].output_group_settings.cmaf_ingest_group_settings.nielsen_id3_behavior

If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.

encoder_settings.output_groups[].output_group_settings.cmaf_ingest_group_settings.scte35_type

Type of scte35 track to add. none or scte35WithoutSegmentation

encoder_settings.output_groups[].output_group_settings.cmaf_ingest_group_settings.segment_length

The nominal duration of segments. The units are specified in SegmentLengthUnits. The segments will end on the next keyframe after the specified duration, so the actual segment length might be longer, and it might be a fraction of the units.

encoder_settings.output_groups[].output_group_settings.cmaf_ingest_group_settings.segment_length_units

Time unit for segment length parameter.

encoder_settings.output_groups[].output_group_settings.cmaf_ingest_group_settings.send_delay_ms

Number of milliseconds to delay the output from the second pipeline.

encoder_settings.output_groups[].output_group_settings.frame_capture_group_settings

Frame Capture Group Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.frame_capture_group_settings.destination

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, curling-low.00001.jpg

Show child fields
encoder_settings.output_groups[].output_group_settings.frame_capture_group_settings.destination.destination_ref_id

Placeholder documentation for __string

encoder_settings.output_groups[].output_group_settings.frame_capture_group_settings.frame_capture_cdn_settings

Parameters that control interactions with the CDN.

Show child fields
encoder_settings.output_groups[].output_group_settings.frame_capture_group_settings.frame_capture_cdn_settings.frame_capture_s3_settings

Frame Capture S3 Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.frame_capture_group_settings.frame_capture_cdn_settings.frame_capture_s3_settings.canned_acl

Specify the canned ACL to apply to each S3 request. Defaults to none.

encoder_settings.output_groups[].output_group_settings.hls_group_settings

Hls Group Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.hls_group_settings.ad_markers[]
encoder_settings.output_groups[].output_group_settings.hls_group_settings.base_url_content

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.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.base_url_content1

Optional. One value per output group. This field is required only if you are completing Base URL content A, and the downstream system has notified you that the media files for pipeline 1 of all outputs are in a location different from the media files for pipeline 0.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.base_url_manifest

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.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.base_url_manifest1

Optional. One value per output group. Complete this field only if you are completing Base URL manifest A, and the downstream system has notified you that the child manifest files for pipeline 1 of all outputs are in a location different from the child manifest files for pipeline 0.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.caption_language_mappings[]
Show child fields
encoder_settings.output_groups[].output_group_settings.hls_group_settings.caption_language_mappings[].caption_channel

The closed caption channel being described by this CaptionLanguageMapping. Each channel mapping must have a unique channel number (maximum of 4)

encoder_settings.output_groups[].output_group_settings.hls_group_settings.caption_language_mappings[].language_code

Three character ISO 639-2 language code (see http://www.loc.gov/standards/iso639-2)

encoder_settings.output_groups[].output_group_settings.hls_group_settings.caption_language_mappings[].language_description

Textual description of language

encoder_settings.output_groups[].output_group_settings.hls_group_settings.caption_language_setting

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.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.client_cache

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.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.codec_specification

Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.constant_iv

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.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.destination

A directory or HTTP destination for the HLS segments, manifest files, and encryption keys (if enabled).

Show child fields
encoder_settings.output_groups[].output_group_settings.hls_group_settings.destination.destination_ref_id

Placeholder documentation for __string

encoder_settings.output_groups[].output_group_settings.hls_group_settings.directory_structure

Place segments in subdirectories.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.discontinuity_tags

Specifies whether to insert EXT-X-DISCONTINUITY tags in the HLS child manifests for this output group. Typically, choose Insert because these tags are required in the manifest (according to the HLS specification) and serve an important purpose. Choose Never Insert only if the downstream system is doing real-time failover (without using the MediaLive automatic failover feature) and only if that downstream system has advised you to exclude the tags.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.encryption_type

Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings

Parameters that control interactions with the CDN.

Show child fields
encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_akamai_settings

Hls Akamai Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_akamai_settings.connection_retry_interval

Number of seconds to wait before retrying connection to the CDN if the connection is lost.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_akamai_settings.filecache_duration

Size in seconds of file cache for streaming outputs.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_akamai_settings.http_transfer_mode

Specify whether or not to use chunked transfer encoding to Akamai. User should contact Akamai to enable this feature.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_akamai_settings.num_retries

Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with "s3" or "mediastore". For other URIs, the value is always 3.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_akamai_settings.restart_delay

If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_akamai_settings.salt

Salt for authenticated Akamai.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_akamai_settings.token

Token parameter for authenticated akamai. If not specified, _gda_ is used.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_basic_put_settings

Hls Basic Put Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_basic_put_settings.connection_retry_interval

Number of seconds to wait before retrying connection to the CDN if the connection is lost.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_basic_put_settings.filecache_duration

Size in seconds of file cache for streaming outputs.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_basic_put_settings.num_retries

Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with "s3" or "mediastore". For other URIs, the value is always 3.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_basic_put_settings.restart_delay

If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_media_store_settings

Hls Media Store Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_media_store_settings.connection_retry_interval

Number of seconds to wait before retrying connection to the CDN if the connection is lost.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_media_store_settings.filecache_duration

Size in seconds of file cache for streaming outputs.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_media_store_settings.media_store_storage_class

When set to temporal, output files are stored in non-persistent memory for faster reading and writing.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_media_store_settings.num_retries

Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with "s3" or "mediastore". For other URIs, the value is always 3.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_media_store_settings.restart_delay

If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_s3_settings

Hls S3 Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_s3_settings.canned_acl

Specify the canned ACL to apply to each S3 request. Defaults to none.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_webdav_settings

Hls Webdav Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_webdav_settings.connection_retry_interval

Number of seconds to wait before retrying connection to the CDN if the connection is lost.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_webdav_settings.filecache_duration

Size in seconds of file cache for streaming outputs.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_webdav_settings.http_transfer_mode

Specify whether or not to use chunked transfer encoding to WebDAV.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_webdav_settings.num_retries

Number of retry attempts that will be made before the Live Event is put into an error state. Applies only if the CDN destination URI begins with "s3" or "mediastore". For other URIs, the value is always 3.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_cdn_settings.hls_webdav_settings.restart_delay

If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.hls_id3_segment_tagging

State of HLS ID3 Segment Tagging

encoder_settings.output_groups[].output_group_settings.hls_group_settings.i_frame_only_playlists

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"

encoder_settings.output_groups[].output_group_settings.hls_group_settings.incomplete_segment_behavior

Specifies whether to include the final (incomplete) segment in the media output when the pipeline stops producing output because of a channel stop, a channel pause or a loss of input to the pipeline. Auto means that MediaLive decides whether to include the final segment, depending on the channel class and the types of output groups. Suppress means to never include the incomplete segment. We recommend you choose Auto and let MediaLive control the behavior.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.index_n_segments

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 smaller than the number in the Keep Segments field.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.input_loss_action

Parameter that control output group behavior on input loss.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.iv_in_manifest

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.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.iv_source

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.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.keep_segments

Applies only if Mode field is LIVE. Specifies the number of media segments to retain in the destination directory. This number should be bigger than indexNSegments (Num segments). We recommend (value = (2 x indexNsegments) + 1). If this "keep segments" number is too low, the following might happen: the player is still reading a media manifest file that lists this segment, but that segment has been removed from the destination directory (as directed by indexNSegments). This situation would result in a 404 HTTP error on the player.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.key_format

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.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.key_format_versions

Either a single positive integer version value or a slash delimited list of version values (1/2/3).

encoder_settings.output_groups[].output_group_settings.hls_group_settings.key_provider_settings

The key provider settings.

Show child fields
encoder_settings.output_groups[].output_group_settings.hls_group_settings.key_provider_settings.static_key_settings

Static Key Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.hls_group_settings.key_provider_settings.static_key_settings.key_provider_server

The URL of the license server used for protecting content.

Show child fields
encoder_settings.output_groups[].output_group_settings.hls_group_settings.key_provider_settings.static_key_settings.key_provider_server.password_param

key used to extract the password from EC2 Parameter store

encoder_settings.output_groups[].output_group_settings.hls_group_settings.key_provider_settings.static_key_settings.key_provider_server.uri

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

encoder_settings.output_groups[].output_group_settings.hls_group_settings.key_provider_settings.static_key_settings.key_provider_server.username

Documentation update needed

encoder_settings.output_groups[].output_group_settings.hls_group_settings.key_provider_settings.static_key_settings.static_key_value

Static key value as a 32 character hexadecimal string.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.manifest_compression

When set to gzip, compresses HLS playlist.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.manifest_duration_format

Indicates whether the output manifest should use floating point or integer values for segment duration.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.min_segment_length

Minimum length of MPEG-2 Transport Stream segments in seconds. When set, minimum segment length is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.mode

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.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.output_selection

MANIFESTS_AND_SEGMENTS: Generates manifests (master manifest, if applicable, and media manifests) for this output group. VARIANT_MANIFESTS_AND_SEGMENTS: Generates media manifests for this output group, but not a master manifest. SEGMENTS_ONLY: Does not generate any manifests for this output group.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.program_date_time

Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated using the program date time clock.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.program_date_time_clock

Specifies the algorithm used to drive the HLS EXT-X-PROGRAM-DATE-TIME clock. Options include: INITIALIZE_FROM_OUTPUT_TIMECODE: The PDT clock is initialized as a function of the first output timecode, then incremented by the EXTINF duration of each encoded segment. SYSTEM_CLOCK: The PDT clock is initialized as a function of the UTC wall clock, then incremented by the EXTINF duration of each encoded segment. If the PDT clock diverges from the wall clock by more than 500ms, it is resynchronized to the wall clock.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.program_date_time_period

Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.redundant_manifest

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.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.segment_length

Length of MPEG-2 Transport Stream segments to create in seconds. Note that segments will end on the next keyframe after this duration, so actual segment length may be longer.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.segmentation_mode

useInputSegmentation has been deprecated. The configured segment size is always used.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.segments_per_subdirectory

Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.stream_inf_resolution

Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.timed_metadata_id3_frame

Indicates ID3 frame that has the timecode.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.timed_metadata_id3_period

Timed Metadata interval in seconds.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.timestamp_delta_milliseconds

Provides an extra millisecond delta offset to fine tune the timestamps.

encoder_settings.output_groups[].output_group_settings.hls_group_settings.ts_file_mode

SEGMENTED_FILES: Emit the program as segments - multiple .ts media files. SINGLE_FILE: 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.

encoder_settings.output_groups[].output_group_settings.media_package_group_settings

Media Package Group Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.media_package_group_settings.destination

MediaPackage channel destination.

Show child fields
encoder_settings.output_groups[].output_group_settings.media_package_group_settings.destination.destination_ref_id

Placeholder documentation for __string

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings

Ms Smooth Group Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.acquisition_point_id

The ID to include in each message in the sparse track. Ignored if sparseTrackType is NONE.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.audio_only_timecode_control

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.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.certificate_mode

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.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.connection_retry_interval

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.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.destination

Smooth Streaming publish point on an IIS server. Elemental Live acts as a "Push" encoder to IIS.

Show child fields
encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.destination.destination_ref_id

Placeholder documentation for __string

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.event_id

MS Smooth event ID to be sent to the IIS server. Should only be specified if eventIdMode is set to useConfigured.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.event_id_mode

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.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.event_stop_behavior

When set to sendEos, send EOS signal to IIS server when stopping the event

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.filecache_duration

Size in seconds of file cache for streaming outputs.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.fragment_length

Length of mp4 fragments to generate (in seconds). Fragment length must be compatible with GOP size and framerate.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.input_loss_action

Parameter that control output group behavior on input loss.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.num_retries

Number of retry attempts.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.restart_delay

Number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.segmentation_mode

useInputSegmentation has been deprecated. The configured segment size is always used.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.send_delay_ms

Number of milliseconds to delay the output from the second pipeline.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.sparse_track_type

Identifies the type of data to place in the sparse track: - SCTE35: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame to start a new segment. - SCTE35_WITHOUT_SEGMENTATION: Insert SCTE-35 messages from the source content. With each message, insert an IDR frame but don't start a new segment. - NONE: Don't generate a sparse track for any outputs in this output group.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.stream_manifest_behavior

When set to send, send stream manifest so publishing point doesn't start until all streams start.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.timestamp_offset

Timestamp offset for the event. Only used if timestampOffsetMode is set to useConfiguredOffset.

encoder_settings.output_groups[].output_group_settings.ms_smooth_group_settings.timestamp_offset_mode

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

encoder_settings.output_groups[].output_group_settings.multiplex_group_settings

Multiplex Group Settings

encoder_settings.output_groups[].output_group_settings.rtmp_group_settings

Rtmp Group Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.rtmp_group_settings.ad_markers[]
encoder_settings.output_groups[].output_group_settings.rtmp_group_settings.authentication_scheme

Authentication scheme to use when connecting with CDN

encoder_settings.output_groups[].output_group_settings.rtmp_group_settings.cache_full_behavior

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.

encoder_settings.output_groups[].output_group_settings.rtmp_group_settings.cache_length

Cache length, in seconds, is used to calculate buffer size.

encoder_settings.output_groups[].output_group_settings.rtmp_group_settings.caption_data

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.

encoder_settings.output_groups[].output_group_settings.rtmp_group_settings.include_filler_nal_units

Applies only when the rate control mode (in the codec settings) is CBR (constant bit rate). Controls whether the RTMP output stream is padded (with FILL NAL units) in order to achieve a constant bit rate that is truly constant. When there is no padding, the bandwidth varies (up to the bitrate value in the codec settings). We recommend that you choose Auto.

encoder_settings.output_groups[].output_group_settings.rtmp_group_settings.input_loss_action

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.

encoder_settings.output_groups[].output_group_settings.rtmp_group_settings.restart_delay

If a streaming output fails, number of seconds to wait until a restart is initiated. A value of 0 means never restart.

encoder_settings.output_groups[].output_group_settings.udp_group_settings

Udp Group Settings

Show child fields
encoder_settings.output_groups[].output_group_settings.udp_group_settings.input_loss_action

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.

encoder_settings.output_groups[].output_group_settings.udp_group_settings.timed_metadata_id3_frame

Indicates ID3 frame that has the timecode.

encoder_settings.output_groups[].output_group_settings.udp_group_settings.timed_metadata_id3_period

Timed Metadata interval in seconds.

encoder_settings.output_groups[].outputs[]
Show child fields
encoder_settings.output_groups[].outputs[].audio_description_names[]
encoder_settings.output_groups[].outputs[].caption_description_names[]
encoder_settings.output_groups[].outputs[].output_name

The name used to identify an output.

encoder_settings.output_groups[].outputs[].output_settings

Output type-specific settings.

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings

Archive Output Settings

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings

Settings specific to the container type of the file.

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings

M2ts Settings

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.absent_input_audio_behavior

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.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.arib

When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.arib_captions_pid

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

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.arib_captions_pid_control

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.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.audio_buffer_model

When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.audio_frames_per_pes

The number of audio frames to insert for each PES packet.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.audio_pids

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

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.audio_stream_type

When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.bitrate

The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.buffer_model

Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.cc_descriptor

When set to enabled, generates captionServiceDescriptor in PMT.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.dvb_nit_settings

Inserts DVB Network Information Table (NIT) at the specified table repetition interval.

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.dvb_nit_settings.network_id

The numeric value placed in the Network Information Table (NIT).

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.dvb_nit_settings.network_name

The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.dvb_nit_settings.rep_interval

The number of milliseconds between instances of this table in the output transport stream.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.dvb_sdt_settings

Inserts DVB Service Description Table (SDT) at the specified table repetition interval.

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.dvb_sdt_settings.output_sdt

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.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.dvb_sdt_settings.rep_interval

The number of milliseconds between instances of this table in the output transport stream.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.dvb_sdt_settings.service_name

The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.dvb_sdt_settings.service_provider_name

The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.dvb_sub_pids

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

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.dvb_tdt_settings

Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.dvb_tdt_settings.rep_interval

The number of milliseconds between instances of this table in the output transport stream.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.dvb_teletext_pid

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

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.ebif

If set to passthrough, passes any EBIF data from the input source to this output.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.ebp_audio_interval

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.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.ebp_lookahead_ms

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.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.ebp_placement

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.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.ecm_pid

This field is unused and deprecated.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.es_rate_in_pes

Include or exclude the ES Rate field in the PES header.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.etv_platform_pid

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

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.etv_signal_pid

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

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.fragment_time

The length in seconds of each fragment. Only used with EBP markers.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.klv

If set to passthrough, passes any KLV data from the input source to this output.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.klv_data_pids

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

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.nielsen_id3_behavior

If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.null_packet_bitrate

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.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.pat_interval

The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.pcr_control

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.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.pcr_period

Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.pcr_pid

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

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.pmt_interval

The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.pmt_pid

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

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.program_num

The value of the program number field in the Program Map Table.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.rate_mode

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.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.scte27_pids

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

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.scte35_control

Optionally pass SCTE-35 signals from the input source to this output.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.scte35_pid

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

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.scte35_preroll_pullup_milliseconds

Defines the amount SCTE-35 preroll will be increased (in milliseconds) on the output. Preroll is the amount of time between the presence of a SCTE-35 indication in a transport stream and the PTS of the video frame it references. Zero means don't add pullup (it doesn't mean set the preroll to zero). Negative pullup is not supported, which means that you can't make the preroll shorter. Be aware that latency in the output will increase by the pullup amount.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.segmentation_markers

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.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.segmentation_style

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.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.segmentation_time

The length in seconds of each segment. Required unless markers is set to _none_.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.timed_metadata_behavior

When set to passthrough, timed metadata will be passed through from input to output.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.timed_metadata_pid

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

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.transport_stream_id

The value of the transport stream ID field in the Program Map Table.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.m2ts_settings.video_pid

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

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.container_settings.raw_settings

Raw Settings

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.extension

Output file extension. If excluded, this will be auto-selected from the container type.

encoder_settings.output_groups[].outputs[].output_settings.archive_output_settings.name_modifier

String concatenated to the end of the destination filename. Required for multiple outputs of the same type.

encoder_settings.output_groups[].outputs[].output_settings.cmaf_ingest_output_settings

Cmaf Ingest Output Settings

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.cmaf_ingest_output_settings.name_modifier

String concatenated to the end of the destination filename. Required for multiple outputs of the same type.

encoder_settings.output_groups[].outputs[].output_settings.frame_capture_output_settings

Frame Capture Output Settings

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.frame_capture_output_settings.name_modifier

Required if the output group contains more than one output. This modifier forms part of the output file name.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings

Hls Output Settings

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.h265_packaging_type

Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings

Settings regarding the underlying stream. These settings are different for audio-only outputs.

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.audio_only_hls_settings

Audio Only Hls Settings

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.audio_only_hls_settings.audio_group_id

Specifies the group to which the audio Rendition belongs.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.audio_only_hls_settings.audio_only_image

Optional. Specifies the .jpg or .png image to use as the cover art for an audio-only output. We recommend a low bit-size file because the image increases the output audio bandwidth. The image is attached to the audio as an ID3 tag, frame type APIC, picture type 0x10, as per the "ID3 tag version 2.4.0 - Native Frames" standard.

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.audio_only_hls_settings.audio_only_image.password_param

key used to extract the password from EC2 Parameter store

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.audio_only_hls_settings.audio_only_image.uri

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

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.audio_only_hls_settings.audio_only_image.username

Documentation update needed

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.audio_only_hls_settings.audio_track_type

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

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.audio_only_hls_settings.segment_type

Specifies the segment type.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.fmp4_hls_settings

Fmp4 Hls Settings

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.fmp4_hls_settings.audio_rendition_sets

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

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.fmp4_hls_settings.nielsen_id3_behavior

If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.fmp4_hls_settings.timed_metadata_behavior

When set to passthrough, timed metadata is passed through from input to output.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.frame_capture_hls_settings

Frame Capture Hls Settings

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings

Standard Hls Settings

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.audio_rendition_sets

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

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings

Settings information for the .m3u8 container

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.audio_frames_per_pes

The number of audio frames to insert for each PES packet.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.audio_pids

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.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.ecm_pid

This parameter is unused and deprecated.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.klv_behavior

If set to passthrough, passes any KLV data from the input source to this output.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.klv_data_pids

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

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.nielsen_id3_behavior

If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.pat_interval

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.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.pcr_control

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.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.pcr_period

Maximum time in milliseconds between Program Clock References (PCRs) inserted into the transport stream.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.pcr_pid

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.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.pmt_interval

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.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.pmt_pid

Packet Identifier (PID) for the Program Map Table (PMT) in the transport stream. Can be entered as a decimal or hexadecimal value.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.program_num

The value of the program number field in the Program Map Table.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.scte35_behavior

If set to passthrough, passes any SCTE-35 signals from the input source to this output.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.scte35_pid

Packet Identifier (PID) of the SCTE-35 stream in the transport stream. Can be entered as a decimal or hexadecimal value.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.timed_metadata_behavior

When set to passthrough, timed metadata is passed through from input to output.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.timed_metadata_pid

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

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.transport_stream_id

The value of the transport stream ID field in the Program Map Table.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.hls_settings.standard_hls_settings.m3u8_settings.video_pid

Packet Identifier (PID) of the elementary video stream in the transport stream. Can be entered as a decimal or hexadecimal value.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.name_modifier

String concatenated to the end of the destination filename. Accepts \"Format Identifiers\":#formatIdentifierParameters.

encoder_settings.output_groups[].outputs[].output_settings.hls_output_settings.segment_modifier

String concatenated to end of segment filenames.

encoder_settings.output_groups[].outputs[].output_settings.media_package_output_settings

Media Package Output Settings

encoder_settings.output_groups[].outputs[].output_settings.ms_smooth_output_settings

Ms Smooth Output Settings

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.ms_smooth_output_settings.h265_packaging_type

Only applicable when this output is referencing an H.265 video description. Specifies whether MP4 segments should be packaged as HEV1 or HVC1.

encoder_settings.output_groups[].outputs[].output_settings.ms_smooth_output_settings.name_modifier

String concatenated to the end of the destination filename. Required for multiple outputs of the same type.

encoder_settings.output_groups[].outputs[].output_settings.multiplex_output_settings

Multiplex Output Settings

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.multiplex_output_settings.destination

Destination is a Multiplex.

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.multiplex_output_settings.destination.destination_ref_id

Placeholder documentation for __string

encoder_settings.output_groups[].outputs[].output_settings.rtmp_output_settings

Rtmp Output Settings

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.rtmp_output_settings.certificate_mode

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.

encoder_settings.output_groups[].outputs[].output_settings.rtmp_output_settings.connection_retry_interval

Number of seconds to wait before retrying a connection to the Flash Media server if the connection is lost.

encoder_settings.output_groups[].outputs[].output_settings.rtmp_output_settings.destination

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.

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.rtmp_output_settings.destination.destination_ref_id

Placeholder documentation for __string

encoder_settings.output_groups[].outputs[].output_settings.rtmp_output_settings.num_retries

Number of retry attempts.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings

Udp Output Settings

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.buffer_msec

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.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings

Udp Container Settings

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings

M2ts Settings

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.absent_input_audio_behavior

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.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.arib

When set to enabled, uses ARIB-compliant field muxing and removes video descriptor.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.arib_captions_pid

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

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.arib_captions_pid_control

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.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.audio_buffer_model

When set to dvb, uses DVB buffer model for Dolby Digital audio. When set to atsc, the ATSC model is used.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.audio_frames_per_pes

The number of audio frames to insert for each PES packet.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.audio_pids

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

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.audio_stream_type

When set to atsc, uses stream type = 0x81 for AC3 and stream type = 0x87 for EAC3. When set to dvb, uses stream type = 0x06.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.bitrate

The output bitrate of the transport stream in bits per second. Setting to 0 lets the muxer automatically determine the appropriate bitrate.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.buffer_model

Controls the timing accuracy for output network traffic. Leave as MULTIPLEX to ensure accurate network packet timing. Or set to NONE, which might result in lower latency but will result in more variability in output network packet timing. This variability might cause interruptions, jitter, or bursty behavior in your playback or receiving devices.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.cc_descriptor

When set to enabled, generates captionServiceDescriptor in PMT.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.dvb_nit_settings

Inserts DVB Network Information Table (NIT) at the specified table repetition interval.

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.dvb_nit_settings.network_id

The numeric value placed in the Network Information Table (NIT).

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.dvb_nit_settings.network_name

The network name text placed in the networkNameDescriptor inside the Network Information Table. Maximum length is 256 characters.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.dvb_nit_settings.rep_interval

The number of milliseconds between instances of this table in the output transport stream.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.dvb_sdt_settings

Inserts DVB Service Description Table (SDT) at the specified table repetition interval.

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.dvb_sdt_settings.output_sdt

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.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.dvb_sdt_settings.rep_interval

The number of milliseconds between instances of this table in the output transport stream.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.dvb_sdt_settings.service_name

The service name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.dvb_sdt_settings.service_provider_name

The service provider name placed in the serviceDescriptor in the Service Description Table. Maximum length is 256 characters.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.dvb_sub_pids

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

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.dvb_tdt_settings

Inserts DVB Time and Date Table (TDT) at the specified table repetition interval.

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.dvb_tdt_settings.rep_interval

The number of milliseconds between instances of this table in the output transport stream.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.dvb_teletext_pid

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

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.ebif

If set to passthrough, passes any EBIF data from the input source to this output.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.ebp_audio_interval

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.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.ebp_lookahead_ms

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.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.ebp_placement

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.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.ecm_pid

This field is unused and deprecated.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.es_rate_in_pes

Include or exclude the ES Rate field in the PES header.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.etv_platform_pid

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

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.etv_signal_pid

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

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.fragment_time

The length in seconds of each fragment. Only used with EBP markers.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.klv

If set to passthrough, passes any KLV data from the input source to this output.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.klv_data_pids

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

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.nielsen_id3_behavior

If set to passthrough, Nielsen inaudible tones for media tracking will be detected in the input audio and an equivalent ID3 tag will be inserted in the output.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.null_packet_bitrate

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.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.pat_interval

The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.pcr_control

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.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.pcr_period

Maximum time in milliseconds between Program Clock Reference (PCRs) inserted into the transport stream.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.pcr_pid

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

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.pmt_interval

The number of milliseconds between instances of this table in the output transport stream. Valid values are 0, 10..1000.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.pmt_pid

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

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.program_num

The value of the program number field in the Program Map Table.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.rate_mode

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.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.scte27_pids

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

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.scte35_control

Optionally pass SCTE-35 signals from the input source to this output.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.scte35_pid

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

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.scte35_preroll_pullup_milliseconds

Defines the amount SCTE-35 preroll will be increased (in milliseconds) on the output. Preroll is the amount of time between the presence of a SCTE-35 indication in a transport stream and the PTS of the video frame it references. Zero means don't add pullup (it doesn't mean set the preroll to zero). Negative pullup is not supported, which means that you can't make the preroll shorter. Be aware that latency in the output will increase by the pullup amount.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.segmentation_markers

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.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.segmentation_style

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.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.segmentation_time

The length in seconds of each segment. Required unless markers is set to _none_.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.timed_metadata_behavior

When set to passthrough, timed metadata will be passed through from input to output.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.timed_metadata_pid

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

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.transport_stream_id

The value of the transport stream ID field in the Program Map Table.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.container_settings.m2ts_settings.video_pid

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

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.destination

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

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.destination.destination_ref_id

Placeholder documentation for __string

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.fec_output_settings

Settings for enabling and adjusting Forward Error Correction on UDP outputs.

Show child fields
encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.fec_output_settings.column_depth

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.

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.fec_output_settings.include_fec

Enables column only or column and row based FEC

encoder_settings.output_groups[].outputs[].output_settings.udp_output_settings.fec_output_settings.row_length

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.

encoder_settings.output_groups[].outputs[].video_description_name

The name of the VideoDescription used as the source for this output.

encoder_settings.thumbnail_configuration

Thumbnail configuration settings.

Show child fields
encoder_settings.thumbnail_configuration.state

Enables the thumbnail feature. The feature generates thumbnails of the incoming video in each pipeline in the channel. AUTO turns the feature on, DISABLE turns the feature off.

encoder_settings.timecode_config

Contains settings used to acquire and adjust timecode information from inputs.

Show child fields
encoder_settings.timecode_config.source

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.

encoder_settings.timecode_config.sync_threshold

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.

encoder_settings.video_descriptions[]
Show child fields
encoder_settings.video_descriptions[].codec_settings

Video codec settings.

Show child fields
encoder_settings.video_descriptions[].codec_settings.frame_capture_settings

Frame Capture Settings

Show child fields
encoder_settings.video_descriptions[].codec_settings.frame_capture_settings.capture_interval

The frequency at which to capture frames for inclusion in the output. May be specified in either seconds or milliseconds, as specified by captureIntervalUnits.

encoder_settings.video_descriptions[].codec_settings.frame_capture_settings.capture_interval_units

Unit for the frame capture interval.

encoder_settings.video_descriptions[].codec_settings.frame_capture_settings.timecode_burnin_settings

Timecode burn-in settings

Show child fields
encoder_settings.video_descriptions[].codec_settings.frame_capture_settings.timecode_burnin_settings.font_size

Choose a timecode burn-in font size

encoder_settings.video_descriptions[].codec_settings.frame_capture_settings.timecode_burnin_settings.position

Choose a timecode burn-in output position

encoder_settings.video_descriptions[].codec_settings.frame_capture_settings.timecode_burnin_settings.prefix

Create a timecode burn-in prefix (optional)

encoder_settings.video_descriptions[].codec_settings.h264_settings

H264 Settings

Show child fields
encoder_settings.video_descriptions[].codec_settings.h264_settings.adaptive_quantization

Enables or disables adaptive quantization, which is a technique MediaLive can apply to video on a frame-by-frame basis to produce more compression without losing quality. There are three types of adaptive quantization: flicker, spatial, and temporal. Set the field in one of these ways: Set to Auto. Recommended. For each type of AQ, MediaLive will determine if AQ is needed, and if so, the appropriate strength. Set a strength (a value other than Auto or Disable). This strength will apply to any of the AQ fields that you choose to enable. Set to Disabled to disable all types of adaptive quantization.

encoder_settings.video_descriptions[].codec_settings.h264_settings.afd_signaling

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.

encoder_settings.video_descriptions[].codec_settings.h264_settings.bitrate

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.

encoder_settings.video_descriptions[].codec_settings.h264_settings.buf_fill_pct

Percentage of the buffer that should initially be filled (HRD buffer model).

encoder_settings.video_descriptions[].codec_settings.h264_settings.buf_size

Size of buffer (HRD buffer model) in bits.

encoder_settings.video_descriptions[].codec_settings.h264_settings.color_metadata

Includes colorspace metadata in the output.

encoder_settings.video_descriptions[].codec_settings.h264_settings.color_space_settings

Color Space settings

Show child fields
encoder_settings.video_descriptions[].codec_settings.h264_settings.color_space_settings.color_space_passthrough_settings

Passthrough applies no color space conversion to the output

encoder_settings.video_descriptions[].codec_settings.h264_settings.color_space_settings.rec601_settings

Rec601 Settings

encoder_settings.video_descriptions[].codec_settings.h264_settings.color_space_settings.rec709_settings

Rec709 Settings

encoder_settings.video_descriptions[].codec_settings.h264_settings.entropy_encoding

Entropy encoding mode. Use cabac (must be in Main or High profile) or cavlc.

encoder_settings.video_descriptions[].codec_settings.h264_settings.filter_settings

Optional. Both filters reduce bandwidth by removing imperceptible details. You can enable one of the filters. We recommend that you try both filters and observe the results to decide which one to use. The Temporal Filter reduces bandwidth by removing imperceptible details in the content. It combines perceptual filtering and motion compensated temporal filtering (MCTF). It operates independently of the compression level. The Bandwidth Reduction filter is a perceptual filter located within the encoding loop. It adapts to the current compression level to filter imperceptible signals. This filter works only when the resolution is 1080p or lower.

Show child fields
encoder_settings.video_descriptions[].codec_settings.h264_settings.filter_settings.temporal_filter_settings

Temporal Filter Settings

Show child fields
encoder_settings.video_descriptions[].codec_settings.h264_settings.filter_settings.temporal_filter_settings.post_filter_sharpening

If you enable this filter, the results are the following: - If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source. - If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR.

encoder_settings.video_descriptions[].codec_settings.h264_settings.filter_settings.temporal_filter_settings.strength

Choose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft.

encoder_settings.video_descriptions[].codec_settings.h264_settings.fixed_afd

Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.

encoder_settings.video_descriptions[].codec_settings.h264_settings.flicker_aq

Flicker AQ makes adjustments within each frame to reduce flicker or 'pop' on I-frames. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if flicker AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply flicker AQ using the specified strength. Disabled: MediaLive won't apply flicker AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply flicker AQ.

encoder_settings.video_descriptions[].codec_settings.h264_settings.force_field_pictures

This setting applies only when scan type is "interlaced." It controls whether coding is performed on a field basis or on a frame basis. (When the video is progressive, the coding is always performed on a frame basis.) enabled: Force MediaLive to code on a field basis, so that odd and even sets of fields are coded separately. disabled: Code the two sets of fields separately (on a field basis) or together (on a frame basis using PAFF), depending on what is most appropriate for the content.

encoder_settings.video_descriptions[].codec_settings.h264_settings.framerate_control

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.

encoder_settings.video_descriptions[].codec_settings.h264_settings.framerate_denominator

Framerate denominator.

encoder_settings.video_descriptions[].codec_settings.h264_settings.framerate_numerator

Framerate numerator - framerate is a fraction, e.g. 24000/1001 = 23.976 fps.

encoder_settings.video_descriptions[].codec_settings.h264_settings.gop_b_reference

Documentation update needed

encoder_settings.video_descriptions[].codec_settings.h264_settings.gop_closed_cadence

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.

encoder_settings.video_descriptions[].codec_settings.h264_settings.gop_num_b_frames

Number of B-frames between reference frames.

encoder_settings.video_descriptions[].codec_settings.h264_settings.gop_size

GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.

encoder_settings.video_descriptions[].codec_settings.h264_settings.gop_size_units

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.

encoder_settings.video_descriptions[].codec_settings.h264_settings.level

H.264 Level.

encoder_settings.video_descriptions[].codec_settings.h264_settings.look_ahead_rate_control

Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.

encoder_settings.video_descriptions[].codec_settings.h264_settings.max_bitrate

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.

encoder_settings.video_descriptions[].codec_settings.h264_settings.min_i_interval

Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. 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

encoder_settings.video_descriptions[].codec_settings.h264_settings.num_ref_frames

Number of reference frames to use. The encoder may use more than requested if using B-frames and/or interlaced encoding.

encoder_settings.video_descriptions[].codec_settings.h264_settings.par_control

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.

encoder_settings.video_descriptions[].codec_settings.h264_settings.par_denominator

Pixel Aspect Ratio denominator.

encoder_settings.video_descriptions[].codec_settings.h264_settings.par_numerator

Pixel Aspect Ratio numerator.

encoder_settings.video_descriptions[].codec_settings.h264_settings.profile

H.264 Profile.

encoder_settings.video_descriptions[].codec_settings.h264_settings.quality_level

Leave as STANDARD_QUALITY or choose a different value (which might result in additional costs to run the channel). - ENHANCED_QUALITY: Produces a slightly better video quality without an increase in the bitrate. Has an effect only when the Rate control mode is QVBR or CBR. If this channel is in a MediaLive multiplex, the value must be ENHANCED_QUALITY. - STANDARD_QUALITY: Valid for any Rate control mode.

encoder_settings.video_descriptions[].codec_settings.h264_settings.qvbr_quality_level

Controls the target quality for the video encode. Applies only when the rate control mode is QVBR. You can set a target quality or you can let MediaLive determine the best quality. To set a target quality, enter values in the QVBR quality level field and the Max bitrate field. Enter values 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 To let MediaLive decide, leave the QVBR quality level field empty, and in Max bitrate enter the maximum rate you want in the video. For more information, see the section called "Video - rate control mode" in the MediaLive user guide

encoder_settings.video_descriptions[].codec_settings.h264_settings.rate_control_mode

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. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program.

encoder_settings.video_descriptions[].codec_settings.h264_settings.scan_type

Sets the scan type of the output to progressive or top-field-first interlaced.

encoder_settings.video_descriptions[].codec_settings.h264_settings.scene_change_detect

Scene change detection. - On: inserts I-frames when scene change is detected. - Off: does not force an I-frame when scene change is detected.

encoder_settings.video_descriptions[].codec_settings.h264_settings.slices

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.

encoder_settings.video_descriptions[].codec_settings.h264_settings.softness

Softness. Selects quantizer matrix, larger values reduce high-frequency content in the encoded image. If not set to zero, must be greater than 15.

encoder_settings.video_descriptions[].codec_settings.h264_settings.spatial_aq

Spatial AQ makes adjustments within each frame based on spatial variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if spatial AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply spatial AQ using the specified strength. Disabled: MediaLive won't apply spatial AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply spatial AQ.

encoder_settings.video_descriptions[].codec_settings.h264_settings.subgop_length

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.

encoder_settings.video_descriptions[].codec_settings.h264_settings.syntax

Produces a bitstream compliant with SMPTE RP-2027.

encoder_settings.video_descriptions[].codec_settings.h264_settings.temporal_aq

Temporal makes adjustments within each frame based on temporal variation of content complexity. The value to enter in this field depends on the value in the Adaptive quantization field: If you have set the Adaptive quantization field to Auto, MediaLive ignores any value in this field. MediaLive will determine if temporal AQ is appropriate and will apply the appropriate strength. If you have set the Adaptive quantization field to a strength, you can set this field to Enabled or Disabled. Enabled: MediaLive will apply temporal AQ using the specified strength. Disabled: MediaLive won't apply temporal AQ. If you have set the Adaptive quantization to Disabled, MediaLive ignores any value in this field and doesn't apply temporal AQ.

encoder_settings.video_descriptions[].codec_settings.h264_settings.timecode_burnin_settings

Timecode burn-in settings

Show child fields
encoder_settings.video_descriptions[].codec_settings.h264_settings.timecode_burnin_settings.font_size

Choose a timecode burn-in font size

encoder_settings.video_descriptions[].codec_settings.h264_settings.timecode_burnin_settings.position

Choose a timecode burn-in output position

encoder_settings.video_descriptions[].codec_settings.h264_settings.timecode_burnin_settings.prefix

Create a timecode burn-in prefix (optional)

encoder_settings.video_descriptions[].codec_settings.h264_settings.timecode_insertion

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

encoder_settings.video_descriptions[].codec_settings.h265_settings

H265 Settings

Show child fields
encoder_settings.video_descriptions[].codec_settings.h265_settings.adaptive_quantization

Adaptive quantization. Allows intra-frame quantizers to vary to improve visual quality.

encoder_settings.video_descriptions[].codec_settings.h265_settings.afd_signaling

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.

encoder_settings.video_descriptions[].codec_settings.h265_settings.alternative_transfer_function

Whether or not EML should insert an Alternative Transfer Function SEI message to support backwards compatibility with non-HDR decoders and displays.

encoder_settings.video_descriptions[].codec_settings.h265_settings.bitrate

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.

encoder_settings.video_descriptions[].codec_settings.h265_settings.buf_size

Size of buffer (HRD buffer model) in bits.

encoder_settings.video_descriptions[].codec_settings.h265_settings.color_metadata

Includes colorspace metadata in the output.

encoder_settings.video_descriptions[].codec_settings.h265_settings.color_space_settings

Color Space settings

Show child fields
encoder_settings.video_descriptions[].codec_settings.h265_settings.color_space_settings.color_space_passthrough_settings

Passthrough applies no color space conversion to the output

encoder_settings.video_descriptions[].codec_settings.h265_settings.color_space_settings.dolby_vision81_settings

Dolby Vision81 Settings

encoder_settings.video_descriptions[].codec_settings.h265_settings.color_space_settings.hdr10_settings

Hdr10 Settings

Show child fields
encoder_settings.video_descriptions[].codec_settings.h265_settings.color_space_settings.hdr10_settings.max_cll

Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file.

encoder_settings.video_descriptions[].codec_settings.h265_settings.color_space_settings.hdr10_settings.max_fall

Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file.

encoder_settings.video_descriptions[].codec_settings.h265_settings.color_space_settings.rec601_settings

Rec601 Settings

encoder_settings.video_descriptions[].codec_settings.h265_settings.color_space_settings.rec709_settings

Rec709 Settings

encoder_settings.video_descriptions[].codec_settings.h265_settings.filter_settings

Optional. Both filters reduce bandwidth by removing imperceptible details. You can enable one of the filters. We recommend that you try both filters and observe the results to decide which one to use. The Temporal Filter reduces bandwidth by removing imperceptible details in the content. It combines perceptual filtering and motion compensated temporal filtering (MCTF). It operates independently of the compression level. The Bandwidth Reduction filter is a perceptual filter located within the encoding loop. It adapts to the current compression level to filter imperceptible signals. This filter works only when the resolution is 1080p or lower.

Show child fields
encoder_settings.video_descriptions[].codec_settings.h265_settings.filter_settings.temporal_filter_settings

Temporal Filter Settings

Show child fields
encoder_settings.video_descriptions[].codec_settings.h265_settings.filter_settings.temporal_filter_settings.post_filter_sharpening

If you enable this filter, the results are the following: - If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source. - If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR.

encoder_settings.video_descriptions[].codec_settings.h265_settings.filter_settings.temporal_filter_settings.strength

Choose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft.

encoder_settings.video_descriptions[].codec_settings.h265_settings.fixed_afd

Four bit AFD value to write on all frames of video in the output stream. Only valid when afdSignaling is set to 'Fixed'.

encoder_settings.video_descriptions[].codec_settings.h265_settings.flicker_aq

If set to enabled, adjust quantization within each frame to reduce flicker or 'pop' on I-frames.

encoder_settings.video_descriptions[].codec_settings.h265_settings.framerate_denominator

Framerate denominator.

encoder_settings.video_descriptions[].codec_settings.h265_settings.framerate_numerator

Framerate numerator - framerate is a fraction, e.g. 24000/1001 = 23.976 fps.

encoder_settings.video_descriptions[].codec_settings.h265_settings.gop_closed_cadence

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.

encoder_settings.video_descriptions[].codec_settings.h265_settings.gop_size

GOP size (keyframe interval) in units of either frames or seconds per gopSizeUnits. If gopSizeUnits is frames, gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, gopSize must be greater than 0, but need not be an integer.

encoder_settings.video_descriptions[].codec_settings.h265_settings.gop_size_units

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.

encoder_settings.video_descriptions[].codec_settings.h265_settings.level

H.265 Level.

encoder_settings.video_descriptions[].codec_settings.h265_settings.look_ahead_rate_control

Amount of lookahead. A value of low can decrease latency and memory usage, while high can produce better quality for certain content.

encoder_settings.video_descriptions[].codec_settings.h265_settings.max_bitrate

For QVBR: See the tooltip for Quality level

encoder_settings.video_descriptions[].codec_settings.h265_settings.min_i_interval

Only meaningful if sceneChangeDetect is set to enabled. Defaults to 5 if multiplex rate control is used. 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

encoder_settings.video_descriptions[].codec_settings.h265_settings.mv_over_picture_boundaries

If you are setting up the picture as a tile, you must set this to "disabled". In all other configurations, you typically enter "enabled".

encoder_settings.video_descriptions[].codec_settings.h265_settings.mv_temporal_predictor

If you are setting up the picture as a tile, you must set this to "disabled". In other configurations, you typically enter "enabled".

encoder_settings.video_descriptions[].codec_settings.h265_settings.par_denominator

Pixel Aspect Ratio denominator.

encoder_settings.video_descriptions[].codec_settings.h265_settings.par_numerator

Pixel Aspect Ratio numerator.

encoder_settings.video_descriptions[].codec_settings.h265_settings.profile

H.265 Profile.

encoder_settings.video_descriptions[].codec_settings.h265_settings.qvbr_quality_level

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

encoder_settings.video_descriptions[].codec_settings.h265_settings.rate_control_mode

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. CBR: Quality varies, depending on the video complexity. Recommended only if you distribute your assets to devices that cannot handle variable bitrates. Multiplex: This rate control mode is only supported (and is required) when the video is being delivered to a MediaLive Multiplex in which case the rate control configuration is controlled by the properties within the Multiplex Program.

encoder_settings.video_descriptions[].codec_settings.h265_settings.scan_type

Sets the scan type of the output to progressive or top-field-first interlaced.

encoder_settings.video_descriptions[].codec_settings.h265_settings.scene_change_detect

Scene change detection.

encoder_settings.video_descriptions[].codec_settings.h265_settings.slices

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.

encoder_settings.video_descriptions[].codec_settings.h265_settings.tier

H.265 Tier.

encoder_settings.video_descriptions[].codec_settings.h265_settings.tile_height

Set this field to set up the picture as a tile. You must also set tileWidth. The tile height must result in 22 or fewer rows in the frame. The tile width must result in 20 or fewer columns in the frame. And finally, the product of the column count and row count must be 64 of less. If the tile width and height are specified, MediaLive will override the video codec slices field with a value that MediaLive calculates

encoder_settings.video_descriptions[].codec_settings.h265_settings.tile_padding

Set to "padded" to force MediaLive to add padding to the frame, to obtain a frame that is a whole multiple of the tile size. If you are setting up the picture as a tile, you must enter "padded". In all other configurations, you typically enter "none".

encoder_settings.video_descriptions[].codec_settings.h265_settings.tile_width

Set this field to set up the picture as a tile. See tileHeight for more information.

encoder_settings.video_descriptions[].codec_settings.h265_settings.timecode_burnin_settings

Timecode burn-in settings

Show child fields
encoder_settings.video_descriptions[].codec_settings.h265_settings.timecode_burnin_settings.font_size

Choose a timecode burn-in font size

encoder_settings.video_descriptions[].codec_settings.h265_settings.timecode_burnin_settings.position

Choose a timecode burn-in output position

encoder_settings.video_descriptions[].codec_settings.h265_settings.timecode_burnin_settings.prefix

Create a timecode burn-in prefix (optional)

encoder_settings.video_descriptions[].codec_settings.h265_settings.timecode_insertion

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

encoder_settings.video_descriptions[].codec_settings.h265_settings.treeblock_size

Select the tree block size used for encoding. If you enter "auto", the encoder will pick the best size. If you are setting up the picture as a tile, you must set this to 32x32. In all other configurations, you typically enter "auto".

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings

Mpeg2 Settings

Show child fields
encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.adaptive_quantization

Choose Off to disable adaptive quantization. Or choose another value to enable the quantizer and set its strength. The strengths are: Auto, Off, Low, Medium, High. When you enable this field, MediaLive allows intra-frame quantizers to vary, which might improve visual quality.

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.afd_signaling

Indicates the AFD values that MediaLive will write into the video encode. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose AUTO. AUTO: MediaLive will try to preserve the input AFD value (in cases where multiple AFD values are valid). FIXED: MediaLive will use the value you specify in fixedAFD.

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.color_metadata

Specifies whether to include the color space metadata. The metadata describes the color space that applies to the video (the colorSpace field). We recommend that you insert the metadata.

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.color_space

Choose the type of color space conversion to apply to the output. For detailed information on setting up both the input and the output to obtain the desired color space in the output, see the section on \"MediaLive Features - Video - color space\" in the MediaLive User Guide. PASSTHROUGH: Keep the color space of the input content - do not convert it. AUTO:Convert all content that is SD to rec 601, and convert all content that is HD to rec 709.

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.display_aspect_ratio

Sets the pixel aspect ratio for the encode.

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.filter_settings

Optionally specify a noise reduction filter, which can improve quality of compressed content. If you do not choose a filter, no filter will be applied. TEMPORAL: This filter is useful for both source content that is noisy (when it has excessive digital artifacts) and source content that is clean. When the content is noisy, the filter cleans up the source content before the encoding phase, with these two effects: First, it improves the output video quality because the content has been cleaned up. Secondly, it decreases the bandwidth because MediaLive does not waste bits on encoding noise. When the content is reasonably clean, the filter tends to decrease the bitrate.

Show child fields
encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.filter_settings.temporal_filter_settings

Temporal Filter Settings

Show child fields
encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.filter_settings.temporal_filter_settings.post_filter_sharpening

If you enable this filter, the results are the following: - If the source content is noisy (it contains excessive digital artifacts), the filter cleans up the source. - If the source content is already clean, the filter tends to decrease the bitrate, especially when the rate control mode is QVBR.

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.filter_settings.temporal_filter_settings.strength

Choose a filter strength. We recommend a strength of 1 or 2. A higher strength might take out good information, resulting in an image that is overly soft.

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.fixed_afd

Complete this field only when afdSignaling is set to FIXED. Enter the AFD value (4 bits) to write on all frames of the video encode.

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.framerate_denominator

description": "The framerate denominator. For example, 1001. The framerate is the numerator divided by the denominator. For example, 24000/1001 = 23.976 FPS.

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.framerate_numerator

The framerate numerator. For example, 24000. The framerate is the numerator divided by the denominator. For example, 24000/1001 = 23.976 FPS.

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.gop_closed_cadence

MPEG2: default is open GOP.

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.gop_num_b_frames

Relates to the GOP structure. The number of B-frames between reference frames. If you do not know what a B-frame is, use the default.

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.gop_size

Relates to the GOP structure. The GOP size (keyframe interval) in the units specified in gopSizeUnits. If you do not know what GOP is, use the default. If gopSizeUnits is frames, then the gopSize must be an integer and must be greater than or equal to 1. If gopSizeUnits is seconds, the gopSize must be greater than 0, but does not need to be an integer.

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.gop_size_units

Relates to the GOP structure. Specifies whether the gopSize is specified in frames or seconds. If you do not plan to change the default gopSize, leave the default. If you specify SECONDS, MediaLive will internally convert the gop size to a frame count.

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.scan_type

Set the scan type of the output to PROGRESSIVE or INTERLACED (top field first).

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.subgop_length

Relates to the GOP structure. If you do not know what GOP is, use the default. FIXED: Set the number of B-frames in each sub-GOP to the value in gopNumBFrames. DYNAMIC: Let MediaLive optimize the number of B-frames in each sub-GOP, to improve visual quality.

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.timecode_burnin_settings

Timecode burn-in settings

Show child fields
encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.timecode_burnin_settings.font_size

Choose a timecode burn-in font size

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.timecode_burnin_settings.position

Choose a timecode burn-in output position

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.timecode_burnin_settings.prefix

Create a timecode burn-in prefix (optional)

encoder_settings.video_descriptions[].codec_settings.mpeg2_settings.timecode_insertion

Determines how MediaLive inserts timecodes in the output video. For detailed information about setting up the input and the output for a timecode, see the section on \"MediaLive Features - Timecode configuration\" in the MediaLive User Guide. DISABLED: do not include timecodes. GOP_TIMECODE: Include timecode metadata in the GOP header.

encoder_settings.video_descriptions[].height

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.

encoder_settings.video_descriptions[].name

The name of this VideoDescription. Outputs will use this name to uniquely identify this Description. Description names should be unique within this Live Event.

encoder_settings.video_descriptions[].respond_to_afd

Indicates how MediaLive will respond to the AFD values that might be in the input video. If you do not know what AFD signaling is, or if your downstream system has not given you guidance, choose PASSTHROUGH. RESPOND: MediaLive clips the input video using a formula that uses the AFD values (configured in afdSignaling ), the input display aspect ratio, and the output display aspect ratio. MediaLive also includes the AFD values in the output, unless the codec for this encode is FRAME_CAPTURE. PASSTHROUGH: MediaLive ignores the AFD values and does not clip the video. But MediaLive does include the values in the output. NONE: MediaLive does not clip the input video and does not include the AFD values in the output

encoder_settings.video_descriptions[].scaling_behavior

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

encoder_settings.video_descriptions[].sharpness

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.

encoder_settings.video_descriptions[].width

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

The unique id of the channel.

VARCHAR
input_attachments

List of input attachments for channel.

STRUCT(
"automatic_input_failover_settings" STRUCT(
"error_clear_time_msec" BIGINT,
"failover_conditions" STRUCT(
"failover_condition_settings" STRUCT(
"audio_silence_settings" STRUCT(
"audio_selector_name" VARCHAR,
"audio_silence_threshold_msec" BIGINT
),
"input_loss_settings" STRUCT(
"input_loss_threshold_msec" BIGINT
),
"video_black_settings" STRUCT(
"black_detect_threshold" DOUBLE,
"video_black_threshold_msec" BIGINT
)
)
)[],
"input_preference" VARCHAR,
"secondary_input_id" VARCHAR
),
"input_attachment_name" VARCHAR,
"input_id" VARCHAR,
"input_settings" STRUCT(
"audio_selectors" STRUCT(
"name" VARCHAR,
"selector_settings" STRUCT(
"audio_hls_rendition_selection" STRUCT(
"group_id" VARCHAR,
"name" VARCHAR
),
"audio_language_selection" STRUCT(
"language_code" VARCHAR,
"language_selection_policy" VARCHAR
),
"audio_pid_selection" STRUCT(
"pid" BIGINT
),
"audio_track_selection" STRUCT(
"tracks" STRUCT(
"track" BIGINT
)[],
"dolby_e_decode" STRUCT(
"program_selection" VARCHAR
)
)
)
)[],
"caption_selectors" STRUCT(
"language_code" VARCHAR,
"name" VARCHAR,
"selector_settings" STRUCT(
"ancillary_source_settings" STRUCT(
"source_ancillary_channel_number" BIGINT
),
"arib_source_settings" BOOLEAN,
"dvb_sub_source_settings" STRUCT(
"ocr_language" VARCHAR,
"pid" BIGINT
),
"embedded_source_settings" STRUCT(
"convert608_to708" VARCHAR,
"scte20_detection" VARCHAR,
"source608_channel_number" BIGINT,
"source608_track_number" BIGINT
),
"scte20_source_settings" STRUCT(
"convert608_to708" VARCHAR,
"source608_channel_number" BIGINT
),
"scte27_source_settings" STRUCT(
"ocr_language" VARCHAR,
"pid" BIGINT
),
"teletext_source_settings" STRUCT(
"output_rectangle" STRUCT(
"height" DOUBLE,
"left_offset" DOUBLE,
"top_offset" DOUBLE,
"width" DOUBLE
),
"page_number" VARCHAR
)
)
)[],
"deblock_filter" VARCHAR,
"denoise_filter" VARCHAR,
"filter_strength" BIGINT,
"input_filter" VARCHAR,
"network_input_settings" STRUCT(
"hls_input_settings" STRUCT(
"bandwidth" BIGINT,
"buffer_segments" BIGINT,
"retries" BIGINT,
"retry_interval" BIGINT,
"scte35_source" VARCHAR
),
"server_validation" VARCHAR
),
"scte35_pid" BIGINT,
"smpte2038_data_preference" VARCHAR,
"source_end_behavior" VARCHAR,
"video_selector" STRUCT(
"color_space" VARCHAR,
"color_space_settings" STRUCT(
"hdr10_settings" STRUCT(
"max_cll" BIGINT,
"max_fall" BIGINT
)
),
"color_space_usage" VARCHAR,
"selector_settings" STRUCT(
"video_selector_pid" STRUCT(
"pid" BIGINT
),
"video_selector_program_id" STRUCT(
"program_id" BIGINT
)
)
)
)
)[]
Show child fields
input_attachments[]
Show child fields
input_attachments[].automatic_input_failover_settings

User-specified settings for defining what the conditions are for declaring the input unhealthy and failing over to a different input.

Show child fields
input_attachments[].automatic_input_failover_settings.error_clear_time_msec

This clear time defines the requirement a recovered input must meet to be considered healthy. The input must have no failover conditions for this length of time. Enter a time in milliseconds. This value is particularly important if the input_preference for the failover pair is set to PRIMARY_INPUT_PREFERRED, because after this time, MediaLive will switch back to the primary input.

input_attachments[].automatic_input_failover_settings.failover_conditions[]
Show child fields
input_attachments[].automatic_input_failover_settings.failover_conditions[].failover_condition_settings

Failover condition type-specific settings.

Show child fields
input_attachments[].automatic_input_failover_settings.failover_conditions[].failover_condition_settings.audio_silence_settings

MediaLive will perform a failover if the specified audio selector is silent for the specified period.

Show child fields
input_attachments[].automatic_input_failover_settings.failover_conditions[].failover_condition_settings.audio_silence_settings.audio_selector_name

The name of the audio selector in the input that MediaLive should monitor to detect silence. Select your most important rendition. If you didn't create an audio selector in this input, leave blank.

input_attachments[].automatic_input_failover_settings.failover_conditions[].failover_condition_settings.audio_silence_settings.audio_silence_threshold_msec

The amount of time (in milliseconds) that the active input must be silent before automatic input failover occurs. Silence is defined as audio loss or audio quieter than -50 dBFS.

input_attachments[].automatic_input_failover_settings.failover_conditions[].failover_condition_settings.input_loss_settings

MediaLive will perform a failover if content is not detected in this input for the specified period.

Show child fields
input_attachments[].automatic_input_failover_settings.failover_conditions[].failover_condition_settings.input_loss_settings.input_loss_threshold_msec

The amount of time (in milliseconds) that no input is detected. After that time, an input failover will occur.

input_attachments[].automatic_input_failover_settings.failover_conditions[].failover_condition_settings.video_black_settings

MediaLive will perform a failover if content is considered black for the specified period.

Show child fields
input_attachments[].automatic_input_failover_settings.failover_conditions[].failover_condition_settings.video_black_settings.black_detect_threshold

A value used in calculating the threshold below which MediaLive considers a pixel to be 'black'. For the input to be considered black, every pixel in a frame must be below this threshold. The threshold is calculated as a percentage (expressed as a decimal) of white. Therefore .1 means 10% white (or 90% black). Note how the formula works for any color depth. For example, if you set this field to 0.1 in 10-bit color depth: (1023*0.1=102.3), which means a pixel value of 102 or less is 'black'. If you set this field to .1 in an 8-bit color depth: (255*0.1=25.5), which means a pixel value of 25 or less is 'black'. The range is 0.0 to 1.0, with any number of decimal places.

input_attachments[].automatic_input_failover_settings.failover_conditions[].failover_condition_settings.video_black_settings.video_black_threshold_msec

The amount of time (in milliseconds) that the active input must be black before automatic input failover occurs.

input_attachments[].automatic_input_failover_settings.input_preference

Input preference when deciding which input to make active when a previously failed input has recovered.

input_attachments[].automatic_input_failover_settings.secondary_input_id

The input ID of the secondary input in the automatic input failover pair.

input_attachments[].input_attachment_name

User-specified name for the attachment. This is required if the user wants to use this input in an input switch action.

input_attachments[].input_id

The ID of the input

input_attachments[].input_settings

Settings of an input (caption selector, etc.)

Show child fields
input_attachments[].input_settings.audio_selectors[]
Show child fields
input_attachments[].input_settings.audio_selectors[].name

The name of this AudioSelector. AudioDescriptions will use this name to uniquely identify this Selector. Selector names should be unique per input.

input_attachments[].input_settings.audio_selectors[].selector_settings

The audio selector settings.

Show child fields
input_attachments[].input_settings.audio_selectors[].selector_settings.audio_hls_rendition_selection

Audio Hls Rendition Selection

Show child fields
input_attachments[].input_settings.audio_selectors[].selector_settings.audio_hls_rendition_selection.group_id

Specifies the GROUP-ID in the #EXT-X-MEDIA tag of the target HLS audio rendition.

input_attachments[].input_settings.audio_selectors[].selector_settings.audio_hls_rendition_selection.name

Specifies the NAME in the #EXT-X-MEDIA tag of the target HLS audio rendition.

input_attachments[].input_settings.audio_selectors[].selector_settings.audio_language_selection

Audio Language Selection

Show child fields
input_attachments[].input_settings.audio_selectors[].selector_settings.audio_language_selection.language_code

Selects a specific three-letter language code from within an audio source.

input_attachments[].input_settings.audio_selectors[].selector_settings.audio_language_selection.language_selection_policy

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.

input_attachments[].input_settings.audio_selectors[].selector_settings.audio_pid_selection

Audio Pid Selection

Show child fields
input_attachments[].input_settings.audio_selectors[].selector_settings.audio_pid_selection.pid

Selects a specific PID from within a source.

input_attachments[].input_settings.audio_selectors[].selector_settings.audio_track_selection

Audio Track Selection

Show child fields
input_attachments[].input_settings.audio_selectors[].selector_settings.audio_track_selection.dolby_e_decode

Configure decoding options for Dolby E streams - these should be Dolby E frames carried in PCM streams tagged with SMPTE-337

Show child fields
input_attachments[].input_settings.audio_selectors[].selector_settings.audio_track_selection.dolby_e_decode.program_selection

Applies only to Dolby E. Enter the program ID (according to the metadata in the audio) of the Dolby E program to extract from the specified track. One program extracted per audio selector. To select multiple programs, create multiple selectors with the same Track and different Program numbers. “All channels” means to ignore the program IDs and include all the channels in this selector; useful if metadata is known to be incorrect.

input_attachments[].input_settings.audio_selectors[].selector_settings.audio_track_selection.tracks[]
Show child fields
input_attachments[].input_settings.audio_selectors[].selector_settings.audio_track_selection.tracks[].track

1-based integer value that maps to a specific audio track

input_attachments[].input_settings.caption_selectors[]
Show child fields
input_attachments[].input_settings.caption_selectors[].language_code

When specified this field indicates the three letter language code of the caption track to extract from the source.

input_attachments[].input_settings.caption_selectors[].name

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.

input_attachments[].input_settings.caption_selectors[].selector_settings

Caption selector settings.

Show child fields
input_attachments[].input_settings.caption_selectors[].selector_settings.ancillary_source_settings

Ancillary Source Settings

Show child fields
input_attachments[].input_settings.caption_selectors[].selector_settings.ancillary_source_settings.source_ancillary_channel_number

Specifies the number (1 to 4) of the captions channel you want to extract from the ancillary captions. If you plan to convert the ancillary captions to another format, complete this field. If you plan to choose Embedded as the captions destination in the output (to pass through all the channels in the ancillary captions), leave this field blank because MediaLive ignores the field.

input_attachments[].input_settings.caption_selectors[].selector_settings.arib_source_settings

Arib Source Settings

input_attachments[].input_settings.caption_selectors[].selector_settings.dvb_sub_source_settings

Dvb Sub Source Settings

Show child fields
input_attachments[].input_settings.caption_selectors[].selector_settings.dvb_sub_source_settings.ocr_language

If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text.

input_attachments[].input_settings.caption_selectors[].selector_settings.dvb_sub_source_settings.pid

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.

input_attachments[].input_settings.caption_selectors[].selector_settings.embedded_source_settings

Embedded Source Settings

Show child fields
input_attachments[].input_settings.caption_selectors[].selector_settings.embedded_source_settings.convert608_to708

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.

input_attachments[].input_settings.caption_selectors[].selector_settings.embedded_source_settings.scte20_detection

Set to "auto" to handle streams with intermittent and/or non-aligned SCTE-20 and Embedded captions.

input_attachments[].input_settings.caption_selectors[].selector_settings.embedded_source_settings.source608_channel_number

Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.

input_attachments[].input_settings.caption_selectors[].selector_settings.embedded_source_settings.source608_track_number

This field is unused and deprecated.

input_attachments[].input_settings.caption_selectors[].selector_settings.scte20_source_settings

Scte20 Source Settings

Show child fields
input_attachments[].input_settings.caption_selectors[].selector_settings.scte20_source_settings.convert608_to708

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.

input_attachments[].input_settings.caption_selectors[].selector_settings.scte20_source_settings.source608_channel_number

Specifies the 608/708 channel number within the video track from which to extract captions. Unused for passthrough.

input_attachments[].input_settings.caption_selectors[].selector_settings.scte27_source_settings

Scte27 Source Settings

Show child fields
input_attachments[].input_settings.caption_selectors[].selector_settings.scte27_source_settings.ocr_language

If you will configure a WebVTT caption description that references this caption selector, use this field to provide the language to consider when translating the image-based source to text.

input_attachments[].input_settings.caption_selectors[].selector_settings.scte27_source_settings.pid

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.

input_attachments[].input_settings.caption_selectors[].selector_settings.teletext_source_settings

Teletext Source Settings

Show child fields
input_attachments[].input_settings.caption_selectors[].selector_settings.teletext_source_settings.output_rectangle

Optionally defines a region where TTML style captions will be displayed

Show child fields
input_attachments[].input_settings.caption_selectors[].selector_settings.teletext_source_settings.output_rectangle.height

See the description in leftOffset. For height, specify the entire height of the rectangle as a percentage of the underlying frame height. For example, \"80\" means the rectangle height is 80% of the underlying frame height. The topOffset and rectangleHeight must add up to 100% or less. This field corresponds to tts:extent - Y in the TTML standard.

input_attachments[].input_settings.caption_selectors[].selector_settings.teletext_source_settings.output_rectangle.left_offset

Applies only if you plan to convert these source captions to EBU-TT-D or TTML in an output. (Make sure to leave the default if you don't have either of these formats in the output.) You can define a display rectangle for the captions that is smaller than the underlying video frame. You define the rectangle by specifying the position of the left edge, top edge, bottom edge, and right edge of the rectangle, all within the underlying video frame. The units for the measurements are percentages. If you specify a value for one of these fields, you must specify a value for all of them. For leftOffset, specify the position of the left edge of the rectangle, as a percentage of the underlying frame width, and relative to the left edge of the frame. For example, \"10\" means the measurement is 10% of the underlying frame width. The rectangle left edge starts at that position from the left edge of the frame. This field corresponds to tts:origin - X in the TTML standard.

input_attachments[].input_settings.caption_selectors[].selector_settings.teletext_source_settings.output_rectangle.top_offset

See the description in leftOffset. For topOffset, specify the position of the top edge of the rectangle, as a percentage of the underlying frame height, and relative to the top edge of the frame. For example, \"10\" means the measurement is 10% of the underlying frame height. The rectangle top edge starts at that position from the top edge of the frame. This field corresponds to tts:origin - Y in the TTML standard.

input_attachments[].input_settings.caption_selectors[].selector_settings.teletext_source_settings.output_rectangle.width

See the description in leftOffset. For width, specify the entire width of the rectangle as a percentage of the underlying frame width. For example, \"80\" means the rectangle width is 80% of the underlying frame width. The leftOffset and rectangleWidth must add up to 100% or less. This field corresponds to tts:extent - X in the TTML standard.

input_attachments[].input_settings.caption_selectors[].selector_settings.teletext_source_settings.page_number

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.

input_attachments[].input_settings.deblock_filter

Enable or disable the deblock filter when filtering.

input_attachments[].input_settings.denoise_filter

Enable or disable the denoise filter when filtering.

input_attachments[].input_settings.filter_strength

Adjusts the magnitude of filtering from 1 (minimal) to 5 (strongest).

input_attachments[].input_settings.input_filter

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

input_attachments[].input_settings.network_input_settings

Input settings.

Show child fields
input_attachments[].input_settings.network_input_settings.hls_input_settings

Specifies HLS input settings when the uri is for a HLS manifest.

Show child fields
input_attachments[].input_settings.network_input_settings.hls_input_settings.bandwidth

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.

input_attachments[].input_settings.network_input_settings.hls_input_settings.buffer_segments

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.

input_attachments[].input_settings.network_input_settings.hls_input_settings.retries

The number of consecutive times that attempts to read a manifest or segment must fail before the input is considered unavailable.

input_attachments[].input_settings.network_input_settings.hls_input_settings.retry_interval

The number of seconds between retries when an attempt to read a manifest or segment fails.

input_attachments[].input_settings.network_input_settings.hls_input_settings.scte35_source

Identifies the source for the SCTE-35 messages that MediaLive will ingest. Messages can be ingested from the content segments (in the stream) or from tags in the playlist (the HLS manifest). MediaLive ignores SCTE-35 information in the source that is not selected.

input_attachments[].input_settings.network_input_settings.server_validation

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.

input_attachments[].input_settings.scte35_pid

PID from which to read SCTE-35 messages. If left undefined, EML will select the first SCTE-35 PID found in the input.

input_attachments[].input_settings.smpte2038_data_preference

Specifies whether to extract applicable ancillary data from a SMPTE-2038 source in this input. Applicable data types are captions, timecode, AFD, and SCTE-104 messages. - PREFER: Extract from SMPTE-2038 if present in this input, otherwise extract from another source (if any). - IGNORE: Never extract any ancillary data from SMPTE-2038.

input_attachments[].input_settings.source_end_behavior

Loop input if it is a file. This allows a file input to be streamed indefinitely.

input_attachments[].input_settings.video_selector

Informs which video elementary stream to decode for input types that have multiple available.

Show child fields
input_attachments[].input_settings.video_selector.color_space

Specifies the color space of an input. This setting works in tandem with colorSpaceUsage and a video description's colorSpaceSettingsChoice to determine if any conversion will be performed.

input_attachments[].input_settings.video_selector.color_space_settings

Color space settings

Show child fields
input_attachments[].input_settings.video_selector.color_space_settings.hdr10_settings

Hdr10 Settings

Show child fields
input_attachments[].input_settings.video_selector.color_space_settings.hdr10_settings.max_cll

Maximum Content Light Level An integer metadata value defining the maximum light level, in nits, of any single pixel within an encoded HDR video stream or file.

input_attachments[].input_settings.video_selector.color_space_settings.hdr10_settings.max_fall

Maximum Frame Average Light Level An integer metadata value defining the maximum average light level, in nits, for any single frame within an encoded HDR video stream or file.

input_attachments[].input_settings.video_selector.color_space_usage

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.

input_attachments[].input_settings.video_selector.selector_settings

The video selector settings.

Show child fields
input_attachments[].input_settings.video_selector.selector_settings.video_selector_pid

Video Selector Pid

Show child fields
input_attachments[].input_settings.video_selector.selector_settings.video_selector_pid.pid

Selects a specific PID from within a video source.

input_attachments[].input_settings.video_selector.selector_settings.video_selector_program_id

Video Selector Program Id

Show child fields
input_attachments[].input_settings.video_selector.selector_settings.video_selector_program_id.program_id

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.

input_specification

Specification of network and file inputs for this channel

STRUCT(
"codec" VARCHAR,
"maximum_bitrate" VARCHAR,
"resolution" VARCHAR
)
Show child fields
input_specification.codec

Input codec

input_specification.maximum_bitrate

Maximum input bitrate, categorized coarsely

input_specification.resolution

Input resolution, categorized coarsely

log_level

The log level being written to CloudWatch Logs.

VARCHAR
maintenance

Maintenance settings for this channel.

STRUCT(
"maintenance_day" VARCHAR,
"maintenance_deadline" VARCHAR,
"maintenance_scheduled_date" VARCHAR,
"maintenance_start_time" VARCHAR
)
Show child fields
maintenance.maintenance_day

The currently selected maintenance day.

maintenance.maintenance_deadline

Maintenance is required by the displayed date and time. Date and time is in ISO.

maintenance.maintenance_scheduled_date

The currently scheduled maintenance date and time. Date and time is in ISO.

maintenance.maintenance_start_time

The currently selected maintenance start time. Time is in UTC.

name

The name of the channel. (user-mutable)

VARCHAR
pipeline_details

Runtime details for the pipelines of a running channel.

STRUCT(
"active_input_attachment_name" VARCHAR,
"active_input_switch_action_name" VARCHAR,
"active_motion_graphics_action_name" VARCHAR,
"active_motion_graphics_uri" VARCHAR,
"pipeline_id" VARCHAR
)[]
Show child fields
pipeline_details[]
Show child fields
pipeline_details[].active_input_attachment_name

The name of the active input attachment currently being ingested by this pipeline.

pipeline_details[].active_input_switch_action_name

The name of the input switch schedule action that occurred most recently and that resulted in the switch to the current input attachment for this pipeline.

pipeline_details[].active_motion_graphics_action_name

The name of the motion graphics activate action that occurred most recently and that resulted in the current graphics URI for this pipeline.

pipeline_details[].active_motion_graphics_uri

The current URI being used for HTML5 motion graphics for this pipeline.

pipeline_details[].pipeline_id

Pipeline ID

pipelines_running_count

The number of currently healthy pipelines.

BIGINT
role_arn

The Amazon Resource Name (ARN) of the role assumed when running the Channel.

VARCHAR
state

Placeholder documentation for ChannelState

VARCHAR
tags

A collection of key-value pairs.

MAP(VARCHAR, VARCHAR)
vpc

Settings for VPC output

STRUCT(
"availability_zones" VARCHAR[],
"network_interface_ids" VARCHAR[],
"security_group_ids" VARCHAR[],
"subnet_ids" VARCHAR[]
)
Show child fields
vpc.availability_zones[]
vpc.network_interface_ids[]
vpc.security_group_ids[]
vpc.subnet_ids[]