Exemples d'Amazon IVS Real-Time Streaming utilisant AWS CLI - AWS Command Line Interface
Actions

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Exemples d'Amazon IVS Real-Time Streaming utilisant AWS CLI

Les exemples de code suivants vous montrent comment effectuer des actions et implémenter des scénarios courants en utilisant Amazon IVS Real-Time Streaming. AWS Command Line Interface

Les actions sont des extraits de code de programmes plus larges et doivent être exécutées dans leur contexte. Les actions vous indiquent comment appeler des fonctions de service individuelles, mais vous pouvez les visualiser dans leur contexte dans les scénarios correspondants.

Chaque exemple inclut un lien vers le code source complet, où vous trouverez des instructions sur la façon de configurer et d'exécuter le code en contexte.

Rubriques

Actions

L'exemple de code suivant montre comment utilisercreate-encoder-configuration.

AWS CLI

Pour créer une configuration d'encodeur de composition

L'create-encoder-configurationexemple suivant crée une configuration d'encodeur de composition avec les propriétés spécifiées.

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

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utilisercreate-participant-token.

AWS CLI

Pour créer un jeton de participant à une étape

L'create-participant-tokenexemple suivant crée un jeton de participation pour l'étape spécifiée.

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

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utilisercreate-stage.

AWS CLI

Pour créer une scène

L'create-stageexemple suivant crée un jeton d'étape et un jeton de participant à l'étape pour un utilisateur spécifié.

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

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour API plus de détails, voir CreateStagela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utilisercreate-storage-configuration.

AWS CLI

Pour créer une configuration de stockage de compositions

L'create-storage-configurationexemple suivant crée une configuration de stockage de compositions avec les propriétés spécifiées.

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

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utiliserdelete-encoder-configuration.

AWS CLI

Pour supprimer la configuration d'un encodeur de composition

Ce qui suit delete-encoder-configuration supprime la configuration de l'encodeur de composition spécifiée par le paramètre indiqué (ARNAmazon Resource Name).

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utiliserdelete-stage.

AWS CLI

Pour supprimer une étape

L'delete-stageexemple suivant supprime l'étape spécifiée.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour API plus de détails, voir DeleteStagela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserdelete-storage-configuration.

AWS CLI

Pour supprimer une configuration de stockage de compositions

Ce qui suit delete-storage-configuration supprime la configuration de stockage de la composition spécifiée par le paramètre indiqué ARN (Amazon Resource Name).

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utiliserdisconnect-participant.

AWS CLI

Pour déconnecter un participant à l'étape

L'disconnect-participantexemple suivant déconnecte le participant spécifié de l'étape spécifiée.

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utiliserget-composition.

AWS CLI

Exemple 1 : Pour obtenir une composition avec les paramètres de mise en page par défaut

L'get-compositionexemple suivant obtient la composition du ARN (Amazon Resource Name) spécifié.

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

Sortie :

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

Pour plus d'informations, consultez la section Enregistrement composite (diffusion en temps réel) dans le guide de l'utilisateur d'Amazon Interactive Video Service.

Exemple 2 : Pour obtenir une composition avec une mise en page PiP

L'get-compositionexemple suivant obtient la composition du ARN (Amazon Resource Name) spécifié, qui utilise la mise en page PiP.

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

Sortie :

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

Pour plus d'informations, consultez la section Enregistrement composite (diffusion en temps réel) dans le guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour API plus de détails, voir GetCompositionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-encoder-configuration.

AWS CLI

Pour obtenir la configuration d'un encodeur de composition

L'get-encoder-configurationexemple suivant obtient la configuration de l'encodeur de composition spécifiée par la donnée ARN (Amazon Resource Name).

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

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utiliserget-participant.

AWS CLI

Pour obtenir un participant à la scène

L'get-participantexemple suivant obtient le participant à l'étape pour un ID de participant et un identifiant de session spécifiés dans l'étape spécifiée ARN (Amazon Resource Name).

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

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour API plus de détails, voir GetParticipantla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-stage-session.

AWS CLI

Pour obtenir une séance sur scène

L'get-stage-sessionexemple suivant obtient la session d'étape pour un ID de session spécifié d'une étape spécifiée ARN (Amazon Resource Name).

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

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour API plus de détails, voir GetStageSessionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-stage.

AWS CLI

