aws_sdk_elastictranscoder/types/

_create_job_playlist.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.

/// <p>Information about the master playlist.</p>
#[non_exhaustive]
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::fmt::Debug)]
pub struct CreateJobPlaylist {
    /// <p>The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a <code>/</code> character, the section of the name before the last <code>/</code> must be identical for all <code>Name</code> objects. If you create more than one master playlist, the values of all <code>Name</code> objects must be unique.</p><note>
    /// <p>Elastic Transcoder automatically appends the relevant file extension to the file name (<code>.m3u8</code> for <code>HLSv3</code> and <code>HLSv4</code> playlists, and <code>.ism</code> and <code>.ismc</code> for <code>Smooth</code> playlists). If you include a file extension in <code>Name</code>, the file name will have two extensions.</p>
    /// </note>
    pub name: ::std::option::Option<::std::string::String>,
    /// <p>The format of the output playlist. Valid formats include <code>HLSv3</code>, <code>HLSv4</code>, and <code>Smooth</code>.</p>
    pub format: ::std::option::Option<::std::string::String>,
    /// <p>For each output in this job that you want to include in a master playlist, the value of the <code>Outputs:Key</code> object.</p>
    /// <ul>
    /// <li>
    /// <p>If your output is not <code>HLS</code> or does not have a segment duration set, the name of the output file is a concatenation of <code>OutputKeyPrefix</code> and <code>Outputs:Key</code>:</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code></p></li>
    /// <li>
    /// <p>If your output is <code>HLSv3</code> and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of <code>.m3u8</code>, and a series of <code>.ts</code> files that include a five-digit sequential counter beginning with 00000:</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>.m3u8</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>00000.ts</p></li>
    /// <li>
    /// <p>If your output is <code>HLSv4</code>, has a segment duration set, and is included in an <code>HLSv4</code> playlist, Elastic Transcoder creates an output playlist file with a file extension of <code>_v4.m3u8</code>. If the output is video, Elastic Transcoder also creates an output file with an extension of <code>_iframe.m3u8</code>:</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>_v4.m3u8</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>_iframe.m3u8</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>.ts</p></li>
    /// </ul>
    /// <p>Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.</p>
    /// <p>If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For <code>Smooth</code> playlists, the <code>Audio:Profile</code>, <code>Video:Profile</code>, and <code>Video:FrameRate</code> to <code>Video:KeyframesMaxDist</code> ratio must be the same for all outputs.</p>
    pub output_keys: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    /// <p>The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.</p>
    pub hls_content_protection: ::std::option::Option<crate::types::HlsContentProtection>,
    /// <p>The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.</p>
    pub play_ready_drm: ::std::option::Option<crate::types::PlayReadyDrm>,
}
impl CreateJobPlaylist {
    /// <p>The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a <code>/</code> character, the section of the name before the last <code>/</code> must be identical for all <code>Name</code> objects. If you create more than one master playlist, the values of all <code>Name</code> objects must be unique.</p><note>
    /// <p>Elastic Transcoder automatically appends the relevant file extension to the file name (<code>.m3u8</code> for <code>HLSv3</code> and <code>HLSv4</code> playlists, and <code>.ism</code> and <code>.ismc</code> for <code>Smooth</code> playlists). If you include a file extension in <code>Name</code>, the file name will have two extensions.</p>
    /// </note>
    pub fn name(&self) -> ::std::option::Option<&str> {
        self.name.as_deref()
    }
    /// <p>The format of the output playlist. Valid formats include <code>HLSv3</code>, <code>HLSv4</code>, and <code>Smooth</code>.</p>
    pub fn format(&self) -> ::std::option::Option<&str> {
        self.format.as_deref()
    }
    /// <p>For each output in this job that you want to include in a master playlist, the value of the <code>Outputs:Key</code> object.</p>
    /// <ul>
    /// <li>
    /// <p>If your output is not <code>HLS</code> or does not have a segment duration set, the name of the output file is a concatenation of <code>OutputKeyPrefix</code> and <code>Outputs:Key</code>:</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code></p></li>
    /// <li>
    /// <p>If your output is <code>HLSv3</code> and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of <code>.m3u8</code>, and a series of <code>.ts</code> files that include a five-digit sequential counter beginning with 00000:</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>.m3u8</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>00000.ts</p></li>
    /// <li>
    /// <p>If your output is <code>HLSv4</code>, has a segment duration set, and is included in an <code>HLSv4</code> playlist, Elastic Transcoder creates an output playlist file with a file extension of <code>_v4.m3u8</code>. If the output is video, Elastic Transcoder also creates an output file with an extension of <code>_iframe.m3u8</code>:</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>_v4.m3u8</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>_iframe.m3u8</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>.ts</p></li>
    /// </ul>
    /// <p>Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.</p>
    /// <p>If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For <code>Smooth</code> playlists, the <code>Audio:Profile</code>, <code>Video:Profile</code>, and <code>Video:FrameRate</code> to <code>Video:KeyframesMaxDist</code> ratio must be the same for all outputs.</p>
    ///
    /// If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use `.output_keys.is_none()`.
    pub fn output_keys(&self) -> &[::std::string::String] {
        self.output_keys.as_deref().unwrap_or_default()
    }
    /// <p>The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.</p>
    pub fn hls_content_protection(&self) -> ::std::option::Option<&crate::types::HlsContentProtection> {
        self.hls_content_protection.as_ref()
    }
    /// <p>The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.</p>
    pub fn play_ready_drm(&self) -> ::std::option::Option<&crate::types::PlayReadyDrm> {
        self.play_ready_drm.as_ref()
    }
}
impl CreateJobPlaylist {
    /// Creates a new builder-style object to manufacture [`CreateJobPlaylist`](crate::types::CreateJobPlaylist).
    pub fn builder() -> crate::types::builders::CreateJobPlaylistBuilder {
        crate::types::builders::CreateJobPlaylistBuilder::default()
    }
}

