Google Cloud Video Live Stream V1 Client - Class DvrSession (1.2.1)

Reference documentation and code samples for the Google Cloud Video Live Stream V1 Client class DvrSession.

DvrSession is a sub-resource under channel. Each DvrSession represents a DVR recording of the live stream for a specific time range.

Generated from protobuf message google.cloud.video.livestream.v1.DvrSession

Namespace

Google \ Cloud \ Video \ LiveStream \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ name
string

Identifier. The resource name of the DVR session, in the following format: projects/{project}/locations/{location}/channels/{channelId}/dvrSessions/{dvrSessionId} . {dvrSessionId} 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
Google\Protobuf\Timestamp

Output only. The creation time.

↳ update_time
Google\Protobuf\Timestamp

Output only. The update time.

↳ labels
array| Google\Protobuf\Internal\MapField

Optional. User-defined key/value metadata.

↳ state
int

Output only. The state of the clip.

↳ error
Google\Rpc\Status

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

↳ dvr_manifests
array< DvrSession\DvrManifest >

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

↳ dvr_windows
array< DvrSession\DvrWindow >

Required. The specified ranges of segments to generate a DVR recording.

getName

Identifier. The resource name of the DVR session, in the following format: projects/{project}/locations/{location}/channels/{channelId}/dvrSessions/{dvrSessionId} .

{dvrSessionId} 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
Type
Description
string

setName

Identifier. The resource name of the DVR session, in the following format: projects/{project}/locations/{location}/channels/{channelId}/dvrSessions/{dvrSessionId} .

{dvrSessionId} 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
Parameter
Name
Description
var
string
Returns
Type
Description
$this

getCreateTime

Output only. The creation time.

Returns
Type
Description

hasCreateTime

clearCreateTime

setCreateTime

Output only. The creation time.

Parameter
Name
Description
Returns
Type
Description
$this

getUpdateTime

Output only. The update time.

Returns
Type
Description

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. The update time.

Parameter
Name
Description
Returns
Type
Description
$this

getLabels

Optional. User-defined key/value metadata.

Returns
Type
Description

setLabels

Optional. User-defined key/value metadata.

Parameter
Name
Description
Returns
Type
Description
$this

getState

Output only. The state of the clip.

Returns
Type
Description
int

setState

Output only. The state of the clip.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getError

Output only. An error object that describes the reason for the failure.

This property only presents when state is FAILED .

Returns
Type
Description

hasError

clearError

setError

Output only. An error object that describes the reason for the failure.

This property only presents when state is FAILED .

Parameter
Name
Description
Returns
Type
Description
$this

getDvrManifests

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

Returns
Type
Description

setDvrManifests

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

Parameter
Name
Description
var
Returns
Type
Description
$this

getDvrWindows

Required. The specified ranges of segments to generate a DVR recording.

Returns
Type
Description

setDvrWindows

Required. The specified ranges of segments to generate a DVR recording.

Parameter
Name
Description
var
Returns
Type
Description
$this
Create a Mobile Website
View Site in Mobile | Classic
Share by: