VideoAnnotationResults

google.cloud.videointelligence.v1. VideoAnnotationResults

Represents a VideoAnnotationResults.

Constructor

new VideoAnnotationResults(propertiesopt)

Constructs a new VideoAnnotationResults.

Parameters:
Name Type Attributes Description
properties google.cloud.videointelligence.v1.IVideoAnnotationResults <optional>

Properties to set

Implements:
  • IVideoAnnotationResults

Members

error

VideoAnnotationResults error.

explicitAnnotation

VideoAnnotationResults explicitAnnotation.

faceAnnotations

VideoAnnotationResults faceAnnotations.

faceDetectionAnnotations

VideoAnnotationResults faceDetectionAnnotations.

frameLabelAnnotations

VideoAnnotationResults frameLabelAnnotations.

inputUri

VideoAnnotationResults inputUri.

logoRecognitionAnnotations

VideoAnnotationResults logoRecognitionAnnotations.

objectAnnotations

VideoAnnotationResults objectAnnotations.

personDetectionAnnotations

VideoAnnotationResults personDetectionAnnotations.

segment

VideoAnnotationResults segment.

segmentLabelAnnotations

VideoAnnotationResults segmentLabelAnnotations.

segmentPresenceLabelAnnotations

VideoAnnotationResults segmentPresenceLabelAnnotations.

shotAnnotations

VideoAnnotationResults shotAnnotations.

shotLabelAnnotations

VideoAnnotationResults shotLabelAnnotations.

shotPresenceLabelAnnotations

VideoAnnotationResults shotPresenceLabelAnnotations.

speechTranscriptions

VideoAnnotationResults speechTranscriptions.

textAnnotations

VideoAnnotationResults textAnnotations.

Methods

toJSON() → {Object.<string, *>}

Converts this VideoAnnotationResults to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.videointelligence.v1.VideoAnnotationResults}

Creates a new VideoAnnotationResults instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.videointelligence.v1.IVideoAnnotationResults <optional>

Properties to set

Returns:
Type Description
google.cloud.videointelligence.v1.VideoAnnotationResults

VideoAnnotationResults instance

(static) decode(reader, lengthopt) → {google.cloud.videointelligence.v1.VideoAnnotationResults}

Decodes a VideoAnnotationResults message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.videointelligence.v1.VideoAnnotationResults

VideoAnnotationResults

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.videointelligence.v1.VideoAnnotationResults}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.videointelligence.v1.VideoAnnotationResults

VideoAnnotationResults

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified VideoAnnotationResults message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.videointelligence.v1.IVideoAnnotationResults

VideoAnnotationResults message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.videointelligence.v1.IVideoAnnotationResults

VideoAnnotationResults message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.videointelligence.v1.VideoAnnotationResults}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.videointelligence.v1.VideoAnnotationResults

VideoAnnotationResults

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for VideoAnnotationResults

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.videointelligence.v1.VideoAnnotationResults

VideoAnnotationResults

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies a VideoAnnotationResults message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not