Live Stream V1 API - Class Google::Cloud::Video::LiveStream::V1::Manifest (v1.2.0)

Reference documentation and code samples for the Live Stream V1 API class Google::Cloud::Video::LiveStream::V1::Manifest.

Manifest configuration.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#file_name

def file_name() -> ::String
Returns
  • (::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.

#file_name=

def file_name=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#key

def key() -> ::String
Returns
  • (::String) — Optional. A unique key for this manifest.

#key=

def key=(value) -> ::String
Parameter
  • value (::String) — Optional. A unique key for this manifest.
Returns
  • (::String) — Optional. A unique key for this manifest.

#max_segment_count

def max_segment_count() -> ::Integer
Returns
  • (::Integer) — 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.

#max_segment_count=

def max_segment_count=(value) -> ::Integer
Parameter
  • value (::Integer) — 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
  • (::Integer) — 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.

#mux_streams

def mux_streams() -> ::Array<::String>
Returns
  • (::Array<::String>) —

    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.

#mux_streams=

def mux_streams=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) —

    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
  • (::Array<::String>) —

    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.

#segment_keep_duration

def segment_keep_duration() -> ::Google::Protobuf::Duration
Returns
  • (::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.

#segment_keep_duration=

def segment_keep_duration=(value) -> ::Google::Protobuf::Duration
Parameter
  • value (::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.

Returns
  • (::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.

#type

def type() -> ::Google::Cloud::Video::LiveStream::V1::Manifest::ManifestType
Returns

#type=

def type=(value) -> ::Google::Cloud::Video::LiveStream::V1::Manifest::ManifestType
Parameter
Returns

#use_timecode_as_timeline

def use_timecode_as_timeline() -> ::Boolean
Returns
  • (::Boolean) — 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.

#use_timecode_as_timeline=

def use_timecode_as_timeline=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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.