Class VideoStitcherServiceClient (2.20.0)

Version 2.20.0

• 2.34.0-rc (latest)
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.1
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.1
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0

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 projects/{project_number}/locations/{location}.
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. 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::CdnKey > >	A future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.CdnKey proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.CreateCdnKeyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.CdnKey proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 projects/{project_number}/locations/{location}.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.video.stitcher.v1.CdnKey, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.ListCdnKeysRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.video.stitcher.v1.CdnKey, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 projects/{project}/locations/{location}/cdnKeys/{id}.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.GetCdnKeyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/{project_number}/locations/{location}/cdnKeys/{id}.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.DeleteCdnKeyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.CdnKey proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.UpdateCdnKeyRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.CdnKey proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 projects/{project_number}/locations/{location}.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.CreateVodSessionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/{project_number}/locations/{location}/vodSessions/{id}.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.GetVodSessionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/{project}/locations/{location}/vodSessions/{id}.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.video.stitcher.v1.VodStitchDetail, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.ListVodStitchDetailsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.video.stitcher.v1.VodStitchDetail, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 projects/{project}/locations/{location}/vodSessions/{vod_session_id}/vodStitchDetails/{id}.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.GetVodStitchDetailRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/{project}/locations/{location}/vodSessions/{vod_session_id}.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.video.stitcher.v1.VodAdTagDetail, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.ListVodAdTagDetailsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.video.stitcher.v1.VodAdTagDetail, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 projects/{project}/locations/{location}/vodSessions/{vod_session_id}/vodAdTagDetails/{vod_ad_tag_detail}.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.GetVodAdTagDetailRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/{project}/locations/{location}/liveSessions/{live_session}.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.video.stitcher.v1.LiveAdTagDetail, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.ListLiveAdTagDetailsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.video.stitcher.v1.LiveAdTagDetail, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 projects/{project}/locations/{location}/liveSessions/{live_session}/liveAdTagDetails/{live_ad_tag_detail}.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.GetLiveAdTagDetailRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/{project_number}/locations/{location}.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.Slate proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.CreateSlateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.Slate proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 projects/{project_number}/locations/{location}.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.video.stitcher.v1.Slate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.ListSlatesRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.video.stitcher.v1.Slate, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 projects/{project_number}/locations/{location}/slates/{id}.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.GetSlateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.Slate proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.UpdateSlateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.Slate proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 projects/{project_number}/locations/{location}/slates/{id}.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.DeleteSlateRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 projects/{project_number}/locations/{location}.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.CreateLiveSessionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/{project_number}/locations/{location}/liveSessions/{id}.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.GetLiveSessionRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/{project_number}/locations/{location}.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.LiveConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.CreateLiveConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.LiveConfig proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

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 projects/{project_number}/locations/{location}.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.video.stitcher.v1.LiveConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.ListLiveConfigsRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 begin() and end() member functions returning a iterator class meeting the input iterator requirements. The value type for this iterator is a StatusOr as the iteration may fail even after some values are retrieved successfully, for example, if there is a network disconnect. An empty set of results does not indicate an error, it indicates that there are no resources meeting the request criteria. On a successful iteration the StatusOr<T> contains elements of type google.cloud.video.stitcher.v1.LiveConfig, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

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 projects/{project_number}/locations/{location}/liveConfigs/{id}.
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 StatusOr contains the error details.

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 request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.GetLiveConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 StatusOr contains the error details.

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 projects/{project_number}/locations/{location}/liveConfigs/{id}.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteLiveConfig(google::cloud::video::stitcher::v1::DeleteLiveConfigRequest const &, Options)

Deletes the specified live config.

Parameters
Name	Description
request	google::cloud::video::stitcher::v1::DeleteLiveConfigRequest const & Unary RPCs, such as the one wrapped by this function, receive a single request proto message which includes all the inputs for the RPC. In this case, the proto message is a google.cloud.video.stitcher.v1.DeleteLiveConfigRequest. Proto messages are converted to C++ classes by Protobuf, using the Protobuf mapping rules.
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 future that becomes satisfied when the LRO (Long Running Operation) completes or the polling policy in effect for this call is exhausted. The future is satisfied with an error if the LRO completes with an error or the polling policy is exhausted. In this case the StatusOr returned by the future contains the error. If the LRO completes successfully the value of the future contains the LRO's result. For this RPC the result is a google.cloud.video.stitcher.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.