Package com.google.cloud.video.livestream.v1 (0.10.0)

A client to Live Stream API

The interfaces provided are listed below, along with usage samples.

LivestreamServiceClient

Service Description: Using Live Stream API, you can generate live streams in the various renditions and streaming formats. The streaming format include HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH). You can send a source stream in the various ways, including Real-Time Messaging Protocol (RTMP) and Secure Reliable Transport (SRT).

Sample for LivestreamServiceClient:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (LivestreamServiceClient livestreamServiceClient = LivestreamServiceClient.create()) {
   ChannelName name = ChannelName.of("[PROJECT]", "[LOCATION]", "[CHANNEL]");
   Channel response = livestreamServiceClient.getChannel(name);
 }

Classes

AudioFormat

Properties of the audio format.

Protobuf type google.cloud.video.livestream.v1.AudioFormat

AudioFormat.Builder

Properties of the audio format.

Protobuf type google.cloud.video.livestream.v1.AudioFormat

AudioStream

Audio stream resource.

Protobuf type google.cloud.video.livestream.v1.AudioStream

AudioStream.AudioMapping

The mapping for the input streams and audio channels.

Protobuf type google.cloud.video.livestream.v1.AudioStream.AudioMapping

AudioStream.AudioMapping.Builder

The mapping for the input streams and audio channels.

Protobuf type google.cloud.video.livestream.v1.AudioStream.AudioMapping

AudioStream.Builder

Audio stream resource.

Protobuf type google.cloud.video.livestream.v1.AudioStream

AudioStreamProperty

Properties of the audio stream.

Protobuf type google.cloud.video.livestream.v1.AudioStreamProperty

AudioStreamProperty.Builder

Properties of the audio stream.

Protobuf type google.cloud.video.livestream.v1.AudioStreamProperty

Channel

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

Channel.Builder

Protobuf type google.cloud.video.livestream.v1.Channel

Channel.Output

Location of output file(s) in a Google Cloud Storage bucket.

Protobuf type google.cloud.video.livestream.v1.Channel.Output

Channel.Output.Builder

Location of output file(s) in a Google Cloud Storage bucket.

Protobuf type google.cloud.video.livestream.v1.Channel.Output

ChannelName

ChannelName.Builder

Builder for projects/{project}/locations/{location}/channels/{channel}.

ChannelOperationResponse

Response message for Start/Stop Channel long-running operations.

Protobuf type google.cloud.video.livestream.v1.ChannelOperationResponse

ChannelOperationResponse.Builder

Response message for Start/Stop Channel long-running operations.

Protobuf type google.cloud.video.livestream.v1.ChannelOperationResponse

CreateChannelRequest

Request message for "LivestreamService.CreateChannel".

Protobuf type google.cloud.video.livestream.v1.CreateChannelRequest

CreateChannelRequest.Builder

Request message for "LivestreamService.CreateChannel".

Protobuf type google.cloud.video.livestream.v1.CreateChannelRequest

CreateEventRequest

Request message for "LivestreamService.CreateEvent".

Protobuf type google.cloud.video.livestream.v1.CreateEventRequest

CreateEventRequest.Builder

Request message for "LivestreamService.CreateEvent".

Protobuf type google.cloud.video.livestream.v1.CreateEventRequest

CreateInputRequest

Request message for "LivestreamService.CreateInput".

Protobuf type google.cloud.video.livestream.v1.CreateInputRequest

CreateInputRequest.Builder

Request message for "LivestreamService.CreateInput".

Protobuf type google.cloud.video.livestream.v1.CreateInputRequest

DeleteChannelRequest

Request message for "LivestreamService.DeleteChannel".

Protobuf type google.cloud.video.livestream.v1.DeleteChannelRequest

DeleteChannelRequest.Builder

Request message for "LivestreamService.DeleteChannel".

Protobuf type google.cloud.video.livestream.v1.DeleteChannelRequest

DeleteEventRequest

Request message for "LivestreamService.DeleteEvent".

Protobuf type google.cloud.video.livestream.v1.DeleteEventRequest

DeleteEventRequest.Builder

Request message for "LivestreamService.DeleteEvent".

Protobuf type google.cloud.video.livestream.v1.DeleteEventRequest

DeleteInputRequest

Request message for "LivestreamService.DeleteInput".

