Class protos.google.cloud.videointelligence.v1p3beta1.VideoAnnotationProgress (3.0.0)

Represents a VideoAnnotationProgress.

Package

@google-cloud/video-intelligence!

Constructors

(constructor)(properties)

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

Constructs a new VideoAnnotationProgress.

Parameter
NameDescription
properties IVideoAnnotationProgress

Properties to set

Properties

feature

public feature: (google.cloud.videointelligence.v1p3beta1.Feature|keyof typeof google.cloud.videointelligence.v1p3beta1.Feature);

VideoAnnotationProgress feature.

Property Value
TypeDescription
(google.cloud.videointelligence.v1p3beta1.Feature|keyof typeof google.cloud.videointelligence.v1p3beta1.Feature)

inputUri

public inputUri: string;

VideoAnnotationProgress inputUri.

Property Value
TypeDescription
string

progressPercent

public progressPercent: number;

VideoAnnotationProgress progressPercent.

Property Value
TypeDescription
number

segment

public segment?: (google.cloud.videointelligence.v1p3beta1.IVideoSegment|null);

VideoAnnotationProgress segment.

Property Value
TypeDescription
(google.cloud.videointelligence.v1p3beta1.IVideoSegment|null)

startTime

public startTime?: (google.protobuf.ITimestamp|null);

VideoAnnotationProgress startTime.

Property Value
TypeDescription
(google.protobuf.ITimestamp|null)

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

VideoAnnotationProgress updateTime.

Property Value
TypeDescription
(google.protobuf.ITimestamp|null)

Methods

create(properties)

public static create(properties?: google.cloud.videointelligence.v1p3beta1.IVideoAnnotationProgress): google.cloud.videointelligence.v1p3beta1.VideoAnnotationProgress;

Creates a new VideoAnnotationProgress instance using the specified properties.

Parameter
NameDescription
properties IVideoAnnotationProgress

Properties to set

Returns
TypeDescription
google.cloud.videointelligence.v1p3beta1.VideoAnnotationProgress

VideoAnnotationProgress instance

decode(reader, length)

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

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

VideoAnnotationProgress

decodeDelimited(reader)

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

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

VideoAnnotationProgress

encode(message, writer)

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

Encodes the specified VideoAnnotationProgress message. Does not implicitly messages.

Parameters
NameDescription
message IVideoAnnotationProgress

VideoAnnotationProgress 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.v1p3beta1.IVideoAnnotationProgress, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IVideoAnnotationProgress

VideoAnnotationProgress 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.v1p3beta1.VideoAnnotationProgress;

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

VideoAnnotationProgress

toJSON()

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

Converts this VideoAnnotationProgress to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.videointelligence.v1p3beta1.VideoAnnotationProgress

VideoAnnotationProgress

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 VideoAnnotationProgress 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