Class protos.google.cloud.videointelligence.v1.TextAnnotation (3.3.6)

Version 3.3.6

• 5.0.2 (latest)
• 5.0.0
• 4.2.2
• 4.1.1
• 3.4.1
• 3.3.6
• 3.1.0
• 3.0.0

Represents a TextAnnotation.

Package

@google-cloud/video-intelligence!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.videointelligence.v1.ITextAnnotation);

Constructs a new TextAnnotation.

Parameter

Name	Description
properties	ITextAnnotation Properties to set

Properties

segments

public segments: google.cloud.videointelligence.v1.ITextSegment[];

TextAnnotation segments.

Property Value

Type	Description
google.cloud.videointelligence.v1.ITextSegment[]

text

public text: string;

TextAnnotation text.

Property Value

Type	Description
string

version

public version: string;

TextAnnotation version.

Property Value

Type	Description
string

Methods

create(properties)

public static create(properties?: google.cloud.videointelligence.v1.ITextAnnotation): google.cloud.videointelligence.v1.TextAnnotation;

Creates a new TextAnnotation instance using the specified properties.

Parameter

Name	Description
properties	ITextAnnotation Properties to set

Returns

Type	Description
google.cloud.videointelligence.v1.TextAnnotation	TextAnnotation instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.videointelligence.v1.TextAnnotation;

Decodes a TextAnnotation message from the specified reader or buffer.

Parameters

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from
length	number Message length if known beforehand

Returns

Type	Description
google.cloud.videointelligence.v1.TextAnnotation	TextAnnotation

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.videointelligence.v1.TextAnnotation;

Decodes a TextAnnotation message from the specified reader or buffer, length delimited.

Parameter

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from

Returns

Type	Description
google.cloud.videointelligence.v1.TextAnnotation	TextAnnotation

encode(message, writer)

public static encode(message: google.cloud.videointelligence.v1.ITextAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TextAnnotation message. Does not implicitly messages.

Parameters

Name	Description
message	ITextAnnotation TextAnnotation message or plain object to encode
writer	$protobuf.Writer Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.videointelligence.v1.ITextAnnotation, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified TextAnnotation message, length delimited. Does not implicitly messages.

Parameters

Name	Description
message	ITextAnnotation TextAnnotation message or plain object to encode
writer	$protobuf.Writer Writer to encode to

Returns

Type	Description
$protobuf.Writer	Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.videointelligence.v1.TextAnnotation;

Creates a TextAnnotation message from a plain object. Also converts values to their respective internal types.

Parameter

Name	Description
object	{ [k: string]: any } Plain object

Returns

Type	Description
google.cloud.videointelligence.v1.TextAnnotation	TextAnnotation

toJSON()

public toJSON(): { [k: string]: any };

Converts this TextAnnotation to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

public static toObject(message: google.cloud.videointelligence.v1.TextAnnotation, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a TextAnnotation message. Also converts values to other types if specified.

Parameters

Name	Description
message	google.cloud.videointelligence.v1.TextAnnotation TextAnnotation
options	$protobuf.IConversionOptions Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a TextAnnotation message.

Parameter

Name	Description
message	{ [k: string]: any } Plain object to verify

Returns

Type	Description
(string|null)	null if valid, otherwise the reason why it is not