Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class AudioMapping.
The mapping for the input streams and audio channels.
Generated from protobuf message google.cloud.video.livestream.v1.AudioStream.AudioMapping
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ input_key |
string
Required. The |
↳ input_track |
int
Required. The zero-based index of the track in the input stream. All mappings in the same AudioStream must have the same input track. |
↳ input_channel |
int
Required. The zero-based index of the channel in the input stream. |
↳ output_channel |
int
Required. The zero-based index of the channel in the output audio stream. Must be consistent with the input_channel. |
↳ gain_db |
float
Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0. |
getInputKey
Required. The Channel
InputAttachment.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 | |
|---|---|
| Type | Description |
string | |
setInputKey
Required. The Channel
InputAttachment.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.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInputTrack
Required. The zero-based index of the track in the input stream.
All mappings in the same AudioStream must have the same input track.
| Returns | |
|---|---|
| Type | Description |
int | |
setInputTrack
Required. The zero-based index of the track in the input stream.
All mappings in the same AudioStream must have the same input track.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getInputChannel
Required. The zero-based index of the channel in the input stream.
| Returns | |
|---|---|
| Type | Description |
int | |
setInputChannel
Required. The zero-based index of the channel in the input stream.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getOutputChannel
Required. The zero-based index of the channel in the output audio stream.
Must be consistent with the input_channel.
| Returns | |
|---|---|
| Type | Description |
int | |
setOutputChannel
Required. The zero-based index of the channel in the output audio stream.
Must be consistent with the input_channel.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGainDb
Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.
| Returns | |
|---|---|
| Type | Description |
float | |
setGainDb
Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this | |