Protobuf type google.cloud.video.livestream.v1.DeleteInputRequest

DeleteInputRequest.Builder

Request message for "LivestreamService.DeleteInput".

Protobuf type google.cloud.video.livestream.v1.DeleteInputRequest

ElementaryStream

Encoding of an input element such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.

Protobuf type google.cloud.video.livestream.v1.ElementaryStream

ElementaryStream.Builder

Encoding of an input element such as an audio, video, or text track. Elementary streams must be packaged before mapping and sharing between different output formats.

Protobuf type google.cloud.video.livestream.v1.ElementaryStream

Event

Event is a sub-resource of a channel, which can be scheduled by the user to execute operations on a channel resource without having to stop the channel.

Protobuf type google.cloud.video.livestream.v1.Event

Event.AdBreakTask

Inserts a new ad opportunity.

Protobuf type google.cloud.video.livestream.v1.Event.AdBreakTask

Event.AdBreakTask.Builder

Inserts a new ad opportunity.

Protobuf type google.cloud.video.livestream.v1.Event.AdBreakTask

Event.Builder

Event is a sub-resource of a channel, which can be scheduled by the user to execute operations on a channel resource without having to stop the channel.

Protobuf type google.cloud.video.livestream.v1.Event

EventName

EventName.Builder

Builder for projects/{project}/locations/{location}/channels/{channel}/events/{event}.

GetChannelRequest

Request message for "LivestreamService.GetChannel".

Protobuf type google.cloud.video.livestream.v1.GetChannelRequest

GetChannelRequest.Builder

Request message for "LivestreamService.GetChannel".

Protobuf type google.cloud.video.livestream.v1.GetChannelRequest

GetEventRequest

Request message for "LivestreamService.GetEvent".

Protobuf type google.cloud.video.livestream.v1.GetEventRequest

GetEventRequest.Builder

Request message for "LivestreamService.GetEvent".

Protobuf type google.cloud.video.livestream.v1.GetEventRequest

GetInputRequest

Request message for "LivestreamService.GetInput".

Protobuf type google.cloud.video.livestream.v1.GetInputRequest

GetInputRequest.Builder

Request message for "LivestreamService.GetInput".

Protobuf type google.cloud.video.livestream.v1.GetInputRequest

Input

Input resource represents the endpoint from which the channel ingests the input stream.

Protobuf type google.cloud.video.livestream.v1.Input

Input.Builder

Input resource represents the endpoint from which the channel ingests the input stream.

Protobuf type google.cloud.video.livestream.v1.Input

Input.SecurityRule

Security rules for access control. Each field represents one security rule. Only when the source of the input stream satisfies all the fields, this input stream can be accepted.

Protobuf type google.cloud.video.livestream.v1.Input.SecurityRule

Input.SecurityRule.Builder

Security rules for access control. Each field represents one security rule. Only when the source of the input stream satisfies all the fields, this input stream can be accepted.

Protobuf type google.cloud.video.livestream.v1.Input.SecurityRule

InputAttachment

A group of information for attaching an input resource to this channel.

Protobuf type google.cloud.video.livestream.v1.InputAttachment

InputAttachment.AutomaticFailover

Configurations to follow when automatic failover happens.

Protobuf type google.cloud.video.livestream.v1.InputAttachment.AutomaticFailover

InputAttachment.AutomaticFailover.Builder

Configurations to follow when automatic failover happens.

Protobuf type google.cloud.video.livestream.v1.InputAttachment.AutomaticFailover

InputAttachment.Builder

A group of information for attaching an input resource to this channel.

Protobuf type google.cloud.video.livestream.v1.InputAttachment

InputName

InputName.Builder

Builder for projects/{project}/locations/{location}/inputs/{input}.

InputStreamProperty

Properties of the input stream.

Protobuf type google.cloud.video.livestream.v1.InputStreamProperty

InputStreamProperty.Builder

Properties of the input stream.

Protobuf type google.cloud.video.livestream.v1.InputStreamProperty

ListChannelsRequest

Request message for "LivestreamService.ListChannels".

Protobuf type google.cloud.video.livestream.v1.ListChannelsRequest

ListChannelsRequest.Builder

Request message for "LivestreamService.ListChannels".

Protobuf type google.cloud.video.livestream.v1.ListChannelsRequest

ListChannelsResponse

Response message for "LivestreamService.ListChannels".

Protobuf type google.cloud.video.livestream.v1.ListChannelsResponse

ListChannelsResponse.Builder

Response message for "LivestreamService.ListChannels".

Protobuf type google.cloud.video.livestream.v1.ListChannelsResponse

ListEventsRequest

Request message for "LivestreamService.ListEvents".

Protobuf type google.cloud.video.livestream.v1.ListEventsRequest

ListEventsRequest.Builder

Request message for "LivestreamService.ListEvents".

Protobuf type google.cloud.video.livestream.v1.ListEventsRequest

ListEventsResponse

Response message for "LivestreamService.ListEvents".

Protobuf type google.cloud.video.livestream.v1.ListEventsResponse

ListEventsResponse.Builder

Response message for "LivestreamService.ListEvents".

Protobuf type google.cloud.video.livestream.v1.ListEventsResponse

ListInputsRequest

Request message for "LivestreamService.ListInputs".

Protobuf type google.cloud.video.livestream.v1.ListInputsRequest

ListInputsRequest.Builder

Request message for "LivestreamService.ListInputs".

Protobuf type google.cloud.video.livestream.v1.ListInputsRequest

ListInputsResponse

Response message for "LivestreamService.ListInputs".

Protobuf type google.cloud.video.livestream.v1.ListInputsResponse

ListInputsResponse.Builder

Response message for "LivestreamService.ListInputs".

Protobuf type google.cloud.video.livestream.v1.ListInputsResponse

LivestreamServiceClient

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (LivestreamServiceClient livestreamServiceClient = LivestreamServiceClient.create()) {
   ChannelName name = ChannelName.of("[PROJECT]", "[LOCATION]", "[CHANNEL]");
   Channel response = livestreamServiceClient.getChannel(name);
 }

Note: close() needs to be called on the LivestreamServiceClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of LivestreamServiceSettings to create(). For example:

To customize credentials:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 LivestreamServiceSettings livestreamServiceSettings =
     LivestreamServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LivestreamServiceClient livestreamServiceClient =
     LivestreamServiceClient.create(livestreamServiceSettings);

