Class Manifest (0.49.0)

public final class Manifest extends GeneratedMessageV3 implements ManifestOrBuilder

Manifest configuration.

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

Implements

ManifestOrBuilder

Static Fields

FILE_NAME_FIELD_NUMBER

public static final int FILE_NAME_FIELD_NUMBER
Field Value
Type Description
int

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER
Field Value
Type Description
int

MAX_SEGMENT_COUNT_FIELD_NUMBER

public static final int MAX_SEGMENT_COUNT_FIELD_NUMBER
Field Value
Type Description
int

MUX_STREAMS_FIELD_NUMBER

public static final int MUX_STREAMS_FIELD_NUMBER
Field Value
Type Description
int

SEGMENT_KEEP_DURATION_FIELD_NUMBER

public static final int SEGMENT_KEEP_DURATION_FIELD_NUMBER
Field Value
Type Description
int

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int

USE_TIMECODE_AS_TIMELINE_FIELD_NUMBER

public static final int USE_TIMECODE_AS_TIMELINE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Manifest getDefaultInstance()
Returns
Type Description
Manifest

getDescriptor()

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

newBuilder()

public static Manifest.Builder newBuilder()
Returns
Type Description
Manifest.Builder

newBuilder(Manifest prototype)

public static Manifest.Builder newBuilder(Manifest prototype)
Parameter
Name Description
prototype Manifest
Returns
Type Description
Manifest.Builder

parseDelimitedFrom(InputStream input)

public static Manifest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Manifest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Manifest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Manifest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Manifest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Manifest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Manifest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Manifest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Manifest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Manifest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Manifest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Manifest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Manifest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Manifest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Manifest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Manifest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Manifest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Manifest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Manifest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Manifest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Manifest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Manifest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Manifest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Manifest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Manifest> parser()
Returns
Type Description
Parser<Manifest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Manifest getDefaultInstanceForType()
Returns
Type Description
Manifest

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.

getParserForType()

public Parser<Manifest> getParserForType()
Returns
Type Description
Parser<Manifest>
Overrides

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Manifest.Builder newBuilderForType()
Returns
Type Description
Manifest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Manifest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Manifest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Manifest.Builder toBuilder()
Returns
Type Description
Manifest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException