Cloud Video Intelligence V1 Client - Class ObjectTrackingAnnotation (2.0.0-RC1)

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

Annotations corresponding to one tracked object.

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

Namespace

Google \ Cloud \ VideoIntelligence \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ segment Google\Cloud\VideoIntelligence\V1\VideoSegment

Non-streaming batch mode ONLY. Each object track corresponds to one video segment where it appears.

↳ track_id int|string

Streaming mode ONLY. In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time.

↳ entity Google\Cloud\VideoIntelligence\V1\Entity

Entity to specify the object category that this track is labeled as.

↳ confidence float

Object category's labeling confidence of this track.

↳ frames array<Google\Cloud\VideoIntelligence\V1\ObjectTrackingFrame>

Information corresponding to all frames where this object track appears. Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

↳ version string

Feature version.

getSegment

Non-streaming batch mode ONLY.

Each object track corresponds to one video segment where it appears.

Returns
Type Description
Google\Cloud\VideoIntelligence\V1\VideoSegment|null

hasSegment

setSegment

Non-streaming batch mode ONLY.

Each object track corresponds to one video segment where it appears.

Parameter
Name Description
var Google\Cloud\VideoIntelligence\V1\VideoSegment
Returns
Type Description
$this

getTrackId

Streaming mode ONLY.

In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time.

Returns
Type Description
int|string

hasTrackId

setTrackId

Streaming mode ONLY.

In streaming mode, we do not know the end time of a tracked object before it is completed. Hence, there is no VideoSegment info returned. Instead, we provide a unique identifiable integer track_id so that the customers can correlate the results of the ongoing ObjectTrackAnnotation of the same track_id over time.

Parameter
Name Description
var int|string
Returns
Type Description
$this

getEntity

Entity to specify the object category that this track is labeled as.

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

hasEntity

clearEntity

setEntity

Entity to specify the object category that this track is labeled as.

Parameter
Name Description
var Google\Cloud\VideoIntelligence\V1\Entity
Returns
Type Description
$this

getConfidence

Object category's labeling confidence of this track.

Returns
Type Description
float

setConfidence

Object category's labeling confidence of this track.

Parameter
Name Description
var float
Returns
Type Description
$this

getFrames

Information corresponding to all frames where this object track appears.

Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setFrames

Information corresponding to all frames where this object track appears.

Non-streaming batch mode: it may be one or multiple ObjectTrackingFrame messages in frames. Streaming mode: it can only be one ObjectTrackingFrame message in frames.

Parameter
Name Description
var array<Google\Cloud\VideoIntelligence\V1\ObjectTrackingFrame>
Returns
Type Description
$this

getVersion

Feature version.

Returns
Type Description
string

setVersion

Feature version.

Parameter
Name Description
var string
Returns
Type Description
$this

getTrackInfo

Returns
Type Description
string