To customize the endpoint:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 LivestreamServiceSettings livestreamServiceSettings =
     LivestreamServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 LivestreamServiceClient livestreamServiceClient =
     LivestreamServiceClient.create(livestreamServiceSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 LivestreamServiceSettings livestreamServiceSettings =
     LivestreamServiceSettings.newHttpJsonBuilder().build();
 LivestreamServiceClient livestreamServiceClient =
     LivestreamServiceClient.create(livestreamServiceSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

LivestreamServiceClient.ListChannelsFixedSizeCollection

LivestreamServiceClient.ListChannelsPage

LivestreamServiceClient.ListChannelsPagedResponse

LivestreamServiceClient.ListEventsFixedSizeCollection

LivestreamServiceClient.ListEventsPage

LivestreamServiceClient.ListEventsPagedResponse

LivestreamServiceClient.ListInputsFixedSizeCollection

LivestreamServiceClient.ListInputsPage

LivestreamServiceClient.ListInputsPagedResponse

LivestreamServiceGrpc

Using Live Stream API, you can generate live streams in the various renditions and streaming formats. The streaming format include HTTP Live Streaming (HLS) and Dynamic Adaptive Streaming over HTTP (DASH). You can send a source stream in the various ways, including Real-Time Messaging Protocol (RTMP) and Secure Reliable Transport (SRT).

LivestreamServiceGrpc.LivestreamServiceBlockingStub

LivestreamServiceGrpc.LivestreamServiceFutureStub

LivestreamServiceGrpc.LivestreamServiceImplBase

LivestreamServiceGrpc.LivestreamServiceStub

LivestreamServiceSettings

Settings class to configure an instance of LivestreamServiceClient.

The default instance has everything set to sensible defaults:

The default service address (livestream.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getChannel to 30 seconds:


 // This snippet has been automatically generated and should be regarded as a code template only.
 // It will require modifications to work:
 // - It may require correct/in-range values for request initialization.
 // - It may require specifying regional endpoints when creating the service client as shown in
 // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 LivestreamServiceSettings.Builder livestreamServiceSettingsBuilder =
     LivestreamServiceSettings.newBuilder();
 livestreamServiceSettingsBuilder
     .getChannelSettings()
     .setRetrySettings(
         livestreamServiceSettingsBuilder
             .getChannelSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 LivestreamServiceSettings livestreamServiceSettings = livestreamServiceSettingsBuilder.build();

LivestreamServiceSettings.Builder

Builder for LivestreamServiceSettings.

LocationName

LocationName.Builder

Builder for projects/{project}/locations/{location}.

LogConfig

Configuration of platform logs. See Using and managing platform logs for more information about how to view platform logs through Cloud Logging.

Protobuf type google.cloud.video.livestream.v1.LogConfig

LogConfig.Builder

Configuration of platform logs. See Using and managing platform logs for more information about how to view platform logs through Cloud Logging.

Protobuf type google.cloud.video.livestream.v1.LogConfig

Manifest

Manifest configuration.

Protobuf type google.cloud.video.livestream.v1.Manifest

Manifest.Builder

Manifest configuration.

Protobuf type google.cloud.video.livestream.v1.Manifest

MuxStream

Multiplexing settings for output stream.

Protobuf type google.cloud.video.livestream.v1.MuxStream

MuxStream.Builder

Multiplexing settings for output stream.

Protobuf type google.cloud.video.livestream.v1.MuxStream

OperationMetadata

Represents the metadata of the long-running operation.

Protobuf type google.cloud.video.livestream.v1.OperationMetadata

OperationMetadata.Builder

Represents the metadata of the long-running operation.

Protobuf type google.cloud.video.livestream.v1.OperationMetadata

OutputsProto

PreprocessingConfig

Preprocessing configurations.

Protobuf type google.cloud.video.livestream.v1.PreprocessingConfig

PreprocessingConfig.Builder

Preprocessing configurations.

Protobuf type google.cloud.video.livestream.v1.PreprocessingConfig

PreprocessingConfig.Crop

Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution.

Protobuf type google.cloud.video.livestream.v1.PreprocessingConfig.Crop

PreprocessingConfig.Crop.Builder

Video cropping configuration for the input video. The cropped input video is scaled to match the output resolution.

Protobuf type google.cloud.video.livestream.v1.PreprocessingConfig.Crop

PreprocessingConfig.Pad

Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution.

Protobuf type google.cloud.video.livestream.v1.PreprocessingConfig.Pad

PreprocessingConfig.Pad.Builder

Pad filter configuration for the input video. The padded input video is scaled after padding with black to match the output resolution.

Protobuf type google.cloud.video.livestream.v1.PreprocessingConfig.Pad

ResourcesProto

SegmentSettings

Segment settings for fmp4 and ts.

Protobuf type google.cloud.video.livestream.v1.SegmentSettings

SegmentSettings.Builder

Segment settings for fmp4 and ts.

Protobuf type google.cloud.video.livestream.v1.SegmentSettings

ServiceProto

SpriteSheet

Sprite sheet configuration.

Protobuf type google.cloud.video.livestream.v1.SpriteSheet

SpriteSheet.Builder

Sprite sheet configuration.

Protobuf type google.cloud.video.livestream.v1.SpriteSheet

StartChannelRequest

Request message for "LivestreamService.StartChannel".

Protobuf type google.cloud.video.livestream.v1.StartChannelRequest

StartChannelRequest.Builder

Request message for "LivestreamService.StartChannel".

Protobuf type google.cloud.video.livestream.v1.StartChannelRequest

StopChannelRequest

Request message for "LivestreamService.StopChannel".

Protobuf type google.cloud.video.livestream.v1.StopChannelRequest

StopChannelRequest.Builder

Request message for "LivestreamService.StopChannel".

Protobuf type google.cloud.video.livestream.v1.StopChannelRequest

TextStream

Encoding of a text stream. For example, closed captions or subtitles.

Protobuf type google.cloud.video.livestream.v1.TextStream

TextStream.Builder

Encoding of a text stream. For example, closed captions or subtitles.

Protobuf type google.cloud.video.livestream.v1.TextStream

UpdateChannelRequest

Request message for "LivestreamService.UpdateChannel".

Protobuf type google.cloud.video.livestream.v1.UpdateChannelRequest

UpdateChannelRequest.Builder

Request message for "LivestreamService.UpdateChannel".

Protobuf type google.cloud.video.livestream.v1.UpdateChannelRequest

UpdateInputRequest

Request message for "LivestreamService.UpdateInput".

Protobuf type google.cloud.video.livestream.v1.UpdateInputRequest

UpdateInputRequest.Builder

Request message for "LivestreamService.UpdateInput".

Protobuf type google.cloud.video.livestream.v1.UpdateInputRequest

VideoFormat

Properties of the video format.

Protobuf type google.cloud.video.livestream.v1.VideoFormat

VideoFormat.Builder

Properties of the video format.

Protobuf type google.cloud.video.livestream.v1.VideoFormat

VideoStream

Video stream resource.

Protobuf type google.cloud.video.livestream.v1.VideoStream

VideoStream.Builder

Video stream resource.

Protobuf type google.cloud.video.livestream.v1.VideoStream

VideoStream.H264CodecSettings

H264 codec settings.

Protobuf type google.cloud.video.livestream.v1.VideoStream.H264CodecSettings

VideoStream.H264CodecSettings.Builder

H264 codec settings.

Protobuf type google.cloud.video.livestream.v1.VideoStream.H264CodecSettings

VideoStreamProperty

Properties of the video stream.

Protobuf type google.cloud.video.livestream.v1.VideoStreamProperty

VideoStreamProperty.Builder

Properties of the video stream.

Protobuf type google.cloud.video.livestream.v1.VideoStreamProperty

Interfaces

AudioFormatOrBuilder

AudioStream.AudioMappingOrBuilder

AudioStreamOrBuilder

AudioStreamPropertyOrBuilder

Channel.OutputOrBuilder

ChannelOperationResponseOrBuilder

ChannelOrBuilder

CreateChannelRequestOrBuilder

CreateEventRequestOrBuilder

CreateInputRequestOrBuilder

DeleteChannelRequestOrBuilder

DeleteEventRequestOrBuilder

DeleteInputRequestOrBuilder

ElementaryStreamOrBuilder

Event.AdBreakTaskOrBuilder

EventOrBuilder

GetChannelRequestOrBuilder

GetEventRequestOrBuilder

GetInputRequestOrBuilder

Input.SecurityRuleOrBuilder

InputAttachment.AutomaticFailoverOrBuilder

InputAttachmentOrBuilder

InputOrBuilder

InputStreamPropertyOrBuilder

ListChannelsRequestOrBuilder

ListChannelsResponseOrBuilder

ListEventsRequestOrBuilder

ListEventsResponseOrBuilder

ListInputsRequestOrBuilder

ListInputsResponseOrBuilder

LogConfigOrBuilder

ManifestOrBuilder

MuxStreamOrBuilder

OperationMetadataOrBuilder

PreprocessingConfig.CropOrBuilder

PreprocessingConfig.PadOrBuilder

PreprocessingConfigOrBuilder

SegmentSettingsOrBuilder

SpriteSheetOrBuilder

StartChannelRequestOrBuilder

StopChannelRequestOrBuilder

TextStreamOrBuilder

UpdateChannelRequestOrBuilder

UpdateInputRequestOrBuilder

VideoFormatOrBuilder

VideoStream.H264CodecSettingsOrBuilder

VideoStreamOrBuilder

VideoStreamPropertyOrBuilder

Enums

Channel.StreamingState

State of streaming operation that the channel is running.

Protobuf enum google.cloud.video.livestream.v1.Channel.StreamingState

ElementaryStream.ElementaryStreamCase

Event.State

State of the event

Protobuf enum google.cloud.video.livestream.v1.Event.State

Event.TaskCase

Input.Tier

Tier of the input specification.

Protobuf enum google.cloud.video.livestream.v1.Input.Tier

Input.Type

The type of the input.

Protobuf enum google.cloud.video.livestream.v1.Input.Type

LogConfig.LogSeverity

The severity level of platform logging for this channel. Logs with a severity level higher than or equal to the chosen severity level will be logged and can be viewed through Cloud Logging. The severity level of a log is ranked as followed from low to high: DEBUG < INFO < NOTICE < WARNING < ERROR < CRITICAL < ALERT < EMERGENCY. See LogSeverity for more information.

Protobuf enum google.cloud.video.livestream.v1.LogConfig.LogSeverity