Interface ChannelOrBuilder (0.56.0)

Version 0.56.0

• 0.57.0 (latest)
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.8
• 0.3.0

public interface ChannelOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsLabels(String key)

public abstract boolean containsLabels(String key)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameter
Name	Description
key	String

Returns
Type	Description
boolean

getActiveInput()

public abstract String getActiveInput()

Output only. The InputAttachment.key that serves as the current input source. The first input in the input_attachments is the initial input source.

string active_input = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
String	The activeInput.

getActiveInputBytes()

public abstract ByteString getActiveInputBytes()

Output only. The InputAttachment.key that serves as the current input source. The first input in the input_attachments is the initial input source.

string active_input = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
ByteString	The bytes for activeInput.

getCreateTime()

public abstract Timestamp getCreateTime()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The createTime.

getCreateTimeOrBuilder()

public abstract TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

getElementaryStreams(int index)

public abstract ElementaryStream getElementaryStreams(int index)

List of elementary streams.

repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
ElementaryStream

getElementaryStreamsCount()

public abstract int getElementaryStreamsCount()

List of elementary streams.

repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;

Returns
Type	Description
int

getElementaryStreamsList()

public abstract List<ElementaryStream> getElementaryStreamsList()

List of elementary streams.

repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;

Returns
Type	Description
List<ElementaryStream>

getElementaryStreamsOrBuilder(int index)

public abstract ElementaryStreamOrBuilder getElementaryStreamsOrBuilder(int index)

List of elementary streams.

repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;

Parameter
Name	Description
index	int

Returns
Type	Description
ElementaryStreamOrBuilder

getElementaryStreamsOrBuilderList()

public abstract List<? extends ElementaryStreamOrBuilder> getElementaryStreamsOrBuilderList()

List of elementary streams.

repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;

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

getEncryptions(int index)

public abstract Encryption getEncryptions(int index)

Encryption configurations for this channel. Each configuration has an ID which is referred to by each MuxStream to indicate which configuration is used for that output.

repeated .google.cloud.video.livestream.v1.Encryption encryptions = 24;

Parameter
Name	Description
index	int

Returns
Type	Description
Encryption

getEncryptionsCount()

public abstract int getEncryptionsCount()

Encryption configurations for this channel. Each configuration has an ID which is referred to by each MuxStream to indicate which configuration is used for that output.

repeated .google.cloud.video.livestream.v1.Encryption encryptions = 24;

Returns
Type	Description
int

getEncryptionsList()

public abstract List<Encryption> getEncryptionsList()

Encryption configurations for this channel. Each configuration has an ID which is referred to by each MuxStream to indicate which configuration is used for that output.

repeated .google.cloud.video.livestream.v1.Encryption encryptions = 24;

Returns
Type	Description
List<Encryption>

getEncryptionsOrBuilder(int index)

public abstract EncryptionOrBuilder getEncryptionsOrBuilder(int index)

Encryption configurations for this channel. Each configuration has an ID which is referred to by each MuxStream to indicate which configuration is used for that output.

repeated .google.cloud.video.livestream.v1.Encryption encryptions = 24;

Parameter
Name	Description
index	int

Returns
Type	Description
EncryptionOrBuilder

getEncryptionsOrBuilderList()

public abstract List<? extends EncryptionOrBuilder> getEncryptionsOrBuilderList()

Encryption configurations for this channel. Each configuration has an ID which is referred to by each MuxStream to indicate which configuration is used for that output.

repeated .google.cloud.video.livestream.v1.Encryption encryptions = 24;

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

getInputAttachments(int index)

public abstract InputAttachment getInputAttachments(int index)

A list of input attachments that this channel uses. One channel can have multiple inputs as the input sources. Only one input can be selected as the input source at one time.

repeated .google.cloud.video.livestream.v1.InputAttachment input_attachments = 16;

Parameter
Name	Description
index	int

Returns
Type	Description
InputAttachment

getInputAttachmentsCount()

public abstract int getInputAttachmentsCount()

A list of input attachments that this channel uses. One channel can have multiple inputs as the input sources. Only one input can be selected as the input source at one time.

repeated .google.cloud.video.livestream.v1.InputAttachment input_attachments = 16;

Returns
Type	Description
int

getInputAttachmentsList()

public abstract List<InputAttachment> getInputAttachmentsList()

A list of input attachments that this channel uses. One channel can have multiple inputs as the input sources. Only one input can be selected as the input source at one time.

repeated .google.cloud.video.livestream.v1.InputAttachment input_attachments = 16;

Returns
Type	Description
List<InputAttachment>

getInputAttachmentsOrBuilder(int index)

public abstract InputAttachmentOrBuilder getInputAttachmentsOrBuilder(int index)

A list of input attachments that this channel uses. One channel can have multiple inputs as the input sources. Only one input can be selected as the input source at one time.

repeated .google.cloud.video.livestream.v1.InputAttachment input_attachments = 16;

Parameter
Name	Description
index	int

Returns
Type	Description
InputAttachmentOrBuilder

getInputAttachmentsOrBuilderList()

public abstract List<? extends InputAttachmentOrBuilder> getInputAttachmentsOrBuilderList()

A list of input attachments that this channel uses. One channel can have multiple inputs as the input sources. Only one input can be selected as the input source at one time.

repeated .google.cloud.video.livestream.v1.InputAttachment input_attachments = 16;

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

getInputConfig()

public abstract InputConfig getInputConfig()

The configuration for input sources defined in input_attachments.

.google.cloud.video.livestream.v1.InputConfig input_config = 25;

Returns
Type	Description
InputConfig	The inputConfig.

getInputConfigOrBuilder()

public abstract InputConfigOrBuilder getInputConfigOrBuilder()

The configuration for input sources defined in input_attachments.

.google.cloud.video.livestream.v1.InputConfig input_config = 25;

Returns
Type	Description
InputConfigOrBuilder

getLabels() (deprecated)

public abstract Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
Type	Description
Map<String,String>

getLabelsCount()

public abstract int getLabelsCount()

User-defined key/value metadata.

map<string, string> labels = 4;

Returns
Type	Description
int

getLabelsMap()

public abstract Map<String,String> getLabelsMap()

User-defined key/value metadata.

map<string, string> labels = 4;

Returns
Type	Description
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public abstract String getLabelsOrDefault(String key, String defaultValue)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameters
Name	Description
key	String
defaultValue	String

Returns
Type	Description
String

getLabelsOrThrow(String key)

public abstract String getLabelsOrThrow(String key)

User-defined key/value metadata.

map<string, string> labels = 4;

Parameter
Name	Description
key	String

Returns
Type	Description
String

getLogConfig()

public abstract LogConfig getLogConfig()

Configuration of platform logs for this channel.

.google.cloud.video.livestream.v1.LogConfig log_config = 19;

Returns
Type	Description
LogConfig	The logConfig.

getLogConfigOrBuilder()

public abstract LogConfigOrBuilder getLogConfigOrBuilder()

Configuration of platform logs for this channel.

.google.cloud.video.livestream.v1.LogConfig log_config = 19;

Returns
Type	Description
LogConfigOrBuilder

getManifests(int index)

public abstract Manifest getManifests(int index)

List of output manifests.

repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
Manifest

getManifestsCount()

public abstract int getManifestsCount()

List of output manifests.

repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;

Returns
Type	Description
int

getManifestsList()

public abstract List<Manifest> getManifestsList()

List of output manifests.

repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;

Returns
Type	Description
List<Manifest>

getManifestsOrBuilder(int index)

public abstract ManifestOrBuilder getManifestsOrBuilder(int index)

List of output manifests.

repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;

Parameter
Name	Description
index	int

Returns
Type	Description
ManifestOrBuilder

getManifestsOrBuilderList()

public abstract List<? extends ManifestOrBuilder> getManifestsOrBuilderList()

List of output manifests.

repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;

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

getMuxStreams(int index)

public abstract MuxStream getMuxStreams(int index)

List of multiplexing settings for output streams.

repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;

Parameter
Name	Description
index	int

Returns
Type	Description
MuxStream

getMuxStreamsCount()

public abstract int getMuxStreamsCount()

List of multiplexing settings for output streams.

repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;

Returns
Type	Description
int

getMuxStreamsList()

public abstract List<MuxStream> getMuxStreamsList()

List of multiplexing settings for output streams.

repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;

Returns
Type	Description
List<MuxStream>

getMuxStreamsOrBuilder(int index)

public abstract MuxStreamOrBuilder getMuxStreamsOrBuilder(int index)

List of multiplexing settings for output streams.

repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;

Parameter
Name	Description
index	int

Returns
Type	Description
MuxStreamOrBuilder

getMuxStreamsOrBuilderList()

public abstract List<? extends MuxStreamOrBuilder> getMuxStreamsOrBuilderList()

List of multiplexing settings for output streams.

repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;

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

getName()

public abstract String getName()

The resource name of the channel, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

string name = 1;

Returns
Type	Description
String	The name.

getNameBytes()

public abstract ByteString getNameBytes()

The resource name of the channel, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

string name = 1;

Returns
Type	Description
ByteString	The bytes for name.

getOutput()

public abstract Channel.Output getOutput()

Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).

.google.cloud.video.livestream.v1.Channel.Output output = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Channel.Output	The output.

getOutputOrBuilder()

public abstract Channel.OutputOrBuilder getOutputOrBuilder()

Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).

.google.cloud.video.livestream.v1.Channel.Output output = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
Channel.OutputOrBuilder

getRetentionConfig()

public abstract RetentionConfig getRetentionConfig()

Optional. Configuration for retention of output files for this channel.

.google.cloud.video.livestream.v1.RetentionConfig retention_config = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RetentionConfig	The retentionConfig.

getRetentionConfigOrBuilder()

public abstract RetentionConfigOrBuilder getRetentionConfigOrBuilder()

Optional. Configuration for retention of output files for this channel.

.google.cloud.video.livestream.v1.RetentionConfig retention_config = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
RetentionConfigOrBuilder

getSpriteSheets(int index)

public abstract SpriteSheet getSpriteSheets(int index)

List of output sprite sheets.

repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;

Parameter
Name	Description
index	int

Returns
Type	Description
SpriteSheet

getSpriteSheetsCount()

public abstract int getSpriteSheetsCount()

List of output sprite sheets.

repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;

Returns
Type	Description
int

getSpriteSheetsList()

public abstract List<SpriteSheet> getSpriteSheetsList()

List of output sprite sheets.

repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;

Returns
Type	Description
List<SpriteSheet>

getSpriteSheetsOrBuilder(int index)

public abstract SpriteSheetOrBuilder getSpriteSheetsOrBuilder(int index)

List of output sprite sheets.

repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;

Parameter
Name	Description
index	int

Returns
Type	Description
SpriteSheetOrBuilder

getSpriteSheetsOrBuilderList()

public abstract List<? extends SpriteSheetOrBuilder> getSpriteSheetsOrBuilderList()

List of output sprite sheets.

repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;

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

getStaticOverlays(int index)

public abstract StaticOverlay getStaticOverlays(int index)

Optional. List of static overlay images. Those images display over the output content for the whole duration of the live stream.

repeated .google.cloud.video.livestream.v1.StaticOverlay static_overlays = 27 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
StaticOverlay

getStaticOverlaysCount()

public abstract int getStaticOverlaysCount()

Optional. List of static overlay images. Those images display over the output content for the whole duration of the live stream.

repeated .google.cloud.video.livestream.v1.StaticOverlay static_overlays = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int

getStaticOverlaysList()

public abstract List<StaticOverlay> getStaticOverlaysList()

Optional. List of static overlay images. Those images display over the output content for the whole duration of the live stream.

repeated .google.cloud.video.livestream.v1.StaticOverlay static_overlays = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
List<StaticOverlay>

getStaticOverlaysOrBuilder(int index)

public abstract StaticOverlayOrBuilder getStaticOverlaysOrBuilder(int index)

Optional. List of static overlay images. Those images display over the output content for the whole duration of the live stream.

