使用 Amazon IVS 实时直播示例 Amazon CLI - Amazon Command Line Interface
操作
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异，请参阅 中国的 Amazon Web Services 服务入门 (PDF)。

本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

使用 Amazon IVS 实时直播示例 Amazon CLI

以下代码示例向您展示如何使用 Amazon Command Line Interface 与 Amazon IVS 实时流媒体配合使用来执行操作和实现常见场景。

操作是大型程序的代码摘录，必须在上下文中运行。您可以通过操作了解如何调用单个服务函数，还可以通过函数相关场景和跨服务示例的上下文查看操作。

场景是展示如何通过在同一服务中调用多个函数来完成特定任务任务的代码示例。

每个示例都包含一个指向的链接 GitHub，您可以在其中找到有关如何在上下文中设置和运行代码的说明。

主题

操作

以下代码示例演示如何使用 create-encoder-configuration。

Amazon CLI

创建合成编码器配置

以下create-encoder-configuration示例创建具有指定属性的合成编码器配置。

aws ivs-realtime create-encoder-configuration \
    --name test-ec --video bitrate=3500000,framerate=30.0,height=1080,width=1920

输出：

{
    "encoderConfiguration": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef",
        "name": "test-ec",
        "tags": {},
        "video": {
            "bitrate": 3500000,
            "framerate": 30,
            "height": 1080,
            "width": 1920
        }
    }
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

以下代码示例演示如何使用 create-participant-token。

Amazon CLI

创建舞台参与者令牌

以下create-participant-token示例为指定阶段创建参与者令牌。

aws ivs-realtime create-participant-token \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --user-id bob

输出：

{
    "participantToken": {
        "expirationTime": "2023-03-07T09:47:43+00:00",
        "participantId": "ABCDEfghij01234KLMN6789",
        "token": "abcd1234defg5678"
    }
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

以下代码示例演示如何使用 create-stage。

Amazon CLI

创建舞台

以下create-stage示例为指定用户创建舞台和舞台参与者令牌。

aws ivs-realtime create-stage \
    --name stage1 \
    --participant-token-configurations userId=alice

输出：

{
    "participantTokens": [
        {
            "participantId": "ABCDEfghij01234KLMN5678",
            "token": "a1b2c3d4567890ab",
            "userId": "alice"
        }
    ],
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "name": "stage1",
        "tags": {}
    }
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考CreateStage中的。

以下代码示例演示如何使用 create-storage-configuration。

Amazon CLI

创建合成存储配置

以下create-storage-configuration示例创建具有指定属性的合成存储配置。

aws ivs-realtime create-storage-configuration \
    --name "test-sc" --s3 "bucketName=test-bucket-name"

输出：

{
    "storageConfiguration": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef",
        "name": "test-sc",
        "s3": {
            "bucketName": "test-bucket-name"
        },
        "tags": {}
    }
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

以下代码示例演示如何使用 delete-encoder-configuration。

Amazon CLI

删除合成编码器配置

以下内容delete-encoder-configuration删除由给定 ARN（Amazon 资源名称）指定的合成编码器配置。

aws ivs-realtime delete-encoder-configuration \
    --arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"

此命令不生成任何输出。

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

以下代码示例演示如何使用 delete-stage。

Amazon CLI

删除舞台

以下delete-stage示例删除了指定的阶段。

aws ivs-realtime delete-stage \
    --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh

此命令不生成任何输出。

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考DeleteStage中的。

以下代码示例演示如何使用 delete-storage-configuration。

Amazon CLI

删除合成存储配置

以下内容delete-storage-configuration删除由给定 ARN（Amazon 资源名称）指定的合成存储配置。

aws ivs-realtime delete-storage-configuration \
    --arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABabCDcdEFef"

此命令不生成任何输出。

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

以下代码示例演示如何使用 disconnect-participant。

Amazon CLI

断开舞台参与者的连接

以下disconnect-participant示例断开指定参与者与指定阶段的连接。

aws ivs-realtime disconnect-participant \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --participant-id ABCDEfghij01234KLMN5678

此命令不生成任何输出。

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

以下代码示例演示如何使用 get-composition。

Amazon CLI

示例 1：使用默认布局设置获取合成

以下get-composition示例获取指定的 ARN（亚马逊资源名称）的构成。

aws ivs-realtime get-composition \
    --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"

输出：

{
    "composition": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
        "destinations": [
            {
                "configuration": {
                    "channel": {
                        "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
                        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                    },
                    "name": ""
                },
                "id": "AabBCcdDEefF",
                "startTime": "2023-10-16T23:26:00+00:00",
                "state": "ACTIVE"
            },
            {
                "configuration": {
                    "name": "",
                    "s3": {
                        "encoderConfigurationArns": [
                            "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                        ],
                        "recordingConfiguration": {
                            "format": "HLS"
                        },
                        "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
                    }
                },
                "detail": {
                    "s3": {
                        "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
                    }
                },
                "id": "GHFabcgefABC",
                "startTime": "2023-10-16T23:26:00+00:00",
                "state": "STARTING"
            }
        ],
        "layout": {
            "grid": {
                "featuredParticipantAttribute": ""
                "gridGap": 2,
                "omitStoppedVideo": false,
                "videoAspectRatio": "VIDEO",
                "videoFillMode": ""                }
        },
        "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
        "startTime": "2023-10-16T23:24:00+00:00",
        "state": "ACTIVE",
        "tags": {}
    }
}

有关更多信息，请参阅 Amazon 互动视频服务用户指南中的复合录制（实时流媒体）。

示例 2：使用画中画布局获取合成

以下get-composition示例获取指定的 ARN（亚马逊资源名称）的构成，该名称使用 PiP 布局。

aws ivs-realtime get-composition \
    --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs"

输出：

{
    "composition": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs",
        "destinations": [
            {
                "configuration": {
                    "channel": {
                        "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
                        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                    },
                    "name": ""
                },
                "id": "AabBCcdDEefF",
                "startTime": "2023-10-16T23:26:00+00:00",
                "state": "ACTIVE"
            },
            {
                "configuration": {
                    "name": "",
                    "s3": {
                        "encoderConfigurationArns": [
                            "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                        ],
                        "recordingConfiguration": {
                            "format": "HLS"
                        },
                        "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
                    }
                },
                "detail": {
                    "s3": {
                        "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
                    }
                },
                "id": "GHFabcgefABC",
                "startTime": "2023-10-16T23:26:00+00:00",
                "state": "STARTING"
            }
        ],
        "layout": {
            "pip": {
                "featuredParticipantAttribute": "abcdefg",
                "gridGap": 0,
                "omitStoppedVideo": false,
                "pipBehavior": "STATIC",
                "pipOffset": 0,
                "pipParticipantAttribute": "",
                "pipPosition": "BOTTOM_RIGHT",
                "videoFillMode": "COVER"
            }
        },
        "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
        "startTime": "2023-10-16T23:24:00+00:00",
        "state": "ACTIVE",
        "tags": {}
    }
}

有关更多信息，请参阅 Amazon 互动视频服务用户指南中的复合录制（实时流媒体）。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考GetComposition中的。

以下代码示例演示如何使用 get-encoder-configuration。

Amazon CLI

获取合成编码器配置

以下get-encoder-configuration示例获取由给定 ARN（Amazon 资源名称）指定的合成编码器配置。

aws ivs-realtime get-encoder-configuration \
    --arn "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh"

输出：

{
    "encoderConfiguration": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh",
        "name": "test-ec",
        "tags": {},
        "video": {
            "bitrate": 3500000,
            "framerate": 30,
            "height": 1080,
            "width": 1920
        }
    }
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

以下代码示例演示如何使用 get-participant。

Amazon CLI

招募舞台参与者

以下get-participant示例获取指定阶段 ARN（Amazon 资源名称）中指定参与者 ID 和会话 ID 的阶段参与者。

aws ivs-realtime get-participant \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --session-id st-a1b2c3d4e5f6g \
    --participant-id abCDEf12GHIj

输出：

{
    "participant": {
        "browserName", "Google Chrome",
        "browserVersion", "116",
        "firstJoinTime": "2023-04-26T20:30:34+00:00",
        "ispName", "Comcast",
        "osName", "Microsoft Windows 10 Pro",
        "osVersion", "10.0.19044",
        "participantId": "abCDEf12GHIj",
        "published": true,
        "sdkVersion", "",
        "state": "DISCONNECTED",
        "userId": ""
    }
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考GetParticipant中的。

以下代码示例演示如何使用 get-stage-session。

Amazon CLI

要参加舞台演出

以下get-stage-session示例获取指定阶段 ARN 的指定会话 ID 的阶段会话（Amazon 资源名称）。

aws ivs-realtime get-stage-session \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --session-id st-a1b2c3d4e5f6g

输出：

{
    "stageSession": {
        "endTime": "2023-04-26T20:36:29+00:00",
        "sessionId": "st-a1b2c3d4e5f6g",
        "startTime": "2023-04-26T20:30:29.602000+00:00"
    }
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考GetStageSession中的。

以下代码示例演示如何使用 get-stage。

Amazon CLI

获取舞台的配置信息

以下get-stage示例获取指定阶段 ARN 的阶段配置（Amazon 资源名称）。

aws ivs-realtime get-stage \
    --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh

输出：

{
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "name": "test",
        "tags": {}
    }
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考GetStage中的。

以下代码示例演示如何使用 get-storage-configuration。

Amazon CLI

获取合成存储配置

以下get-storage-configuration示例获取由给定 ARN（Amazon 资源名称）指定的组合存储配置。

aws ivs-realtime get-storage-configuration \
    --name arn "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh"

输出：

{
    "storageConfiguration": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh",
        "name": "test-sc",
        "s3": {
            "bucketName": "test-bucket-name"
        },
        "tags": {}
    }
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

以下代码示例演示如何使用 list-compositions。

Amazon CLI

要获取作品清单

以下list-compositions列出了您 Amazon 账户在处理 API 请求的 Amazon 区域内的所有组合信息。

aws ivs-realtime list-compositions

输出：

{
    "compositions": [
        {
            "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
            "destinations": [
                {
                    "id": "AabBCcdDEefF",
                    "startTime": "2023-10-16T23:25:23+00:00",
                    "state": "ACTIVE"
                }
            ],
            "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
            "startTime": "2023-10-16T23:25:21+00:00",
            "state": "ACTIVE",
            "tags": {}
        },
        {
            "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/ABcdabCDefgh",
            "destinations": [
                {
                    "endTime": "2023-10-16T23:25:00.786512+00:00",
                    "id": "aABbcCDdeEFf",
                    "startTime": "2023-10-16T23:24:01+00:00",
                    "state": "STOPPED"
                },
                {
                    "endTime": "2023-10-16T23:25:00.786512+00:00",
                    "id": "deEFfaABbcCD",
                    "startTime": "2023-10-16T23:24:01+00:00",
                    "state": "STOPPED"
                }
            ],
            "endTime": "2023-10-16T23:25:00+00:00",
            "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/efghabcdABCD",
            "startTime": "2023-10-16T23:24:00+00:00",
            "state": "STOPPED",
            "tags": {}
        }
    ]
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考ListCompositions中的。

以下代码示例演示如何使用 list-encoder-configurations。

Amazon CLI

列出合成编码器配置

以下list-encoder-configurations列出了在处理 API 请求的 Amazon 区域中您的 Amazon 账户的所有合成编码器配置。

aws ivs-realtime list-encoder-configurations

输出：

{
    "encoderConfigurations": [
        {
            "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/abcdABCDefgh",
            "name": "test-ec-1",
            "tags": {}
        },
        {
            "arn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABCefgEFGabc",
            "name": "test-ec-2",
            "tags": {}
        }
    ]
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

以下代码示例演示如何使用 list-participant-events。

Amazon CLI

获取舞台参与者活动列表

以下list-participant-events示例列出了指定参与者 ID 和指定阶段 ARN 的会话 ID（Amazon 资源名称）的所有参与者事件。

aws ivs-realtime list-participant-events \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --session-id st-a1b2c3d4e5f6g \
    --participant-id abCDEf12GHIj

输出：

{
    "events": [
        {
            "eventTime": "2023-04-26T20:36:28+00:00",
            "name": "LEFT",
            "participantId": "abCDEf12GHIj"
        },
        {
            "eventTime": "2023-04-26T20:36:28+00:00",
            "name": "PUBLISH_STOPPED",
            "participantId": "abCDEf12GHIj"
        },
        {
            "eventTime": "2023-04-26T20:30:34+00:00",
            "name": "JOINED",
            "participantId": "abCDEf12GHIj"
        },
        {
            "eventTime": "2023-04-26T20:30:34+00:00",
            "name": "PUBLISH_STARTED",
            "participantId": "abCDEf12GHIj"
        }
    ]
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

以下代码示例演示如何使用 list-participants。

Amazon CLI

获取舞台参与者名单

以下list-participants示例列出了指定阶段 ARN（Amazon 资源名称）的指定会话 ID 的所有参与者。

aws ivs-realtime list-participants \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --session-id st-a1b2c3d4e5f6g

输出：

{
    "participants": [
        {
            "firstJoinTime": "2023-04-26T20:30:34+00:00",
            "participantId": "abCDEf12GHIj"
            "published": true,
            "state": "DISCONNECTED",
            "userId": ""
        }
    ]
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考ListParticipants中的。

以下代码示例演示如何使用 list-stage-sessions。

Amazon CLI

获取舞台会议清单

以下list-stage-sessions示例列出了指定阶段 ARN（Amazon 资源名称）的所有会话。

aws ivs-realtime list-stage-sessions \
    --stage-arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh

输出：

{
    "stageSessions": [
        {
            "endTime": "2023-04-26T20:36:29+00:00",
            "sessionId": "st-a1b2c3d4e5f6g",
            "startTime": "2023-04-26T20:30:29.602000+00:00"
        }
    ]
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考ListStageSessions中的。

以下代码示例演示如何使用 list-stages。

Amazon CLI

获取有关所有阶段的摘要信息

以下list-stages示例列出了您的 Amazon 账户在处理 API 请求的 Amazon 区域中的所有阶段。

aws ivs-realtime list-stages

输出：

{
    "stages": [
        {
            "activeSessionId": "st-a1b2c3d4e5f6g",
            "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
            "name": "stage1",
            "tags": {}
        },
        {
            "activeSessionId": "st-a123bcd456efg",
            "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcd1234ABCD",
            "name": "stage2",
            "tags": {}
        },
        {
            "activeSessionId": "st-abcDEF1234ghi",
            "arn": "arn:aws:ivs:us-west-2:123456789012:stage/ABCD1234efgh",
            "name": "stage3",
            "tags": {}
        }
    ]
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考ListStages中的。

以下代码示例演示如何使用 list-storage-configurations。

Amazon CLI

列出合成存储配置

以下list-storage-configurations列出了在处理 API 请求的 Amazon 区域中您的 Amazon 账户的所有合成存储配置。

aws ivs-realtime list-storage-configurations

输出：

{
    "storageConfigurations": [
        {
            "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/abcdABCDefgh",
            "name": "test-sc-1",
            "s3": {
                "bucketName": "test-bucket-1-name"
            },
            "tags": {}
        },
        {
            "arn": "arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/ABCefgEFGabc",
            "name": "test-sc-2",
            "s3": {
                "bucketName": "test-bucket-2-name"
            },
            "tags": {}
        }
    ]
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

以下代码示例演示如何使用 start-composition。

Amazon CLI

示例 1：使用默认布局设置开始合成

以下start-composition示例启动指定舞台的合成，以流式传输到指定位置。

aws ivs-realtime start-composition \
    --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
    --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
        {"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
        "storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]'

输出：

{
    "composition": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh",
        "destinations": [
            {
                "configuration": {
                    "channel": {
                        "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
                        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                    },
                    "name": ""
                },
                "id": "AabBCcdDEefF",
                "state": "STARTING"
            },
            {
                "configuration": {
                    "name": "",
                    "s3": {
                        "encoderConfigurationArns": [
                            "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                        ],
                        "recordingConfiguration": {
                            "format": "HLS"
                        },
                        "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
                    }
                },
                "detail": {
                    "s3": {
                        "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
                    }
                },
                "id": "GHFabcgefABC",
                "state": "STARTING"
            }
        ],
        "layout": {
            "grid": {
                "featuredParticipantAttribute": ""
                "gridGap": 2,
                "omitStoppedVideo": false,
                "videoAspectRatio": "VIDEO",
                "videoFillMode": ""
            }
        },
        "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
        "startTime": "2023-10-16T23:24:00+00:00",
        "state": "STARTING",
        "tags": {}
    }
}

有关更多信息，请参阅 Amazon 互动视频服务用户指南中的复合录制（实时流媒体）。

示例 2：使用 PiP 布局开始合成

以下start-composition示例开始使用画中画布局将指定舞台流式传输到指定位置的合成。

aws ivs-realtime start-composition \
    --stage-arn arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd \
    --destinations '[{"channel": {"channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg", \
        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"}}, \
        {"s3":{"encoderConfigurationArns":["arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"], \
        "storageConfigurationArn":"arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"}}]' \
    --layout pip='{featuredParticipantAttribute="abcdefg"}'

输出：

{
    "composition": {
        "arn": "arn:aws:ivs:ap-northeast-1:123456789012:composition/wxyzWXYZpqrs",
        "destinations": [
            {
                "configuration": {
                    "channel": {
                        "channelArn": "arn:aws:ivs:ap-northeast-1:123456789012:channel/abcABCdefDEg",
                        "encoderConfigurationArn": "arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                    },
                    "name": ""
                },
                "id": "AabBCcdDEefF",
                "state": "STARTING"
            },
            {
                "configuration": {
                    "name": "",
                    "s3": {
                        "encoderConfigurationArns": [
                            "arn:aws:ivs:arn:aws:ivs:ap-northeast-1:123456789012:encoder-configuration/ABabCDcdEFef"
                        ],
                        "recordingConfiguration": {
                            "format": "HLS"
                        },
                        "storageConfigurationArn": "arn:arn:aws:ivs:ap-northeast-1:123456789012:storage-configuration/FefABabCDcdE"
                    }
                },
                "detail": {
                    "s3": {
                        "recordingPrefix": "aBcDeFgHhGfE/AbCdEfGhHgFe/GHFabcgefABC/composite"
                    }
                },
                "id": "GHFabcgefABC",
                "state": "STARTING"
            }
        ],
        "layout": {
            "pip": {
                "featuredParticipantAttribute": "abcdefg",
                "gridGap": 0,
                "omitStoppedVideo": false,
                "pipBehavior": "STATIC",
                "pipOffset": 0,
                "pipParticipantAttribute": "",
                "pipPosition": "BOTTOM_RIGHT",
                "videoFillMode": "COVER"
            }
        },
        "stageArn": "arn:aws:ivs:ap-northeast-1:123456789012:stage/defgABCDabcd",
        "startTime": "2023-10-16T23:24:00+00:00",
        "state": "STARTING",
        "tags": {}
    }
}

有关更多信息，请参阅 Amazon 互动视频服务用户指南中的复合录制（实时流媒体）。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考StartComposition中的。

以下代码示例演示如何使用 stop-composition。

Amazon CLI

停止合成

以下内容stop-composition停止由给定 ARN（Amazon 资源名称）指定的合成。

aws ivs-realtime stop-composition \
    --arn "arn:aws:ivs:ap-northeast-1:123456789012:composition/abcdABCDefgh"

此命令不生成任何输出。

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考StopComposition中的。

以下代码示例演示如何使用 update-stage。

Amazon CLI

更新舞台的配置

以下update-stage示例更新指定阶段 ARN 的阶段以更新阶段名称。

aws ivs-realtime update-stage \
    --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --name stage1a

输出：

{
    "stage": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "name": "stage1a"
    }
}

有关更多信息，请参阅《亚马逊互动视频服务用户指南》中的在 Amazon IVS 直播中启用多台主机。

  • 有关 API 的详细信息，请参阅Amazon CLI 命令参考UpdateStage中的。