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.
Equality
Instances of this class created via copy-construction or copy-assignment always compare equal. Instances created with equal std::shared_ptr<*Connection>
objects compare equal. Objects that compare equal share the same underlying resources.
Performance
Creating a new instance of this class is a relatively expensive operation, new objects establish new connections to the service. In contrast, copy-construction, move-construction, and the corresponding assignment operations are relatively efficient as the copies share all underlying resources.
Thread Safety
Concurrent access to different instances of this class, even if they compare equal, is guaranteed to work. Two or more threads operating on the same instance of this class is not guaranteed to work. Since copy-construction and move-construction is a relatively efficient operation, consider using such a copy when using this class from multiple threads.
Constructors
VideoStitcherServiceClient(VideoStitcherServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VideoStitcherServiceClient const &
|
VideoStitcherServiceClient(VideoStitcherServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VideoStitcherServiceClient &&
|
VideoStitcherServiceClient(std::shared_ptr< VideoStitcherServiceConnection >, Options)
Parameters | |
---|---|
Name | Description |
connection |
std::shared_ptr< VideoStitcherServiceConnection >
|
opts |
Options
|
Operators
operator=(VideoStitcherServiceClient const &)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VideoStitcherServiceClient const &
|
Returns | |
---|---|
Type | Description |
VideoStitcherServiceClient & |
operator=(VideoStitcherServiceClient &&)
Copy and move support
Parameter | |
---|---|
Name | Description |
|
VideoStitcherServiceClient &&
|
Returns | |
---|---|
Type | Description |
VideoStitcherServiceClient & |
Functions
CreateCdnKey(std::string const &, google::cloud::video::stitcher::v1::CdnKey const &, std::string const &, Options)
Creates a new CDN key.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project in which the CDN key should be created, in the form of |
cdn_key |
google::cloud::video::stitcher::v1::CdnKey const &
Required. The CDN key resource to create. |
cdn_key_id |
std::string const &
Required. The ID to use for the CDN key, which will become the final component of the CDN key's resource name. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::CdnKey > > |
A |
CreateCdnKey(NoAwaitTag, std::string const &, google::cloud::video::stitcher::v1::CdnKey const &, std::string const &, Options)
Creates a new CDN key.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
cdn_key |
google::cloud::video::stitcher::v1::CdnKey const &
|
cdn_key_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateCdnKey(google::cloud::video::stitcher::v1::CreateCdnKeyRequest const &, Options)
Creates a new CDN key.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::CreateCdnKeyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::CdnKey > > |
A |
CreateCdnKey(NoAwaitTag, google::cloud::video::stitcher::v1::CreateCdnKeyRequest const &, Options)
Creates a new CDN key.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::video::stitcher::v1::CreateCdnKeyRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateCdnKey(google::longrunning::Operation const &, Options)
Creates a new CDN key.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::CdnKey > > |
ListCdnKeys(std::string const &, Options)
Lists all CDN keys in the specified project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project that contains the list of CDN keys, in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::video::stitcher::v1::CdnKey > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListCdnKeys(google::cloud::video::stitcher::v1::ListCdnKeysRequest, Options)
Lists all CDN keys in the specified project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::ListCdnKeysRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::video::stitcher::v1::CdnKey > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetCdnKey(std::string const &, Options)
Returns the specified CDN key.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the CDN key to be retrieved, in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::CdnKey > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.CdnKey) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetCdnKey(google::cloud::video::stitcher::v1::GetCdnKeyRequest const &, Options)
Returns the specified CDN key.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::GetCdnKeyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::CdnKey > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.CdnKey) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteCdnKey(std::string const &, Options)
Deletes the specified CDN key.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the CDN key to be deleted, in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::OperationMetadata > > |
A |
DeleteCdnKey(NoAwaitTag, std::string const &, Options)
Deletes the specified CDN key.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteCdnKey(google::cloud::video::stitcher::v1::DeleteCdnKeyRequest const &, Options)
Deletes the specified CDN key.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::DeleteCdnKeyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::OperationMetadata > > |
A |
DeleteCdnKey(NoAwaitTag, google::cloud::video::stitcher::v1::DeleteCdnKeyRequest const &, Options)
Deletes the specified CDN key.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::video::stitcher::v1::DeleteCdnKeyRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteCdnKey(google::longrunning::Operation const &, Options)
Deletes the specified CDN key.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::OperationMetadata > > |
UpdateCdnKey(google::cloud::video::stitcher::v1::CdnKey const &, google::protobuf::FieldMask const &, Options)
Updates the specified CDN key.
Only update fields specified in the call method body.
Parameters | |
---|---|
Name | Description |
cdn_key |
google::cloud::video::stitcher::v1::CdnKey const &
Required. The CDN key resource which replaces the resource on the server. |
update_mask |
google::protobuf::FieldMask const &
Required. The update mask applies to the resource. For the |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::CdnKey > > |
A |
UpdateCdnKey(NoAwaitTag, google::cloud::video::stitcher::v1::CdnKey const &, google::protobuf::FieldMask const &, Options)
Updates the specified CDN key.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
cdn_key |
google::cloud::video::stitcher::v1::CdnKey const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateCdnKey(google::cloud::video::stitcher::v1::UpdateCdnKeyRequest const &, Options)
Updates the specified CDN key.
Only update fields specified in the call method body.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::UpdateCdnKeyRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::CdnKey > > |
A |
UpdateCdnKey(NoAwaitTag, google::cloud::video::stitcher::v1::UpdateCdnKeyRequest const &, Options)
Updates the specified CDN key.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::video::stitcher::v1::UpdateCdnKeyRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateCdnKey(google::longrunning::Operation const &, Options)
Updates the specified CDN key.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::CdnKey > > |
CreateVodSession(std::string const &, google::cloud::video::stitcher::v1::VodSession const &, Options)
Creates a client side playback VOD session and returns the full tracking and playback metadata of the session.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project and location in which the VOD session should be created, in the form of |
vod_session |
google::cloud::video::stitcher::v1::VodSession const &
Required. Parameters for creating a session. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::VodSession > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.VodSession) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateVodSession(google::cloud::video::stitcher::v1::CreateVodSessionRequest const &, Options)
Creates a client side playback VOD session and returns the full tracking and playback metadata of the session.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::CreateVodSessionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::VodSession > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.VodSession) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetVodSession(std::string const &, Options)
Returns the full tracking, playback metadata, and relevant ad-ops logs for the specified VOD session.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the VOD session to be retrieved, in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::VodSession > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.VodSession) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetVodSession(google::cloud::video::stitcher::v1::GetVodSessionRequest const &, Options)
Returns the full tracking, playback metadata, and relevant ad-ops logs for the specified VOD session.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::GetVodSessionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::VodSession > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.VodSession) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListVodStitchDetails(std::string const &, Options)
Returns a list of detailed stitching information of the specified VOD session.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The VOD session where the stitch details belong to, in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::video::stitcher::v1::VodStitchDetail > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListVodStitchDetails(google::cloud::video::stitcher::v1::ListVodStitchDetailsRequest, Options)
Returns a list of detailed stitching information of the specified VOD session.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::ListVodStitchDetailsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::video::stitcher::v1::VodStitchDetail > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetVodStitchDetail(std::string const &, Options)
Returns the specified stitching information for the specified VOD session.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the stitch detail in the specified VOD session, in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::VodStitchDetail > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.VodStitchDetail) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetVodStitchDetail(google::cloud::video::stitcher::v1::GetVodStitchDetailRequest const &, Options)
Returns the specified stitching information for the specified VOD session.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::GetVodStitchDetailRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::VodStitchDetail > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.VodStitchDetail) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListVodAdTagDetails(std::string const &, Options)
Return the list of ad tag details for the specified VOD session.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The VOD session which the ad tag details belong to, in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::video::stitcher::v1::VodAdTagDetail > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListVodAdTagDetails(google::cloud::video::stitcher::v1::ListVodAdTagDetailsRequest, Options)
Return the list of ad tag details for the specified VOD session.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::ListVodAdTagDetailsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::video::stitcher::v1::VodAdTagDetail > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetVodAdTagDetail(std::string const &, Options)
Returns the specified ad tag detail for the specified VOD session.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the ad tag detail for the specified VOD session, in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::VodAdTagDetail > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.VodAdTagDetail) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetVodAdTagDetail(google::cloud::video::stitcher::v1::GetVodAdTagDetailRequest const &, Options)
Returns the specified ad tag detail for the specified VOD session.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::GetVodAdTagDetailRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::VodAdTagDetail > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.VodAdTagDetail) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
ListLiveAdTagDetails(std::string const &, Options)
Return the list of ad tag details for the specified live session.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The resource parent in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::video::stitcher::v1::LiveAdTagDetail > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListLiveAdTagDetails(google::cloud::video::stitcher::v1::ListLiveAdTagDetailsRequest, Options)
Return the list of ad tag details for the specified live session.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::ListLiveAdTagDetailsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::video::stitcher::v1::LiveAdTagDetail > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLiveAdTagDetail(std::string const &, Options)
Returns the specified ad tag detail for the specified live session.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The resource name in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::LiveAdTagDetail > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.LiveAdTagDetail) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetLiveAdTagDetail(google::cloud::video::stitcher::v1::GetLiveAdTagDetailRequest const &, Options)
Returns the specified ad tag detail for the specified live session.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::GetLiveAdTagDetailRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::LiveAdTagDetail > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.LiveAdTagDetail) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateSlate(std::string const &, google::cloud::video::stitcher::v1::Slate const &, std::string const &, Options)
Creates a slate.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project in which the slate should be created, in the form of |
slate |
google::cloud::video::stitcher::v1::Slate const &
Required. The slate to create. |
slate_id |
std::string const &
Required. The unique identifier for the slate. This value should conform to RFC-1034, which restricts to lower-case letters, numbers, and hyphen, with the first character a letter, the last a letter or a number, and a 63 character maximum. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::Slate > > |
A |
CreateSlate(NoAwaitTag, std::string const &, google::cloud::video::stitcher::v1::Slate const &, std::string const &, Options)
Creates a slate.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
slate |
google::cloud::video::stitcher::v1::Slate const &
|
slate_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateSlate(google::cloud::video::stitcher::v1::CreateSlateRequest const &, Options)
Creates a slate.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::CreateSlateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::Slate > > |
A |
CreateSlate(NoAwaitTag, google::cloud::video::stitcher::v1::CreateSlateRequest const &, Options)
Creates a slate.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::video::stitcher::v1::CreateSlateRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateSlate(google::longrunning::Operation const &, Options)
Creates a slate.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::Slate > > |
ListSlates(std::string const &, Options)
Lists all slates in the specified project and location.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project to list slates, in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::video::stitcher::v1::Slate > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListSlates(google::cloud::video::stitcher::v1::ListSlatesRequest, Options)
Lists all slates in the specified project and location.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::ListSlatesRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::video::stitcher::v1::Slate > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetSlate(std::string const &, Options)
Returns the specified slate.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the slate to be retrieved, of the slate, in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::Slate > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.Slate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetSlate(google::cloud::video::stitcher::v1::GetSlateRequest const &, Options)
Returns the specified slate.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::GetSlateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::Slate > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.Slate) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
UpdateSlate(google::cloud::video::stitcher::v1::Slate const &, google::protobuf::FieldMask const &, Options)
Updates the specified slate.
Parameters | |
---|---|
Name | Description |
slate |
google::cloud::video::stitcher::v1::Slate const &
Required. The resource with updated fields. |
update_mask |
google::protobuf::FieldMask const &
Required. The update mask which specifies fields which should be updated. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::Slate > > |
A |
UpdateSlate(NoAwaitTag, google::cloud::video::stitcher::v1::Slate const &, google::protobuf::FieldMask const &, Options)
Updates the specified slate.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
slate |
google::cloud::video::stitcher::v1::Slate const &
|
update_mask |
google::protobuf::FieldMask const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateSlate(google::cloud::video::stitcher::v1::UpdateSlateRequest const &, Options)
Updates the specified slate.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::UpdateSlateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::Slate > > |
A |
UpdateSlate(NoAwaitTag, google::cloud::video::stitcher::v1::UpdateSlateRequest const &, Options)
Updates the specified slate.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::video::stitcher::v1::UpdateSlateRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
UpdateSlate(google::longrunning::Operation const &, Options)
Updates the specified slate.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::Slate > > |
DeleteSlate(std::string const &, Options)
Deletes the specified slate.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the slate to be deleted, in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::OperationMetadata > > |
A |
DeleteSlate(NoAwaitTag, std::string const &, Options)
Deletes the specified slate.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteSlate(google::cloud::video::stitcher::v1::DeleteSlateRequest const &, Options)
Deletes the specified slate.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::DeleteSlateRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::OperationMetadata > > |
A |
DeleteSlate(NoAwaitTag, google::cloud::video::stitcher::v1::DeleteSlateRequest const &, Options)
Deletes the specified slate.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::video::stitcher::v1::DeleteSlateRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
DeleteSlate(google::longrunning::Operation const &, Options)
Deletes the specified slate.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::OperationMetadata > > |
CreateLiveSession(std::string const &, google::cloud::video::stitcher::v1::LiveSession const &, Options)
Creates a new live session.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project and location in which the live session should be created, in the form of |
live_session |
google::cloud::video::stitcher::v1::LiveSession const &
Required. Parameters for creating a live session. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::LiveSession > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.LiveSession) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateLiveSession(google::cloud::video::stitcher::v1::CreateLiveSessionRequest const &, Options)
Creates a new live session.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::CreateLiveSessionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::LiveSession > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.LiveSession) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetLiveSession(std::string const &, Options)
Returns the details for the specified live session.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the live session, in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::LiveSession > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.LiveSession) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetLiveSession(google::cloud::video::stitcher::v1::GetLiveSessionRequest const &, Options)
Returns the details for the specified live session.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::GetLiveSessionRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::LiveSession > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.LiveSession) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
CreateLiveConfig(std::string const &, google::cloud::video::stitcher::v1::LiveConfig const &, std::string const &, Options)
Registers the live config with the provided unique ID in the specified region.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project in which the live config should be created, in the form of |
live_config |
google::cloud::video::stitcher::v1::LiveConfig const &
Required. The live config resource to create. |
live_config_id |
std::string const &
Required. The unique identifier ID to use for the live config. |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::LiveConfig > > |
A |
CreateLiveConfig(NoAwaitTag, std::string const &, google::cloud::video::stitcher::v1::LiveConfig const &, std::string const &, Options)
Registers the live config with the provided unique ID in the specified region.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
parent |
std::string const &
|
live_config |
google::cloud::video::stitcher::v1::LiveConfig const &
|
live_config_id |
std::string const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateLiveConfig(google::cloud::video::stitcher::v1::CreateLiveConfigRequest const &, Options)
Registers the live config with the provided unique ID in the specified region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::CreateLiveConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::LiveConfig > > |
A |
CreateLiveConfig(NoAwaitTag, google::cloud::video::stitcher::v1::CreateLiveConfigRequest const &, Options)
Registers the live config with the provided unique ID in the specified region.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
request |
google::cloud::video::stitcher::v1::CreateLiveConfigRequest const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
StatusOr< google::longrunning::Operation > |
CreateLiveConfig(google::longrunning::Operation const &, Options)
Registers the live config with the provided unique ID in the specified region.
This method accepts a google::longrunning::Operation
that corresponds to a previously started Long Running Operation (LRO) and polls the status of the LRO in the background.
Parameters | |
---|---|
Name | Description |
operation |
google::longrunning::Operation const &
|
opts |
Options
|
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::LiveConfig > > |
ListLiveConfigs(std::string const &, Options)
Lists all live configs managed by the Video Stitcher that belong to the specified project and region.
Parameters | |
---|---|
Name | Description |
parent |
std::string const &
Required. The project that contains the list of live configs, in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::video::stitcher::v1::LiveConfig > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
ListLiveConfigs(google::cloud::video::stitcher::v1::ListLiveConfigsRequest, Options)
Lists all live configs managed by the Video Stitcher that belong to the specified project and region.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::ListLiveConfigsRequest
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StreamRange< google::cloud::video::stitcher::v1::LiveConfig > |
a StreamRange to iterate of the results. See the documentation of this type for details. In brief, this class has |
GetLiveConfig(std::string const &, Options)
Returns the specified live config managed by the Video Stitcher service.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the live config to be retrieved, in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::LiveConfig > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.LiveConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
GetLiveConfig(google::cloud::video::stitcher::v1::GetLiveConfigRequest const &, Options)
Returns the specified live config managed by the Video Stitcher service.
Parameters | |
---|---|
Name | Description |
request |
google::cloud::video::stitcher::v1::GetLiveConfigRequest const &
Unary RPCs, such as the one wrapped by this function, receive a single |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
StatusOr< google::cloud::video::stitcher::v1::LiveConfig > |
the result of the RPC. The response message type (google.cloud.video.stitcher.v1.LiveConfig) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the |
DeleteLiveConfig(std::string const &, Options)
Deletes the specified live config.
Parameters | |
---|---|
Name | Description |
name |
std::string const &
Required. The name of the live config to be deleted, in the form of |
opts |
Options
Optional. Override the class-level options, such as retry and backoff policies. |
Returns | |
---|---|
Type | Description |
future< StatusOr< google::cloud::video::stitcher::v1::OperationMetadata > > |
A |
DeleteLiveConfig(NoAwaitTag, std::string const &, Options)
Deletes the specified live config.
Specifying the NoAwaitTag
immediately returns the [google::longrunning::Operation
] that corresponds to the Long Running Operation that has been started. No polling for operation status occurs.
Parameters | |
---|---|
Name | Description |
|
NoAwaitTag
|
name |
std::string const &
|
opts |
Options
|
Returns | |
---|---|