# components.schemas.ArchiveFERRequest.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.ArchiveFERRequest.properties.correlation_id.description
Correlation ID for this FER archive request

# components.schemas.ArchiveFERRequest.properties.global_query_string.description
Portion of the query string that applies to all packages

# components.schemas.ArchiveFERResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.ArchiveFERResponse.properties.correlation_id.description
Identifier that is carried through the archive request

# components.schemas.ArchiveFERResponse.properties.task_id.description
Task ID for the archive task started by the L2V service

# components.schemas.CancelTaskResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.CancelTaskResponse.properties.error.properties.location.description
Where the error occured, e.g. 'body.items[3].tags' or 'path.thing-id'

# components.schemas.Channel.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.Channel.properties.enable_byoip.description
Indicates whether the channel's transcoder needs to run in a designated IP range.

# components.schemas.Channel.properties.id.description
External Channel ID provided at channel creation time

# components.schemas.Channel.properties.ingest.description
Ingest configures inputs for the transcoder.

# components.schemas.Channel.properties.ingest.properties.slate.description
Slate configures default slating behavior.

# components.schemas.Channel.properties.ingest.properties.slate.properties.source_loss_url.description
Source loss URL defines the location of the TS file to play when no source is available. It must have one audio and one video stream. Either MPEG2 or H.264 can be used.

# components.schemas.Channel.properties.ingest.properties.source.description
Source provides a reference to the input media stream for this channel.

# components.schemas.Channel.properties.ingest.properties.source.properties.audio_sources.items.properties.license.description
License specifies how the audio in this source is licensed.

# components.schemas.Channel.properties.ingest.properties.source.properties.audio_sources.items.properties.name.description
Language fiendly name, e.g. 'English', 'Spanish'

# components.schemas.Channel.properties.ingest.properties.source.properties.captions_source.description
Closed captions source embedding. If unspecified, defaults to ATSC_A53.

# components.schemas.Channel.properties.ingest.properties.source.properties.video_source.description
Additional information about the source video stream. This is only used to configure the transcoder compute resources to account for scaling and colorspace conversion of the source input.

# components.schemas.Channel.properties.ingest.properties.source.properties.video_source.properties.dynamic_range.description
The highest dynamic range the source will ever send to the transcoder.

# components.schemas.Channel.properties.ingest.properties.source.properties.video_source.properties.max_resolution.description
The maximum resolution the source will ever send to the transcoder.

# components.schemas.Channel.properties.labels.description
Optional labels for a channel. Any included labels must be at least 1 character long, but no greater than 256 characters. The maximum number of labels is 10.

# components.schemas.Channel.properties.modified.description
Date and time the channel was last modified.

# components.schemas.Channel.properties.name.description
A friendly human-readable name for the channel. This will get displayed in user interfaces.

# components.schemas.Channel.properties.packaging.description
Packaging configures media format and content protection settings.

# components.schemas.Channel.properties.packaging.properties.packagers.description
Defines the list of packagers available for Publications.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.description
Configures how to protect packaged media segments.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.atlas.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.atlas.properties.asset_id.description
The Asset Identifier which was taken from the token entitlement service request.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.atlas.properties.company_id.description
The Identifier of the Company that this token belongs.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.atlas.properties.widevine_v0_pssh_box.description
When TRUE the KeyID is not embedded in the pssh box which sets the version to 0. Defaults to generating v1 pssh_boxes that includes the key_id

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.bulk_file.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.bulk_file.properties.iv_rotation.description
How often the IV should be rotated and how it should be created

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.common.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.common.properties.scheme_type.description
Defines the scheme that can be used with Common Encryption

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.certificates_id.description
Unique ID used for certificate settings, unique per distributor.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.content_id.description
(Optional) Content ID that identifies this channel in the CPIX service. Value is defined by the DRM system owner, and if defined will be included as part of a POST request.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.credentials_id.description
Unique ID used for credentials settings, unique per distributor.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.decryption_key_id.description
Unique ID of the decryption key to use in case the server response contains content keys encrypted. The key is unique per distirutor, and configured ahead of time by the publishing team and the CPIX service owner.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.drms.description
(Optional) DRM system keys to request. If not defined a GET request will be done, and any key returned will be handled. If defined, random kid(s) (key ids) will be generated on rotation for each DRM system, and a POST request will be done to create them.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.headers_id.description
(Optional) An identifier to a list of HTTP headers to be added to the request sent to the CPIX service.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.key_rotation.properties.interval_secs.description
Rotate keys based on the specified time interval. If Program is also provided then this time interval will only apply to media segments that are outside of program boundaries. If Program is NOT provided then only this time interval will be used to decided when to rotate keys.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.key_rotation.properties.program.description
Rotate keys on (SCTE35) program boundaries such that no two programs will be protected with the same key.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.key_rotation.properties.program_overlap_skip_encrypt.description
Do not encrypt segments that are part of more than one SCTE-35 program.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.sample_aes.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.description
Pub points where keys should be published. If multiple are specified, only one needs to succeed to consider the key successfully published.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.compression.description
Configures whether or not (and how) to compress manifests being published to the origin. If not specified, manifests will not be compressed.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.cross_playback_paths.description
Cross Playback Paths are playback paths that reference alternative content. These playback paths could reference publish points from the same publication or a completely different encoder and packager altogether. Content published to an endpoint referenced by one of these cross playback paths MUST be of the same Manifest.Type.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.do_not_monitor.description
(Optional) Specifies if this pubpoint should not be monitored by PLM.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.headers.description
Allows custom HTTP headers to be set via configuration for all HTTP requests.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.method.description
Method overrides what HTTP method to specify in requests to the Publish Point. If not specified the service will default to POST.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.playback_base_url.description
The base URL where published playlists will be able to be obtained. This is often different than the publish_base_url for CDN publishing workflows.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.playback_query_params.description
Specifies any query parameters that will be added to playback urls. Should not include the initial '?' Example: 'foo=bar&q=golang'

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.publish_base_url.description
The base URL where generated playlists will be sent/published. Each publish point requires a unique 'publish_base_url'.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.require_publish.description
Indicates which publish points must succeed for segment publishing to use the keys.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.mp2t.description
Uses MP2T format for each segments. Only one of ['mp2t', 'mp4'] may be set.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.mp2t.properties.force_unmuxed_audio.description
Forces the Video and Audio Encodings to be unmuxed when there is one audio encodings. This setting will have to be uniformed across MP2T packagers within a config. When there are two or more audio encodings, unmuxed will be used automatically.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.mp2t.properties.insert_id3_utc_time.description
If true, insert ID3 tags that include a UTC timestamp. This is a Turner/WM-specific extension.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.mp4.description
Uses MP4 format for each segments. Only one of ['mp2t', 'mp4'] may be set.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.mp4.properties.caption_placement.description
CaptionPlacement defines where caption messages should be placed in the output MP4.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.mp4.properties.insert_pssh_box.description
Insert pssh boxes generated by content protection into packaged segments. Defaults to not insert pssh boxes to the packaged segments.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.ttml.description
Only one of ['web_vtt', 'ttml'] may be set.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.web_vtt.description
Only one of ['web_vtt', 'ttml'] may be set.

# components.schemas.Channel.properties.packaging.properties.packagers.additionalProperties.properties.web_vtt.properties.file_format.description
The file format used to encapsulate the WebVTT segments.

# components.schemas.Channel.properties.publishing.description
Publishing configures playlist formats and where to send video and playlist data.

# components.schemas.Channel.properties.publishing.properties.closed_caption_streams.description
Configures how captioning information, which references CEA-608 captions embedded in video segments, is published.

# components.schemas.Channel.properties.publishing.properties.closed_caption_streams.items.properties.auto_select.description
Indicates that the client should play the captioning media selection group if the user has not indicated a user preference. If both auto_select and default are not set, the first captioning media selection group will be used.

# components.schemas.Channel.properties.publishing.properties.closed_caption_streams.items.properties.default.description
Configures the captioning media selection group that will be played if the user has not indicated a user preference. If both auto_select and default are not set, the first captioning media selection group will be used.

# components.schemas.Channel.properties.publishing.properties.closed_caption_streams.items.properties.language.description
Language code as RFC 5646, e.g. 'en' 'en-US'.

# components.schemas.Channel.properties.publishing.properties.feature_flags.description
Set of string identifiers corresponding to features that this Channel is opting in.

# components.schemas.Channel.properties.publishing.properties.live2vod.description
Live2VOD configuration used to archive the channel data, this allows clip creation after the content is no longer live.

# components.schemas.Channel.properties.publishing.properties.live2vod.properties.clear_capture.description
BETA - (Optional) Indicates whether the system should send the unpackaged segments produced from the transcoder to the L2V system for purposes of creating mp4s and/or repackaging.

# components.schemas.Channel.properties.publishing.properties.live2vod.properties.product_id.description
Product ID that VODs will be associated with in the Live2VOD system. The value of this ID is pre-configured in the Live2VOD portal.

# components.schemas.Channel.properties.publishing.properties.live2vod.properties.retention_days.description
Specifies the retention time, in days, for archived content.

