Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class AudioStream.
Audio stream resource.
Generated from protobuf messagegoogle.cloud.video.livestream.v1.AudioStream
Namespace
Google \ Cloud \ Video \ LiveStream \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ transmux
bool
Specifies whether pass through (transmuxing) is enabled or not. If set totrue, the rest of the settings, other thanmapping, will be ignored. The default isfalse.
↳ codec
string
The codec for this audio stream. The default isaac. Supported audio codecs: -aac
↳ bitrate_bps
int
Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.
↳ channel_count
int
Number of audio channels. Must be between 1 and 6. The default is 2.
↳ channel_layout
array
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
The mapping for the input streams and audio channels.
↳ sample_rate_hertz
int
The audio sample rate in Hertz. The default is 48000 Hertz.
getTransmux
Specifies whether pass through (transmuxing) is enabled or not.
If set totrue, the rest of the settings, other thanmapping, will be
ignored. The default isfalse.
Returns
Type
Description
bool
setTransmux
Specifies whether pass through (transmuxing) is enabled or not.
If set totrue, the rest of the settings, other thanmapping, will be
ignored. The default isfalse.
Parameter
Name
Description
var
bool
Returns
Type
Description
$this
getCodec
The codec for this audio stream. The default isaac.
Supported audio codecs:
aac
Returns
Type
Description
string
setCodec
The codec for this audio stream. The default isaac.
Supported audio codecs:
aac
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getBitrateBps
Required. Audio bitrate in bits per second. Must be between 1 and
10,000,000.
Returns
Type
Description
int
setBitrateBps
Required. Audio bitrate in bits per second. Must be between 1 and
10,000,000.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getChannelCount
Number of audio channels. Must be between 1 and 6. The default is 2.
Returns
Type
Description
int
setChannelCount
Number of audio channels. Must be between 1 and 6. The default is 2.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getChannelLayout
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:
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
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
getMapping
The mapping for the input streams and audio channels.
[[["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,["# Google Cloud Video Live Stream V1 Client - Class AudioStream (1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/php/docs/reference/cloud-video-live-stream/latest/V1.AudioStream)\n- [1.2.0](/php/docs/reference/cloud-video-live-stream/1.2.0/V1.AudioStream)\n- [1.1.3](/php/docs/reference/cloud-video-live-stream/1.1.3/V1.AudioStream)\n- [1.0.0](/php/docs/reference/cloud-video-live-stream/1.0.0/V1.AudioStream)\n- [0.7.5](/php/docs/reference/cloud-video-live-stream/0.7.5/V1.AudioStream)\n- [0.6.2](/php/docs/reference/cloud-video-live-stream/0.6.2/V1.AudioStream)\n- [0.5.0](/php/docs/reference/cloud-video-live-stream/0.5.0/V1.AudioStream)\n- [0.4.2](/php/docs/reference/cloud-video-live-stream/0.4.2/V1.AudioStream)\n- [0.3.2](/php/docs/reference/cloud-video-live-stream/0.3.2/V1.AudioStream)\n- [0.2.6](/php/docs/reference/cloud-video-live-stream/0.2.6/V1.AudioStream) \nReference documentation and code samples for the Google Cloud Video Live Stream V1 Client class AudioStream.\n\nAudio stream resource.\n\nGenerated from protobuf message `google.cloud.video.livestream.v1.AudioStream`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Video \\\\ LiveStream \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getTransmux\n\nSpecifies whether pass through (transmuxing) is enabled or not.\n\nIf set to `true`, the rest of the settings, other than `mapping`, will be\nignored. The default is `false`.\n\n### setTransmux\n\nSpecifies whether pass through (transmuxing) is enabled or not.\n\nIf set to `true`, the rest of the settings, other than `mapping`, will be\nignored. The default is `false`.\n\n### getCodec\n\nThe codec for this audio stream. The default is `aac`.\n\nSupported audio codecs:\n\n- `aac`\n\n### setCodec\n\nThe codec for this audio stream. The default is `aac`.\n\nSupported audio codecs:\n\n- `aac`\n\n### getBitrateBps\n\nRequired. Audio bitrate in bits per second. Must be between 1 and\n10,000,000.\n\n### setBitrateBps\n\nRequired. Audio bitrate in bits per second. Must be between 1 and\n10,000,000.\n\n### getChannelCount\n\nNumber of audio channels. Must be between 1 and 6. The default is 2.\n\n### setChannelCount\n\nNumber of audio channels. Must be between 1 and 6. The default is 2.\n\n### getChannelLayout\n\nA list of channel names specifying layout of the audio channels.\n\nThis only affects the metadata embedded in the container headers, if\nsupported by the specified format. The default is `[fl, fr]`.\nSupported channel names:\n\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### setChannelLayout\n\nA list of channel names specifying layout of the audio channels.\n\nThis only affects the metadata embedded in the container headers, if\nsupported by the specified format. The default is `[fl, fr]`.\nSupported channel names:\n\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### getMapping\n\nThe mapping for the input streams and audio channels.\n\n### setMapping\n\nThe mapping for the input streams and audio channels.\n\n### getSampleRateHertz\n\nThe audio sample rate in Hertz. The default is 48000 Hertz.\n\n### setSampleRateHertz\n\nThe audio sample rate in Hertz. The default is 48000 Hertz."]]