repeated .google.cloud.video.livestream.v1.StaticOverlay static_overlays = 27 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int

Returns
Type	Description
StaticOverlayOrBuilder

getStaticOverlaysOrBuilderList()

public abstract List<? extends StaticOverlayOrBuilder> getStaticOverlaysOrBuilderList()

Optional. List of static overlay images. Those images display over the output content for the whole duration of the live stream.

repeated .google.cloud.video.livestream.v1.StaticOverlay static_overlays = 27 [(.google.api.field_behavior) = OPTIONAL];

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

getStreamingError()

public abstract Status getStreamingError()

Output only. A description of the reason for the streaming error. This property is always present when streaming_state is STREAMING_ERROR.

.google.rpc.Status streaming_error = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
com.google.rpc.Status	The streamingError.

getStreamingErrorOrBuilder()

public abstract StatusOrBuilder getStreamingErrorOrBuilder()

Output only. A description of the reason for the streaming error. This property is always present when streaming_state is STREAMING_ERROR.

.google.rpc.Status streaming_error = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
com.google.rpc.StatusOrBuilder

getStreamingState()

public abstract Channel.StreamingState getStreamingState()

Output only. State of the streaming operation.

.google.cloud.video.livestream.v1.Channel.StreamingState streaming_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Channel.StreamingState	The streamingState.

getStreamingStateValue()

public abstract int getStreamingStateValue()

Output only. State of the streaming operation.

.google.cloud.video.livestream.v1.Channel.StreamingState streaming_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
int	The enum numeric value on the wire for streamingState.

getTimecodeConfig()

public abstract TimecodeConfig getTimecodeConfig()

Configuration of timecode for this channel.

.google.cloud.video.livestream.v1.TimecodeConfig timecode_config = 21;

Returns
Type	Description
TimecodeConfig	The timecodeConfig.

getTimecodeConfigOrBuilder()

public abstract TimecodeConfigOrBuilder getTimecodeConfigOrBuilder()

Configuration of timecode for this channel.

.google.cloud.video.livestream.v1.TimecodeConfig timecode_config = 21;

Returns
Type	Description
TimecodeConfigOrBuilder

getUpdateTime()

public abstract Timestamp getUpdateTime()

Output only. The update time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeOrBuilder()

public abstract TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The update time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
TimestampOrBuilder

hasCreateTime()

public abstract boolean hasCreateTime()

Output only. The creation time.

.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the createTime field is set.

hasInputConfig()

public abstract boolean hasInputConfig()

The configuration for input sources defined in input_attachments.

.google.cloud.video.livestream.v1.InputConfig input_config = 25;

Returns
Type	Description
boolean	Whether the inputConfig field is set.

hasLogConfig()

public abstract boolean hasLogConfig()

Configuration of platform logs for this channel.

.google.cloud.video.livestream.v1.LogConfig log_config = 19;

Returns
Type	Description
boolean	Whether the logConfig field is set.

hasOutput()

public abstract boolean hasOutput()

Required. Information about the output (that is, the Cloud Storage bucket to store the generated live stream).

.google.cloud.video.livestream.v1.Channel.Output output = 9 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
boolean	Whether the output field is set.

hasRetentionConfig()

public abstract boolean hasRetentionConfig()

Optional. Configuration for retention of output files for this channel.

.google.cloud.video.livestream.v1.RetentionConfig retention_config = 26 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
boolean	Whether the retentionConfig field is set.

hasStreamingError()

public abstract boolean hasStreamingError()

Output only. A description of the reason for the streaming error. This property is always present when streaming_state is STREAMING_ERROR.

.google.rpc.Status streaming_error = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the streamingError field is set.

hasTimecodeConfig()

public abstract boolean hasTimecodeConfig()

Configuration of timecode for this channel.

.google.cloud.video.livestream.v1.TimecodeConfig timecode_config = 21;

Returns
Type	Description
boolean	Whether the timecodeConfig field is set.

hasUpdateTime()

public abstract boolean hasUpdateTime()

Output only. The update time.

.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type	Description
boolean	Whether the updateTime field is set.