Benutzerdefinierte Teilnehmeranordnung - Amazon IVS
Funktionsweise der benutzerdefinierten AnordnungErstellen von Token mit AnordnungsattributenBeispielanwendungsfälleAbwärtskompatibilität

Benutzerdefinierte Teilnehmeranordnung

Mit der benutzerdefinierten Teilnehmeranordnung können Sie die Positionierung der Teilnehmer im Raster- und im PiP-Layout auf Grundlage benutzerdefinierter Attributwerte in den Teilnehmer-Token steuern. Dazu gehört auch die Positionierung der hervorgehobenen Teilnehmer und die Auswahl der Teilnehmer für das PiP-Fenster. Das bietet eine deterministische Positionierung und ermöglicht rollenbasierte Layouts.

Funktionsweise der benutzerdefinierten Anordnung

Wenn participantOrderAttribute in Ihrer Layoutkonfiguration angegeben ist, werden die Teilnehmer nach den folgenden Regeln angeordnet:

  • Teilnehmer, deren Token das angegebene Anordnungsattribut enthalten, werden an erster Stelle positioniert und numerisch nach ihren Attributwerten angeordnet.

  • Für Teilnehmer ohne das Anordnungsattribut erfolgt die Anordnung wieder nach der Ankunftszeit. Sie werden hinter den angeordneten Teilnehmern positioniert.

  • Wenn mehrere Teilnehmer identische Anordnungswerte haben, werden sie auf der Bühne nach ihrer Ankunftszeit untersortiert.

  • Bei der Anordnung kommt eine numerische Sortierung (keine lexikografische) zum Einsatz, sodass „10" nach „9" kommt (nicht nach „1").

  • Negative Werte werden unterstützt. Sie werden vor positiven Werten positioniert.

  • Nichtnumerische Werte (z. B. „abc“, „1,5") werden als ungültig behandelt. Bei diesen Teilnehmern erfolgt die Anordnung wieder nach der Ankunftszeit.

Wichtig: Die Teilnehmeranordnung wird (unabhängig davon, ob sie nach der Ankunftszeit oder benutzerdefiniert erfolgt) erst wirksam, nachdem die Zusammensetzung begonnen hat. Für Teilnehmer, die vor Beginn der Zusammensetzung die Bühne betreten, kann die korrekte Anordnung nicht garantiert werden.

Erstellen von Token mit Anordnungsattributen

Um die benutzerdefinierte Teilnehmeranordnung zu nutzen, fügen Sie das Anordnungsattribut in die Teilnehmer-Token ein, wenn Sie diese erstellen:

aws ivs-realtime create-participant-token --stage-arn "arn:aws:ivs:us-east-1:123456789012:stage/u9OiE29bT7Xp" --attributes order=1

aws ivs-realtime create-participant-token --stage-arn "arn:aws:ivs:us-east-1:123456789012:stage/u9OiE29bT7Xp" --attributes order=2

aws ivs-realtime create-participant-token --stage-arn "arn:aws:ivs:us-east-1:123456789012:stage/u9OiE29bT7Xp" --attributes order=3

Sie können das Attribut für die benutzerdefinierte Teilnehmeranordnung mit den Attributen zur Auswahl der Teilnehmer für den hervorgehobenen Slot und das PiP-Fenster kombinieren:

aws ivs-realtime create-participant-token --stage-arn "arn:aws:ivs:us-east-1:123456789012:stage/u9OiE29bT7Xp" --attributes order=2,isFeatured=true

aws ivs-realtime create-participant-token --stage-arn "arn:aws:ivs:us-east-1:123456789012:stage/u9OiE29bT7Xp" --attributes order=3,isFeatured=true

aws ivs-realtime create-participant-token --stage-arn "arn:aws:ivs:us-east-1:123456789012:stage/u9OiE29bT7Xp" --attributes order=4,isPip=true

Beispielanwendungsfälle

Zu den beispielhaften Anwendungsfällen gehören:

  • Konsistente Positionierung – Die Teilnehmer behalten ihre Positionen bei, wenn sie sich mit demselben Token erneut verbinden.

  • Rollenbasierte Positionierung – Sie könnten beispielsweise Lehrer mit order=1 und Schüler mit order=2 angeben.

  • Prioritätsbasierte Layouts – VIP-Teilnehmer mit niedrigeren Anordnungswerten werden zuerst angezeigt.

  • Dynamische Layouts – Für komplexe Szenarien können Sie die benutzerdefinierte Anordnung mit featuredParticipantAttribute und pipParticipantAttribute kombinieren.

  • Bühnenübergreifende Interaktionen – Wenn Sie für Szenarien wie Wettbewerbe im VS-Modus, bei denen Streamende von verschiedenen Bühnen interagieren, die Teilnehmerreplikation nutzen, können Sie die Anordnungsattribute außer Kraft setzen, um die Positionierung in der Zusammensetzung der Zielbühne festzulegen.

Hinweis: In Anwendungsfällen mit Teilnehmerreplikation können Sie die Teilnehmerattribute (einschließlich des Anordnungsattributs) beim Start einer Replikation nach Bedarf außer Kraft setzen, um das gewünschte Layout in der Zielbühne zu erreichen.

Abwärtskompatibilität

Die benutzerdefinierte Teilnehmeranordnung ist eine optionale Funktion und vollständig abwärtskompatibel. Bestehende Zusammensetzungen ohne participantOrderAttribute funktionieren unverändert weiter, wobei die Anordnung nach der Ankunftszeit erfolgt. Wenn participantOrderAttribute auf eine leere Zeichenfolge gesetzt ist, ignoriert das System die benutzerdefinierte Anordnung vollständig und kehrt zum Standardverhalten zurück.