Cloud Video Intelligence V1 Client - Class LabelAnnotation (1.12.16)

Reference documentation and code samples for the Cloud Video Intelligence V1 Client class LabelAnnotation.

Label annotation.

Generated from protobuf message google.cloud.videointelligence.v1.LabelAnnotation

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ entity`	`Google\Cloud\VideoIntelligence\V1\Entity` Detected entity.
`↳ category_entities`	`array<Google\Cloud\VideoIntelligence\V1\Entity>` Common categories for the detected entity. For example, when the label is `Terrier`, the category is likely `dog`. And in some cases there might be more than one categories e.g., `Terrier` could also be a `pet`.
`↳ segments`	`array<Google\Cloud\VideoIntelligence\V1\LabelSegment>` All video segments where a label was detected.
`↳ frames`	`array<Google\Cloud\VideoIntelligence\V1\LabelFrame>` All video frames where a label was detected.
`↳ version`	`string` Feature version.

getEntity

Detected entity.

Returns
Type	Description
`Google\Cloud\VideoIntelligence\V1\Entity\|null`

hasEntity

clearEntity

setEntity

Detected entity.

Parameter
Name	Description
`var`	`Google\Cloud\VideoIntelligence\V1\Entity`

Returns
Type	Description
`$this`

getCategoryEntities

Common categories for the detected entity.

For example, when the label is Terrier, the category is likely dog. And in some cases there might be more than one categories e.g., Terrier could also be a pet.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setCategoryEntities

Common categories for the detected entity.

For example, when the label is Terrier, the category is likely dog. And in some cases there might be more than one categories e.g., Terrier could also be a pet.

Parameter
Name	Description
`var`	`array<Google\Cloud\VideoIntelligence\V1\Entity>`

Returns
Type	Description
`$this`

getSegments

All video segments where a label was detected.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setSegments

All video segments where a label was detected.

Parameter
Name	Description
`var`	`array<Google\Cloud\VideoIntelligence\V1\LabelSegment>`

Returns
Type	Description
`$this`

getFrames

All video frames where a label was detected.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setFrames

All video frames where a label was detected.

Parameter
Name	Description
`var`	`array<Google\Cloud\VideoIntelligence\V1\LabelFrame>`

Returns
Type	Description
`$this`

getVersion

Feature version.

Returns
Type	Description
`string`

setVersion

Feature version.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`