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

Interface ManifestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFileName()
    The name of the generated file.
    com.google.protobuf.ByteString
    getFileNameBytes()
    The name of the generated file.
    String
    getKey()
    Optional.
    com.google.protobuf.ByteString
    getKeyBytes()
    Optional.
    int
    getMaxSegmentCount()
    Maximum number of segments that this manifest holds.
    String
    getMuxStreams(int index)
    Required.
    com.google.protobuf.ByteString
    getMuxStreamsBytes(int index)
    Required.
    int
    getMuxStreamsCount()
    Required.
    List<String>
    getMuxStreamsList()
    Required.
    com.google.protobuf.Duration
    getSegmentKeepDuration()
    How long to keep a segment on the output Google Cloud Storage bucket after it is removed from the manifest.
    com.google.protobuf.DurationOrBuilder
    getSegmentKeepDurationOrBuilder()
    How long to keep a segment on the output Google Cloud Storage bucket after it is removed from the manifest.
    Manifest.ManifestType
    getType()
    Required.
    int
    getTypeValue()
    Required.
    boolean
    getUseTimecodeAsTimeline()
    Whether to use the timecode, as specified in timecode config, when setting: - `availabilityStartTime` attribute in DASH manifests
    boolean
    hasSegmentKeepDuration()
    How long to keep a segment on the output Google Cloud Storage bucket after it is removed from the manifest.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getFileName

      String getFileName()
       The name of the generated file. The default is `manifest` with the
 extension suffix corresponding to the `Manifest`
 [type][google.cloud.video.livestream.v1.Manifest.type]. If multiple
 manifests are added to the channel, each must have a unique file name.
      string file_name = 1;
      Returns:
      The fileName.

    • getFileNameBytes

      com.google.protobuf.ByteString getFileNameBytes()
       The name of the generated file. The default is `manifest` with the
 extension suffix corresponding to the `Manifest`
 [type][google.cloud.video.livestream.v1.Manifest.type]. If multiple
 manifests are added to the channel, each must have a unique file name.
      string file_name = 1;
      Returns:
      The bytes for fileName.

    • getTypeValue

      int getTypeValue()
       Required. Type of the manifest, can be `HLS` or `DASH`.
      .google.cloud.video.livestream.v1.Manifest.ManifestType type = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The enum numeric value on the wire for type.

    • getType

      Manifest.ManifestType getType()
       Required. Type of the manifest, can be `HLS` or `DASH`.
      .google.cloud.video.livestream.v1.Manifest.ManifestType type = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The type.

    • getMuxStreamsList

      List<String> getMuxStreamsList()
       Required. List of `MuxStream`
 [key][google.cloud.video.livestream.v1.MuxStream.key]s that should appear
 in this manifest.

 - For HLS, either `fmp4` or `ts` mux streams can be specified but not
 mixed.
 - For DASH, only `fmp4` mux streams can be specified.
      repeated string mux_streams = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      A list containing the muxStreams.

    • getMuxStreamsCount

      int getMuxStreamsCount()
       Required. List of `MuxStream`
 [key][google.cloud.video.livestream.v1.MuxStream.key]s that should appear
 in this manifest.

 - For HLS, either `fmp4` or `ts` mux streams can be specified but not
 mixed.
 - For DASH, only `fmp4` mux streams can be specified.
      repeated string mux_streams = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      The count of muxStreams.

    • getMuxStreams

      String getMuxStreams(int index)
       Required. List of `MuxStream`
 [key][google.cloud.video.livestream.v1.MuxStream.key]s that should appear
 in this manifest.

 - For HLS, either `fmp4` or `ts` mux streams can be specified but not
 mixed.
 - For DASH, only `fmp4` mux streams can be specified.
      repeated string mux_streams = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      index - The index of the element to return.
      Returns:
      The muxStreams at the given index.

    • getMuxStreamsBytes

      com.google.protobuf.ByteString getMuxStreamsBytes(int index)
       Required. List of `MuxStream`
 [key][google.cloud.video.livestream.v1.MuxStream.key]s that should appear
 in this manifest.

 - For HLS, either `fmp4` or `ts` mux streams can be specified but not
 mixed.
 - For DASH, only `fmp4` mux streams can be specified.
      repeated string mux_streams = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the muxStreams at the given index.

    • getMaxSegmentCount

      int getMaxSegmentCount()
       Maximum number of segments that this manifest holds. Once the manifest
 reaches this maximum number of segments, whenever a new segment is added to
 the manifest, the oldest segment will be removed from the manifest.
 The minimum value is 3 and the default value is 5.
      int32 max_segment_count = 4;
      Returns:
      The maxSegmentCount.

    • hasSegmentKeepDuration

      boolean hasSegmentKeepDuration()
       How long to keep a segment on the output Google Cloud Storage bucket after
 it is removed from the manifest. This field should be large enough to cover
 the manifest propagation delay. Otherwise, a player could receive 404
 errors while accessing segments which are listed in the manifest that the
 player has, but were already deleted from the output Google Cloud Storage
 bucket. Default value is `60s`.

 If both segment_keep_duration and
 [RetentionConfig.retention_window_duration][google.cloud.video.livestream.v1.RetentionConfig.retention_window_duration]
 are set,
 [RetentionConfig.retention_window_duration][google.cloud.video.livestream.v1.RetentionConfig.retention_window_duration]
 is used and segment_keep_duration is ignored.
      .google.protobuf.Duration segment_keep_duration = 5;
      Returns:
      Whether the segmentKeepDuration field is set.

    • getSegmentKeepDuration

      com.google.protobuf.Duration getSegmentKeepDuration()
       How long to keep a segment on the output Google Cloud Storage bucket after
 it is removed from the manifest. This field should be large enough to cover
 the manifest propagation delay. Otherwise, a player could receive 404
 errors while accessing segments which are listed in the manifest that the
 player has, but were already deleted from the output Google Cloud Storage
 bucket. Default value is `60s`.

 If both segment_keep_duration and
 [RetentionConfig.retention_window_duration][google.cloud.video.livestream.v1.RetentionConfig.retention_window_duration]
 are set,
 [RetentionConfig.retention_window_duration][google.cloud.video.livestream.v1.RetentionConfig.retention_window_duration]
 is used and segment_keep_duration is ignored.
      .google.protobuf.Duration segment_keep_duration = 5;
      Returns:
      The segmentKeepDuration.

    • getSegmentKeepDurationOrBuilder

      com.google.protobuf.DurationOrBuilder getSegmentKeepDurationOrBuilder()
       How long to keep a segment on the output Google Cloud Storage bucket after
 it is removed from the manifest. This field should be large enough to cover
 the manifest propagation delay. Otherwise, a player could receive 404
 errors while accessing segments which are listed in the manifest that the
 player has, but were already deleted from the output Google Cloud Storage
 bucket. Default value is `60s`.

 If both segment_keep_duration and
 [RetentionConfig.retention_window_duration][google.cloud.video.livestream.v1.RetentionConfig.retention_window_duration]
 are set,
 [RetentionConfig.retention_window_duration][google.cloud.video.livestream.v1.RetentionConfig.retention_window_duration]
 is used and segment_keep_duration is ignored.
      .google.protobuf.Duration segment_keep_duration = 5;

    • getUseTimecodeAsTimeline

      boolean getUseTimecodeAsTimeline()
       Whether to use the timecode, as specified in timecode config, when setting:

 - `availabilityStartTime` attribute in DASH manifests.
 - `#EXT-X-PROGRAM-DATE-TIME` tag in HLS manifests.

 If false, ignore the input timecode and use the time from system clock
 when the manifest is first generated. This is the default behavior.
      bool use_timecode_as_timeline = 6;
      Returns:
      The useTimecodeAsTimeline.

    • getKey

      String getKey()
       Optional. A unique key for this manifest.
      string key = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The key.

    • getKeyBytes

      com.google.protobuf.ByteString getKeyBytes()
       Optional. A unique key for this manifest.
      string key = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The bytes for key.