Pour obtenir les informations de configuration d'une étape

L'get-stageexemple suivant obtient la configuration de l'étape pour une étape spécifiée ARN (Amazon Resource Name).

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

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour API plus de détails, voir GetStagela section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserget-storage-configuration.

AWS CLI

Pour obtenir une configuration de stockage de compositions

L'get-storage-configurationexemple suivant obtient la configuration de stockage de composition spécifiée par la donnée ARN (Amazon Resource Name).

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

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utiliserlist-compositions.

AWS CLI

Pour obtenir une liste de compositions

Vous trouverez ci-dessous la list-compositions liste de toutes les compositions pour votre AWS compte, dans la AWS région où la API demande est traitée.

aws ivs-realtime list-compositions

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour API plus de détails, voir ListCompositionsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-encoder-configurations.

AWS CLI

Pour répertorier les configurations des encodeurs de composition

Vous trouverez ci-dessous la list-encoder-configurations liste de toutes les configurations d'encodeur de composition pour votre AWS compte, dans la AWS région où la API demande est traitée.

aws ivs-realtime list-encoder-configurations

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utiliserlist-participant-events.

AWS CLI

Pour obtenir la liste des événements organisés par les participants à la scène

L'list-participant-eventsexemple suivant répertorie tous les événements participants pour un identifiant de participant et un identifiant de session spécifiques pour une étape spécifiée ARN (Amazon Resource Name).

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

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utiliserlist-participants.

AWS CLI

Pour obtenir la liste des participants à l'étape

L'list-participantsexemple suivant répertorie tous les participants pour un ID de session spécifique d'une étape spécifiée ARN (Amazon Resource Name).

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

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour API plus de détails, voir ListParticipantsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-stage-sessions.

AWS CLI

Pour obtenir la liste des sessions sur scène

L'list-stage-sessionsexemple suivant répertorie toutes les sessions pour une étape spécifiée ARN (Amazon Resource Name).

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

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour API plus de détails, voir ListStageSessionsla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-stages.

AWS CLI

Pour obtenir des informations récapitulatives sur toutes les étapes

L'list-stagesexemple suivant répertorie toutes les étapes de votre AWS compte, dans la AWS région où la API demande est traitée.

aws ivs-realtime list-stages

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour API plus de détails, voir ListStagesla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserlist-storage-configurations.

AWS CLI

Pour répertorier les configurations de stockage de compositions

Vous trouverez ci-dessous la list-storage-configurations liste de toutes les configurations de stockage des compositions pour votre AWS compte, dans la AWS région où la API demande est traitée.

aws ivs-realtime list-storage-configurations

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

L'exemple de code suivant montre comment utiliserstart-composition.

AWS CLI

Exemple 1 : Pour démarrer une composition avec les paramètres de mise en page par défaut

L'start-compositionexemple suivant lance une composition pour la scène spécifiée à diffuser aux emplacements spécifiés.

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

Sortie :

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

Pour plus d'informations, consultez la section Enregistrement composite (diffusion en temps réel) dans le guide de l'utilisateur d'Amazon Interactive Video Service.

Exemple 2 : Pour démarrer une composition avec une mise en page PiP

L'start-compositionexemple suivant démarre une composition pour la scène spécifiée à diffuser vers les emplacements spécifiés à l'aide de la mise en page 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"}'

Sortie :

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

Pour plus d'informations, consultez la section Enregistrement composite (diffusion en temps réel) dans le guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour API plus de détails, voir StartCompositionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserstop-composition.

AWS CLI

Pour arrêter une composition

Ce qui suit stop-composition arrête la composition spécifiée par la donnée ARN (Amazon Resource Name).

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

Cette commande ne produit aucun résultat.

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour API plus de détails, voir StopCompositionla section Référence des AWS CLI commandes.

L'exemple de code suivant montre comment utiliserupdate-stage.

AWS CLI

Pour mettre à jour la configuration d'une étape

L'update-stageexemple suivant met à jour une étape pour une étape spécifiée afin de mettre ARN à jour le nom de l'étape.

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

Sortie :

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

Pour plus d'informations, consultez la section Activation de plusieurs hôtes sur un IVS flux Amazon dans le guide de l'utilisateur d'Amazon Interactive Video Service.

  • Pour API plus de détails, voir UpdateStagela section Référence des AWS CLI commandes.