Google Cloud Video Live Stream V1 Client - Class Manifest (1.1.2)

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 Manifest type. 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 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.
↳ 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.
↳ segment_keep_duration Google\Protobuf\Duration

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 Manifest type. 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 Manifest type. 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 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.
Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setMuxStreams

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

If both segment_keep_duration and RetentionConfig.retention_window_duration are set, RetentionConfig.retention_window_duration is used and segment_keep_duration is ignored.

Returns
Type Description
Google\Protobuf\Duration|null

hasSegmentKeepDuration

clearSegmentKeepDuration

setSegmentKeepDuration

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.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

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.

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getKey

Optional. A unique key for this manifest.

Returns
Type Description
string

setKey

Optional. A unique key for this manifest.

Parameter
Name Description
var string
Returns
Type Description
$this