Class: Google::Cloud::Video::LiveStream::V1::Manifest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/video/livestream/v1/outputs.rb

Overview

Manifest configuration.

Defined Under Namespace

Modules: ManifestType

Instance Attribute Summary collapse

Instance Attribute Details

#file_name ⇒ ::String

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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 133

class Manifest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The manifest type can be either `HLS` or `DASH`.
  module ManifestType
    # The manifest type is not specified.
    MANIFEST_TYPE_UNSPECIFIED = 0

    # Create an `HLS` manifest. The corresponding file extension is `.m3u8`.
    HLS = 1

    # Create a `DASH` manifest. The corresponding file extension is `.mpd`.
    DASH = 2
  end
end

#key ⇒ ::String

Returns Optional. A unique key for this manifest.

Returns:

  • (::String) —

    Optional. A unique key for this manifest.



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 133

class Manifest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The manifest type can be either `HLS` or `DASH`.
  module ManifestType
    # The manifest type is not specified.
    MANIFEST_TYPE_UNSPECIFIED = 0

    # Create an `HLS` manifest. The corresponding file extension is `.m3u8`.
    HLS = 1

    # Create a `DASH` manifest. The corresponding file extension is `.mpd`.
    DASH = 2
  end
end

#max_segment_count ⇒ ::Integer

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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 133

class Manifest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The manifest type can be either `HLS` or `DASH`.
  module ManifestType
    # The manifest type is not specified.
    MANIFEST_TYPE_UNSPECIFIED = 0

    # Create an `HLS` manifest. The corresponding file extension is `.m3u8`.
    HLS = 1

    # Create a `DASH` manifest. The corresponding file extension is `.mpd`.
    DASH = 2
  end
end

#mux_streams ⇒ ::Array<::String>

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


133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 133

class Manifest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The manifest type can be either `HLS` or `DASH`.
  module ManifestType
    # The manifest type is not specified.
    MANIFEST_TYPE_UNSPECIFIED = 0

    # Create an `HLS` manifest. The corresponding file extension is `.m3u8`.
    HLS = 1

    # Create a `DASH` manifest. The corresponding file extension is `.mpd`.
    DASH = 2
  end
end

#segment_keep_duration ⇒ ::Google::Protobuf::Duration

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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 133

class Manifest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The manifest type can be either `HLS` or `DASH`.
  module ManifestType
    # The manifest type is not specified.
    MANIFEST_TYPE_UNSPECIFIED = 0

    # Create an `HLS` manifest. The corresponding file extension is `.m3u8`.
    HLS = 1

    # Create a `DASH` manifest. The corresponding file extension is `.mpd`.
    DASH = 2
  end
end

#type ⇒ ::Google::Cloud::Video::LiveStream::V1::Manifest::ManifestType

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

Returns:



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 133

class Manifest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The manifest type can be either `HLS` or `DASH`.
  module ManifestType
    # The manifest type is not specified.
    MANIFEST_TYPE_UNSPECIFIED = 0

    # Create an `HLS` manifest. The corresponding file extension is `.m3u8`.
    HLS = 1

    # Create a `DASH` manifest. The corresponding file extension is `.mpd`.
    DASH = 2
  end
end

#use_timecode_as_timeline ⇒ ::Boolean

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



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'proto_docs/google/cloud/video/livestream/v1/outputs.rb', line 133

class Manifest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # The manifest type can be either `HLS` or `DASH`.
  module ManifestType
    # The manifest type is not specified.
    MANIFEST_TYPE_UNSPECIFIED = 0

    # Create an `HLS` manifest. The corresponding file extension is `.m3u8`.
    HLS = 1

    # Create a `DASH` manifest. The corresponding file extension is `.mpd`.
    DASH = 2
  end
end