Cloud Video Intelligence V1 Client - Class LabelAnnotation (1.13.1)

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

Namespace

Google \ Cloud \ VideoIntelligence \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
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
TypeDescription
Google\Cloud\VideoIntelligence\V1\Entity|null

hasEntity

clearEntity

setEntity

Detected entity.

Parameter
NameDescription
var Google\Cloud\VideoIntelligence\V1\Entity
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var array<Google\Cloud\VideoIntelligence\V1\Entity>
Returns
TypeDescription
$this

getSegments

All video segments where a label was detected.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setSegments

All video segments where a label was detected.

Parameter
NameDescription
var array<Google\Cloud\VideoIntelligence\V1\LabelSegment>
Returns
TypeDescription
$this

getFrames

All video frames where a label was detected.

Returns
TypeDescription
Google\Protobuf\Internal\RepeatedField

setFrames

All video frames where a label was detected.

Parameter
NameDescription
var array<Google\Cloud\VideoIntelligence\V1\LabelFrame>
Returns
TypeDescription
$this

getVersion

Feature version.

Returns
TypeDescription
string

setVersion

Feature version.

Parameter
NameDescription
var string
Returns
TypeDescription
$this