/// A builder for [`CreateJobPlaylist`](crate::types::CreateJobPlaylist).
#[derive(::std::clone::Clone, ::std::cmp::PartialEq, ::std::default::Default, ::std::fmt::Debug)]
#[non_exhaustive]
pub struct CreateJobPlaylistBuilder {
    pub(crate) name: ::std::option::Option<::std::string::String>,
    pub(crate) format: ::std::option::Option<::std::string::String>,
    pub(crate) output_keys: ::std::option::Option<::std::vec::Vec<::std::string::String>>,
    pub(crate) hls_content_protection: ::std::option::Option<crate::types::HlsContentProtection>,
    pub(crate) play_ready_drm: ::std::option::Option<crate::types::PlayReadyDrm>,
}
impl CreateJobPlaylistBuilder {
    /// <p>The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a <code>/</code> character, the section of the name before the last <code>/</code> must be identical for all <code>Name</code> objects. If you create more than one master playlist, the values of all <code>Name</code> objects must be unique.</p><note>
    /// <p>Elastic Transcoder automatically appends the relevant file extension to the file name (<code>.m3u8</code> for <code>HLSv3</code> and <code>HLSv4</code> playlists, and <code>.ism</code> and <code>.ismc</code> for <code>Smooth</code> playlists). If you include a file extension in <code>Name</code>, the file name will have two extensions.</p>
    /// </note>
    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.name = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a <code>/</code> character, the section of the name before the last <code>/</code> must be identical for all <code>Name</code> objects. If you create more than one master playlist, the values of all <code>Name</code> objects must be unique.</p><note>
    /// <p>Elastic Transcoder automatically appends the relevant file extension to the file name (<code>.m3u8</code> for <code>HLSv3</code> and <code>HLSv4</code> playlists, and <code>.ism</code> and <code>.ismc</code> for <code>Smooth</code> playlists). If you include a file extension in <code>Name</code>, the file name will have two extensions.</p>
    /// </note>
    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.name = input;
        self
    }
    /// <p>The name that you want Elastic Transcoder to assign to the master playlist, for example, nyc-vacation.m3u8. If the name includes a <code>/</code> character, the section of the name before the last <code>/</code> must be identical for all <code>Name</code> objects. If you create more than one master playlist, the values of all <code>Name</code> objects must be unique.</p><note>
    /// <p>Elastic Transcoder automatically appends the relevant file extension to the file name (<code>.m3u8</code> for <code>HLSv3</code> and <code>HLSv4</code> playlists, and <code>.ism</code> and <code>.ismc</code> for <code>Smooth</code> playlists). If you include a file extension in <code>Name</code>, the file name will have two extensions.</p>
    /// </note>
    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
        &self.name
    }
    /// <p>The format of the output playlist. Valid formats include <code>HLSv3</code>, <code>HLSv4</code>, and <code>Smooth</code>.</p>
    pub fn format(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        self.format = ::std::option::Option::Some(input.into());
        self
    }
    /// <p>The format of the output playlist. Valid formats include <code>HLSv3</code>, <code>HLSv4</code>, and <code>Smooth</code>.</p>
    pub fn set_format(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
        self.format = input;
        self
    }
    /// <p>The format of the output playlist. Valid formats include <code>HLSv3</code>, <code>HLSv4</code>, and <code>Smooth</code>.</p>
    pub fn get_format(&self) -> &::std::option::Option<::std::string::String> {
        &self.format
    }
    /// Appends an item to `output_keys`.
    ///
    /// To override the contents of this collection use [`set_output_keys`](Self::set_output_keys).
    ///
    /// <p>For each output in this job that you want to include in a master playlist, the value of the <code>Outputs:Key</code> object.</p>
    /// <ul>
    /// <li>
    /// <p>If your output is not <code>HLS</code> or does not have a segment duration set, the name of the output file is a concatenation of <code>OutputKeyPrefix</code> and <code>Outputs:Key</code>:</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code></p></li>
    /// <li>
    /// <p>If your output is <code>HLSv3</code> and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of <code>.m3u8</code>, and a series of <code>.ts</code> files that include a five-digit sequential counter beginning with 00000:</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>.m3u8</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>00000.ts</p></li>
    /// <li>
    /// <p>If your output is <code>HLSv4</code>, has a segment duration set, and is included in an <code>HLSv4</code> playlist, Elastic Transcoder creates an output playlist file with a file extension of <code>_v4.m3u8</code>. If the output is video, Elastic Transcoder also creates an output file with an extension of <code>_iframe.m3u8</code>:</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>_v4.m3u8</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>_iframe.m3u8</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>.ts</p></li>
    /// </ul>
    /// <p>Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.</p>
    /// <p>If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For <code>Smooth</code> playlists, the <code>Audio:Profile</code>, <code>Video:Profile</code>, and <code>Video:FrameRate</code> to <code>Video:KeyframesMaxDist</code> ratio must be the same for all outputs.</p>
    pub fn output_keys(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
        let mut v = self.output_keys.unwrap_or_default();
        v.push(input.into());
        self.output_keys = ::std::option::Option::Some(v);
        self
    }
    /// <p>For each output in this job that you want to include in a master playlist, the value of the <code>Outputs:Key</code> object.</p>
    /// <ul>
    /// <li>
    /// <p>If your output is not <code>HLS</code> or does not have a segment duration set, the name of the output file is a concatenation of <code>OutputKeyPrefix</code> and <code>Outputs:Key</code>:</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code></p></li>
    /// <li>
    /// <p>If your output is <code>HLSv3</code> and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of <code>.m3u8</code>, and a series of <code>.ts</code> files that include a five-digit sequential counter beginning with 00000:</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>.m3u8</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>00000.ts</p></li>
    /// <li>
    /// <p>If your output is <code>HLSv4</code>, has a segment duration set, and is included in an <code>HLSv4</code> playlist, Elastic Transcoder creates an output playlist file with a file extension of <code>_v4.m3u8</code>. If the output is video, Elastic Transcoder also creates an output file with an extension of <code>_iframe.m3u8</code>:</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>_v4.m3u8</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>_iframe.m3u8</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>.ts</p></li>
    /// </ul>
    /// <p>Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.</p>
    /// <p>If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For <code>Smooth</code> playlists, the <code>Audio:Profile</code>, <code>Video:Profile</code>, and <code>Video:FrameRate</code> to <code>Video:KeyframesMaxDist</code> ratio must be the same for all outputs.</p>
    pub fn set_output_keys(mut self, input: ::std::option::Option<::std::vec::Vec<::std::string::String>>) -> Self {
        self.output_keys = input;
        self
    }
    /// <p>For each output in this job that you want to include in a master playlist, the value of the <code>Outputs:Key</code> object.</p>
    /// <ul>
    /// <li>
    /// <p>If your output is not <code>HLS</code> or does not have a segment duration set, the name of the output file is a concatenation of <code>OutputKeyPrefix</code> and <code>Outputs:Key</code>:</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code></p></li>
    /// <li>
    /// <p>If your output is <code>HLSv3</code> and has a segment duration set, or is not included in a playlist, Elastic Transcoder creates an output playlist file with a file extension of <code>.m3u8</code>, and a series of <code>.ts</code> files that include a five-digit sequential counter beginning with 00000:</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>.m3u8</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>00000.ts</p></li>
    /// <li>
    /// <p>If your output is <code>HLSv4</code>, has a segment duration set, and is included in an <code>HLSv4</code> playlist, Elastic Transcoder creates an output playlist file with a file extension of <code>_v4.m3u8</code>. If the output is video, Elastic Transcoder also creates an output file with an extension of <code>_iframe.m3u8</code>:</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>_v4.m3u8</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>_iframe.m3u8</p>
    /// <p>OutputKeyPrefix<code>Outputs:Key</code>.ts</p></li>
    /// </ul>
    /// <p>Elastic Transcoder automatically appends the relevant file extension to the file name. If you include a file extension in Output Key, the file name will have two extensions.</p>
    /// <p>If you include more than one output in a playlist, any segment duration settings, clip settings, or caption settings must be the same for all outputs in the playlist. For <code>Smooth</code> playlists, the <code>Audio:Profile</code>, <code>Video:Profile</code>, and <code>Video:FrameRate</code> to <code>Video:KeyframesMaxDist</code> ratio must be the same for all outputs.</p>
    pub fn get_output_keys(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
        &self.output_keys
    }
    /// <p>The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.</p>
    pub fn hls_content_protection(mut self, input: crate::types::HlsContentProtection) -> Self {
        self.hls_content_protection = ::std::option::Option::Some(input);
        self
    }
    /// <p>The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.</p>
    pub fn set_hls_content_protection(mut self, input: ::std::option::Option<crate::types::HlsContentProtection>) -> Self {
        self.hls_content_protection = input;
        self
    }
    /// <p>The HLS content protection settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.</p>
    pub fn get_hls_content_protection(&self) -> &::std::option::Option<crate::types::HlsContentProtection> {
        &self.hls_content_protection
    }
    /// <p>The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.</p>
    pub fn play_ready_drm(mut self, input: crate::types::PlayReadyDrm) -> Self {
        self.play_ready_drm = ::std::option::Option::Some(input);
        self
    }
    /// <p>The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.</p>
    pub fn set_play_ready_drm(mut self, input: ::std::option::Option<crate::types::PlayReadyDrm>) -> Self {
        self.play_ready_drm = input;
        self
    }
    /// <p>The DRM settings, if any, that you want Elastic Transcoder to apply to the output files associated with this playlist.</p>
    pub fn get_play_ready_drm(&self) -> &::std::option::Option<crate::types::PlayReadyDrm> {
        &self.play_ready_drm
    }
    /// Consumes the builder and constructs a [`CreateJobPlaylist`](crate::types::CreateJobPlaylist).
    pub fn build(self) -> crate::types::CreateJobPlaylist {
        crate::types::CreateJobPlaylist {
            name: self.name,
            format: self.format,
            output_keys: self.output_keys,
            hls_content_protection: self.hls_content_protection,
            play_ready_drm: self.play_ready_drm,
        }
    }
}