Class AudioStream (0.56.0)

public final class AudioStream extends GeneratedMessageV3 implements AudioStreamOrBuilder

Audio stream resource.

Protobuf type google.cloud.video.livestream.v1.AudioStream

Static Fields

BITRATE_BPS_FIELD_NUMBER

public static final int BITRATE_BPS_FIELD_NUMBER
Field Value
Type Description
int

CHANNEL_COUNT_FIELD_NUMBER

public static final int CHANNEL_COUNT_FIELD_NUMBER
Field Value
Type Description
int

CHANNEL_LAYOUT_FIELD_NUMBER

public static final int CHANNEL_LAYOUT_FIELD_NUMBER
Field Value
Type Description
int

CODEC_FIELD_NUMBER

public static final int CODEC_FIELD_NUMBER
Field Value
Type Description
int

MAPPING_FIELD_NUMBER

public static final int MAPPING_FIELD_NUMBER
Field Value
Type Description
int

SAMPLE_RATE_HERTZ_FIELD_NUMBER

public static final int SAMPLE_RATE_HERTZ_FIELD_NUMBER
Field Value
Type Description
int

TRANSMUX_FIELD_NUMBER

public static final int TRANSMUX_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AudioStream getDefaultInstance()
Returns
Type Description
AudioStream

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static AudioStream.Builder newBuilder()
Returns
Type Description
AudioStream.Builder

newBuilder(AudioStream prototype)

public static AudioStream.Builder newBuilder(AudioStream prototype)
Parameter
Name Description
prototype AudioStream
Returns
Type Description
AudioStream.Builder

parseDelimitedFrom(InputStream input)

public static AudioStream parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AudioStream
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AudioStream parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudioStream
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AudioStream parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AudioStream
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AudioStream parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudioStream
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AudioStream parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AudioStream
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AudioStream parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudioStream
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AudioStream parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AudioStream
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AudioStream parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudioStream
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AudioStream parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AudioStream
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AudioStream parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudioStream
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AudioStream parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AudioStream
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AudioStream parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AudioStream
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AudioStream> parser()
Returns
Type Description
Parser<AudioStream>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getBitrateBps()

public int getBitrateBps()

Required. Audio bitrate in bits per second. Must be between 1 and 10,000,000.

int32 bitrate_bps = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
int

The bitrateBps.

getChannelCount()

public int getChannelCount()

Number of audio channels. Must be between 1 and 6. The default is 2.

int32 channel_count = 3;

Returns
Type Description
int

The channelCount.

getChannelLayout(int index)

public String getChannelLayout(int index)

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

repeated string channel_layout = 4;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The channelLayout at the given index.

getChannelLayoutBytes(int index)

public ByteString getChannelLayoutBytes(int index)

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

repeated string channel_layout = 4;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the channelLayout at the given index.

getChannelLayoutCount()

public int getChannelLayoutCount()

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

repeated string channel_layout = 4;

Returns
Type Description
int

The count of channelLayout.

getChannelLayoutList()

public ProtocolStringList getChannelLayoutList()

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

repeated string channel_layout = 4;

Returns
Type Description
ProtocolStringList

A list containing the channelLayout.

getCodec()

public String getCodec()

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

Supported audio codecs:

  • aac

string codec = 1;

Returns
Type Description
String

The codec.

getCodecBytes()

public ByteString getCodecBytes()

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

Supported audio codecs:

  • aac

string codec = 1;

Returns
Type Description
ByteString

The bytes for codec.

getDefaultInstanceForType()

public AudioStream getDefaultInstanceForType()
Returns
Type Description
AudioStream

getMapping(int index)

public AudioStream.AudioMapping getMapping(int index)

The mapping for the input streams and audio channels.

repeated .google.cloud.video.livestream.v1.AudioStream.AudioMapping mapping = 5;

Parameter
Name Description
index int
Returns
Type Description
AudioStream.AudioMapping

getMappingCount()

public int getMappingCount()

The mapping for the input streams and audio channels.

repeated .google.cloud.video.livestream.v1.AudioStream.AudioMapping mapping = 5;

Returns
Type Description
int

getMappingList()

public List<AudioStream.AudioMapping> getMappingList()

The mapping for the input streams and audio channels.

repeated .google.cloud.video.livestream.v1.AudioStream.AudioMapping mapping = 5;

Returns
Type Description
List<AudioMapping>

getMappingOrBuilder(int index)

public AudioStream.AudioMappingOrBuilder getMappingOrBuilder(int index)

The mapping for the input streams and audio channels.

repeated .google.cloud.video.livestream.v1.AudioStream.AudioMapping mapping = 5;

Parameter
Name Description
index int
Returns
Type Description
AudioStream.AudioMappingOrBuilder

getMappingOrBuilderList()

public List<? extends AudioStream.AudioMappingOrBuilder> getMappingOrBuilderList()

The mapping for the input streams and audio channels.

repeated .google.cloud.video.livestream.v1.AudioStream.AudioMapping mapping = 5;

Returns
Type Description
List<? extends com.google.cloud.video.livestream.v1.AudioStream.AudioMappingOrBuilder>

getParserForType()

public Parser<AudioStream> getParserForType()
Returns
Type Description
Parser<AudioStream>
Overrides

getSampleRateHertz()

public int getSampleRateHertz()

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

int32 sample_rate_hertz = 6;

Returns
Type Description
int

The sampleRateHertz.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTransmux()

public boolean 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.

bool transmux = 8;

Returns
Type Description
boolean

The transmux.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AudioStream.Builder newBuilderForType()
Returns
Type Description
AudioStream.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AudioStream.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AudioStream.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AudioStream.Builder toBuilder()
Returns
Type Description
AudioStream.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException