@aws-sdk/客户端-ivs-实时
说明
JavaScript IVSRealTime客户端的 AWS SDK 为Node.js, 浏览器和React Industrial 的客户端.
Amazon Interactive Video Service(IVS)实时API是REST相容的,使用标准HTTP API和AWS EventBridge事件流进行响应. JSON既用于请求,也用于答复,包括出错.
关键概念
-
阶段 ——一个参与者可以实时交换视频的虚拟空间.
-
参与者符号 ——一种使参与者加入舞台时认证的标志.
-
与会者对象 代表舞台上的参与者(人民),并载有关于他们的信息。 当一个符号被创建时,它包括一个参与者身份;当参与者使用该符号加入一个阶段时,参与者与该参与者身份相关. 参与者符号和参与者之间有1:1的分布图.
对于服务器侧组成 :
-
组成过程 ——将一个舞台的参与者综合到一个单一的视频中,并转发到一组出品(例如IVS频道). 组成行动支持这一进程.
-
组成 ——控制产出的外观,包括参与者在视频中的位置.
供与会者复制:
-
来源阶段 ——参与者最初加入的阶段,作为复制来源.
-
目标阶段 ——参与者被复制的阶段.
-
重复与会者 参与一个复制到一个或多个目的地阶段的参与者.
-
复制参与者 - 目的地阶段的参与者,该阶段从另一个阶段复制(来源阶段).
更多信息,请查看InfoFinland上的 IVS 直播流 启动 Amazon IVS 实时流线。 。 。 .
缠绕
A 类 标签 是您为 AWS 资源指定的元数据标签。 标签包含 键 (单位:千美元) 价值你们俩都安排好了 例如,您可能设置标签为 topic:nature 标记特定视频类别。 见 最佳做法和战略 内 拖入 AWS 资源和标签编辑器 细节,包括适用于标签和“标签命名限制和要求”的限制; Amazon IVS阶段除了记录的内容之外,没有特定服务的限制.
标记可以帮助您识别和组织您的 AWS 资源 。 例如,您可以使用不同资源的同名标记来表示它们具有关联性. 您也可以使用标签来管理访问(参见 访问标记) (中文(简体) ).
Amazon IVS实时API拥有这些与标记相关的操作: 标签资源, (中文(简体) ), 调和资源,以及 列表标签格式资源。以下资源支持标记: Stage.
最多50个标记可以应用到一个资源上.
安装
要安装此软件包, 请使用您最喜欢的软件包管理器的 CLI :
npm install @aws-sdk/client-ivs-realtimeyarn add @aws-sdk/client-ivs-realtimepnpm add @aws-sdk/client-ivs-realtime
开始
导入
AWS SDK由客户端和命令进行调制.
要发送请求,只需导入 IVSRealTimeClient 财务报告和审定财务报表
例如,您需要的命令 ListStagesCommand数字 :
// ES5 example
const { IVSRealTimeClient, ListStagesCommand } = require("@aws-sdk/client-ivs-realtime");
// ES6+ example
import { IVSRealTimeClient, ListStagesCommand } from "@aws-sdk/client-ivs-realtime";
使用量
发出请求:
- 以配置(如证书,区域)为客户端提供证据.
- 见 文件/中心 用于配置细节.
- 见 @aws- sdk/ 配置 附加选项.
- 以输入参数证明命令 .
- 打电话
send操作客户端,以输入方式提供命令对象.
const client = new IVSRealTimeClient({ region: "REGION" });
const params = { /** input parameters */ };
const command = new ListStagesCommand(params);
自动/等待
我们建议使用 等待时 运算符等待通过发送操作返回的承诺如下:
// async/await.
try {
const data = await client.send(command);
// process data.
} catch (error) {
// error handling.
} finally {
// finally.
}
承诺
您还可以使用 承诺连锁。 。 。 .
client
.send(command)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
})
.finally(() => {
// finally.
});
合并客户端
归集客户端类别从同套件中导出,但没有"Client"后缀.
IVSRealTime 扩展 IVSRealTimeClient 并额外支持所有操作,服务员, 和活人作为方法.
这种风格可能从JavaScript v2的AWS SDK中为您所熟悉.
如果你正在捆绑 AWS SDK, 我们建议只使用赤骨客户端(IVSRealTimeClient) (中文(简体) ).
更多详情见博客文章:
javaScript 的 AWS SDK 模块包。 。 。 .
import { IVSRealTime } from "@aws-sdk/client-ivs-realtime";
const client = new IVSRealTime({ region: "REGION" });
// async/await.
try {
const data = await client.listStages(params);
// process data.
} catch (error) {
// error handling.
}
// Promises.
client
.listStages(params)
.then((data) => {
// process data.
})
.catch((error) => {
// error handling.
});
// callbacks (not recommended).
client.listStages(params, (err, data) => {
// process err and data.
});
解决问题
当服务返回例外时,错误将包括例外信息, 以及响应元数据(如请求编号).
try {
const data = await client.send(command);
// process data.
} catch (error) {
const { requestId, cfId, extendedRequestId } = error.$metadata;
console.log({ requestId, cfId, extendedRequestId });
/**
* The keys within exceptions are also parsed.
* You can access them by specifying exception names:
* if (error.name === 'SomeServiceException') {
* const value = error.specialKeyInException;
* }
*/
}
另见 文档/错误。 。 。 .
获取帮助
请利用这些社区资源获得帮助. 我们使用 GitHub 问题来跟踪错误和特性请求,但处理它们的带宽有限.
- 访问 开发者指南 或者说 API 参考。 。 。 .
- 看看贴有标签的博客文章
aws-sdk-jsaWS 开发者博客. - 问个问题 叠叠流 并贴上标签
aws-sdk-js。 。 。 . - 加入 AWS JavaScript 社区 发光。 。 。 .
- 如果你发现你发现了一个虫子,请 打开一个问题。 。 。 .
为了测试您在Node.js中通用的JavaScript代码,浏览器和反应本地环境, 拜访我们 代码样本 repo。 。 。 .
捐款
此客户端代码是自动生成的. 任何修改在下次修改时都会被覆盖 @aws-sdk/client-ivs-realtime 软件包正在更新.
为了帮助客户,你可以检查我们 生成客户端脚本。 。 。 .
许可证
此 SDK 分布于 Apache 许可证,2.0版本, (中文(简体) ), 更多信息见LICENSE.