Amazon IVS 即時串流範例 AWS CLI - AWS Command Line Interface

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

Amazon IVS 即時串流範例 AWS CLI

下列程式碼範例說明如何透過 AWS Command Line Interface 搭配 Amazon IVS 即時串流使用來執行動作和實作常見案例。

Actions 是大型程式的程式碼摘錄,必須在內容中執行。雖然動作會告訴您如何呼叫個別服務函數,但您可以在其相關情境和跨服務範例中查看內容中的動作。

Scenarios (案例) 是向您展示如何呼叫相同服務中的多個函數來完成特定任務的程式碼範例。

每個範例都包含一個連結 GitHub,您可以在其中找到如何在內容中設定和執行程式碼的指示。

主題

動作

下列程式碼範例會示範如何使用create-encoder-configuration

AWS 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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

下列程式碼範例會示範如何使用create-participant-token

AWS CLI

若要建立階段參與者權杖

下列create-participant-token範例會針對指定階段建立參與者 toke。

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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

下列程式碼範例會示範如何使用create-stage

AWS CLI

建立階段

下列create-stage範例會為指定的使用者建立階段和階段參與者 Token。

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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考CreateStage中的。

下列程式碼範例會示範如何使用create-storage-configuration

AWS 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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

下列程式碼範例會示範如何使用delete-encoder-configuration

AWS CLI

刪除構成編碼器組態

以下內容delete-encoder-configuration會刪除指定 ARN (Amazon 資源名稱) 指定的構成編碼器組態。

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

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

下列程式碼範例會示範如何使用delete-stage

AWS CLI

若要刪除階段

下列delete-stage範例會刪除指定的階段。

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

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考DeleteStage中的。

下列程式碼範例會示範如何使用delete-storage-configuration

AWS CLI

刪除構成儲存組態

以下內容delete-storage-configuration會刪除指定 ARN (Amazon 資源名稱) 指定的構成儲存組態。

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

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

下列程式碼範例會示範如何使用disconnect-participant

AWS CLI

中斷階段參與者的連線

下列disconnect-participant範例中斷指定參與者與指定階段的連線。

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

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

下列程式碼範例會示範如何使用get-composition

AWS CLI

範例 1:取得具有預設版面設定的合成

下列get-composition範例會取得指定的 ARN (Amazon 資源名稱) 的組成。

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:要獲得具有 PiP 佈局的合成

下列get-composition範例會取得使用 PiP 版面配置的 ARN (Amazon 資源名稱) 指定的組成。

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 詳細資訊,請參閱AWS CLI 命令參考GetComposition中的。

下列程式碼範例會示範如何使用get-encoder-configuration

AWS 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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

下列程式碼範例會示範如何使用get-participant

AWS CLI

獲得舞台參與者

下列get-participant範例會取得指定參與者 ID 的階段參與者,以及指定階段 ARN (Amazon 資源名稱) 中的工作階段 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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考GetParticipant中的。

下列程式碼範例會示範如何使用get-stage-session

AWS CLI

若要取得階段作業

下列get-stage-session範例會取得指定階段 ARN (Amazon 資源名稱) 的指定工作階段 ID 的階段工作階段。

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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考GetStageSession中的。

下列程式碼範例會示範如何使用get-stage

AWS 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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考GetStage中的。

下列程式碼範例會示範如何使用get-storage-configuration

AWS 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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

下列程式碼範例會示範如何使用list-compositions

AWS CLI

若要取得構圖清單

以下list-compositions列出處理 API 請求所在 AWS 地區的所有 AWS 帳戶構圖。

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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListCompositions中的。

下列程式碼範例會示範如何使用list-encoder-configurations

AWS CLI

列出構成編碼器組態

以下list-encoder-configurations列出您 AWS 帳戶的所有構成編碼器配置,在處理 API 請求的 AWS 區域中。

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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

下列程式碼範例會示範如何使用list-participant-events

AWS CLI

若要取得階段參與者事件清單

下列list-participant-events範例會列出指定參與者 ID 的所有參與者事件,以及指定階段 ARN (Amazon 資源名稱) 的工作階段 ID。

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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

下列程式碼範例會示範如何使用list-participants

AWS 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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListParticipants中的。

下列程式碼範例會示範如何使用list-stage-sessions

AWS 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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

下列程式碼範例會示範如何使用list-stages

AWS CLI

若要取得有關所有階段的摘要資訊

下列list-stages範例會列出處理 API 要求所在 AWS 地區的 AWS 帳戶所有階段。

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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考ListStages中的。

下列程式碼範例會示範如何使用list-storage-configurations

AWS CLI

列出構成儲存組態

以下list-storage-configurations列出您 AWS 帳戶的所有構成儲存設定 (在處理 API 請求的 AWS 地區)。

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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

下列程式碼範例會示範如何使用start-composition

AWS 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範例會啟動指定階段的構成,以便使用 PiP 佈局串流至指定的位置。

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 詳細資訊,請參閱AWS CLI 命令參考StartComposition中的。

下列程式碼範例會示範如何使用stop-composition

AWS CLI

若要停止構圖

以下內容將stop-composition停止由給定 ARN(Amazon 資源名稱)指定的組合。

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

此命令不會產生輸出。

如需詳細資訊,請參閱 Amazon 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考StopComposition中的。

下列程式碼範例會示範如何使用update-stage

AWS 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 互動式視訊服務使用者指南中的在 Amazon IVS 串流上啟用多台主機

  • 如需 API 詳細資訊,請參閱AWS CLI 命令參考UpdateStage中的。