Console
    Start free

    Google Cloud Video Live Stream V1 Client - Class DvrSession (1.3.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
    Google\Protobuf\Timestamp |null

    hasCreateTime

    clearCreateTime

    setCreateTime

    Output only. The creation time.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getUpdateTime

    Output only. The update time.

    Returns
    Type
    Description
    Google\Protobuf\Timestamp |null

    hasUpdateTime

    clearUpdateTime

    setUpdateTime

    Output only. The update time.

    Parameter
    Name
    Description
    var
    Google\Protobuf\Timestamp
    Returns
    Type
    Description
    $this

    getLabels

    Optional. User-defined key/value metadata.

    Returns
    Type
    Description
    Google\Protobuf\Internal\MapField

    setLabels

    Optional. User-defined key/value metadata.

    Parameter
    Name
    Description
    var
    array| Google\Protobuf\Internal\MapField
    Returns
    Type
    Description
    $this

    getState

    Output only. The state of the clip.

    Returns
    Type
    Description
    int
    Enum of type State .

    setState

    Output only. The state of the clip.

    Parameter
    Name
    Description
    var
    int

    Enum of type State .

    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
    Google\Rpc\Status |null

    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
    var
    Google\Rpc\Status
    Returns
    Type
    Description
    $this

    getDvrManifests

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

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setDvrManifests

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

    Parameter
    Name
    Description
    var
    array< DvrSession\DvrManifest >
    Returns
    Type
    Description
    $this

    getDvrWindows

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

    Returns
    Type
    Description
    Google\Protobuf\Internal\RepeatedField

    setDvrWindows

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

    Parameter
    Name
    Description
    var
    array< DvrSession\DvrWindow >
    Returns
    Type
    Description
    $this
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: