Package com.google.cloud.video.livestream.v1

Interface ChannelOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Channel, Channel.Builder
@Generated public interface ChannelOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getName

      String getName()
       The resource name of the channel, in the form of:
 `projects/{project}/locations/{location}/channels/{channelId}`.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The resource name of the channel, in the form of:
 `projects/{project}/locations/{location}/channels/{channelId}`.
      string name = 1;
      Returns:
      The bytes for name.

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The creation time.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. The creation time.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The creation time.
      .google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The update time.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. The update time.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The update time.
      .google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • getLabelsCount

      int getLabelsCount()
       User-defined key/value metadata.
      map<string, string> labels = 4;

    • containsLabels

      boolean containsLabels(String key)
       User-defined key/value metadata.
      map<string, string> labels = 4;

    • getLabels

      @Deprecated Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.

    • getLabelsMap

      Map<String,String> getLabelsMap()
       User-defined key/value metadata.
      map<string, string> labels = 4;

    • getLabelsOrDefault

      String getLabelsOrDefault(String key, String defaultValue)
       User-defined key/value metadata.
      map<string, string> labels = 4;

    • getLabelsOrThrow

      String getLabelsOrThrow(String key)
       User-defined key/value metadata.
      map<string, string> labels = 4;

    • getInputAttachmentsList

      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;

    • getInputAttachments

      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;

    • getInputAttachmentsCount

      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;

    • getInputAttachmentsOrBuilderList

      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;

    • getInputAttachmentsOrBuilder

      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;

    • getActiveInput

      String getActiveInput()
       Output only. The
 [InputAttachment.key][google.cloud.video.livestream.v1.InputAttachment.key]
 that serves as the current input source. The first input in the
 [input_attachments][google.cloud.video.livestream.v1.Channel.input_attachments]
 is the initial input source.
      string active_input = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The activeInput.

    • getActiveInputBytes

      com.google.protobuf.ByteString getActiveInputBytes()
       Output only. The
 [InputAttachment.key][google.cloud.video.livestream.v1.InputAttachment.key]
 that serves as the current input source. The first input in the
 [input_attachments][google.cloud.video.livestream.v1.Channel.input_attachments]
 is the initial input source.
      string active_input = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The bytes for activeInput.

    • hasOutput

      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:
      Whether the output field is set.

    • getOutput

      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:
      The output.

    • getOutputOrBuilder

      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];

    • getElementaryStreamsList

      List<ElementaryStream> getElementaryStreamsList()
       List of elementary streams.
      repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;

    • getElementaryStreams

      ElementaryStream getElementaryStreams(int index)
       List of elementary streams.
      repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;

    • getElementaryStreamsCount

      int getElementaryStreamsCount()
       List of elementary streams.
      repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;

    • getElementaryStreamsOrBuilderList

      List<? extends ElementaryStreamOrBuilder> getElementaryStreamsOrBuilderList()
       List of elementary streams.
      repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;

    • getElementaryStreamsOrBuilder

      ElementaryStreamOrBuilder getElementaryStreamsOrBuilder(int index)
       List of elementary streams.
      repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;

    • getMuxStreamsList

      List<MuxStream> getMuxStreamsList()
       List of multiplexing settings for output streams.
      repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;

    • getMuxStreams

      MuxStream getMuxStreams(int index)
       List of multiplexing settings for output streams.
      repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;

    • getMuxStreamsCount

      int getMuxStreamsCount()
       List of multiplexing settings for output streams.
      repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;

    • getMuxStreamsOrBuilderList

      List<? extends MuxStreamOrBuilder> getMuxStreamsOrBuilderList()
       List of multiplexing settings for output streams.
      repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;

    • getMuxStreamsOrBuilder

      MuxStreamOrBuilder getMuxStreamsOrBuilder(int index)
       List of multiplexing settings for output streams.
      repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;

    • getManifestsList

      List<Manifest> getManifestsList()
       List of output manifests.
      repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;

    • getManifests

      Manifest getManifests(int index)
       List of output manifests.
      repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;

    • getManifestsCount

      int getManifestsCount()
       List of output manifests.
      repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;

    • getManifestsOrBuilderList

      List<? extends ManifestOrBuilder> getManifestsOrBuilderList()
       List of output manifests.
      repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;

    • getManifestsOrBuilder

      ManifestOrBuilder getManifestsOrBuilder(int index)
       List of output manifests.
      repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;

    • getDistributionStreamsList

      List<DistributionStream> getDistributionStreamsList()
       Optional. List of multiplexing settings of streams for distributions.
      repeated .google.cloud.video.livestream.v1.DistributionStream distribution_streams = 28 [(.google.api.field_behavior) = OPTIONAL];

    • getDistributionStreams

      DistributionStream getDistributionStreams(int index)
       Optional. List of multiplexing settings of streams for distributions.
      repeated .google.cloud.video.livestream.v1.DistributionStream distribution_streams = 28 [(.google.api.field_behavior) = OPTIONAL];

    • getDistributionStreamsCount

      int getDistributionStreamsCount()
       Optional. List of multiplexing settings of streams for distributions.
      repeated .google.cloud.video.livestream.v1.DistributionStream distribution_streams = 28 [(.google.api.field_behavior) = OPTIONAL];

    • getDistributionStreamsOrBuilderList

      List<? extends DistributionStreamOrBuilder> getDistributionStreamsOrBuilderList()
       Optional. List of multiplexing settings of streams for distributions.
      repeated .google.cloud.video.livestream.v1.DistributionStream distribution_streams = 28 [(.google.api.field_behavior) = OPTIONAL];

    • getDistributionStreamsOrBuilder

      DistributionStreamOrBuilder getDistributionStreamsOrBuilder(int index)
       Optional. List of multiplexing settings of streams for distributions.
      repeated .google.cloud.video.livestream.v1.DistributionStream distribution_streams = 28 [(.google.api.field_behavior) = OPTIONAL];

    • getDistributionsList

      List<Distribution> getDistributionsList()
       Optional. List of distributions.
      repeated .google.cloud.video.livestream.v1.Distribution distributions = 29 [(.google.api.field_behavior) = OPTIONAL];

    • getDistributions

      Distribution getDistributions(int index)
       Optional. List of distributions.
      repeated .google.cloud.video.livestream.v1.Distribution distributions = 29 [(.google.api.field_behavior) = OPTIONAL];

    • getDistributionsCount

      int getDistributionsCount()
       Optional. List of distributions.
      repeated .google.cloud.video.livestream.v1.Distribution distributions = 29 [(.google.api.field_behavior) = OPTIONAL];

    • getDistributionsOrBuilderList

      List<? extends DistributionOrBuilder> getDistributionsOrBuilderList()
       Optional. List of distributions.
      repeated .google.cloud.video.livestream.v1.Distribution distributions = 29 [(.google.api.field_behavior) = OPTIONAL];

    • getDistributionsOrBuilder

      DistributionOrBuilder getDistributionsOrBuilder(int index)
       Optional. List of distributions.
      repeated .google.cloud.video.livestream.v1.Distribution distributions = 29 [(.google.api.field_behavior) = OPTIONAL];

    • getSpriteSheetsList

      List<SpriteSheet> getSpriteSheetsList()
       List of output sprite sheets.
      repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;

    • getSpriteSheets

      SpriteSheet getSpriteSheets(int index)
       List of output sprite sheets.
      repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;

    • getSpriteSheetsCount

      int getSpriteSheetsCount()
       List of output sprite sheets.
      repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;

    • getSpriteSheetsOrBuilderList

      List<? extends SpriteSheetOrBuilder> getSpriteSheetsOrBuilderList()
       List of output sprite sheets.
      repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;

    • getSpriteSheetsOrBuilder

      SpriteSheetOrBuilder getSpriteSheetsOrBuilder(int index)
       List of output sprite sheets.
      repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;

    • getStreamingStateValue

      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:
      The enum numeric value on the wire for streamingState.

    • getStreamingState

      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:
      The streamingState.

    • hasStreamingError

      boolean hasStreamingError()
       Output only. A description of the reason for the streaming error. This
 property is always present when
 [streaming_state][google.cloud.video.livestream.v1.Channel.streaming_state]
 is
 [STREAMING_ERROR][google.cloud.video.livestream.v1.Channel.StreamingState.STREAMING_ERROR].
      .google.rpc.Status streaming_error = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      Whether the streamingError field is set.

    • getStreamingError

      Status getStreamingError()
       Output only. A description of the reason for the streaming error. This
 property is always present when
 [streaming_state][google.cloud.video.livestream.v1.Channel.streaming_state]
 is
 [STREAMING_ERROR][google.cloud.video.livestream.v1.Channel.StreamingState.STREAMING_ERROR].
      .google.rpc.Status streaming_error = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Returns:
      The streamingError.

    • getStreamingErrorOrBuilder

      StatusOrBuilder getStreamingErrorOrBuilder()
       Output only. A description of the reason for the streaming error. This
 property is always present when
 [streaming_state][google.cloud.video.livestream.v1.Channel.streaming_state]
 is
 [STREAMING_ERROR][google.cloud.video.livestream.v1.Channel.StreamingState.STREAMING_ERROR].
      .google.rpc.Status streaming_error = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];

    • hasLogConfig

      boolean hasLogConfig()
       Configuration of platform logs for this channel.
      .google.cloud.video.livestream.v1.LogConfig log_config = 19;
      Returns:
      Whether the logConfig field is set.

    • getLogConfig

      LogConfig getLogConfig()
       Configuration of platform logs for this channel.
      .google.cloud.video.livestream.v1.LogConfig log_config = 19;
      Returns:
      The logConfig.

    • getLogConfigOrBuilder

      LogConfigOrBuilder getLogConfigOrBuilder()
       Configuration of platform logs for this channel.
      .google.cloud.video.livestream.v1.LogConfig log_config = 19;

    • hasTimecodeConfig

      boolean hasTimecodeConfig()
       Configuration of timecode for this channel.
      .google.cloud.video.livestream.v1.TimecodeConfig timecode_config = 21;
      Returns:
      Whether the timecodeConfig field is set.

    • getTimecodeConfig

      TimecodeConfig getTimecodeConfig()
       Configuration of timecode for this channel.
      .google.cloud.video.livestream.v1.TimecodeConfig timecode_config = 21;
      Returns:
      The timecodeConfig.

    • getTimecodeConfigOrBuilder

      TimecodeConfigOrBuilder getTimecodeConfigOrBuilder()
       Configuration of timecode for this channel.
      .google.cloud.video.livestream.v1.TimecodeConfig timecode_config = 21;

    • getEncryptionsList

      List<Encryption> getEncryptionsList()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    • getEncryptions

      Encryption getEncryptions(int index)
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    • getEncryptionsCount

      int getEncryptionsCount()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    • getEncryptionsOrBuilderList

      List<? extends EncryptionOrBuilder> getEncryptionsOrBuilderList()
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    • getEncryptionsOrBuilder

      EncryptionOrBuilder getEncryptionsOrBuilder(int index)
       Optional. 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 [(.google.api.field_behavior) = OPTIONAL];

    • hasInputConfig

      boolean hasInputConfig()
       The configuration for input sources defined in
 [input_attachments][google.cloud.video.livestream.v1.Channel.input_attachments].
      .google.cloud.video.livestream.v1.InputConfig input_config = 25;
      Returns:
      Whether the inputConfig field is set.

    • getInputConfig

      InputConfig getInputConfig()
       The configuration for input sources defined in
 [input_attachments][google.cloud.video.livestream.v1.Channel.input_attachments].
      .google.cloud.video.livestream.v1.InputConfig input_config = 25;
      Returns:
      The inputConfig.

    • getInputConfigOrBuilder

      InputConfigOrBuilder getInputConfigOrBuilder()
       The configuration for input sources defined in
 [input_attachments][google.cloud.video.livestream.v1.Channel.input_attachments].
      .google.cloud.video.livestream.v1.InputConfig input_config = 25;

    • hasRetentionConfig

      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:
      Whether the retentionConfig field is set.

    • getRetentionConfig

      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:
      The retentionConfig.

    • getRetentionConfigOrBuilder

      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];

    • getStaticOverlaysList

      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];

    • getStaticOverlays

      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];

    • getStaticOverlaysCount

      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];

    • getStaticOverlaysOrBuilderList

      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];

    • getStaticOverlaysOrBuilder

      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];

    • hasAutoTranscriptionConfig

      boolean hasAutoTranscriptionConfig()
       Optional. Advanced configurations for auto-generated text streams.
      .google.cloud.video.livestream.v1.AutoTranscriptionConfig auto_transcription_config = 30 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      Whether the autoTranscriptionConfig field is set.

    • getAutoTranscriptionConfig

      AutoTranscriptionConfig getAutoTranscriptionConfig()
       Optional. Advanced configurations for auto-generated text streams.
      .google.cloud.video.livestream.v1.AutoTranscriptionConfig auto_transcription_config = 30 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The autoTranscriptionConfig.

    • getAutoTranscriptionConfigOrBuilder

      AutoTranscriptionConfigOrBuilder getAutoTranscriptionConfigOrBuilder()
       Optional. Advanced configurations for auto-generated text streams.
      .google.cloud.video.livestream.v1.AutoTranscriptionConfig auto_transcription_config = 30 [(.google.api.field_behavior) = OPTIONAL];