Package com.google.cloud.video.stitcher.v1 (0.8.0)

A client to Video Stitcher API

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

VideoStitcherServiceClient

Service Description: Video-On-Demand content stitching API allows you to insert ads into (VoD) video on demand files. You will be able to render custom scrubber bars with highlighted ads, enforce ad policies, allow seamless playback and tracking on native players and monetize content with any standard VMAP compliant ad server.

Sample for VideoStitcherServiceClient:


 // 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 (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   CdnKey cdnKey = CdnKey.newBuilder().build();
   String cdnKeyId = "cdnKeyId-1777782867";
   CdnKey response = videoStitcherServiceClient.createCdnKey(parent, cdnKey, cdnKeyId);
 }

Classes

AdRequest

Details of an ad request to an ad server.

Protobuf type google.cloud.video.stitcher.v1.AdRequest

AdRequest.Builder

Details of an ad request to an ad server.

Protobuf type google.cloud.video.stitcher.v1.AdRequest

AdStitchDetail

Metadata for a stitched ad.

Protobuf type google.cloud.video.stitcher.v1.AdStitchDetail

AdStitchDetail.Builder

Metadata for a stitched ad.

Protobuf type google.cloud.video.stitcher.v1.AdStitchDetail

AdTag

Metadata of an ad tag.

Protobuf type google.cloud.video.stitcher.v1.AdTag

AdTag.Builder

Metadata of an ad tag.

Protobuf type google.cloud.video.stitcher.v1.AdTag

AdTagDetailsProto

AkamaiCdnKey

Configuration for an Akamai CDN key.

Protobuf type google.cloud.video.stitcher.v1.AkamaiCdnKey

AkamaiCdnKey.Builder

Configuration for an Akamai CDN key.

Protobuf type google.cloud.video.stitcher.v1.AkamaiCdnKey

CdnKey

Configuration for a CDN key. Used by the Video Stitcher to sign URIs for fetching video manifests and signing media segments for playback.

Protobuf type google.cloud.video.stitcher.v1.CdnKey

CdnKey.Builder

Configuration for a CDN key. Used by the Video Stitcher to sign URIs for fetching video manifests and signing media segments for playback.

Protobuf type google.cloud.video.stitcher.v1.CdnKey

CdnKeyName

CdnKeyName.Builder

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

CdnKeysProto

Companion

Metadata for a companion.

Protobuf type google.cloud.video.stitcher.v1.Companion

Companion.Builder

Metadata for a companion.

Protobuf type google.cloud.video.stitcher.v1.Companion

CompanionAds

Metadata for companion ads.

Protobuf type google.cloud.video.stitcher.v1.CompanionAds

CompanionAds.Builder

Metadata for companion ads.

Protobuf type google.cloud.video.stitcher.v1.CompanionAds

CompanionsProto

CreateCdnKeyRequest

Request message for VideoStitcherService.createCdnKey.

Protobuf type google.cloud.video.stitcher.v1.CreateCdnKeyRequest

CreateCdnKeyRequest.Builder

Request message for VideoStitcherService.createCdnKey.

Protobuf type google.cloud.video.stitcher.v1.CreateCdnKeyRequest

CreateLiveSessionRequest

Request message for VideoStitcherService.createLiveSession.

Protobuf type google.cloud.video.stitcher.v1.CreateLiveSessionRequest

CreateLiveSessionRequest.Builder

Request message for VideoStitcherService.createLiveSession.

Protobuf type google.cloud.video.stitcher.v1.CreateLiveSessionRequest

CreateSlateRequest

Request message for VideoStitcherService.createSlate.

Protobuf type google.cloud.video.stitcher.v1.CreateSlateRequest

CreateSlateRequest.Builder

Request message for VideoStitcherService.createSlate.

Protobuf type google.cloud.video.stitcher.v1.CreateSlateRequest

CreateVodSessionRequest

Request message for VideoStitcherService.createVodSession

Protobuf type google.cloud.video.stitcher.v1.CreateVodSessionRequest

CreateVodSessionRequest.Builder

Request message for VideoStitcherService.createVodSession

Protobuf type google.cloud.video.stitcher.v1.CreateVodSessionRequest

DeleteCdnKeyRequest

Request message for VideoStitcherService.deleteCdnKey.

Protobuf type google.cloud.video.stitcher.v1.DeleteCdnKeyRequest

DeleteCdnKeyRequest.Builder

Request message for VideoStitcherService.deleteCdnKey.

Protobuf type google.cloud.video.stitcher.v1.DeleteCdnKeyRequest

DeleteSlateRequest

Request message for VideoStitcherService.deleteSlate.

Protobuf type google.cloud.video.stitcher.v1.DeleteSlateRequest

DeleteSlateRequest.Builder

Request message for VideoStitcherService.deleteSlate.

Protobuf type google.cloud.video.stitcher.v1.DeleteSlateRequest

Event

Describes an event and a trigger URI.

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

Event.Builder

Describes an event and a trigger URI.

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

EventsProto

GetCdnKeyRequest

Request message for VideoStitcherService.getCdnKey.

Protobuf type google.cloud.video.stitcher.v1.GetCdnKeyRequest

GetCdnKeyRequest.Builder

Request message for VideoStitcherService.getCdnKey.

Protobuf type google.cloud.video.stitcher.v1.GetCdnKeyRequest

GetLiveAdTagDetailRequest

Request message for VideoStitcherService.getLiveAdTagDetail

Protobuf type google.cloud.video.stitcher.v1.GetLiveAdTagDetailRequest

GetLiveAdTagDetailRequest.Builder

Request message for VideoStitcherService.getLiveAdTagDetail

Protobuf type google.cloud.video.stitcher.v1.GetLiveAdTagDetailRequest

GetLiveSessionRequest

Request message for VideoStitcherService.getSession.

Protobuf type google.cloud.video.stitcher.v1.GetLiveSessionRequest

GetLiveSessionRequest.Builder

Request message for VideoStitcherService.getSession.

Protobuf type google.cloud.video.stitcher.v1.GetLiveSessionRequest

GetSlateRequest

Request message for VideoStitcherService.getSlate.

Protobuf type google.cloud.video.stitcher.v1.GetSlateRequest

GetSlateRequest.Builder

Request message for VideoStitcherService.getSlate.

Protobuf type google.cloud.video.stitcher.v1.GetSlateRequest

GetVodAdTagDetailRequest

Request message for VideoStitcherService.getVodAdTagDetail

Protobuf type google.cloud.video.stitcher.v1.GetVodAdTagDetailRequest

GetVodAdTagDetailRequest.Builder

Request message for VideoStitcherService.getVodAdTagDetail

Protobuf type google.cloud.video.stitcher.v1.GetVodAdTagDetailRequest

GetVodSessionRequest

Request message for VideoStitcherService.getVodSession

Protobuf type google.cloud.video.stitcher.v1.GetVodSessionRequest

GetVodSessionRequest.Builder

Request message for VideoStitcherService.getVodSession

Protobuf type google.cloud.video.stitcher.v1.GetVodSessionRequest

GetVodStitchDetailRequest

Request message for VideoStitcherService.getVodStitchDetail.

Protobuf type google.cloud.video.stitcher.v1.GetVodStitchDetailRequest

GetVodStitchDetailRequest.Builder

Request message for VideoStitcherService.getVodStitchDetail.

Protobuf type google.cloud.video.stitcher.v1.GetVodStitchDetailRequest

GoogleCdnKey

Configuration for a Google Cloud CDN key.

Protobuf type google.cloud.video.stitcher.v1.GoogleCdnKey

GoogleCdnKey.Builder

Configuration for a Google Cloud CDN key.

