Class protos.google.cloud.videointelligence.v1p3beta1.PersonDetectionConfig (3.1.0)

Version 3.1.0

• 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 PersonDetectionConfig.

Package

@google-cloud/video-intelligence!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.videointelligence.v1p3beta1.IPersonDetectionConfig);

Constructs a new PersonDetectionConfig.

Parameter

Name	Description
properties	IPersonDetectionConfig Properties to set

Properties

includeAttributes

public includeAttributes: boolean;

PersonDetectionConfig includeAttributes.

Property Value

Type	Description
boolean

includeBoundingBoxes

public includeBoundingBoxes: boolean;

PersonDetectionConfig includeBoundingBoxes.

Property Value

Type	Description
boolean

includePoseLandmarks

public includePoseLandmarks: boolean;

PersonDetectionConfig includePoseLandmarks.

Property Value

Type	Description
boolean

Methods

create(properties)

public static create(properties?: google.cloud.videointelligence.v1p3beta1.IPersonDetectionConfig): google.cloud.videointelligence.v1p3beta1.PersonDetectionConfig;

Creates a new PersonDetectionConfig instance using the specified properties.

Parameter

Name	Description
properties	IPersonDetectionConfig Properties to set

Returns

Type	Description
google.cloud.videointelligence.v1p3beta1.PersonDetectionConfig	PersonDetectionConfig instance

decode(reader, length)

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

Decodes a PersonDetectionConfig 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.v1p3beta1.PersonDetectionConfig	PersonDetectionConfig

decodeDelimited(reader)

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

Decodes a PersonDetectionConfig 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.v1p3beta1.PersonDetectionConfig	PersonDetectionConfig

encode(message, writer)

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

Encodes the specified PersonDetectionConfig message. Does not implicitly messages.

Parameters

Name	Description
message	IPersonDetectionConfig PersonDetectionConfig 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.v1p3beta1.IPersonDetectionConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	IPersonDetectionConfig PersonDetectionConfig 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.v1p3beta1.PersonDetectionConfig;

Creates a PersonDetectionConfig 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.v1p3beta1.PersonDetectionConfig	PersonDetectionConfig

toJSON()

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

Converts this PersonDetectionConfig to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	google.cloud.videointelligence.v1p3beta1.PersonDetectionConfig PersonDetectionConfig
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 PersonDetectionConfig 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