public final class Channel extends GeneratedMessageV3 implements ChannelOrBuilder
Channel resource represents the processor that does a user-defined
"streaming" operation, which includes getting an input stream through an
input, transcoding it to multiple renditions, and publishing output live
streams in certain formats (for example, HLS or DASH) to the specified
location.
Protobuf type google.cloud.video.livestream.v1.Channel
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
public static final int ACTIVE_INPUT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ELEMENTARY_STREAMS_FIELD_NUMBER
public static final int ELEMENTARY_STREAMS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
ENCRYPTIONS_FIELD_NUMBER
public static final int ENCRYPTIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int INPUT_ATTACHMENTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
public static final int INPUT_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
LOG_CONFIG_FIELD_NUMBER
public static final int LOG_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MANIFESTS_FIELD_NUMBER
public static final int MANIFESTS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
MUX_STREAMS_FIELD_NUMBER
public static final int MUX_STREAMS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OUTPUT_FIELD_NUMBER
public static final int OUTPUT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
SPRITE_SHEETS_FIELD_NUMBER
public static final int SPRITE_SHEETS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STREAMING_ERROR_FIELD_NUMBER
public static final int STREAMING_ERROR_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STREAMING_STATE_FIELD_NUMBER
public static final int STREAMING_STATE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
TIMECODE_CONFIG_FIELD_NUMBER
public static final int TIMECODE_CONFIG_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static Channel getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Channel.Builder newBuilder()
newBuilder(Channel prototype)
public static Channel.Builder newBuilder(Channel prototype)
| Parameter |
|---|
| Name | Description |
prototype | Channel
|
public static Channel parseDelimitedFrom(InputStream input)
public static Channel parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static Channel parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Channel parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static Channel parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Channel parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Channel parseFrom(CodedInputStream input)
public static Channel parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static Channel parseFrom(InputStream input)
public static Channel parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static Channel parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Channel parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<Channel> parser()
Methods
containsLabels(String key)
public boolean containsLabels(String key)
User-defined key/value metadata.
map<string, string> labels = 4;
| Parameter |
|---|
| Name | Description |
key | String
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
public String getActiveInput()
Output only. The
InputAttachment.key
that serves as the current input source. The first input in the
input_attachments
is the initial input source.
string active_input = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
String | The activeInput.
|
public ByteString getActiveInputBytes()
Output only. The
InputAttachment.key
that serves as the current input source. The first input in the
input_attachments
is the initial input source.
string active_input = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for activeInput.
|
getCreateTime()
public Timestamp getCreateTime()
Output only. The creation time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The createTime.
|
getCreateTimeOrBuilder()
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. The creation time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
getDefaultInstanceForType()
public Channel getDefaultInstanceForType()
getElementaryStreams(int index)
public ElementaryStream getElementaryStreams(int index)
List of elementary streams.
repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;
| Parameter |
|---|
| Name | Description |
index | int
|
getElementaryStreamsCount()
public int getElementaryStreamsCount()
List of elementary streams.
repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;
| Returns |
|---|
| Type | Description |
int | |
getElementaryStreamsList()
public List<ElementaryStream> getElementaryStreamsList()
List of elementary streams.
repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;
getElementaryStreamsOrBuilder(int index)
public ElementaryStreamOrBuilder getElementaryStreamsOrBuilder(int index)
List of elementary streams.
repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;
| Parameter |
|---|
| Name | Description |
index | int
|
getElementaryStreamsOrBuilderList()
public List<? extends ElementaryStreamOrBuilder> getElementaryStreamsOrBuilderList()
List of elementary streams.
repeated .google.cloud.video.livestream.v1.ElementaryStream elementary_streams = 10;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.video.livestream.v1.ElementaryStreamOrBuilder> | |
getEncryptions(int index)
public Encryption getEncryptions(int index)
Encryption configurations for this channel. Each configuration has an ID
which is referred to by each MuxStream to indicate which configuration is
used for that output.
repeated .google.cloud.video.livestream.v1.Encryption encryptions = 24;
| Parameter |
|---|
| Name | Description |
index | int
|
getEncryptionsCount()
public int getEncryptionsCount()
Encryption configurations for this channel. Each configuration has an ID
which is referred to by each MuxStream to indicate which configuration is
used for that output.
repeated .google.cloud.video.livestream.v1.Encryption encryptions = 24;
| Returns |
|---|
| Type | Description |
int | |
getEncryptionsList()
public List<Encryption> getEncryptionsList()
Encryption configurations for this channel. Each configuration has an ID
which is referred to by each MuxStream to indicate which configuration is
used for that output.
repeated .google.cloud.video.livestream.v1.Encryption encryptions = 24;
getEncryptionsOrBuilder(int index)
public EncryptionOrBuilder getEncryptionsOrBuilder(int index)
Encryption configurations for this channel. Each configuration has an ID
which is referred to by each MuxStream to indicate which configuration is
used for that output.
repeated .google.cloud.video.livestream.v1.Encryption encryptions = 24;
| Parameter |
|---|
| Name | Description |
index | int
|
getEncryptionsOrBuilderList()
public List<? extends EncryptionOrBuilder> getEncryptionsOrBuilderList()
Encryption configurations for this channel. Each configuration has an ID
which is referred to by each MuxStream to indicate which configuration is
used for that output.
repeated .google.cloud.video.livestream.v1.Encryption encryptions = 24;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.video.livestream.v1.EncryptionOrBuilder> | |
public InputAttachment getInputAttachments(int index)
A list of input attachments that this channel uses.
One channel can have multiple inputs as the input sources. Only one
input can be selected as the input source at one time.
repeated .google.cloud.video.livestream.v1.InputAttachment input_attachments = 16;
| Parameter |
|---|
| Name | Description |
index | int
|
public int getInputAttachmentsCount()
A list of input attachments that this channel uses.
One channel can have multiple inputs as the input sources. Only one
input can be selected as the input source at one time.
repeated .google.cloud.video.livestream.v1.InputAttachment input_attachments = 16;
| Returns |
|---|
| Type | Description |
int | |
public List<InputAttachment> getInputAttachmentsList()
A list of input attachments that this channel uses.
One channel can have multiple inputs as the input sources. Only one
input can be selected as the input source at one time.
repeated .google.cloud.video.livestream.v1.InputAttachment input_attachments = 16;
public InputAttachmentOrBuilder getInputAttachmentsOrBuilder(int index)
A list of input attachments that this channel uses.
One channel can have multiple inputs as the input sources. Only one
input can be selected as the input source at one time.
repeated .google.cloud.video.livestream.v1.InputAttachment input_attachments = 16;
| Parameter |
|---|
| Name | Description |
index | int
|
public List<? extends InputAttachmentOrBuilder> getInputAttachmentsOrBuilderList()
A list of input attachments that this channel uses.
One channel can have multiple inputs as the input sources. Only one
input can be selected as the input source at one time.
repeated .google.cloud.video.livestream.v1.InputAttachment input_attachments = 16;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.video.livestream.v1.InputAttachmentOrBuilder> | |
public InputConfig getInputConfig()
The configuration for input sources defined in
input_attachments.
.google.cloud.video.livestream.v1.InputConfig input_config = 25;
public InputConfigOrBuilder getInputConfigOrBuilder()
The configuration for input sources defined in
input_attachments.
.google.cloud.video.livestream.v1.InputConfig input_config = 25;
getLabels() (deprecated)
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
User-defined key/value metadata.
map<string, string> labels = 4;
| Returns |
|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()
User-defined key/value metadata.
map<string, string> labels = 4;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
User-defined key/value metadata.
map<string, string> labels = 4;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
User-defined key/value metadata.
map<string, string> labels = 4;
| Parameter |
|---|
| Name | Description |
key | String
|
getLogConfig()
public LogConfig getLogConfig()
Configuration of platform logs for this channel.
.google.cloud.video.livestream.v1.LogConfig log_config = 19;
| Returns |
|---|
| Type | Description |
LogConfig | The logConfig.
|
getLogConfigOrBuilder()
public LogConfigOrBuilder getLogConfigOrBuilder()
Configuration of platform logs for this channel.
.google.cloud.video.livestream.v1.LogConfig log_config = 19;
getManifests(int index)
public Manifest getManifests(int index)
List of output manifests.
repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;
| Parameter |
|---|
| Name | Description |
index | int
|
getManifestsCount()
public int getManifestsCount()
List of output manifests.
repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;
| Returns |
|---|
| Type | Description |
int | |
getManifestsList()
public List<Manifest> getManifestsList()
List of output manifests.
repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;
getManifestsOrBuilder(int index)
public ManifestOrBuilder getManifestsOrBuilder(int index)
List of output manifests.
repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;
| Parameter |
|---|
| Name | Description |
index | int
|
getManifestsOrBuilderList()
public List<? extends ManifestOrBuilder> getManifestsOrBuilderList()
List of output manifests.
repeated .google.cloud.video.livestream.v1.Manifest manifests = 12;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.video.livestream.v1.ManifestOrBuilder> | |
getMuxStreams(int index)
public MuxStream getMuxStreams(int index)
List of multiplexing settings for output streams.
repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;
| Parameter |
|---|
| Name | Description |
index | int
|
getMuxStreamsCount()
public int getMuxStreamsCount()
List of multiplexing settings for output streams.
repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;
| Returns |
|---|
| Type | Description |
int | |
getMuxStreamsList()
public List<MuxStream> getMuxStreamsList()
List of multiplexing settings for output streams.
repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;
getMuxStreamsOrBuilder(int index)
public MuxStreamOrBuilder getMuxStreamsOrBuilder(int index)
List of multiplexing settings for output streams.
repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;
| Parameter |
|---|
| Name | Description |
index | int
|
getMuxStreamsOrBuilderList()
public List<? extends MuxStreamOrBuilder> getMuxStreamsOrBuilderList()
List of multiplexing settings for output streams.
repeated .google.cloud.video.livestream.v1.MuxStream mux_streams = 11;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.video.livestream.v1.MuxStreamOrBuilder> | |
getName()
The resource name of the channel, in the form of:
projects/{project}/locations/{location}/channels/{channelId}.
string name = 1;
| Returns |
|---|
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
The resource name of the channel, in the form of:
projects/{project}/locations/{location}/channels/{channelId}.
string name = 1;
| Returns |
|---|
| Type | Description |
ByteString | The bytes for name.
|
getOutput()
public Channel.Output getOutput()
Required. Information about the output (that is, the Cloud Storage bucket
to store the generated live stream).
.google.cloud.video.livestream.v1.Channel.Output output = 9 [(.google.api.field_behavior) = REQUIRED];
getOutputOrBuilder()
public Channel.OutputOrBuilder getOutputOrBuilder()
Required. Information about the output (that is, the Cloud Storage bucket
to store the generated live stream).
.google.cloud.video.livestream.v1.Channel.Output output = 9 [(.google.api.field_behavior) = REQUIRED];
getParserForType()
public Parser<Channel> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getSpriteSheets(int index)
public SpriteSheet getSpriteSheets(int index)
List of output sprite sheets.
repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;
| Parameter |
|---|
| Name | Description |
index | int
|
getSpriteSheetsCount()
public int getSpriteSheetsCount()
List of output sprite sheets.
repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;
| Returns |
|---|
| Type | Description |
int | |
getSpriteSheetsList()
public List<SpriteSheet> getSpriteSheetsList()
List of output sprite sheets.
repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;
getSpriteSheetsOrBuilder(int index)
public SpriteSheetOrBuilder getSpriteSheetsOrBuilder(int index)
List of output sprite sheets.
repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;
| Parameter |
|---|
| Name | Description |
index | int
|
getSpriteSheetsOrBuilderList()
public List<? extends SpriteSheetOrBuilder> getSpriteSheetsOrBuilderList()
List of output sprite sheets.
repeated .google.cloud.video.livestream.v1.SpriteSheet sprite_sheets = 13;
| Returns |
|---|
| Type | Description |
List<? extends com.google.cloud.video.livestream.v1.SpriteSheetOrBuilder> | |
getStreamingError()
public Status getStreamingError()
Output only. A description of the reason for the streaming error. This
property is always present when
streaming_state
is
STREAMING_ERROR.
.google.rpc.Status streaming_error = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
com.google.rpc.Status | The streamingError.
|
getStreamingErrorOrBuilder()
public StatusOrBuilder getStreamingErrorOrBuilder()
Output only. A description of the reason for the streaming error. This
property is always present when
streaming_state
is
STREAMING_ERROR.
.google.rpc.Status streaming_error = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
com.google.rpc.StatusOrBuilder | |
getStreamingState()
public Channel.StreamingState getStreamingState()
Output only. State of the streaming operation.
.google.cloud.video.livestream.v1.Channel.StreamingState streaming_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
getStreamingStateValue()
public int getStreamingStateValue()
Output only. State of the streaming operation.
.google.cloud.video.livestream.v1.Channel.StreamingState streaming_state = 14 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
int | The enum numeric value on the wire for streamingState.
|
getTimecodeConfig()
public TimecodeConfig getTimecodeConfig()
Configuration of timecode for this channel.
.google.cloud.video.livestream.v1.TimecodeConfig timecode_config = 21;
getTimecodeConfigOrBuilder()
public TimecodeConfigOrBuilder getTimecodeConfigOrBuilder()
Configuration of timecode for this channel.
.google.cloud.video.livestream.v1.TimecodeConfig timecode_config = 21;
getUpdateTime()
public Timestamp getUpdateTime()
Output only. The update time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
Timestamp | The updateTime.
|
getUpdateTimeOrBuilder()
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. The update time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
hasCreateTime()
public boolean hasCreateTime()
Output only. The creation time.
.google.protobuf.Timestamp create_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the createTime field is set.
|
public boolean hasInputConfig()
The configuration for input sources defined in
input_attachments.
.google.cloud.video.livestream.v1.InputConfig input_config = 25;
| Returns |
|---|
| Type | Description |
boolean | Whether the inputConfig field is set.
|
hasLogConfig()
public boolean hasLogConfig()
Configuration of platform logs for this channel.
.google.cloud.video.livestream.v1.LogConfig log_config = 19;
| Returns |
|---|
| Type | Description |
boolean | Whether the logConfig field is set.
|
hasOutput()
public boolean hasOutput()
Required. Information about the output (that is, the Cloud Storage bucket
to store the generated live stream).
.google.cloud.video.livestream.v1.Channel.Output output = 9 [(.google.api.field_behavior) = REQUIRED];
| Returns |
|---|
| Type | Description |
boolean | Whether the output field is set.
|
hasStreamingError()
public boolean hasStreamingError()
Output only. A description of the reason for the streaming error. This
property is always present when
streaming_state
is
STREAMING_ERROR.
.google.rpc.Status streaming_error = 18 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the streamingError field is set.
|
hasTimecodeConfig()
public boolean hasTimecodeConfig()
Configuration of timecode for this channel.
.google.cloud.video.livestream.v1.TimecodeConfig timecode_config = 21;
| Returns |
|---|
| Type | Description |
boolean | Whether the timecodeConfig field is set.
|
hasUpdateTime()
public boolean hasUpdateTime()
Output only. The update time.
.google.protobuf.Timestamp update_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns |
|---|
| Type | Description |
boolean | Whether the updateTime field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapFieldReflection(int number)
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
| Returns |
|---|
| Type | Description |
com.google.protobuf.MapFieldReflectionAccessor | |
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Channel.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Channel.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public Channel.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
