Exemplos de Streaming em tempo real do Amazon IVS usando a AWS CLI - AWS Command Line Interface
Ações

Exemplos de Streaming em tempo real do Amazon IVS usando a AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando a AWS Command Line Interface com o streaming em tempo real do Amazon IVS.

Ações são trechos de código de programas maiores e devem ser executadas em contexto. Embora as ações mostrem como chamar funções de serviço individuais, você pode ver as ações no contexto em seus cenários relacionados.

Cada exemplo inclui um link para o código-fonte completo, em que você pode encontrar instruções sobre como configurar e executar o código.

Tópicos

Ações

O código de exemplo a seguir mostra como usar create-encoder-configuration.

AWS CLI

Para criar uma configuração de codificador de composição

O exemplo create-encoder-configuration a seguir cria um codificador de composição com as propriedades especificadas.

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

Saída:

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

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

O código de exemplo a seguir mostra como usar create-participant-token.

AWS CLI

Para criar um token de participante de palco

O exemplo create-participant-token a seguir cria um token de participante para o palco especificado.

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

Saída:

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

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

O código de exemplo a seguir mostra como usar create-stage.

AWS CLI

Exemplo 1: criar um palco

O exemplo create-stage a seguir cria um token de participante para o palco especificado.

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

Saída:

{
    "participantTokens": [
        {
            "participantId": "ABCDEfghij01234KLMN5678",
            "token": "a1b2c3d4567890ab",
            "userId": "alice"
        }
    ],
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "endpoints": {
            "events": "wss://global.events.live-video.net",
            "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
        },
        "name": "stage1",
        "tags": {}
    }
}

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

Exemplo 2: criar um palco e configurar a gravação de participantes individuais

O exemplo create-stage a seguir cria um palco e a configura a gravação individual do participante.

aws ivs-realtime create-stage \
    --name stage1 \
    --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh"}'

Saída:

{
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "autoParticipantRecordingConfiguration": {
             "mediaTypes": [
                   "AUDIO_VIDEO"
             ],
             "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
        },
        "endpoints": {
            "events": "wss://global.events.live-video.net",
            "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
        },
        "name": "stage1",
        "tags": {}
    }
}

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

  • Para ver detalhes da API, consulte CreateStage na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar create-storage-configuration.

AWS CLI

Para criar uma configuração de armazenamento de composição

O exemplo create-storage-configuration a seguir cria uma configuração de armazenamento de composição com as propriedades especificadas.

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

Saída:

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

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

O código de exemplo a seguir mostra como usar delete-encoder-configuration.

AWS CLI

Para excluir uma configuração de codificador de composição

O seguinte delete-encoder-configuration exclui a configuração do codificador de composição especificada pelo ARN (Amazon Resource Name) fornecido.

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

Este comando não produz saída.

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

O código de exemplo a seguir mostra como usar delete-public-key.

AWS CLI

Para excluir uma chave pública

O exemplo delete-public-key a seguir exclui a chave pública especificada.

aws ivs-realtime delete-public-key \
    --arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2

Este comando não produz saída.

Para obter mais informações, consulte Distribuir tokens de participantes no Guia do usuário de streaming em tempo real do Amazon IVS.

  • Para ver detalhes da API, consulte DeletePublicKey na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-stage.

AWS CLI

Para excluir uma estágio

O exemplo delete-stage a seguir exclui o palco especificado.

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

Este comando não produz saída.

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

  • Para ver detalhes da API, consulte DeleteStage na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar delete-storage-configuration.

AWS CLI

Para excluir uma configuração de armazenamento de composição

O seguinte delete-storage-configuration exclui a configuração de armazenamento de composição especificada pelo ARN (Amazon Resource Name) fornecido.

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

Este comando não produz saída.

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

O código de exemplo a seguir mostra como usar disconnect-participant.

AWS CLI

Como desconectar um participante do palco

O exemplo disconnect-participant a seguir desconecta o participante especificado do palco especificada.

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

Este comando não produz saída.

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

O código de exemplo a seguir mostra como usar get-composition.

AWS CLI

Exemplo 1: obter uma composição com configurações de layout padrão

O exemplo get-composition a seguir obtém a composição do ARN (Amazon Resource Name) especificado.

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

Saída:

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

Para obter mais informações, consulte Gravação composta (streaming em tempo real) no Guia do usuário do Amazon Interactive Video Service.

Exemplo 2: obter uma composição com layout PiP

O exemplo get-composition a seguir obtém a composição do ARN (Amazon Resource Name) especificado, usando o layout PiP.

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

Saída:

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

Para obter mais informações, consulte Gravação composta (streaming em tempo real) no Guia do usuário do Amazon Interactive Video Service.

  • Para ver detalhes da API, consulte GetComposition na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-encoder-configuration.

AWS CLI

Para obter uma configuração de codificador de composição

O exemplo get-encoder-configuration a seguir obtém a configuração do codificador de composição especificada pelo ARN (Amazon Resource Name) fornecido.

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

