Constructor
new Channel(propertiesopt)
Constructs a new Channel.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.video.livestream.v1.IChannel |
<optional> |
Properties to set |
- Implements:
-
- IChannel
Classes
Members
activeInput
Channel activeInput.
createTime
Channel createTime.
elementaryStreams
Channel elementaryStreams.
encryptions
Channel encryptions.
inputAttachments
Channel inputAttachments.
inputConfig
Channel inputConfig.
labels
Channel labels.
logConfig
Channel logConfig.
manifests
Channel manifests.
muxStreams
Channel muxStreams.
name
Channel name.
output
Channel output.
spriteSheets
Channel spriteSheets.
streamingError
Channel streamingError.
streamingState
Channel streamingState.
timecodeConfig
Channel timecodeConfig.
updateTime
Channel updateTime.
StreamingState
StreamingState enum.
Properties:
| Name | Type | Description |
|---|---|---|
STREAMING_STATE_UNSPECIFIED |
number |
STREAMING_STATE_UNSPECIFIED value |
STREAMING |
number |
STREAMING value |
AWAITING_INPUT |
number |
AWAITING_INPUT value |
STREAMING_ERROR |
number |
STREAMING_ERROR value |
STREAMING_NO_INPUT |
number |
STREAMING_NO_INPUT value |
STOPPED |
number |
STOPPED value |
STARTING |
number |
STARTING value |
STOPPING |
number |
STOPPING value |
Methods
toJSON() → {Object.<string, *>}
Converts this Channel to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.video.livestream.v1.Channel}
Creates a new Channel instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.video.livestream.v1.IChannel |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.video.livestream.v1.Channel |
Channel instance |
(static) decode(reader, lengthopt) → {google.cloud.video.livestream.v1.Channel}
Decodes a Channel message from the specified reader or buffer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
|
length |
number |
<optional> |
Message length if known beforehand |
Returns:
| Type | Description |
|---|---|
| google.cloud.video.livestream.v1.Channel |
Channel |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) decodeDelimited(reader) → {google.cloud.video.livestream.v1.Channel}
Decodes a Channel message from the specified reader or buffer, length delimited.
Parameters:
| Name | Type | Description |
|---|---|---|
reader |
$protobuf.Reader | Uint8Array |
Reader or buffer to decode from |
Returns:
| Type | Description |
|---|---|
| google.cloud.video.livestream.v1.Channel |
Channel |
Throws:
-
-
If the payload is not a reader or valid buffer
- Type
- Error
-
-
-
If required fields are missing
- Type
- $protobuf.util.ProtocolError
-
(static) encode(message, writeropt) → {$protobuf.Writer}
Encodes the specified Channel message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.video.livestream.v1.IChannel |
Channel message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}
Encodes the specified Channel message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.video.livestream.v1.IChannel |
Channel message or plain object to encode |
|
writer |
$protobuf.Writer |
<optional> |
Writer to encode to |
Returns:
| Type | Description |
|---|---|
| $protobuf.Writer |
Writer |
(static) fromObject(object) → {google.cloud.video.livestream.v1.Channel}
Creates a Channel message from a plain object. Also converts values to their respective internal types.
Parameters:
| Name | Type | Description |
|---|---|---|
object |
Object.<string, *> |
Plain object |
Returns:
| Type | Description |
|---|---|
| google.cloud.video.livestream.v1.Channel |
Channel |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Channel
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Channel message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.video.livestream.v1.Channel |
Channel |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Channel message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|