Class: AWSCDK::MediaLive::CfnChannel::MsSmoothGroupSettingsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
media_live/cfn_channel.rb

Overview

The settings for a Microsoft Smooth output group.

The parent of this entity is OutputGroupSettings.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(acquisition_point_id: nil, audio_only_timecode_control: nil, certificate_mode: nil, connection_retry_interval: nil, destination: nil, event_id: nil, event_id_mode: nil, event_stop_behavior: nil, filecache_duration: nil, fragment_length: nil, input_loss_action: nil, num_retries: nil, restart_delay: nil, segmentation_mode: nil, send_delay_ms: nil, sparse_track_type: nil, stream_manifest_behavior: nil, timestamp_offset: nil, timestamp_offset_mode: nil) ⇒ MsSmoothGroupSettingsProperty

Returns a new instance of MsSmoothGroupSettingsProperty.

Parameters:

  • acquisition_point_id (String, nil) (defaults to: nil) —

    The value of the Acquisition Point Identity element that is used in each message placed in the sparse track.

  • audio_only_timecode_control (String, nil) (defaults to: nil) —

    If set to passthrough for an audio-only Microsoft Smooth output, the fragment absolute time is set to the current timecode.

  • certificate_mode (String, nil) (defaults to: nil) —

    If set to verifyAuthenticity, verifies the HTTPS certificate chain to a trusted certificate authority (CA).

  • connection_retry_interval (Numeric, nil) (defaults to: nil) —

    The number of seconds to wait before retrying the connection to the IIS server if the connection is lost.

  • destination (AWSCDK::IResolvable, AWSCDK::MediaLive::CfnChannel::OutputLocationRefProperty, nil) (defaults to: nil) —

    The Smooth Streaming publish point on an IIS server.

  • event_id (String, nil) (defaults to: nil) —

    The Microsoft Smooth channel ID that is sent to the IIS server.

  • event_id_mode (String, nil) (defaults to: nil) —

    Specifies whether to send a channel ID to the IIS server.

  • event_stop_behavior (String, nil) (defaults to: nil) —

    When set to sendEos, sends an EOS signal to an IIS server when stopping the channel.

  • filecache_duration (Numeric, nil) (defaults to: nil) —

    The size, in seconds, of the file cache for streaming outputs.

  • fragment_length (Numeric, nil) (defaults to: nil) —

    The length, in seconds, of mp4 fragments to generate.

  • input_loss_action (String, nil) (defaults to: nil) —

    A parameter that controls output group behavior on an input loss.

  • num_retries (Numeric, nil) (defaults to: nil) —

    The number of retry attempts.

  • restart_delay (Numeric, nil) (defaults to: nil) —

    The number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.

  • segmentation_mode (String, nil) (defaults to: nil) —

    useInputSegmentation has been deprecated.

  • send_delay_ms (Numeric, nil) (defaults to: nil) —

    The number of milliseconds to delay the output from the second pipeline.

  • sparse_track_type (String, nil) (defaults to: nil) —

    If set to scte35, uses incoming SCTE-35 messages to generate a sparse track in this group of Microsoft Smooth outputs.

  • stream_manifest_behavior (String, nil) (defaults to: nil) —

    When set to send, sends a stream manifest so that the publishing point doesn't start until all streams start.

  • timestamp_offset (String, nil) (defaults to: nil) —

    The timestamp offset for the channel.

  • timestamp_offset_mode (String, nil) (defaults to: nil) —

    The type of timestamp date offset to use.



10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
 
# File 'media_live/cfn_channel.rb', line 10947

def initialize(acquisition_point_id: nil, audio_only_timecode_control: nil, certificate_mode: nil, connection_retry_interval: nil, destination: nil, event_id: nil, event_id_mode: nil, event_stop_behavior: nil, filecache_duration: nil, fragment_length: nil, input_loss_action: nil, num_retries: nil, restart_delay: nil, segmentation_mode: nil, send_delay_ms: nil, sparse_track_type: nil, stream_manifest_behavior: nil, timestamp_offset: nil, timestamp_offset_mode: nil)
  @acquisition_point_id = acquisition_point_id
  Jsii::Type.check_type(@acquisition_point_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "acquisitionPointId") unless @acquisition_point_id.nil?
  @audio_only_timecode_control = audio_only_timecode_control
  Jsii::Type.check_type(@audio_only_timecode_control, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "audioOnlyTimecodeControl") unless @audio_only_timecode_control.nil?
  @certificate_mode = certificate_mode
  Jsii::Type.check_type(@certificate_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "certificateMode") unless @certificate_mode.nil?
  @connection_retry_interval = connection_retry_interval
  Jsii::Type.check_type(@connection_retry_interval, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "connectionRetryInterval") unless @connection_retry_interval.nil?
  @destination = destination.is_a?(Hash) ? ::AWSCDK::MediaLive::CfnChannel::OutputLocationRefProperty.new(**destination.transform_keys(&:to_sym)) : destination
  Jsii::Type.check_type(@destination, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19tZWRpYWxpdmUuQ2ZuQ2hhbm5lbC5PdXRwdXRMb2NhdGlvblJlZlByb3BlcnR5In1dfX0=")), "destination") unless @destination.nil?
  @event_id = event_id
  Jsii::Type.check_type(@event_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "eventId") unless @event_id.nil?
  @event_id_mode = event_id_mode
  Jsii::Type.check_type(@event_id_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "eventIdMode") unless @event_id_mode.nil?
  @event_stop_behavior = event_stop_behavior
  Jsii::Type.check_type(@event_stop_behavior, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "eventStopBehavior") unless @event_stop_behavior.nil?
  @filecache_duration = filecache_duration
  Jsii::Type.check_type(@filecache_duration, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "filecacheDuration") unless @filecache_duration.nil?
  @fragment_length = fragment_length
  Jsii::Type.check_type(@fragment_length, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "fragmentLength") unless @fragment_length.nil?
  @input_loss_action = input_loss_action
  Jsii::Type.check_type(@input_loss_action, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "inputLossAction") unless @input_loss_action.nil?
  @num_retries = num_retries
  Jsii::Type.check_type(@num_retries, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "numRetries") unless @num_retries.nil?
  @restart_delay = restart_delay
  Jsii::Type.check_type(@restart_delay, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "restartDelay") unless @restart_delay.nil?
  @segmentation_mode = segmentation_mode
  Jsii::Type.check_type(@segmentation_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "segmentationMode") unless @segmentation_mode.nil?
  @send_delay_ms = send_delay_ms
  Jsii::Type.check_type(@send_delay_ms, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "sendDelayMs") unless @send_delay_ms.nil?
  @sparse_track_type = sparse_track_type
  Jsii::Type.check_type(@sparse_track_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sparseTrackType") unless @sparse_track_type.nil?
  @stream_manifest_behavior = stream_manifest_behavior
  Jsii::Type.check_type(@stream_manifest_behavior, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "streamManifestBehavior") unless @stream_manifest_behavior.nil?
  @timestamp_offset = timestamp_offset
  Jsii::Type.check_type(@timestamp_offset, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timestampOffset") unless @timestamp_offset.nil?
  @timestamp_offset_mode = timestamp_offset_mode
  Jsii::Type.check_type(@timestamp_offset_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "timestampOffsetMode") unless @timestamp_offset_mode.nil?
end

Instance Attribute Details

#acquisition_point_id ⇒ String? (readonly)

The value of the Acquisition Point Identity element that is used in each message placed in the sparse track.

Enabled only if sparseTrackType is not "none."

Returns:

  • (String, nil)

See Also:



10994
10995
10996
 
# File 'media_live/cfn_channel.rb', line 10994

def acquisition_point_id
  @acquisition_point_id
end

#audio_only_timecode_control ⇒ String? (readonly)

If set to passthrough for an audio-only Microsoft Smooth output, the fragment absolute time is set to the current timecode.

This option does not write timecodes to the audio elementary stream.

Returns:

  • (String, nil)

See Also:



11001
11002
11003
 
# File 'media_live/cfn_channel.rb', line 11001

def audio_only_timecode_control
  @audio_only_timecode_control
end

#certificate_mode ⇒ String? (readonly)

If set to verifyAuthenticity, verifies the HTTPS certificate chain to a trusted certificate authority (CA).

This causes HTTPS outputs to self-signed certificates to fail.

Returns:

  • (String, nil)

See Also:



11008
11009
11010
 
# File 'media_live/cfn_channel.rb', line 11008

def certificate_mode
  @certificate_mode
end

#connection_retry_interval ⇒ Numeric? (readonly)

The number of seconds to wait before retrying the connection to the IIS server if the connection is lost.

Content is cached during this time, and the cache is delivered to the IIS server after the connection is re-established.

Returns:

  • (Numeric, nil)

See Also:



11015
11016
11017
 
# File 'media_live/cfn_channel.rb', line 11015

def connection_retry_interval
  @connection_retry_interval
end

#destination ⇒ AWSCDK::IResolvable, ... (readonly)

The Smooth Streaming publish point on an IIS server.

MediaLive acts as a "Push" encoder to IIS.

Returns:

See Also:



11022
11023
11024
 
# File 'media_live/cfn_channel.rb', line 11022

def destination
  @destination
end

#event_id ⇒ String? (readonly)

The Microsoft Smooth channel ID that is sent to the IIS server.

Specify the ID only if eventIdMode is set to useConfigured.

Returns:

  • (String, nil)

See Also:



11029
11030
11031
 
# File 'media_live/cfn_channel.rb', line 11029

def event_id
  @event_id
end

#event_id_mode ⇒ String? (readonly)

Specifies whether to send a channel ID to the IIS server.

If no channel ID is sent and the same channel is used without changing the publishing point, clients might see cached video from the previous run. Options: - "useConfigured" - use the value provided in eventId - "useTimestamp" - generate and send a channel ID based on the current timestamp - "noEventId" - do not send a channel ID to the IIS server.

Returns:

  • (String, nil)

See Also:



11036
11037
11038
 
# File 'media_live/cfn_channel.rb', line 11036

def event_id_mode
  @event_id_mode
end

#event_stop_behavior ⇒ String? (readonly)

When set to sendEos, sends an EOS signal to an IIS server when stopping the channel.

Returns:

  • (String, nil)

See Also:



11041
11042
11043
 
# File 'media_live/cfn_channel.rb', line 11041

def event_stop_behavior
  @event_stop_behavior
end

#filecache_duration ⇒ Numeric? (readonly)

The size, in seconds, of the file cache for streaming outputs.

Returns:

  • (Numeric, nil)

See Also:



11046
11047
11048
 
# File 'media_live/cfn_channel.rb', line 11046

def filecache_duration
  @filecache_duration
end

#fragment_length ⇒ Numeric? (readonly)

The length, in seconds, of mp4 fragments to generate.

The fragment length must be compatible with GOP size and frame rate.

Returns:

  • (Numeric, nil)

See Also:



11053
11054
11055
 
# File 'media_live/cfn_channel.rb', line 11053

def fragment_length
  @fragment_length
end

#input_loss_action ⇒ String? (readonly)

A parameter that controls output group behavior on an input loss.

Returns:

  • (String, nil)

See Also:



11058
11059
11060
 
# File 'media_live/cfn_channel.rb', line 11058

def input_loss_action
  @input_loss_action
end

#num_retries ⇒ Numeric? (readonly)

The number of retry attempts.

Returns:

  • (Numeric, nil)

See Also:



11063
11064
11065
 
# File 'media_live/cfn_channel.rb', line 11063

def num_retries
  @num_retries
end

#restart_delay ⇒ Numeric? (readonly)

The number of seconds before initiating a restart due to output failure, due to exhausting the numRetries on one segment, or exceeding filecacheDuration.

Returns:

  • (Numeric, nil)

See Also:



11068
11069
11070
 
# File 'media_live/cfn_channel.rb', line 11068

def restart_delay
  @restart_delay
end

#segmentation_mode ⇒ String? (readonly)

useInputSegmentation has been deprecated.

The configured segment size is always used.

Returns:

  • (String, nil)

See Also:



11075
11076
11077
 
# File 'media_live/cfn_channel.rb', line 11075

def segmentation_mode
  @segmentation_mode
end

#send_delay_ms ⇒ Numeric? (readonly)

The number of milliseconds to delay the output from the second pipeline.

Returns:

  • (Numeric, nil)

See Also:



11080
11081
11082
 
# File 'media_live/cfn_channel.rb', line 11080

def send_delay_ms
  @send_delay_ms
end

#sparse_track_type ⇒ String? (readonly)

If set to scte35, uses incoming SCTE-35 messages to generate a sparse track in this group of Microsoft Smooth outputs.

Returns:

  • (String, nil)

See Also:



11085
11086
11087
 
# File 'media_live/cfn_channel.rb', line 11085

def sparse_track_type
  @sparse_track_type
end

#stream_manifest_behavior ⇒ String? (readonly)

When set to send, sends a stream manifest so that the publishing point doesn't start until all streams start.

Returns:

  • (String, nil)

See Also:



11090
11091
11092
 
# File 'media_live/cfn_channel.rb', line 11090

def stream_manifest_behavior
  @stream_manifest_behavior
end

#timestamp_offset ⇒ String? (readonly)

The timestamp offset for the channel.

Used only if timestampOffsetMode is set to useConfiguredOffset.

Returns:

  • (String, nil)

See Also:



11097
11098
11099
 
# File 'media_live/cfn_channel.rb', line 11097

def timestamp_offset
  @timestamp_offset
end

#timestamp_offset_mode ⇒ String? (readonly)

The type of timestamp date offset to use.

  • useEventStartDate: Use the date the channel was started as the offset - useConfiguredOffset: Use an explicitly configured date as the offset.

Returns:

  • (String, nil)

See Also:



11104
11105
11106
 
# File 'media_live/cfn_channel.rb', line 11104

def timestamp_offset_mode
  @timestamp_offset_mode
end

Class Method Details

.jsii_properties ⇒ Object 



11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
 
# File 'media_live/cfn_channel.rb', line 11106

def self.jsii_properties
  {
    :acquisition_point_id => "acquisitionPointId",
    :audio_only_timecode_control => "audioOnlyTimecodeControl",
    :certificate_mode => "certificateMode",
    :connection_retry_interval => "connectionRetryInterval",
    :destination => "destination",
    :event_id => "eventId",
    :event_id_mode => "eventIdMode",
    :event_stop_behavior => "eventStopBehavior",
    :filecache_duration => "filecacheDuration",
    :fragment_length => "fragmentLength",
    :input_loss_action => "inputLossAction",
    :num_retries => "numRetries",
    :restart_delay => "restartDelay",
    :segmentation_mode => "segmentationMode",
    :send_delay_ms => "sendDelayMs",
    :sparse_track_type => "sparseTrackType",
    :stream_manifest_behavior => "streamManifestBehavior",
    :timestamp_offset => "timestampOffset",
    :timestamp_offset_mode => "timestampOffsetMode",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
 
# File 'media_live/cfn_channel.rb', line 11130

def to_jsii
  result = {}
  result.merge!({
    "acquisitionPointId" => @acquisition_point_id,
    "audioOnlyTimecodeControl" => @audio_only_timecode_control,
    "certificateMode" => @certificate_mode,
    "connectionRetryInterval" => @connection_retry_interval,
    "destination" => @destination,
    "eventId" => @event_id,
    "eventIdMode" => @event_id_mode,
    "eventStopBehavior" => @event_stop_behavior,
    "filecacheDuration" => @filecache_duration,
    "fragmentLength" => @fragment_length,
    "inputLossAction" => @input_loss_action,
    "numRetries" => @num_retries,
    "restartDelay" => @restart_delay,
    "segmentationMode" => @segmentation_mode,
    "sendDelayMs" => @send_delay_ms,
    "sparseTrackType" => @sparse_track_type,
    "streamManifestBehavior" => @stream_manifest_behavior,
    "timestampOffset" => @timestamp_offset,
    "timestampOffsetMode" => @timestamp_offset_mode,
  })
  result.compact
end