Saída:

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

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

O código de exemplo a seguir mostra como usar get-participant.

AWS CLI

Para obter um participante do palco

O exemplo get-participant a seguir obtém o participante do palco para um ID de participante e ID de sessão especificados no ARN (Amazon Resource Name) especificado do estágio.

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

Saída:

{
    "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,
        "recordingS3BucketName": "bucket-name",
        "recordingS3Prefix": "abcdABCDefgh/st-a1b2c3d4e5f6g/abCDEf12GHIj/1234567890",
        "recordingState": "ACTIVE",
        "sdkVersion", "",
        "state": "CONNECTED",
        "userId": "",
    }
}

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

  • Para ver detalhes da API, consulte GetParticipant na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-public-key.

AWS CLI

Para obter uma chave pública existente usada para assinar tokens de participantes do palco

O exemplo get-public-key a seguir obtém uma chave pública especificada pelo ARN fornecido para assinar tokens de participantes do palco.

aws ivs-realtime get-public-key \
    --arn arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2

Saída:

{
    "publicKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2",
        "name": "",
        "publicKeyMaterial": "-----BEGIN PUBLIC KEY-----\nMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEqVWUtqs6EktQMR1sCYmEzGvRwtaycI16\n9pmzcpiWu/uhNStGlteJ5odRfRwVkoQUMnSZXTCcbn9bBTTmiWo4mJcFOOAzsthH\n0UAb8NdD4tUE0At4a9hYP9IETEXAMPLE\n-----END PUBLIC KEY-----",
        "fingerprint": "12:a3:44:56:bc:7d:e8:9f:10:2g:34:hi:56:78:90:12",
        "tags": {}
    }
}

Para obter mais informações, consulte Distribuir tokens de participantes no Guia do usuário de streaming em tempo real do Amazon IVS.

  • Para ver detalhes da API, consulte GetPublicKey na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-stage-session.

AWS CLI

Para obter uma sessão de palco

O exemplo get-stage-session a seguir obtém a sessão de palco para um ID de sessão especificados no ARN (Amazon Resource Name) do palco especificado.

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

Saída:

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

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

  • Para ver detalhes da API, consulte GetStageSession na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-stage.

AWS CLI

Para obter as informações de configuração de um palco

O exemplo get-stage a seguir obtém a configuração de palco para um ARN (Amazon Resource Name) especificado.

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

Saída:

{
    "stage": {
        "activeSessionId": "st-a1b2c3d4e5f6g",
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "autoParticipantRecordingConfiguration": {
             "mediaTypes": [
                   "AUDIO_VIDEO"
             ],
             "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
        },
        "endpoints": {
            "events": "wss://global.events.live-video.net",
            "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
        },
        "name": "test",
        "tags": {}
    }
}

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

  • Para ver detalhes da API, consulte GetStage na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar get-storage-configuration.

AWS CLI

Para obter uma configuração de armazenamento de composição

O exemplo get-storage-configuration a seguir obtém a configuração de armazenamento da composição especificada pelo ARN (Amazon Resource Name) fornecido.

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

Saída:

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

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

O código de exemplo a seguir mostra como usar import-public-key.

AWS CLI

Para importar uma chave pública existente usada para assinar tokens de participantes do palco

O exemplo import-public-key a seguir importa uma chave pública de um arquivo de material, para ser usada para assinar tokens de participantes do palco.

aws ivs-realtime import-public-key \
    --public-key-material="`cat public.pem`"

Saída:

{
    "publicKey": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2",
        "name": "",
        "publicKeyMaterial": "-----BEGIN PUBLIC KEY-----\nMHYwEAYHKoZIzj0CAQYFK4EEACIDYgAEqVWUtqs6EktQMR1sCYmEzGvRwtaycI16\n9pmzcpiWu/uhNStGlteJ5odRfRwVkoQUMnSZXTCcbn9bBTTmiWo4mJcFOOAzsthH\n0UAb8NdD4tUE0At4a9hYP9IETEXAMPLE\n-----END PUBLIC KEY-----",
        "fingerprint": "12:a3:44:56:bc:7d:e8:9f:10:2g:34:hi:56:78:90:12",
        "tags": {}
    }
}

Para obter mais informações, consulte Distribuir tokens de participantes no Guia do usuário de streaming em tempo real do Amazon IVS.

  • Para ver detalhes da API, consulte ImportPublicKey na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-compositions.

AWS CLI

Para obter uma lista de composições

O seguinte list-compositions lista todas as composições da sua conta da AWS, na região da AWS em que a solicitação da API é processada.

aws ivs-realtime list-compositions

Saída:

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

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

  • Para ver detalhes da API, consulte ListCompositions na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-encoder-configurations.

AWS CLI

Para listar as configurações do codificador de composição

O seguinte list-encoder-configurations lista todas as configurações do codificador de composição da sua conta da AWS, na região da AWS em que a solicitação da API é processada.