Protobuf type google.cloud.video.stitcher.v1.GoogleCdnKey

HtmlAdResource

Metadata for an HTML ad resource.

Protobuf type google.cloud.video.stitcher.v1.HtmlAdResource

HtmlAdResource.Builder

Metadata for an HTML ad resource.

Protobuf type google.cloud.video.stitcher.v1.HtmlAdResource

IframeAdResource

Metadata for an IFrame ad resource.

Protobuf type google.cloud.video.stitcher.v1.IframeAdResource

IframeAdResource.Builder

Metadata for an IFrame ad resource.

Protobuf type google.cloud.video.stitcher.v1.IframeAdResource

Interstitials

Describes what was stitched into a VOD session's manifest.

Protobuf type google.cloud.video.stitcher.v1.Interstitials

Interstitials.Builder

Describes what was stitched into a VOD session's manifest.

Protobuf type google.cloud.video.stitcher.v1.Interstitials

ListCdnKeysRequest

Request message for VideoStitcherService.listCdnKeys.

Protobuf type google.cloud.video.stitcher.v1.ListCdnKeysRequest

ListCdnKeysRequest.Builder

Request message for VideoStitcherService.listCdnKeys.

Protobuf type google.cloud.video.stitcher.v1.ListCdnKeysRequest

ListCdnKeysResponse

Response message for VideoStitcher.ListCdnKeys.

Protobuf type google.cloud.video.stitcher.v1.ListCdnKeysResponse

ListCdnKeysResponse.Builder

Response message for VideoStitcher.ListCdnKeys.

Protobuf type google.cloud.video.stitcher.v1.ListCdnKeysResponse

ListLiveAdTagDetailsRequest

Request message for VideoStitcherService.listLiveAdTagDetails.

Protobuf type google.cloud.video.stitcher.v1.ListLiveAdTagDetailsRequest

ListLiveAdTagDetailsRequest.Builder

Request message for VideoStitcherService.listLiveAdTagDetails.

Protobuf type google.cloud.video.stitcher.v1.ListLiveAdTagDetailsRequest

ListLiveAdTagDetailsResponse

Response message for VideoStitcherService.listLiveAdTagDetails.

Protobuf type google.cloud.video.stitcher.v1.ListLiveAdTagDetailsResponse

ListLiveAdTagDetailsResponse.Builder

Response message for VideoStitcherService.listLiveAdTagDetails.

Protobuf type google.cloud.video.stitcher.v1.ListLiveAdTagDetailsResponse

ListSlatesRequest

Request message for VideoStitcherService.listSlates.

Protobuf type google.cloud.video.stitcher.v1.ListSlatesRequest

ListSlatesRequest.Builder

Request message for VideoStitcherService.listSlates.

Protobuf type google.cloud.video.stitcher.v1.ListSlatesRequest

ListSlatesResponse

Response message for VideoStitcherService.listSlates.

Protobuf type google.cloud.video.stitcher.v1.ListSlatesResponse

ListSlatesResponse.Builder

Response message for VideoStitcherService.listSlates.

Protobuf type google.cloud.video.stitcher.v1.ListSlatesResponse

ListVodAdTagDetailsRequest

Request message for VideoStitcherService.listVodAdTagDetails.

Protobuf type google.cloud.video.stitcher.v1.ListVodAdTagDetailsRequest

ListVodAdTagDetailsRequest.Builder

Request message for VideoStitcherService.listVodAdTagDetails.

Protobuf type google.cloud.video.stitcher.v1.ListVodAdTagDetailsRequest

ListVodAdTagDetailsResponse

Response message for VideoStitcherService.listVodAdTagDetails.

Protobuf type google.cloud.video.stitcher.v1.ListVodAdTagDetailsResponse

ListVodAdTagDetailsResponse.Builder

Response message for VideoStitcherService.listVodAdTagDetails.

Protobuf type google.cloud.video.stitcher.v1.ListVodAdTagDetailsResponse

