Live Stream V1 API - Class Google::Cloud::Video::LiveStream::V1::Clip (v1.1.0)

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.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#clip_manifests

def clip_manifests() -> ::Array<::Google::Cloud::Video::LiveStream::V1::Clip::ClipManifest>

Returns

(::Array<::Google::Cloud::Video::LiveStream::V1::Clip::ClipManifest>) — Required. A list of clip manifests. Currently only one clip manifest is allowed.

#clip_manifests=

def clip_manifests=(value) -> ::Array<::Google::Cloud::Video::LiveStream::V1::Clip::ClipManifest>

Parameter

value (::Array<::Google::Cloud::Video::LiveStream::V1::Clip::ClipManifest>) — Required. A list of clip manifests. Currently only one clip manifest is allowed.

Returns

(::Array<::Google::Cloud::Video::LiveStream::V1::Clip::ClipManifest>) — Required. A list of clip manifests. Currently only one clip manifest is allowed.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The creation timestamp of the clip resource.

#error

def error() -> ::Google::Rpc::Status

Returns

(::Google::Rpc::Status) — Output only. An error object that describes the reason for the failure. This property only presents when state is FAILED.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — The labels associated with this resource. Each label is a key-value pair.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

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

def name() -> ::String

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

#name=

def name=(value) -> ::String

Parameter

value (::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

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

#output_uri

def output_uri() -> ::String

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"

#output_uri=

def output_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"

#slices

def slices() -> ::Array<::Google::Cloud::Video::LiveStream::V1::Clip::Slice>

Returns

(::Array<::Google::Cloud::Video::LiveStream::V1::Clip::Slice>) — The specified ranges of segments to generate a clip.

#slices=

def slices=(value) -> ::Array<::Google::Cloud::Video::LiveStream::V1::Clip::Slice>

Parameter

value (::Array<::Google::Cloud::Video::LiveStream::V1::Clip::Slice>) — The specified ranges of segments to generate a clip.

Returns

(::Array<::Google::Cloud::Video::LiveStream::V1::Clip::Slice>) — The specified ranges of segments to generate a clip.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The timestamp when the clip request starts to be processed.

#state

def state() -> ::Google::Cloud::Video::LiveStream::V1::Clip::State

Returns

(::Google::Cloud::Video::LiveStream::V1::Clip::State) — Output only. The state of the clip.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. The update timestamp of the clip resource.