Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class 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.
Generated from protobuf message google.cloud.video.livestream.v1.Clip
Namespace
Google \ Cloud \ Video \ LiveStream \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ name
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
↳ create_time
↳ start_time
↳ update_time
↳ labels
array| Google\Protobuf\Internal\MapField
The labels associated with this resource. Each label is a key-value pair.
↳ state
int
Output only. The state of the clip.
↳ output_uri
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"
↳ error
Google\Rpc\Status
Output only. An error object that describes the reason for the failure. This property only presents when state
is FAILED
.
↳ slices
↳ clip_manifests
array< Clip\ClipManifest
>
Required. A list of clip manifests. Currently only one clip manifest is allowed.
getName
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 character minimum, 63 characters maximum
- Only contains letters, digits, underscores, and hyphens
string
setName
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 character minimum, 63 characters maximum
- Only contains letters, digits, underscores, and hyphens
var
string
$this
getCreateTime
Output only. The creation timestamp of the clip resource.
hasCreateTime
clearCreateTime
setCreateTime
Output only. The creation timestamp of the clip resource.
$this
getStartTime
Output only. The timestamp when the clip request starts to be processed.
hasStartTime
clearStartTime
setStartTime
Output only. The timestamp when the clip request starts to be processed.
$this
getUpdateTime
Output only. The update timestamp of the clip resource.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. The update timestamp of the clip resource.
$this
getLabels
The labels associated with this resource. Each label is a key-value pair.
setLabels
The labels associated with this resource. Each label is a key-value pair.
$this
getState
Output only. The state of the clip.
int
setState
Output only. The state of the clip.
var
int
$this
getOutputUri
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"
string
setOutputUri
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"
var
string
$this
getError
Output only. An error object that describes the reason for the failure.
This property only presents when state
is FAILED
.
hasError
clearError
setError
Output only. An error object that describes the reason for the failure.
This property only presents when state
is FAILED
.
$this
getSlices
The specified ranges of segments to generate a clip.
setSlices
The specified ranges of segments to generate a clip.
$this
getClipManifests
Required. A list of clip manifests. Currently only one clip manifest is allowed.
setClipManifests
Required. A list of clip manifests. Currently only one clip manifest is allowed.
$this