ListVodStitchDetailsRequest

Request message for VideoStitcherService.listVodStitchDetails.

Protobuf type google.cloud.video.stitcher.v1.ListVodStitchDetailsRequest

ListVodStitchDetailsRequest.Builder

Request message for VideoStitcherService.listVodStitchDetails.

Protobuf type google.cloud.video.stitcher.v1.ListVodStitchDetailsRequest

ListVodStitchDetailsResponse

Response message for VideoStitcherService.listVodStitchDetails.

Protobuf type google.cloud.video.stitcher.v1.ListVodStitchDetailsResponse

ListVodStitchDetailsResponse.Builder

Response message for VideoStitcherService.listVodStitchDetails.

Protobuf type google.cloud.video.stitcher.v1.ListVodStitchDetailsResponse

LiveAdTagDetail

Container for a live session's ad tag detail.

Protobuf type google.cloud.video.stitcher.v1.LiveAdTagDetail

LiveAdTagDetail.Builder

Container for a live session's ad tag detail.

Protobuf type google.cloud.video.stitcher.v1.LiveAdTagDetail

LiveAdTagDetailName

LiveAdTagDetailName.Builder

Builder for projects/{project}/locations/{location}/liveSessions/{live_session}/liveAdTagDetails/{live_ad_tag_detail}.

LiveSession

Metadata for a live session.

Protobuf type google.cloud.video.stitcher.v1.LiveSession

LiveSession.Builder

Metadata for a live session.

Protobuf type google.cloud.video.stitcher.v1.LiveSession

LiveSessionName

LiveSessionName.Builder

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

LocationName

LocationName.Builder

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

ManifestOptions

Options for manifest generation.

Protobuf type google.cloud.video.stitcher.v1.ManifestOptions

ManifestOptions.Builder

Options for manifest generation.

Protobuf type google.cloud.video.stitcher.v1.ManifestOptions

MediaCdnKey

Configuration for a Media CDN key.

Protobuf type google.cloud.video.stitcher.v1.MediaCdnKey

MediaCdnKey.Builder

Configuration for a Media CDN key.

Protobuf type google.cloud.video.stitcher.v1.MediaCdnKey

ProgressEvent

Indicates a time in which a list of events should be triggered during media playback.

Protobuf type google.cloud.video.stitcher.v1.ProgressEvent

ProgressEvent.Builder

Indicates a time in which a list of events should be triggered during media playback.

Protobuf type google.cloud.video.stitcher.v1.ProgressEvent

RenditionFilter

Filters for a video or muxed redition.

Protobuf type google.cloud.video.stitcher.v1.RenditionFilter

RenditionFilter.Builder

Filters for a video or muxed redition.

Protobuf type google.cloud.video.stitcher.v1.RenditionFilter

RequestMetadata

Metadata for an ad request.

Protobuf type google.cloud.video.stitcher.v1.RequestMetadata

RequestMetadata.Builder

Metadata for an ad request.

Protobuf type google.cloud.video.stitcher.v1.RequestMetadata

ResponseMetadata

Metadata for the response of an ad request.

Protobuf type google.cloud.video.stitcher.v1.ResponseMetadata

ResponseMetadata.Builder

Metadata for the response of an ad request.

Protobuf type google.cloud.video.stitcher.v1.ResponseMetadata

SessionsProto

Slate

Slate object

Protobuf type google.cloud.video.stitcher.v1.Slate

Slate.Builder

Slate object

Protobuf type google.cloud.video.stitcher.v1.Slate

SlateName

SlateName.Builder

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

SlatesProto

StaticAdResource

Metadata for a static ad resource.

Protobuf type google.cloud.video.stitcher.v1.StaticAdResource

StaticAdResource.Builder

Metadata for a static ad resource.

Protobuf type google.cloud.video.stitcher.v1.StaticAdResource

StitchDetailsProto

UpdateCdnKeyRequest

Request message for VideoStitcherService.updateCdnKey.

Protobuf type google.cloud.video.stitcher.v1.UpdateCdnKeyRequest

UpdateCdnKeyRequest.Builder

Request message for VideoStitcherService.updateCdnKey.

Protobuf type google.cloud.video.stitcher.v1.UpdateCdnKeyRequest

UpdateSlateRequest

Request message for VideoStitcherService.updateSlate.

Protobuf type google.cloud.video.stitcher.v1.UpdateSlateRequest

UpdateSlateRequest.Builder

Request message for VideoStitcherService.updateSlate.

Protobuf type google.cloud.video.stitcher.v1.UpdateSlateRequest

VideoStitcherServiceClient

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 (VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   CdnKey cdnKey = CdnKey.newBuilder().build();
   String cdnKeyId = "cdnKeyId-1777782867";
   CdnKey response = videoStitcherServiceClient.createCdnKey(parent, cdnKey, cdnKeyId);
 }

Note: close() needs to be called on the VideoStitcherServiceClient 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 VideoStitcherServiceSettings 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
 VideoStitcherServiceSettings videoStitcherServiceSettings =
     VideoStitcherServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create(videoStitcherServiceSettings);

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
 VideoStitcherServiceSettings videoStitcherServiceSettings =
     VideoStitcherServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 VideoStitcherServiceClient videoStitcherServiceClient =
     VideoStitcherServiceClient.create(videoStitcherServiceSettings);

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

VideoStitcherServiceClient.ListCdnKeysFixedSizeCollection

VideoStitcherServiceClient.ListCdnKeysPage

VideoStitcherServiceClient.ListCdnKeysPagedResponse

VideoStitcherServiceClient.ListLiveAdTagDetailsFixedSizeCollection

VideoStitcherServiceClient.ListLiveAdTagDetailsPage

VideoStitcherServiceClient.ListLiveAdTagDetailsPagedResponse

VideoStitcherServiceClient.ListSlatesFixedSizeCollection

VideoStitcherServiceClient.ListSlatesPage

VideoStitcherServiceClient.ListSlatesPagedResponse

VideoStitcherServiceClient.ListVodAdTagDetailsFixedSizeCollection

VideoStitcherServiceClient.ListVodAdTagDetailsPage

VideoStitcherServiceClient.ListVodAdTagDetailsPagedResponse

VideoStitcherServiceClient.ListVodStitchDetailsFixedSizeCollection

VideoStitcherServiceClient.ListVodStitchDetailsPage

VideoStitcherServiceClient.ListVodStitchDetailsPagedResponse

VideoStitcherServiceGrpc

Video-On-Demand content stitching API allows you to insert ads into (VoD) video on demand files. You will be able to render custom scrubber bars with highlighted ads, enforce ad policies, allow seamless playback and tracking on native players and monetize content with any standard VMAP compliant ad server.

VideoStitcherServiceGrpc.VideoStitcherServiceBlockingStub

VideoStitcherServiceGrpc.VideoStitcherServiceFutureStub

VideoStitcherServiceGrpc.VideoStitcherServiceImplBase

VideoStitcherServiceGrpc.VideoStitcherServiceStub

VideoStitcherServiceProto

VideoStitcherServiceSettings

Settings class to configure an instance of VideoStitcherServiceClient.

The default instance has everything set to sensible defaults:

The default service address (videostitcher.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 createCdnKey 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
 VideoStitcherServiceSettings.Builder videoStitcherServiceSettingsBuilder =
     VideoStitcherServiceSettings.newBuilder();
 videoStitcherServiceSettingsBuilder
     .createCdnKeySettings()
     .setRetrySettings(
         videoStitcherServiceSettingsBuilder
             .createCdnKeySettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 VideoStitcherServiceSettings videoStitcherServiceSettings =
     videoStitcherServiceSettingsBuilder.build();