JoinStorageSessionAsViewer - Amazon Kinesis Video Streams

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

JoinStorageSessionAsViewer

Note

L'RTCingestion Web avec prise en charge de plusieurs visionneurs (version préliminaire) est fournie en version préliminaire conformément aux conditions de AWS service et est sujette à modification. Il n'est actuellement disponible que dans us-east-1 (). IAD

Pour participer à l'avant-première, envoyez-nous un e-mail à kvs-webrtc-multi-view-preview@amazon.com.

Note

Avant de l'utiliserAPI, vous devez appeler le GetSignalingChannelEndpoint API pour demander le WEBRTC point de terminaison. Vous spécifiez ensuite le point de terminaison et la région dans votre JoinStorageSessionAsViewer API demande.

Participez à la RTC session Web de vidéo unidirectionnelle et/ou audio multidirectionnelle en cours en tant que dispositif de production vidéo pour un canal d'entrée. S'il n'existe pas de session pour le canal, créez une nouvelle session de streaming et fournissez le nom de ressource Amazon (ARN) du canal de signalisation.

Actuellement, pour SINGLE_MASTER ce type, un appareil de production vidéo est capable d'ingérer à la fois du contenu audio et vidéo dans un flux.

Important

Les spectateurs ne peuvent actuellement pas envoyer de pistes vidéo. Les spectateurs peuvent envoyer une piste audio facultative ou ne pas envoyer de piste du tout.

Exigences actuelles relatives à l'envoi des spectateurs par les participants :

  • Piste vidéo : non prise en charge

  • Piste audio (en option) : Opus

Si le participant principal est actuellement connecté à l'appareil de production vidéo, la vidéo ingérée qui en résulte dans le flux vidéo Kinesis comportera les paramètres suivants : vidéo et audio H.264. AAC

Tous les participants, y compris les spectateurs et le master, pourront s'entendre. Tous les spectateurs reçoivent également les médias du participant principal via le WebRTC.

Note

Les participants spectateurs se connectent directement à la session de stockage et non directement au participant principal. La session de stockage se charge du mixage, de la duplication et du routage du média vers la destination appropriée.

Note

Si le participant principal n'est pas présent, les spectateurs ne pourront pas s'entendre.

Une fois que le participant téléspectateur a négocié une connexion via le WebRTC, la session audio ingérée est stockée dans le flux vidéo Kinesis tant que le participant principal est également connecté à la session de stockage.

Vous pouvez également utiliser les fonctionnalités existantes de Kinesis Video Streams, HLS telles que DASH la lecture, la génération d'images GetImagesvia, etc., avec du contenu multimédia Web ingéréRTC.

Note

La livraison d'images et les notifications S3 ne sont actuellement pas prises en charge.

Note

Supposons qu'un seul appareil de production vidéo client puisse être associé à une session pour le canal. Si plusieurs clients rejoignent la session d'une chaîne spécifique en tant que périphérique de production vidéo, la demande la plus récente du client a priorité.

Restrictions

Les limites actuelles sont en place :

  • Nombre maximum de spectateurs : 3

  • Durée maximale pendant laquelle les spectateurs restent connectés à la session de stockage en l'absence d'un participant principal : 3 minutes

Important

Si un utilisateur se déconnecte de la session de stockage (ferme la connexion homologue), son quota (limite de spectateurs) reste consommé pendant 1 minute. Pendant cette période d'une minute, le spectateur peut l'invoquer API avec le même ID client pour rejoindre la session sans consommer un quota de spectateurs supplémentaire. Au bout d'une minute, le quota de spectateurs est dépassé et les autres spectateurs peuvent s'y joindre.

Informations supplémentaires

  • Idempotent - Ce n'APIest pas idempotent.

  • Comportement des nouvelles tentatives : ceci est considéré comme un nouvel API appel.

  • Appels simultanés - Les appels simultanés sont autorisés. Une offre est envoyée une fois par appel.

Syntaxe de la requête

POST /joinStorageSessionAsViewer HTTP/1.1 Content-type: application/json { "channelArn": "string", "clientId": "string" }

URIParamètres de demande

La demande n'utilise aucun URI paramètre.

Corps de la requête

La demande accepte les données suivantes au JSON format suivant.

channelArn

Le nom de ressource Amazon (ARN) du canal de signalisation.

Important

Notez la capitalisation de ce paramètre d'entrée.

Type : chaîne

Modèle : ^arn:(aws[a-zA-Z-]*):kinesisvideo:[a-z0-9-]+:[0-9]+:[a-z]+/[a-zA-Z0-9_.-]+/[0-9]+$

Obligatoire : oui

clientId

Identifiant unique du client expéditeur.

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.

Modèle : ^[a-zA-Z0-9_.-]+$

Obligatoire : oui

Syntaxe de la réponse

HTTP/1.1 200

Eléments de réponse

Si l'action aboutit, le service renvoie une réponse HTTP 200 avec un HTTP corps vide.

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

AccessDeniedException

Vous ne disposez pas des autorisations requises pour effectuer cette opération.

HTTPCode de statut : 403

ClientLimitExceededException

Kinesis Video Streams a limité le nombre de demandes car vous avez dépassé le nombre maximal d'appels clients autorisés. Essayez de passer l'appel plus tard.

HTTPCode de statut : 400

InvalidArgumentException

La valeur de ce paramètre d'entrée n'est pas valide.

HTTPCode de statut : 400

ResourceNotFoundException

La ressource spécifiée est introuvable.

HTTPCode de statut : 404

consultez aussi

Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :