Class Manifest.Builder (0.50.0) 

public static final class Manifest.Builder extends GeneratedMessageV3.Builder<Manifest.Builder> implements ManifestOrBuilder

Manifest configuration.

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Manifest.Builder

Implements

ManifestOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllMuxStreams(Iterable<String> values)

public Manifest.Builder addAllMuxStreams(Iterable<String> values)

Required. List of MuxStream keys 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];

Parameter
Name Description
values Iterable<String>

The muxStreams to add.
Returns
Type Description
Manifest.Builder

This builder for chaining.

addMuxStreams(String value)

public Manifest.Builder addMuxStreams(String value)

Required. List of MuxStream keys 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];

Parameter
Name Description
value String

The muxStreams to add.
Returns
Type Description
Manifest.Builder

This builder for chaining.

addMuxStreamsBytes(ByteString value)

public Manifest.Builder addMuxStreamsBytes(ByteString value)

Required. List of MuxStream keys 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];

Parameter
Name Description
value ByteString

The bytes of the muxStreams to add.
Returns
Type Description
Manifest.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Manifest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Manifest.Builder
Overrides

build()

public Manifest build()
Returns
Type Description
Manifest

buildPartial()

public Manifest buildPartial()
Returns
Type Description
Manifest

clear()

public Manifest.Builder clear()
Returns
Type Description
Manifest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Manifest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Manifest.Builder
Overrides

clearFileName()

public Manifest.Builder clearFileName()

The name of the generated file. The default is manifest with the extension suffix corresponding to the Manifest type. If multiple manifests are added to the channel, each must have a unique file name.

string file_name = 1;

Returns
Type Description
Manifest.Builder

This builder for chaining.

clearKey()

public Manifest.Builder clearKey()

Optional. A unique key for this manifest.

string key = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Manifest.Builder

This builder for chaining.

clearMaxSegmentCount()

public Manifest.Builder clearMaxSegmentCount()

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
Type Description
Manifest.Builder

This builder for chaining.

clearMuxStreams()

public Manifest.Builder clearMuxStreams()

Required. List of MuxStream keys 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
Type Description
Manifest.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Manifest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Manifest.Builder
Overrides

clearSegmentKeepDuration()

public Manifest.Builder clearSegmentKeepDuration()

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 are set, RetentionConfig.retention_window_duration is used and segment_keep_duration is ignored.

.google.protobuf.Duration segment_keep_duration = 5;

Returns
Type Description
Manifest.Builder

clearType()

public Manifest.Builder clearType()

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
Type Description
Manifest.Builder

This builder for chaining.

clearUseTimecodeAsTimeline()

public Manifest.Builder clearUseTimecodeAsTimeline()

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
Type Description
Manifest.Builder

This builder for chaining.

clone()

public Manifest.Builder clone()
Returns
Type Description
Manifest.Builder
Overrides

getDefaultInstanceForType()

public Manifest getDefaultInstanceForType()
Returns
Type Description
Manifest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getFileName()

public String getFileName()

The name of the generated file. The default is manifest with the extension suffix corresponding to the Manifest type. If multiple manifests are added to the channel, each must have a unique file name.

string file_name = 1;

Returns
Type Description
String

The fileName.

getFileNameBytes()

public ByteString getFileNameBytes()

The name of the generated file. The default is manifest with the extension suffix corresponding to the Manifest type. If multiple manifests are added to the channel, each must have a unique file name.

string file_name = 1;

Returns
Type Description
ByteString

The bytes for fileName.

getKey()

public String getKey()

Optional. A unique key for this manifest.

string key = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The key.

getKeyBytes()

public ByteString getKeyBytes()

Optional. A unique key for this manifest.

string key = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for key.

getMaxSegmentCount()

public 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
Type Description
int

The maxSegmentCount.

getMuxStreams(int index)

public String getMuxStreams(int index)

Required. List of MuxStream keys 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];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The muxStreams at the given index.

getMuxStreamsBytes(int index)

public ByteString getMuxStreamsBytes(int index)

Required. List of MuxStream keys 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];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the muxStreams at the given index.

getMuxStreamsCount()

public int getMuxStreamsCount()

Required. List of MuxStream keys 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
Type Description
int

The count of muxStreams.

getMuxStreamsList()

public ProtocolStringList getMuxStreamsList()

Required. List of MuxStream keys 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
Type Description
ProtocolStringList

A list containing the muxStreams.

getSegmentKeepDuration()

public 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 are set, RetentionConfig.retention_window_duration is used and segment_keep_duration is ignored.

.google.protobuf.Duration segment_keep_duration = 5;

Returns
Type Description
Duration

The segmentKeepDuration.

getSegmentKeepDurationBuilder()

public Duration.Builder getSegmentKeepDurationBuilder()

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 are set, RetentionConfig.retention_window_duration is used and segment_keep_duration is ignored.

