- [Device Streaming API](/google/cloud/devicestreaming/README.md)

./include/google/cloud/devicestreaming

./include/google/cloud/devicestreaming/v1

./include/google/cloud/devicestreaming/v1/internal

./include/google/cloud/devicestreaming/v1/mocks

./lib64/cmake/google_cloud_cpp_devicestreaming

./lib64/cmake/google_cloud_cpp_devicestreaming_mocks

"devicestreaming"

@com_google_googleapis//google/api:annotations_proto

@com_google_googleapis//google/api:client_proto

@com_google_googleapis//google/api:field_behavior_proto

@com_google_googleapis//google/api:http_proto

@com_google_googleapis//google/api:launch_stage_proto

@com_google_googleapis//google/api:resource_proto

@com_google_googleapis//google/cloud/devicestreaming/v1:adb_service.proto

@com_google_googleapis//google/cloud/devicestreaming/v1:service.proto

["devicestreaming"]="@com_google_googleapis//google/cloud/devicestreaming/v1:devicestreaming_cc_grpc"

load("//bazel:gapic.bzl", "cc_gapic_library")

package(default_visibility = ["//visibility:private"])

licenses(["notice"]) # Apache 2.0

service_dirs = ["v1/"]

googleapis_deps = [

"@com_google_googleapis//google/cloud/devicestreaming/v1:devicestreaming_cc_grpc",

]

cc_gapic_library(

name = "devicestreaming",

googleapis_deps = googleapis_deps,

service_dirs = service_dirs,

)

include(GoogleCloudCppLibrary)

google_cloud_cpp_add_gapic_library(devicestreaming "Device Streaming API"

SERVICE_DIRS "v1/")

if (BUILD_TESTING AND GOOGLE_CLOUD_CPP_ENABLE_CXX_EXCEPTIONS)

add_executable(devicestreaming_quickstart "quickstart/quickstart.cc")

target_link_libraries(devicestreaming_quickstart

PRIVATE google-cloud-cpp::devicestreaming)

google_cloud_cpp_add_common_options(devicestreaming_quickstart)

add_test(

NAME devicestreaming_quickstart

COMMAND cmake -P "${PROJECT_SOURCE_DIR}/cmake/quickstart-runner.cmake"

$<TARGET_FILE:devicestreaming_quickstart> GOOGLE_CLOUD_PROJECT)

set_tests_properties(devicestreaming_quickstart

PROPERTIES LABELS "integration-test;quickstart")

endif ()

This directory contains an idiomatic C++ client library for the

[Device Streaming API][cloud-service-docs].

The Cloud API for device streaming usage.

While this library is **GA**, please note that the Google Cloud C++ client

libraries do **not** follow [Semantic Versioning](https://semver.org/).

The [quickstart/](quickstart/README.md) directory contains a minimal environment

to get started using this client library in a larger project. The following

"Hello World" program is used in this quickstart, and should give you a taste of

this library.

#include "google/cloud/devicestreaming/v1/direct_access_client.h"

#include "google/cloud/location.h"

#include <iostream>

int main(int argc, char* argv[]) try {

if (argc != 2) {

std::cerr << "Usage: " << argv[0] << " project-id\n";

return 1;

}

auto const project_id = std::string(argv[1]);

auto const parent = "projects/" + project_id;

namespace devicestreaming = ::google::cloud::devicestreaming_v1;

auto client = devicestreaming::DirectAccessServiceClient(

devicestreaming::MakeDirectAccessServiceConnection());

for (auto r : client.ListDeviceSessions(parent)) {

if (!r) throw std::move(r).status();

std::cout << r->DebugString() << "\n";

}

return 0;

} catch (google::cloud::Status const& status) {

std::cerr << "google::cloud::Status thrown: " << status << "\n";

return 1;

}

/*!

@page devicestreaming-env Environment Variables

A number of environment variables can be used to configure the behavior of

the library. There are also functions to configure this behavior in code. The

environment variables are convenient when troubleshooting problems.

@section devicestreaming-env-endpoint Endpoint Overrides

<!-- inject-endpoint-env-vars-start -->

- `GOOGLE_CLOUD_CPP_DIRECT_ACCESS_SERVICE_ENDPOINT=...` overrides the

`EndpointOption` (which defaults to "devicestreaming.googleapis.com")

used by `MakeDirectAccessServiceConnection()`.

<!-- inject-endpoint-env-vars-end -->

@see google::cloud::EndpointOption

@section devicestreaming-env-logging Logging

`GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc`: turns on tracing for most gRPC

calls. The library injects an additional Stub decorator that prints each gRPC

request and response. Unless you have configured your own logging backend,

you should also set `GOOGLE_CLOUD_CPP_ENABLE_CLOG` to produce any output on

the program's console.

@see google::cloud::LoggingComponentsOption

`GOOGLE_CLOUD_CPP_TRACING_OPTIONS=...`: modifies the behavior of gRPC tracing,

including whether messages will be output on multiple lines, or whether

string/bytes fields will be truncated.

@see google::cloud::GrpcTracingOptionsOption

`GOOGLE_CLOUD_CPP_ENABLE_CLOG=yes`: turns on logging in the library, basically

the library always "logs" but the logging infrastructure has no backend to

actually print anything until the application sets a backend or they set this

environment variable.

@see google::cloud::LogBackend

@see google::cloud::LogSink

@section devicestreaming-env-project Setting the Default Project

`GOOGLE_CLOUD_PROJECT=...`: is used in examples and integration tests to

configure the GCP project. This has no effect in the library.

*/

/*!

@mainpage Device Streaming API C++ Client Library

An idiomatic C++ client library for the [Device Streaming API][cloud-service-docs].

The Cloud API for device streaming usage.

While this library is **GA**, please note that the Google Cloud C++ client libraries do **not** follow

[Semantic Versioning](https://semver.org/).

@tableofcontents{HTML:2}

## Quickstart

The following shows the code that you'll run in the

`google/cloud/devicestreaming/quickstart/` directory,

which should give you a taste of the Device Streaming API C++ client library API.

@snippet quickstart.cc all

## Main classes

<!-- inject-client-list-start -->

The main class in this library is

[`devicestreaming_v1::DirectAccessServiceClient`](@ref google::cloud::devicestreaming_v1::DirectAccessServiceClient). All RPCs are exposed

as member functions of this class. Other classes provide helpers, configuration

parameters, and infrastructure to mock

[`devicestreaming_v1::DirectAccessServiceClient`](@ref google::cloud::devicestreaming_v1::DirectAccessServiceClient) when testing your

application.

<!-- inject-client-list-end -->

## More Information

- @ref common-error-handling - describes how the library reports errors.

- @ref devicestreaming-override-endpoint - describes how to override the default

endpoint.

- @ref devicestreaming-override-authentication - describes how to change the

authentication credentials used by the library.

- @ref devicestreaming-override-retry - describes how to change the default retry

policies.

- @ref devicestreaming-env - describes environment variables that can configure the

behavior of the library.

[cloud-service-docs]: https://cloud.google.com/device-streaming/docs

*/

/*!

@defgroup google-cloud-devicestreaming-options Device Streaming API Configuration Options

This library uses the same mechanism (`google::cloud::Options`) and the common

[options](@ref options) as all other C++ client libraries for its configuration.

Some `*Option` classes, which are only used in this library, are documented in

this page.

@see @ref options - for an overview of client library configuration.

*/

/*!

@page devicestreaming-override-authentication How to Override the Authentication Credentials

Unless otherwise configured, the client libraries use

[Application Default Credentials] to authenticate with Google Cloud Services.

While this works for most applications, in some cases you may need to override

this default. You can do so by providing the

[UnifiedCredentialsOption](@ref google::cloud::UnifiedCredentialsOption)

The following example shows how to explicitly load a service account key file:

<!-- inject-service-account-snippet-start -->

@snippet direct_access_client_samples.cc with-service-account

<!-- inject-service-account-snippet-end -->

Keep in mind that we chose this as an example because it is relatively easy to

understand. Consult the [Best practices for managing service account keys]

guide for more details.

@see @ref guac - for more information on the factory functions to create

`google::cloud::Credentials` objects.

[Best practices for managing service account keys]: https://cloud.google.com/iam/docs/best-practices-for-managing-service-account-keys

[Application Default Credentials]: https://cloud.google.com/docs/authentication#adc

*/

// <!-- inject-authentication-pages-start -->

/*! @page devicestreaming_v1::DirectAccessServiceClient-service-account-snippet Override devicestreaming_v1::DirectAccessServiceClient Authentication Defaults

@snippet google/cloud/devicestreaming/v1/samples/direct_access_client_samples.cc with-service-account

*/

// <!-- inject-authentication-pages-end -->

/*!

@page devicestreaming-override-endpoint How to Override the Default Endpoint

In some cases, you may need to override the default endpoint used by the client

library. Use the

[EndpointOption](@ref google::cloud::EndpointOption) when initializing the

client library to change this default.

<!-- inject-endpoint-snippet-start -->

For example, this will override the default endpoint for `devicestreaming_v1::DirectAccessServiceClient`:

@snippet direct_access_client_samples.cc set-client-endpoint

<!-- inject-endpoint-snippet-end -->

*/

// <!-- inject-endpoint-pages-start -->

/*! @page devicestreaming_v1::DirectAccessServiceClient-endpoint-snippet Override devicestreaming_v1::DirectAccessServiceClient Endpoint Configuration

@snippet google/cloud/devicestreaming/v1/samples/direct_access_client_samples.cc set-client-endpoint

*/

// <!-- inject-endpoint-pages-end -->