Class AudioStream (0.34.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
TypeDescription
int

CHANNEL_COUNT_FIELD_NUMBER

public static final int CHANNEL_COUNT_FIELD_NUMBER
Field Value
TypeDescription
int

CHANNEL_LAYOUT_FIELD_NUMBER

public static final int CHANNEL_LAYOUT_FIELD_NUMBER
Field Value
TypeDescription
int

CODEC_FIELD_NUMBER

public static final int CODEC_FIELD_NUMBER
Field Value
TypeDescription
int

MAPPING_FIELD_NUMBER

public static final int MAPPING_FIELD_NUMBER
Field Value
TypeDescription
int

SAMPLE_RATE_HERTZ_FIELD_NUMBER

public static final int SAMPLE_RATE_HERTZ_FIELD_NUMBER
Field Value
TypeDescription
int

TRANSMUX_FIELD_NUMBER

public static final int TRANSMUX_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static AudioStream getDefaultInstance()
Returns
TypeDescription
AudioStream

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static AudioStream.Builder newBuilder()
Returns
TypeDescription
AudioStream.Builder

newBuilder(AudioStream prototype)

public static AudioStream.Builder newBuilder(AudioStream prototype)
Parameter
NameDescription
prototypeAudioStream
Returns
TypeDescription
AudioStream.Builder

parseDelimitedFrom(InputStream input)

public static AudioStream parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AudioStream
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AudioStream parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AudioStream
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static AudioStream parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
AudioStream
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AudioStream parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AudioStream
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AudioStream parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
AudioStream
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AudioStream parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AudioStream
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AudioStream parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
AudioStream
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AudioStream parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AudioStream
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static AudioStream parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
AudioStream
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AudioStream parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AudioStream
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static AudioStream parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
AudioStream
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AudioStream parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AudioStream
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<AudioStream> parser()
Returns
TypeDescription
Parser<AudioStream>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for codec.

getDefaultInstanceForType()

public AudioStream getDefaultInstanceForType()
Returns
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
indexint
Returns
TypeDescription
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
TypeDescription
List<? extends com.google.cloud.video.livestream.v1.AudioStream.AudioMappingOrBuilder>

getParserForType()

public Parser<AudioStream> getParserForType()
Returns
TypeDescription
Parser<AudioStream>
Overrides

getSampleRateHertz()

public int getSampleRateHertz()

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

int32 sample_rate_hertz = 6;

Returns
TypeDescription
int

The sampleRateHertz.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
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
TypeDescription
boolean

The transmux.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public AudioStream.Builder newBuilderForType()
Returns
TypeDescription
AudioStream.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AudioStream.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
AudioStream.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public AudioStream.Builder toBuilder()
Returns
TypeDescription
AudioStream.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException