Ejemplos de Amazon IVS Real-Time Streaming utilizando AWS CLI - AWS Command Line Interface
Acciones

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Ejemplos de Amazon IVS Real-Time Streaming utilizando AWS CLI

Los siguientes ejemplos de código muestran cómo realizar acciones e implementar escenarios comunes mediante Amazon IVS Real-Time Streaming. AWS Command Line Interface

Las acciones son extractos de código de programas más grandes y deben ejecutarse en contexto. Mientras las acciones muestran cómo llamar a las funciones de servicio individuales, es posible ver las acciones en contexto en los escenarios relacionados.

Cada ejemplo incluye un enlace al código fuente completo, donde puede encontrar instrucciones sobre cómo configurar y ejecutar el código en su contexto.

Acciones

En el siguiente ejemplo de código, se muestra cómo usar create-encoder-configuration.

AWS CLI

Para crear una configuración de codificador de composición

El siguiente create-encoder-configuration ejemplo crea una configuración de codificador de composición con las propiedades especificadas.

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

Salida:

{
    "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 obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

En el siguiente ejemplo de código, se muestra cómo usar create-participant-token.

AWS CLI

Para crear un token de participante en el escenario

En el siguiente create-participant-token ejemplo, se crea un token de participante para la etapa especificada.

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

Salida:

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

Para obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

En el siguiente ejemplo de código, se muestra cómo usar create-stage.

AWS CLI

Para crear un escenario

El siguiente create-stage ejemplo crea un escenario y un token de participante del escenario para un usuario específico.

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

Salida:

{
    "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 obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

  • Para API obtener más información, consulte CreateStagela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar create-storage-configuration.

AWS CLI

Para crear una configuración de almacenamiento de composiciones

El siguiente create-storage-configuration ejemplo crea una configuración de almacenamiento de composiciones con las propiedades especificadas.

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

Salida:

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

Para obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

En el siguiente ejemplo de código, se muestra cómo usar delete-encoder-configuration.

AWS CLI

Para eliminar la configuración de un codificador de composición

Lo siguiente delete-encoder-configuration elimina la configuración del codificador de composición especificada por el dato (nombre de recurso de ARN Amazon).

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

En el siguiente ejemplo de código, se muestra cómo usar delete-stage.

AWS CLI

Para eliminar una etapa

En el siguiente delete-stage ejemplo, se elimina la etapa especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

  • Para API obtener más información, consulte DeleteStagela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar delete-storage-configuration.

AWS CLI

Para eliminar una configuración de almacenamiento de maquetación

Lo siguiente delete-storage-configuration elimina la configuración de almacenamiento de composición especificada por el ARN (nombre de recurso de Amazon) indicado.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

En el siguiente ejemplo de código, se muestra cómo usar disconnect-participant.

AWS CLI

Para desconectar a un participante del escenario

El siguiente disconnect-participant ejemplo desconecta al participante especificado de la etapa especificada.

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

En el siguiente ejemplo de código, se muestra cómo usar get-composition.

AWS CLI

Ejemplo 1: Para obtener una composición con los ajustes de maquetación predeterminados

En el siguiente get-composition ejemplo, se obtiene la composición del ARN (Amazon Resource Name) especificado.

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

Salida:

{
    "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 obtener más información, consulte Grabación compuesta (transmisión en tiempo real) en la Guía del usuario de Amazon Interactive Video Service.

Ejemplo 2: Para obtener una composición con un diseño PiP

El siguiente get-composition ejemplo obtiene la composición del ARN (Amazon Resource Name) especificado, que utiliza el diseño PiP.

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

Salida:

{
    "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 obtener más información, consulte Grabación compuesta (transmisión en tiempo real) en la Guía del usuario de Amazon Interactive Video Service.

  • Para API obtener más información, consulte GetCompositionla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar get-encoder-configuration.

AWS CLI

Para obtener una configuración de codificador de composición

El siguiente get-encoder-configuration ejemplo obtiene la configuración del codificador de composición especificada por el dato ARN (Amazon Resource Name).

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

Salida:

{
    "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 obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

En el siguiente ejemplo de código, se muestra cómo usar get-participant.

AWS CLI

Para conseguir un participante en el escenario

En el siguiente get-participant ejemplo, se obtiene el participante de la etapa para un ID de participante y un ID de sesión específicos en la etapa especificada 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

Salida:

{
    "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 obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

  • Para API obtener más información, consulte GetParticipantla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar get-stage-session.

AWS CLI

Para obtener una sesión de escenario

En el siguiente get-stage-session ejemplo, se obtiene la sesión de la etapa para un ID de sesión específico de una etapa específica 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

Salida:

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

Para obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

  • Para API obtener más información, consulte GetStageSessionla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar get-stage.

AWS CLI

Para obtener la información de configuración de una etapa

El siguiente get-stage ejemplo obtiene la configuración de la etapa para una etapa específica ARN (Amazon Resource Name).

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

Salida:

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

Para obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

  • Para API obtener más información, consulte GetStagela Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar get-storage-configuration.

AWS CLI

Para obtener una configuración de almacenamiento de composiciones

El siguiente get-storage-configuration ejemplo obtiene la configuración de almacenamiento de la composición especificada por el dato ARN (Amazon Resource Name).

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

Salida:

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

Para obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

En el siguiente ejemplo de código, se muestra cómo usar list-compositions.

AWS CLI

Para obtener una lista de composiciones

A continuación list-compositions se muestran todas las composiciones de tu AWS cuenta en la AWS región en la que se procesa la API solicitud.

aws ivs-realtime list-compositions

Salida:

{
    "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 obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

  • Para API obtener más información, consulte ListCompositionsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar list-encoder-configurations.

AWS CLI

Para ver una lista de las configuraciones de los codificadores de composición

A continuación, se list-encoder-configurations enumeran todas las configuraciones de codificadores de composición de su AWS cuenta, en la AWS región en la que se procesa la API solicitud.

aws ivs-realtime list-encoder-configurations

Salida:

{
    "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 obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

En el siguiente ejemplo de código, se muestra cómo usar list-participant-events.

AWS CLI

Para obtener una lista de los eventos participantes en el escenario

En el siguiente list-participant-events ejemplo, se enumeran todos los eventos de los participantes para un ID de participante y un ID de sesión específicos de una etapa específica 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

Salida:

{
    "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 obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

En el siguiente ejemplo de código, se muestra cómo usar list-participants.

AWS CLI

Para obtener una lista de los participantes del escenario

El siguiente list-participants ejemplo muestra una lista de todos los participantes de un ID de sesión específico de una etapa específica ARN (Amazon Resource Name).

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

Salida:

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

Para obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

  • Para API obtener más información, consulte ListParticipantsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar list-stage-sessions.

AWS CLI

Para obtener una lista de las sesiones de escenario

En el siguiente list-stage-sessions ejemplo, se enumeran todas las sesiones de una etapa específica ARN (Amazon Resource Name).

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

Salida:

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

Para obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

  • Para API obtener más información, consulte ListStageSessionsla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar list-stages.

AWS CLI

Para obtener información resumida sobre todas las etapas

En el siguiente list-stages ejemplo, se enumeran todas las etapas de tu AWS cuenta, en la AWS región en la que se procesa la API solicitud.

aws ivs-realtime list-stages

Salida:

{
    "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 obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

  • Para API obtener más información, consulte ListStagesla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar list-storage-configurations.

AWS CLI

Para ver una lista de las configuraciones de almacenamiento de composiciones

A continuación, se list-storage-configurations enumeran todas las configuraciones de almacenamiento de composición de su AWS cuenta, en la AWS región en la que se procesa la API solicitud.

aws ivs-realtime list-storage-configurations

Salida:

{
    "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 obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

En el siguiente ejemplo de código, se muestra cómo usar start-composition.

AWS CLI

Ejemplo 1: Para iniciar una composición con los ajustes de maquetación predeterminados

En el siguiente start-composition ejemplo, se inicia una composición para el escenario especificado para que se transmita a las ubicaciones especificadas.

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

Salida:

{
    "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 obtener más información, consulte Grabación compuesta (transmisión en tiempo real) en la Guía del usuario de Amazon Interactive Video Service.

Ejemplo 2: Para iniciar una composición con un diseño PiP

En el siguiente start-composition ejemplo, se inicia una composición para el escenario especificado para que se transmita a las ubicaciones especificadas mediante el diseño 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"}'

Salida:

{
    "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 obtener más información, consulte Grabación compuesta (transmisión en tiempo real) en la Guía del usuario de Amazon Interactive Video Service.

  • Para API obtener más información, consulte StartCompositionla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar stop-composition.

AWS CLI

Para detener una composición

Lo siguiente stop-composition detiene la composición especificada por el dato ARN (nombre del recurso de Amazon).

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

Este comando no genera ninguna salida.

Para obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

  • Para API obtener más información, consulte StopCompositionla Referencia de AWS CLI comandos.

En el siguiente ejemplo de código, se muestra cómo usar update-stage.

AWS CLI

Para actualizar la configuración de una etapa

El siguiente update-stage ejemplo actualiza una etapa para una etapa específica ARN para actualizar el nombre de la etapa.

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

Salida:

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

Para obtener más información, consulte Habilitar varios hosts en una IVS transmisión de Amazon en la Guía del usuario de Amazon Interactive Video Service.

  • Para API obtener más información, consulte UpdateStagela Referencia de AWS CLI comandos.