Layout

Definiert das Objekt, das als $layout-Parameter an die Methoden OpenTok->setArchiveLayout() und OpenTok->updateBroadcastLayout() übergeben wird.

Um ein Layout-Objekt zu instanziieren, rufen Sie eine der statischen Methoden der Layout-Klasse auf: getBestFit(), getPIP(), getVerticalPresentation(), getHorizontalPresentation(), oder createCustom().

Siehe OpenTok->setArchiveLayout(), OpenTok->updateBroadcastLayout(), Anpassung des Video-Layouts für zusammengestellte Archiveund Konfigurieren des Video-Layouts für OpenTok-Live-Streaming-Übertragungen.

Schnittstellen, Klassen, Traits und Enums

JsonSerializable

Inhaltsverzeichnis

LAYOUT_BESTFIT  = 'bestFit'

LAYOUT_CUSTOM  = 'benutzerdefiniert'

LAYOUT_HORIZONTAL  = 'horizontalPresentation'

LAYOUT_PIP  = 'pip'

LAYOUT_VERTICAL  = 'verticalPresentation'

createCustom()  : Layout : Gibt ein Layout-Objekt zurück, das einen benutzerdefinierten Layout-Typ definiert.

getBestFit()  : Layout : Gibt ein Layout-Objekt zurück, das den vordefinierten Layout-Typ „Best Fit“ definiert.

getHorizontalPresentation()  : Layout : Gibt ein Layout-Objekt zurück, das den vordefinierten Layout-Typ „horizontale Darstellung“ definiert.

getPIP()  : Layout : Gibt ein Layout-Objekt zurück, das den vordefinierten Layout-Typ „Bild-in-Bild“ definiert.

getVerticalPresentation()  : Layout : Gibt ein Layout-Objekt zurück, das den vordefinierten Layout-Typ „vertikale Darstellung“ definiert.

jsonSerialize()  : gemischt

setScreenshareType()  : Layout

toArray()  : array<string|int, mixed>

toJson()  : string : Gibt eine JSON-kodierte Zeichenfolgenrepräsentation des Layouts zurück

Konstanten

LAYOUT_BESTFIT

public mixed LAYOUT_BESTFIT = 'bestFit'

LAYOUT_CUSTOM

public mixed LAYOUT_CUSTOM = 'custom'

LAYOUT_HORIZONTAL

public mixed LAYOUT_HORIZONTAL = 'horizontalPresentation'

LAYOUT_PIP

public mixed LAYOUT_PIP = 'pip'

LAYOUT_VERTICAL

public mixed LAYOUT_VERTICAL = 'verticalPresentation'

Methoden

createCustom()

Gibt ein Layout-Objekt zurück, das einen benutzerdefinierten Layouttyp definiert.

public static createCustom(array<string|int, mixed> $options) : Layout

Parameter

$options : Array<String|Int, Mixed> : Ein Array, das eine Eigenschaft enthält: $stylesheet, which is a string containing the stylesheet to be used for the layout.

Rückgabewerte

Layout —

getBestFit()

Gibt ein Layout-Objekt zurück, das den vordefinierten Layout-Typ „Best Fit“ definiert.

public static getBestFit() : Layout

Rückgabewerte

Layout —

getHorizontalPresentation()

Gibt ein Layout-Objekt zurück, das den vordefinierten Layouttyp „horizontale Darstellung“ definiert.

public static getHorizontalPresentation() : Layout

Rückgabewerte

Layout —

getPIP()

Gibt ein Layout-Objekt zurück, das den vordefinierten Layout-Typ „Bild-in-Bild“ definiert.

public static getPIP() : Layout

Rückgabewerte

Layout —

getVerticalPresentation()

Gibt ein Layout-Objekt zurück, das den vordefinierten Layouttyp „vertikale Darstellung“ definiert.

public static getVerticalPresentation() : Layout

Rückgabewerte

Layout —

jsonSerialize()

public jsonSerialize() : mixed

Rückgabewerte

gemischt —

setScreenshareType()

public setScreenshareType(string $screenshareType) : Layout

Parameter

$screenshareType: Zeichenfolge

Rückgabewerte

Layout —

toArray()

public toArray() : array<string|int, mixed>

Rückgabewerte

array<string|int, mixed> —

toJson()

Gibt eine JSON-kodierte Zeichenfolgenrepräsentation des Layouts zurück

public toJson() : string

Rückgabewerte

Zeichenkette —