Interface ManifestOrBuilder (0.56.0)

public interface ManifestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFileName()

public abstract 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 abstract ByteString getFileNameBytes()

string file_name = 1;

Returns
Type	Description
`ByteString`	The bytes for fileName.

getKey()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract List<String> 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
`List<String>`	A list containing the muxStreams.

getSegmentKeepDuration()

public abstract 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.

getSegmentKeepDurationOrBuilder()

public abstract DurationOrBuilder getSegmentKeepDurationOrBuilder()

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 abstract 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 abstract 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 abstract 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 abstract boolean hasSegmentKeepDuration()

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.