Google Cloud Vision Ai V1 Client - Class StreamAnnotation (0.1.0)

Reference documentation and code samples for the Google Cloud Vision Ai V1 Client class StreamAnnotation.

message about annotations about Vision AI stream resource.

Generated from protobuf message google.cloud.visionai.v1.StreamAnnotation

Namespace

Google \ Cloud \ VisionAI \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ active_zone NormalizedPolygon

Annotation for type ACTIVE_ZONE

↳ crossing_line NormalizedPolyline

Annotation for type CROSSING_LINE

↳ id string

ID of the annotation. It must be unique when used in the certain context. For example, all the annotations to one input streams of a Vision AI application.

↳ display_name string

User-friendly name for the annotation.

↳ source_stream string

The Vision AI stream resource name.

↳ type int

The actual type of Annotation.

getActiveZone

Annotation for type ACTIVE_ZONE

Returns
Type Description
NormalizedPolygon|null

hasActiveZone

setActiveZone

Annotation for type ACTIVE_ZONE

Parameter
Name Description
var NormalizedPolygon
Returns
Type Description
$this

getCrossingLine

Annotation for type CROSSING_LINE

Returns
Type Description
NormalizedPolyline|null

hasCrossingLine

setCrossingLine

Annotation for type CROSSING_LINE

Parameter
Name Description
var NormalizedPolyline
Returns
Type Description
$this

getId

ID of the annotation. It must be unique when used in the certain context.

For example, all the annotations to one input streams of a Vision AI application.

Returns
Type Description
string

setId

ID of the annotation. It must be unique when used in the certain context.

For example, all the annotations to one input streams of a Vision AI application.

Parameter
Name Description
var string
Returns
Type Description
$this

getDisplayName

User-friendly name for the annotation.

Returns
Type Description
string

setDisplayName

User-friendly name for the annotation.

Parameter
Name Description
var string
Returns
Type Description
$this

getSourceStream

The Vision AI stream resource name.

Returns
Type Description
string

setSourceStream

The Vision AI stream resource name.

Parameter
Name Description
var string
Returns
Type Description
$this

getType

The actual type of Annotation.

Returns
Type Description
int Enum of type StreamAnnotationType.

setType

The actual type of Annotation.

Parameter
Name Description
var int

Enum of type StreamAnnotationType.

Returns
Type Description
$this

getAnnotationPayload

Returns
Type Description
string