#语音合成 #谷歌 #协议 #谷歌API #网页 #网页API

google-texttospeech1

一个完整的库,用于与 Texttospeech(协议 v1)交互

17 个稳定版本 (4 个主要版本)

5.0.5+20240530 2024年6月27日
5.0.4+20240228 2024年3月5日
5.0.3+20230118 2023年8月24日
5.0.2+20230118 2023年3月17日
1.0.8+20181005 2018年10月14日

#2666 in 网页编程


google-texttospeech1-cli 中使用

MIT 许可证

205KB
2.5K SLoC

google-texttospeech1 库允许访问 Google Texttospeech 服务(协议 v1)的所有功能。

本文档是从 Texttospeech crate 版本 5.0.5+20240530 生成的,其中 20240530 是由 mako 代码生成器 v5.0.5 构建的 texttospeech:v1 模式的确切修订版。

关于 Texttospeech v1 API 的其他信息可以在 官方文档网站 找到。

特性

轻松从中央 枢纽 处理以下 资源...

本库结构

API 结构如下

  • 枢纽
  • 资源
    • 主要类型,可以将 活动 应用到这些类型上
    • 一组属性和 部分
    • 部分
      • 一组属性
      • 不直接用于 活动
  • 活动
    • 应用于 资源 的操作

所有 结构 都带有适用的特质,以进一步分类它们并便于浏览。

一般来说,您可以像这样调用 活动

let r = hub.resource().activity(...).doit().await

或者具体地 ...

let r = hub.operations().cancel(...).doit().await
let r = hub.operations().delete(...).doit().await
let r = hub.projects().locations_operations_get(...).doit().await
let r = hub.projects().locations_synthesize_long_audio(...).doit().await

资源(resource)和活动(activity)调用创建构建器。第二个处理Activities,支持配置即将进行的操作的各种方法(此处未显示)。它被设计成必须立即指定所有必需参数(即 (...)),而所有可选参数则可以根据需要逐步构建。doit()方法执行与服务器之间的实际通信,并返回相应的结果。

用法

设置项目

要使用此库,请将以下行放入您的Cargo.toml文件中

[dependencies]
google-texttospeech1 = "*"
serde = "^1.0"
serde_json = "^1.0"

完整示例

extern crate hyper;
extern crate hyper_rustls;
extern crate google_texttospeech1 as texttospeech1;
use texttospeech1::api::CancelOperationRequest;
use texttospeech1::{Result, Error};
use std::default::Default;
use texttospeech1::{Texttospeech, oauth2, hyper, hyper_rustls, chrono, FieldMask};

// Get an ApplicationSecret instance by some means. It contains the `client_id` and 
// `client_secret`, among other things.
let secret: oauth2::ApplicationSecret = Default::default();
// Instantiate the authenticator. It will choose a suitable authentication flow for you, 
// unless you replace  `None` with the desired Flow.
// Provide your own `AuthenticatorDelegate` to adjust the way it operates and get feedback about 
// what's going on. You probably want to bring in your own `TokenStorage` to persist tokens and
// retrieve them from storage.
let auth = oauth2::InstalledFlowAuthenticator::builder(
        secret,
        oauth2::InstalledFlowReturnMethod::HTTPRedirect,
    ).build().await.unwrap();
let mut hub = Texttospeech::new(hyper::Client::builder().build(hyper_rustls::HttpsConnectorBuilder::new().with_native_roots().unwrap().https_or_http().enable_http1().build()), auth);
// As the method needs a request, you would usually fill it with the desired information
// into the respective structure. Some of the parts shown here might not be applicable !
// Values shown here are possibly random and not representative !
let mut req = CancelOperationRequest::default();

// You can configure optional parameters by calling the respective setters at will, and
// execute the final call using `doit()`.
// Values shown here are possibly random and not representative !
let result = hub.operations().cancel(req, "name")
             .doit().await;

match result {
    Err(e) => match e {
        // The Error enum provides details about what exactly happened.
        // You can also just use its `Debug`, `Display` or `Error` traits
         Error::HttpError(_)
        |Error::Io(_)
        |Error::MissingAPIKey
        |Error::MissingToken(_)
        |Error::Cancelled
        |Error::UploadSizeLimitExceeded(_, _)
        |Error::Failure(_)
        |Error::BadRequest(_)
        |Error::FieldClash(_)
        |Error::JsonDecodeError(_, _) => println!("{}", e),
    },
    Ok(res) => println!("Success: {:?}", res),
}

错误处理

系统产生的所有错误都作为Result枚举提供,作为doit()方法的返回值,或者作为可能的中级结果传递给Hub Delegate,或者Authenticator Delegate

当代理处理错误或中间值时,它们有机会指导系统重试。这使得系统可能对所有类型的错误都具有弹性。

上传和下载

如果某个方法支持下载,您应该读取响应体以获取媒体,这是Result的一部分。如果此方法还支持Response Result,它将默认返回。您可以将其视为实际媒体的元数据。要触发媒体下载,您需要设置构建器,执行此调用:.param("alt", "media")

支持上传的方法可以使用最多2种不同的协议进行上传:简单可恢复。每种方法的独特性由定制的doit(...)方法表示,分别命名为upload(...)upload_resumable(...)

自定义和回调

您可以通过向Method Builder提供一个代理来更改doit()方法的调用方式,在执行最终的doit()调用之前。相应的方程序将被调用以提供进度信息,以及确定系统在失败时是否应该重试。

delegate trait具有默认实现,这使得您只需付出最小的努力就可以自定义它。

服务器请求中的可选部分

本库提供的所有结构都设计为可以通过json进行编码解码。使用可选参数来表示部分请求或响应是有效的。大多数可选参数都被视为部分,可以通过名称识别,这些部分将被发送到服务器以指示请求或响应中的所需部分。

构建器参数

通过使用方法构建器,您可以多次调用它的方法来准备一个操作调用。这些方法始终只接受一个参数,以下陈述对它适用。

  • PODs通过复制传递
  • 字符串作为&str传递
  • 请求值是移动的

参数将被复制或克隆到构建器中,以确保它们与其原始生命周期独立。

Cargo功能

  • utoipa - 添加对utoipa的支持并从所有类型中派生utoipa::ToSchema。您需要在#[openapi(schemas(...))]中导入和注册所需类型,否则生成的openapi规范将是无效的。

许可证

texttospeech1库由Sebastian Thiel生成,并置于MIT许可证之下。您可以在仓库的许可证文件中阅读全文。

依赖关系

~12–23MB
~344K SLoC