aws ivs-realtime list-encoder-configurations

Saída:

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

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

O código de exemplo a seguir mostra como usar list-participant-events.

AWS CLI

Para obter uma lista de eventos de participantes

O exemplo list-participant-events a seguir lista todos os eventos de participantes para um ID de participante e ID de sessão especificados no ARN (Amazon Resource Name) especificado do estágio.

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

Saída:

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

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

O código de exemplo a seguir mostra como usar list-participants.

AWS CLI

Para obter uma lista de participantes de um palco

O exemplo list-participants a seguir lista todos os participantes para um ID de sessão especificado no ARN (Amazon Resource Name) do palco especificado.

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

Saída:

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

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

  • Para ver detalhes da API, consulte ListParticipants na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-public-keys.

AWS CLI

Para listar chaves públicas existentes disponíveis para assinar tokens de participantes do palco

O exemplo list-public-keys a seguir lista todas as chaves públicas disponíveis para os tokens dos participantes na região da AWS em que a solicitação da API é processada.

aws ivs-realtime list-public-keys

Saída:

{
    "publicKeys": [
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/abcdABC1efg2",
            "name": "",
            "tags": {}
        },
        {
            "arn": "arn:aws:ivs:us-west-2:123456789012:public-key/3bcdABCDefg4",
            "name": "",
            "tags": {}
        }
    ]
}

Para obter mais informações, consulte Distribuir tokens de participantes no Guia do usuário de streaming em tempo real do Amazon IVS.

  • Para ver detalhes da API, consulte ListPublicKeys na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-stage-sessions.

AWS CLI

Para obter uma lista das sessões de palco

O exemplo list-stage-sessions a seguir lista todas as sessões para o ARN (Amazon Resource Name) do palco especificado.

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

Saída:

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

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

  • Para ver detalhes da API, consulte ListStageSessions na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-stages.

AWS CLI

Para obter informações resumidas sobre todos os palcos

O seguinte list-stages lista todos os palcos da sua conta da AWS, na região da AWS em que a solicitação da API é processada.

aws ivs-realtime list-stages

Saída:

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

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

  • Para ver detalhes da API, consulte ListStages na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar list-storage-configurations.

AWS CLI

Para listar as configurações de armazenamento de composição

O seguinte list-storage-configurations lista todas as configurações de armazenamento de composição da sua conta da AWS, na região da AWS em que a solicitação da API é processada.

aws ivs-realtime list-storage-configurations

Saída:

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

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

O código de exemplo a seguir mostra como usar start-composition.

AWS CLI

Exemplo 1: iniciar uma composição com configurações de layout padrão

O exemplo start-composition a seguir inicia uma composição para o palco especificado a ser transmitida para os locais especificados.

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

Saída:

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

Para obter mais informações, consulte Gravação composta (streaming em tempo real) no Guia do usuário do Amazon Interactive Video Service.

Exemplo 2: iniciar uma composição com layout PiP

O exemplo start-composition a seguir inicia uma composição para o palco especificado a ser transmitida para os locais especificados usando o layout 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"}'

Saída:

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

Para obter mais informações, consulte Gravação composta (streaming em tempo real) no Guia do usuário do Amazon Interactive Video Service.

  • Para ver detalhes da API, consulte StartComposition na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar stop-composition.

AWS CLI

Como parar uma composição

O seguinte stop-composition interrompe a composição especificada pelo ARN (Amazon Resource Name) fornecido.

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

Este comando não produz saída.

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

  • Para ver detalhes da API, consulte StopComposition na Referência de comandos da AWS CLI.

O código de exemplo a seguir mostra como usar update-stage.

AWS CLI

Para atualizar uma configuração de estágio

O exemplo update-stage a seguir atualiza um estágio para um ARN de estágio especificado para atualizar o nome do estágio e configurar a gravação individual de participantes.

aws ivs-realtime update-stage \
    --arn arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh \
    --auto-participant-recording-configuration '{"mediaTypes": ["AUDIO_VIDEO"],"storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh"}' \
    --name stage1a

Saída:

{
    "stage": {
        "arn": "arn:aws:ivs:us-west-2:123456789012:stage/abcdABCDefgh",
        "autoParticipantRecordingConfiguration": {
             "mediaTypes": [
                   "AUDIO_VIDEO"
             ],
             "storageConfigurationArn": "arn:aws:ivs:us-west-2:123456789012:storage-configuration/abcdABCDefgh",
        },
        "endpoints": {
            "events": "wss://global.events.live-video.net",
            "whip": "https://1a2b3c4d5e6f.global-bm.whip.live-video.net"
        },
        "name": "stage1a",
        "tags": {}
    }
}

Para obter mais informações, consulte Habilitar vários hosts em um stream do Amazon IVS e Service Quotas do Amazon IVS.

  • Para ver detalhes da API, consulte UpdateStage na Referência de comandos da AWS CLI.