Google Cloud Video Live Stream V1 Client - Class State (1.2.0)

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

State of the DVR session.

Protobuf type google.cloud.video.livestream.v1.DvrSession.State

Namespace

Google \ Cloud \ Video \ LiveStream \ V1 \ DvrSession

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

STATE_UNSPECIFIED

Value: 0

State is not specified.

Generated from protobuf enum STATE_UNSPECIFIED = 0;

PENDING

Value: 1

The operation is pending to be picked up by the server.

Generated from protobuf enum PENDING = 1;

UPDATING

Value: 2

The session is being updated.

Generated from protobuf enum UPDATING = 2;

SCHEDULED

Value: 3

The session is scheduled and waiting for the start time.

Generated from protobuf enum SCHEDULED = 3;

LIVE

Value: 4

The session is currently in progress and the outputs are available in the specified Cloud Storage bucket. For additional information, see the dvr_manifests.output_uri field.

Generated from protobuf enum LIVE = 4;

FINISHED

Value: 5

Outputs are available in the specified Cloud Storage bucket. For additional information, see the dvr_manifests.output_uri field.

Generated from protobuf enum FINISHED = 5;

FAILED

Value: 6

The operation has failed. For additional information, see the error field.

Generated from protobuf enum FAILED = 6;

DELETING

Value: 7

The session is being deleted.

Generated from protobuf enum DELETING = 7;

POST_PROCESSING

Value: 8

The session is being post processed.

Generated from protobuf enum POST_PROCESSING = 8;

COOLDOWN

Value: 9

The session is in cooldown. The cooldown period lasts for 60 seconds.

When the DVR session is updated by the user to have a new end time that is likely already in the past, the DVR manifest will end as soon as possible and the DVR session will move to this state. This is done to prevent the players to receive a manifest update that removes a segment that has already been played. After the cooldown period ends, a new manifest is generated that honors the new end time.

Generated from protobuf enum COOLDOWN = 9;

STOPPING

Value: 10

The session is being stopped. The session will move to STOPPING state, if the parent channel is updated.

Generated from protobuf enum STOPPING = 10;