Class: Google::Cloud::Video::LiveStream::V1::Clip

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

Overview

Clip is a sub-resource under channel. Each clip represents a clipping operation that generates a VOD playlist from its channel given a set of timestamp ranges.

Defined Under Namespace

Modules: State Classes: ClipManifest, LabelsEntry, Slice, TimeSlice

Instance Attribute Summary collapse

Instance Attribute Details

#clip_manifests ⇒ ::Array<::Google::Cloud::Video::LiveStream::V1::Clip::ClipManifest>

Returns Required. A list of clip manifests. Currently only one clip manifest is allowed.

Returns:



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 705

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

  # TimeSlice represents a tuple of Unix epoch timestamps that specifies a time
  # range.
  # @!attribute [rw] markin_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-in Unix epoch time in the original live stream manifest.
  # @!attribute [rw] markout_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-out Unix epoch time in the original live stream manifest.
  class TimeSlice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Slice represents a slice of the requested clip.
  # @!attribute [rw] time_slice
  #   @return [::Google::Cloud::Video::LiveStream::V1::Clip::TimeSlice]
  #     A slice in form of a tuple of Unix epoch time.
  class Slice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ClipManifest identifies a source manifest for the generated clip manifest.
  # @!attribute [rw] manifest_key
  #   @return [::String]
  #     Required. A unique key that identifies a manifest config in the parent
  #     channel. This key is the same as `channel.manifests.key` for the selected
  #     manifest.
  # @!attribute [r] output_uri
  #   @return [::String]
  #     Output only. The output URI of the generated clip manifest. This field
  #     will be populated when the CreateClip request is accepted. Current output
  #     format is provided below but may change in the future. Please read this
  #     field to get the uri to the generated clip manifest. Format:
  #     \\{clip.output_uri}/\\{channel.manifest.fileName} Example:
  #     gs://my-bucket/clip-outputs/main.m3u8
  class ClipManifest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of clipping operation.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The operation is pending to be picked up by the server.
    PENDING = 1

    # The server admitted this create clip request, and
    # outputs are under processing.
    CREATING = 2

    # Outputs are available in the specified Cloud Storage bucket. For
    # additional information, see the `outputs` field.
    SUCCEEDED = 3

    # The operation has failed. For additional information, see the `error`
    # field.
    FAILED = 4
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The creation timestamp of the clip resource.

Returns:



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 705

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

  # TimeSlice represents a tuple of Unix epoch timestamps that specifies a time
  # range.
  # @!attribute [rw] markin_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-in Unix epoch time in the original live stream manifest.
  # @!attribute [rw] markout_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-out Unix epoch time in the original live stream manifest.
  class TimeSlice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Slice represents a slice of the requested clip.
  # @!attribute [rw] time_slice
  #   @return [::Google::Cloud::Video::LiveStream::V1::Clip::TimeSlice]
  #     A slice in form of a tuple of Unix epoch time.
  class Slice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ClipManifest identifies a source manifest for the generated clip manifest.
  # @!attribute [rw] manifest_key
  #   @return [::String]
  #     Required. A unique key that identifies a manifest config in the parent
  #     channel. This key is the same as `channel.manifests.key` for the selected
  #     manifest.
  # @!attribute [r] output_uri
  #   @return [::String]
  #     Output only. The output URI of the generated clip manifest. This field
  #     will be populated when the CreateClip request is accepted. Current output
  #     format is provided below but may change in the future. Please read this
  #     field to get the uri to the generated clip manifest. Format:
  #     \\{clip.output_uri}/\\{channel.manifest.fileName} Example:
  #     gs://my-bucket/clip-outputs/main.m3u8
  class ClipManifest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of clipping operation.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The operation is pending to be picked up by the server.
    PENDING = 1

    # The server admitted this create clip request, and
    # outputs are under processing.
    CREATING = 2

    # Outputs are available in the specified Cloud Storage bucket. For
    # additional information, see the `outputs` field.
    SUCCEEDED = 3

    # The operation has failed. For additional information, see the `error`
    # field.
    FAILED = 4
  end
end

#error ⇒ ::Google::Rpc::Status (readonly)

Returns Output only. An error object that describes the reason for the failure. This property only presents when state is FAILED.

Returns:

  • (::Google::Rpc::Status) —

    Output only. An error object that describes the reason for the failure. This property only presents when state is FAILED.



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 705

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

  # TimeSlice represents a tuple of Unix epoch timestamps that specifies a time
  # range.
  # @!attribute [rw] markin_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-in Unix epoch time in the original live stream manifest.
  # @!attribute [rw] markout_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-out Unix epoch time in the original live stream manifest.
  class TimeSlice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Slice represents a slice of the requested clip.
  # @!attribute [rw] time_slice
  #   @return [::Google::Cloud::Video::LiveStream::V1::Clip::TimeSlice]
  #     A slice in form of a tuple of Unix epoch time.
  class Slice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ClipManifest identifies a source manifest for the generated clip manifest.
  # @!attribute [rw] manifest_key
  #   @return [::String]
  #     Required. A unique key that identifies a manifest config in the parent
  #     channel. This key is the same as `channel.manifests.key` for the selected
  #     manifest.
  # @!attribute [r] output_uri
  #   @return [::String]
  #     Output only. The output URI of the generated clip manifest. This field
  #     will be populated when the CreateClip request is accepted. Current output
  #     format is provided below but may change in the future. Please read this
  #     field to get the uri to the generated clip manifest. Format:
  #     \\{clip.output_uri}/\\{channel.manifest.fileName} Example:
  #     gs://my-bucket/clip-outputs/main.m3u8
  class ClipManifest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of clipping operation.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The operation is pending to be picked up by the server.
    PENDING = 1

    # The server admitted this create clip request, and
    # outputs are under processing.
    CREATING = 2

    # Outputs are available in the specified Cloud Storage bucket. For
    # additional information, see the `outputs` field.
    SUCCEEDED = 3

    # The operation has failed. For additional information, see the `error`
    # field.
    FAILED = 4
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns The labels associated with this resource. Each label is a key-value pair.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    The labels associated with this resource. Each label is a key-value pair.



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 705

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

  # TimeSlice represents a tuple of Unix epoch timestamps that specifies a time
  # range.
  # @!attribute [rw] markin_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-in Unix epoch time in the original live stream manifest.
  # @!attribute [rw] markout_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-out Unix epoch time in the original live stream manifest.
  class TimeSlice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Slice represents a slice of the requested clip.
  # @!attribute [rw] time_slice
  #   @return [::Google::Cloud::Video::LiveStream::V1::Clip::TimeSlice]
  #     A slice in form of a tuple of Unix epoch time.
  class Slice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ClipManifest identifies a source manifest for the generated clip manifest.
  # @!attribute [rw] manifest_key
  #   @return [::String]
  #     Required. A unique key that identifies a manifest config in the parent
  #     channel. This key is the same as `channel.manifests.key` for the selected
  #     manifest.
  # @!attribute [r] output_uri
  #   @return [::String]
  #     Output only. The output URI of the generated clip manifest. This field
  #     will be populated when the CreateClip request is accepted. Current output
  #     format is provided below but may change in the future. Please read this
  #     field to get the uri to the generated clip manifest. Format:
  #     \\{clip.output_uri}/\\{channel.manifest.fileName} Example:
  #     gs://my-bucket/clip-outputs/main.m3u8
  class ClipManifest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of clipping operation.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The operation is pending to be picked up by the server.
    PENDING = 1

    # The server admitted this create clip request, and
    # outputs are under processing.
    CREATING = 2

    # Outputs are available in the specified Cloud Storage bucket. For
    # additional information, see the `outputs` field.
    SUCCEEDED = 3

    # The operation has failed. For additional information, see the `error`
    # field.
    FAILED = 4
  end
end

#name ⇒ ::String

Returns The resource name of the clip, in the following format: projects/{project}/locations/{location}/channels/{c}/clips/{clipId}. {clipId} is a user-specified resource id that conforms to the following criteria:

  1. 1 character minimum, 63 characters maximum
  2. Only contains letters, digits, underscores, and hyphens.

