Class protos.google.cloud.video.transcoder.v1.JobConfig (3.0.3)

Represents a JobConfig.

Package

@google-cloud/video-transcoder

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.video.transcoder.v1.IJobConfig);

Constructs a new JobConfig.

Parameter
NameDescription
properties IJobConfig

Properties to set

Properties

adBreaks

public adBreaks: google.cloud.video.transcoder.v1.IAdBreak[];

JobConfig adBreaks.

editList

public editList: google.cloud.video.transcoder.v1.IEditAtom[];

JobConfig editList.

elementaryStreams

public elementaryStreams: google.cloud.video.transcoder.v1.IElementaryStream[];

JobConfig elementaryStreams.

encryptions

public encryptions: google.cloud.video.transcoder.v1.IEncryption[];

JobConfig encryptions.

inputs

public inputs: google.cloud.video.transcoder.v1.IInput[];

JobConfig inputs.

manifests

public manifests: google.cloud.video.transcoder.v1.IManifest[];

JobConfig manifests.

muxStreams

public muxStreams: google.cloud.video.transcoder.v1.IMuxStream[];

JobConfig muxStreams.

output

public output?: (google.cloud.video.transcoder.v1.IOutput|null);

JobConfig output.

overlays

public overlays: google.cloud.video.transcoder.v1.IOverlay[];

JobConfig overlays.

pubsubDestination

public pubsubDestination?: (google.cloud.video.transcoder.v1.IPubsubDestination|null);

JobConfig pubsubDestination.

spriteSheets

public spriteSheets: google.cloud.video.transcoder.v1.ISpriteSheet[];

JobConfig spriteSheets.

Methods

create(properties)

public static create(properties?: google.cloud.video.transcoder.v1.IJobConfig): google.cloud.video.transcoder.v1.JobConfig;

Creates a new JobConfig instance using the specified properties.

Parameter
NameDescription
properties IJobConfig

Properties to set

Returns
TypeDescription
JobConfig

JobConfig instance

decode(reader, length)

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

Decodes a JobConfig message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
JobConfig

JobConfig

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.video.transcoder.v1.JobConfig;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
JobConfig

JobConfig

encode(message, writer)

public static encode(message: google.cloud.video.transcoder.v1.IJobConfig, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified JobConfig message. Does not implicitly messages.

Parameters
NameDescription
message IJobConfig

JobConfig 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.video.transcoder.v1.IJobConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IJobConfig

JobConfig 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.video.transcoder.v1.JobConfig;

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

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

Plain object

Returns
TypeDescription
JobConfig

JobConfig

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for JobConfig

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this JobConfig to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message JobConfig

JobConfig

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