Struct aws_sdk_mediaconvert::types::HlsSettings

#[non_exhaustive]
pub struct HlsSettings {
    pub audio_group_id: Option<String>,
    pub audio_only_container: Option<HlsAudioOnlyContainer>,
    pub audio_rendition_sets: Option<String>,
    pub audio_track_type: Option<HlsAudioTrackType>,
    pub descriptive_video_service_flag: Option<HlsDescriptiveVideoServiceFlag>,
    pub i_frame_only_manifest: Option<HlsIFrameOnlyManifest>,
    pub segment_modifier: Option<String>,
}

Settings for HLS output groups

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

audio_group_id: Option<String>

Specifies the group to which the audio rendition belongs.

audio_only_container: Option<HlsAudioOnlyContainer>

Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic to create an audio-only file in a raw container. Regardless of the value that you specify here, if this output has video, the service will place the output into an MPEG2-TS container.

audio_rendition_sets: Option<String>

List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ‘,’.

audio_track_type: Option<HlsAudioTrackType>

Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO

descriptive_video_service_flag: Option<HlsDescriptiveVideoServiceFlag>

Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag, MediaConvert includes the parameter CHARACTERISTICS=“public.accessibility.describes-video” in the EXT-X-MEDIA entry for this track. When you keep the default choice, Don’t flag, MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.

i_frame_only_manifest: Option<HlsIFrameOnlyManifest>

Choose Include to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don’t need the I-frame only child manifest, keep the default value Exclude.

segment_modifier: Option<String>

Use this setting to add an identifying string to the filename of each segment. The service adds this string between the name modifier and segment index number. You can use format identifiers in the string. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html

Implementations

impl HlsSettings

pub fn audio_group_id(&self) -> Option<&str>

Specifies the group to which the audio rendition belongs.

pub fn audio_only_container(&self) -> Option<&HlsAudioOnlyContainer>

Use this setting only in audio-only outputs. Choose MPEG-2 Transport Stream (M2TS) to create a file in an MPEG2-TS container. Keep the default value Automatic to create an audio-only file in a raw container. Regardless of the value that you specify here, if this output has video, the service will place the output into an MPEG2-TS container.

pub fn audio_rendition_sets(&self) -> Option<&str>

List all the audio groups that are used with the video output stream. Input all the audio GROUP-IDs that are associated to the video, separate by ‘,’.

pub fn audio_track_type(&self) -> Option<&HlsAudioTrackType>

Four types of audio-only tracks are supported: Audio-Only Variant Stream The client can play back this audio-only stream instead of video in low-bandwidth scenarios. Represented as an EXT-X-STREAM-INF in the HLS manifest. Alternate Audio, Auto Select, Default Alternate rendition that the client should try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=YES, AUTOSELECT=YES Alternate Audio, Auto Select, Not Default Alternate rendition that the client may try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=YES Alternate Audio, not Auto Select Alternate rendition that the client will not try to play back by default. Represented as an EXT-X-MEDIA in the HLS manifest with DEFAULT=NO, AUTOSELECT=NO

pub fn descriptive_video_service_flag( &self ) -> Option<&HlsDescriptiveVideoServiceFlag>

Specify whether to flag this audio track as descriptive video service (DVS) in your HLS parent manifest. When you choose Flag, MediaConvert includes the parameter CHARACTERISTICS=“public.accessibility.describes-video” in the EXT-X-MEDIA entry for this track. When you keep the default choice, Don’t flag, MediaConvert leaves this parameter out. The DVS flag can help with accessibility on Apple devices. For more information, see the Apple documentation.

pub fn i_frame_only_manifest(&self) -> Option<&HlsIFrameOnlyManifest>

Choose Include to have MediaConvert generate a child manifest that lists only the I-frames for this rendition, in addition to your regular manifest for this rendition. You might use this manifest as part of a workflow that creates preview functions for your video. MediaConvert adds both the I-frame only child manifest and the regular child manifest to the parent manifest. When you don’t need the I-frame only child manifest, keep the default value Exclude.

pub fn segment_modifier(&self) -> Option<&str>

Use this setting to add an identifying string to the filename of each segment. The service adds this string between the name modifier and segment index number. You can use format identifiers in the string. For more information, see https://docs.aws.amazon.com/mediaconvert/latest/ug/using-variables-in-your-job-settings.html

impl HlsSettings

pub fn builder() -> HlsSettingsBuilder

Creates a new builder-style object to manufacture HlsSettings.

Trait Implementations

impl Clone for HlsSettings

fn clone(&self) -> HlsSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HlsSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for HlsSettings

fn eq(&self, other: &HlsSettings) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HlsSettings