Represents a VideoAnnotationResults.
Package
@google-cloud/video-intelligenceConstructors
(constructor)(properties)
constructor(properties?: google.cloud.videointelligence.v1.IVideoAnnotationResults);Constructs a new VideoAnnotationResults.
| Parameter | |
|---|---|
| Name | Description |
properties |
IVideoAnnotationResults
Properties to set |
Properties
error
public error?: (google.rpc.IStatus|null);VideoAnnotationResults error.
explicitAnnotation
public explicitAnnotation?: (google.cloud.videointelligence.v1.IExplicitContentAnnotation|null);VideoAnnotationResults explicitAnnotation.
faceAnnotations
public faceAnnotations: google.cloud.videointelligence.v1.IFaceAnnotation[];VideoAnnotationResults faceAnnotations.
faceDetectionAnnotations
public faceDetectionAnnotations: google.cloud.videointelligence.v1.IFaceDetectionAnnotation[];VideoAnnotationResults faceDetectionAnnotations.
frameLabelAnnotations
public frameLabelAnnotations: google.cloud.videointelligence.v1.ILabelAnnotation[];VideoAnnotationResults frameLabelAnnotations.
inputUri
public inputUri: string;VideoAnnotationResults inputUri.
logoRecognitionAnnotations
public logoRecognitionAnnotations: google.cloud.videointelligence.v1.ILogoRecognitionAnnotation[];VideoAnnotationResults logoRecognitionAnnotations.
objectAnnotations
public objectAnnotations: google.cloud.videointelligence.v1.IObjectTrackingAnnotation[];VideoAnnotationResults objectAnnotations.
personDetectionAnnotations
public personDetectionAnnotations: google.cloud.videointelligence.v1.IPersonDetectionAnnotation[];VideoAnnotationResults personDetectionAnnotations.
segment
public segment?: (google.cloud.videointelligence.v1.IVideoSegment|null);VideoAnnotationResults segment.
segmentLabelAnnotations
public segmentLabelAnnotations: google.cloud.videointelligence.v1.ILabelAnnotation[];VideoAnnotationResults segmentLabelAnnotations.
segmentPresenceLabelAnnotations
public segmentPresenceLabelAnnotations: google.cloud.videointelligence.v1.ILabelAnnotation[];VideoAnnotationResults segmentPresenceLabelAnnotations.
shotAnnotations
public shotAnnotations: google.cloud.videointelligence.v1.IVideoSegment[];VideoAnnotationResults shotAnnotations.
shotLabelAnnotations
public shotLabelAnnotations: google.cloud.videointelligence.v1.ILabelAnnotation[];VideoAnnotationResults shotLabelAnnotations.
shotPresenceLabelAnnotations
public shotPresenceLabelAnnotations: google.cloud.videointelligence.v1.ILabelAnnotation[];VideoAnnotationResults shotPresenceLabelAnnotations.
speechTranscriptions
public speechTranscriptions: google.cloud.videointelligence.v1.ISpeechTranscription[];VideoAnnotationResults speechTranscriptions.
textAnnotations
public textAnnotations: google.cloud.videointelligence.v1.ITextAnnotation[];VideoAnnotationResults textAnnotations.
Methods
create(properties)
public static create(properties?: google.cloud.videointelligence.v1.IVideoAnnotationResults): google.cloud.videointelligence.v1.VideoAnnotationResults;Creates a new VideoAnnotationResults instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IVideoAnnotationResults
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.videointelligence.v1.VideoAnnotationResults | VideoAnnotationResults instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.videointelligence.v1.VideoAnnotationResults;Decodes a VideoAnnotationResults 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.VideoAnnotationResults | VideoAnnotationResults |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.videointelligence.v1.VideoAnnotationResults;Decodes a VideoAnnotationResults 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.VideoAnnotationResults | VideoAnnotationResults |
encode(message, writer)
public static encode(message: google.cloud.videointelligence.v1.IVideoAnnotationResults, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified VideoAnnotationResults message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IVideoAnnotationResults
VideoAnnotationResults 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.IVideoAnnotationResults, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified VideoAnnotationResults message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IVideoAnnotationResults
VideoAnnotationResults 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.VideoAnnotationResults;Creates a VideoAnnotationResults 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.VideoAnnotationResults | VideoAnnotationResults |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for VideoAnnotationResults
| Parameter | |
|---|---|
| Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
| Returns | |
|---|---|
| Type | Description |
string | The default type url |
toJSON()
public toJSON(): { [k: string]: any };Converts this VideoAnnotationResults to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.videointelligence.v1.VideoAnnotationResults, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a VideoAnnotationResults message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.cloud.videointelligence.v1.VideoAnnotationResults
VideoAnnotationResults |
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 VideoAnnotationResults message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|