Contoh Streaming IVS Waktu Nyata Amazon menggunakan AWS CLI - AWS SDKContoh Kode
Tindakan

Ada lebih banyak AWS SDK contoh yang tersedia di GitHub repo SDKContoh AWS Dokumen.

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Contoh Streaming IVS Waktu Nyata Amazon menggunakan AWS CLI

Contoh kode berikut menunjukkan kepada Anda cara melakukan tindakan dan menerapkan skenario umum dengan menggunakan Streaming IVS Real-Time AWS Command Line Interface dengan Amazon.

Tindakan adalah kutipan kode dari program yang lebih besar dan harus dijalankan dalam konteks. Sementara tindakan menunjukkan cara memanggil fungsi layanan individual, Anda dapat melihat tindakan dalam konteks dalam skenario terkait.

Setiap contoh menyertakan tautan ke kode sumber lengkap, di mana Anda dapat menemukan instruksi tentang cara mengatur dan menjalankan kode dalam konteks.

Tindakan

Contoh kode berikut menunjukkan cara menggunakancreate-encoder-configuration.

AWS CLI

Untuk membuat konfigurasi encoder komposisi

create-encoder-configurationContoh berikut membuat konfigurasi encoder komposisi dengan properti yang ditentukan.

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

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakancreate-participant-token.

AWS CLI

Untuk membuat token peserta panggung

create-participant-tokenContoh berikut membuat toke peserta untuk tahap yang ditentukan.

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

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakancreate-stage.

AWS CLI

Contoh 1: Untuk membuat panggung

create-stageContoh berikut membuat token peserta tahap dan tahap untuk pengguna tertentu.

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

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh 2: Untuk membuat panggung dan mengkonfigurasi rekaman peserta individual

create-stageContoh berikut membuat panggung dan mengkonfigurasi rekaman peserta individu.

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

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

  • Untuk API detailnya, lihat CreateStagedi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakancreate-storage-configuration.

AWS CLI

Untuk membuat konfigurasi penyimpanan komposisi

create-storage-configurationContoh berikut membuat konfigurasi penyimpanan komposisi dengan properti yang ditentukan.

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

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakandelete-encoder-configuration.

AWS CLI

Untuk menghapus konfigurasi encoder komposisi

Berikut ini delete-encoder-configuration menghapus konfigurasi encoder komposisi yang ditentukan oleh yang diberikan (ARNAmazon Resource Name).

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakandelete-public-key.

AWS CLI

Untuk menghapus kunci publik

Berikut ini delete-public-key menghapus kunci publik yang ditentukan.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mendistribusikan Token Peserta di Panduan Pengguna Streaming IVS Waktu Nyata Amazon.

Contoh kode berikut menunjukkan cara menggunakandelete-stage.

AWS CLI

Untuk menghapus panggung

delete-stageContoh berikut menghapus tahap yang ditentukan.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

  • Untuk API detailnya, lihat DeleteStagedi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakandelete-storage-configuration.

AWS CLI

Untuk menghapus konfigurasi penyimpanan komposisi

Berikut ini delete-storage-configuration menghapus konfigurasi penyimpanan komposisi yang ditentukan oleh yang diberikan ARN (Nama Sumber Daya Amazon).

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakandisconnect-participant.

AWS CLI

Untuk memutuskan sambungan peserta panggung

disconnect-participantContoh berikut memutus peserta yang ditentukan dari tahap yang ditentukan.

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakanget-composition.

AWS CLI

Contoh 1: Untuk mendapatkan komposisi dengan pengaturan tata letak default

get-compositionContoh berikut mendapatkan komposisi untuk ARN (Amazon Resource Name) yang ditentukan.

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

Output:

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

Untuk informasi selengkapnya, lihat Perekaman Komposit (Streaming Waktu Nyata) di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh 2: Untuk mendapatkan komposisi dengan tata letak PiP

get-compositionContoh berikut mendapatkan komposisi untuk ARN (Amazon Resource Name) yang ditentukan, yang menggunakan tata letak PiP.

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

Output:

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

Untuk informasi selengkapnya, lihat Perekaman Komposit (Streaming Waktu Nyata) di Panduan Pengguna Layanan Video Interaktif Amazon.

  • Untuk API detailnya, lihat GetCompositiondi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanget-encoder-configuration.

AWS CLI

Untuk mendapatkan konfigurasi encoder komposisi

get-encoder-configurationContoh berikut mendapatkan konfigurasi encoder komposisi yang ditentukan oleh yang diberikan (ARNAmazon Resource Name).

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

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakanget-participant.

AWS CLI

Untuk mendapatkan peserta panggung

get-participantContoh berikut mendapatkan peserta tahap untuk ID peserta tertentu dan ID sesi dalam tahap tertentu 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

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

  • Untuk API detailnya, lihat GetParticipantdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanget-public-key.

AWS CLI

Untuk mendapatkan kunci publik yang ada digunakan untuk menandatangani token peserta panggung

get-public-keyContoh berikut mendapatkan kunci publik yang ditentukan oleh yang disediakanARN, untuk menandatangani token peserta tahap.

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

Output:

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

Untuk informasi selengkapnya, lihat Mendistribusikan Token Peserta di Panduan Pengguna Streaming IVS Waktu Nyata Amazon.

  • Untuk API detailnya, lihat GetPublicKeydi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanget-stage-session.

AWS CLI

Untuk mendapatkan sesi panggung

get-stage-sessionContoh berikut mendapatkan sesi tahap untuk ID sesi tertentu dari tahap tertentu 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

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakanget-stage.

AWS CLI

Untuk mendapatkan informasi konfigurasi panggung

get-stageContoh berikut mendapatkan konfigurasi tahap untuk tahap tertentu ARN (Amazon Resource Name).

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

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

  • Untuk API detailnya, lihat GetStagedi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanget-storage-configuration.

AWS CLI

Untuk mendapatkan konfigurasi penyimpanan komposisi

get-storage-configurationContoh berikut mendapatkan konfigurasi penyimpanan komposisi yang ditentukan oleh yang diberikan ARN (Amazon Resource Name).

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

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakanimport-public-key.

AWS CLI

Untuk mengimpor kunci publik yang ada untuk digunakan untuk menandatangani token peserta panggung

import-public-keyContoh berikut mengimpor kunci publik dari file material, yang akan digunakan untuk menandatangani token peserta tahap.

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

Output:

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

Untuk informasi selengkapnya, lihat Mendistribusikan Token Peserta di Panduan Pengguna Streaming IVS Waktu Nyata Amazon.

Contoh kode berikut menunjukkan cara menggunakanlist-compositions.

AWS CLI

Untuk mendapatkan daftar komposisi

Berikut ini list-compositions mencantumkan semua komposisi untuk AWS akun Anda, di AWS wilayah tempat API permintaan diproses.

aws ivs-realtime list-compositions

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakanlist-encoder-configurations.

AWS CLI

Untuk membuat daftar konfigurasi encoder komposisi

Berikut ini list-encoder-configurations mencantumkan semua konfigurasi encoder komposisi untuk AWS akun Anda, di AWS wilayah tempat API permintaan diproses.

aws ivs-realtime list-encoder-configurations

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakanlist-participant-events.

AWS CLI

Untuk mendapatkan daftar acara peserta panggung

list-participant-eventsContoh berikut mencantumkan semua peristiwa peserta untuk ID peserta tertentu dan ID sesi dari tahap tertentu ARN (Nama Sumber Daya Amazon).

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

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakanlist-participants.

AWS CLI

Untuk mendapatkan daftar peserta panggung

list-participantsContoh berikut mencantumkan semua peserta untuk ID sesi tertentu dari tahap tertentu ARN (Nama Sumber Daya Amazon).

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

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakanlist-public-keys.

AWS CLI

Untuk mencantumkan kunci publik yang ada yang tersedia untuk menandatangani token peserta panggung

list-public-keysContoh berikut mencantumkan semua kunci publik yang tersedia untuk menandatangani token peserta tahap, di AWS wilayah tempat API permintaan diproses.

aws ivs-realtime list-public-keys

Output:

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

Untuk informasi selengkapnya, lihat Mendistribusikan Token Peserta di Panduan Pengguna Streaming IVS Waktu Nyata Amazon.

  • Untuk API detailnya, lihat ListPublicKeysdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanlist-stage-sessions.

AWS CLI

Untuk mendapatkan daftar sesi panggung

list-stage-sessionsContoh berikut mencantumkan semua sesi untuk tahap tertentu ARN (Amazon Resource Name).

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

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakanlist-stages.

AWS CLI

Untuk mendapatkan informasi ringkasan tentang semua tahapan

list-stagesContoh berikut mencantumkan semua tahapan untuk AWS akun Anda, di AWS wilayah tempat API permintaan diproses.

aws ivs-realtime list-stages

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

  • Untuk API detailnya, lihat ListStagesdi Referensi AWS CLI Perintah.

Contoh kode berikut menunjukkan cara menggunakanlist-storage-configurations.

AWS CLI

Untuk membuat daftar konfigurasi penyimpanan komposisi

Berikut ini list-storage-configurations mencantumkan semua konfigurasi penyimpanan komposisi untuk AWS akun Anda, di AWS wilayah tempat API permintaan diproses.

aws ivs-realtime list-storage-configurations

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakanstart-composition.

AWS CLI

Contoh 1: Untuk memulai komposisi dengan pengaturan tata letak default

start-compositionContoh berikut memulai komposisi untuk tahap tertentu yang akan dialirkan ke lokasi yang ditentukan.

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

Output:

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

Untuk informasi selengkapnya, lihat Perekaman Komposit (Streaming Waktu Nyata) di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh 2: Untuk memulai komposisi dengan tata letak PiP

start-compositionContoh berikut memulai komposisi untuk tahap tertentu yang akan dialirkan ke lokasi yang ditentukan menggunakan tata letak 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"}'

Output:

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

Untuk informasi selengkapnya, lihat Perekaman Komposit (Streaming Waktu Nyata) di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakanstop-composition.

AWS CLI

Untuk menghentikan komposisi

Berikut ini stop-composition menghentikan komposisi yang ditentukan oleh yang diberikan ARN (Nama Sumber Daya Amazon).

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

Perintah ini tidak menghasilkan output.

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

Contoh kode berikut menunjukkan cara menggunakanupdate-stage.

AWS CLI

Untuk memperbarui konfigurasi tahap

update-stageContoh berikut memperbarui tahapan untuk tahap tertentu ARN untuk memperbarui nama panggung dan mengonfigurasi rekaman peserta individu.

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

Output:

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

Untuk informasi selengkapnya, lihat Mengaktifkan Beberapa Host di Amazon IVS Stream di Panduan Pengguna Layanan Video Interaktif Amazon.

  • Untuk API detailnya, lihat UpdateStagedi Referensi AWS CLI Perintah.