Live Stream v1 API - Class Manifest (1.8.0)

public sealed class Manifest : IMessage<Manifest>, IEquatable<Manifest>, IDeepCloneable<Manifest>, IBufferMessage, IMessage

Reference documentation and code samples for the Live Stream v1 API class Manifest.

Manifest configuration.

Inheritance

object > Manifest

Namespace

Google.Cloud.Video.LiveStream.V1

Assembly

Google.Cloud.Video.LiveStream.V1.dll

Constructors

Manifest()

public Manifest()

Manifest(Manifest)

public Manifest(Manifest other)
Parameter
Name Description
other Manifest

Properties

FileName

public string FileName { get; set; }

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.

Property Value
Type Description
string

Key

public string Key { get; set; }

Optional. A unique key for this manifest.

Property Value
Type Description
string

MaxSegmentCount

public int MaxSegmentCount { get; set; }

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.

Property Value
Type Description
int

MuxStreams

public RepeatedField<string> MuxStreams { get; }

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.
Property Value
Type Description
RepeatedFieldstring

SegmentKeepDuration

public Duration SegmentKeepDuration { get; set; }

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.

Property Value
Type Description
Duration

Type

public Manifest.Types.ManifestType Type { get; set; }

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

Property Value
Type Description
ManifestTypesManifestType

UseTimecodeAsTimeline

public bool UseTimecodeAsTimeline { get; set; }

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.

Property Value
Type Description
bool