Class: Aws::IVS::Types::AudioConfiguration

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb

Overview

Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in an encoder). This is part of the IngestConfigurations object and the deprecated IngestConfiguration object. It is used for monitoring stream health.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#channels ⇒ Integer

Number of audio channels.

Returns:

  • (Integer)


191
192
193
194
195
196
197
198
199
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 191

class AudioConfiguration < Struct.new(
  :codec,
  :target_bitrate,
  :sample_rate,
  :channels,
  :track)
  SENSITIVE = []
  include Aws::Structure
end

#codec ⇒ String

Codec used for the audio encoding.

Returns:

  • (String)


191
192
193
194
195
196
197
198
199
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 191

class AudioConfiguration < Struct.new(
  :codec,
  :target_bitrate,
  :sample_rate,
  :channels,
  :track)
  SENSITIVE = []
  include Aws::Structure
end

#sample_rate ⇒ Integer

Number of audio samples recorded per second.

Returns:

  • (Integer)


191
192
193
194
195
196
197
198
199
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 191

class AudioConfiguration < Struct.new(
  :codec,
  :target_bitrate,
  :sample_rate,
  :channels,
  :track)
  SENSITIVE = []
  include Aws::Structure
end

#target_bitrate ⇒ Integer

The expected ingest bitrate (bits per second). This is configured in the encoder.

Returns:

  • (Integer)


191
192
193
194
195
196
197
198
199
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 191

class AudioConfiguration < Struct.new(
  :codec,
  :target_bitrate,
  :sample_rate,
  :channels,
  :track)
  SENSITIVE = []
  include Aws::Structure
end

#track ⇒ String

Name of the audio track (if the stream has an audio track). If multitrack is not enabled, this is Track0 (the sole track).

Returns:

  • (String)


191
192
193
194
195
196
197
198
199
# File 'gems/aws-sdk-ivs/lib/aws-sdk-ivs/types.rb', line 191

class AudioConfiguration < Struct.new(
  :codec,
  :target_bitrate,
  :sample_rate,
  :channels,
  :track)
  SENSITIVE = []
  include Aws::Structure
end