Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class Manifest.
Manifest configuration.
Generated from protobuf message google.cloud.video.livestream.v1.Manifest
Namespace
Google \ Cloud \ Video \ LiveStream \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ file_name
string
The name of the generated file. The default is manifest with the extension suffix corresponding to the Manifesttype. If multiple manifests are added to the channel, each must have a unique file name.
↳ type
int
Required. Type of the manifest, can be HLS or DASH.
↳ mux_streams
array
Required. List of MuxStreamkeys 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.
↳ max_segment_count
int
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.
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.
↳ use_timecode_as_timeline
bool
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.
↳ key
string
Optional. A unique key for this manifest.
getFileName
The name of the generated file. The default is manifest with the
extension suffix corresponding to the Manifesttype. If multiple
manifests are added to the channel, each must have a unique file name.
Returns
Type
Description
string
setFileName
The name of the generated file. The default is manifest with the
extension suffix corresponding to the Manifesttype. If multiple
manifests are added to the channel, each must have a unique file name.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getType
Required. Type of the manifest, can be HLS or DASH.
Returns
Type
Description
int
setType
Required. Type of the manifest, can be HLS or DASH.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
getMuxStreams
Required. List of MuxStreamkeys that should appear
in this manifest.
For HLS, either fmp4 or ts mux streams can be specified but not
mixed.
Required. List of MuxStreamkeys 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.
Parameter
Name
Description
var
string[]
Returns
Type
Description
$this
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.
Returns
Type
Description
int
setMaxSegmentCount
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.
Parameter
Name
Description
var
int
Returns
Type
Description
$this
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.
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.
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.
Returns
Type
Description
bool
setUseTimecodeAsTimeline
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[],[],null,["# Google Cloud Video Live Stream V1 Client - Class Manifest (1.2.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.2.1 (latest)](/php/docs/reference/cloud-video-live-stream/latest/V1.Manifest)\n- [1.2.0](/php/docs/reference/cloud-video-live-stream/1.2.0/V1.Manifest)\n- [1.1.3](/php/docs/reference/cloud-video-live-stream/1.1.3/V1.Manifest)\n- [1.0.0](/php/docs/reference/cloud-video-live-stream/1.0.0/V1.Manifest)\n- [0.7.5](/php/docs/reference/cloud-video-live-stream/0.7.5/V1.Manifest)\n- [0.6.2](/php/docs/reference/cloud-video-live-stream/0.6.2/V1.Manifest)\n- [0.5.0](/php/docs/reference/cloud-video-live-stream/0.5.0/V1.Manifest)\n- [0.4.2](/php/docs/reference/cloud-video-live-stream/0.4.2/V1.Manifest)\n- [0.3.2](/php/docs/reference/cloud-video-live-stream/0.3.2/V1.Manifest)\n- [0.2.6](/php/docs/reference/cloud-video-live-stream/0.2.6/V1.Manifest) \nReference documentation and code samples for the Google Cloud Video Live Stream V1 Client class Manifest.\n\nManifest configuration.\n\nGenerated from protobuf message `google.cloud.video.livestream.v1.Manifest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Video \\\\ LiveStream \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getFileName\n\nThe name of the generated file. The default is `manifest` with the\nextension suffix corresponding to the `Manifest`\n[type](/php/docs/reference/cloud-video-live-stream/latest/V1.Manifest#_Google_Cloud_Video_LiveStream_V1_Manifest__getType__). If multiple\nmanifests are added to the channel, each must have a unique file name.\n\n### setFileName\n\nThe name of the generated file. The default is `manifest` with the\nextension suffix corresponding to the `Manifest`\n[type](/php/docs/reference/cloud-video-live-stream/latest/V1.Manifest#_Google_Cloud_Video_LiveStream_V1_Manifest__getType__). If multiple\nmanifests are added to the channel, each must have a unique file name.\n\n### getType\n\nRequired. Type of the manifest, can be `HLS` or `DASH`.\n\n### setType\n\nRequired. Type of the manifest, can be `HLS` or `DASH`.\n\n### getMuxStreams\n\nRequired. List of `MuxStream`\n[key](/php/docs/reference/cloud-video-live-stream/latest/V1.MuxStream#_Google_Cloud_Video_LiveStream_V1_MuxStream__getKey__)s that should appear\nin this manifest.\n\n- For HLS, either `fmp4` or `ts` mux streams can be specified but not mixed.\n- For DASH, only `fmp4` mux streams can be specified.\n\n### setMuxStreams\n\nRequired. List of `MuxStream`\n[key](/php/docs/reference/cloud-video-live-stream/latest/V1.MuxStream#_Google_Cloud_Video_LiveStream_V1_MuxStream__getKey__)s that should appear\nin this manifest.\n\n- For HLS, either `fmp4` or `ts` mux streams can be specified but not mixed.\n- For DASH, only `fmp4` mux streams can be specified.\n\n### getMaxSegmentCount\n\nMaximum number of segments that this manifest holds. Once the manifest\nreaches this maximum number of segments, whenever a new segment is added to\nthe manifest, the oldest segment will be removed from the manifest.\n\nThe minimum value is 3 and the default value is 5.\n\n### setMaxSegmentCount\n\nMaximum number of segments that this manifest holds. Once the manifest\nreaches this maximum number of segments, whenever a new segment is added to\nthe manifest, the oldest segment will be removed from the manifest.\n\nThe minimum value is 3 and the default value is 5.\n\n### getSegmentKeepDuration\n\nHow long to keep a segment on the output Google Cloud Storage bucket after\nit is removed from the manifest. This field should be large enough to cover\nthe manifest propagation delay. Otherwise, a player could receive 404\nerrors while accessing segments which are listed in the manifest that the\nplayer has, but were already deleted from the output Google Cloud Storage\nbucket. Default value is `60s`.\n\nIf both segment_keep_duration and\n[RetentionConfig.retention_window_duration](/php/docs/reference/cloud-video-live-stream/latest/V1.RetentionConfig#_Google_Cloud_Video_LiveStream_V1_RetentionConfig__getRetentionWindowDuration__)\nare set,\n[RetentionConfig.retention_window_duration](/php/docs/reference/cloud-video-live-stream/latest/V1.RetentionConfig#_Google_Cloud_Video_LiveStream_V1_RetentionConfig__getRetentionWindowDuration__)\nis used and segment_keep_duration is ignored.\n\n### hasSegmentKeepDuration\n\n### clearSegmentKeepDuration\n\n### setSegmentKeepDuration\n\nHow long to keep a segment on the output Google Cloud Storage bucket after\nit is removed from the manifest. This field should be large enough to cover\nthe manifest propagation delay. Otherwise, a player could receive 404\nerrors while accessing segments which are listed in the manifest that the\nplayer has, but were already deleted from the output Google Cloud Storage\nbucket. Default value is `60s`.\n\nIf both segment_keep_duration and\n[RetentionConfig.retention_window_duration](/php/docs/reference/cloud-video-live-stream/latest/V1.RetentionConfig#_Google_Cloud_Video_LiveStream_V1_RetentionConfig__getRetentionWindowDuration__)\nare set,\n[RetentionConfig.retention_window_duration](/php/docs/reference/cloud-video-live-stream/latest/V1.RetentionConfig#_Google_Cloud_Video_LiveStream_V1_RetentionConfig__getRetentionWindowDuration__)\nis used and segment_keep_duration is ignored.\n\n### getUseTimecodeAsTimeline\n\nWhether to use the timecode, as specified in timecode config, when setting:\n\n- `availabilityStartTime` attribute in DASH manifests.\n\n- `#EXT-X-PROGRAM-DATE-TIME` tag in HLS manifests.\n If false, ignore the input timecode and use the time from system clock\n when the manifest is first generated. This is the default behavior.\n\n### setUseTimecodeAsTimeline\n\nWhether to use the timecode, as specified in timecode config, when setting:\n\n- `availabilityStartTime` attribute in DASH manifests.\n\n- `#EXT-X-PROGRAM-DATE-TIME` tag in HLS manifests.\n If false, ignore the input timecode and use the time from system clock\n when the manifest is first generated. This is the default behavior.\n\n### getKey\n\nOptional. A unique key for this manifest.\n\n### setKey\n\nOptional. A unique key for this manifest."]]