.google.protobuf.Duration segment_keep_duration = 5;

Returns
Type Description
Builder

getSegmentKeepDurationOrBuilder()

public 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 are set, RetentionConfig.retention_window_duration is used and segment_keep_duration is ignored.

.google.protobuf.Duration segment_keep_duration = 5;

Returns
Type Description
DurationOrBuilder

getType()

public 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
Type Description
Manifest.ManifestType

The type.

getTypeValue()

public 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
Type Description
int

The enum numeric value on the wire for type.

getUseTimecodeAsTimeline()

public 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
Type Description
boolean

The useTimecodeAsTimeline.

hasSegmentKeepDuration()

public 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 are set, RetentionConfig.retention_window_duration is used and segment_keep_duration is ignored.

.google.protobuf.Duration segment_keep_duration = 5;

Returns
Type Description
boolean

Whether the segmentKeepDuration field is set.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Manifest other)

public Manifest.Builder mergeFrom(Manifest other)
Parameter
Name Description
other Manifest
Returns
Type Description
Manifest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Manifest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Manifest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Manifest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Manifest.Builder
Overrides

mergeSegmentKeepDuration(Duration value)

public Manifest.Builder mergeSegmentKeepDuration(Duration value)

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 are set, RetentionConfig.retention_window_duration is used and segment_keep_duration is ignored.

.google.protobuf.Duration segment_keep_duration = 5;

Parameter
Name Description
value Duration
Returns
Type Description
Manifest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Manifest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Manifest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Manifest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Manifest.Builder
Overrides

setFileName(String value)

public Manifest.Builder setFileName(String value)

The name of the generated file. The default is manifest with the extension suffix corresponding to the Manifest type. If multiple manifests are added to the channel, each must have a unique file name.

string file_name = 1;

Parameter
Name Description
value String

The fileName to set.
Returns
Type Description
Manifest.Builder

This builder for chaining.

setFileNameBytes(ByteString value)

public Manifest.Builder setFileNameBytes(ByteString value)

The name of the generated file. The default is manifest with the extension suffix corresponding to the Manifest type. If multiple manifests are added to the channel, each must have a unique file name.

string file_name = 1;

Parameter
Name Description
value ByteString

The bytes for fileName to set.
Returns
Type Description
Manifest.Builder

This builder for chaining.

setKey(String value)

public Manifest.Builder setKey(String value)

Optional. A unique key for this manifest.

string key = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The key to set.
Returns
Type Description
Manifest.Builder

This builder for chaining.

setKeyBytes(ByteString value)

public Manifest.Builder setKeyBytes(ByteString value)

Optional. A unique key for this manifest.

string key = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for key to set.
Returns
Type Description
Manifest.Builder

This builder for chaining.

setMaxSegmentCount(int value)

public Manifest.Builder setMaxSegmentCount(int value)

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;

Parameter
Name Description
value int

The maxSegmentCount to set.
Returns
Type Description
Manifest.Builder

This builder for chaining.

setMuxStreams(int index, String value)

public Manifest.Builder setMuxStreams(int index, String value)

Required. List of MuxStream keys 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
Name Description
index int

The index to set the value at.
value String

The muxStreams to set.
Returns
Type Description
Manifest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Manifest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Manifest.Builder
Overrides

setSegmentKeepDuration(Duration value)

public Manifest.Builder setSegmentKeepDuration(Duration value)

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 are set, RetentionConfig.retention_window_duration is used and segment_keep_duration is ignored.

.google.protobuf.Duration segment_keep_duration = 5;

Parameter
Name Description
value Duration
Returns
Type Description
Manifest.Builder

setSegmentKeepDuration(Duration.Builder builderForValue)

public Manifest.Builder setSegmentKeepDuration(Duration.Builder builderForValue)

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 are set, RetentionConfig.retention_window_duration is used and segment_keep_duration is ignored.

.google.protobuf.Duration segment_keep_duration = 5;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Manifest.Builder

setType(Manifest.ManifestType value)

public Manifest.Builder setType(Manifest.ManifestType value)

Required. Type of the manifest, can be HLS or DASH.

.google.cloud.video.livestream.v1.Manifest.ManifestType type = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value Manifest.ManifestType

The type to set.
Returns
Type Description
Manifest.Builder

This builder for chaining.

setTypeValue(int value)

public Manifest.Builder setTypeValue(int value)

Required. Type of the manifest, can be HLS or DASH.

.google.cloud.video.livestream.v1.Manifest.ManifestType type = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value int

The enum numeric value on the wire for type to set.
Returns
Type Description
Manifest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Manifest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Manifest.Builder
Overrides

setUseTimecodeAsTimeline(boolean value)

public Manifest.Builder setUseTimecodeAsTimeline(boolean value)

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;

Parameter
Name Description
value boolean

The useTimecodeAsTimeline to set.
Returns
Type Description
Manifest.Builder

This builder for chaining.