Google Cloud Video Live Stream V1 Client - Class AudioMapping (0.4.2)

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

Namespace

Google \ Cloud \ Video \ LiveStream \ V1 \ AudioStream

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ input_key string

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.

↳ 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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$this

getInputChannel

Required. The zero-based index of the channel in the input stream.

Returns
TypeDescription
int

setInputChannel

Required. The zero-based index of the channel in the input stream.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getOutputChannel

Required. The zero-based index of the channel in the output audio stream.

Must be consistent with the input_channel.

Returns
TypeDescription
int

setOutputChannel

Required. The zero-based index of the channel in the output audio stream.

Must be consistent with the input_channel.

Parameter
NameDescription
var int
Returns
TypeDescription
$this

getGainDb

Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.

Returns
TypeDescription
float

setGainDb

Audio volume control in dB. Negative values decrease volume, positive values increase. The default is 0.

Parameter
NameDescription
var float
Returns
TypeDescription
$this