Class LivestreamServiceClient (2.24.0)

Using Live Stream API, you can generate live streams in the various renditions and streaming formats.

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

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

LivestreamServiceClient(LivestreamServiceClient const &)

Copy and move support

Parameter
Name Description
LivestreamServiceClient const &

LivestreamServiceClient(LivestreamServiceClient &&)

Copy and move support

Parameter
Name Description
LivestreamServiceClient &&

LivestreamServiceClient(std::shared_ptr< LivestreamServiceConnection >, Options)

Parameters
Name Description
connection std::shared_ptr< LivestreamServiceConnection >
opts Options

Operators

operator=(LivestreamServiceClient const &)

Copy and move support

Parameter
Name Description
LivestreamServiceClient const &
Returns
Type Description
LivestreamServiceClient &

operator=(LivestreamServiceClient &&)

Copy and move support

Parameter
Name Description
LivestreamServiceClient &&
Returns
Type Description
LivestreamServiceClient &

Functions

CreateChannel(std::string const &, google::cloud::video::livestream::v1::Channel const &, std::string const &, Options)

Creates a channel with the provided unique ID in the specified region.

Parameters
Name Description
parent std::string const &

Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

channel google::cloud::video::livestream::v1::Channel const &

Required. The channel resource to be created.

channel_id std::string const &

Required. The ID of the channel resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::video::livestream::v1::Channel > >

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.livestream.v1.Channel proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateChannel(google::cloud::video::livestream::v1::CreateChannelRequest const &, Options)

Creates a channel with the provided unique ID in the specified region.

Parameters
Name Description
request google::cloud::video::livestream::v1::CreateChannelRequest 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.livestream.v1.CreateChannelRequest. 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::livestream::v1::Channel > >

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.livestream.v1.Channel proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListChannels(std::string const &, Options)

Returns a list of all channels in the specified region.

Parameters
Name Description
parent std::string const &

Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::video::livestream::v1::Channel >

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.livestream.v1.Channel, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListChannels(google::cloud::video::livestream::v1::ListChannelsRequest, Options)

Returns a list of all channels in the specified region.

Parameters
Name Description
request google::cloud::video::livestream::v1::ListChannelsRequest

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.livestream.v1.ListChannelsRequest. 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::livestream::v1::Channel >

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.livestream.v1.Channel, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetChannel(std::string const &, Options)

Returns the specified channel.

Parameters
Name Description
name std::string const &

Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::video::livestream::v1::Channel >

the result of the RPC. The response message type (google.cloud.video.livestream.v1.Channel) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetChannel(google::cloud::video::livestream::v1::GetChannelRequest const &, Options)

Returns the specified channel.

Parameters
Name Description
request google::cloud::video::livestream::v1::GetChannelRequest 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.livestream.v1.GetChannelRequest. 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::livestream::v1::Channel >

the result of the RPC. The response message type (google.cloud.video.livestream.v1.Channel) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteChannel(std::string const &, Options)

Deletes the specified channel.

Parameters
Name Description
name std::string const &

Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::video::livestream::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.livestream.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteChannel(google::cloud::video::livestream::v1::DeleteChannelRequest const &, Options)

Deletes the specified channel.

Parameters
Name Description
request google::cloud::video::livestream::v1::DeleteChannelRequest 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.livestream.v1.DeleteChannelRequest. 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::livestream::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.livestream.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateChannel(google::cloud::video::livestream::v1::Channel const &, google::protobuf::FieldMask const &, Options)

Updates the specified channel.

Parameters
Name Description
channel google::cloud::video::livestream::v1::Channel const &

Required. The channel resource to be updated.

update_mask google::protobuf::FieldMask const &

Field mask is used to specify the fields to be overwritten in the Channel resource by the update. You can only update the following fields:

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::video::livestream::v1::Channel > >

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.livestream.v1.Channel proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateChannel(google::cloud::video::livestream::v1::UpdateChannelRequest const &, Options)

Updates the specified channel.

Parameters
Name Description
request google::cloud::video::livestream::v1::UpdateChannelRequest 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.livestream.v1.UpdateChannelRequest. 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::livestream::v1::Channel > >

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.livestream.v1.Channel proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StartChannel(std::string const &, Options)

Starts the specified channel.

Part of the video pipeline will be created only when the StartChannel request is received by the server.

Parameters
Name Description
name std::string const &

Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::video::livestream::v1::ChannelOperationResponse > >

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.livestream.v1.ChannelOperationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StartChannel(google::cloud::video::livestream::v1::StartChannelRequest const &, Options)

Starts the specified channel.

Part of the video pipeline will be created only when the StartChannel request is received by the server.

Parameters
Name Description
request google::cloud::video::livestream::v1::StartChannelRequest 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.livestream.v1.StartChannelRequest. 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::livestream::v1::ChannelOperationResponse > >

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.livestream.v1.ChannelOperationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StopChannel(std::string const &, Options)

Stops the specified channel.

Part of the video pipeline will be released when the StopChannel request is received by the server.

Parameters
Name Description
name std::string const &

Required. The name of the channel resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::video::livestream::v1::ChannelOperationResponse > >

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.livestream.v1.ChannelOperationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

StopChannel(google::cloud::video::livestream::v1::StopChannelRequest const &, Options)

Stops the specified channel.

Part of the video pipeline will be released when the StopChannel request is received by the server.

Parameters
Name Description
request google::cloud::video::livestream::v1::StopChannelRequest 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.livestream.v1.StopChannelRequest. 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::livestream::v1::ChannelOperationResponse > >

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.livestream.v1.ChannelOperationResponse proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateInput(std::string const &, google::cloud::video::livestream::v1::Input const &, std::string const &, Options)

Creates an input with the provided unique ID in the specified region.

Parameters
Name Description
parent std::string const &

Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

input google::cloud::video::livestream::v1::Input const &

Required. The input resource to be created.

input_id std::string const &

Required. The ID of the input resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::video::livestream::v1::Input > >

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.livestream.v1.Input proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateInput(google::cloud::video::livestream::v1::CreateInputRequest const &, Options)

Creates an input with the provided unique ID in the specified region.

Parameters
Name Description
request google::cloud::video::livestream::v1::CreateInputRequest 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.livestream.v1.CreateInputRequest. 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::livestream::v1::Input > >

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.livestream.v1.Input proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

ListInputs(std::string const &, Options)

Returns a list of all inputs in the specified region.

Parameters
Name Description
parent std::string const &

Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::video::livestream::v1::Input >

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.livestream.v1.Input, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListInputs(google::cloud::video::livestream::v1::ListInputsRequest, Options)

Returns a list of all inputs in the specified region.

Parameters
Name Description
request google::cloud::video::livestream::v1::ListInputsRequest

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.livestream.v1.ListInputsRequest. 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::livestream::v1::Input >

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.livestream.v1.Input, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetInput(std::string const &, Options)

Returns the specified input.

Parameters
Name Description
name std::string const &

Required. The name of the input resource, in the form of: projects/{project}/locations/{location}/inputs/{inputId}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::video::livestream::v1::Input >

the result of the RPC. The response message type (google.cloud.video.livestream.v1.Input) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetInput(google::cloud::video::livestream::v1::GetInputRequest const &, Options)

Returns the specified input.

Parameters
Name Description
request google::cloud::video::livestream::v1::GetInputRequest 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.livestream.v1.GetInputRequest. 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::livestream::v1::Input >

the result of the RPC. The response message type (google.cloud.video.livestream.v1.Input) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteInput(std::string const &, Options)

Deletes the specified input.

Parameters
Name Description
name std::string const &

Required. The name of the input resource, in the form of: projects/{project}/locations/{location}/inputs/{inputId}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::video::livestream::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.livestream.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteInput(google::cloud::video::livestream::v1::DeleteInputRequest const &, Options)

Deletes the specified input.

Parameters
Name Description
request google::cloud::video::livestream::v1::DeleteInputRequest 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.livestream.v1.DeleteInputRequest. 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::livestream::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.livestream.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateInput(google::cloud::video::livestream::v1::Input const &, google::protobuf::FieldMask const &, Options)

Updates the specified input.

Parameters
Name Description
input google::cloud::video::livestream::v1::Input const &

Required. The input resource to be updated.

update_mask google::protobuf::FieldMask const &

Field mask is used to specify the fields to be overwritten in the Input resource by the update. You can only update the following fields:

  • preprocessingConfig
  • securityRules
    The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.
    If the mask is not present, then each field from the list above is updated if the field appears in the request payload. To unset a field, add the field to the update mask and remove it from the request payload.
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::video::livestream::v1::Input > >

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.livestream.v1.Input proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdateInput(google::cloud::video::livestream::v1::UpdateInputRequest const &, Options)

Updates the specified input.

Parameters
Name Description
request google::cloud::video::livestream::v1::UpdateInputRequest 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.livestream.v1.UpdateInputRequest. 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::livestream::v1::Input > >

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.livestream.v1.Input proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateEvent(std::string const &, google::cloud::video::livestream::v1::Event const &, std::string const &, Options)

Creates an event with the provided unique ID in the specified channel.

Parameters
Name Description
parent std::string const &

Required. The parent channel for the resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

event google::cloud::video::livestream::v1::Event const &

Required. The event resource to be created.

event_id std::string const &

Required. The ID of the event resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::video::livestream::v1::Event >

the result of the RPC. The response message type (google.cloud.video.livestream.v1.Event) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

CreateEvent(google::cloud::video::livestream::v1::CreateEventRequest const &, Options)

Creates an event with the provided unique ID in the specified channel.

Parameters
Name Description
request google::cloud::video::livestream::v1::CreateEventRequest 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.livestream.v1.CreateEventRequest. 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::livestream::v1::Event >

the result of the RPC. The response message type (google.cloud.video.livestream.v1.Event) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListEvents(std::string const &, Options)

Returns a list of all events in the specified channel.

Parameters
Name Description
parent std::string const &

Required. The parent channel for the resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::video::livestream::v1::Event >

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.livestream.v1.Event, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListEvents(google::cloud::video::livestream::v1::ListEventsRequest, Options)

Returns a list of all events in the specified channel.

Parameters
Name Description
request google::cloud::video::livestream::v1::ListEventsRequest

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.livestream.v1.ListEventsRequest. 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::livestream::v1::Event >

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.livestream.v1.Event, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetEvent(std::string const &, Options)

Returns the specified event.

Parameters
Name Description
name std::string const &

Required. The name of the event resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::video::livestream::v1::Event >

the result of the RPC. The response message type (google.cloud.video.livestream.v1.Event) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetEvent(google::cloud::video::livestream::v1::GetEventRequest const &, Options)

Returns the specified event.

Parameters
Name Description
request google::cloud::video::livestream::v1::GetEventRequest 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.livestream.v1.GetEventRequest. 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::livestream::v1::Event >

the result of the RPC. The response message type (google.cloud.video.livestream.v1.Event) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

DeleteEvent(std::string const &, Options)

Deletes the specified event.

Parameters
Name Description
name std::string const &

Required. The name of the event resource, in the form of: projects/{project}/locations/{location}/channels/{channelId}/events/{eventId}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
Status

a Status object. If the request failed, the status contains the details of the failure.

DeleteEvent(google::cloud::video::livestream::v1::DeleteEventRequest const &, Options)

Deletes the specified event.

Parameters
Name Description
request google::cloud::video::livestream::v1::DeleteEventRequest 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.livestream.v1.DeleteEventRequest. 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
Status

a Status object. If the request failed, the status contains the details of the failure.

CreateAsset(std::string const &, google::cloud::video::livestream::v1::Asset const &, std::string const &, Options)

Creates a Asset with the provided unique ID in the specified region.

Parameters
Name Description
parent std::string const &

Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

asset google::cloud::video::livestream::v1::Asset const &

Required. The asset resource to be created.

asset_id std::string const &

Required. The ID of the asset resource to be created. This value must be 1-63 characters, begin and end with [a-z0-9], could contain dashes (-) in between.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::video::livestream::v1::Asset > >

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.livestream.v1.Asset proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

CreateAsset(google::cloud::video::livestream::v1::CreateAssetRequest const &, Options)

Creates a Asset with the provided unique ID in the specified region.

Parameters
Name Description
request google::cloud::video::livestream::v1::CreateAssetRequest 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.livestream.v1.CreateAssetRequest. 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::livestream::v1::Asset > >

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.livestream.v1.Asset proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteAsset(std::string const &, Options)

Deletes the specified asset if it is not used.

Parameters
Name Description
name std::string const &

Required. The name of the asset resource, in the form of: projects/{project}/locations/{location}/assets/{assetId}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::video::livestream::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.livestream.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

DeleteAsset(google::cloud::video::livestream::v1::DeleteAssetRequest const &, Options)

Deletes the specified asset if it is not used.

Parameters
Name Description
request google::cloud::video::livestream::v1::DeleteAssetRequest 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.livestream.v1.DeleteAssetRequest. 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::livestream::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.livestream.v1.OperationMetadata proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

GetAsset(std::string const &, Options)

Returns the specified asset.

Parameters
Name Description
name std::string const &

Required. Name of the resource, in the following form: projects/{project}/locations/{location}/assets/{asset}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::video::livestream::v1::Asset >

the result of the RPC. The response message type (google.cloud.video.livestream.v1.Asset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetAsset(google::cloud::video::livestream::v1::GetAssetRequest const &, Options)

Returns the specified asset.

Parameters
Name Description
request google::cloud::video::livestream::v1::GetAssetRequest 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.livestream.v1.GetAssetRequest. 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::livestream::v1::Asset >

the result of the RPC. The response message type (google.cloud.video.livestream.v1.Asset) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

ListAssets(std::string const &, Options)

Returns a list of all assets in the specified region.

Parameters
Name Description
parent std::string const &

Required. The parent location for the resource, in the form of: projects/{project}/locations/{location}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StreamRange< google::cloud::video::livestream::v1::Asset >

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.livestream.v1.Asset, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

ListAssets(google::cloud::video::livestream::v1::ListAssetsRequest, Options)

Returns a list of all assets in the specified region.

Parameters
Name Description
request google::cloud::video::livestream::v1::ListAssetsRequest

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.livestream.v1.ListAssetsRequest. 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::livestream::v1::Asset >

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.livestream.v1.Asset, or rather, the C++ class generated by Protobuf from that type. Please consult the Protobuf documentation for details on the Protobuf mapping rules.

GetPool(std::string const &, Options)

Returns the specified pool.

Parameters
Name Description
name std::string const &

Required. The name of the pool resource, in the form of: projects/{project}/locations/{location}/pools/{poolId}.

opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
StatusOr< google::cloud::video::livestream::v1::Pool >

the result of the RPC. The response message type (google.cloud.video.livestream.v1.Pool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

GetPool(google::cloud::video::livestream::v1::GetPoolRequest const &, Options)

Returns the specified pool.

Parameters
Name Description
request google::cloud::video::livestream::v1::GetPoolRequest 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.livestream.v1.GetPoolRequest. 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::livestream::v1::Pool >

the result of the RPC. The response message type (google.cloud.video.livestream.v1.Pool) is mapped to a C++ class using the Protobuf mapping rules. If the request fails, the StatusOr contains the error details.

UpdatePool(google::cloud::video::livestream::v1::Pool const &, google::protobuf::FieldMask const &, Options)

Updates the specified pool.

Parameters
Name Description
pool google::cloud::video::livestream::v1::Pool const &

Required. The pool resource to be updated.

update_mask google::protobuf::FieldMask const &

Field mask is used to specify the fields to be overwritten in the Pool resource by the update. You can only update the following fields:

  • networkConfig
    The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.
opts Options

Optional. Override the class-level options, such as retry and backoff policies.

Returns
Type Description
future< StatusOr< google::cloud::video::livestream::v1::Pool > >

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.livestream.v1.Pool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.

UpdatePool(google::cloud::video::livestream::v1::UpdatePoolRequest const &, Options)

Updates the specified pool.

Parameters
Name Description
request google::cloud::video::livestream::v1::UpdatePoolRequest 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.livestream.v1.UpdatePoolRequest. 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::livestream::v1::Pool > >

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.livestream.v1.Pool proto message. The C++ class representing this message is created by Protobuf, using the Protobuf mapping rules.