Exemplos de streaming IVS em tempo real da Amazon usando AWS CLI

Os exemplos de código a seguir mostram como realizar ações e implementar cenários comuns usando o AWS Command Line Interface Amazon IVS Real-Time Streaming.

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, onde você pode encontrar instruções sobre como configurar e executar o código no contexto.

Tópicos

Ações

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 create-encoder-configuration exemplo a seguir cria uma configuração de 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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte CreateEncoderConfigurationna Referência de AWS CLI Comandos.

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

AWS CLI

Para criar um token de participante do estágio

O create-participant-token exemplo a seguir cria um token de participante para o estágio 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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte CreateParticipantTokenna Referência de AWS CLI Comandos.

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

AWS CLI

Para criar um palco

O create-stage exemplo a seguir cria um token de estágio e participante do estágio para um usuário 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",
        "name": "stage1",
        "tags": {}
    }
}

Para obter mais informações, consulte Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte CreateStagena Referência de AWS CLI Comandos.

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 create-storage-configuration exemplo 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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte CreateStorageConfigurationna Referência de AWS CLI Comandos.

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 dado (ARNAmazon Resource Name).


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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte DeleteEncoderConfigurationna Referência de AWS CLI Comandos.

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

AWS CLI

Para excluir um estágio

O delete-stage exemplo a seguir exclui o estágio 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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte DeleteStagena Referência de AWS CLI Comandos.

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 da composição especificada pelo dado ARN (Amazon Resource Name).


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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte DeleteStorageConfigurationna Referência de AWS CLI Comandos.

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

AWS CLI

Para desconectar um participante da etapa

O disconnect-participant exemplo a seguir desconecta o participante especificado do estágio especificado.


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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte DisconnectParticipantna Referência de AWS CLI Comandos.

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

AWS CLI

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

O get-composition exemplo 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: Para obter uma composição com layout PiP

O get-composition exemplo a seguir obtém a composição do ARN (Amazon Resource Name) especificado, que usa 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 API obter detalhes, consulte GetCompositionna Referência de AWS CLI Comandos.

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 get-encoder-configuration exemplo a seguir obtém a configuração do codificador de composição especificada pelo dado ARN (Amazon Resource Name).


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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte GetEncoderConfigurationna Referência de AWS CLI Comandos.

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

AWS CLI

Para conseguir um participante da etapa

O get-participant exemplo a seguir obtém o participante do estágio para um ID de participante e ID de sessão especificados no estágio especificado 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

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,
        "sdkVersion", "",
        "state": "DISCONNECTED",
        "userId": ""
    }
}

Para obter mais informações, consulte Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte GetParticipantna Referência de AWS CLI Comandos.

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

AWS CLI

Para obter uma sessão de palco

O get-stage-session exemplo a seguir obtém a sessão de estágio para um ID de sessão especificado de um estágio específico 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

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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte GetStageSessionna Referência de AWS CLI Comandos.

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

AWS CLI

Para obter as informações de configuração de um estágio

O get-stage exemplo a seguir obtém a configuração do estágio para um estágio específico ARN (Amazon Resource Name).


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",
        "name": "test",
        "tags": {}
    }
}

Para obter mais informações, consulte Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte GetStagena Referência de AWS CLI Comandos.

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 get-storage-configuration exemplo a seguir obtém a configuração de armazenamento da composição especificada pelo dado ARN (Amazon Resource Name).


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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte GetStorageConfigurationna Referência de AWS CLI Comandos.

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

AWS CLI

Para obter uma lista de composições

A seguir, são list-compositions listadas todas as composições AWS da sua conta, na AWS região em que a API solicitação é 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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte ListCompositionsna Referência de AWS CLI Comandos.

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

Veja a seguir list-encoder-configurations todas as configurações do codificador de composição da sua AWS conta, na AWS região em que a API solicitação é 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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte ListEncoderConfigurationsna Referência de AWS CLI Comandos.

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

AWS CLI

Para obter uma lista dos eventos dos participantes do palco

O list-participant-events exemplo a seguir lista todos os eventos de participantes para um ID de participante e ID de sessão específicos de um estágio específico 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

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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte ListParticipantEventsna Referência de AWS CLI Comandos.

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

AWS CLI

Para obter uma lista dos participantes da etapa

O list-participants exemplo a seguir lista todos os participantes de um ID de sessão específico de um estágio específico ARN (Amazon Resource Name).


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,
            "state": "DISCONNECTED",
            "userId": ""
        }
    ]
}

Para obter mais informações, consulte Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte ListParticipantsna Referência de AWS CLI Comandos.

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 list-stage-sessions exemplo a seguir lista todas as sessões de um estágio específico ARN (Amazon Resource Name).


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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte ListStageSessionsna Referência de AWS CLI Comandos.

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

AWS CLI

Para obter informações resumidas sobre todas as etapas

O list-stages exemplo a seguir lista todos os estágios AWS da sua conta, na AWS região em que a API solicitação é 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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte ListStagesna Referência de AWS CLI Comandos.

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

A seguir, são list-storage-configurations listadas todas as configurações de armazenamento de composição AWS da sua conta, na AWS região em que a API solicitação é 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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte ListStorageConfigurationsna Referência de AWS CLI Comandos.

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

AWS CLI

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

O start-composition exemplo a seguir inicia uma composição para o estágio especificado a ser transmitido 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: Para iniciar uma composição com o layout PiP

O start-composition exemplo a seguir inicia uma composição para o estágio especificado a ser transmitido 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 API obter detalhes, consulte StartCompositionna Referência de AWS CLI Comandos.

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

AWS CLI

Para parar uma composição

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


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 Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte StopCompositionna Referência de AWS CLI Comandos.

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

AWS CLI

Para atualizar a configuração de um estágio

O update-stage exemplo a seguir atualiza um estágio para um estágio especificado ARN para atualizar o nome do estágio.


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

Saída:


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

Para obter mais informações, consulte Habilitando vários hosts em um Amazon IVS Stream no Guia do usuário do Amazon Interactive Video Service.

Para API obter detalhes, consulte UpdateStagena Referência de AWS CLI Comandos.

Atenção O Javascript está desativado ou não está disponível no seu navegador.

Para usar a documentação da AWS, o Javascript deve estar ativado. Consulte as páginas de Ajuda do navegador para obter instruções.

Convenções do documento

Amazon IVS Chat

Amazon Kendra