Class protos.google.cloud.video.stitcher.v1.LiveConfig (2.0.1)

Represents a LiveConfig.

Package

@google-cloud/video-stitcher

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.video.stitcher.v1.ILiveConfig);

Constructs a new LiveConfig.

Parameter
Name Description
properties ILiveConfig

Properties to set

Properties

adTagUri

public adTagUri: string;

LiveConfig adTagUri.

adTracking

public adTracking: (google.cloud.video.stitcher.v1.AdTracking|keyof typeof google.cloud.video.stitcher.v1.AdTracking);

LiveConfig adTracking.

defaultSlate

public defaultSlate: string;

LiveConfig defaultSlate.

gamLiveConfig

public gamLiveConfig?: (google.cloud.video.stitcher.v1.IGamLiveConfig|null);

LiveConfig gamLiveConfig.

name

public name: string;

LiveConfig name.

prefetchConfig

public prefetchConfig?: (google.cloud.video.stitcher.v1.IPrefetchConfig|null);

LiveConfig prefetchConfig.

sourceUri

public sourceUri: string;

LiveConfig sourceUri.

state

public state: (google.cloud.video.stitcher.v1.LiveConfig.State|keyof typeof google.cloud.video.stitcher.v1.LiveConfig.State);

LiveConfig state.

stitchingPolicy

public stitchingPolicy: (google.cloud.video.stitcher.v1.LiveConfig.StitchingPolicy|keyof typeof google.cloud.video.stitcher.v1.LiveConfig.StitchingPolicy);

LiveConfig stitchingPolicy.

Methods

create(properties)

public static create(properties?: google.cloud.video.stitcher.v1.ILiveConfig): google.cloud.video.stitcher.v1.LiveConfig;

Creates a new LiveConfig instance using the specified properties.

Parameter
Name Description
properties ILiveConfig

Properties to set

Returns
Type Description
LiveConfig

LiveConfig instance

decode(reader, length)

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

Decodes a LiveConfig message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
LiveConfig

LiveConfig

decodeDelimited(reader)

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

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

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
LiveConfig

LiveConfig

encode(message, writer)

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

Encodes the specified LiveConfig message. Does not implicitly messages.

Parameters
Name Description
message ILiveConfig

LiveConfig 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.video.stitcher.v1.ILiveConfig, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name Description
message ILiveConfig

LiveConfig 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.video.stitcher.v1.LiveConfig;

Creates a LiveConfig 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
LiveConfig

LiveConfig

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for LiveConfig

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 LiveConfig to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
Name Description
message LiveConfig

LiveConfig

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 LiveConfig message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not