Returns:

  • (::String) —

    The resource name of the clip, in the following format: projects/{project}/locations/{location}/channels/{c}/clips/{clipId}. {clipId} is a user-specified resource id that conforms to the following criteria:

    1. 1 character minimum, 63 characters maximum
    2. Only contains letters, digits, underscores, and hyphens


705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 705

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

  # TimeSlice represents a tuple of Unix epoch timestamps that specifies a time
  # range.
  # @!attribute [rw] markin_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-in Unix epoch time in the original live stream manifest.
  # @!attribute [rw] markout_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-out Unix epoch time in the original live stream manifest.
  class TimeSlice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Slice represents a slice of the requested clip.
  # @!attribute [rw] time_slice
  #   @return [::Google::Cloud::Video::LiveStream::V1::Clip::TimeSlice]
  #     A slice in form of a tuple of Unix epoch time.
  class Slice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ClipManifest identifies a source manifest for the generated clip manifest.
  # @!attribute [rw] manifest_key
  #   @return [::String]
  #     Required. A unique key that identifies a manifest config in the parent
  #     channel. This key is the same as `channel.manifests.key` for the selected
  #     manifest.
  # @!attribute [r] output_uri
  #   @return [::String]
  #     Output only. The output URI of the generated clip manifest. This field
  #     will be populated when the CreateClip request is accepted. Current output
  #     format is provided below but may change in the future. Please read this
  #     field to get the uri to the generated clip manifest. Format:
  #     \\{clip.output_uri}/\\{channel.manifest.fileName} Example:
  #     gs://my-bucket/clip-outputs/main.m3u8
  class ClipManifest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of clipping operation.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The operation is pending to be picked up by the server.
    PENDING = 1

    # The server admitted this create clip request, and
    # outputs are under processing.
    CREATING = 2

    # Outputs are available in the specified Cloud Storage bucket. For
    # additional information, see the `outputs` field.
    SUCCEEDED = 3

    # The operation has failed. For additional information, see the `error`
    # field.
    FAILED = 4
  end
end

#output_uri ⇒ ::String

Returns Specify the output_uri to determine where to place the clip segments and clip manifest files in Cloud Storage. The manifests specified in clip_manifests fields will be placed under this URI. The exact URI of the generated manifests will be provided in clip_manifests.output_uri for each manifest. Example: "output_uri": "gs://my-bucket/clip-outputs" "clip_manifests.output_uri": "gs://my-bucket/clip-outputs/main.m3u8".

Returns:

  • (::String) —

    Specify the output_uri to determine where to place the clip segments and clip manifest files in Cloud Storage. The manifests specified in clip_manifests fields will be placed under this URI. The exact URI of the generated manifests will be provided in clip_manifests.output_uri for each manifest. Example: "output_uri": "gs://my-bucket/clip-outputs" "clip_manifests.output_uri": "gs://my-bucket/clip-outputs/main.m3u8"



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 705

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

  # TimeSlice represents a tuple of Unix epoch timestamps that specifies a time
  # range.
  # @!attribute [rw] markin_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-in Unix epoch time in the original live stream manifest.
  # @!attribute [rw] markout_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-out Unix epoch time in the original live stream manifest.
  class TimeSlice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Slice represents a slice of the requested clip.
  # @!attribute [rw] time_slice
  #   @return [::Google::Cloud::Video::LiveStream::V1::Clip::TimeSlice]
  #     A slice in form of a tuple of Unix epoch time.
  class Slice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ClipManifest identifies a source manifest for the generated clip manifest.
  # @!attribute [rw] manifest_key
  #   @return [::String]
  #     Required. A unique key that identifies a manifest config in the parent
  #     channel. This key is the same as `channel.manifests.key` for the selected
  #     manifest.
  # @!attribute [r] output_uri
  #   @return [::String]
  #     Output only. The output URI of the generated clip manifest. This field
  #     will be populated when the CreateClip request is accepted. Current output
  #     format is provided below but may change in the future. Please read this
  #     field to get the uri to the generated clip manifest. Format:
  #     \\{clip.output_uri}/\\{channel.manifest.fileName} Example:
  #     gs://my-bucket/clip-outputs/main.m3u8
  class ClipManifest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of clipping operation.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The operation is pending to be picked up by the server.
    PENDING = 1

    # The server admitted this create clip request, and
    # outputs are under processing.
    CREATING = 2

    # Outputs are available in the specified Cloud Storage bucket. For
    # additional information, see the `outputs` field.
    SUCCEEDED = 3

    # The operation has failed. For additional information, see the `error`
    # field.
    FAILED = 4
  end
