Class: Aws::MediaLive::Types::ScheduleActionSettings

Inherits:

Struct

• Object
• Struct
• Aws::MediaLive::Types::ScheduleActionSettings

Includes:

Structure

Defined in:

lib/aws-sdk-medialive/types.rb

Overview

Note:

When making an API call, you may pass ScheduleActionSettings data as a hash:

{
  hls_id_3_segment_tagging_settings: {
    tag: "__string", # required
  },
  hls_timed_metadata_settings: {
    id_3: "__string", # required
  },
  input_prepare_settings: {
    input_attachment_name_reference: "__string",
    input_clipping_settings: {
      input_timecode_source: "ZEROBASED", # required, accepts ZEROBASED, EMBEDDED
      start_timecode: {
        timecode: "__string",
      },
      stop_timecode: {
        last_frame_clipping_behavior: "EXCLUDE_LAST_FRAME", # accepts EXCLUDE_LAST_FRAME, INCLUDE_LAST_FRAME
        timecode: "__string",
      },
    },
    url_path: ["__string"],
  },
  input_switch_settings: {
    input_attachment_name_reference: "__string", # required
    input_clipping_settings: {
      input_timecode_source: "ZEROBASED", # required, accepts ZEROBASED, EMBEDDED
      start_timecode: {
        timecode: "__string",
      },
      stop_timecode: {
        last_frame_clipping_behavior: "EXCLUDE_LAST_FRAME", # accepts EXCLUDE_LAST_FRAME, INCLUDE_LAST_FRAME
        timecode: "__string",
      },
    },
    url_path: ["__string"],
  },
  motion_graphics_image_activate_settings: {
    duration: 1,
    password_param: "__string",
    url: "__string",
    username: "__string",
  },
  motion_graphics_image_deactivate_settings: {
  },
  pause_state_settings: {
    pipelines: [
      {
        pipeline_id: "PIPELINE_0", # required, accepts PIPELINE_0, PIPELINE_1
      },
    ],
  },
  scte_35_return_to_network_settings: {
    splice_event_id: 1, # required
  },
  scte_35_splice_insert_settings: {
    duration: 1,
    splice_event_id: 1, # required
  },
  scte_35_time_signal_settings: {
    scte_35_descriptors: [ # required
      {
        scte_35_descriptor_settings: { # required
          segmentation_descriptor_scte_35_descriptor_settings: { # required
            delivery_restrictions: {
              archive_allowed_flag: "ARCHIVE_NOT_ALLOWED", # required, accepts ARCHIVE_NOT_ALLOWED, ARCHIVE_ALLOWED
              device_restrictions: "NONE", # required, accepts NONE, RESTRICT_GROUP0, RESTRICT_GROUP1, RESTRICT_GROUP2
              no_regional_blackout_flag: "REGIONAL_BLACKOUT", # required, accepts REGIONAL_BLACKOUT, NO_REGIONAL_BLACKOUT
              web_delivery_allowed_flag: "WEB_DELIVERY_NOT_ALLOWED", # required, accepts WEB_DELIVERY_NOT_ALLOWED, WEB_DELIVERY_ALLOWED
            },
            segment_num: 1,
            segmentation_cancel_indicator: "SEGMENTATION_EVENT_NOT_CANCELED", # required, accepts SEGMENTATION_EVENT_NOT_CANCELED, SEGMENTATION_EVENT_CANCELED
            segmentation_duration: 1,
            segmentation_event_id: 1, # required
            segmentation_type_id: 1,
            segmentation_upid: "__string",
            segmentation_upid_type: 1,
            segments_expected: 1,
            sub_segment_num: 1,
            sub_segments_expected: 1,
          },
        },
      },
    ],
  },
  static_image_activate_settings: {
    duration: 1,
    fade_in: 1,
    fade_out: 1,
    height: 1,
    image: { # required
      password_param: "__string",
      uri: "__string", # required
      username: "__string",
    },
    image_x: 1,
    image_y: 1,
    layer: 1,
    opacity: 1,
    width: 1,
  },
  static_image_deactivate_settings: {
    fade_out: 1,
    layer: 1,
  },
}

