Reference documentation and code samples for the Live Stream V1 API class Google::Cloud::Video::LiveStream::V1::AudioStream.
Audio stream resource.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#bitrate_bps
defbitrate_bps()->::Integer
Returns
(::Integer) — Required. Audio bitrate in bits per second. Must be between 1 and
10,000,000.
#bitrate_bps=
defbitrate_bps=(value)->::Integer
Parameter
value (::Integer) — 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.
#channel_count
defchannel_count()->::Integer
Returns
(::Integer) — Number of audio channels. Must be between 1 and 6. The default is 2.
#channel_count=
defchannel_count=(value)->::Integer
Parameter
value (::Integer) — 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.
#channel_layout
defchannel_layout()->::Array<::String>
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
#channel_layout=
defchannel_layout=(value)->::Array<::String>
Parameter
value (::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
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
#codec
defcodec()->::String
Returns
(::String) —
The codec for this audio stream. The default is aac.
Supported audio codecs:
aac
#codec=
defcodec=(value)->::String
Parameter
value (::String) —
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.
(::Integer) — The audio sample rate in Hertz. The default is 48000 Hertz.
#sample_rate_hertz=
defsample_rate_hertz=(value)->::Integer
Parameter
value (::Integer) — The audio sample rate in Hertz. The default is 48000 Hertz.
Returns
(::Integer) — The audio sample rate in Hertz. The default is 48000 Hertz.
#transmux
deftransmux()->::Boolean
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.
#transmux=
deftransmux=(value)->::Boolean
Parameter
value (::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.
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.
[[["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 (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)\n- [2.1.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/2.1.0/Google-Cloud-Video-LiveStream-V1-AudioStream)\n- [2.0.1](/ruby/docs/reference/google-cloud-video-live_stream-v1/2.0.1/Google-Cloud-Video-LiveStream-V1-AudioStream)\n- [1.3.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.3.0/Google-Cloud-Video-LiveStream-V1-AudioStream)\n- [1.2.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.2.0/Google-Cloud-Video-LiveStream-V1-AudioStream)\n- [1.1.1](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.1.1/Google-Cloud-Video-LiveStream-V1-AudioStream)\n- [1.0.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.0.0/Google-Cloud-Video-LiveStream-V1-AudioStream)\n- [0.9.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.9.0/Google-Cloud-Video-LiveStream-V1-AudioStream)\n- [0.8.2](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.8.2/Google-Cloud-Video-LiveStream-V1-AudioStream)\n- [0.7.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.7.0/Google-Cloud-Video-LiveStream-V1-AudioStream)\n- [0.6.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.6.0/Google-Cloud-Video-LiveStream-V1-AudioStream)\n- [0.5.1](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.5.1/Google-Cloud-Video-LiveStream-V1-AudioStream)\n- [0.4.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.4.0/Google-Cloud-Video-LiveStream-V1-AudioStream)\n- [0.3.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.3.0/Google-Cloud-Video-LiveStream-V1-AudioStream)\n- [0.2.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.2.0/Google-Cloud-Video-LiveStream-V1-AudioStream)\n- [0.1.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.1.0/Google-Cloud-Video-LiveStream-V1-AudioStream) \nReference documentation and code samples for the Live Stream V1 API class Google::Cloud::Video::LiveStream::V1::AudioStream.\n\nAudio stream resource. \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### #bitrate_bps\n\n def bitrate_bps() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.\n\n### #bitrate_bps=\n\n def bitrate_bps=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000. \n**Returns**\n\n- (::Integer) --- Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.\n\n### #channel_count\n\n def channel_count() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- Number of audio channels. Must be between 1 and 6. The default is 2.\n\n### #channel_count=\n\n def channel_count=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- Number of audio channels. Must be between 1 and 6. The default is 2. \n**Returns**\n\n- (::Integer) --- Number of audio channels. Must be between 1 and 6. The default is 2.\n\n### #channel_layout\n\n def channel_layout() -\u003e ::Array\u003c::String\u003e\n\n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- A list of channel names specifying layout of the audio channels.\n This only affects the metadata embedded in the container headers, if\n supported by the specified format. The default is `[fl, fr]`.\n\n Supported channel names:\n - `fl` - Front left channel\n - `fr` - Front right channel\n - `sl` - Side left channel\n - `sr` - Side right channel\n - `fc` - Front center channel\n - `lfe` - Low frequency\n\n### #channel_layout=\n\n def channel_layout=(value) -\u003e ::Array\u003c::String\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c::String\\\u003e) ---\n\n A list of channel names specifying layout of the audio channels.\n This only affects the metadata embedded in the container headers, if\n supported by the specified format. The default is `[fl, fr]`.\n\n Supported channel names:\n - `fl` - Front left channel\n - `fr` - Front right channel\n - `sl` - Side left channel\n - `sr` - Side right channel\n - `fc` - Front center channel\n- `lfe` - Low frequency \n**Returns**\n\n- (::Array\\\u003c::String\\\u003e) --- A list of channel names specifying layout of the audio channels.\n This only affects the metadata embedded in the container headers, if\n supported by the specified format. The default is `[fl, fr]`.\n\n Supported channel names:\n - `fl` - Front left channel\n - `fr` - Front right channel\n - `sl` - Side left channel\n - `sr` - Side right channel\n - `fc` - Front center channel\n - `lfe` - Low frequency\n\n### #codec\n\n def codec() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The codec for this audio stream. The default is `aac`.\n\n Supported audio codecs:\n - `aac`\n\n### #codec=\n\n def codec=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) ---\n\n The codec for this audio stream. The default is `aac`.\n\n Supported audio codecs:\n- `aac` \n**Returns**\n\n- (::String) --- The codec for this audio stream. The default is `aac`.\n\n Supported audio codecs:\n - `aac`\n\n### #mapping\n\n def mapping() -\u003e ::Array\u003c::Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping](./Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\\\u003e) --- The mapping for the input streams and audio channels.\n\n### #mapping=\n\n def mapping=(value) -\u003e ::Array\u003c::Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping](./Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\\\u003e) --- The mapping for the input streams and audio channels. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Video::LiveStream::V1::AudioStream::AudioMapping](./Google-Cloud-Video-LiveStream-V1-AudioStream-AudioMapping)\\\u003e) --- The mapping for the input streams and audio channels.\n\n### #sample_rate_hertz\n\n def sample_rate_hertz() -\u003e ::Integer\n\n**Returns**\n\n- (::Integer) --- The audio sample rate in Hertz. The default is 48000 Hertz.\n\n### #sample_rate_hertz=\n\n def sample_rate_hertz=(value) -\u003e ::Integer\n\n**Parameter**\n\n- **value** (::Integer) --- The audio sample rate in Hertz. The default is 48000 Hertz. \n**Returns**\n\n- (::Integer) --- The audio sample rate in Hertz. The default is 48000 Hertz.\n\n### #transmux\n\n def transmux() -\u003e ::Boolean\n\n**Returns**\n\n- (::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`.\n\n### #transmux=\n\n def transmux=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::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`. \n**Returns**\n\n- (::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`."]]
