Represents a LiveSession.
Package
@google-cloud/video-stitcherConstructors
(constructor)(properties)
constructor(properties?: google.cloud.video.stitcher.v1.ILiveSession);Constructs a new LiveSession.
| Parameter | |
|---|---|
| Name | Description |
properties |
ILiveSession
Properties to set |
Properties
adTagMacros
public adTagMacros: { [k: string]: string };LiveSession adTagMacros.
adTagMap
public adTagMap: { [k: string]: google.cloud.video.stitcher.v1.IAdTag };LiveSession adTagMap.
clientAdTracking
public clientAdTracking: boolean;LiveSession clientAdTracking.
defaultAdTagId
public defaultAdTagId: string;LiveSession defaultAdTagId.
defaultSlateId
public defaultSlateId: string;LiveSession defaultSlateId.
manifestOptions
public manifestOptions?: (google.cloud.video.stitcher.v1.IManifestOptions|null);LiveSession manifestOptions.
name
public name: string;LiveSession name.
playUri
public playUri: string;LiveSession playUri.
sourceUri
public sourceUri: string;LiveSession sourceUri.
stitchingPolicy
public stitchingPolicy: (google.cloud.video.stitcher.v1.LiveSession.StitchingPolicy|keyof typeof google.cloud.video.stitcher.v1.LiveSession.StitchingPolicy);LiveSession stitchingPolicy.
streamId
public streamId: string;LiveSession streamId.
Methods
create(properties)
public static create(properties?: google.cloud.video.stitcher.v1.ILiveSession): google.cloud.video.stitcher.v1.LiveSession;Creates a new LiveSession instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
ILiveSession
Properties to set |
| Returns | |
|---|---|
| Type | Description |
google.cloud.video.stitcher.v1.LiveSession | LiveSession instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.video.stitcher.v1.LiveSession;Decodes a LiveSession 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.video.stitcher.v1.LiveSession | LiveSession |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.video.stitcher.v1.LiveSession;Decodes a LiveSession 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.video.stitcher.v1.LiveSession | LiveSession |
encode(message, writer)
public static encode(message: google.cloud.video.stitcher.v1.ILiveSession, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified LiveSession message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ILiveSession
LiveSession 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.ILiveSession, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified LiveSession message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
ILiveSession
LiveSession 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.LiveSession;Creates a LiveSession 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.video.stitcher.v1.LiveSession | LiveSession |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for LiveSession
| 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 LiveSession to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.video.stitcher.v1.LiveSession, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a LiveSession message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
google.cloud.video.stitcher.v1.LiveSession
LiveSession |
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 LiveSession message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|