Class: Google::Cloud::Video::LiveStream::V1::AudioStream

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/video/livestream/v1/outputs.rb

Overview

Audio stream resource.

Defined Under Namespace

Classes: AudioMapping

Instance Attribute Summary collapse

Instance Attribute Details

#bitrate_bps ⇒ ::Integer

Returns Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.

Returns:

  • (::Integer) —

    Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 423

class AudioStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The mapping for the input streams and audio channels.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     Required. The `Channel`
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     that identifies the input that this audio mapping applies to. If an
  #     active input doesn't have an audio mapping, the primary audio track in
  #     the input stream will be selected.
  # @!attribute [rw] input_track
  #   @return [::Integer]
  #     Required. The zero-based index of the track in the input stream.
  #     All {::Google::Cloud::Video::LiveStream::V1::AudioStream#mapping mapping}s in
  #     the same {::Google::Cloud::Video::LiveStream::V1::AudioStream AudioStream} must
  #     have the same input track.
  # @!attribute [rw] input_channel
  #   @return [::Integer]
  #     Required. The zero-based index of the channel in the input stream.
  # @!attribute [rw] output_channel
  #   @return [::Integer]
  #     Required. The zero-based index of the channel in the output audio stream.
  #     Must be consistent with the
  #     {::Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping#input_channel input_channel}.
  # @!attribute [rw] gain_db
  #   @return [::Float]
  #     Audio volume control in dB. Negative values decrease volume,
  #     positive values increase. The default is 0.
  class AudioMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#channel_count ⇒ ::Integer

Returns Number of audio channels. Must be between 1 and 6. The default is 2.

Returns:

  • (::Integer) —

    Number of audio channels. Must be between 1 and 6. The default is 2.



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 423

class AudioStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The mapping for the input streams and audio channels.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     Required. The `Channel`
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     that identifies the input that this audio mapping applies to. If an
  #     active input doesn't have an audio mapping, the primary audio track in
  #     the input stream will be selected.
  # @!attribute [rw] input_track
  #   @return [::Integer]
  #     Required. The zero-based index of the track in the input stream.
  #     All {::Google::Cloud::Video::LiveStream::V1::AudioStream#mapping mapping}s in
  #     the same {::Google::Cloud::Video::LiveStream::V1::AudioStream AudioStream} must
  #     have the same input track.
  # @!attribute [rw] input_channel
  #   @return [::Integer]
  #     Required. The zero-based index of the channel in the input stream.
  # @!attribute [rw] output_channel
  #   @return [::Integer]
  #     Required. The zero-based index of the channel in the output audio stream.
  #     Must be consistent with the
  #     {::Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping#input_channel input_channel}.
  # @!attribute [rw] gain_db
  #   @return [::Float]
  #     Audio volume control in dB. Negative values decrease volume,
  #     positive values increase. The default is 0.
  class AudioMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#channel_layout ⇒ ::Array<::String>

Returns A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is [fl, fr].

Supported channel names:

  • fl - Front left channel
  • fr - Front right channel
  • sl - Side left channel
  • sr - Side right channel
  • fc - Front center channel
  • lfe - Low frequency.

Returns:

  • (::Array<::String>) —

    A list of channel names specifying layout of the audio channels. This only affects the metadata embedded in the container headers, if supported by the specified format. The default is [fl, fr].

    Supported channel names:

    • fl - Front left channel
    • fr - Front right channel
    • sl - Side left channel
    • sr - Side right channel
    • fc - Front center channel
    • lfe - Low frequency


423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 423

class AudioStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The mapping for the input streams and audio channels.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     Required. The `Channel`
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     that identifies the input that this audio mapping applies to. If an
  #     active input doesn't have an audio mapping, the primary audio track in
  #     the input stream will be selected.
  # @!attribute [rw] input_track
  #   @return [::Integer]
  #     Required. The zero-based index of the track in the input stream.
  #     All {::Google::Cloud::Video::LiveStream::V1::AudioStream#mapping mapping}s in
  #     the same {::Google::Cloud::Video::LiveStream::V1::AudioStream AudioStream} must
  #     have the same input track.
  # @!attribute [rw] input_channel
  #   @return [::Integer]
  #     Required. The zero-based index of the channel in the input stream.
  # @!attribute [rw] output_channel
  #   @return [::Integer]
  #     Required. The zero-based index of the channel in the output audio stream.
  #     Must be consistent with the
  #     {::Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping#input_channel input_channel}.
  # @!attribute [rw] gain_db
  #   @return [::Float]
  #     Audio volume control in dB. Negative values decrease volume,
  #     positive values increase. The default is 0.
  class AudioMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#codec ⇒ ::String

Returns The codec for this audio stream. The default is aac.

Supported audio codecs:

  • aac.

Returns:

  • (::String) —

    The codec for this audio stream. The default is aac.

    Supported audio codecs:

    • aac


423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 423

class AudioStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The mapping for the input streams and audio channels.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     Required. The `Channel`
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     that identifies the input that this audio mapping applies to. If an
  #     active input doesn't have an audio mapping, the primary audio track in
  #     the input stream will be selected.
  # @!attribute [rw] input_track
  #   @return [::Integer]
  #     Required. The zero-based index of the track in the input stream.
  #     All {::Google::Cloud::Video::LiveStream::V1::AudioStream#mapping mapping}s in
  #     the same {::Google::Cloud::Video::LiveStream::V1::AudioStream AudioStream} must
  #     have the same input track.
  # @!attribute [rw] input_channel
  #   @return [::Integer]
  #     Required. The zero-based index of the channel in the input stream.
  # @!attribute [rw] output_channel
  #   @return [::Integer]
  #     Required. The zero-based index of the channel in the output audio stream.
  #     Must be consistent with the
  #     {::Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping#input_channel input_channel}.
  # @!attribute [rw] gain_db
  #   @return [::Float]
  #     Audio volume control in dB. Negative values decrease volume,
  #     positive values increase. The default is 0.
  class AudioMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#mapping ⇒ ::Array<::Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping>

Returns The mapping for the input streams and audio channels.

Returns:



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 423

class AudioStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The mapping for the input streams and audio channels.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     Required. The `Channel`
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     that identifies the input that this audio mapping applies to. If an
  #     active input doesn't have an audio mapping, the primary audio track in
  #     the input stream will be selected.
  # @!attribute [rw] input_track
  #   @return [::Integer]
  #     Required. The zero-based index of the track in the input stream.
  #     All {::Google::Cloud::Video::LiveStream::V1::AudioStream#mapping mapping}s in
  #     the same {::Google::Cloud::Video::LiveStream::V1::AudioStream AudioStream} must
  #     have the same input track.
  # @!attribute [rw] input_channel
  #   @return [::Integer]
  #     Required. The zero-based index of the channel in the input stream.
  # @!attribute [rw] output_channel
  #   @return [::Integer]
  #     Required. The zero-based index of the channel in the output audio stream.
  #     Must be consistent with the
  #     {::Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping#input_channel input_channel}.
  # @!attribute [rw] gain_db
  #   @return [::Float]
  #     Audio volume control in dB. Negative values decrease volume,
  #     positive values increase. The default is 0.
  class AudioMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#sample_rate_hertz ⇒ ::Integer

Returns The audio sample rate in Hertz. The default is 48000 Hertz.

Returns:

  • (::Integer) —

    The audio sample rate in Hertz. The default is 48000 Hertz.



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 423

class AudioStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The mapping for the input streams and audio channels.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     Required. The `Channel`
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     that identifies the input that this audio mapping applies to. If an
  #     active input doesn't have an audio mapping, the primary audio track in
  #     the input stream will be selected.
  # @!attribute [rw] input_track
  #   @return [::Integer]
  #     Required. The zero-based index of the track in the input stream.
  #     All {::Google::Cloud::Video::LiveStream::V1::AudioStream#mapping mapping}s in
  #     the same {::Google::Cloud::Video::LiveStream::V1::AudioStream AudioStream} must
  #     have the same input track.
  # @!attribute [rw] input_channel
  #   @return [::Integer]
  #     Required. The zero-based index of the channel in the input stream.
  # @!attribute [rw] output_channel
  #   @return [::Integer]
  #     Required. The zero-based index of the channel in the output audio stream.
  #     Must be consistent with the
  #     {::Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping#input_channel input_channel}.
  # @!attribute [rw] gain_db
  #   @return [::Float]
  #     Audio volume control in dB. Negative values decrease volume,
  #     positive values increase. The default is 0.
  class AudioMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#transmux ⇒ ::Boolean

Returns Specifies whether pass through (transmuxing) is enabled or not. If set to true, the rest of the settings, other than mapping, will be ignored. The default is false.

Returns:

  • (::Boolean) —

    Specifies whether pass through (transmuxing) is enabled or not. If set to true, the rest of the settings, other than mapping, will be ignored. The default is false.



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 423

class AudioStream
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The mapping for the input streams and audio channels.
  # @!attribute [rw] input_key
  #   @return [::String]
  #     Required. The `Channel`
  #     {::Google::Cloud::Video::LiveStream::V1::InputAttachment#key InputAttachment.key}
  #     that identifies the input that this audio mapping applies to. If an
  #     active input doesn't have an audio mapping, the primary audio track in
  #     the input stream will be selected.
  # @!attribute [rw] input_track
  #   @return [::Integer]
  #     Required. The zero-based index of the track in the input stream.
  #     All {::Google::Cloud::Video::LiveStream::V1::AudioStream#mapping mapping}s in
  #     the same {::Google::Cloud::Video::LiveStream::V1::AudioStream AudioStream} must
  #     have the same input track.
  # @!attribute [rw] input_channel
  #   @return [::Integer]
  #     Required. The zero-based index of the channel in the input stream.
  # @!attribute [rw] output_channel
  #   @return [::Integer]
  #     Required. The zero-based index of the channel in the output audio stream.
  #     Must be consistent with the
  #     {::Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping#input_channel input_channel}.
  # @!attribute [rw] gain_db
  #   @return [::Float]
  #     Audio volume control in dB. Negative values decrease volume,
  #     positive values increase. The default is 0.
  class AudioMapping
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end