Represents a Channel.
Package
@google-cloud/livestreamConstructors
(constructor)(properties)
constructor(properties?: google.cloud.video.livestream.v1.IChannel);Constructs a new Channel.
| Parameter | |
|---|---|
| Name | Description |
properties |
IChannel
Properties to set |
Properties
activeInput
public activeInput: string;Channel activeInput.
createTime
public createTime?: (google.protobuf.ITimestamp|null);Channel createTime.
elementaryStreams
public elementaryStreams: google.cloud.video.livestream.v1.IElementaryStream[];Channel elementaryStreams.
encryptions
public encryptions: google.cloud.video.livestream.v1.IEncryption[];Channel encryptions.
inputAttachments
public inputAttachments: google.cloud.video.livestream.v1.IInputAttachment[];Channel inputAttachments.
inputConfig
public inputConfig?: (google.cloud.video.livestream.v1.IInputConfig|null);Channel inputConfig.
labels
public labels: { [k: string]: string };Channel labels.
logConfig
public logConfig?: (google.cloud.video.livestream.v1.ILogConfig|null);Channel logConfig.
manifests
public manifests: google.cloud.video.livestream.v1.IManifest[];Channel manifests.
muxStreams
public muxStreams: google.cloud.video.livestream.v1.IMuxStream[];Channel muxStreams.
name
public name: string;Channel name.
output
public output?: (google.cloud.video.livestream.v1.Channel.IOutput|null);Channel output.
spriteSheets
public spriteSheets: google.cloud.video.livestream.v1.ISpriteSheet[];Channel spriteSheets.
streamingError
public streamingError?: (google.rpc.IStatus|null);Channel streamingError.
streamingState
public streamingState: (google.cloud.video.livestream.v1.Channel.StreamingState|keyof typeof google.cloud.video.livestream.v1.Channel.StreamingState);Channel streamingState.
timecodeConfig
public timecodeConfig?: (google.cloud.video.livestream.v1.ITimecodeConfig|null);Channel timecodeConfig.
updateTime
public updateTime?: (google.protobuf.ITimestamp|null);Channel updateTime.
Methods
create(properties)
public static create(properties?: google.cloud.video.livestream.v1.IChannel): google.cloud.video.livestream.v1.Channel;Creates a new Channel instance using the specified properties.
| Parameter | |
|---|---|
| Name | Description |
properties |
IChannel
Properties to set |
| Returns | |
|---|---|
| Type | Description |
Channel | Channel instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.video.livestream.v1.Channel;Decodes a Channel 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 |
Channel | Channel |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.video.livestream.v1.Channel;Decodes a Channel message from the specified reader or buffer, length delimited.
| Parameter | |
|---|---|
| Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
| Returns | |
|---|---|
| Type | Description |
Channel | Channel |
encode(message, writer)
public static encode(message: google.cloud.video.livestream.v1.IChannel, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Channel message. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IChannel
Channel 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.livestream.v1.IChannel, writer?: $protobuf.Writer): $protobuf.Writer;Encodes the specified Channel message, length delimited. Does not implicitly messages.
| Parameters | |
|---|---|
| Name | Description |
message |
IChannel
Channel 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.livestream.v1.Channel;Creates a Channel 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 |
Channel | Channel |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;Gets the default type url for Channel
| 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 Channel to JSON.
| Returns | |
|---|---|
| Type | Description |
{ [k: string]: any } | JSON object |
toObject(message, options)
public static toObject(message: google.cloud.video.livestream.v1.Channel, options?: $protobuf.IConversionOptions): { [k: string]: any };Creates a plain object from a Channel message. Also converts values to other types if specified.
| Parameters | |
|---|---|
| Name | Description |
message |
Channel
Channel |
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 Channel message.
| Parameter | |
|---|---|
| Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
| Returns | |
|---|---|
| Type | Description |
(string|null) |
|