Reference documentation and code samples for the Live Stream V1 API class Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping.
The mapping for the input streams and audio channels.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#gain_db
defgain_db()->::Float
Returns
(::Float) — Audio volume control in dB. Negative values decrease volume,
positive values increase. The default is 0.
#gain_db=
defgain_db=(value)->::Float
Parameter
value (::Float) — Audio volume control in dB. Negative values decrease volume,
positive values increase. The default is 0.
Returns
(::Float) — Audio volume control in dB. Negative values decrease volume,
positive values increase. The default is 0.
#input_channel
definput_channel()->::Integer
Returns
(::Integer) — Required. The zero-based index of the channel in the input stream.
#input_channel=
definput_channel=(value)->::Integer
Parameter
value (::Integer) — Required. The zero-based index of the channel in the input stream.
Returns
(::Integer) — Required. The zero-based index of the channel in the input stream.
#input_key
definput_key()->::String
Returns
(::String) — Required. The ChannelInputAttachment.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.
#input_key=
definput_key=(value)->::String
Parameter
value (::String) — Required. The ChannelInputAttachment.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.
Returns
(::String) — Required. The ChannelInputAttachment.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.
#input_track
definput_track()->::Integer
Returns
(::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 AudioStream must
have the same input track.
#input_track=
definput_track=(value)->::Integer
Parameter
value (::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 AudioStream must
have the same input track.
Returns
(::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 AudioStream must
have the same input track.
#output_channel
defoutput_channel()->::Integer
Returns
(::Integer) — Required. The zero-based index of the channel in the output audio stream.
Must be consistent with the
input_channel.
#output_channel=
defoutput_channel=(value)->::Integer
Parameter
value (::Integer) — Required. The zero-based index of the channel in the output audio stream.
Must be consistent with the
input_channel.
Returns
(::Integer) — Required. The zero-based index of the channel in the output audio stream.
Must be consistent with the
input_channel.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Live Stream V1 API - Class Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping (v2.2.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.0 (latest)](/ruby/docs/reference/google-cloud-video-live_stream-v1/latest/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\n- [2.1.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/2.1.0/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\n- [2.0.1](/ruby/docs/reference/google-cloud-video-live_stream-v1/2.0.1/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\n- [1.3.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.3.0/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\n- [1.2.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.2.0/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\n- [1.1.1](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.1.1/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\n- [1.0.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.0.0/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\n- [0.9.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.9.0/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\n- [0.8.2](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.8.2/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\n- [0.7.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.7.0/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\n- [0.6.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.6.0/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\n- [0.5.1](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.5.1/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\n- [0.4.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.4.0/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\n- [0.3.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.3.0/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\n- [0.2.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.2.0/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\n- [0.1.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.1.0/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping) \nReference documentation and code samples for the Live Stream V1 API class Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping.\n\nThe mapping for the input streams and audio channels. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #gain_db\n\n def gain_db() -\u003e ::Float\n\n**Returns**\n\n- (::Float) --- Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.\n\n### #gain_db=\n\n def gain_db=(value) -\u003e ::Float\n\n**Parameter**\n\n- **value** (::Float) --- Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0. \n**Returns**\n\n- (::Float) --- Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.\n\n### #input_channel\n\n def input_channel() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Required. The zero-based index of the channel in the input stream.\n\n### #input_channel=\n\n def input_channel=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Required. The zero-based index of the channel in the input stream. \n**Returns**\n\n- (::Integer) --- Required. The zero-based index of the channel in the input stream.\n\n### #input_key\n\n def input_key() -\u003e ::String\n\n**Returns**\n\n- (::String) --- Required. The `Channel` [InputAttachment.key](/ruby/docs/reference/google-cloud-video-live_stream-v1/latest/Google-Cloud-Video-LiveStream-V1-InputAttachment#Google__Cloud__Video__LiveStream__V1__InputAttachment_key_instance_ \"Google::Cloud::Video::LiveStream::V1::InputAttachment#key (method)\") 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.\n\n### #input_key=\n\n def input_key=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- Required. The `Channel` [InputAttachment.key](/ruby/docs/reference/google-cloud-video-live_stream-v1/latest/Google-Cloud-Video-LiveStream-V1-InputAttachment#Google__Cloud__Video__LiveStream__V1__InputAttachment_key_instance_ \"Google::Cloud::Video::LiveStream::V1::InputAttachment#key (method)\") 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. \n**Returns**\n\n- (::String) --- Required. The `Channel` [InputAttachment.key](/ruby/docs/reference/google-cloud-video-live_stream-v1/latest/Google-Cloud-Video-LiveStream-V1-InputAttachment#Google__Cloud__Video__LiveStream__V1__InputAttachment_key_instance_ \"Google::Cloud::Video::LiveStream::V1::InputAttachment#key (method)\") 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.\n\n### #input_track\n\n def input_track() -\u003e ::Integer\n\n**Returns**\n\n- (::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 [AudioStream](/ruby/docs/reference/google-cloud-video-live_stream-v1/latest/Google-Cloud-Video-LiveStream-V1-AudioStream \"Google::Cloud::Video::LiveStream::V1::AudioStream (class)\") must have the same input track.\n\n### #input_track=\n\n def input_track=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::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 [AudioStream](/ruby/docs/reference/google-cloud-video-live_stream-v1/latest/Google-Cloud-Video-LiveStream-V1-AudioStream \"Google::Cloud::Video::LiveStream::V1::AudioStream (class)\") must have the same input track. \n**Returns**\n\n- (::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 [AudioStream](/ruby/docs/reference/google-cloud-video-live_stream-v1/latest/Google-Cloud-Video-LiveStream-V1-AudioStream \"Google::Cloud::Video::LiveStream::V1::AudioStream (class)\") must have the same input track.\n\n### #output_channel\n\n def output_channel() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Required. The zero-based index of the channel in the output audio stream. Must be consistent with the [input_channel](/ruby/docs/reference/google-cloud-video-live_stream-v1/latest/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping#Google__Cloud__Video__LiveStream__V1__AudioStream__AudioMapping_input_channel_instance_ \"Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping#input_channel (method)\").\n\n### #output_channel=\n\n def output_channel=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Required. The zero-based index of the channel in the output audio stream. Must be consistent with the [input_channel](/ruby/docs/reference/google-cloud-video-live_stream-v1/latest/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping#Google__Cloud__Video__LiveStream__V1__AudioStream__AudioMapping_input_channel_instance_ \"Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping#input_channel (method)\"). \n**Returns**\n\n- (::Integer) --- Required. The zero-based index of the channel in the output audio stream. Must be consistent with the [input_channel](/ruby/docs/reference/google-cloud-video-live_stream-v1/latest/Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping#Google__Cloud__Video__LiveStream__V1__AudioStream__AudioMapping_input_channel_instance_ \"Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping#input_channel (method)\")."]]