Class protos.google.cloud.videointelligence.v1.PersonDetectionConfig (3.0.0)

Represents a PersonDetectionConfig.

Package

@google-cloud/video-intelligence!

Constructors

(constructor)(properties)

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

Constructs a new PersonDetectionConfig.

Parameter
NameDescription
properties IPersonDetectionConfig

Properties to set

Properties

includeAttributes

public includeAttributes: boolean;

PersonDetectionConfig includeAttributes.

Property Value
TypeDescription
boolean

includeBoundingBoxes

public includeBoundingBoxes: boolean;

PersonDetectionConfig includeBoundingBoxes.

Property Value
TypeDescription
boolean

includePoseLandmarks

public includePoseLandmarks: boolean;

PersonDetectionConfig includePoseLandmarks.

Property Value
TypeDescription
boolean

Methods

create(properties)

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

Creates a new PersonDetectionConfig instance using the specified properties.

Parameter
NameDescription
properties IPersonDetectionConfig

Properties to set

Returns
TypeDescription
google.cloud.videointelligence.v1.PersonDetectionConfig

PersonDetectionConfig instance

decode(reader, length)

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

Decodes a PersonDetectionConfig message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.videointelligence.v1.PersonDetectionConfig

PersonDetectionConfig

decodeDelimited(reader)

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

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.videointelligence.v1.PersonDetectionConfig

PersonDetectionConfig

encode(message, writer)

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

Encodes the specified PersonDetectionConfig message. Does not implicitly messages.

Parameters
NameDescription
message IPersonDetectionConfig

PersonDetectionConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

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

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

Parameters
NameDescription
message IPersonDetectionConfig

PersonDetectionConfig message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

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

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.videointelligence.v1.PersonDetectionConfig

PersonDetectionConfig

toJSON()

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

Converts this PersonDetectionConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.videointelligence.v1.PersonDetectionConfig

PersonDetectionConfig

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a PersonDetectionConfig message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not