AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Placeholder documentation for HlsGroupSettings

Inheritance Hierarchy

System.Object
  Amazon.MediaLive.Model.HlsGroupSettings

Namespace: Amazon.MediaLive.Model
Assembly: AWSSDK.MediaLive.dll
Version: 3.x.y.z

Syntax

C#
public class HlsGroupSettings

The HlsGroupSettings type exposes the following members

Constructors

NameDescription
Public Method HlsGroupSettings()

Properties

NameTypeDescription
Public Property AdMarkers System.Collections.Generic.List<System.String>

Gets and sets the property AdMarkers. Choose one or more ad marker types to pass SCTE35 signals through to this group of Apple HLS outputs.

Public Property BaseUrlContent System.String

Gets and sets the property BaseUrlContent. A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.

Public Property BaseUrlManifest System.String

Gets and sets the property BaseUrlManifest. A partial URI prefix that will be prepended to each output in the media .m3u8 file. Can be used if base manifest is delivered from a different URL than the main .m3u8 file.

Public Property CaptionLanguageMappings System.Collections.Generic.List<Amazon.MediaLive.Model.CaptionLanguageMapping>

Gets and sets the property CaptionLanguageMappings. Mapping of up to 4 caption channels to caption languages. Is only meaningful if captionLanguageSetting is set to "insert".

Public Property CaptionLanguageSetting Amazon.MediaLive.HlsCaptionLanguageSetting

Gets and sets the property CaptionLanguageSetting. Applies only to 608 Embedded output captions.insert: Include CLOSED-CAPTIONS lines in the manifest. Specify at least one language in the CC1 Language Code field. One CLOSED-CAPTION line is added for each Language Code you specify. Make sure to specify the languages in the order in which they appear in the original source (if the source is embedded format) or the order of the caption selectors (if the source is other than embedded). Otherwise, languages in the manifest will not match up properly with the output captions.none: Include CLOSED-CAPTIONS=NONE line in the manifest.omit: Omit any CLOSED-CAPTIONS line from the manifest.

Public Property ClientCache Amazon.MediaLive.HlsClientCache

Gets and sets the property ClientCache. When set to "disabled", sets the #EXT-X-ALLOW-CACHE:no tag in the manifest, which prevents clients from saving media segments for later replay.

Public Property CodecSpecification Amazon.MediaLive.HlsCodecSpecification

Gets and sets the property CodecSpecification. Specification to use (RFC-6381 or the default RFC-4281) during m3u8 playlist generation.

Public Property ConstantIv System.String

Gets and sets the property ConstantIv. For use with encryptionType. This is a 128-bit, 16-byte hex value represented by a 32-character text string. If ivSource is set to "explicit" then this parameter is required and is used as the IV for encryption.

Public Property Destination Amazon.MediaLive.Model.OutputLocationRef

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

Public Property DirectoryStructure Amazon.MediaLive.HlsDirectoryStructure

Gets and sets the property DirectoryStructure. Place segments in subdirectories.

Public Property EncryptionType Amazon.MediaLive.HlsEncryptionType

Gets and sets the property EncryptionType. Encrypts the segments with the given encryption scheme. Exclude this parameter if no encryption is desired.

Public Property HlsCdnSettings Amazon.MediaLive.Model.HlsCdnSettings

Gets and sets the property HlsCdnSettings. Parameters that control interactions with the CDN.

Public Property IndexNSegments System.Int32

Gets and sets the property IndexNSegments. If mode is "live", the number of segments to retain in the manifest (.m3u8) file. This number must be less than or equal to keepSegments. If mode is "vod", this parameter has no effect.

Public Property InputLossAction Amazon.MediaLive.InputLossActionForHlsOut

Gets and sets the property InputLossAction. Parameter that control output group behavior on input loss.

Public Property IvInManifest Amazon.MediaLive.HlsIvInManifest

Gets and sets the property IvInManifest. For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If set to "include", IV is listed in the manifest, otherwise the IV is not in the manifest.

Public Property IvSource Amazon.MediaLive.HlsIvSource

Gets and sets the property IvSource. For use with encryptionType. The IV (Initialization Vector) is a 128-bit number used in conjunction with the key for encrypting blocks. If this setting is "followsSegmentNumber", it will cause the IV to change every segment (to match the segment number). If this is set to "explicit", you must enter a constantIv value.