Holds the settings for a single schedule action.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #hls_id_3_segment_tagging_settings ⇒ Types::HlsId3SegmentTaggingScheduleActionSettings

  Action to insert HLS ID3 segment tagging.

• #hls_timed_metadata_settings ⇒ Types::HlsTimedMetadataScheduleActionSettings

  Action to insert HLS metadata.

• #input_prepare_settings ⇒ Types::InputPrepareScheduleActionSettings

  Action to prepare an input for a future immediate input switch.

• #input_switch_settings ⇒ Types::InputSwitchScheduleActionSettings

  Action to switch the input.

• #motion_graphics_image_activate_settings ⇒ Types::MotionGraphicsActivateScheduleActionSettings

  Action to activate a motion graphics image overlay.

• #motion_graphics_image_deactivate_settings ⇒ Types::MotionGraphicsDeactivateScheduleActionSettings

  Action to deactivate a motion graphics image overlay.

• #pause_state_settings ⇒ Types::PauseStateScheduleActionSettings

  Action to pause or unpause one or both channel pipelines.

• #scte_35_return_to_network_settings ⇒ Types::Scte35ReturnToNetworkScheduleActionSettings

  Action to insert SCTE-35 return_to_network message.

• #scte_35_splice_insert_settings ⇒ Types::Scte35SpliceInsertScheduleActionSettings

  Action to insert SCTE-35 splice_insert message.

• #scte_35_time_signal_settings ⇒ Types::Scte35TimeSignalScheduleActionSettings

  Action to insert SCTE-35 time_signal message.

• #static_image_activate_settings ⇒ Types::StaticImageActivateScheduleActionSettings

  Action to activate a static image overlay.

• #static_image_deactivate_settings ⇒ Types::StaticImageDeactivateScheduleActionSettings

  Action to deactivate a static image overlay.

Instance Attribute Details

#hls_id_3_segment_tagging_settings ⇒ Types::HlsId3SegmentTaggingScheduleActionSettings

Action to insert HLS ID3 segment tagging

Returns:

• (Types::HlsId3SegmentTaggingScheduleActionSettings)

# File 'lib/aws-sdk-medialive/types.rb', line 15675