end

#slices ⇒ ::Array<::Google::Cloud::Video::LiveStream::V1::Clip::Slice>

Returns The specified ranges of segments to generate a clip.

Returns:



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 705

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

  # TimeSlice represents a tuple of Unix epoch timestamps that specifies a time
  # range.
  # @!attribute [rw] markin_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-in Unix epoch time in the original live stream manifest.
  # @!attribute [rw] markout_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-out Unix epoch time in the original live stream manifest.
  class TimeSlice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Slice represents a slice of the requested clip.
  # @!attribute [rw] time_slice
  #   @return [::Google::Cloud::Video::LiveStream::V1::Clip::TimeSlice]
  #     A slice in form of a tuple of Unix epoch time.
  class Slice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ClipManifest identifies a source manifest for the generated clip manifest.
  # @!attribute [rw] manifest_key
  #   @return [::String]
  #     Required. A unique key that identifies a manifest config in the parent
  #     channel. This key is the same as `channel.manifests.key` for the selected
  #     manifest.
  # @!attribute [r] output_uri
  #   @return [::String]
  #     Output only. The output URI of the generated clip manifest. This field
  #     will be populated when the CreateClip request is accepted. Current output
  #     format is provided below but may change in the future. Please read this
  #     field to get the uri to the generated clip manifest. Format:
  #     \\{clip.output_uri}/\\{channel.manifest.fileName} Example:
  #     gs://my-bucket/clip-outputs/main.m3u8
  class ClipManifest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of clipping operation.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The operation is pending to be picked up by the server.
    PENDING = 1

    # The server admitted this create clip request, and
    # outputs are under processing.
    CREATING = 2

    # Outputs are available in the specified Cloud Storage bucket. For
    # additional information, see the `outputs` field.
    SUCCEEDED = 3

    # The operation has failed. For additional information, see the `error`
    # field.
    FAILED = 4
  end
end

#start_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The timestamp when the clip request starts to be processed.

Returns:



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 705

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

  # TimeSlice represents a tuple of Unix epoch timestamps that specifies a time
  # range.
  # @!attribute [rw] markin_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-in Unix epoch time in the original live stream manifest.
  # @!attribute [rw] markout_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-out Unix epoch time in the original live stream manifest.
  class TimeSlice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Slice represents a slice of the requested clip.
  # @!attribute [rw] time_slice
  #   @return [::Google::Cloud::Video::LiveStream::V1::Clip::TimeSlice]
  #     A slice in form of a tuple of Unix epoch time.
  class Slice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ClipManifest identifies a source manifest for the generated clip manifest.
  # @!attribute [rw] manifest_key
  #   @return [::String]
  #     Required. A unique key that identifies a manifest config in the parent
  #     channel. This key is the same as `channel.manifests.key` for the selected
  #     manifest.
  # @!attribute [r] output_uri
  #   @return [::String]
  #     Output only. The output URI of the generated clip manifest. This field
  #     will be populated when the CreateClip request is accepted. Current output
  #     format is provided below but may change in the future. Please read this
  #     field to get the uri to the generated clip manifest. Format:
  #     \\{clip.output_uri}/\\{channel.manifest.fileName} Example:
  #     gs://my-bucket/clip-outputs/main.m3u8
  class ClipManifest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of clipping operation.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The operation is pending to be picked up by the server.
    PENDING = 1

    # The server admitted this create clip request, and
    # outputs are under processing.
    CREATING = 2

    # Outputs are available in the specified Cloud Storage bucket. For
    # additional information, see the `outputs` field.
    SUCCEEDED = 3

    # The operation has failed. For additional information, see the `error`
    # field.
    FAILED = 4
  end