# components.schemas.Channel.properties.publishing.properties.publications.description
A set of individual configurations that each can configure a specific destination and mechanism of delivery for segments and/or playlists.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.audio_encoder_ids.description
Optionally specify which audio encoders should be used for this publication. If none are specified, all audio encoders configured for the transcoder will be used.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.create_vods.description
Create VODs for all publish points in this publication. Note that Live2VOD must also be configured for the parent |Channel|.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.dash.description
DASH configures publication settings. Only one of HLS or DASH can be set.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.dash.properties.minimum_update_period_secs.description
Sets the minimumUpdatePeriod field in MPD to be this value. If set to 0 (default), segment duration is used. The value shall not exceed the 'suggested_presentation_delay_secs'.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.dash.properties.signaling_formats.description
Signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering playlists.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.dash.properties.suggested_presentation_delay_secs.description
The suggested amount of time (in seconds) the player should be behind the live stream. This value must be greater or equal to 'minimum_update_period_secs'.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.dash.properties.url_type.description
If set to 'URL_TYPE_UNDEFINED' playlist generation will use 'RELATIVE'.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.drms.description
Optionally specify which DRMs to advertise in the playlist. If specified, this must be a subset of the DRMs specified by the packager associated with this publication. If omitted or empty, all DRMs specified by the packager will be advertised. This setting can only be used for HLS playlists.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.dvr_window_secs.description
DVR window is the max sum(duration of media segments) that will be kept in a manifest at a given time in seconds. The max supported DVR window is 10 hours.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.fer_audio_encoder_ids.description
Optionally specify which audio encoders should be used when generating the FER of this Presentation, this overrides the 'audio_encoder_ids' used during the live portion. If none are specified, the 'audio_encoder_ids' field will be used.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.description
HLS configures publication settings. Only one of HLS or DASH can be set.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.properties.audio_only_variants.description
Defines how audio only variant streams are included in the master playlist, where the variant streams are defined by #EXT-X-STREAM-INF tag, the tag attributes provide information about the Stream. The INCLUDE_DEFAULT option - only the default 'audio only variant stream' is included in master playlist. This is the most common use case. INCLUDE_NONE - no audio only variant streams are included in the master playlist. INCLUDE_ALL - include all audio only variant streams in the master playlist.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.properties.gap_tags.description
Allows turning gap tags ON/OFF. When turned ON - the tag '#EXT-X-GAP' is inserted into media playlist for a missing segment. When turned OFF - Discontinuity is inserted into the playlist for missing segment(s). The default option UNDEFINED is mapped to OFF. Note: Gap tags are always inserted for the missing thumbnail segments independently of this setting

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.properties.master_publish_frequency_secs.description
How often the multi-variant playlist(s) should be published (in seconds) once a channel is started. If 0 (not provided), defaults to 1 hour. The following can also result in re-publishing of multi-variant playlists: - Configuration changes related to transcoding configuration (i.e. adding, removing, changing encoders). - Service code changes related to manifest generation.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.properties.master_url_type.description
Allows specifying url type for HLS master playlists. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.properties.media_url_type.description
Allows specifying url type for HLS media playlists. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.description
Specify which partial presentations should be used for this presentation. Partial presentations are additional master playlists that point to a subset of the parent presentation's media streams/variant playlists.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.audio_encoder_ids.description
Specify which audio encoders should be used for this presentation. If none are specified, all audio encoders configured for the parent Publication will be used.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.fer_audio_encoder_ids.description
Optionally specify which audio encoders should be used when generating the FER of this Partial Presentation, this overrides the 'audio_encoder_ids' used during the live portion. If none are specified, the 'audio_encoder_ids' field will be used. NOTE: This MUST only be used with push based manifest. Ignore this field when using Aventus Origin with Dynamic Manifests. Instead use the AudioSource.License field.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.iframe_only_encoder_ids.description
List of video encoder IDs that should have I-Frame only playlists generated for them. If no 'iframe_only_encoder_ids' are given then no I-Frame playlists will be in the Partial Presentation.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.playlist_path.description
Sub-path that will be appended onto the publish and playback base URLs of HTTP PublishPoints for published playlist files.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.thumbnail_encoder_ids.description
Specify which thumbnail encoders should be used for this presentation. If no 'thumbnail_encoder_ids' are given then no thumbnail playlists will be in the Partial Presentation.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.video_encoder_ids.description
Specify which video encoders should be used for this presentation. If none are specified, all video encoders configured for the parent Publication will be used.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.properties.pdt_on_every_segment.description
When true a #EXT-X-PROGRAM-DATE-TIME tag will be placed on every media segment in media playlists. When false, the default behavior, the PDT tag is set according to the HLS specification.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.properties.signaling_formats.description
Signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering playlists.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.hls.properties.utc_in_segment_title.description
Include a UTC timestamp (that is equivalent in value to #EXT-X-PROGRAM-DATE-TIME) in the title of each media segment in media playlists. Ex. #EXTINF:6.006,LTC=2020-01-01T12:00:00.000Z

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.iframe_only_encoder_ids.description
List of video encoder IDs that should have I-Frame only playlists generated for them.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.master_playlist_name.description
Optional master manifest name. When not supplied a default of 'master' will be used.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.description
Configures defaults used when generating manifests or playlist using the dynamic origin. Cannot be set if this is a playlist-only publication (i.e. contains publish points that specify 'playlist_only_for').

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.description
FallbackDefaults specifies the alternative behavior of the dynamic manifest generator. This behavior is intended to be a simplified configuration comparead to the default behavior so that it can be used as a fallback for when players are encountering issues with the default behavior. Specific behaviors can be overwritten using appropriate query string parameters when making the request for the manifest.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.dash_signaling_formats.description
DASH Signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering DASH manifests.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.duration_seconds.description
Duration is the length of content that will be included in the manifest, in seconds. The max supported DVR window is 12 hours. If not specified, the default duration will be 30 seconds.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.hls_signaling_formats.description
HLS signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering playlists.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.media_url_type.description
Allows specifying url type for HLS media playlists and DASH manifests. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.minimum_update_period_seconds.description
Sets the minimumUpdatePeriod field in MPD to be this value. If set to 0 (default), segment duration is used. The value shall not exceed the 'suggested_presentation_delay_secs'.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.multi_variant_url_type.description
Allows specifying url type for HLS multi-variant playlists. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.pdt_on_every_segment.description
When true a #EXT-X-PROGRAM-DATE-TIME tag will be placed on every media segment in HLS media playlists. When false, the default behavior, the PDT tag is set according to the HLS specification.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.pre_start_duration_seconds.description
Pre Start Duration is the length of content that will be included in the manifest when the start time of a manifest is in the future. When a manifest is near the start time but does not contain 'pre_start_duration_seconds' content Manifest Origin will keep content before the start time to make the manifest length at least 'pre_start_duration_seconds'. If not specified requesting a manifest in the future will result in a 404.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.suggested_presentation_delay_seconds.description
Sets the suggestedPresentationDelay field in MPD to be this value. This value must be greater or equal to 'minimum_update_period_secs'. If unset, the default value will be calculated as 3 * segment target duration.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.description
ManifestDefaults specifies the default behavior of the dynamic manifest generator. Specific behaviors can be overwritten using appropriate query string parameters when making the request for the manifest.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.dash_signaling_formats.description
DASH Signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering DASH manifests.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.duration_seconds.description
Duration is the length of content that will be included in the manifest, in seconds. The max supported DVR window is 12 hours. If not specified, the default duration will be 30 seconds.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.hls_signaling_formats.description
HLS signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering playlists.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.media_url_type.description
Allows specifying url type for HLS media playlists and DASH manifests. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.minimum_update_period_seconds.description
Sets the minimumUpdatePeriod field in MPD to be this value. If set to 0 (default), segment duration is used. The value shall not exceed the 'suggested_presentation_delay_secs'.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.multi_variant_url_type.description
Allows specifying url type for HLS multi-variant playlists. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.pdt_on_every_segment.description
When true a #EXT-X-PROGRAM-DATE-TIME tag will be placed on every media segment in HLS media playlists. When false, the default behavior, the PDT tag is set according to the HLS specification.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.pre_start_duration_seconds.description
Pre Start Duration is the length of content that will be included in the manifest when the start time of a manifest is in the future. When a manifest is near the start time but does not contain 'pre_start_duration_seconds' content Manifest Origin will keep content before the start time to make the manifest length at least 'pre_start_duration_seconds'. If not specified requesting a manifest in the future will result in a 404.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.suggested_presentation_delay_seconds.description
Sets the suggestedPresentationDelay field in MPD to be this value. This value must be greater or equal to 'minimum_update_period_secs'. If unset, the default value will be calculated as 3 * segment target duration.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.origin.properties.retention_minutes.description
RetentionMinutes specifies how long data is retained, in minutes. Live linear (24/7) channels should set this to the longest expected DVR window (a few hours). Live event channels should set this to how Live2VOD playlists are expected to be available. If unspecified, the default will be 60 minutes. The maximum value is 15 days (21600 minutes).

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.packager_id.description
Determines how segments in this publication are packaged. Must reference a packager in 'packaging.packagers'. However, if this is a playlist-only publication (i.e. contains publish points that specify 'playlist_only_for'), this must remain unset as the packager will be inferred from the publication this one is providing playlists for.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.description
HTTP destination where media segments and playlists will be published.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.compression.description
Configures whether or not (and how) to compress manifests being published to the origin. If not specified, manifests will not be compressed.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.cross_playback_paths.description
Cross Playback Paths are playback paths that reference alternative content. These playback paths could reference publish points from the same publication or a completely different encoder and packager altogether. Content published to an endpoint referenced by one of these cross playback paths MUST be of the same Manifest.Type.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.do_not_monitor.description
(Optional) Specifies if this pubpoint should not be monitored by PLM.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.headers.description
Allows custom HTTP headers to be set via configuration for all HTTP requests.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.method.description
Method overrides what HTTP method to specify in requests to the Publish Point. If not specified the service will default to POST.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.playback_base_url.description
The base URL where published playlists will be able to be obtained. This is often different than the publish_base_url for CDN publishing workflows.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.playback_query_params.description
Specifies any query parameters that will be added to playback urls. Should not include the initial '?' Example: 'foo=bar&q=golang'

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.publish_base_url.description
The base URL where generated playlists will be sent/published. Each publish point requires a unique 'publish_base_url'.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.publish_points.items.properties.id.description
uniquely identifies this publish_point within a channel configuration. Can be referenced by other publish_points in the 'playlist_only_for' field.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.publish_points.items.properties.playlist_only_for.description
playlist_only_for identifies the id of the publish_point that has the segments for this publish_point, which is only publishing a playlist for those segments. All publish_points within a publication must either have 'playlist_only_for' all set or all not set.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.redundant_publishing.description
When redundant publishing is enabled succeeding to publish a given media segment to at least one HTTPPublishPoint in publish_points will result in that segment showing up in manifests as playable content. Will require at least two publish_points defined within the same publication.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.startover.description
Configures startover processing for this Publication.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.startover.properties.first_program_start.description
Trigger Startover on the first Program Start. Only one of ['first_program_start', 'on_airing_id'] may be set.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.startover.properties.on_airing_id.description
Use the Airing Id of a Program Start to trigger a Startover on the first match. Only one of ['first_program_start', 'on_airing_id'] may be set.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.startover.properties.on_airing_id.properties.airing_id.description
Airing Id is a SCTE-35 Segmentation Unique Program ID (UPID) of type 0x08 used to specify the unique airing of a program. Is a 8 byte hex encoded string that is prepended with '0x'.

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.thumbnail_encoder_ids.description
Optional: Specify what thumbnail_encoders should be in this Publication

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.use_strict_bitrate.description
Optional, indicates whether we should pad the bitrate (false) or use what is explicitly provided (true)

# components.schemas.Channel.properties.publishing.properties.publications.items.properties.video_encoder_ids.description
Optionally specify which video encoders should be used for this publication. If none are specified, all video encoders configured for the transcoder will be used.

# components.schemas.Channel.properties.publishing.properties.rtmp_publications.description
A set of configurations for delivering RTMP streams

# components.schemas.Channel.properties.publishing.properties.srt_publications.description
A set of configurations for delivering SRT streams

# components.schemas.Channel.properties.publishing.properties.srt_publications.items.properties.audio_encoders.items.properties.pid.description
Output MPEG-TS PID. PIDs should be set on the PMT, SCTE-35 and all encoders or none. Valid PIDs must 13-bit values greater than 31. If no PIDs are provided (pid == 0) then they will be generated automatically.

# components.schemas.Channel.properties.publishing.properties.srt_publications.items.properties.pmt_pid.description
MPEG-TS PMT PID. PIDs should be set on the PMT, SCTE-35 and all encoders or none. Valid PIDs must 13-bit values greater than 31. If no PIDs are provided (pid == 0) then they will be generated automatically.

# components.schemas.Channel.properties.publishing.properties.srt_publications.items.properties.scte35_pid.description
MPEG-TS SCTE-35 PID. PIDs should be set on the PMT, SCTE-35, and all encoders or none. Valid PIDs must 13-bit values greater than 31. If no PIDs are provided (pid == 0) then they will be generated automatically.

# components.schemas.Channel.properties.publishing.properties.srt_publications.items.properties.video_encoders.items.properties.pid.description
Output MPEG-TS PID. PIDs should be set on the PMT, SCTE-35 and all encoders or none. Valid PIDs must 13-bit values greater than 31. If no PIDs are provided (pid == 0) then they will be generated automatically.

# components.schemas.Channel.properties.region.description
Region represents the general geolocation for transcoding and stream egress from iStreamPlanet. If no region is provided at channel creation time, then 'US_WEST' is used.

# components.schemas.Channel.properties.resource_class.description
If the ResourceClass is unspecified the channel will default to run in the 'DYNAMIC' ResourceClass. Note that changing the ResourceClass for a running channel is supported and will be performed with no downtime.

# components.schemas.Channel.properties.signaling.description
Signaling configures in-band signaling (i.e. SCTE-35).

# components.schemas.Channel.properties.signaling.properties.blackout_settings.description
Configure blackout: replacing content with custom slates based on program signaling.

# components.schemas.Channel.properties.signaling.properties.blackout_settings.properties.default_blackout_slate_url.description
Default slate URL to use for blackouts. Can be overridden by the 'slates' field.

# components.schemas.Channel.properties.signaling.properties.blackout_settings.properties.force_blackout_segments.description
List of signaling segment types to force blackout, e.g. add 'SPLICE_INSERT' to blackout all ads signaled via SCTE-35 splice_insert.

# components.schemas.Channel.properties.signaling.properties.blackout_settings.properties.honor_web_delivery_restriction.description
Determines whether to honor the web_delivery_allowed attribute in SCTE-35 segmentation descriptors. When this is enabled, a segmentation descriptor with web_delivery_allowed=false will trigger a blackout.

# components.schemas.Channel.properties.signaling.properties.blackout_settings.properties.slates.items.properties.blackout_slate_url.description
Blackout slate URL to use for the specified segments. It must have one audio and one video stream. Either MPEG2 or H.264 can be used.

# components.schemas.Channel.properties.signaling.properties.blackout_settings.properties.slates.items.properties.segments.description
Segment types that shall utilize the blackout slate URL. Any segment type defined here _must_ also be present in the parent signaling configuration.

# components.schemas.Channel.properties.signaling.properties.blackout_settings.properties.slates.items.properties.upids.description
Exclusive list of hex string encoded colon separated UPID Type:ID pairs (e.g. '0A:1A2B3C4D') to enable this blackout slate on.

# components.schemas.Channel.properties.signaling.properties.disable_inband_parsing.description
Disable parsing SCTE-35 in-band signaling. Out-of-band signaling is still allowed.

# components.schemas.Channel.properties.signaling.properties.scte_pid.description
Defines the specific PID containing the SCTE that the transcoder should process. Using '0' (default value) will pick the first PID containing SCTE-35 in the PMT.

# components.schemas.Channel.properties.signaling.properties.segment_settings.description
Settings that apply to specific segments.

# components.schemas.Channel.properties.signaling.properties.segment_settings.items.properties.default_duration_secs.description
Specifies the duration of a segment when the in-band SCTE-35 that initiates it (e.g. Distributor Placement Opportunity Start) is missing an explicit duration. N.B. for program and ad types, this also affects 'Simple Program' and 'Simple Ad' markers, respectively.

# components.schemas.Channel.properties.signaling.properties.segment_settings.items.properties.emit_default_duration.description
Determines whether to include the default duration in the output SCTE-35 messages when the input SCTE-35 message did not specify a duration.

# components.schemas.Channel.properties.signaling.properties.segment_settings.items.properties.offset_millis.description
Specifies a 'correction' to the splice_time of in-band SCTE-35 in milliseconds.

# components.schemas.Channel.properties.signaling.properties.segment_settings.items.properties.segment_end_mode.description
Determines which Segment End signaling mode to use for the provided segments. If unspecified, defaults to MATCH_END_EVENT_ID.

# components.schemas.Channel.properties.signaling.properties.segment_settings.items.properties.segments.description
Specifies the list of which segment types this setting applies to. Any segment type defined here _must_ also be present in the parent signaling configuration.

# components.schemas.Channel.properties.signaling.properties.segment_settings.items.properties.tier_filter.description
Specifies how to filter the provided segments, when received through in-band SCTE-35, based on the SCTE-35 SpliceInfoSection Tier.

# components.schemas.Channel.properties.signaling.properties.segment_settings.items.properties.tier_filter.properties.explicit_tier.description
Only one of ['explicit_tier'] may be set.

# components.schemas.Channel.properties.signaling.properties.segments.description
Segment types to process for in-band signaling.

# components.schemas.Channel.properties.tags.description
Use ChannelMetadata when possible instead of tags.

# components.schemas.Channel.properties.tags.properties.monitored.description
Indicates whether this channel is monitored by automation.

# components.schemas.Channel.properties.transcode.properties.audio_encoders.description
Audio encoders specify audio conversion settings, e.g. channels, samples, codec, bitrate, etc.

# components.schemas.Channel.properties.transcode.properties.audio_encoders.items.properties.audio_source_id.description
Audio source ID specifies which stream within the audio source to use.

# components.schemas.Channel.properties.transcode.properties.audio_encoders.items.properties.bit_rate.description
Bit rate specifies the constant number of bits used per second. Higher values result in better audio quality but bigger file sizes.

# components.schemas.Channel.properties.transcode.properties.audio_encoders.items.properties.channels.description
Channels specifies the number of real audio channels to encode. The available options depend on the audio codec. The encoder supports different channel configurations based on the codec; AAC 1-2 channels, AC3 supports 2 or 6, and EAC3 supports 2 or 6. For example, for AC3 5.1 one would set 6 channels. Channel configurations are as follows: 1 - Mono (C) 2 - Stereo / Dolby 2.0 (L, R) 6 - Dolby 5.1 (L, C, R, l, r, LFE) Dolby Atmos layouts such as 5.1.4 are achieved by setting this field to 6 and configuring ddp_joc_logical_channels in EAC3Settings as desired.

# components.schemas.Channel.properties.transcode.properties.audio_encoders.items.properties.codec.description
Codec specifies the audio data encoding format.

# components.schemas.Channel.properties.transcode.properties.audio_encoders.items.properties.eac3.properties.ddp_joc_logical_channels.description
If non-zero, configures the encoder to compute JOC metadata (i.e. Dolby Atmos) for the given logical speaker layout. The transcoder does not guarantee any particular bed layout in the JOC metadata, and this setting currently has no effect on that. It merely determines the channel layout to which all inputs are converted before encoding. Legal values are: 8 - 5.1.2 10 - 5.1.4 For sources with raw PCM input and more than 6 channels, configure this according to the expected input channel layout. For channels which expect to take a 7.1 EAC-3 input, configure to 8. For all other cases, including upmixing from 5.1 or fewer channels or any kind of Atmos input, configure to 10. This setting is mutually exclusive with ddp_joc_passthrough. This setting has no effect on the current production version of the transcoder, nor does the current production version of the transcoder support raw PCM inputs.

# components.schemas.Channel.properties.transcode.properties.audio_encoders.items.properties.eac3.properties.ddp_joc_passthrough.description
Indicates that the source will contain Joint Object Coding metadata (Dolby Atmos) and that the encoder should operate in passthrough mode. https://learning.dolby.com/hc/en-us/articles/4406039180564-Appendix-C-Dolby-Atmos-Delivery-Codecs- When the audio encoder is configured with this setting, the source audio will be repackaged without being decoded and re-encoded. If the source is not DD+JOC, it will be replaced with silence.

# components.schemas.Channel.properties.transcode.properties.audio_encoders.items.properties.eac3.properties.drc_line_mode.description
If specified, overrides the dynamic range control line mode. If unspecified and the source audio is AC-3 or EAC-3, the DRC line mode matches the input. If unspecified and the source audio is any other codec, the encoder uses an unspecified default which may change without notice. This setting has no effect on transcoder versions which do not support Atmos encoding.

# components.schemas.Channel.properties.transcode.properties.audio_encoders.items.properties.eac3.properties.drc_rf_mode.description
If specified, overrides the dynamic range control RF mode. If unspecified and the source audio is AC-3 or EAC-3, the DRC RF mode matches the input. If unspecified and the source audio is any other codec, the encoder uses an unspecified default which may change without notice. This setting has no effect on transcoder versions which do not support Atmos encoding.

# components.schemas.Channel.properties.transcode.properties.audio_encoders.items.properties.eac3.properties.surround_phase_shift.description
If specified, overrides whether surround phase shift is enabled. If unspecified and the source audio is AC-3 or EAC-3, the surround phase shift mode matches the input. If unspecified and the source audio is any other codec, the encoder uses an unspecified default which may change without notice. This setting has no effect on transcoder versions which do not support Atmos encoding.

# components.schemas.Channel.properties.transcode.properties.audio_encoders.items.properties.id.description
Encoder ID. IDs must be unique for all encoders. This ID is referenced when setting up playlist publishing.

# components.schemas.Channel.properties.transcode.properties.audio_encoders.items.properties.loudness.description
Loudness normalization settings. Loudness configuration is required for non-passthrough AC-3 and EAC-3.

# components.schemas.Channel.properties.transcode.properties.audio_encoders.items.properties.loudness.properties.dialog_intel.description
Enable Dialog Intelligence. Only supported for (E)AC-3 encoders. This may only be set if lkfs is explicitly configured to -24.

# components.schemas.Channel.properties.transcode.properties.audio_encoders.items.properties.loudness.properties.lkfs.description
Loudness normalization LKFS setting. Default value is -24.

# components.schemas.Channel.properties.transcode.properties.audio_encoders.items.properties.loudness.properties.peak_limit.description
Peak Limit. The only allowable value is -2.0. This field is soft-deprecated and will be unsupported in a future transcoder version. In the current transcoder version, the values 0.0 and -2.0 both produce the same configuration.

# components.schemas.Channel.properties.transcode.properties.debug_overlay.description
Deprecated: Do not use. Debug_overlay overlays debugging information from the transcoder into the top right of the video output. The overlay is burned into the video and will be visible to end-users if enabled. Do not enable on customer facing channels. Requires a transcoder restart if the state is changed. The default value is false, which disables the overlay. This setting is deprecated in favour of debug_overlays.

# components.schemas.Channel.properties.transcode.properties.debug_overlays.description
The debug_overlays specifies the position of the debugging overlay information from the transcoder into each video output. The overlay is burned into the video and will be visible to end-users if enabled. The default position value is OFF, which results in no debug overlay. Do not enable on customer facing channels. Requires a transcoder restart if the state is changed.

# components.schemas.Channel.properties.transcode.properties.debug_overlays.properties.position.description
Position of the debug overlay within the output frame.

# components.schemas.Channel.properties.transcode.properties.feature_flags.description
Feature flag strings enable experimental transcode features or functionality that are not yet or never will be promoted to the channeldoc model proper. Do not enable on customer facing channels.

# components.schemas.Channel.properties.transcode.properties.id3_mode.description
Specify how to process ID3 tags from the input source. If not specified, ID3 tags in the source will be ignored.

# components.schemas.Channel.properties.transcode.properties.overlays.description
List of overlays. An overlay is an image that will be rendered on top of the source video. Only one overlay is supported at the moment. If specified, the overlay will be always rendered unless a video slate is on.

# components.schemas.Channel.properties.transcode.properties.overlays.items.properties.image_url.description
The URL of the image overlay. Only PNG is supported at the moment. The image's dimensions should match those of source for perfect pixel placement.

# components.schemas.Channel.properties.transcode.properties.resize_mode.description
Resize mode specifies how to scale a video up or down to match the output dimensions.

# components.schemas.Channel.properties.transcode.properties.segmenter.description
Segmenter configures how video GOPs and segments get generated.

# components.schemas.Channel.properties.transcode.properties.segmenter.properties.gop_duration_secs.description
GOP (group of pictures) duration specifies the amount of time between I-frames. Shorter durations can lower quality slightly as each I-frame uses more bits than P- & B-frames but can provide a better seeking experience when enabling thumbnail encoders and/or I-Frame Only playlists.

# components.schemas.Channel.properties.transcode.properties.segmenter.properties.segment_duration_secs.description
Segment duration specifies the target duration of a single segment. Segments shorter than this duration can occur at signaling boundaries. This value _must_ be a multiple of the GOP duration value.

# components.schemas.Channel.properties.transcode.properties.segmenter.properties.temi.description
Include TEMI (Timeline and External Media Information ISO/IEC 13818-1:2019 Annex U) to mpeg-ts segments.

# components.schemas.Channel.properties.transcode.properties.subtitle_encoders.description
Subtitle encoders specify how text-based subtitles are extracted into separate segments. They are not used to describe CEA 608 captions, which remain part of the video codec.

# components.schemas.Channel.properties.transcode.properties.subtitle_encoders.items.properties.atsc_captions.description
Extract subtitles from the ATSC caption encodings. The captions themselves are first sourced according to the Source.captions_source field. Only one of ['teletext', 'atsc_captions'] may be set.

# components.schemas.Channel.properties.transcode.properties.subtitle_encoders.items.properties.atsc_captions.properties.cea608.description
If non-zero, decode captions from the CEA-608 logical channel number identified by this number. If zero, only CTA-708 captions will be decoded. The 'logical channel number' refers to the CCx name commonly used in literature: - CC1 is the NTSC odd field subchannel 1, considered the primary caption stream. - CC2 is the NTSC odd field subchannel 2, considered the tertiary caption stream. - CC3 is the NTSC even field subchannel 1, considered the secondary caption stream. - CC4 is the NTSC even field subchannel 2, considered the quaternary caption stream.

# components.schemas.Channel.properties.transcode.properties.subtitle_encoders.items.properties.atsc_captions.properties.cta708.description
If non-zero, decode captions from the CTA-708 service identified by this number. If zero, only CEA-608 captions will be decoded. It is allowed to set both 'cta708' and 'cea608'. In this case, the transcoder will decode both streams, and will use the CTA-708 data if the stream is active and fall back to CEA-608 otherwise. Fallback from CTA-708 to CEA-608 requires a timeout to elapse, but switching from CEA-608 to CTA-708 occurs the instant the CTA-708 stream becomes active. CTA-708 recommends the following correspondence between the two encodings: - CTA-708 service 1 == CEA-608 CC1 (primary captions) - CTA-708 service 2 == CEA-608 CC3 (secondary captions) - CTA-708 service 3 == CEA-608 CC2 (tertiary captions) - CTA-708 service 4 == CEA-608 CC4 (quaternary captions) However, some sources use an alternate convention where CTA-708 service 3 is the secondary caption service (corresponding to CC3) and CTA-708 service 2 is the tertiary caption service.

# components.schemas.Channel.properties.transcode.properties.subtitle_encoders.items.properties.id.description
Encoder ID. IDs must be unique for all encoders. This ID is referenced when setting up playlist publishing.

# components.schemas.Channel.properties.transcode.properties.subtitle_encoders.items.properties.language.description
Language is the code for the language in which the subtitles are written.

# components.schemas.Channel.properties.transcode.properties.subtitle_encoders.items.properties.teletext.description
Extract subtitles from an embedded Teletext stream. The teletext PID is determined automatically. Only one of ['teletext', 'atsc_captions'] may be set.

# components.schemas.Channel.properties.transcode.properties.subtitle_encoders.items.properties.teletext.properties.charset_set.description
If set, forces interpretation of the National Option field to choose from character sets in this specific set of character sets. Determining the correct value for this configuration is non-trivial, but there are some guidelines. Usually, all languages in one Teletext stream will use the same charset set. If only one set can handle all the languages, it's probably that one. Some of the sets roughly correspond to geopolitical divisions from the Cold War era: SET3 is roughly Yugoslavia plus Romania; SET4 is the rest of the former USSR/Warsaw Pact, including East Germany but excluding Poland; SET8 is Africa; SET10 is the Middle East. There does not seem to be any standard name for this configuration. The standard calls it 'the upper four bits of Triplet 1', which is highly ambiguous and nonsensical outside of the context of that usage. The decoder ffmpeg uses calls it 'region', but most of the sets cannot cleanly be described as any particular geographic region.

# components.schemas.Channel.properties.transcode.properties.subtitle_encoders.items.properties.teletext.properties.language.description
The three-letter language code declared in the Teletext descriptor in the source PMT. If the language is not found, the subtitles will be empty. language + type configuration is mutually exclusive with magazine + page configuration.

# components.schemas.Channel.properties.transcode.properties.subtitle_encoders.items.properties.teletext.properties.magazine.description
The teletext magazine number where the subtitles are found. magazine + page configuration is mutually exclusive with language + type configuration.

# components.schemas.Channel.properties.transcode.properties.subtitle_encoders.items.properties.teletext.properties.page.description
The teletext page number where the subtitles are found. magazine + page configuration is mutually exclusive with language + type configuration.

# components.schemas.Channel.properties.transcode.properties.subtitle_encoders.items.properties.teletext.properties.page_type.description
The Teletext page type declared in the Teletext descriptor in the source PMT. If this field is unset, it will be inferred from the 'usage' field on the SubtitleEncoder using this table: SubtitleEncoder.CLOSED_CAPTIONS => TeletextSource.PAGE_TYPE_SUBTITLE_HEARING_IMPAIRED SubtitleEncoder.SUBTITLES => TeletextSource.PAGE_TYPE_SUBTITLE

# components.schemas.Channel.properties.transcode.properties.subtitle_encoders.items.properties.usage.description
Usage indicates how this encoder should be flagged in generated manifests.

# components.schemas.Channel.properties.transcode.properties.thumbnail_encoders.description
Thumbnail encoders specify how to create image snapshots of the video stream.

# components.schemas.Channel.properties.transcode.properties.thumbnail_encoders.items.properties.height.description
Height specifies the thumbnail image height in pixels.

# components.schemas.Channel.properties.transcode.properties.thumbnail_encoders.items.properties.id.description
Encoder ID. IDs must be unique for all encoders. This ID is referenced when setting up playlist publishing.

# components.schemas.Channel.properties.transcode.properties.thumbnail_encoders.items.properties.width.description
Width specifies the thumbnail image width in pixels.

# components.schemas.Channel.properties.transcode.properties.video_encoders.description
Video encoders specify video conversion settings, e.g. dimensions, codec, bitrate, etc.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.bit_rate.description
Bit rate specifies the number in bits used per second. Higher values result in better video quality but bigger file sizes. For H.264 this value is the target of the constrained variable bit rate.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.frame_rate.description
Frame rate specifies the number of images that are shown per second when playing back the video. For the best quality playback, this should match or be a multiple of the input source video stream.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h264.description
Configure the encoder to use the H.264 codec. Only one of ['H264Settings', 'H265Settings'] may be set.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h264.properties.profile.description
H.264 video profile, which defines various encoder features and settings. See https://en.wikipedia.org/wiki/Advanced_Video_Coding#Profiles for details.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h265.description
Configure the encoder to use the H.265 codec. Only one of ['H264Settings', 'H265Settings'] may be set.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.description
Only one of ['hdr10', 'dolby_vision'] may be set.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile5.description
Only one of ['profile5', 'profile81', 'profile84'] may be set.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile81.description
Only one of ['profile5', 'profile81', 'profile84'] may be set.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile81.properties.clli.properties.max_fall.description
Maximum Frame-Average Light Level (nits).

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile81.properties.mdcv.properties.color_profile.description
Identifies color primaries and white point.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile81.properties.mdcv.properties.max_dml.description
Maximum display mastering luminance (nits). Must be greater than min_dml.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile81.properties.mdcv.properties.min_dml.description
Minimum display mastering luminance (nits).

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile84.description
Only one of ['profile5', 'profile81', 'profile84'] may be set.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.hdr10.description
Only one of ['hdr10', 'dolby_vision'] may be set.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.hdr10.properties.clli.properties.max_fall.description
Maximum Frame-Average Light Level (nits).

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.hdr10.properties.mdcv.properties.color_profile.description
Identifies color primaries and white point.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.hdr10.properties.mdcv.properties.max_dml.description
Maximum display mastering luminance (nits). Must be greater than min_dml.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.hdr10.properties.mdcv.properties.min_dml.description
Minimum display mastering luminance (nits).

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.height.description
Height specifies the video height in pixels. Must be a multiple of two. Valid resolution ranges, width x height are: H.264: 2x2 to 1920x1080 H.265: 130x34 to 3840x2160

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.id.description
Encoder ID. IDs must be unique for all encoders. This ID is referenced when setting up playlist publishing.

# components.schemas.Channel.properties.transcode.properties.video_encoders.items.properties.width.description
Width specifies the video width in pixels. Must be a multiple of two. Valid resolution ranges, width x height are: H.264: 2x2 to 1920x1080 H.265: 130x34 to 3840x2160

# components.schemas.ChannelPlayback.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.atlas.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.atlas.properties.asset_id.description
The Asset Identifier which was taken from the token entitlement service request.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.atlas.properties.company_id.description
The Identifier of the Company that this token belongs.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.atlas.properties.widevine_v0_pssh_box.description
When TRUE the KeyID is not embedded in the pssh box which sets the version to 0. Defaults to generating v1 pssh_boxes that includes the key_id

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.bulk_file.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.bulk_file.properties.iv_rotation.description
How often the IV should be rotated and how it should be created

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.common.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.common.properties.scheme_type.description
Defines the scheme that can be used with Common Encryption

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.cpix.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.cpix.properties.certificates_id.description
Unique ID used for certificate settings, unique per distributor.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.cpix.properties.content_id.description
(Optional) Content ID that identifies this channel in the CPIX service. Value is defined by the DRM system owner, and if defined will be included as part of a POST request.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.cpix.properties.credentials_id.description
Unique ID used for credentials settings, unique per distributor.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.cpix.properties.decryption_key_id.description
Unique ID of the decryption key to use in case the server response contains content keys encrypted. The key is unique per distirutor, and configured ahead of time by the publishing team and the CPIX service owner.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.cpix.properties.drms.description
(Optional) DRM system keys to request. If not defined a GET request will be done, and any key returned will be handled. If defined, random kid(s) (key ids) will be generated on rotation for each DRM system, and a POST request will be done to create them.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.cpix.properties.headers_id.description
(Optional) An identifier to a list of HTTP headers to be added to the request sent to the CPIX service.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.key_rotation.properties.interval_secs.description
Rotate keys based on the specified time interval. If Program is also provided then this time interval will only apply to media segments that are outside of program boundaries. If Program is NOT provided then only this time interval will be used to decided when to rotate keys.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.key_rotation.properties.program.description
Rotate keys on (SCTE35) program boundaries such that no two programs will be protected with the same key.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.key_rotation.properties.program_overlap_skip_encrypt.description
Do not encrypt segments that are part of more than one SCTE-35 program.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.sample_aes.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.simple.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.simple.properties.publish_points.description
Pub points where keys should be published. If multiple are specified, only one needs to succeed to consider the key successfully published.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.compression.description
Configures whether or not (and how) to compress manifests being published to the origin. If not specified, manifests will not be compressed.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.cross_playback_paths.description
Cross Playback Paths are playback paths that reference alternative content. These playback paths could reference publish points from the same publication or a completely different encoder and packager altogether. Content published to an endpoint referenced by one of these cross playback paths MUST be of the same Manifest.Type.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.do_not_monitor.description
(Optional) Specifies if this pubpoint should not be monitored by PLM.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.headers.description
Allows custom HTTP headers to be set via configuration for all HTTP requests.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.method.description
Method overrides what HTTP method to specify in requests to the Publish Point. If not specified the service will default to POST.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.playback_base_url.description
The base URL where published playlists will be able to be obtained. This is often different than the publish_base_url for CDN publishing workflows.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.playback_query_params.description
Specifies any query parameters that will be added to playback urls. Should not include the initial '?' Example: 'foo=bar&q=golang'

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.publish_base_url.description
The base URL where generated playlists will be sent/published. Each publish point requires a unique 'publish_base_url'.

# components.schemas.ChannelPlayback.properties.cmaf.items.properties.content_protection.properties.simple.properties.require_publish.description
Indicates which publish points must succeed for segment publishing to use the keys.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.atlas.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.atlas.properties.asset_id.description
The Asset Identifier which was taken from the token entitlement service request.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.atlas.properties.company_id.description
The Identifier of the Company that this token belongs.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.atlas.properties.widevine_v0_pssh_box.description
When TRUE the KeyID is not embedded in the pssh box which sets the version to 0. Defaults to generating v1 pssh_boxes that includes the key_id

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.bulk_file.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.bulk_file.properties.iv_rotation.description
How often the IV should be rotated and how it should be created

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.common.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.common.properties.scheme_type.description
Defines the scheme that can be used with Common Encryption

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.cpix.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.cpix.properties.certificates_id.description
Unique ID used for certificate settings, unique per distributor.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.cpix.properties.content_id.description
(Optional) Content ID that identifies this channel in the CPIX service. Value is defined by the DRM system owner, and if defined will be included as part of a POST request.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.cpix.properties.credentials_id.description
Unique ID used for credentials settings, unique per distributor.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.cpix.properties.decryption_key_id.description
Unique ID of the decryption key to use in case the server response contains content keys encrypted. The key is unique per distirutor, and configured ahead of time by the publishing team and the CPIX service owner.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.cpix.properties.drms.description
(Optional) DRM system keys to request. If not defined a GET request will be done, and any key returned will be handled. If defined, random kid(s) (key ids) will be generated on rotation for each DRM system, and a POST request will be done to create them.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.cpix.properties.headers_id.description
(Optional) An identifier to a list of HTTP headers to be added to the request sent to the CPIX service.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.key_rotation.properties.interval_secs.description
Rotate keys based on the specified time interval. If Program is also provided then this time interval will only apply to media segments that are outside of program boundaries. If Program is NOT provided then only this time interval will be used to decided when to rotate keys.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.key_rotation.properties.program.description
Rotate keys on (SCTE35) program boundaries such that no two programs will be protected with the same key.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.key_rotation.properties.program_overlap_skip_encrypt.description
Do not encrypt segments that are part of more than one SCTE-35 program.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.sample_aes.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.simple.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.simple.properties.publish_points.description
Pub points where keys should be published. If multiple are specified, only one needs to succeed to consider the key successfully published.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.compression.description
Configures whether or not (and how) to compress manifests being published to the origin. If not specified, manifests will not be compressed.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.cross_playback_paths.description
Cross Playback Paths are playback paths that reference alternative content. These playback paths could reference publish points from the same publication or a completely different encoder and packager altogether. Content published to an endpoint referenced by one of these cross playback paths MUST be of the same Manifest.Type.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.do_not_monitor.description
(Optional) Specifies if this pubpoint should not be monitored by PLM.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.headers.description
Allows custom HTTP headers to be set via configuration for all HTTP requests.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.method.description
Method overrides what HTTP method to specify in requests to the Publish Point. If not specified the service will default to POST.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.playback_base_url.description
The base URL where published playlists will be able to be obtained. This is often different than the publish_base_url for CDN publishing workflows.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.playback_query_params.description
Specifies any query parameters that will be added to playback urls. Should not include the initial '?' Example: 'foo=bar&q=golang'

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.publish_base_url.description
The base URL where generated playlists will be sent/published. Each publish point requires a unique 'publish_base_url'.

# components.schemas.ChannelPlayback.properties.dash.items.properties.content_protection.properties.simple.properties.require_publish.description
Indicates which publish points must succeed for segment publishing to use the keys.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.atlas.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.atlas.properties.asset_id.description
The Asset Identifier which was taken from the token entitlement service request.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.atlas.properties.company_id.description
The Identifier of the Company that this token belongs.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.atlas.properties.widevine_v0_pssh_box.description
When TRUE the KeyID is not embedded in the pssh box which sets the version to 0. Defaults to generating v1 pssh_boxes that includes the key_id

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.bulk_file.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.bulk_file.properties.iv_rotation.description
How often the IV should be rotated and how it should be created

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.common.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.common.properties.scheme_type.description
Defines the scheme that can be used with Common Encryption

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.cpix.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.cpix.properties.certificates_id.description
Unique ID used for certificate settings, unique per distributor.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.cpix.properties.content_id.description
(Optional) Content ID that identifies this channel in the CPIX service. Value is defined by the DRM system owner, and if defined will be included as part of a POST request.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.cpix.properties.credentials_id.description
Unique ID used for credentials settings, unique per distributor.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.cpix.properties.decryption_key_id.description
Unique ID of the decryption key to use in case the server response contains content keys encrypted. The key is unique per distirutor, and configured ahead of time by the publishing team and the CPIX service owner.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.cpix.properties.drms.description
(Optional) DRM system keys to request. If not defined a GET request will be done, and any key returned will be handled. If defined, random kid(s) (key ids) will be generated on rotation for each DRM system, and a POST request will be done to create them.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.cpix.properties.headers_id.description
(Optional) An identifier to a list of HTTP headers to be added to the request sent to the CPIX service.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.key_rotation.properties.interval_secs.description
Rotate keys based on the specified time interval. If Program is also provided then this time interval will only apply to media segments that are outside of program boundaries. If Program is NOT provided then only this time interval will be used to decided when to rotate keys.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.key_rotation.properties.program.description
Rotate keys on (SCTE35) program boundaries such that no two programs will be protected with the same key.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.key_rotation.properties.program_overlap_skip_encrypt.description
Do not encrypt segments that are part of more than one SCTE-35 program.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.sample_aes.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.simple.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.simple.properties.publish_points.description
Pub points where keys should be published. If multiple are specified, only one needs to succeed to consider the key successfully published.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.compression.description
Configures whether or not (and how) to compress manifests being published to the origin. If not specified, manifests will not be compressed.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.cross_playback_paths.description
Cross Playback Paths are playback paths that reference alternative content. These playback paths could reference publish points from the same publication or a completely different encoder and packager altogether. Content published to an endpoint referenced by one of these cross playback paths MUST be of the same Manifest.Type.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.do_not_monitor.description
(Optional) Specifies if this pubpoint should not be monitored by PLM.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.headers.description
Allows custom HTTP headers to be set via configuration for all HTTP requests.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.method.description
Method overrides what HTTP method to specify in requests to the Publish Point. If not specified the service will default to POST.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.playback_base_url.description
The base URL where published playlists will be able to be obtained. This is often different than the publish_base_url for CDN publishing workflows.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.playback_query_params.description
Specifies any query parameters that will be added to playback urls. Should not include the initial '?' Example: 'foo=bar&q=golang'

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.simple.properties.publish_points.items.properties.publish_base_url.description
The base URL where generated playlists will be sent/published. Each publish point requires a unique 'publish_base_url'.

# components.schemas.ChannelPlayback.properties.hls.items.properties.content_protection.properties.simple.properties.require_publish.description
Indicates which publish points must succeed for segment publishing to use the keys.

# components.schemas.ChannelPlayback.properties.origin.items.properties.dash.description
Dash can be an empty value if Aventus Origin does not have a valid Dash url for the packaged segments.

# components.schemas.ChannelPlayback.properties.origin.items.properties.dash.properties.fallback_manifest.description
fallback_manifest is the name of the fallback playback manifest. ex. 'fallback.m3u8' or 'fallback.mpd'

# components.schemas.ChannelPlayback.properties.origin.items.properties.dash.properties.fallback_url.description
fallback_url is the full playback url for the fallback. It is a composition of hostname, path and fallback_manifest fields. ex. 'https://foo.example.com/live/usw2/path/to/manifest/dir/fallback.m3u8'

# components.schemas.ChannelPlayback.properties.origin.items.properties.dash.properties.hostname.description
hostname for the playback url. ex. 'foo.example.com'

# components.schemas.ChannelPlayback.properties.origin.items.properties.dash.properties.path.description
path identifies where manifests live at the host. ex. /live/usw2/path/to/manifest/dir

# components.schemas.ChannelPlayback.properties.origin.items.properties.dash.properties.primary_manifest.description
primary_manifest is the name of the primary playback manifest. ex. 'main.m3u8' or 'main.mpd'

# components.schemas.ChannelPlayback.properties.origin.items.properties.dash.properties.primary_url.description
primary_url is the full playback url for the primary. It is a composition of hostname, path and primary_manifest fields. ex. 'https://foo.example.com/live/usw2/path/to/manifest/dir/main.m3u8'

# components.schemas.ChannelPlayback.properties.origin.items.properties.fallback_manifest_defaults.properties.dash_signaling_formats.description
DASH Signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering DASH manifests.

# components.schemas.ChannelPlayback.properties.origin.items.properties.fallback_manifest_defaults.properties.duration_seconds.description
Duration is the length of content that will be included in the manifest, in seconds. The max supported DVR window is 12 hours. If not specified, the default duration will be 30 seconds.

# components.schemas.ChannelPlayback.properties.origin.items.properties.fallback_manifest_defaults.properties.hls_signaling_formats.description
HLS signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering playlists.

# components.schemas.ChannelPlayback.properties.origin.items.properties.fallback_manifest_defaults.properties.media_url_type.description
Allows specifying url type for HLS media playlists and DASH manifests. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.ChannelPlayback.properties.origin.items.properties.fallback_manifest_defaults.properties.minimum_update_period_seconds.description
Sets the minimumUpdatePeriod field in MPD to be this value. If set to 0 (default), segment duration is used. The value shall not exceed the 'suggested_presentation_delay_secs'.

# components.schemas.ChannelPlayback.properties.origin.items.properties.fallback_manifest_defaults.properties.multi_variant_url_type.description
Allows specifying url type for HLS multi-variant playlists. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.ChannelPlayback.properties.origin.items.properties.fallback_manifest_defaults.properties.pdt_on_every_segment.description
When true a #EXT-X-PROGRAM-DATE-TIME tag will be placed on every media segment in HLS media playlists. When false, the default behavior, the PDT tag is set according to the HLS specification.

# components.schemas.ChannelPlayback.properties.origin.items.properties.fallback_manifest_defaults.properties.pre_start_duration_seconds.description
Pre Start Duration is the length of content that will be included in the manifest when the start time of a manifest is in the future. When a manifest is near the start time but does not contain 'pre_start_duration_seconds' content Manifest Origin will keep content before the start time to make the manifest length at least 'pre_start_duration_seconds'. If not specified requesting a manifest in the future will result in a 404.

# components.schemas.ChannelPlayback.properties.origin.items.properties.fallback_manifest_defaults.properties.suggested_presentation_delay_seconds.description
Sets the suggestedPresentationDelay field in MPD to be this value. This value must be greater or equal to 'minimum_update_period_secs'. If unset, the default value will be calculated as 3 * segment target duration.

# components.schemas.ChannelPlayback.properties.origin.items.properties.hls.description
HLS can be an empty value if Aventus Origin does not have a valid HLS url for the packaged segments.

# components.schemas.ChannelPlayback.properties.origin.items.properties.hls.properties.fallback_manifest.description
fallback_manifest is the name of the fallback playback manifest. ex. 'fallback.m3u8' or 'fallback.mpd'

# components.schemas.ChannelPlayback.properties.origin.items.properties.hls.properties.fallback_url.description
fallback_url is the full playback url for the fallback. It is a composition of hostname, path and fallback_manifest fields. ex. 'https://foo.example.com/live/usw2/path/to/manifest/dir/fallback.m3u8'

# components.schemas.ChannelPlayback.properties.origin.items.properties.hls.properties.hostname.description
hostname for the playback url. ex. 'foo.example.com'

# components.schemas.ChannelPlayback.properties.origin.items.properties.hls.properties.path.description
path identifies where manifests live at the host. ex. /live/usw2/path/to/manifest/dir

# components.schemas.ChannelPlayback.properties.origin.items.properties.hls.properties.primary_manifest.description
primary_manifest is the name of the primary playback manifest. ex. 'main.m3u8' or 'main.mpd'

# components.schemas.ChannelPlayback.properties.origin.items.properties.hls.properties.primary_url.description
primary_url is the full playback url for the primary. It is a composition of hostname, path and primary_manifest fields. ex. 'https://foo.example.com/live/usw2/path/to/manifest/dir/main.m3u8'

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.description
Configures how to protect packaged media segments.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.atlas.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.atlas.properties.asset_id.description
The Asset Identifier which was taken from the token entitlement service request.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.atlas.properties.company_id.description
The Identifier of the Company that this token belongs.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.atlas.properties.widevine_v0_pssh_box.description
When TRUE the KeyID is not embedded in the pssh box which sets the version to 0. Defaults to generating v1 pssh_boxes that includes the key_id

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.bulk_file.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.bulk_file.properties.iv_rotation.description
How often the IV should be rotated and how it should be created

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.common.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.common.properties.scheme_type.description
Defines the scheme that can be used with Common Encryption

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.cpix.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.cpix.properties.certificates_id.description
Unique ID used for certificate settings, unique per distributor.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.cpix.properties.content_id.description
(Optional) Content ID that identifies this channel in the CPIX service. Value is defined by the DRM system owner, and if defined will be included as part of a POST request.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.cpix.properties.credentials_id.description
Unique ID used for credentials settings, unique per distributor.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.cpix.properties.decryption_key_id.description
Unique ID of the decryption key to use in case the server response contains content keys encrypted. The key is unique per distirutor, and configured ahead of time by the publishing team and the CPIX service owner.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.cpix.properties.drms.description
(Optional) DRM system keys to request. If not defined a GET request will be done, and any key returned will be handled. If defined, random kid(s) (key ids) will be generated on rotation for each DRM system, and a POST request will be done to create them.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.cpix.properties.headers_id.description
(Optional) An identifier to a list of HTTP headers to be added to the request sent to the CPIX service.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.key_rotation.properties.interval_secs.description
Rotate keys based on the specified time interval. If Program is also provided then this time interval will only apply to media segments that are outside of program boundaries. If Program is NOT provided then only this time interval will be used to decided when to rotate keys.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.key_rotation.properties.program.description
Rotate keys on (SCTE35) program boundaries such that no two programs will be protected with the same key.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.key_rotation.properties.program_overlap_skip_encrypt.description
Do not encrypt segments that are part of more than one SCTE-35 program.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.sample_aes.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.simple.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.simple.properties.publish_points.description
Pub points where keys should be published. If multiple are specified, only one needs to succeed to consider the key successfully published.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.simple.properties.publish_points.items.properties.compression.description
Configures whether or not (and how) to compress manifests being published to the origin. If not specified, manifests will not be compressed.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.simple.properties.publish_points.items.properties.cross_playback_paths.description
Cross Playback Paths are playback paths that reference alternative content. These playback paths could reference publish points from the same publication or a completely different encoder and packager altogether. Content published to an endpoint referenced by one of these cross playback paths MUST be of the same Manifest.Type.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.simple.properties.publish_points.items.properties.do_not_monitor.description
(Optional) Specifies if this pubpoint should not be monitored by PLM.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.simple.properties.publish_points.items.properties.headers.description
Allows custom HTTP headers to be set via configuration for all HTTP requests.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.simple.properties.publish_points.items.properties.method.description
Method overrides what HTTP method to specify in requests to the Publish Point. If not specified the service will default to POST.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.simple.properties.publish_points.items.properties.playback_base_url.description
The base URL where published playlists will be able to be obtained. This is often different than the publish_base_url for CDN publishing workflows.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.simple.properties.publish_points.items.properties.playback_query_params.description
Specifies any query parameters that will be added to playback urls. Should not include the initial '?' Example: 'foo=bar&q=golang'

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.simple.properties.publish_points.items.properties.publish_base_url.description
The base URL where generated playlists will be sent/published. Each publish point requires a unique 'publish_base_url'.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.content_protection.properties.simple.properties.require_publish.description
Indicates which publish points must succeed for segment publishing to use the keys.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.mp2t.description
Uses MP2T format for each segments. Only one of ['mp2t', 'mp4'] may be set.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.mp2t.properties.force_unmuxed_audio.description
Forces the Video and Audio Encodings to be unmuxed when there is one audio encodings. This setting will have to be uniformed across MP2T packagers within a config. When there are two or more audio encodings, unmuxed will be used automatically.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.mp2t.properties.insert_id3_utc_time.description
If true, insert ID3 tags that include a UTC timestamp. This is a Turner/WM-specific extension.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.mp4.description
Uses MP4 format for each segments. Only one of ['mp2t', 'mp4'] may be set.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.mp4.properties.caption_placement.description
CaptionPlacement defines where caption messages should be placed in the output MP4.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.mp4.properties.insert_pssh_box.description
Insert pssh boxes generated by content protection into packaged segments. Defaults to not insert pssh boxes to the packaged segments.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.ttml.description
Only one of ['web_vtt', 'ttml'] may be set.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.web_vtt.description
Only one of ['web_vtt', 'ttml'] may be set.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_config.properties.web_vtt.properties.file_format.description
The file format used to encapsulate the WebVTT segments.

# components.schemas.ChannelPlayback.properties.origin.items.properties.packager_id.description
packager_id is the ID used to identify the packager_config within the channel configuration.

# components.schemas.ChannelPlayback.properties.origin.items.properties.primary_manifest_defaults.properties.dash_signaling_formats.description
DASH Signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering DASH manifests.

# components.schemas.ChannelPlayback.properties.origin.items.properties.primary_manifest_defaults.properties.duration_seconds.description
Duration is the length of content that will be included in the manifest, in seconds. The max supported DVR window is 12 hours. If not specified, the default duration will be 30 seconds.

# components.schemas.ChannelPlayback.properties.origin.items.properties.primary_manifest_defaults.properties.hls_signaling_formats.description
HLS signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering playlists.

# components.schemas.ChannelPlayback.properties.origin.items.properties.primary_manifest_defaults.properties.media_url_type.description
Allows specifying url type for HLS media playlists and DASH manifests. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.ChannelPlayback.properties.origin.items.properties.primary_manifest_defaults.properties.minimum_update_period_seconds.description
Sets the minimumUpdatePeriod field in MPD to be this value. If set to 0 (default), segment duration is used. The value shall not exceed the 'suggested_presentation_delay_secs'.

# components.schemas.ChannelPlayback.properties.origin.items.properties.primary_manifest_defaults.properties.multi_variant_url_type.description
Allows specifying url type for HLS multi-variant playlists. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.ChannelPlayback.properties.origin.items.properties.primary_manifest_defaults.properties.pdt_on_every_segment.description
When true a #EXT-X-PROGRAM-DATE-TIME tag will be placed on every media segment in HLS media playlists. When false, the default behavior, the PDT tag is set according to the HLS specification.

# components.schemas.ChannelPlayback.properties.origin.items.properties.primary_manifest_defaults.properties.pre_start_duration_seconds.description
Pre Start Duration is the length of content that will be included in the manifest when the start time of a manifest is in the future. When a manifest is near the start time but does not contain 'pre_start_duration_seconds' content Manifest Origin will keep content before the start time to make the manifest length at least 'pre_start_duration_seconds'. If not specified requesting a manifest in the future will result in a 404.

# components.schemas.ChannelPlayback.properties.origin.items.properties.primary_manifest_defaults.properties.suggested_presentation_delay_seconds.description
Sets the suggestedPresentationDelay field in MPD to be this value. This value must be greater or equal to 'minimum_update_period_secs'. If unset, the default value will be calculated as 3 * segment target duration.

# components.schemas.ChannelTimelineEntry.properties.action.description
Shortcode indicating what action was taken

# components.schemas.ChannelTimelineEntry.properties.request_body.description
The request body, if any, of the original action

# components.schemas.ChannelTimelineEntry.properties.status_code.description
HTTP Status code indicating outcome of the action.

# components.schemas.CollapseVODRequest.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.CollapseVODRequest.properties.filterconfig.properties.time.items.properties.start.description
start time of the time window of segments

# components.schemas.CollapseVODResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.DeprecatedGetClipResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.DeprecatedGetMp4UrlResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.DeprecatedGetProgramResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.DeprecatedGetProgramTimeResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.DeprecatedMakeMP4Request.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.DeprecatedMakeMP4Request.properties.force.description
if true, forces recreation of the mp4 if already created.

# components.schemas.DeprecatedMakeMP4Response.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.DeprecatedMakeMP4Response.properties.taskid.description
task id of the makemp4 task that has been created.

# components.schemas.DynamicSyndicationRequest.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.DynamicSyndicationRequest.properties.correlation_id.description
Correlation ID for this FER archive request

# components.schemas.DynamicSyndicationRequest.properties.manifest_url.description
URL of the main manifest to reference for the mp4

# components.schemas.DynamicSyndicationRequest.properties.query_string.description
Query string containing params for the manifest url

# components.schemas.DynamicSyndicationRequest.properties.syndication_files.description
List of files to be created by Syndication

# components.schemas.DynamicSyndicationResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.DynamicSyndicationResponse.properties.correlation_id.description
Identifier that is carried through the syndication request

# components.schemas.DynamicSyndicationResponse.properties.task_id.description
Task ID for the syndication task started by the L2V service

# components.schemas.ErrorModel.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.ErrorModel.properties.detail.description
A human-readable explanation specific to this occurrence of the problem.

# components.schemas.ErrorModel.properties.detail.example
Property foo is required but is missing.

# components.schemas.ErrorModel.properties.errors.description
Optional list of individual error details

# components.schemas.ErrorModel.properties.errors.items.properties.location.description
Where the error occured, e.g. 'body.items[3].tags' or 'path.thing-id'

# components.schemas.ErrorModel.properties.instance.description
A URI reference that identifies the specific occurence of the problem.

# components.schemas.ErrorModel.properties.title.description
A short, human-readable summary of the problem type. This value should not change between occurances of the error.

# components.schemas.ErrorModel.properties.type.description
A URI reference to human-readable documentation for the error.

# components.schemas.GenericSignal.properties.duration.description
Splice duration (ms). If no duration or a duration of 0 then the default duration for the segment type is used.

# components.schemas.GenericSignal.properties.event_id.description
Identifies the active signaling segment. Use the same event_id for both START and END to reference the same segment. When signaling two STARTs with the same event_id, the second one will result in an error (ALREADY_EXISTS). Signaling a second start with a different event_id will end a previous active segment of the same type. After a segment has ended, its event_id can be reused. IDs are namespaced by segment type. E.g. it is allowed to have an active Chapter and an active Program with the same event_id. This field corresponds to SCTE-35 segmentation_event_id and splice_event_id.

# components.schemas.GenericSignal.properties.segment_type.description
The signaling segment type which is going to start/end/etc. This is used to mark programs, chapters, ad insertion points, video slating, etc.

# components.schemas.GenericSignal.properties.signal_type.description
Whether this signal will start/end/etc a signaling segment

# components.schemas.GenericSignalResult.properties.error_message.description
Error details from the signaling subsystem

# components.schemas.GenericSignalResult.properties.result_code.description
Result of signal; 'accepted' means no error

# components.schemas.GetClipProgramTimeResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.GetPreviewStreamsResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.GetPreviewStreamsResponse.properties.audio_tracks.description
Lists of all audio and video tracks that are available. Note: the default audio and video track info will also appear here.

# components.schemas.GetPreviewStreamsResponse.properties.audio_tracks.items.properties.codec_string.description
codec_string will be set to the RFC 6381 compliant string that represents the specific codec in this AudioTrackInfo. ex. 'mp4a.40.2' for AAC Low-Complexity.

# components.schemas.GetPreviewStreamsResponse.properties.default_audio_track.description
Audio and Video Track info provided so that callers have easy access to track information of default tracks in the above default_url.

# components.schemas.GetPreviewStreamsResponse.properties.default_audio_track.properties.codec_string.description
codec_string will be set to the RFC 6381 compliant string that represents the specific codec in this AudioTrackInfo. ex. 'mp4a.40.2' for AAC Low-Complexity.

# components.schemas.GetPreviewStreamsResponse.properties.default_url.description
default_url contains the default URL that can be used to start playback. Ex: https://example.com/cluster/org/isp/ext_id/foo/play?vid_id=2&aud_id=6 The vid_id and aud_id can be changed utilizing the ones provided by the 'audio_tracks' and 'video_tracks' fields to see different combinations.

# components.schemas.GetPreviewStreamsResponse.properties.default_video_track.properties.codec_string.description
codec_string will be set to the RFC 6381 compliant string that represents the specific codec in this VideoTrackInfo. ex. 'avc1.4d401e' for H.264 and 'hvc1.2.4.L150.90' for H.265. This can be used to verify track+browser compatibility.

# components.schemas.GetPreviewStreamsResponse.properties.token.description
JWT Bearer token that shall be supplied with a 'pre-flight' to myriapod.js to send the auth token to the server.

# components.schemas.GetPreviewStreamsResponse.properties.video_tracks.items.properties.codec_string.description
codec_string will be set to the RFC 6381 compliant string that represents the specific codec in this VideoTrackInfo. ex. 'avc1.4d401e' for H.264 and 'hvc1.2.4.L150.90' for H.265. This can be used to verify track+browser compatibility.

# components.schemas.GetProductConfigResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.GetProductConfigResponse.properties.errors.items.properties.location.description
Where the error occured, e.g. 'body.items[3].tags' or 'path.thing-id'

# components.schemas.GetProductConfigResponse.properties.product_config.description
Product Config for a given org and product id

# components.schemas.GetProductConfigResponse.properties.product_config.items.properties.collapse_config.properties.v2_filters_config.properties.time.items.properties.start.description
start time of the time window of segments

# components.schemas.GetProductConfigResponse.properties.product_config.items.properties.region.description
Region represents the general geolocation the product is in.

# components.schemas.GetProductResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.GetProductResponse.properties.errors.items.properties.location.description
Where the error occured, e.g. 'body.items[3].tags' or 'path.thing-id'

# components.schemas.GetProductResponse.properties.products.items.properties.region.description
Region represents the general geolocation the product is in.

# components.schemas.GetScte35MarkerByClipIDResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.GetTaskResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.GetTaskResponse.properties.created.description
when the task was created in RFC3339Nano format

# components.schemas.GetTaskResponse.properties.ended.description
when the task ended in RFC3339Nano format

# components.schemas.GetTaskResponse.properties.region.description
Region represents the general geolocation the task is in.

# components.schemas.GetVODResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.InsertMetadataRequest.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.InsertMetadataResult.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.InsertMetadataResult.properties.presentation_time.description
The media stream timestamp for where the transcoder inserted the metadata

# components.schemas.ListClipsForVodResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.ListClipsForVodResponse.properties.channel_clips.items.properties.vod_id.description
ID of the VOD from which the clips were created

# components.schemas.ListClipsForVodResponse.properties.errors.description
Reports failures to fetch the clips of a single VOD. Empty if clips from all VODs are successfully fetched.

# components.schemas.ListClipsForVodResponse.properties.errors.items.properties.location.description
Where the error occured, e.g. 'body.items[3].tags' or 'path.thing-id'

# components.schemas.ListClipsResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.ListClipsResponse.properties.channel_clips.items.properties.vod_id.description
ID of the VOD from which the clips were created

# components.schemas.ListClipsResponse.properties.errors.description
Reports failures to fetch the clips of a single VOD. Empty if clips from all VODs are successfully fetched.

# components.schemas.ListProductsResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.ListProductsResponse.properties.errors.items.properties.location.description
Where the error occured, e.g. 'body.items[3].tags' or 'path.thing-id'

# components.schemas.ListProductsResponse.properties.products.items.properties.region.description
Region represents the general geolocation the product is in.

# components.schemas.ListProgramsResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.ListProgramsResponse.properties.errors.items.properties.location.description
Where the error occured, e.g. 'body.items[3].tags' or 'path.thing-id'

# components.schemas.ListProgramsResponse.properties.programs.items.properties.region.description
Region represents the general geolocation the program is in.

# components.schemas.ListProgramsResponse.properties.programs.items.properties.retention_days.description
How many days the program is retained for

# components.schemas.ListTasksResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.ListTasksResponse.properties.errors.items.properties.location.description
Where the error occured, e.g. 'body.items[3].tags' or 'path.thing-id'

# components.schemas.ListTasksResponse.properties.tasks.items.properties.created.description
when the task was created in RFC3339Nano format

# components.schemas.ListTasksResponse.properties.tasks.items.properties.ended.description
when the task ended in RFC3339Nano format

# components.schemas.ListTasksResponse.properties.tasks.items.properties.region.description
Region represents the general geolocation the task is in.

# components.schemas.MP4URLResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.MakeClipRequest.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.MakeClipRequest.properties.correlation_id.description
Identifer that is carried through archive and collapse notifications for the clip creation

# components.schemas.MakeClipResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.MakeClipResponse.properties.clip_id.description
Identifier for the clip created from the VOD

# components.schemas.MakeClipResponse.properties.task_id.description
Identifier for the task from which the clip was created

# components.schemas.MakeMP4Response.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.PinSourceRequest.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.PinSourceRequest.properties.ingest_origin.description
Which ingest origin to pin the transcoder to.

# components.schemas.PlayURLResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.PostClipArchiveRequest.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.PostClipArchiveRequest.properties.correlation_id.description
Identifer that is carried through the archive request

# components.schemas.PostClipArchiveResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.PostClipArchiveResponse.properties.correlation_id.description
Identifer that is carried through the archive request

# components.schemas.PostClipArchiveResponse.properties.task_errors.description
Set if Live2VOD failed to start an archive task for any configured archive destination. Empty if all are successful

# components.schemas.PostClipArchiveResponse.properties.task_errors.items.properties.location.description
Where the error occured, e.g. 'body.items[3].tags' or 'path.thing-id'

# components.schemas.PostClipArchiveResponse.properties.task_ids.description
Array of task ids for each archive destination task started by Live2VOD

# components.schemas.PostClipRequest.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.PostClipRequest.properties.correlation_id.description
Identifer that is carried through archive and collapse notifications for the clip creation

# components.schemas.PostClipRequest.properties.create_mp4.description
If true, creates the mp4. Default: false

# components.schemas.PostClipRequest.properties.mp4_file_path.description
If set, overrides the mp4 file path for archiving.

# components.schemas.PostClipResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.PostClipResponse.properties.clips.description
List of clip identifiers paired with each VodID that was clipped

# components.schemas.PostClipResponse.properties.clips.items.properties.clip_id.description
Identifier for the clip created from the VOD

# components.schemas.PostClipResponse.properties.clips.items.properties.vod_id.description
Identifier for the VOD from which the clip was created

# components.schemas.PostClipResponse.properties.correlation_id.description
Identifer that is carried through archive and collapse notifications for the clip creation

# components.schemas.PostClipResponse.properties.task_errors.description
Reports failures of individual clip tasks. Empty if all are successful

# components.schemas.PostClipResponse.properties.task_errors.items.properties.location.description
Where the error occured, e.g. 'body.items[3].tags' or 'path.thing-id'

# components.schemas.PostClipResponse.properties.task_ids.description
Identifies clipping tasks, each task producing N VodItems

# components.schemas.PostCopyMP4Request.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.PostCopyMP4Request.properties.override_mp4_path.description
override path for writing an mp4 to destination.

# components.schemas.PostCopyMP4Response.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.PostCopyMP4Response.properties.task_ids.description
Array of task ids for each copymp4 destination task successfully started by Live2VOD

# components.schemas.PostMakeMP4Request.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.PostMakeMP4Request.properties.override_mp4_path.description
override path for writing an mp4 to destination.

# components.schemas.RetryTaskResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.RetryTaskResponse.properties.error.properties.location.description
Where the error occured, e.g. 'body.items[3].tags' or 'path.thing-id'

# components.schemas.Scte35.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.Scte35.properties.payload.description
The SCTE-35 payload, encoded as base-64 in JSON or binary data in CBOR

# components.schemas.Segment.properties.end.description
The program time when the segment ends (or ended).

# components.schemas.Segment.properties.event_id.description
The event_id used in the Signal START that resulted in this signaling segment.

# components.schemas.Segment.properties.segment_id.description
Uniquely identifies the signaling segment for a channel. This is assigned by the transcoder when the segment is created.

# components.schemas.Segment.properties.slate_url.description
When set, contains the URL to the slate media asset that will play for the duration of the segment.

# components.schemas.Segment.properties.start.description
The program time when the segment starts (or started).

# components.schemas.Source.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.Status.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.Status.properties.ingest_status.properties.primary_status.properties.active.description
Reports whether this is the active source - i.e. the source being transcoded.

# components.schemas.Status.properties.ingest_status.properties.primary_status.properties.cc_errors.description
Continuity counter error total since the transcoder pod started.

# components.schemas.Status.properties.ingest_status.properties.primary_status.properties.last_data_received.description
The last time data was received for this source.

# components.schemas.Status.properties.ingest_status.properties.primary_status.properties.pinned.description
Reports whether this source was pinned to be always preferred (if available).

# components.schemas.Status.properties.ingest_status.properties.primary_status.properties.pmt.properties.streams.items.properties.mapped.description
Indicates whether the stream is being used by the transcoder. The remaining fields are only valid if 'mapped' is true.

# components.schemas.Status.properties.ingest_status.properties.primary_status.properties.pmt.properties.streams.items.properties.raw_type.description
The type of the stream as reported in the PMT.

# components.schemas.Status.properties.ingest_status.properties.primary_status.properties.pmt.properties.streams.items.properties.type.description
The type of the stream inferred by the demuxer. Includes MP2TStreamType's pseudo-types values. It is not guaranteed to be the same value reported in the PMT. E.g. MP2T_STREAM_TYPE_PES_PRIVATE_DATA plus the right descriptor might result in MP2T_STREAM_TYPE_ID3.

# components.schemas.Status.properties.ingest_status.properties.primary_status.properties.pmt.properties.streams.items.properties.video.properties.clli.properties.max_fall.description
Max frame (pic) average light level in nits.

# components.schemas.Status.properties.ingest_status.properties.primary_status.properties.quality_score.description
A measure of the source's quality if available. Zero is the perfect score. The higher the score, the worst the quality.

# components.schemas.Status.properties.ingest_status.properties.primary_status.properties.unavailable_reason.description
If unset (empty string), the source is available, and could be made active if necessary. Otherwise, it contains a message indicating why the source is unavailable. E.g. 'No source AUs received'.

# components.schemas.Status.properties.ingest_status.properties.secondary_status.properties.active.description
Reports whether this is the active source - i.e. the source being transcoded.

# components.schemas.Status.properties.ingest_status.properties.secondary_status.properties.cc_errors.description
Continuity counter error total since the transcoder pod started.

# components.schemas.Status.properties.ingest_status.properties.secondary_status.properties.last_data_received.description
The last time data was received for this source.

# components.schemas.Status.properties.ingest_status.properties.secondary_status.properties.pinned.description
Reports whether this source was pinned to be always preferred (if available).

# components.schemas.Status.properties.ingest_status.properties.secondary_status.properties.pmt.properties.streams.items.properties.mapped.description
Indicates whether the stream is being used by the transcoder. The remaining fields are only valid if 'mapped' is true.

# components.schemas.Status.properties.ingest_status.properties.secondary_status.properties.pmt.properties.streams.items.properties.raw_type.description
The type of the stream as reported in the PMT.

# components.schemas.Status.properties.ingest_status.properties.secondary_status.properties.pmt.properties.streams.items.properties.type.description
The type of the stream inferred by the demuxer. Includes MP2TStreamType's pseudo-types values. It is not guaranteed to be the same value reported in the PMT. E.g. MP2T_STREAM_TYPE_PES_PRIVATE_DATA plus the right descriptor might result in MP2T_STREAM_TYPE_ID3.

# components.schemas.Status.properties.ingest_status.properties.secondary_status.properties.pmt.properties.streams.items.properties.video.properties.clli.properties.max_fall.description
Max frame (pic) average light level in nits.

# components.schemas.Status.properties.ingest_status.properties.secondary_status.properties.quality_score.description
A measure of the source's quality if available. Zero is the perfect score. The higher the score, the worst the quality.

# components.schemas.Status.properties.ingest_status.properties.secondary_status.properties.unavailable_reason.description
If unset (empty string), the source is available, and could be made active if necessary. Otherwise, it contains a message indicating why the source is unavailable. E.g. 'No source AUs received'.

# components.schemas.Status.properties.ingest_status.properties.source_loss_slate_status.properties.active.description
Reports whether this is the active source - i.e. the source being transcoded.

# components.schemas.Status.properties.ingest_status.properties.source_loss_slate_status.properties.cc_errors.description
Continuity counter error total since the transcoder pod started.

# components.schemas.Status.properties.ingest_status.properties.source_loss_slate_status.properties.last_data_received.description
The last time data was received for this source.

# components.schemas.Status.properties.ingest_status.properties.source_loss_slate_status.properties.pinned.description
Reports whether this source was pinned to be always preferred (if available).

# components.schemas.Status.properties.ingest_status.properties.source_loss_slate_status.properties.pmt.properties.streams.items.properties.mapped.description
Indicates whether the stream is being used by the transcoder. The remaining fields are only valid if 'mapped' is true.

# components.schemas.Status.properties.ingest_status.properties.source_loss_slate_status.properties.pmt.properties.streams.items.properties.raw_type.description
The type of the stream as reported in the PMT.

# components.schemas.Status.properties.ingest_status.properties.source_loss_slate_status.properties.pmt.properties.streams.items.properties.type.description
The type of the stream inferred by the demuxer. Includes MP2TStreamType's pseudo-types values. It is not guaranteed to be the same value reported in the PMT. E.g. MP2T_STREAM_TYPE_PES_PRIVATE_DATA plus the right descriptor might result in MP2T_STREAM_TYPE_ID3.

# components.schemas.Status.properties.ingest_status.properties.source_loss_slate_status.properties.pmt.properties.streams.items.properties.video.properties.clli.properties.max_fall.description
Max frame (pic) average light level in nits.

# components.schemas.Status.properties.ingest_status.properties.source_loss_slate_status.properties.quality_score.description
A measure of the source's quality if available. Zero is the perfect score. The higher the score, the worst the quality.

# components.schemas.Status.properties.ingest_status.properties.source_loss_slate_status.properties.unavailable_reason.description
If unset (empty string), the source is available, and could be made active if necessary. Otherwise, it contains a message indicating why the source is unavailable. E.g. 'No source AUs received'.

# components.schemas.Status.properties.ingest_status.properties.source_merging_active.description
Reports whether source merging is currently active i.e. that the transcoder is merging samples from primary and secondary sources to conceal errors.

# components.schemas.Status.properties.ingest_status.properties.source_merging_disabled.description
Reports whether source merging was disabled via API.

# components.schemas.TaskResponse.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.TaskResponse.properties.tasks.items.properties.created.description
when the task was created in RFC3339Nano format

# components.schemas.TaskResponse.properties.tasks.items.properties.ended.description
when the task ended in RFC3339Nano format

# components.schemas.TaskResponse.properties.tasks.items.properties.region.description
Region represents the general geolocation the task is in.

# components.schemas.UpdateProductConfigRequest.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.UpdateProductConfigRequest.properties.collapse_config.properties.v2_filters_config.properties.time.items.properties.start.description
start time of the time window of segments

# components.schemas.UpdateProductConfigRequest.properties.region.description
Region represents the general geolocation the product is in.

# components.schemas.desiredStateBody.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.patch-org-channel-request.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.patch-org-channel-request.properties.enable_byoip.description
Indicates whether the channel's transcoder needs to run in a designated IP range.

# components.schemas.patch-org-channel-request.properties.id.description
External Channel ID provided at channel creation time

# components.schemas.patch-org-channel-request.properties.ingest.description
Ingest configures inputs for the transcoder.

# components.schemas.patch-org-channel-request.properties.ingest.properties.slate.description
Slate configures default slating behavior.

# components.schemas.patch-org-channel-request.properties.ingest.properties.slate.properties.source_loss_url.description
Source loss URL defines the location of the TS file to play when no source is available. It must have one audio and one video stream. Either MPEG2 or H.264 can be used.

# components.schemas.patch-org-channel-request.properties.ingest.properties.source.description
Source provides a reference to the input media stream for this channel.

# components.schemas.patch-org-channel-request.properties.ingest.properties.source.properties.audio_sources.items.properties.license.description
License specifies how the audio in this source is licensed.

# components.schemas.patch-org-channel-request.properties.ingest.properties.source.properties.audio_sources.items.properties.name.description
Language fiendly name, e.g. 'English', 'Spanish'

# components.schemas.patch-org-channel-request.properties.ingest.properties.source.properties.captions_source.description
Closed captions source embedding. If unspecified, defaults to ATSC_A53.

# components.schemas.patch-org-channel-request.properties.ingest.properties.source.properties.video_source.description
Additional information about the source video stream. This is only used to configure the transcoder compute resources to account for scaling and colorspace conversion of the source input.

# components.schemas.patch-org-channel-request.properties.ingest.properties.source.properties.video_source.properties.dynamic_range.description
The highest dynamic range the source will ever send to the transcoder.

# components.schemas.patch-org-channel-request.properties.ingest.properties.source.properties.video_source.properties.max_resolution.description
The maximum resolution the source will ever send to the transcoder.

# components.schemas.patch-org-channel-request.properties.labels.description
Optional labels for a channel. Any included labels must be at least 1 character long, but no greater than 256 characters. The maximum number of labels is 10.

# components.schemas.patch-org-channel-request.properties.modified.description
Date and time the channel was last modified.

# components.schemas.patch-org-channel-request.properties.name.description
A friendly human-readable name for the channel. This will get displayed in user interfaces.

# components.schemas.patch-org-channel-request.properties.packaging.description
Packaging configures media format and content protection settings.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.description
Defines the list of packagers available for Publications.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.description
Configures how to protect packaged media segments.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.atlas.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.atlas.properties.asset_id.description
The Asset Identifier which was taken from the token entitlement service request.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.atlas.properties.company_id.description
The Identifier of the Company that this token belongs.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.atlas.properties.widevine_v0_pssh_box.description
When TRUE the KeyID is not embedded in the pssh box which sets the version to 0. Defaults to generating v1 pssh_boxes that includes the key_id

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.bulk_file.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.bulk_file.properties.iv_rotation.description
How often the IV should be rotated and how it should be created

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.common.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.common.properties.scheme_type.description
Defines the scheme that can be used with Common Encryption

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.certificates_id.description
Unique ID used for certificate settings, unique per distributor.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.content_id.description
(Optional) Content ID that identifies this channel in the CPIX service. Value is defined by the DRM system owner, and if defined will be included as part of a POST request.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.credentials_id.description
Unique ID used for credentials settings, unique per distributor.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.decryption_key_id.description
Unique ID of the decryption key to use in case the server response contains content keys encrypted. The key is unique per distirutor, and configured ahead of time by the publishing team and the CPIX service owner.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.drms.description
(Optional) DRM system keys to request. If not defined a GET request will be done, and any key returned will be handled. If defined, random kid(s) (key ids) will be generated on rotation for each DRM system, and a POST request will be done to create them.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.headers_id.description
(Optional) An identifier to a list of HTTP headers to be added to the request sent to the CPIX service.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.key_rotation.properties.interval_secs.description
Rotate keys based on the specified time interval. If Program is also provided then this time interval will only apply to media segments that are outside of program boundaries. If Program is NOT provided then only this time interval will be used to decided when to rotate keys.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.key_rotation.properties.program.description
Rotate keys on (SCTE35) program boundaries such that no two programs will be protected with the same key.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.key_rotation.properties.program_overlap_skip_encrypt.description
Do not encrypt segments that are part of more than one SCTE-35 program.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.sample_aes.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.description
Pub points where keys should be published. If multiple are specified, only one needs to succeed to consider the key successfully published.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.compression.description
Configures whether or not (and how) to compress manifests being published to the origin. If not specified, manifests will not be compressed.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.cross_playback_paths.description
Cross Playback Paths are playback paths that reference alternative content. These playback paths could reference publish points from the same publication or a completely different encoder and packager altogether. Content published to an endpoint referenced by one of these cross playback paths MUST be of the same Manifest.Type.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.do_not_monitor.description
(Optional) Specifies if this pubpoint should not be monitored by PLM.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.headers.description
Allows custom HTTP headers to be set via configuration for all HTTP requests.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.method.description
Method overrides what HTTP method to specify in requests to the Publish Point. If not specified the service will default to POST.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.playback_base_url.description
The base URL where published playlists will be able to be obtained. This is often different than the publish_base_url for CDN publishing workflows.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.playback_query_params.description
Specifies any query parameters that will be added to playback urls. Should not include the initial '?' Example: 'foo=bar&q=golang'

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.publish_base_url.description
The base URL where generated playlists will be sent/published. Each publish point requires a unique 'publish_base_url'.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.require_publish.description
Indicates which publish points must succeed for segment publishing to use the keys.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.mp2t.description
Uses MP2T format for each segments. Only one of ['mp2t', 'mp4'] may be set.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.mp2t.properties.force_unmuxed_audio.description
Forces the Video and Audio Encodings to be unmuxed when there is one audio encodings. This setting will have to be uniformed across MP2T packagers within a config. When there are two or more audio encodings, unmuxed will be used automatically.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.mp2t.properties.insert_id3_utc_time.description
If true, insert ID3 tags that include a UTC timestamp. This is a Turner/WM-specific extension.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.mp4.description
Uses MP4 format for each segments. Only one of ['mp2t', 'mp4'] may be set.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.mp4.properties.caption_placement.description
CaptionPlacement defines where caption messages should be placed in the output MP4.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.mp4.properties.insert_pssh_box.description
Insert pssh boxes generated by content protection into packaged segments. Defaults to not insert pssh boxes to the packaged segments.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.ttml.description
Only one of ['web_vtt', 'ttml'] may be set.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.web_vtt.description
Only one of ['web_vtt', 'ttml'] may be set.

# components.schemas.patch-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.web_vtt.properties.file_format.description
The file format used to encapsulate the WebVTT segments.

# components.schemas.patch-org-channel-request.properties.publishing.description
Publishing configures playlist formats and where to send video and playlist data.

# components.schemas.patch-org-channel-request.properties.publishing.properties.closed_caption_streams.description
Configures how captioning information, which references CEA-608 captions embedded in video segments, is published.

# components.schemas.patch-org-channel-request.properties.publishing.properties.closed_caption_streams.items.properties.auto_select.description
Indicates that the client should play the captioning media selection group if the user has not indicated a user preference. If both auto_select and default are not set, the first captioning media selection group will be used.

# components.schemas.patch-org-channel-request.properties.publishing.properties.closed_caption_streams.items.properties.default.description
Configures the captioning media selection group that will be played if the user has not indicated a user preference. If both auto_select and default are not set, the first captioning media selection group will be used.

# components.schemas.patch-org-channel-request.properties.publishing.properties.closed_caption_streams.items.properties.language.description
Language code as RFC 5646, e.g. 'en' 'en-US'.

# components.schemas.patch-org-channel-request.properties.publishing.properties.feature_flags.description
Set of string identifiers corresponding to features that this Channel is opting in.

# components.schemas.patch-org-channel-request.properties.publishing.properties.live2vod.description
Live2VOD configuration used to archive the channel data, this allows clip creation after the content is no longer live.

# components.schemas.patch-org-channel-request.properties.publishing.properties.live2vod.properties.clear_capture.description
BETA - (Optional) Indicates whether the system should send the unpackaged segments produced from the transcoder to the L2V system for purposes of creating mp4s and/or repackaging.

# components.schemas.patch-org-channel-request.properties.publishing.properties.live2vod.properties.product_id.description
Product ID that VODs will be associated with in the Live2VOD system. The value of this ID is pre-configured in the Live2VOD portal.

# components.schemas.patch-org-channel-request.properties.publishing.properties.live2vod.properties.retention_days.description
Specifies the retention time, in days, for archived content.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.description
A set of individual configurations that each can configure a specific destination and mechanism of delivery for segments and/or playlists.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.audio_encoder_ids.description
Optionally specify which audio encoders should be used for this publication. If none are specified, all audio encoders configured for the transcoder will be used.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.create_vods.description
Create VODs for all publish points in this publication. Note that Live2VOD must also be configured for the parent |Channel|.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.dash.description
DASH configures publication settings. Only one of HLS or DASH can be set.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.dash.properties.minimum_update_period_secs.description
Sets the minimumUpdatePeriod field in MPD to be this value. If set to 0 (default), segment duration is used. The value shall not exceed the 'suggested_presentation_delay_secs'.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.dash.properties.signaling_formats.description
Signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering playlists.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.dash.properties.suggested_presentation_delay_secs.description
The suggested amount of time (in seconds) the player should be behind the live stream. This value must be greater or equal to 'minimum_update_period_secs'.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.dash.properties.url_type.description
If set to 'URL_TYPE_UNDEFINED' playlist generation will use 'RELATIVE'.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.drms.description
Optionally specify which DRMs to advertise in the playlist. If specified, this must be a subset of the DRMs specified by the packager associated with this publication. If omitted or empty, all DRMs specified by the packager will be advertised. This setting can only be used for HLS playlists.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.dvr_window_secs.description
DVR window is the max sum(duration of media segments) that will be kept in a manifest at a given time in seconds. The max supported DVR window is 10 hours.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.fer_audio_encoder_ids.description
Optionally specify which audio encoders should be used when generating the FER of this Presentation, this overrides the 'audio_encoder_ids' used during the live portion. If none are specified, the 'audio_encoder_ids' field will be used.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.description
HLS configures publication settings. Only one of HLS or DASH can be set.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.audio_only_variants.description
Defines how audio only variant streams are included in the master playlist, where the variant streams are defined by #EXT-X-STREAM-INF tag, the tag attributes provide information about the Stream. The INCLUDE_DEFAULT option - only the default 'audio only variant stream' is included in master playlist. This is the most common use case. INCLUDE_NONE - no audio only variant streams are included in the master playlist. INCLUDE_ALL - include all audio only variant streams in the master playlist.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.gap_tags.description
Allows turning gap tags ON/OFF. When turned ON - the tag '#EXT-X-GAP' is inserted into media playlist for a missing segment. When turned OFF - Discontinuity is inserted into the playlist for missing segment(s). The default option UNDEFINED is mapped to OFF. Note: Gap tags are always inserted for the missing thumbnail segments independently of this setting

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.master_publish_frequency_secs.description
How often the multi-variant playlist(s) should be published (in seconds) once a channel is started. If 0 (not provided), defaults to 1 hour. The following can also result in re-publishing of multi-variant playlists: - Configuration changes related to transcoding configuration (i.e. adding, removing, changing encoders). - Service code changes related to manifest generation.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.master_url_type.description
Allows specifying url type for HLS master playlists. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.media_url_type.description
Allows specifying url type for HLS media playlists. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.description
Specify which partial presentations should be used for this presentation. Partial presentations are additional master playlists that point to a subset of the parent presentation's media streams/variant playlists.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.audio_encoder_ids.description
Specify which audio encoders should be used for this presentation. If none are specified, all audio encoders configured for the parent Publication will be used.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.fer_audio_encoder_ids.description
Optionally specify which audio encoders should be used when generating the FER of this Partial Presentation, this overrides the 'audio_encoder_ids' used during the live portion. If none are specified, the 'audio_encoder_ids' field will be used. NOTE: This MUST only be used with push based manifest. Ignore this field when using Aventus Origin with Dynamic Manifests. Instead use the AudioSource.License field.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.iframe_only_encoder_ids.description
List of video encoder IDs that should have I-Frame only playlists generated for them. If no 'iframe_only_encoder_ids' are given then no I-Frame playlists will be in the Partial Presentation.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.playlist_path.description
Sub-path that will be appended onto the publish and playback base URLs of HTTP PublishPoints for published playlist files.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.thumbnail_encoder_ids.description
Specify which thumbnail encoders should be used for this presentation. If no 'thumbnail_encoder_ids' are given then no thumbnail playlists will be in the Partial Presentation.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.video_encoder_ids.description
Specify which video encoders should be used for this presentation. If none are specified, all video encoders configured for the parent Publication will be used.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.pdt_on_every_segment.description
When true a #EXT-X-PROGRAM-DATE-TIME tag will be placed on every media segment in media playlists. When false, the default behavior, the PDT tag is set according to the HLS specification.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.signaling_formats.description
Signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering playlists.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.utc_in_segment_title.description
Include a UTC timestamp (that is equivalent in value to #EXT-X-PROGRAM-DATE-TIME) in the title of each media segment in media playlists. Ex. #EXTINF:6.006,LTC=2020-01-01T12:00:00.000Z

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.iframe_only_encoder_ids.description
List of video encoder IDs that should have I-Frame only playlists generated for them.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.master_playlist_name.description
Optional master manifest name. When not supplied a default of 'master' will be used.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.description
Configures defaults used when generating manifests or playlist using the dynamic origin. Cannot be set if this is a playlist-only publication (i.e. contains publish points that specify 'playlist_only_for').

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.description
FallbackDefaults specifies the alternative behavior of the dynamic manifest generator. This behavior is intended to be a simplified configuration comparead to the default behavior so that it can be used as a fallback for when players are encountering issues with the default behavior. Specific behaviors can be overwritten using appropriate query string parameters when making the request for the manifest.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.dash_signaling_formats.description
DASH Signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering DASH manifests.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.duration_seconds.description
Duration is the length of content that will be included in the manifest, in seconds. The max supported DVR window is 12 hours. If not specified, the default duration will be 30 seconds.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.hls_signaling_formats.description
HLS signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering playlists.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.media_url_type.description
Allows specifying url type for HLS media playlists and DASH manifests. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.minimum_update_period_seconds.description
Sets the minimumUpdatePeriod field in MPD to be this value. If set to 0 (default), segment duration is used. The value shall not exceed the 'suggested_presentation_delay_secs'.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.multi_variant_url_type.description
Allows specifying url type for HLS multi-variant playlists. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.pdt_on_every_segment.description
When true a #EXT-X-PROGRAM-DATE-TIME tag will be placed on every media segment in HLS media playlists. When false, the default behavior, the PDT tag is set according to the HLS specification.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.pre_start_duration_seconds.description
Pre Start Duration is the length of content that will be included in the manifest when the start time of a manifest is in the future. When a manifest is near the start time but does not contain 'pre_start_duration_seconds' content Manifest Origin will keep content before the start time to make the manifest length at least 'pre_start_duration_seconds'. If not specified requesting a manifest in the future will result in a 404.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.suggested_presentation_delay_seconds.description
Sets the suggestedPresentationDelay field in MPD to be this value. This value must be greater or equal to 'minimum_update_period_secs'. If unset, the default value will be calculated as 3 * segment target duration.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.description
ManifestDefaults specifies the default behavior of the dynamic manifest generator. Specific behaviors can be overwritten using appropriate query string parameters when making the request for the manifest.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.dash_signaling_formats.description
DASH Signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering DASH manifests.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.duration_seconds.description
Duration is the length of content that will be included in the manifest, in seconds. The max supported DVR window is 12 hours. If not specified, the default duration will be 30 seconds.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.hls_signaling_formats.description
HLS signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering playlists.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.media_url_type.description
Allows specifying url type for HLS media playlists and DASH manifests. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.minimum_update_period_seconds.description
Sets the minimumUpdatePeriod field in MPD to be this value. If set to 0 (default), segment duration is used. The value shall not exceed the 'suggested_presentation_delay_secs'.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.multi_variant_url_type.description
Allows specifying url type for HLS multi-variant playlists. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.pdt_on_every_segment.description
When true a #EXT-X-PROGRAM-DATE-TIME tag will be placed on every media segment in HLS media playlists. When false, the default behavior, the PDT tag is set according to the HLS specification.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.pre_start_duration_seconds.description
Pre Start Duration is the length of content that will be included in the manifest when the start time of a manifest is in the future. When a manifest is near the start time but does not contain 'pre_start_duration_seconds' content Manifest Origin will keep content before the start time to make the manifest length at least 'pre_start_duration_seconds'. If not specified requesting a manifest in the future will result in a 404.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.suggested_presentation_delay_seconds.description
Sets the suggestedPresentationDelay field in MPD to be this value. This value must be greater or equal to 'minimum_update_period_secs'. If unset, the default value will be calculated as 3 * segment target duration.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.retention_minutes.description
RetentionMinutes specifies how long data is retained, in minutes. Live linear (24/7) channels should set this to the longest expected DVR window (a few hours). Live event channels should set this to how Live2VOD playlists are expected to be available. If unspecified, the default will be 60 minutes. The maximum value is 15 days (21600 minutes).

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.packager_id.description
Determines how segments in this publication are packaged. Must reference a packager in 'packaging.packagers'. However, if this is a playlist-only publication (i.e. contains publish points that specify 'playlist_only_for'), this must remain unset as the packager will be inferred from the publication this one is providing playlists for.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.description
HTTP destination where media segments and playlists will be published.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.compression.description
Configures whether or not (and how) to compress manifests being published to the origin. If not specified, manifests will not be compressed.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.cross_playback_paths.description
Cross Playback Paths are playback paths that reference alternative content. These playback paths could reference publish points from the same publication or a completely different encoder and packager altogether. Content published to an endpoint referenced by one of these cross playback paths MUST be of the same Manifest.Type.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.do_not_monitor.description
(Optional) Specifies if this pubpoint should not be monitored by PLM.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.headers.description
Allows custom HTTP headers to be set via configuration for all HTTP requests.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.method.description
Method overrides what HTTP method to specify in requests to the Publish Point. If not specified the service will default to POST.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.playback_base_url.description
The base URL where published playlists will be able to be obtained. This is often different than the publish_base_url for CDN publishing workflows.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.playback_query_params.description
Specifies any query parameters that will be added to playback urls. Should not include the initial '?' Example: 'foo=bar&q=golang'

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.publish_base_url.description
The base URL where generated playlists will be sent/published. Each publish point requires a unique 'publish_base_url'.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.id.description
uniquely identifies this publish_point within a channel configuration. Can be referenced by other publish_points in the 'playlist_only_for' field.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.playlist_only_for.description
playlist_only_for identifies the id of the publish_point that has the segments for this publish_point, which is only publishing a playlist for those segments. All publish_points within a publication must either have 'playlist_only_for' all set or all not set.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.redundant_publishing.description
When redundant publishing is enabled succeeding to publish a given media segment to at least one HTTPPublishPoint in publish_points will result in that segment showing up in manifests as playable content. Will require at least two publish_points defined within the same publication.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.startover.description
Configures startover processing for this Publication.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.startover.properties.first_program_start.description
Trigger Startover on the first Program Start. Only one of ['first_program_start', 'on_airing_id'] may be set.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.startover.properties.on_airing_id.description
Use the Airing Id of a Program Start to trigger a Startover on the first match. Only one of ['first_program_start', 'on_airing_id'] may be set.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.startover.properties.on_airing_id.properties.airing_id.description
Airing Id is a SCTE-35 Segmentation Unique Program ID (UPID) of type 0x08 used to specify the unique airing of a program. Is a 8 byte hex encoded string that is prepended with '0x'.

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.thumbnail_encoder_ids.description
Optional: Specify what thumbnail_encoders should be in this Publication

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.use_strict_bitrate.description
Optional, indicates whether we should pad the bitrate (false) or use what is explicitly provided (true)

# components.schemas.patch-org-channel-request.properties.publishing.properties.publications.items.properties.video_encoder_ids.description
Optionally specify which video encoders should be used for this publication. If none are specified, all video encoders configured for the transcoder will be used.

# components.schemas.patch-org-channel-request.properties.publishing.properties.rtmp_publications.description
A set of configurations for delivering RTMP streams

# components.schemas.patch-org-channel-request.properties.publishing.properties.srt_publications.description
A set of configurations for delivering SRT streams

# components.schemas.patch-org-channel-request.properties.publishing.properties.srt_publications.items.properties.audio_encoders.items.properties.pid.description
Output MPEG-TS PID. PIDs should be set on the PMT, SCTE-35 and all encoders or none. Valid PIDs must 13-bit values greater than 31. If no PIDs are provided (pid == 0) then they will be generated automatically.

# components.schemas.patch-org-channel-request.properties.publishing.properties.srt_publications.items.properties.pmt_pid.description
MPEG-TS PMT PID. PIDs should be set on the PMT, SCTE-35 and all encoders or none. Valid PIDs must 13-bit values greater than 31. If no PIDs are provided (pid == 0) then they will be generated automatically.

# components.schemas.patch-org-channel-request.properties.publishing.properties.srt_publications.items.properties.scte35_pid.description
MPEG-TS SCTE-35 PID. PIDs should be set on the PMT, SCTE-35, and all encoders or none. Valid PIDs must 13-bit values greater than 31. If no PIDs are provided (pid == 0) then they will be generated automatically.

# components.schemas.patch-org-channel-request.properties.publishing.properties.srt_publications.items.properties.video_encoders.items.properties.pid.description
Output MPEG-TS PID. PIDs should be set on the PMT, SCTE-35 and all encoders or none. Valid PIDs must 13-bit values greater than 31. If no PIDs are provided (pid == 0) then they will be generated automatically.

# components.schemas.patch-org-channel-request.properties.region.description
Region represents the general geolocation for transcoding and stream egress from iStreamPlanet. If no region is provided at channel creation time, then 'US_WEST' is used.

# components.schemas.patch-org-channel-request.properties.resource_class.description
If the ResourceClass is unspecified the channel will default to run in the 'DYNAMIC' ResourceClass. Note that changing the ResourceClass for a running channel is supported and will be performed with no downtime.

# components.schemas.patch-org-channel-request.properties.signaling.description
Signaling configures in-band signaling (i.e. SCTE-35).

# components.schemas.patch-org-channel-request.properties.signaling.properties.blackout_settings.description
Configure blackout: replacing content with custom slates based on program signaling.

# components.schemas.patch-org-channel-request.properties.signaling.properties.blackout_settings.properties.default_blackout_slate_url.description
Default slate URL to use for blackouts. Can be overridden by the 'slates' field.

# components.schemas.patch-org-channel-request.properties.signaling.properties.blackout_settings.properties.force_blackout_segments.description
List of signaling segment types to force blackout, e.g. add 'SPLICE_INSERT' to blackout all ads signaled via SCTE-35 splice_insert.

# components.schemas.patch-org-channel-request.properties.signaling.properties.blackout_settings.properties.honor_web_delivery_restriction.description
Determines whether to honor the web_delivery_allowed attribute in SCTE-35 segmentation descriptors. When this is enabled, a segmentation descriptor with web_delivery_allowed=false will trigger a blackout.

# components.schemas.patch-org-channel-request.properties.signaling.properties.blackout_settings.properties.slates.items.properties.blackout_slate_url.description
Blackout slate URL to use for the specified segments. It must have one audio and one video stream. Either MPEG2 or H.264 can be used.

# components.schemas.patch-org-channel-request.properties.signaling.properties.blackout_settings.properties.slates.items.properties.segments.description
Segment types that shall utilize the blackout slate URL. Any segment type defined here _must_ also be present in the parent signaling configuration.

# components.schemas.patch-org-channel-request.properties.signaling.properties.blackout_settings.properties.slates.items.properties.upids.description
Exclusive list of hex string encoded colon separated UPID Type:ID pairs (e.g. '0A:1A2B3C4D') to enable this blackout slate on.

# components.schemas.patch-org-channel-request.properties.signaling.properties.disable_inband_parsing.description
Disable parsing SCTE-35 in-band signaling. Out-of-band signaling is still allowed.

# components.schemas.patch-org-channel-request.properties.signaling.properties.scte_pid.description
Defines the specific PID containing the SCTE that the transcoder should process. Using '0' (default value) will pick the first PID containing SCTE-35 in the PMT.

# components.schemas.patch-org-channel-request.properties.signaling.properties.segment_settings.description
Settings that apply to specific segments.

# components.schemas.patch-org-channel-request.properties.signaling.properties.segment_settings.items.properties.default_duration_secs.description
Specifies the duration of a segment when the in-band SCTE-35 that initiates it (e.g. Distributor Placement Opportunity Start) is missing an explicit duration. N.B. for program and ad types, this also affects 'Simple Program' and 'Simple Ad' markers, respectively.

# components.schemas.patch-org-channel-request.properties.signaling.properties.segment_settings.items.properties.emit_default_duration.description
Determines whether to include the default duration in the output SCTE-35 messages when the input SCTE-35 message did not specify a duration.

# components.schemas.patch-org-channel-request.properties.signaling.properties.segment_settings.items.properties.offset_millis.description
Specifies a 'correction' to the splice_time of in-band SCTE-35 in milliseconds.

# components.schemas.patch-org-channel-request.properties.signaling.properties.segment_settings.items.properties.segment_end_mode.description
Determines which Segment End signaling mode to use for the provided segments. If unspecified, defaults to MATCH_END_EVENT_ID.

# components.schemas.patch-org-channel-request.properties.signaling.properties.segment_settings.items.properties.segments.description
Specifies the list of which segment types this setting applies to. Any segment type defined here _must_ also be present in the parent signaling configuration.

# components.schemas.patch-org-channel-request.properties.signaling.properties.segment_settings.items.properties.tier_filter.description
Specifies how to filter the provided segments, when received through in-band SCTE-35, based on the SCTE-35 SpliceInfoSection Tier.

# components.schemas.patch-org-channel-request.properties.signaling.properties.segment_settings.items.properties.tier_filter.properties.explicit_tier.description
Only one of ['explicit_tier'] may be set.

# components.schemas.patch-org-channel-request.properties.signaling.properties.segments.description
Segment types to process for in-band signaling.

# components.schemas.patch-org-channel-request.properties.tags.description
Use ChannelMetadata when possible instead of tags.

# components.schemas.patch-org-channel-request.properties.tags.properties.monitored.description
Indicates whether this channel is monitored by automation.

# components.schemas.patch-org-channel-request.properties.transcode.properties.audio_encoders.description
Audio encoders specify audio conversion settings, e.g. channels, samples, codec, bitrate, etc.

# components.schemas.patch-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.audio_source_id.description
Audio source ID specifies which stream within the audio source to use.

# components.schemas.patch-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.bit_rate.description
Bit rate specifies the constant number of bits used per second. Higher values result in better audio quality but bigger file sizes.

# components.schemas.patch-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.channels.description
Channels specifies the number of real audio channels to encode. The available options depend on the audio codec. The encoder supports different channel configurations based on the codec; AAC 1-2 channels, AC3 supports 2 or 6, and EAC3 supports 2 or 6. For example, for AC3 5.1 one would set 6 channels. Channel configurations are as follows: 1 - Mono (C) 2 - Stereo / Dolby 2.0 (L, R) 6 - Dolby 5.1 (L, C, R, l, r, LFE) Dolby Atmos layouts such as 5.1.4 are achieved by setting this field to 6 and configuring ddp_joc_logical_channels in EAC3Settings as desired.

# components.schemas.patch-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.codec.description
Codec specifies the audio data encoding format.

# components.schemas.patch-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.eac3.properties.ddp_joc_logical_channels.description
If non-zero, configures the encoder to compute JOC metadata (i.e. Dolby Atmos) for the given logical speaker layout. The transcoder does not guarantee any particular bed layout in the JOC metadata, and this setting currently has no effect on that. It merely determines the channel layout to which all inputs are converted before encoding. Legal values are: 8 - 5.1.2 10 - 5.1.4 For sources with raw PCM input and more than 6 channels, configure this according to the expected input channel layout. For channels which expect to take a 7.1 EAC-3 input, configure to 8. For all other cases, including upmixing from 5.1 or fewer channels or any kind of Atmos input, configure to 10. This setting is mutually exclusive with ddp_joc_passthrough. This setting has no effect on the current production version of the transcoder, nor does the current production version of the transcoder support raw PCM inputs.

# components.schemas.patch-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.eac3.properties.ddp_joc_passthrough.description
Indicates that the source will contain Joint Object Coding metadata (Dolby Atmos) and that the encoder should operate in passthrough mode. https://learning.dolby.com/hc/en-us/articles/4406039180564-Appendix-C-Dolby-Atmos-Delivery-Codecs- When the audio encoder is configured with this setting, the source audio will be repackaged without being decoded and re-encoded. If the source is not DD+JOC, it will be replaced with silence.

# components.schemas.patch-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.eac3.properties.drc_line_mode.description
If specified, overrides the dynamic range control line mode. If unspecified and the source audio is AC-3 or EAC-3, the DRC line mode matches the input. If unspecified and the source audio is any other codec, the encoder uses an unspecified default which may change without notice. This setting has no effect on transcoder versions which do not support Atmos encoding.

# components.schemas.patch-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.eac3.properties.drc_rf_mode.description
If specified, overrides the dynamic range control RF mode. If unspecified and the source audio is AC-3 or EAC-3, the DRC RF mode matches the input. If unspecified and the source audio is any other codec, the encoder uses an unspecified default which may change without notice. This setting has no effect on transcoder versions which do not support Atmos encoding.

# components.schemas.patch-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.eac3.properties.surround_phase_shift.description
If specified, overrides whether surround phase shift is enabled. If unspecified and the source audio is AC-3 or EAC-3, the surround phase shift mode matches the input. If unspecified and the source audio is any other codec, the encoder uses an unspecified default which may change without notice. This setting has no effect on transcoder versions which do not support Atmos encoding.

# components.schemas.patch-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.id.description
Encoder ID. IDs must be unique for all encoders. This ID is referenced when setting up playlist publishing.

# components.schemas.patch-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.loudness.description
Loudness normalization settings. Loudness configuration is required for non-passthrough AC-3 and EAC-3.

# components.schemas.patch-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.loudness.properties.dialog_intel.description
Enable Dialog Intelligence. Only supported for (E)AC-3 encoders. This may only be set if lkfs is explicitly configured to -24.

# components.schemas.patch-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.loudness.properties.lkfs.description
Loudness normalization LKFS setting. Default value is -24.

# components.schemas.patch-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.loudness.properties.peak_limit.description
Peak Limit. The only allowable value is -2.0. This field is soft-deprecated and will be unsupported in a future transcoder version. In the current transcoder version, the values 0.0 and -2.0 both produce the same configuration.

# components.schemas.patch-org-channel-request.properties.transcode.properties.debug_overlay.description
Deprecated: Do not use. Debug_overlay overlays debugging information from the transcoder into the top right of the video output. The overlay is burned into the video and will be visible to end-users if enabled. Do not enable on customer facing channels. Requires a transcoder restart if the state is changed. The default value is false, which disables the overlay. This setting is deprecated in favour of debug_overlays.

# components.schemas.patch-org-channel-request.properties.transcode.properties.debug_overlays.description
The debug_overlays specifies the position of the debugging overlay information from the transcoder into each video output. The overlay is burned into the video and will be visible to end-users if enabled. The default position value is OFF, which results in no debug overlay. Do not enable on customer facing channels. Requires a transcoder restart if the state is changed.

# components.schemas.patch-org-channel-request.properties.transcode.properties.debug_overlays.properties.position.description
Position of the debug overlay within the output frame.

# components.schemas.patch-org-channel-request.properties.transcode.properties.feature_flags.description
Feature flag strings enable experimental transcode features or functionality that are not yet or never will be promoted to the channeldoc model proper. Do not enable on customer facing channels.

# components.schemas.patch-org-channel-request.properties.transcode.properties.id3_mode.description
Specify how to process ID3 tags from the input source. If not specified, ID3 tags in the source will be ignored.

# components.schemas.patch-org-channel-request.properties.transcode.properties.overlays.description
List of overlays. An overlay is an image that will be rendered on top of the source video. Only one overlay is supported at the moment. If specified, the overlay will be always rendered unless a video slate is on.

# components.schemas.patch-org-channel-request.properties.transcode.properties.overlays.items.properties.image_url.description
The URL of the image overlay. Only PNG is supported at the moment. The image's dimensions should match those of source for perfect pixel placement.

# components.schemas.patch-org-channel-request.properties.transcode.properties.resize_mode.description
Resize mode specifies how to scale a video up or down to match the output dimensions.

# components.schemas.patch-org-channel-request.properties.transcode.properties.segmenter.description
Segmenter configures how video GOPs and segments get generated.

# components.schemas.patch-org-channel-request.properties.transcode.properties.segmenter.properties.gop_duration_secs.description
GOP (group of pictures) duration specifies the amount of time between I-frames. Shorter durations can lower quality slightly as each I-frame uses more bits than P- & B-frames but can provide a better seeking experience when enabling thumbnail encoders and/or I-Frame Only playlists.

# components.schemas.patch-org-channel-request.properties.transcode.properties.segmenter.properties.segment_duration_secs.description
Segment duration specifies the target duration of a single segment. Segments shorter than this duration can occur at signaling boundaries. This value _must_ be a multiple of the GOP duration value.

# components.schemas.patch-org-channel-request.properties.transcode.properties.segmenter.properties.temi.description
Include TEMI (Timeline and External Media Information ISO/IEC 13818-1:2019 Annex U) to mpeg-ts segments.

# components.schemas.patch-org-channel-request.properties.transcode.properties.subtitle_encoders.description
Subtitle encoders specify how text-based subtitles are extracted into separate segments. They are not used to describe CEA 608 captions, which remain part of the video codec.

# components.schemas.patch-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.atsc_captions.description
Extract subtitles from the ATSC caption encodings. The captions themselves are first sourced according to the Source.captions_source field. Only one of ['teletext', 'atsc_captions'] may be set.

# components.schemas.patch-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.atsc_captions.properties.cea608.description
If non-zero, decode captions from the CEA-608 logical channel number identified by this number. If zero, only CTA-708 captions will be decoded. The 'logical channel number' refers to the CCx name commonly used in literature: - CC1 is the NTSC odd field subchannel 1, considered the primary caption stream. - CC2 is the NTSC odd field subchannel 2, considered the tertiary caption stream. - CC3 is the NTSC even field subchannel 1, considered the secondary caption stream. - CC4 is the NTSC even field subchannel 2, considered the quaternary caption stream.

# components.schemas.patch-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.atsc_captions.properties.cta708.description
If non-zero, decode captions from the CTA-708 service identified by this number. If zero, only CEA-608 captions will be decoded. It is allowed to set both 'cta708' and 'cea608'. In this case, the transcoder will decode both streams, and will use the CTA-708 data if the stream is active and fall back to CEA-608 otherwise. Fallback from CTA-708 to CEA-608 requires a timeout to elapse, but switching from CEA-608 to CTA-708 occurs the instant the CTA-708 stream becomes active. CTA-708 recommends the following correspondence between the two encodings: - CTA-708 service 1 == CEA-608 CC1 (primary captions) - CTA-708 service 2 == CEA-608 CC3 (secondary captions) - CTA-708 service 3 == CEA-608 CC2 (tertiary captions) - CTA-708 service 4 == CEA-608 CC4 (quaternary captions) However, some sources use an alternate convention where CTA-708 service 3 is the secondary caption service (corresponding to CC3) and CTA-708 service 2 is the tertiary caption service.

# components.schemas.patch-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.id.description
Encoder ID. IDs must be unique for all encoders. This ID is referenced when setting up playlist publishing.

# components.schemas.patch-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.language.description
Language is the code for the language in which the subtitles are written.

# components.schemas.patch-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.teletext.description
Extract subtitles from an embedded Teletext stream. The teletext PID is determined automatically. Only one of ['teletext', 'atsc_captions'] may be set.

# components.schemas.patch-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.teletext.properties.charset_set.description
If set, forces interpretation of the National Option field to choose from character sets in this specific set of character sets. Determining the correct value for this configuration is non-trivial, but there are some guidelines. Usually, all languages in one Teletext stream will use the same charset set. If only one set can handle all the languages, it's probably that one. Some of the sets roughly correspond to geopolitical divisions from the Cold War era: SET3 is roughly Yugoslavia plus Romania; SET4 is the rest of the former USSR/Warsaw Pact, including East Germany but excluding Poland; SET8 is Africa; SET10 is the Middle East. There does not seem to be any standard name for this configuration. The standard calls it 'the upper four bits of Triplet 1', which is highly ambiguous and nonsensical outside of the context of that usage. The decoder ffmpeg uses calls it 'region', but most of the sets cannot cleanly be described as any particular geographic region.

# components.schemas.patch-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.teletext.properties.language.description
The three-letter language code declared in the Teletext descriptor in the source PMT. If the language is not found, the subtitles will be empty. language + type configuration is mutually exclusive with magazine + page configuration.

# components.schemas.patch-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.teletext.properties.magazine.description
The teletext magazine number where the subtitles are found. magazine + page configuration is mutually exclusive with language + type configuration.

# components.schemas.patch-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.teletext.properties.page.description
The teletext page number where the subtitles are found. magazine + page configuration is mutually exclusive with language + type configuration.

# components.schemas.patch-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.teletext.properties.page_type.description
The Teletext page type declared in the Teletext descriptor in the source PMT. If this field is unset, it will be inferred from the 'usage' field on the SubtitleEncoder using this table: SubtitleEncoder.CLOSED_CAPTIONS => TeletextSource.PAGE_TYPE_SUBTITLE_HEARING_IMPAIRED SubtitleEncoder.SUBTITLES => TeletextSource.PAGE_TYPE_SUBTITLE

# components.schemas.patch-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.usage.description
Usage indicates how this encoder should be flagged in generated manifests.

# components.schemas.patch-org-channel-request.properties.transcode.properties.thumbnail_encoders.description
Thumbnail encoders specify how to create image snapshots of the video stream.

# components.schemas.patch-org-channel-request.properties.transcode.properties.thumbnail_encoders.items.properties.height.description
Height specifies the thumbnail image height in pixels.

# components.schemas.patch-org-channel-request.properties.transcode.properties.thumbnail_encoders.items.properties.id.description
Encoder ID. IDs must be unique for all encoders. This ID is referenced when setting up playlist publishing.

# components.schemas.patch-org-channel-request.properties.transcode.properties.thumbnail_encoders.items.properties.width.description
Width specifies the thumbnail image width in pixels.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.description
Video encoders specify video conversion settings, e.g. dimensions, codec, bitrate, etc.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.bit_rate.description
Bit rate specifies the number in bits used per second. Higher values result in better video quality but bigger file sizes. For H.264 this value is the target of the constrained variable bit rate.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.frame_rate.description
Frame rate specifies the number of images that are shown per second when playing back the video. For the best quality playback, this should match or be a multiple of the input source video stream.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h264.description
Configure the encoder to use the H.264 codec. Only one of ['H264Settings', 'H265Settings'] may be set.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h264.properties.profile.description
H.264 video profile, which defines various encoder features and settings. See https://en.wikipedia.org/wiki/Advanced_Video_Coding#Profiles for details.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.description
Configure the encoder to use the H.265 codec. Only one of ['H264Settings', 'H265Settings'] may be set.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.description
Only one of ['hdr10', 'dolby_vision'] may be set.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile5.description
Only one of ['profile5', 'profile81', 'profile84'] may be set.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile81.description
Only one of ['profile5', 'profile81', 'profile84'] may be set.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile81.properties.clli.properties.max_fall.description
Maximum Frame-Average Light Level (nits).

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile81.properties.mdcv.properties.color_profile.description
Identifies color primaries and white point.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile81.properties.mdcv.properties.max_dml.description
Maximum display mastering luminance (nits). Must be greater than min_dml.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile81.properties.mdcv.properties.min_dml.description
Minimum display mastering luminance (nits).

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile84.description
Only one of ['profile5', 'profile81', 'profile84'] may be set.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.hdr10.description
Only one of ['hdr10', 'dolby_vision'] may be set.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.hdr10.properties.clli.properties.max_fall.description
Maximum Frame-Average Light Level (nits).

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.hdr10.properties.mdcv.properties.color_profile.description
Identifies color primaries and white point.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.hdr10.properties.mdcv.properties.max_dml.description
Maximum display mastering luminance (nits). Must be greater than min_dml.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.hdr10.properties.mdcv.properties.min_dml.description
Minimum display mastering luminance (nits).

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.height.description
Height specifies the video height in pixels. Must be a multiple of two. Valid resolution ranges, width x height are: H.264: 2x2 to 1920x1080 H.265: 130x34 to 3840x2160

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.id.description
Encoder ID. IDs must be unique for all encoders. This ID is referenced when setting up playlist publishing.

# components.schemas.patch-org-channel-request.properties.transcode.properties.video_encoders.items.properties.width.description
Width specifies the video width in pixels. Must be a multiple of two. Valid resolution ranges, width x height are: H.264: 2x2 to 1920x1080 H.265: 130x34 to 3840x2160

# components.schemas.patch-org-channel-request2.items.properties.from.description
JSON Pointer for the source of a move or copy

# components.schemas.patch-org-channel-request2.items.properties.path.description
JSON Pointer to the field being operated on, or the destination of a move/copy operation

# components.schemas.put-org-channel-request.properties.$schema.description
An optional URL to a JSON Schema document describing this resource

# components.schemas.put-org-channel-request.properties.enable_byoip.description
Indicates whether the channel's transcoder needs to run in a designated IP range.

# components.schemas.put-org-channel-request.properties.id.description
External Channel ID provided at channel creation time

# components.schemas.put-org-channel-request.properties.ingest.description
Ingest configures inputs for the transcoder.

# components.schemas.put-org-channel-request.properties.ingest.properties.slate.description
Slate configures default slating behavior.

# components.schemas.put-org-channel-request.properties.ingest.properties.slate.properties.source_loss_url.description
Source loss URL defines the location of the TS file to play when no source is available. It must have one audio and one video stream. Either MPEG2 or H.264 can be used.

# components.schemas.put-org-channel-request.properties.ingest.properties.source.description
Source provides a reference to the input media stream for this channel.

# components.schemas.put-org-channel-request.properties.ingest.properties.source.properties.audio_sources.items.properties.license.description
License specifies how the audio in this source is licensed.

# components.schemas.put-org-channel-request.properties.ingest.properties.source.properties.audio_sources.items.properties.name.description
Language fiendly name, e.g. 'English', 'Spanish'

# components.schemas.put-org-channel-request.properties.ingest.properties.source.properties.captions_source.description
Closed captions source embedding. If unspecified, defaults to ATSC_A53.

# components.schemas.put-org-channel-request.properties.ingest.properties.source.properties.video_source.description
Additional information about the source video stream. This is only used to configure the transcoder compute resources to account for scaling and colorspace conversion of the source input.

# components.schemas.put-org-channel-request.properties.ingest.properties.source.properties.video_source.properties.dynamic_range.description
The highest dynamic range the source will ever send to the transcoder.

# components.schemas.put-org-channel-request.properties.ingest.properties.source.properties.video_source.properties.max_resolution.description
The maximum resolution the source will ever send to the transcoder.

# components.schemas.put-org-channel-request.properties.labels.description
Optional labels for a channel. Any included labels must be at least 1 character long, but no greater than 256 characters. The maximum number of labels is 10.

# components.schemas.put-org-channel-request.properties.modified.description
Date and time the channel was last modified.

# components.schemas.put-org-channel-request.properties.name.description
A friendly human-readable name for the channel. This will get displayed in user interfaces.

# components.schemas.put-org-channel-request.properties.packaging.description
Packaging configures media format and content protection settings.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.description
Defines the list of packagers available for Publications.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.description
Configures how to protect packaged media segments.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.atlas.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.atlas.properties.asset_id.description
The Asset Identifier which was taken from the token entitlement service request.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.atlas.properties.company_id.description
The Identifier of the Company that this token belongs.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.atlas.properties.widevine_v0_pssh_box.description
When TRUE the KeyID is not embedded in the pssh box which sets the version to 0. Defaults to generating v1 pssh_boxes that includes the key_id

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.bulk_file.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.bulk_file.properties.iv_rotation.description
How often the IV should be rotated and how it should be created

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.common.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.common.properties.scheme_type.description
Defines the scheme that can be used with Common Encryption

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.certificates_id.description
Unique ID used for certificate settings, unique per distributor.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.content_id.description
(Optional) Content ID that identifies this channel in the CPIX service. Value is defined by the DRM system owner, and if defined will be included as part of a POST request.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.credentials_id.description
Unique ID used for credentials settings, unique per distributor.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.decryption_key_id.description
Unique ID of the decryption key to use in case the server response contains content keys encrypted. The key is unique per distirutor, and configured ahead of time by the publishing team and the CPIX service owner.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.drms.description
(Optional) DRM system keys to request. If not defined a GET request will be done, and any key returned will be handled. If defined, random kid(s) (key ids) will be generated on rotation for each DRM system, and a POST request will be done to create them.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.cpix.properties.headers_id.description
(Optional) An identifier to a list of HTTP headers to be added to the request sent to the CPIX service.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.key_rotation.properties.interval_secs.description
Rotate keys based on the specified time interval. If Program is also provided then this time interval will only apply to media segments that are outside of program boundaries. If Program is NOT provided then only this time interval will be used to decided when to rotate keys.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.key_rotation.properties.program.description
Rotate keys on (SCTE35) program boundaries such that no two programs will be protected with the same key.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.key_rotation.properties.program_overlap_skip_encrypt.description
Do not encrypt segments that are part of more than one SCTE-35 program.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.sample_aes.description
Only one of ['bulk_file', 'sample_aes', 'common'] may be set.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.description
Only one of ['simple', 'atlas', 'cpix'] may be set.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.description
Pub points where keys should be published. If multiple are specified, only one needs to succeed to consider the key successfully published.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.compression.description
Configures whether or not (and how) to compress manifests being published to the origin. If not specified, manifests will not be compressed.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.cross_playback_paths.description
Cross Playback Paths are playback paths that reference alternative content. These playback paths could reference publish points from the same publication or a completely different encoder and packager altogether. Content published to an endpoint referenced by one of these cross playback paths MUST be of the same Manifest.Type.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.do_not_monitor.description
(Optional) Specifies if this pubpoint should not be monitored by PLM.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.headers.description
Allows custom HTTP headers to be set via configuration for all HTTP requests.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.method.description
Method overrides what HTTP method to specify in requests to the Publish Point. If not specified the service will default to POST.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.playback_base_url.description
The base URL where published playlists will be able to be obtained. This is often different than the publish_base_url for CDN publishing workflows.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.playback_query_params.description
Specifies any query parameters that will be added to playback urls. Should not include the initial '?' Example: 'foo=bar&q=golang'

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.publish_points.items.properties.publish_base_url.description
The base URL where generated playlists will be sent/published. Each publish point requires a unique 'publish_base_url'.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.content_protection.properties.simple.properties.require_publish.description
Indicates which publish points must succeed for segment publishing to use the keys.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.mp2t.description
Uses MP2T format for each segments. Only one of ['mp2t', 'mp4'] may be set.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.mp2t.properties.force_unmuxed_audio.description
Forces the Video and Audio Encodings to be unmuxed when there is one audio encodings. This setting will have to be uniformed across MP2T packagers within a config. When there are two or more audio encodings, unmuxed will be used automatically.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.mp2t.properties.insert_id3_utc_time.description
If true, insert ID3 tags that include a UTC timestamp. This is a Turner/WM-specific extension.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.mp4.description
Uses MP4 format for each segments. Only one of ['mp2t', 'mp4'] may be set.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.mp4.properties.caption_placement.description
CaptionPlacement defines where caption messages should be placed in the output MP4.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.mp4.properties.insert_pssh_box.description
Insert pssh boxes generated by content protection into packaged segments. Defaults to not insert pssh boxes to the packaged segments.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.ttml.description
Only one of ['web_vtt', 'ttml'] may be set.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.web_vtt.description
Only one of ['web_vtt', 'ttml'] may be set.

# components.schemas.put-org-channel-request.properties.packaging.properties.packagers.additionalProperties.properties.web_vtt.properties.file_format.description
The file format used to encapsulate the WebVTT segments.

# components.schemas.put-org-channel-request.properties.publishing.description
Publishing configures playlist formats and where to send video and playlist data.

# components.schemas.put-org-channel-request.properties.publishing.properties.closed_caption_streams.description
Configures how captioning information, which references CEA-608 captions embedded in video segments, is published.

# components.schemas.put-org-channel-request.properties.publishing.properties.closed_caption_streams.items.properties.auto_select.description
Indicates that the client should play the captioning media selection group if the user has not indicated a user preference. If both auto_select and default are not set, the first captioning media selection group will be used.

# components.schemas.put-org-channel-request.properties.publishing.properties.closed_caption_streams.items.properties.default.description
Configures the captioning media selection group that will be played if the user has not indicated a user preference. If both auto_select and default are not set, the first captioning media selection group will be used.

# components.schemas.put-org-channel-request.properties.publishing.properties.closed_caption_streams.items.properties.language.description
Language code as RFC 5646, e.g. 'en' 'en-US'.

# components.schemas.put-org-channel-request.properties.publishing.properties.feature_flags.description
Set of string identifiers corresponding to features that this Channel is opting in.

# components.schemas.put-org-channel-request.properties.publishing.properties.live2vod.description
Live2VOD configuration used to archive the channel data, this allows clip creation after the content is no longer live.

# components.schemas.put-org-channel-request.properties.publishing.properties.live2vod.properties.clear_capture.description
BETA - (Optional) Indicates whether the system should send the unpackaged segments produced from the transcoder to the L2V system for purposes of creating mp4s and/or repackaging.

# components.schemas.put-org-channel-request.properties.publishing.properties.live2vod.properties.product_id.description
Product ID that VODs will be associated with in the Live2VOD system. The value of this ID is pre-configured in the Live2VOD portal.

# components.schemas.put-org-channel-request.properties.publishing.properties.live2vod.properties.retention_days.description
Specifies the retention time, in days, for archived content.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.description
A set of individual configurations that each can configure a specific destination and mechanism of delivery for segments and/or playlists.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.audio_encoder_ids.description
Optionally specify which audio encoders should be used for this publication. If none are specified, all audio encoders configured for the transcoder will be used.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.create_vods.description
Create VODs for all publish points in this publication. Note that Live2VOD must also be configured for the parent |Channel|.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.dash.description
DASH configures publication settings. Only one of HLS or DASH can be set.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.dash.properties.minimum_update_period_secs.description
Sets the minimumUpdatePeriod field in MPD to be this value. If set to 0 (default), segment duration is used. The value shall not exceed the 'suggested_presentation_delay_secs'.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.dash.properties.signaling_formats.description
Signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering playlists.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.dash.properties.suggested_presentation_delay_secs.description
The suggested amount of time (in seconds) the player should be behind the live stream. This value must be greater or equal to 'minimum_update_period_secs'.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.dash.properties.url_type.description
If set to 'URL_TYPE_UNDEFINED' playlist generation will use 'RELATIVE'.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.drms.description
Optionally specify which DRMs to advertise in the playlist. If specified, this must be a subset of the DRMs specified by the packager associated with this publication. If omitted or empty, all DRMs specified by the packager will be advertised. This setting can only be used for HLS playlists.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.dvr_window_secs.description
DVR window is the max sum(duration of media segments) that will be kept in a manifest at a given time in seconds. The max supported DVR window is 10 hours.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.fer_audio_encoder_ids.description
Optionally specify which audio encoders should be used when generating the FER of this Presentation, this overrides the 'audio_encoder_ids' used during the live portion. If none are specified, the 'audio_encoder_ids' field will be used.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.description
HLS configures publication settings. Only one of HLS or DASH can be set.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.audio_only_variants.description
Defines how audio only variant streams are included in the master playlist, where the variant streams are defined by #EXT-X-STREAM-INF tag, the tag attributes provide information about the Stream. The INCLUDE_DEFAULT option - only the default 'audio only variant stream' is included in master playlist. This is the most common use case. INCLUDE_NONE - no audio only variant streams are included in the master playlist. INCLUDE_ALL - include all audio only variant streams in the master playlist.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.gap_tags.description
Allows turning gap tags ON/OFF. When turned ON - the tag '#EXT-X-GAP' is inserted into media playlist for a missing segment. When turned OFF - Discontinuity is inserted into the playlist for missing segment(s). The default option UNDEFINED is mapped to OFF. Note: Gap tags are always inserted for the missing thumbnail segments independently of this setting

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.master_publish_frequency_secs.description
How often the multi-variant playlist(s) should be published (in seconds) once a channel is started. If 0 (not provided), defaults to 1 hour. The following can also result in re-publishing of multi-variant playlists: - Configuration changes related to transcoding configuration (i.e. adding, removing, changing encoders). - Service code changes related to manifest generation.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.master_url_type.description
Allows specifying url type for HLS master playlists. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.media_url_type.description
Allows specifying url type for HLS media playlists. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.description
Specify which partial presentations should be used for this presentation. Partial presentations are additional master playlists that point to a subset of the parent presentation's media streams/variant playlists.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.audio_encoder_ids.description
Specify which audio encoders should be used for this presentation. If none are specified, all audio encoders configured for the parent Publication will be used.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.fer_audio_encoder_ids.description
Optionally specify which audio encoders should be used when generating the FER of this Partial Presentation, this overrides the 'audio_encoder_ids' used during the live portion. If none are specified, the 'audio_encoder_ids' field will be used. NOTE: This MUST only be used with push based manifest. Ignore this field when using Aventus Origin with Dynamic Manifests. Instead use the AudioSource.License field.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.iframe_only_encoder_ids.description
List of video encoder IDs that should have I-Frame only playlists generated for them. If no 'iframe_only_encoder_ids' are given then no I-Frame playlists will be in the Partial Presentation.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.playlist_path.description
Sub-path that will be appended onto the publish and playback base URLs of HTTP PublishPoints for published playlist files.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.thumbnail_encoder_ids.description
Specify which thumbnail encoders should be used for this presentation. If no 'thumbnail_encoder_ids' are given then no thumbnail playlists will be in the Partial Presentation.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.partial_presentations.items.properties.video_encoder_ids.description
Specify which video encoders should be used for this presentation. If none are specified, all video encoders configured for the parent Publication will be used.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.pdt_on_every_segment.description
When true a #EXT-X-PROGRAM-DATE-TIME tag will be placed on every media segment in media playlists. When false, the default behavior, the PDT tag is set according to the HLS specification.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.signaling_formats.description
Signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering playlists.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.hls.properties.utc_in_segment_title.description
Include a UTC timestamp (that is equivalent in value to #EXT-X-PROGRAM-DATE-TIME) in the title of each media segment in media playlists. Ex. #EXTINF:6.006,LTC=2020-01-01T12:00:00.000Z

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.iframe_only_encoder_ids.description
List of video encoder IDs that should have I-Frame only playlists generated for them.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.master_playlist_name.description
Optional master manifest name. When not supplied a default of 'master' will be used.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.description
Configures defaults used when generating manifests or playlist using the dynamic origin. Cannot be set if this is a playlist-only publication (i.e. contains publish points that specify 'playlist_only_for').

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.description
FallbackDefaults specifies the alternative behavior of the dynamic manifest generator. This behavior is intended to be a simplified configuration comparead to the default behavior so that it can be used as a fallback for when players are encountering issues with the default behavior. Specific behaviors can be overwritten using appropriate query string parameters when making the request for the manifest.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.dash_signaling_formats.description
DASH Signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering DASH manifests.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.duration_seconds.description
Duration is the length of content that will be included in the manifest, in seconds. The max supported DVR window is 12 hours. If not specified, the default duration will be 30 seconds.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.hls_signaling_formats.description
HLS signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering playlists.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.media_url_type.description
Allows specifying url type for HLS media playlists and DASH manifests. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.minimum_update_period_seconds.description
Sets the minimumUpdatePeriod field in MPD to be this value. If set to 0 (default), segment duration is used. The value shall not exceed the 'suggested_presentation_delay_secs'.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.multi_variant_url_type.description
Allows specifying url type for HLS multi-variant playlists. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.pdt_on_every_segment.description
When true a #EXT-X-PROGRAM-DATE-TIME tag will be placed on every media segment in HLS media playlists. When false, the default behavior, the PDT tag is set according to the HLS specification.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.pre_start_duration_seconds.description
Pre Start Duration is the length of content that will be included in the manifest when the start time of a manifest is in the future. When a manifest is near the start time but does not contain 'pre_start_duration_seconds' content Manifest Origin will keep content before the start time to make the manifest length at least 'pre_start_duration_seconds'. If not specified requesting a manifest in the future will result in a 404.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.fallback_defaults.properties.suggested_presentation_delay_seconds.description
Sets the suggestedPresentationDelay field in MPD to be this value. This value must be greater or equal to 'minimum_update_period_secs'. If unset, the default value will be calculated as 3 * segment target duration.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.description
ManifestDefaults specifies the default behavior of the dynamic manifest generator. Specific behaviors can be overwritten using appropriate query string parameters when making the request for the manifest.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.dash_signaling_formats.description
DASH Signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering DASH manifests.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.duration_seconds.description
Duration is the length of content that will be included in the manifest, in seconds. The max supported DVR window is 12 hours. If not specified, the default duration will be 30 seconds.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.hls_signaling_formats.description
HLS signaling formats specifies which SCTE-35 timeline marker formatting to use when rendering playlists.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.media_url_type.description
Allows specifying url type for HLS media playlists and DASH manifests. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.minimum_update_period_seconds.description
Sets the minimumUpdatePeriod field in MPD to be this value. If set to 0 (default), segment duration is used. The value shall not exceed the 'suggested_presentation_delay_secs'.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.multi_variant_url_type.description
Allows specifying url type for HLS multi-variant playlists. If not provided, playlist generation will use 'RELATIVE'.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.pdt_on_every_segment.description
When true a #EXT-X-PROGRAM-DATE-TIME tag will be placed on every media segment in HLS media playlists. When false, the default behavior, the PDT tag is set according to the HLS specification.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.pre_start_duration_seconds.description
Pre Start Duration is the length of content that will be included in the manifest when the start time of a manifest is in the future. When a manifest is near the start time but does not contain 'pre_start_duration_seconds' content Manifest Origin will keep content before the start time to make the manifest length at least 'pre_start_duration_seconds'. If not specified requesting a manifest in the future will result in a 404.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.manifest_defaults.properties.suggested_presentation_delay_seconds.description
Sets the suggestedPresentationDelay field in MPD to be this value. This value must be greater or equal to 'minimum_update_period_secs'. If unset, the default value will be calculated as 3 * segment target duration.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.origin.properties.retention_minutes.description
RetentionMinutes specifies how long data is retained, in minutes. Live linear (24/7) channels should set this to the longest expected DVR window (a few hours). Live event channels should set this to how Live2VOD playlists are expected to be available. If unspecified, the default will be 60 minutes. The maximum value is 15 days (21600 minutes).

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.packager_id.description
Determines how segments in this publication are packaged. Must reference a packager in 'packaging.packagers'. However, if this is a playlist-only publication (i.e. contains publish points that specify 'playlist_only_for'), this must remain unset as the packager will be inferred from the publication this one is providing playlists for.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.description
HTTP destination where media segments and playlists will be published.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.compression.description
Configures whether or not (and how) to compress manifests being published to the origin. If not specified, manifests will not be compressed.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.cross_playback_paths.description
Cross Playback Paths are playback paths that reference alternative content. These playback paths could reference publish points from the same publication or a completely different encoder and packager altogether. Content published to an endpoint referenced by one of these cross playback paths MUST be of the same Manifest.Type.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.do_not_monitor.description
(Optional) Specifies if this pubpoint should not be monitored by PLM.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.headers.description
Allows custom HTTP headers to be set via configuration for all HTTP requests.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.method.description
Method overrides what HTTP method to specify in requests to the Publish Point. If not specified the service will default to POST.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.playback_base_url.description
The base URL where published playlists will be able to be obtained. This is often different than the publish_base_url for CDN publishing workflows.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.playback_query_params.description
Specifies any query parameters that will be added to playback urls. Should not include the initial '?' Example: 'foo=bar&q=golang'

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.http.properties.publish_base_url.description
The base URL where generated playlists will be sent/published. Each publish point requires a unique 'publish_base_url'.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.id.description
uniquely identifies this publish_point within a channel configuration. Can be referenced by other publish_points in the 'playlist_only_for' field.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.publish_points.items.properties.playlist_only_for.description
playlist_only_for identifies the id of the publish_point that has the segments for this publish_point, which is only publishing a playlist for those segments. All publish_points within a publication must either have 'playlist_only_for' all set or all not set.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.redundant_publishing.description
When redundant publishing is enabled succeeding to publish a given media segment to at least one HTTPPublishPoint in publish_points will result in that segment showing up in manifests as playable content. Will require at least two publish_points defined within the same publication.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.startover.description
Configures startover processing for this Publication.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.startover.properties.first_program_start.description
Trigger Startover on the first Program Start. Only one of ['first_program_start', 'on_airing_id'] may be set.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.startover.properties.on_airing_id.description
Use the Airing Id of a Program Start to trigger a Startover on the first match. Only one of ['first_program_start', 'on_airing_id'] may be set.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.startover.properties.on_airing_id.properties.airing_id.description
Airing Id is a SCTE-35 Segmentation Unique Program ID (UPID) of type 0x08 used to specify the unique airing of a program. Is a 8 byte hex encoded string that is prepended with '0x'.

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.thumbnail_encoder_ids.description
Optional: Specify what thumbnail_encoders should be in this Publication

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.use_strict_bitrate.description
Optional, indicates whether we should pad the bitrate (false) or use what is explicitly provided (true)

# components.schemas.put-org-channel-request.properties.publishing.properties.publications.items.properties.video_encoder_ids.description
Optionally specify which video encoders should be used for this publication. If none are specified, all video encoders configured for the transcoder will be used.

# components.schemas.put-org-channel-request.properties.publishing.properties.rtmp_publications.description
A set of configurations for delivering RTMP streams

# components.schemas.put-org-channel-request.properties.publishing.properties.srt_publications.description
A set of configurations for delivering SRT streams

# components.schemas.put-org-channel-request.properties.publishing.properties.srt_publications.items.properties.audio_encoders.items.properties.pid.description
Output MPEG-TS PID. PIDs should be set on the PMT, SCTE-35 and all encoders or none. Valid PIDs must 13-bit values greater than 31. If no PIDs are provided (pid == 0) then they will be generated automatically.

# components.schemas.put-org-channel-request.properties.publishing.properties.srt_publications.items.properties.pmt_pid.description
MPEG-TS PMT PID. PIDs should be set on the PMT, SCTE-35 and all encoders or none. Valid PIDs must 13-bit values greater than 31. If no PIDs are provided (pid == 0) then they will be generated automatically.

# components.schemas.put-org-channel-request.properties.publishing.properties.srt_publications.items.properties.scte35_pid.description
MPEG-TS SCTE-35 PID. PIDs should be set on the PMT, SCTE-35, and all encoders or none. Valid PIDs must 13-bit values greater than 31. If no PIDs are provided (pid == 0) then they will be generated automatically.

# components.schemas.put-org-channel-request.properties.publishing.properties.srt_publications.items.properties.video_encoders.items.properties.pid.description
Output MPEG-TS PID. PIDs should be set on the PMT, SCTE-35 and all encoders or none. Valid PIDs must 13-bit values greater than 31. If no PIDs are provided (pid == 0) then they will be generated automatically.

# components.schemas.put-org-channel-request.properties.region.description
Region represents the general geolocation for transcoding and stream egress from iStreamPlanet. If no region is provided at channel creation time, then 'US_WEST' is used.

# components.schemas.put-org-channel-request.properties.resource_class.description
If the ResourceClass is unspecified the channel will default to run in the 'DYNAMIC' ResourceClass. Note that changing the ResourceClass for a running channel is supported and will be performed with no downtime.

# components.schemas.put-org-channel-request.properties.signaling.description
Signaling configures in-band signaling (i.e. SCTE-35).

# components.schemas.put-org-channel-request.properties.signaling.properties.blackout_settings.description
Configure blackout: replacing content with custom slates based on program signaling.

# components.schemas.put-org-channel-request.properties.signaling.properties.blackout_settings.properties.default_blackout_slate_url.description
Default slate URL to use for blackouts. Can be overridden by the 'slates' field.

# components.schemas.put-org-channel-request.properties.signaling.properties.blackout_settings.properties.force_blackout_segments.description
List of signaling segment types to force blackout, e.g. add 'SPLICE_INSERT' to blackout all ads signaled via SCTE-35 splice_insert.

# components.schemas.put-org-channel-request.properties.signaling.properties.blackout_settings.properties.honor_web_delivery_restriction.description
Determines whether to honor the web_delivery_allowed attribute in SCTE-35 segmentation descriptors. When this is enabled, a segmentation descriptor with web_delivery_allowed=false will trigger a blackout.

# components.schemas.put-org-channel-request.properties.signaling.properties.blackout_settings.properties.slates.items.properties.blackout_slate_url.description
Blackout slate URL to use for the specified segments. It must have one audio and one video stream. Either MPEG2 or H.264 can be used.

# components.schemas.put-org-channel-request.properties.signaling.properties.blackout_settings.properties.slates.items.properties.segments.description
Segment types that shall utilize the blackout slate URL. Any segment type defined here _must_ also be present in the parent signaling configuration.

# components.schemas.put-org-channel-request.properties.signaling.properties.blackout_settings.properties.slates.items.properties.upids.description
Exclusive list of hex string encoded colon separated UPID Type:ID pairs (e.g. '0A:1A2B3C4D') to enable this blackout slate on.

# components.schemas.put-org-channel-request.properties.signaling.properties.disable_inband_parsing.description
Disable parsing SCTE-35 in-band signaling. Out-of-band signaling is still allowed.

# components.schemas.put-org-channel-request.properties.signaling.properties.scte_pid.description
Defines the specific PID containing the SCTE that the transcoder should process. Using '0' (default value) will pick the first PID containing SCTE-35 in the PMT.

# components.schemas.put-org-channel-request.properties.signaling.properties.segment_settings.description
Settings that apply to specific segments.

# components.schemas.put-org-channel-request.properties.signaling.properties.segment_settings.items.properties.default_duration_secs.description
Specifies the duration of a segment when the in-band SCTE-35 that initiates it (e.g. Distributor Placement Opportunity Start) is missing an explicit duration. N.B. for program and ad types, this also affects 'Simple Program' and 'Simple Ad' markers, respectively.

# components.schemas.put-org-channel-request.properties.signaling.properties.segment_settings.items.properties.emit_default_duration.description
Determines whether to include the default duration in the output SCTE-35 messages when the input SCTE-35 message did not specify a duration.

# components.schemas.put-org-channel-request.properties.signaling.properties.segment_settings.items.properties.offset_millis.description
Specifies a 'correction' to the splice_time of in-band SCTE-35 in milliseconds.

# components.schemas.put-org-channel-request.properties.signaling.properties.segment_settings.items.properties.segment_end_mode.description
Determines which Segment End signaling mode to use for the provided segments. If unspecified, defaults to MATCH_END_EVENT_ID.

# components.schemas.put-org-channel-request.properties.signaling.properties.segment_settings.items.properties.segments.description
Specifies the list of which segment types this setting applies to. Any segment type defined here _must_ also be present in the parent signaling configuration.

# components.schemas.put-org-channel-request.properties.signaling.properties.segment_settings.items.properties.tier_filter.description
Specifies how to filter the provided segments, when received through in-band SCTE-35, based on the SCTE-35 SpliceInfoSection Tier.

# components.schemas.put-org-channel-request.properties.signaling.properties.segment_settings.items.properties.tier_filter.properties.explicit_tier.description
Only one of ['explicit_tier'] may be set.

# components.schemas.put-org-channel-request.properties.signaling.properties.segments.description
Segment types to process for in-band signaling.

# components.schemas.put-org-channel-request.properties.tags.description
Use ChannelMetadata when possible instead of tags.

# components.schemas.put-org-channel-request.properties.tags.properties.monitored.description
Indicates whether this channel is monitored by automation.

# components.schemas.put-org-channel-request.properties.transcode.properties.audio_encoders.description
Audio encoders specify audio conversion settings, e.g. channels, samples, codec, bitrate, etc.

# components.schemas.put-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.audio_source_id.description
Audio source ID specifies which stream within the audio source to use.

# components.schemas.put-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.bit_rate.description
Bit rate specifies the constant number of bits used per second. Higher values result in better audio quality but bigger file sizes.

# components.schemas.put-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.channels.description
Channels specifies the number of real audio channels to encode. The available options depend on the audio codec. The encoder supports different channel configurations based on the codec; AAC 1-2 channels, AC3 supports 2 or 6, and EAC3 supports 2 or 6. For example, for AC3 5.1 one would set 6 channels. Channel configurations are as follows: 1 - Mono (C) 2 - Stereo / Dolby 2.0 (L, R) 6 - Dolby 5.1 (L, C, R, l, r, LFE) Dolby Atmos layouts such as 5.1.4 are achieved by setting this field to 6 and configuring ddp_joc_logical_channels in EAC3Settings as desired.

# components.schemas.put-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.codec.description
Codec specifies the audio data encoding format.

# components.schemas.put-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.eac3.properties.ddp_joc_logical_channels.description
If non-zero, configures the encoder to compute JOC metadata (i.e. Dolby Atmos) for the given logical speaker layout. The transcoder does not guarantee any particular bed layout in the JOC metadata, and this setting currently has no effect on that. It merely determines the channel layout to which all inputs are converted before encoding. Legal values are: 8 - 5.1.2 10 - 5.1.4 For sources with raw PCM input and more than 6 channels, configure this according to the expected input channel layout. For channels which expect to take a 7.1 EAC-3 input, configure to 8. For all other cases, including upmixing from 5.1 or fewer channels or any kind of Atmos input, configure to 10. This setting is mutually exclusive with ddp_joc_passthrough. This setting has no effect on the current production version of the transcoder, nor does the current production version of the transcoder support raw PCM inputs.

# components.schemas.put-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.eac3.properties.ddp_joc_passthrough.description
Indicates that the source will contain Joint Object Coding metadata (Dolby Atmos) and that the encoder should operate in passthrough mode. https://learning.dolby.com/hc/en-us/articles/4406039180564-Appendix-C-Dolby-Atmos-Delivery-Codecs- When the audio encoder is configured with this setting, the source audio will be repackaged without being decoded and re-encoded. If the source is not DD+JOC, it will be replaced with silence.

# components.schemas.put-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.eac3.properties.drc_line_mode.description
If specified, overrides the dynamic range control line mode. If unspecified and the source audio is AC-3 or EAC-3, the DRC line mode matches the input. If unspecified and the source audio is any other codec, the encoder uses an unspecified default which may change without notice. This setting has no effect on transcoder versions which do not support Atmos encoding.

# components.schemas.put-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.eac3.properties.drc_rf_mode.description
If specified, overrides the dynamic range control RF mode. If unspecified and the source audio is AC-3 or EAC-3, the DRC RF mode matches the input. If unspecified and the source audio is any other codec, the encoder uses an unspecified default which may change without notice. This setting has no effect on transcoder versions which do not support Atmos encoding.

# components.schemas.put-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.eac3.properties.surround_phase_shift.description
If specified, overrides whether surround phase shift is enabled. If unspecified and the source audio is AC-3 or EAC-3, the surround phase shift mode matches the input. If unspecified and the source audio is any other codec, the encoder uses an unspecified default which may change without notice. This setting has no effect on transcoder versions which do not support Atmos encoding.

# components.schemas.put-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.id.description
Encoder ID. IDs must be unique for all encoders. This ID is referenced when setting up playlist publishing.

# components.schemas.put-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.loudness.description
Loudness normalization settings. Loudness configuration is required for non-passthrough AC-3 and EAC-3.

# components.schemas.put-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.loudness.properties.dialog_intel.description
Enable Dialog Intelligence. Only supported for (E)AC-3 encoders. This may only be set if lkfs is explicitly configured to -24.

# components.schemas.put-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.loudness.properties.lkfs.description
Loudness normalization LKFS setting. Default value is -24.

# components.schemas.put-org-channel-request.properties.transcode.properties.audio_encoders.items.properties.loudness.properties.peak_limit.description
Peak Limit. The only allowable value is -2.0. This field is soft-deprecated and will be unsupported in a future transcoder version. In the current transcoder version, the values 0.0 and -2.0 both produce the same configuration.

# components.schemas.put-org-channel-request.properties.transcode.properties.debug_overlay.description
Deprecated: Do not use. Debug_overlay overlays debugging information from the transcoder into the top right of the video output. The overlay is burned into the video and will be visible to end-users if enabled. Do not enable on customer facing channels. Requires a transcoder restart if the state is changed. The default value is false, which disables the overlay. This setting is deprecated in favour of debug_overlays.

# components.schemas.put-org-channel-request.properties.transcode.properties.debug_overlays.description
The debug_overlays specifies the position of the debugging overlay information from the transcoder into each video output. The overlay is burned into the video and will be visible to end-users if enabled. The default position value is OFF, which results in no debug overlay. Do not enable on customer facing channels. Requires a transcoder restart if the state is changed.

# components.schemas.put-org-channel-request.properties.transcode.properties.debug_overlays.properties.position.description
Position of the debug overlay within the output frame.

# components.schemas.put-org-channel-request.properties.transcode.properties.feature_flags.description
Feature flag strings enable experimental transcode features or functionality that are not yet or never will be promoted to the channeldoc model proper. Do not enable on customer facing channels.

# components.schemas.put-org-channel-request.properties.transcode.properties.id3_mode.description
Specify how to process ID3 tags from the input source. If not specified, ID3 tags in the source will be ignored.

# components.schemas.put-org-channel-request.properties.transcode.properties.overlays.description
List of overlays. An overlay is an image that will be rendered on top of the source video. Only one overlay is supported at the moment. If specified, the overlay will be always rendered unless a video slate is on.

# components.schemas.put-org-channel-request.properties.transcode.properties.overlays.items.properties.image_url.description
The URL of the image overlay. Only PNG is supported at the moment. The image's dimensions should match those of source for perfect pixel placement.

# components.schemas.put-org-channel-request.properties.transcode.properties.resize_mode.description
Resize mode specifies how to scale a video up or down to match the output dimensions.

# components.schemas.put-org-channel-request.properties.transcode.properties.segmenter.description
Segmenter configures how video GOPs and segments get generated.

# components.schemas.put-org-channel-request.properties.transcode.properties.segmenter.properties.gop_duration_secs.description
GOP (group of pictures) duration specifies the amount of time between I-frames. Shorter durations can lower quality slightly as each I-frame uses more bits than P- & B-frames but can provide a better seeking experience when enabling thumbnail encoders and/or I-Frame Only playlists.

# components.schemas.put-org-channel-request.properties.transcode.properties.segmenter.properties.segment_duration_secs.description
Segment duration specifies the target duration of a single segment. Segments shorter than this duration can occur at signaling boundaries. This value _must_ be a multiple of the GOP duration value.

# components.schemas.put-org-channel-request.properties.transcode.properties.segmenter.properties.temi.description
Include TEMI (Timeline and External Media Information ISO/IEC 13818-1:2019 Annex U) to mpeg-ts segments.

# components.schemas.put-org-channel-request.properties.transcode.properties.subtitle_encoders.description
Subtitle encoders specify how text-based subtitles are extracted into separate segments. They are not used to describe CEA 608 captions, which remain part of the video codec.

# components.schemas.put-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.atsc_captions.description
Extract subtitles from the ATSC caption encodings. The captions themselves are first sourced according to the Source.captions_source field. Only one of ['teletext', 'atsc_captions'] may be set.

# components.schemas.put-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.atsc_captions.properties.cea608.description
If non-zero, decode captions from the CEA-608 logical channel number identified by this number. If zero, only CTA-708 captions will be decoded. The 'logical channel number' refers to the CCx name commonly used in literature: - CC1 is the NTSC odd field subchannel 1, considered the primary caption stream. - CC2 is the NTSC odd field subchannel 2, considered the tertiary caption stream. - CC3 is the NTSC even field subchannel 1, considered the secondary caption stream. - CC4 is the NTSC even field subchannel 2, considered the quaternary caption stream.

# components.schemas.put-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.atsc_captions.properties.cta708.description
If non-zero, decode captions from the CTA-708 service identified by this number. If zero, only CEA-608 captions will be decoded. It is allowed to set both 'cta708' and 'cea608'. In this case, the transcoder will decode both streams, and will use the CTA-708 data if the stream is active and fall back to CEA-608 otherwise. Fallback from CTA-708 to CEA-608 requires a timeout to elapse, but switching from CEA-608 to CTA-708 occurs the instant the CTA-708 stream becomes active. CTA-708 recommends the following correspondence between the two encodings: - CTA-708 service 1 == CEA-608 CC1 (primary captions) - CTA-708 service 2 == CEA-608 CC3 (secondary captions) - CTA-708 service 3 == CEA-608 CC2 (tertiary captions) - CTA-708 service 4 == CEA-608 CC4 (quaternary captions) However, some sources use an alternate convention where CTA-708 service 3 is the secondary caption service (corresponding to CC3) and CTA-708 service 2 is the tertiary caption service.

# components.schemas.put-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.id.description
Encoder ID. IDs must be unique for all encoders. This ID is referenced when setting up playlist publishing.

# components.schemas.put-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.language.description
Language is the code for the language in which the subtitles are written.

# components.schemas.put-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.teletext.description
Extract subtitles from an embedded Teletext stream. The teletext PID is determined automatically. Only one of ['teletext', 'atsc_captions'] may be set.

# components.schemas.put-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.teletext.properties.charset_set.description
If set, forces interpretation of the National Option field to choose from character sets in this specific set of character sets. Determining the correct value for this configuration is non-trivial, but there are some guidelines. Usually, all languages in one Teletext stream will use the same charset set. If only one set can handle all the languages, it's probably that one. Some of the sets roughly correspond to geopolitical divisions from the Cold War era: SET3 is roughly Yugoslavia plus Romania; SET4 is the rest of the former USSR/Warsaw Pact, including East Germany but excluding Poland; SET8 is Africa; SET10 is the Middle East. There does not seem to be any standard name for this configuration. The standard calls it 'the upper four bits of Triplet 1', which is highly ambiguous and nonsensical outside of the context of that usage. The decoder ffmpeg uses calls it 'region', but most of the sets cannot cleanly be described as any particular geographic region.

# components.schemas.put-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.teletext.properties.language.description
The three-letter language code declared in the Teletext descriptor in the source PMT. If the language is not found, the subtitles will be empty. language + type configuration is mutually exclusive with magazine + page configuration.

# components.schemas.put-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.teletext.properties.magazine.description
The teletext magazine number where the subtitles are found. magazine + page configuration is mutually exclusive with language + type configuration.

# components.schemas.put-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.teletext.properties.page.description
The teletext page number where the subtitles are found. magazine + page configuration is mutually exclusive with language + type configuration.

# components.schemas.put-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.teletext.properties.page_type.description
The Teletext page type declared in the Teletext descriptor in the source PMT. If this field is unset, it will be inferred from the 'usage' field on the SubtitleEncoder using this table: SubtitleEncoder.CLOSED_CAPTIONS => TeletextSource.PAGE_TYPE_SUBTITLE_HEARING_IMPAIRED SubtitleEncoder.SUBTITLES => TeletextSource.PAGE_TYPE_SUBTITLE

# components.schemas.put-org-channel-request.properties.transcode.properties.subtitle_encoders.items.properties.usage.description
Usage indicates how this encoder should be flagged in generated manifests.

# components.schemas.put-org-channel-request.properties.transcode.properties.thumbnail_encoders.description
Thumbnail encoders specify how to create image snapshots of the video stream.

# components.schemas.put-org-channel-request.properties.transcode.properties.thumbnail_encoders.items.properties.height.description
Height specifies the thumbnail image height in pixels.

# components.schemas.put-org-channel-request.properties.transcode.properties.thumbnail_encoders.items.properties.id.description
Encoder ID. IDs must be unique for all encoders. This ID is referenced when setting up playlist publishing.

# components.schemas.put-org-channel-request.properties.transcode.properties.thumbnail_encoders.items.properties.width.description
Width specifies the thumbnail image width in pixels.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.description
Video encoders specify video conversion settings, e.g. dimensions, codec, bitrate, etc.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.bit_rate.description
Bit rate specifies the number in bits used per second. Higher values result in better video quality but bigger file sizes. For H.264 this value is the target of the constrained variable bit rate.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.frame_rate.description
Frame rate specifies the number of images that are shown per second when playing back the video. For the best quality playback, this should match or be a multiple of the input source video stream.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h264.description
Configure the encoder to use the H.264 codec. Only one of ['H264Settings', 'H265Settings'] may be set.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h264.properties.profile.description
H.264 video profile, which defines various encoder features and settings. See https://en.wikipedia.org/wiki/Advanced_Video_Coding#Profiles for details.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.description
Configure the encoder to use the H.265 codec. Only one of ['H264Settings', 'H265Settings'] may be set.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.description
Only one of ['hdr10', 'dolby_vision'] may be set.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile5.description
Only one of ['profile5', 'profile81', 'profile84'] may be set.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile81.description
Only one of ['profile5', 'profile81', 'profile84'] may be set.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile81.properties.clli.properties.max_fall.description
Maximum Frame-Average Light Level (nits).

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile81.properties.mdcv.properties.color_profile.description
Identifies color primaries and white point.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile81.properties.mdcv.properties.max_dml.description
Maximum display mastering luminance (nits). Must be greater than min_dml.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile81.properties.mdcv.properties.min_dml.description
Minimum display mastering luminance (nits).

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.dolby_vision.properties.profile84.description
Only one of ['profile5', 'profile81', 'profile84'] may be set.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.hdr10.description
Only one of ['hdr10', 'dolby_vision'] may be set.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.hdr10.properties.clli.properties.max_fall.description
Maximum Frame-Average Light Level (nits).

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.hdr10.properties.mdcv.properties.color_profile.description
Identifies color primaries and white point.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.hdr10.properties.mdcv.properties.max_dml.description
Maximum display mastering luminance (nits). Must be greater than min_dml.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.h265.properties.hdr.properties.hdr10.properties.mdcv.properties.min_dml.description
Minimum display mastering luminance (nits).

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.height.description
Height specifies the video height in pixels. Must be a multiple of two. Valid resolution ranges, width x height are: H.264: 2x2 to 1920x1080 H.265: 130x34 to 3840x2160

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.id.description
Encoder ID. IDs must be unique for all encoders. This ID is referenced when setting up playlist publishing.

# components.schemas.put-org-channel-request.properties.transcode.properties.video_encoders.items.properties.width.description
Width specifies the video width in pixels. Must be a multiple of two. Valid resolution ranges, width x height are: H.264: 2x2 to 1920x1080 H.265: 130x34 to 3840x2160

# info.description
This API provides a way to list, create, and run channels.

Channels consist of inputs (ingest), transcoding settings like codecs and bitrates, and outputs (publishing).

## Quickstart

You may use any HTTP client or [SDK](https://istreamlabs.github.io/docs/sdks/golang/) to talk to this API, but [Restish](https://rest.sh/) makes getting started easy via OpenAPI [auto-configuration extensions](https://rest.sh/#/openapi?id=autoconfiguration):

```bash
# Install Restish
$ brew install danielgtaylor/restish/restish

# Configure Restish to talk to the API
$ restish api configure isp https://api.istreamplanet.com

# Get a list of orgs you can access
$ restish isp list-orgs

# Make a request to list channels
$ restish isp list-org-channels $YOUR_ORG

# Or, just use the URL. The API short name is allowed!
$ restish isp/v2/$YOUR_ORG/channels

# See available commands & details
$ restish isp --help
$ restish isp put-org-channel --help
$ restish completion --help
```

### Example Channel

You can create a basic example channel with defaults to get started quickly:

```bash
# First, get and pick a source ID to use.
$ restish isp list-sources

# Now, create a basic example channel using that source!
$ restish isp put-org-chanel $YOUR_ORG $CHANNEL_ID ingest.source.id: $YOUR_SOURCE_ID

# Next, view the channel's full configuration
$ restish isp get-org-channel $YOUR_ORG $CHANNEL_ID
```

From there, you can start to edit the channel to change the encoding settings, publish points, etc to your liking:

```bash
# Interactively edit the configuration using VS Code (with linting)
$ export VISUAL="code --wait"
$ restish edit -i isp/v2/$YOUR_ORG/channels/$CHANNEL_ID
```

### Templating

Templating is handled client-side rather than at the server, which enables you to use whatever technology you prefer and manage your own templates and rendering process. For example, Restish can easily combine a file with command-line arguments for templated input:

```bash
# Save an existing channel response body as a template file
$ restish isp get-org-channel $YOUR_ORG $EXISTING_CHANNEL_ID -f body >template.json

# Create a new channel with a different name, source, and publish point
# using that saved template. The template is passed via STDIN while the
# overrides/modifications are passed via arguments.
$ restish isp put-org-channel $YOUR_ORG $NEW_CHANNEL_ID <template.json \
   ingest.source.id: $NEW_SOURCE, \
   publishing.publications[0].publish_points[0].http.publish_base_url: $NEW_PUB_URL
```

## General API Features

### OpenAPI

The OpenAPI 3 spec for this API is avialable [here](./openapi.json).

### Authentication & Authorization

Auth is handled via the WBD Okta offering using [RFC 7519](https://www.rfc-editor.org/rfc/rfc7519) JSON Web Tokens (JWT). Clients first make a request to the application's WBD Okta endpoint to get a token, and then provide that token in an `Authorization` header with each request to the API. Tokens are short lived and a new token must be fetched when the token expires.

WBD Okta supports [RFC 6749](https://www.rfc-editor.org/rfc/rfc6749) OAuth 2.0, both the Authorization Code (with PKCE) and Client Credential grant flows. Use the following URLs:

- https://tw.okta.com/oauth2/aus125bl6q770za4g0x8/v1/authorize
- https://tw.okta.com/oauth2/aus125bl6q770za4g0x8/v1/token

### Errors

Structured errors are returned using [RFC 7807](https://tools.ietf.org/html/rfc7807) Problem Details for HTTP APIs with an optional `errors` detail array that contains `message`, `location`, and `value` fields when relevant. The location is a path from the root of the request and can include `header`, `path`, `query`, or the `body`. Example error:

```json
{
  "detail": "Error while processing input parameters",
  "errors": [
    {
      "location": "body.transcode.video_encoders.0.bit_rate",
      "message": "Must be greater than 0",
      "value": "0"
    }
  ],
  "status": 422,
  "title": "Unprocessable Entity"
}
```

### Pagination & Links

List calls use [RFC 5988](https://tools.ietf.org/html/rfc5988) Link relation headers. Clients *should* read this header and follow the `next` link to read all pages of results.

Many resources have `self` links, which are URLs that can be followed to get details on the resource.

Most resources have a `describedby` link, which links to a JSON Schema description of the resource.

### Content Negotiation

Server-driven [content negotiation](https://developer.mozilla.org/en-US/docs/Web/HTTP/Content_negotiation) is supported for the following request headers:

- `Accept-Encoding` content encoding: gzip ([RFC 1952](https://tools.ietf.org/html/rfc1952)) & Brotli ([RFC 7932](https://tools.ietf.org/html/rfc7932))
- `Accept` content type: JSON ([RFC 8259](https://tools.ietf.org/html/rfc8259)), YAML, and CBOR ([RFC 8949](https://www.rfc-editor.org/rfc/rfc8949))

### Partial Updates

HTTP patch support is available for partial updates using either [RFC 7386](https://www.rfc-editor.org/rfc/rfc7386) JSON Merge Patch or [RFC 6902](https://www.rfc-editor.org/rfc/rfc6902) JSON Patch. The `Content-Type` header you send determines which format will be used. If no content type is sent, then JSON Merge Patch is assumed.

### Distributed Writes & Conditional Requests

[Conditional requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Conditional_requests) are supported, enabling you to only perform a write operation if the existing resource on the server matches the version or date you expect. This prevents one user/script/service from overwriting the changes of another. You may opt-in by setting the `If-Match` header to the resource's `ETag`, or the `If-Unmodified-Since` header to the resource's `Last-Modified` time.

### Rich Editing Support

Resources in the API provide a `$schema` field which links to the JSON Schema describing the structure, field documentation, and basic validation rules of the resource. Many editors, such as [VS Code](https://code.visualstudio.com/docs/languages/json#_json-schemas-and-settings), use this to provide suggestions as you type, hover documentation, and document validation/linting.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}.get.description
This route is deprecated and is subject to removal any time after `Thu, 06 Apr 2023 19:00:00 UTC`.

Get a program with an customer, product and program id. This API is deprecated, and it only returns
the program from the west region.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}.get.parameters[].description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}.get.parameters[].schema.description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}.get.parameters[].description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}.get.parameters[].schema.description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod.get.description
This route is deprecated and is subject to removal any time after `Thu, 06 Apr 2023 19:00:00 UTC`. Use [list-org-vods](#get-/v2/-org-/channels/-channel-id-/vods) instead.

VODs can be listed after an appropriately configured channel is turned on for the first time.
If a channel with existing VODs is turned off or deleted, the VODs will still be returned.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod.get.parameters[].description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod.get.parameters[].schema.description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod.get.parameters[].description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod.get.parameters[].schema.description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.description
This route is deprecated and is subject to removal any time after `Thu, 06 Apr 2023 19:00:00 UTC`. Use [list-org-clips](#get-/v2/-org-/channels/-channel-id-/clips) instead.

List all clips for the vod identified in the request.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].schema.description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].schema.description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.description
This route is deprecated and is subject to removal any time after `Thu, 06 Apr 2023 19:00:00 UTC`.

Get the clip with the clip id sent in the request.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].schema.description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].schema.description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.post.description
This route is deprecated and is subject to removal any time after `Thu, 06 Apr 2023 19:00:00 UTC`. Use [post-org-make-mp4](#post-/v2/-org-/channels/-channel-id-/vods/-vod_id-/clips/-clip-id-/makemp4) instead.

Create a mp4 entity for the clip within a vod

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.post.parameters[].description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.post.parameters[].schema.description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.post.parameters[].description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.post.parameters[].schema.description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.description
This route is deprecated and is subject to removal any time after `Thu, 06 Apr 2023 19:00:00 UTC`.

Retrieve List of Manifests for a given Clip

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].schema.description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].schema.description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.description
This route is deprecated and is subject to removal any time after `Thu, 06 Apr 2023 19:00:00 UTC`. Use [get-org-mp4-url](#get-/v2/-org-/channels/-channel-id-/vods/-vod_id-/clips/-clip-id-/mp4url) instead.

Retrieves a playback URL for the MP4 playback for a clip if available.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].schema.description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].schema.description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.description
This route is deprecated and is subject to removal any time after `Thu, 06 Apr 2023 19:00:00 UTC`. Use [get-org-vod-clip-program-time](#get-/v2/-org-/channels/-channel-id-/vods/-vod_id-/clips/-clip-id-/programtime) instead.

Retrieves Program Time for a given Clip

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].schema.description
Customer ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./cust/{customer-id}/prod/{product-id}/prog/{program-id}/vod/{vod.get.parameters[].schema.description
Program ID for a l2v request.  Used only for the deprecated legacy route support.

# paths./v2/channels.get.parameters[].description
Search query to match against for filtering a list of channels. This searches the channel ID, name, labels, and source ID.

# paths./v2/channels.get.parameters[].schema.description
Search query to match against for filtering a list of channels. This searches the channel ID, name, labels, and source ID.

# paths./v2/orgs.get.description
Get a list of organizations that you can access.

# paths./v2/{org}/channels.get.parameters[].description
Search query to match against for filtering a list of channels. This searches the channel ID, name, labels, and source ID.

# paths./v2/{org}/channels.get.parameters[].schema.description
Search query to match against for filtering a list of channels. This searches the channel ID, name, labels, and source ID.

# paths./v2/{org}/channels/{channel-id}.delete.description
Delete a channel and stop publishing. This action is idempotent.

End distributions are automatically sent when attempting to delete an `ON` channel. To delete a channel without sending end distribution:
1. The channel's DesiredState must be updated to `OFF`See [put-org-channel-desired-state](#put-/v2/-org-/channels/-channel-id-/desired-state) for more details.
2. Once the channel is `OFF`, the channel can be deleted with the flag`--end_playlist=false`.

# paths./v2/{org}/channels/{channel-id}.delete.parameters[].description
Succeeds if the server's resource matches one of the passed values.

# paths./v2/{org}/channels/{channel-id}.delete.parameters[].schema.description
Succeeds if the server's resource matches one of the passed values.

# paths./v2/{org}/channels/{channel-id}.delete.parameters[].description
Succeeds if the server's resource matches none of the passed values. On writes, the special value * may be used to match any existing value.

# paths./v2/{org}/channels/{channel-id}.delete.parameters[].schema.description
Succeeds if the server's resource matches none of the passed values. On writes, the special value * may be used to match any existing value.

# paths./v2/{org}/channels/{channel-id}.delete.parameters[].description
Succeeds if the server's resource date is more recent than the passed date.

# paths./v2/{org}/channels/{channel-id}.delete.parameters[].schema.description
Succeeds if the server's resource date is more recent than the passed date.

# paths./v2/{org}/channels/{channel-id}.delete.parameters[].description
Succeeds if the server's resource date is older or the same as the passed date.

# paths./v2/{org}/channels/{channel-id}.delete.parameters[].schema.description
Succeeds if the server's resource date is older or the same as the passed date.

# paths./v2/{org}/channels/{channel-id}.get.parameters[].description
Succeeds if the server's resource matches one of the passed values.

# paths./v2/{org}/channels/{channel-id}.get.parameters[].schema.description
Succeeds if the server's resource matches one of the passed values.

# paths./v2/{org}/channels/{channel-id}.get.parameters[].description
Succeeds if the server's resource matches none of the passed values. On writes, the special value * may be used to match any existing value.

# paths./v2/{org}/channels/{channel-id}.get.parameters[].schema.description
Succeeds if the server's resource matches none of the passed values. On writes, the special value * may be used to match any existing value.

# paths./v2/{org}/channels/{channel-id}.get.parameters[].description
Succeeds if the server's resource date is more recent than the passed date.

# paths./v2/{org}/channels/{channel-id}.get.parameters[].schema.description
Succeeds if the server's resource date is more recent than the passed date.

# paths./v2/{org}/channels/{channel-id}.get.parameters[].description
Succeeds if the server's resource date is older or the same as the passed date.

# paths./v2/{org}/channels/{channel-id}.get.parameters[].schema.description
Succeeds if the server's resource date is older or the same as the passed date.

# paths./v2/{org}/channels/{channel-id}.patch.description
Partial update operation supporting both JSON Merge Patch & JSON Patch updates.

# paths./v2/{org}/channels/{channel-id}.patch.parameters[].description
Validate request but do not otherwise process it

# paths./v2/{org}/channels/{channel-id}.patch.parameters[].schema.description
Validate request but do not otherwise process it

# paths./v2/{org}/channels/{channel-id}.patch.parameters[].description
Succeeds if the server's resource matches one of the passed values.

# paths./v2/{org}/channels/{channel-id}.patch.parameters[].schema.description
Succeeds if the server's resource matches one of the passed values.

# paths./v2/{org}/channels/{channel-id}.patch.parameters[].description
Succeeds if the server's resource matches none of the passed values. On writes, the special value * may be used to match any existing value.

# paths./v2/{org}/channels/{channel-id}.patch.parameters[].schema.description
Succeeds if the server's resource matches none of the passed values. On writes, the special value * may be used to match any existing value.

# paths./v2/{org}/channels/{channel-id}.patch.parameters[].description
Succeeds if the server's resource date is more recent than the passed date.

# paths./v2/{org}/channels/{channel-id}.patch.parameters[].schema.description
Succeeds if the server's resource date is more recent than the passed date.

# paths./v2/{org}/channels/{channel-id}.patch.parameters[].description
Succeeds if the server's resource date is older or the same as the passed date.

# paths./v2/{org}/channels/{channel-id}.patch.parameters[].schema.description
Succeeds if the server's resource date is older or the same as the passed date.

# paths./v2/{org}/channels/{channel-id}.put.description
Create or update an existing channel configuration.

# paths./v2/{org}/channels/{channel-id}.put.parameters[].description
Validate request but do not otherwise process it

# paths./v2/{org}/channels/{channel-id}.put.parameters[].schema.description
Validate request but do not otherwise process it

# paths./v2/{org}/channels/{channel-id}.put.parameters[].description
Succeeds if the server's resource matches one of the passed values.

# paths./v2/{org}/channels/{channel-id}.put.parameters[].schema.description
Succeeds if the server's resource matches one of the passed values.

# paths./v2/{org}/channels/{channel-id}.put.parameters[].description
Succeeds if the server's resource matches none of the passed values. On writes, the special value * may be used to match any existing value.

# paths./v2/{org}/channels/{channel-id}.put.parameters[].schema.description
Succeeds if the server's resource matches none of the passed values. On writes, the special value * may be used to match any existing value.

# paths./v2/{org}/channels/{channel-id}.put.parameters[].description
Succeeds if the server's resource date is more recent than the passed date.

# paths./v2/{org}/channels/{channel-id}.put.parameters[].schema.description
Succeeds if the server's resource date is more recent than the passed date.

# paths./v2/{org}/channels/{channel-id}.put.parameters[].description
Succeeds if the server's resource date is older or the same as the passed date.

# paths./v2/{org}/channels/{channel-id}.put.parameters[].schema.description
Succeeds if the server's resource date is older or the same as the passed date.

# paths./v2/{org}/channels/{channel-id}/beta/logs/signaling.get.description
Warning: This is deprecated beta functionality and is unstable and may change, break, or be removed in the future without notice.

Returns the signalling history for a channel.

# paths./v2/{org}/channels/{channel-id}/beta/logs/signaling.get.parameters[].description
ISO 8601 UTC timestamp for start range of date filtering

# paths./v2/{org}/channels/{channel-id}/beta/logs/signaling.get.parameters[].schema.description
ISO 8601 UTC timestamp for start range of date filtering

# paths./v2/{org}/channels/{channel-id}/beta/logs/signaling.get.parameters[].description
ISO 8601 UTC timestamp for end range of date filtering

# paths./v2/{org}/channels/{channel-id}/beta/logs/signaling.get.parameters[].schema.description
ISO 8601 UTC timestamp for end range of date filtering

# paths./v2/{org}/channels/{channel-id}/clips.get.description
List all clips for all VODs of the channel identified in the request.

# paths./v2/{org}/channels/{channel-id}/clips.post.description
Starts a job to create a clip for all VODs for the channel identified in the request.

# paths./v2/{org}/channels/{channel-id}/clips/{clip-id}/archive.post.description
Uses archive settings configured in Live2VOD for the organization and on the channel.

# paths./v2/{org}/channels/{channel-id}/clips/{clip-id}/playurl.get.description
Searches for an organization's VODs with a given ClipID and then returns a url for playback.

# paths./v2/{org}/channels/{channel-id}/desired-state.put.parameters[].description
Deprecated, server ignores all values. Will be removed from API once all clients are confirmed to not break.

# paths./v2/{org}/channels/{channel-id}/desired-state.put.parameters[].schema.description
Deprecated, server ignores all values. Will be removed from API once all clients are confirmed to not break.

# paths./v2/{org}/channels/{channel-id}/desired-state.put.parameters[].description
Succeeds if the server's resource matches one of the passed values.

# paths./v2/{org}/channels/{channel-id}/desired-state.put.parameters[].schema.description
Succeeds if the server's resource matches one of the passed values.

# paths./v2/{org}/channels/{channel-id}/desired-state.put.parameters[].description
Succeeds if the server's resource matches none of the passed values. On writes, the special value * may be used to match any existing value.

# paths./v2/{org}/channels/{channel-id}/desired-state.put.parameters[].schema.description
Succeeds if the server's resource matches none of the passed values. On writes, the special value * may be used to match any existing value.

# paths./v2/{org}/channels/{channel-id}/desired-state.put.parameters[].description
Succeeds if the server's resource date is more recent than the passed date.

# paths./v2/{org}/channels/{channel-id}/desired-state.put.parameters[].schema.description
Succeeds if the server's resource date is more recent than the passed date.

# paths./v2/{org}/channels/{channel-id}/desired-state.put.parameters[].description
Succeeds if the server's resource date is older or the same as the passed date.

# paths./v2/{org}/channels/{channel-id}/desired-state.put.parameters[].schema.description
Succeeds if the server's resource date is older or the same as the passed date.

# paths./v2/{org}/channels/{channel-id}/dvr-window.delete.description
Clears the DVR window for the channel by removing all video segments in the manifest from before the request.  This sets the earliest time a player can rewind to this point.

# paths./v2/{org}/channels/{channel-id}/fer.put.description
Uses archive settings from the request to archive a FER

# paths./v2/{org}/channels/{channel-id}/id3.post.description
Inserts the provided UTF-8 text metadata in the output stream embedded in a TXXX frame of a ID3 tag.

# paths./v2/{org}/channels/{channel-id}/ingest-pin.delete.description
Remove the preferrence for primary or secondary ingest feed from the channel's transcoder.
Automated source failover based on feed quality will be resumed.

# paths./v2/{org}/channels/{channel-id}/ingest-pin.put.description
Pin the channel's transcoder to prefer either primary or secondary ingest feeds.
Note that this will disable some automated ingest failover that is based on the quality of the feeds.

# paths./v2/{org}/channels/{channel-id}/preview-image.get.description
Get a static image of what your channel is outputting.  Valid Accept headers are: image/jpeg

# paths./v2/{org}/channels/{channel-id}/preview-streams.get.description
Get a default url that links to a preview of the channel. Additionally, all possible
video and audio tracks are provided back and can be interchanged in the given url.

# paths./v2/{org}/channels/{channel-id}/scte35.post.description
Inserts a SCTE-35 formatted binary payload into the channel.

# paths./v2/{org}/channels/{channel-id}/signals.get.description
Returns the active signals for a channel.

# paths./v2/{org}/channels/{channel-id}/signals.post.description
Inserts an out-of-band signal into a channel. A signal represents a program signal like chapter-start or ad-end. Signals operate on signaling segments. For example, a chapter-start will result in a new active Chapter segment, while a chapter-end with the same event_id will end it. Signals loosely map to SCTE-35 time_signals and splice_inserts.

The breakaway and resumption signal types are only valid with program segments.

The required event_id identifies the active signaling segment. Use the same event_id for both start and end to reference the same segment.

### Program Start

Inserts a SCTE-35 program start message into the channel with the given event ID. Corresponding calls to end the program must use the same event ID.

Example input body:

```json
[
	{
		"event_id": 0,
		"segment_type": "program",
		"signal_type": "start"
	}
]
```

### Program End

Inserts a SCTE-35 program end message into the channel with the given event ID. The event ID must match the one given during program start.

Example input body:

```json
[
	{
		"event_id": 0,
		"segment_type": "program",
		"signal_type": "end"
	}
]
```

### Slate In

Replaces the current video source with a video slate. An optional duration may be passed to automatically remove the slate after some time, otherwise the slate will remain until removed via a slate out signal.


The following table describes how video slates are supported and recommended attributes. Image slates are **NOT** supported.

<table>
	<tr>
		<th>Attribute</td>
		<th>Supported</td>
		<th>Recommended</td>
	</tr>
	<tr>
		<td>Max File Size</td>
		<td>100MB (104,857,600 bytes)</td>
		<td></td>
	</tr>
	<tr>
		<td>Total Duration</td>
		<td>Minimum: 3s</td>
		<td>10-30s</td>
	</tr>
	<tr>
		<td>Container</td>
		<td>MPEG-TS</td>
		<td></td>
	</tr>
	<tr>
		<td>Resolution (Recommended)</td>
		<td>Up to 4k (2160p)</td>
		<td>720p</td>
	</tr>
	<tr>
		<td>Framerate</td>
		<td>25i, 25p, 29.97i, 30p, 60p</td>
		<td>30p</td>
	</tr>
	<tr>
		<td>Video Codec</td>
		<td>
			- H.264<br/>
			- H.265<br/>
			- MPEG2<br/>
		</td>
		<td>H.264 Main or High profile</td>
	</tr>
	<tr>
		<td>Audio Codec</td>
		<td>
			- AAC-LC<br/>
			- AC-3<br/>
			- E-AC-3<br/>
			- MPEG1|2 Audio<br/>
		</td>
		<td>48KHz AAC-LC</td>
	</tr>
</table>

Additional slate requirements:
<ul>
    <li>The slate MUST contain at least 3 seconds of supported audio and video.</li>
    <li>The delta between the duration of audio and video MUST be less than 3 seconds.</li>
    <li>The delta between the timestamps of the first audio and the first video samples MUST be less than 3 seconds.
		<ul>
        	<li>Audio and video duration measurement begins after the first IDR in the file.</li>
		</ul>
	</li>
	<li>The MPEG2TS PMT MUST NOT change for the duration of the file.
		<ul>
        	<li>Ex. PIDs, audio codec, video codec, etc. must be the same throughout.</li>
		</ul>
	</li>
</ul>

Example input body:

```json
[
	{
		"event_id": 0,
		"segment_type": "slate",
		"signal_type": "start",
		"slate_uri": "https://example.com/slate.ts"
	}
]
```
	
### Slate Out

Removes any active slate and shows the source video content.

Example input body:

```json
[
	{
		"event_id": 0,
		"segment_type": "slate",
		"signal_type": "end"
	}
]
```

### Splice Insert Start

Inserts a splice opportunity into the channel for a given duration. Can optionally include UPIDs and a slate URL to select the content to splice into the channel.

Example input body:

```json
[
	{
		"event_id": 0,
		"segment_type": "splice_insert",
		"signal_type": "start",
		"duration": 25000,
		"slate_uri": "https://example.com/slate.ts"
	}
]
```

### Splice Insert End

Removes an active splice signaling segment from the channel.

Example input body:

```json
[
	{
		"event_id": 0,
		"segment_type": "splice_insert",
		"signal_type": "end"
	}
]
```

# paths./v2/{org}/channels/{channel-id}/signals.post.responses.207.description
Multi-status response; see body for details

# paths./v2/{org}/channels/{channel-id}/syndication.post.description
Uses archive settings from the request to archive syndication files (mp4/wav) files.

# paths./v2/{org}/channels/{channel-id}/syndication.post.summary
Syndication (MP4's/WAV's) creation using Aventus Dynamic Manifest Origin.

# paths./v2/{org}/channels/{channel-id}/tasks.get.description
List all L2V tasks for the channel identified in the request.

# paths./v2/{org}/channels/{channel-id}/timeline.get.description
Returns up to twenty items from the event timeline for a channel, sorted in reverse-chronological order.

# paths./v2/{org}/channels/{channel-id}/transcoder-status.get.description
Get the current status for the live transcoder powering the channel.

# paths./v2/{org}/channels/{channel-id}/vods.get.description
VODs can be listed after an appropriately configured channel is turned on for the first time.
If a channel with existing VODs is turned off or deleted, the VODs will still be returned.

# paths./v2/{org}/channels/{channel-id}/vods/{vod_id}/clips.get.description
List all clips for a single VOD in the channel identified in the request.

# paths./v2/{org}/channels/{channel-id}/vods/{vod_id}/clips.post.description
Starts a job to create a clip for a VOD on the channel identified in the request.

# paths./v2/{org}/channels/{channel-id}/vods/{vod_id}/clips/{clip-id}/co.post.description
Starts a copy mp4 task in l2v to copy an MP4 to another preset storage location

# paths./v2/{org}/channels/{channel-id}/vods/{vod_id}/clips/{clip-id}/ma.post.description
Create a mp4 entity for the clip within a vod

# paths./v2/{org}/channels/{channel-id}/vods/{vod_id}/clips/{clip-id}/ma.get.summary
Retrieve the manifests for a given clip id

# paths./v2/{org}/channels/{channel-id}/vods/{vod_id}/clips/{clip-id}/mp.get.description
Get the mp4url for downloading a mp4 file for a clip
Takes in a vodid and clipid and returns the url to download the mp4 asset.

# paths./v2/{org}/channels/{channel-id}/vods/{vod_id}/clips/{clip-id}/pr.get.description
Get the program start and end times for a clip

# paths./v2/{org}/channels/{channel-id}/vods/{vod_id}/collapse.post.description
A vod can be collapsed to a specific filter config

# paths./v2/{org}/products.get.description
Get all the products for a specific organization across all regions

# paths./v2/{org}/products/{product-id}.get.description
Get a product with an organization and product id. This will return one from each region if that product id is in multiple regions.

# paths./v2/{org}/products/{product-id}/programs.get.description
Get all the programs for a specific organization and product

# paths./v2/{org}/sources.get.description
Get a list of sources that are used to create channels.

# paths./v2/{org}/sources/{source-id}/preview.put.description
Create Source Preview, if one does not already exist. This operation is idempotent and may be called multiple times.

A response status code of 201 Created indicates the necessary Source Preview resources have been created. Once created, it may take up to 30 seconds before all resources to be running and available to provide Source Preview Streams information.

A response status code of 204 NoContent indicates the requisite Source Preview resources have already been created.

# paths./v2/{org}/sources/{source-id}/preview/ingest-pin.delete.description
Remove the preferrence for primary or secondary ingest feed from the Source Preview's transcoder.
Automated source failover based on feed quality will be resumed.

# paths./v2/{org}/sources/{source-id}/preview/ingest-pin.put.description
Pin the Source Preview's transcoder to prefer either primary or secondary ingest feeds.
Note that this will disable some automated ingest failover that is based on the quality of the feeds.

# paths./v2/{org}/sources/{source-id}/preview/stream.get.description
Gets the information required for the Low Latency Preview Player to enable playback.

'PUT /v2/{org}/sources/{source-id}/preview' SHOULD be called prior to ensure that the necessary Source Preview resources have been created. Otherwise, the Source Preview Stream will not be available and this API route will never succeed.

# paths./v2/{org}/sources/{source-id}/preview/transcoder-status.get.description
Get the current status for the live transcoder powering the Source Preview.