# Google Cloud Video Transcoder V1 Client - Class AudioStream (1.4.0)

1.4.0 (latest) 1.3.2 1.2.0 1.1.0 1.0.3 0.10.5 0.9.1 0.8.2 0.7.1 0.6.0 0.5.3 Reference documentation and code samples for the Google Cloud Video Transcoder V1 Client class AudioStream.

Audio stream resource.

Generated from protobuf message `google.cloud.video.transcoder.v1.AudioStream`

## Namespace

Google \\ Cloud \\ Video \\ Transcoder \\ V1

## Methods

### __construct

Constructor.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `data` | `array` Optional. Data for populating the Message object. |
| `↳ codec` | `string` The codec for this audio stream. The default is `aac`. Supported audio codecs: - `aac` - `aac-he` - `aac-he-v2` - `mp3` - `ac3` - `eac3` - `vorbis` |
| `↳ 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` | `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 |
| `↳ mapping` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-video-transcoder/latest/V1.AudioStream.AudioMapping>` The mapping for the [JobConfig.edit_list](https://docs.cloud.google.com/php/docs/reference/cloud-video-transcoder/latest/V1.JobConfig#_Google_Cloud_Video_Transcoder_V1_JobConfig__getEditList__) atoms with audio [EditAtom.inputs](https://docs.cloud.google.com/php/docs/reference/cloud-video-transcoder/latest/V1.EditAtom#_Google_Cloud_Video_Transcoder_V1_EditAtom__getInputs__). |
| `↳ sample_rate_hertz` | `int` The audio sample rate in Hertz. The default is 48000 Hertz. |
| `↳ language_code` | `string` The BCP-47 language code, such as `en-US` or `sr-Latn`. For more information, see <https://www.unicode.org/reports/tr35/#Unicode_locale_identifier>. Not supported in MP4 files. |
| `↳ display_name` | `string` The name for this particular audio stream that will be added to the HLS/DASH manifest. Not supported in MP4 files. |

### getCodec

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

Supported audio codecs:

- `aac`
- `aac-he`
- `aac-he-v2`
- `mp3`
- `ac3`
- `eac3`
- `vorbis`

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setCodec

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

Supported audio codecs:

- `aac`
- `aac-he`
- `aac-he-v2`
- `mp3`
- `ac3`
- `eac3`
- `vorbis`

| **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** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<string>` |   |

### 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
[JobConfig.edit_list](https://docs.cloud.google.com/php/docs/reference/cloud-video-transcoder/latest/V1.JobConfig#_Google_Cloud_Video_Transcoder_V1_JobConfig__getEditList__)
atoms with audio
[EditAtom.inputs](https://docs.cloud.google.com/php/docs/reference/cloud-video-transcoder/latest/V1.EditAtom#_Google_Cloud_Video_Transcoder_V1_EditAtom__getInputs__).

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://protobuf.dev/reference/php/api-docs/Google/Protobuf/RepeatedField<https://docs.cloud.google.com/php/docs/reference/cloud-video-transcoder/latest/V1.AudioStream.AudioMapping>` |   |

### setMapping

The mapping for the
[JobConfig.edit_list](https://docs.cloud.google.com/php/docs/reference/cloud-video-transcoder/latest/V1.JobConfig#_Google_Cloud_Video_Transcoder_V1_JobConfig__getEditList__)
atoms with audio
[EditAtom.inputs](https://docs.cloud.google.com/php/docs/reference/cloud-video-transcoder/latest/V1.EditAtom#_Google_Cloud_Video_Transcoder_V1_EditAtom__getInputs__).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `array<https://docs.cloud.google.com/php/docs/reference/cloud-video-transcoder/latest/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` |   |

### getLanguageCode

The BCP-47 language code, such as `en-US` or `sr-Latn`. For more
information, see
<https://www.unicode.org/reports/tr35/#Unicode_locale_identifier>. Not
supported in MP4 files.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setLanguageCode

The BCP-47 language code, such as `en-US` or `sr-Latn`. For more
information, see
<https://www.unicode.org/reports/tr35/#Unicode_locale_identifier>. Not
supported in MP4 files.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |

### getDisplayName

The name for this particular audio stream that
will be added to the HLS/DASH manifest. Not supported in MP4 files.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `string` |   |

### setDisplayName

The name for this particular audio stream that
will be added to the HLS/DASH manifest. Not supported in MP4 files.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `var` | `string` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `$this` |   |