end

#state ⇒ ::Google::Cloud::Video::LiveStream::V1::Clip::State (readonly)

Returns Output only. The state of the clip.

Returns:



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 705

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

  # TimeSlice represents a tuple of Unix epoch timestamps that specifies a time
  # range.
  # @!attribute [rw] markin_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-in Unix epoch time in the original live stream manifest.
  # @!attribute [rw] markout_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-out Unix epoch time in the original live stream manifest.
  class TimeSlice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Slice represents a slice of the requested clip.
  # @!attribute [rw] time_slice
  #   @return [::Google::Cloud::Video::LiveStream::V1::Clip::TimeSlice]
  #     A slice in form of a tuple of Unix epoch time.
  class Slice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ClipManifest identifies a source manifest for the generated clip manifest.
  # @!attribute [rw] manifest_key
  #   @return [::String]
  #     Required. A unique key that identifies a manifest config in the parent
  #     channel. This key is the same as `channel.manifests.key` for the selected
  #     manifest.
  # @!attribute [r] output_uri
  #   @return [::String]
  #     Output only. The output URI of the generated clip manifest. This field
  #     will be populated when the CreateClip request is accepted. Current output
  #     format is provided below but may change in the future. Please read this
  #     field to get the uri to the generated clip manifest. Format:
  #     \\{clip.output_uri}/\\{channel.manifest.fileName} Example:
  #     gs://my-bucket/clip-outputs/main.m3u8
  class ClipManifest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of clipping operation.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The operation is pending to be picked up by the server.
    PENDING = 1

    # The server admitted this create clip request, and
    # outputs are under processing.
    CREATING = 2

    # Outputs are available in the specified Cloud Storage bucket. For
    # additional information, see the `outputs` field.
    SUCCEEDED = 3

    # The operation has failed. For additional information, see the `error`
    # field.
    FAILED = 4
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The update timestamp of the clip resource.

Returns:



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
 
# File 'proto_docs/google/cloud/video/livestream/v1/resources.rb', line 705

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

  # TimeSlice represents a tuple of Unix epoch timestamps that specifies a time
  # range.
  # @!attribute [rw] markin_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-in Unix epoch time in the original live stream manifest.
  # @!attribute [rw] markout_time
  #   @return [::Google::Protobuf::Timestamp]
  #     The mark-out Unix epoch time in the original live stream manifest.
  class TimeSlice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Slice represents a slice of the requested clip.
  # @!attribute [rw] time_slice
  #   @return [::Google::Cloud::Video::LiveStream::V1::Clip::TimeSlice]
  #     A slice in form of a tuple of Unix epoch time.
  class Slice
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # ClipManifest identifies a source manifest for the generated clip manifest.
  # @!attribute [rw] manifest_key
  #   @return [::String]
  #     Required. A unique key that identifies a manifest config in the parent
  #     channel. This key is the same as `channel.manifests.key` for the selected
  #     manifest.
  # @!attribute [r] output_uri
  #   @return [::String]
  #     Output only. The output URI of the generated clip manifest. This field
  #     will be populated when the CreateClip request is accepted. Current output
  #     format is provided below but may change in the future. Please read this
  #     field to get the uri to the generated clip manifest. Format:
  #     \\{clip.output_uri}/\\{channel.manifest.fileName} Example:
  #     gs://my-bucket/clip-outputs/main.m3u8
  class ClipManifest
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # State of clipping operation.
  module State
    # State is not specified.
    STATE_UNSPECIFIED = 0

    # The operation is pending to be picked up by the server.
    PENDING = 1

    # The server admitted this create clip request, and
    # outputs are under processing.
    CREATING = 2

    # Outputs are available in the specified Cloud Storage bucket. For
    # additional information, see the `outputs` field.
    SUCCEEDED = 3

    # The operation has failed. For additional information, see the `error`
    # field.
    FAILED = 4
  end
end