Google Cloud Video Live Stream V1 Client - Class AudioStream (0.2.6)

Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class AudioStream.

Audio stream resource.

Generated from protobuf message google.cloud.video.livestream.v1.AudioStream

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 to `true`, the rest of the settings, other than `mapping`, will be ignored. The default is `false`.
`↳ codec`	`string` The codec for this audio stream. The default is `aac`. 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
`↳ mapping`	`array<Google\Cloud\Video\LiveStream\V1\AudioStream\AudioMapping>` 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 to true, the rest of the settings, other than mapping, will be ignored. The default is false.

Returns
Type	Description
`bool`

setTransmux

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.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getCodec

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

Supported audio codecs:

aac

Returns
Type	Description
`string`

setCodec

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

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:

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

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setChannelLayout

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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setMapping

The mapping for the input streams and audio channels.

Parameter
Name	Description
`var`	`array<Google\Cloud\Video\LiveStream\V1\AudioStream\AudioMapping>`

Returns
Type	Description
`$this`

getSampleRateHertz

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

Returns
Type	Description
`int`

setSampleRateHertz

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

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`