Public Property KeepSegments System.Int32

Gets and sets the property KeepSegments. If mode is "live", the number of TS segments to retain in the destination directory. If mode is "vod", this parameter has no effect.

Public Property KeyFormat System.String

Gets and sets the property KeyFormat. The value specifies how the key is represented in the resource identified by the URI. If parameter is absent, an implicit value of "identity" is used. A reverse DNS string can also be given.

Public Property KeyFormatVersions System.String

Gets and sets the property KeyFormatVersions. Either a single positive integer version value or a slash delimited list of version values (1/2/3).

Public Property KeyProviderSettings Amazon.MediaLive.Model.KeyProviderSettings

Gets and sets the property KeyProviderSettings. The key provider settings.

Public Property ManifestCompression Amazon.MediaLive.HlsManifestCompression

Gets and sets the property ManifestCompression. When set to gzip, compresses HLS playlist.

Public Property ManifestDurationFormat Amazon.MediaLive.HlsManifestDurationFormat

Gets and sets the property ManifestDurationFormat. Indicates whether the output manifest should use floating point or integer values for segment duration.

Public Property MinSegmentLength System.Int32

Gets and sets the property MinSegmentLength. When set, minimumSegmentLength is enforced by looking ahead and back within the specified range for a nearby avail and extending the segment size if needed.

Public Property Mode Amazon.MediaLive.HlsMode

Gets and sets the property Mode. If "vod", all segments are indexed and kept permanently in the destination and manifest. If "live", only the number segments specified in keepSegments and indexNSegments are kept; newer segments replace older segments, which may prevent players from rewinding all the way to the beginning of the event.VOD mode uses HLS EXT-X-PLAYLIST-TYPE of EVENT while the channel is running, converting it to a "VOD" type manifest on completion of the stream.

Public Property OutputSelection Amazon.MediaLive.HlsOutputSelection

Gets and sets the property OutputSelection. Generates the .m3u8 playlist file for this HLS output group. The segmentsOnly option will output segments without the .m3u8 file.

Public Property ProgramDateTime Amazon.MediaLive.HlsProgramDateTime

Gets and sets the property ProgramDateTime. Includes or excludes EXT-X-PROGRAM-DATE-TIME tag in .m3u8 manifest files. The value is calculated as follows: either the program date and time are initialized using the input timecode source, or the time is initialized using the input timecode source and the date is initialized using the timestampOffset.

Public Property ProgramDateTimePeriod System.Int32

Gets and sets the property ProgramDateTimePeriod. Period of insertion of EXT-X-PROGRAM-DATE-TIME entry, in seconds.

Public Property SegmentationMode Amazon.MediaLive.HlsSegmentationMode

Gets and sets the property SegmentationMode. When set to useInputSegmentation, the output segment or fragment points are set by the RAI markers from the input streams.

Public Property SegmentLength System.Int32

Gets and sets the property SegmentLength. Length of MPEG-2 Transport Stream segments to create (in seconds). Note that segments will end on the next keyframe after this number of seconds, so actual segment length may be longer.

Public Property SegmentsPerSubdirectory System.Int32

Gets and sets the property SegmentsPerSubdirectory. Number of segments to write to a subdirectory before starting a new one. directoryStructure must be subdirectoryPerStream for this setting to have an effect.

Public Property StreamInfResolution Amazon.MediaLive.HlsStreamInfResolution

Gets and sets the property StreamInfResolution. Include or exclude RESOLUTION attribute for video in EXT-X-STREAM-INF tag of variant manifest.

Public Property TimedMetadataId3Frame Amazon.MediaLive.HlsTimedMetadataId3Frame

Gets and sets the property TimedMetadataId3Frame. Indicates ID3 frame that has the timecode.

Public Property TimedMetadataId3Period System.Int32

Gets and sets the property TimedMetadataId3Period. Timed Metadata interval in seconds.

Public Property TimestampDeltaMilliseconds System.Int32

Gets and sets the property TimestampDeltaMilliseconds. Provides an extra millisecond delta offset to fine tune the timestamps.

Public Property TsFileMode Amazon.MediaLive.HlsTsFileMode

Gets and sets the property TsFileMode. When set to "singleFile", emits the program as a single media resource (.ts) file, and uses #EXT-X-BYTERANGE tags to index segment for playback. Playback of VOD mode content during event is not guaranteed due to HTTP server caching.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms