Beispiele für Amazon IVS Real-Time Streaming mit AWS CLI - AWS Command Line Interface
Aktionen

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Beispiele für Amazon IVS Real-Time Streaming mit AWS CLI

Die folgenden Codebeispiele zeigen Ihnen, wie Sie mithilfe von Amazon IVS Real-Time Streaming Aktionen ausführen und allgemeine Szenarien implementieren. AWS Command Line Interface

Aktionen sind Codeauszüge aus größeren Programmen und müssen im Kontext ausgeführt werden. Aktionen zeigen Ihnen zwar, wie Sie einzelne Servicefunktionen aufrufen, aber Sie können Aktionen im Kontext der zugehörigen Szenarien sehen.

Jedes Beispiel enthält einen Link zum vollständigen Quellcode, in dem Sie Anweisungen zum Einrichten und Ausführen des Codes im Kontext finden.

Themen

Aktionen

Das folgende Codebeispiel zeigt die Verwendungcreate-encoder-configuration.

AWS CLI

Um eine Composition Encoder-Konfiguration zu erstellen

Im folgenden create-encoder-configuration Beispiel wird eine Composition Encoder-Konfiguration mit den angegebenen Eigenschaften erstellt.

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

Ausgabe:

{
    "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
        }
    }
}

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungcreate-participant-token.

AWS CLI

Um ein Etappenteilnehmer-Token zu erstellen

Im folgenden create-participant-token Beispiel wird ein Teilnehmer-Token für die angegebene Phase erstellt.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungcreate-stage.

AWS CLI

Um eine Phase zu erstellen

Im folgenden create-stage Beispiel wird ein Token für die Phase und den Teilnehmer der Phase für einen angegebenen Benutzer erstellt.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

  • APIEinzelheiten finden Sie CreateStagein der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungcreate-storage-configuration.

AWS CLI

Um eine Speicherkonfiguration für Kompositionen zu erstellen

Im folgenden create-storage-configuration Beispiel wird eine Kompositionsspeicherkonfiguration mit den angegebenen Eigenschaften erstellt.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungdelete-encoder-configuration.

AWS CLI

Um eine Composition Encoder-Konfiguration zu löschen

Im Folgenden wird die durch den angegebenen ARN (Amazon-Ressourcennamen) angegebene Konfiguration des Kompositions-Encoders delete-encoder-configuration gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungdelete-stage.

AWS CLI

Um eine Phase zu löschen

Im folgenden delete-stage Beispiel wird die angegebene Phase gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

  • APIEinzelheiten finden Sie DeleteStagein der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungdelete-storage-configuration.

AWS CLI

Um eine Speicherkonfiguration für Kompositionen zu löschen

Im Folgenden wird die durch den angegebenen ARN (Amazon-Ressourcennamen) angegebene Kompositionsspeicherkonfiguration delete-storage-configuration gelöscht.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungdisconnect-participant.

AWS CLI

Um die Verbindung mit einem Teilnehmer der Phase zu trennen

Im folgenden disconnect-participant Beispiel wird die Verbindung zwischen dem angegebenen Teilnehmer und der angegebenen Phase getrennt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungget-composition.

AWS CLI

Beispiel 1: Um eine Komposition mit Standard-Layouteinstellungen zu erhalten

Im folgenden get-composition Beispiel wird die Zusammensetzung für den angegebenen ARN (Amazon-Ressourcennamen) abgerufen.

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

Ausgabe:

{
    "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": {}
    }
}

Weitere Informationen finden Sie unter Composite Recording (Echtzeit-Streaming) im Amazon Interactive Video Service-Benutzerhandbuch.

Beispiel 2: Um eine Komposition mit PiP-Layout zu erhalten

Im folgenden get-composition Beispiel wird die Zusammensetzung für die angegebene ARN (Amazon-Ressourcenname) abgerufen, die das PiP-Layout verwendet.

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

Ausgabe:

{
    "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": {}
    }
}

Weitere Informationen finden Sie unter Composite Recording (Echtzeit-Streaming) im Amazon Interactive Video Service-Benutzerhandbuch.

  • APIEinzelheiten finden Sie GetCompositionunter AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-encoder-configuration.

AWS CLI

Um eine Composition Encoder-Konfiguration zu erhalten

Im folgenden get-encoder-configuration Beispiel wird die durch den angegebenen Wert ARN (Amazon-Ressourcenname) angegebene Konfiguration des Kompositions-Encoders abgerufen.

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

Ausgabe:

{
    "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
        }
    }
}

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungget-participant.

AWS CLI

Um einen Bühnenteilnehmer zu bekommen

Im folgenden get-participant Beispiel wird der Phasenteilnehmer für eine angegebene Teilnehmer-ID und Sitzungs-ID in der angegebenen Phase ARN (Amazon-Ressourcenname) abgerufen.

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

Ausgabe:

{
    "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": ""
    }
}

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

  • APIEinzelheiten finden Sie GetParticipantin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-stage-session.

AWS CLI

Um eine Bühnensitzung zu bekommen

Im folgenden get-stage-session Beispiel wird die Stage-Sitzung für eine angegebene Sitzungs-ID einer bestimmten Phase ARN (Amazon Resource Name) abgerufen.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

  • APIEinzelheiten finden Sie GetStageSessionin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-stage.

AWS CLI

Um die Konfigurationsinformationen einer Phase abzurufen

Im folgenden get-stage Beispiel wird die Stufenkonfiguration für eine angegebene Phase ARN (Amazon Resource Name) abgerufen.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

  • APIEinzelheiten finden Sie GetStagein der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungget-storage-configuration.

AWS CLI

Um eine Speicherkonfiguration für Kompositionen zu erhalten

Im folgenden get-storage-configuration Beispiel wird die durch den angegebenen Wert ARN (Amazon-Ressourcenname) angegebene Konfiguration des Kompositionsspeichers abgerufen.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendunglist-compositions.

AWS CLI

Um eine Liste von Kompositionen zu erhalten

Im Folgenden list-compositions sind alle Kompositionen für Ihr AWS Konto in der AWS Region aufgeführt, in der die API Anfrage bearbeitet wird.

aws ivs-realtime list-compositions

Ausgabe:

{
    "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": {}
        }
    ]
}

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendunglist-encoder-configurations.

AWS CLI

Um die Konfigurationen des Kompositions-Encoders aufzulisten

Im Folgenden list-encoder-configurations sind alle Composition Encoder-Konfigurationen für Ihr AWS Konto in der AWS Region aufgeführt, in der die API Anfrage bearbeitet wird.

aws ivs-realtime list-encoder-configurations

Ausgabe:

{
    "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": {}
        }
    ]
}

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendunglist-participant-events.

AWS CLI

Um eine Liste der Veranstaltungen der Bühnenteilnehmer zu erhalten

Das folgende list-participant-events Beispiel listet alle Teilnehmerereignisse für eine angegebene Teilnehmer-ID und Sitzungs-ID einer bestimmten Phase ARN (Amazon-Ressourcenname) auf.

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

Ausgabe:

{
    "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"
        }
    ]
}

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendunglist-participants.

AWS CLI

Um eine Liste der Teilnehmer der Phase zu erhalten

Das folgende list-participants Beispiel listet alle Teilnehmer für eine angegebene Sitzungs-ID einer bestimmten Phase ARN (Amazon Resource Name) auf.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendunglist-stage-sessions.

AWS CLI

Um eine Liste der Bühnensitzungen zu erhalten

Das folgende list-stage-sessions Beispiel listet alle Sitzungen für eine angegebene Phase ARN (Amazon-Ressourcenname) auf.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendunglist-stages.

AWS CLI

Um zusammenfassende Informationen zu allen Phasen zu erhalten

Im folgenden list-stages Beispiel werden alle Phasen Ihres AWS Kontos in der AWS Region aufgeführt, in der die API Anfrage bearbeitet wird.

aws ivs-realtime list-stages

Ausgabe:

{
    "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": {}
        }
    ]
}

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

  • APIEinzelheiten finden Sie ListStagesin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendunglist-storage-configurations.

AWS CLI

Um die Konfigurationen des Kompositionsspeichers aufzulisten

Im Folgenden list-storage-configurations werden alle Konfigurationen des Kompositionsspeichers für Ihr AWS Konto in der AWS Region aufgeführt, in der die API Anfrage bearbeitet wird.

aws ivs-realtime list-storage-configurations

Ausgabe:

{
    "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": {}
        }
    ]
}

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungstart-composition.

AWS CLI

Beispiel 1: Um eine Komposition mit Standard-Layouteinstellungen zu beginnen

Im folgenden start-composition Beispiel wird eine Komposition für die angegebene Phase gestartet, die an die angegebenen Speicherorte gestreamt wird.

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"}}]'

Ausgabe:

{
    "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": {}
    }
}

Weitere Informationen finden Sie unter Composite Recording (Echtzeit-Streaming) im Amazon Interactive Video Service-Benutzerhandbuch.

Beispiel 2: Um eine Komposition mit PiP-Layout zu starten

Im folgenden start-composition Beispiel wird eine Komposition für die angegebene Bühne gestartet, die mithilfe des PiP-Layouts an die angegebenen Orte gestreamt wird.

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"}'

Ausgabe:

{
    "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": {}
    }
}

Weitere Informationen finden Sie unter Composite Recording (Echtzeit-Streaming) im Amazon Interactive Video Service-Benutzerhandbuch.

Das folgende Codebeispiel zeigt die Verwendungstop-composition.

AWS CLI

Um eine Komposition zu beenden

Im Folgenden wird die durch den angegebenen ARN (Amazon-Ressourcennamen) angegebene Zusammensetzung stop-composition gestoppt.

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

Mit diesem Befehl wird keine Ausgabe zurückgegeben.

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

  • APIEinzelheiten finden Sie StopCompositionin der AWS CLI Befehlsreferenz.

Das folgende Codebeispiel zeigt die Verwendungupdate-stage.

AWS CLI

Um die Konfiguration einer Phase zu aktualisieren

Im folgenden update-stage Beispiel wird eine Phase für eine angegebene Phase aktualisiertARN, um den Namen der Phase zu aktualisieren.

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

Ausgabe:

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

Weitere Informationen finden Sie unter Aktivieren mehrerer Hosts auf einem Amazon IVS Stream im Amazon Interactive Video Service-Benutzerhandbuch.

  • APIEinzelheiten finden Sie UpdateStagein der AWS CLI Befehlsreferenz.