class ScheduleActionSettings < Struct.new(
  :hls_id_3_segment_tagging_settings,
  :hls_timed_metadata_settings,
  :input_prepare_settings,
  :input_switch_settings,
  :motion_graphics_image_activate_settings,
  :motion_graphics_image_deactivate_settings,
  :pause_state_settings,
  :scte_35_return_to_network_settings,
  :scte_35_splice_insert_settings,
  :scte_35_time_signal_settings,
  :static_image_activate_settings,
  :static_image_deactivate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#hls_timed_metadata_settings ⇒ Types::HlsTimedMetadataScheduleActionSettings

Action to insert HLS metadata

Returns:

• (Types::HlsTimedMetadataScheduleActionSettings)

# File 'lib/aws-sdk-medialive/types.rb', line 15675

class ScheduleActionSettings < Struct.new(
  :hls_id_3_segment_tagging_settings,
  :hls_timed_metadata_settings,
  :input_prepare_settings,
  :input_switch_settings,
  :motion_graphics_image_activate_settings,
  :motion_graphics_image_deactivate_settings,
  :pause_state_settings,
  :scte_35_return_to_network_settings,
  :scte_35_splice_insert_settings,
  :scte_35_time_signal_settings,
  :static_image_activate_settings,
  :static_image_deactivate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#input_prepare_settings ⇒ Types::InputPrepareScheduleActionSettings

Action to prepare an input for a future immediate input switch

Returns:

• (Types::InputPrepareScheduleActionSettings)

# File 'lib/aws-sdk-medialive/types.rb', line 15675

class ScheduleActionSettings < Struct.new(
  :hls_id_3_segment_tagging_settings,
  :hls_timed_metadata_settings,
  :input_prepare_settings,
  :input_switch_settings,
  :motion_graphics_image_activate_settings,
  :motion_graphics_image_deactivate_settings,
  :pause_state_settings,
  :scte_35_return_to_network_settings,
  :scte_35_splice_insert_settings,
  :scte_35_time_signal_settings,
  :static_image_activate_settings,
  :static_image_deactivate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#input_switch_settings ⇒ Types::InputSwitchScheduleActionSettings

Action to switch the input

Returns:

• (Types::InputSwitchScheduleActionSettings)

# File 'lib/aws-sdk-medialive/types.rb', line 15675

class ScheduleActionSettings < Struct.new(
  :hls_id_3_segment_tagging_settings,
  :hls_timed_metadata_settings,
  :input_prepare_settings,
  :input_switch_settings,
  :motion_graphics_image_activate_settings,
  :motion_graphics_image_deactivate_settings,
  :pause_state_settings,
  :scte_35_return_to_network_settings,
  :scte_35_splice_insert_settings,
  :scte_35_time_signal_settings,
  :static_image_activate_settings,
  :static_image_deactivate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#motion_graphics_image_activate_settings ⇒ Types::MotionGraphicsActivateScheduleActionSettings

Action to activate a motion graphics image overlay

Returns:

• (Types::MotionGraphicsActivateScheduleActionSettings)

# File 'lib/aws-sdk-medialive/types.rb', line 15675

class ScheduleActionSettings < Struct.new(
  :hls_id_3_segment_tagging_settings,
  :hls_timed_metadata_settings,
  :input_prepare_settings,
  :input_switch_settings,
  :motion_graphics_image_activate_settings,
  :motion_graphics_image_deactivate_settings,
  :pause_state_settings,
  :scte_35_return_to_network_settings,
  :scte_35_splice_insert_settings,
  :scte_35_time_signal_settings,
  :static_image_activate_settings,
  :static_image_deactivate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#motion_graphics_image_deactivate_settings ⇒ Types::MotionGraphicsDeactivateScheduleActionSettings

Action to deactivate a motion graphics image overlay

Returns:

• (Types::MotionGraphicsDeactivateScheduleActionSettings)

# File 'lib/aws-sdk-medialive/types.rb', line 15675

class ScheduleActionSettings < Struct.new(
  :hls_id_3_segment_tagging_settings,
  :hls_timed_metadata_settings,
  :input_prepare_settings,
  :input_switch_settings,
  :motion_graphics_image_activate_settings,
  :motion_graphics_image_deactivate_settings,
  :pause_state_settings,
  :scte_35_return_to_network_settings,
  :scte_35_splice_insert_settings,
  :scte_35_time_signal_settings,
  :static_image_activate_settings,
  :static_image_deactivate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#pause_state_settings ⇒ Types::PauseStateScheduleActionSettings

Action to pause or unpause one or both channel pipelines

Returns:

• (Types::PauseStateScheduleActionSettings)

# File 'lib/aws-sdk-medialive/types.rb', line 15675

class ScheduleActionSettings < Struct.new(
  :hls_id_3_segment_tagging_settings,
  :hls_timed_metadata_settings,
  :input_prepare_settings,
  :input_switch_settings,
  :motion_graphics_image_activate_settings,
  :motion_graphics_image_deactivate_settings,
  :pause_state_settings,
  :scte_35_return_to_network_settings,
  :scte_35_splice_insert_settings,
  :scte_35_time_signal_settings,
  :static_image_activate_settings,
  :static_image_deactivate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#scte_35_return_to_network_settings ⇒ Types::Scte35ReturnToNetworkScheduleActionSettings

Action to insert SCTE-35 return_to_network message

Returns:

• (Types::Scte35ReturnToNetworkScheduleActionSettings)

# File 'lib/aws-sdk-medialive/types.rb', line 15675

class ScheduleActionSettings < Struct.new(
  :hls_id_3_segment_tagging_settings,
  :hls_timed_metadata_settings,
  :input_prepare_settings,
  :input_switch_settings,
  :motion_graphics_image_activate_settings,
  :motion_graphics_image_deactivate_settings,
  :pause_state_settings,
  :scte_35_return_to_network_settings,
  :scte_35_splice_insert_settings,
  :scte_35_time_signal_settings,
  :static_image_activate_settings,
  :static_image_deactivate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#scte_35_splice_insert_settings ⇒ Types::Scte35SpliceInsertScheduleActionSettings

Action to insert SCTE-35 splice_insert message

Returns:

• (Types::Scte35SpliceInsertScheduleActionSettings)

# File 'lib/aws-sdk-medialive/types.rb', line 15675

class ScheduleActionSettings < Struct.new(
  :hls_id_3_segment_tagging_settings,
  :hls_timed_metadata_settings,
  :input_prepare_settings,
  :input_switch_settings,
  :motion_graphics_image_activate_settings,
  :motion_graphics_image_deactivate_settings,
  :pause_state_settings,
  :scte_35_return_to_network_settings,
  :scte_35_splice_insert_settings,
  :scte_35_time_signal_settings,
  :static_image_activate_settings,
  :static_image_deactivate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#scte_35_time_signal_settings ⇒ Types::Scte35TimeSignalScheduleActionSettings

Action to insert SCTE-35 time_signal message

Returns:

• (Types::Scte35TimeSignalScheduleActionSettings)

# File 'lib/aws-sdk-medialive/types.rb', line 15675

class ScheduleActionSettings < Struct.new(
  :hls_id_3_segment_tagging_settings,
  :hls_timed_metadata_settings,
  :input_prepare_settings,
  :input_switch_settings,
  :motion_graphics_image_activate_settings,
  :motion_graphics_image_deactivate_settings,
  :pause_state_settings,
  :scte_35_return_to_network_settings,
  :scte_35_splice_insert_settings,
  :scte_35_time_signal_settings,
  :static_image_activate_settings,
  :static_image_deactivate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#static_image_activate_settings ⇒ Types::StaticImageActivateScheduleActionSettings

Action to activate a static image overlay

Returns:

• (Types::StaticImageActivateScheduleActionSettings)

# File 'lib/aws-sdk-medialive/types.rb', line 15675

class ScheduleActionSettings < Struct.new(
  :hls_id_3_segment_tagging_settings,
  :hls_timed_metadata_settings,
  :input_prepare_settings,
  :input_switch_settings,
  :motion_graphics_image_activate_settings,
  :motion_graphics_image_deactivate_settings,
  :pause_state_settings,
  :scte_35_return_to_network_settings,
  :scte_35_splice_insert_settings,
  :scte_35_time_signal_settings,
  :static_image_activate_settings,
  :static_image_deactivate_settings)
  SENSITIVE = []
  include Aws::Structure
end

#static_image_deactivate_settings ⇒ Types::StaticImageDeactivateScheduleActionSettings

Action to deactivate a static image overlay

Returns:

• (Types::StaticImageDeactivateScheduleActionSettings)

# File 'lib/aws-sdk-medialive/types.rb', line 15675

class ScheduleActionSettings < Struct.new(
  :hls_id_3_segment_tagging_settings,
  :hls_timed_metadata_settings,
  :input_prepare_settings,
  :input_switch_settings,
  :motion_graphics_image_activate_settings,
  :motion_graphics_image_deactivate_settings,
  :pause_state_settings,
  :scte_35_return_to_network_settings,
  :scte_35_splice_insert_settings,
  :scte_35_time_signal_settings,
  :static_image_activate_settings,
  :static_image_deactivate_settings)
  SENSITIVE = []
  include Aws::Structure
end