Reference documentation and code samples for the Live Stream V1 API class Google::Cloud::Video::LiveStream::V1::Clip.
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.
value (::Google::Protobuf::Map{::String => ::String}) — 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.
#name
defname()->::String
Returns
(::String) —
The resource name of the clip, in the following format:
projects/{project}/locations/{location}/channels/{channelId}/clips/{clipId}.
{clipId} is a user-specified resource id that conforms to the following
criteria:
1 character minimum, 63 characters maximum
Only contains letters, digits, underscores, and hyphens
#name=
defname=(value)->::String
Parameter
value (::String) —
The resource name of the clip, in the following format:
projects/{project}/locations/{location}/channels/{channelId}/clips/{clipId}.
{clipId} is a user-specified resource id that conforms to the following
criteria:
1 character minimum, 63 characters maximum
Only contains letters, digits, underscores, and hyphens
Returns
(::String) —
The resource name of the clip, in the following format:
projects/{project}/locations/{location}/channels/{channelId}/clips/{clipId}.
{clipId} is a user-specified resource id that conforms to the following
criteria:
1 character minimum, 63 characters maximum
Only contains letters, digits, underscores, and hyphens
(::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"
#output_uri=
defoutput_uri=(value)->::String
Parameter
value (::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"
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"
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Live Stream V1 API - Class Google::Cloud::Video::LiveStream::V1::Clip (v2.2.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.2.0 (latest)](/ruby/docs/reference/google-cloud-video-live_stream-v1/latest/Google-Cloud-Video-LiveStream-V1-Clip)\n- [2.1.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/2.1.0/Google-Cloud-Video-LiveStream-V1-Clip)\n- [2.0.1](/ruby/docs/reference/google-cloud-video-live_stream-v1/2.0.1/Google-Cloud-Video-LiveStream-V1-Clip)\n- [1.3.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.3.0/Google-Cloud-Video-LiveStream-V1-Clip)\n- [1.2.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.2.0/Google-Cloud-Video-LiveStream-V1-Clip)\n- [1.1.1](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.1.1/Google-Cloud-Video-LiveStream-V1-Clip)\n- [1.0.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/1.0.0/Google-Cloud-Video-LiveStream-V1-Clip)\n- [0.9.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.9.0/Google-Cloud-Video-LiveStream-V1-Clip)\n- [0.8.2](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.8.2/Google-Cloud-Video-LiveStream-V1-Clip)\n- [0.7.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.7.0/Google-Cloud-Video-LiveStream-V1-Clip)\n- [0.6.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.6.0/Google-Cloud-Video-LiveStream-V1-Clip)\n- [0.5.1](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.5.1/Google-Cloud-Video-LiveStream-V1-Clip)\n- [0.4.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.4.0/Google-Cloud-Video-LiveStream-V1-Clip)\n- [0.3.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.3.0/Google-Cloud-Video-LiveStream-V1-Clip)\n- [0.2.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.2.0/Google-Cloud-Video-LiveStream-V1-Clip)\n- [0.1.0](/ruby/docs/reference/google-cloud-video-live_stream-v1/0.1.0/Google-Cloud-Video-LiveStream-V1-Clip) \nReference documentation and code samples for the Live Stream V1 API class Google::Cloud::Video::LiveStream::V1::Clip.\n\nClip is a sub-resource under channel. Each clip represents a clipping\noperation that generates a VOD playlist from its channel given a set of\ntimestamp ranges. \n\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #clip_manifests\n\n def clip_manifests() -\u003e ::Array\u003c::Google::Cloud::Video::LiveStream::V1::Clip::ClipManifest\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Video::LiveStream::V1::Clip::ClipManifest](./Google-Cloud-Video-LiveStream-V1-Clip-ClipManifest)\\\u003e) --- Required. A list of clip manifests. Currently only one clip manifest is allowed.\n\n### #clip_manifests=\n\n def clip_manifests=(value) -\u003e ::Array\u003c::Google::Cloud::Video::LiveStream::V1::Clip::ClipManifest\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::Video::LiveStream::V1::Clip::ClipManifest](./Google-Cloud-Video-LiveStream-V1-Clip-ClipManifest)\\\u003e) --- Required. A list of clip manifests. Currently only one clip manifest is allowed. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Video::LiveStream::V1::Clip::ClipManifest](./Google-Cloud-Video-LiveStream-V1-Clip-ClipManifest)\\\u003e) --- Required. A list of clip manifests. Currently only one clip manifest is allowed.\n\n### #create_time\n\n def create_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The creation timestamp of the clip resource.\n\n### #error\n\n def error() -\u003e ::Google::Rpc::Status\n\n**Returns**\n\n- ([::Google::Rpc::Status](./Google-Rpc-Status)) --- Output only. An error object that describes the reason for the failure. This property only presents when `state` is `FAILED`.\n\n### #labels\n\n def labels() -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- The labels associated with this resource. Each label is a key-value pair.\n\n### #labels=\n\n def labels=(value) -\u003e ::Google::Protobuf::Map{::String =\u003e ::String}\n\n**Parameter**\n\n- **value** (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- The labels associated with this resource. Each label is a key-value pair. \n**Returns**\n\n- (::Google::Protobuf::Map{::String =\\\u003e ::String}) --- The labels associated with this resource. Each label is a key-value pair.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The resource name of the clip, in the following format:\n `projects/{project}/locations/{location}/channels/{channelId}/clips/{clipId}`.\n `{clipId}` is a user-specified resource id that conforms to the following\n criteria:\n\n 1. 1 character minimum, 63 characters maximum\n 2. Only contains letters, digits, underscores, and hyphens\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) ---\n\n The resource name of the clip, in the following format:\n `projects/{project}/locations/{location}/channels/{channelId}/clips/{clipId}`.\n `{clipId}` is a user-specified resource id that conforms to the following\n criteria:\n 1. 1 character minimum, 63 characters maximum\n2. Only contains letters, digits, underscores, and hyphens \n**Returns**\n\n- (::String) --- The resource name of the clip, in the following format:\n `projects/{project}/locations/{location}/channels/{channelId}/clips/{clipId}`.\n `{clipId}` is a user-specified resource id that conforms to the following\n criteria:\n\n 1. 1 character minimum, 63 characters maximum\n 2. Only contains letters, digits, underscores, and hyphens\n\n### #output_type\n\n def output_type() -\u003e ::Google::Cloud::Video::LiveStream::V1::Clip::OutputType\n\n**Returns**\n\n- ([::Google::Cloud::Video::LiveStream::V1::Clip::OutputType](./Google-Cloud-Video-LiveStream-V1-Clip-OutputType)) --- Optional. OutputType of the clip. If not specified, the default value is MANIFEST.\n\n### #output_type=\n\n def output_type=(value) -\u003e ::Google::Cloud::Video::LiveStream::V1::Clip::OutputType\n\n**Parameter**\n\n- **value** ([::Google::Cloud::Video::LiveStream::V1::Clip::OutputType](./Google-Cloud-Video-LiveStream-V1-Clip-OutputType)) --- Optional. OutputType of the clip. If not specified, the default value is MANIFEST. \n**Returns**\n\n- ([::Google::Cloud::Video::LiveStream::V1::Clip::OutputType](./Google-Cloud-Video-LiveStream-V1-Clip-OutputType)) --- Optional. OutputType of the clip. If not specified, the default value is MANIFEST.\n\n### #output_uri\n\n def output_uri() -\u003e ::String\n\n**Returns**\n\n- (::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\"\n\n### #output_uri=\n\n def output_uri=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::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\" \n**Returns**\n\n- (::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\"\n\n### #slices\n\n def slices() -\u003e ::Array\u003c::Google::Cloud::Video::LiveStream::V1::Clip::Slice\u003e\n\n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Video::LiveStream::V1::Clip::Slice](./Google-Cloud-Video-LiveStream-V1-Clip-Slice)\\\u003e) --- The specified ranges of segments to generate a clip.\n\n### #slices=\n\n def slices=(value) -\u003e ::Array\u003c::Google::Cloud::Video::LiveStream::V1::Clip::Slice\u003e\n\n**Parameter**\n\n- **value** (::Array\\\u003c[::Google::Cloud::Video::LiveStream::V1::Clip::Slice](./Google-Cloud-Video-LiveStream-V1-Clip-Slice)\\\u003e) --- The specified ranges of segments to generate a clip. \n**Returns**\n\n- (::Array\\\u003c[::Google::Cloud::Video::LiveStream::V1::Clip::Slice](./Google-Cloud-Video-LiveStream-V1-Clip-Slice)\\\u003e) --- The specified ranges of segments to generate a clip.\n\n### #start_time\n\n def start_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The timestamp when the clip request starts to be processed.\n\n### #state\n\n def state() -\u003e ::Google::Cloud::Video::LiveStream::V1::Clip::State\n\n**Returns**\n\n- ([::Google::Cloud::Video::LiveStream::V1::Clip::State](./Google-Cloud-Video-LiveStream-V1-Clip-State)) --- Output only. The state of the clip.\n\n### #update_time\n\n def update_time() -\u003e ::Google::Protobuf::Timestamp\n\n**Returns**\n\n- ([::Google::Protobuf::Timestamp](./Google-Protobuf-Timestamp)) --- Output only. The update timestamp of the clip resource."]]
