Mise en page

Définit l'objet transmis en tant que paramètre $layout des méthodes OpenTok->setArchiveLayout() et OpenTok->updateBroadcastLayout().

Pour instancier un objet `Layout`, appelez l'une des méthodes statiques de la classe `Layout` : getBestFit(), getPIP(), getVerticalPresentation(), getHorizontalPresentation()ou createCustom().

Voir OpenTok->setArchiveLayout(), OpenTok->updateBroadcastLayout(), Personnalisation de la mise en page vidéo pour les archives composéeset Configuration de la disposition vidéo pour les diffusions en direct via OpenTok.

Interfaces, classes, traits et énumérations

JsonSerializable

Table des matières

LAYOUT_BESTFIT  = « bestFit »

LAYOUT_CUSTOM  = « personnalisé »

LAYOUT_HORIZONTAL  = 'horizontalPresentation'

LAYOUT_PIP  = « pip »

LAYOUT_VERTICAL  = 'verticalPresentation'

createCustom()  : Mise en page : Renvoie un objet `Layout` définissant un type de mise en page personnalisé.

getBestFit()  : Mise en page : Renvoie un objet Layout définissant le type de mise en page prédéfini « le mieux adapté ».

getHorizontalPresentation()  : Mise en page : Renvoie un objet Layout définissant le type de mise en page prédéfini « présentation horizontale ».

getPIP()  : Mise en page : Renvoie un objet Layout définissant le type de mise en page prédéfini « image dans l'image ».

getVerticalPresentation()  : Mise en page : Renvoie un objet Layout définissant le type de mise en page prédéfini « présentation verticale ».

jsonSerialize()  : mitigé

setScreenshareType()  : Mise en page

toArray()  : tableau<chaîne|entier, type mixte>

toJson()  : chaîne de caractères : Renvoie une représentation sous forme de chaîne de caractères encodée au format JSON de la mise en page

Constantes

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'

Méthodes

createCustom()

Renvoie un objet `Layout` définissant un type de mise en page personnalisé.

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

Paramètres

$options : tableau<chaîne|entier, type mixte> : Un tableau contenant une propriété : $stylesheet, which is a string containing the stylesheet to be used for the layout.

Valeurs de retour

Mise en page —

getBestFit()

Renvoie un objet Layout définissant le type de mise en page prédéfini « le mieux adapté ».

public static getBestFit() : Layout

Valeurs de retour

Mise en page —

getHorizontalPresentation()

Renvoie un objet Layout définissant le type de mise en page prédéfini « présentation horizontale ».

public static getHorizontalPresentation() : Layout

Valeurs de retour

Mise en page —

getPIP()

Renvoie un objet Layout définissant le type de mise en page prédéfini « image dans l'image ».

public static getPIP() : Layout

Valeurs de retour

Mise en page —

getVerticalPresentation()

Renvoie un objet Layout définissant le type de mise en page prédéfini « présentation verticale ».

public static getVerticalPresentation() : Layout

Valeurs de retour

Mise en page —

jsonSerialize()

public jsonSerialize() : mixed

Valeurs de retour

mixte —

setScreenshareType()

public setScreenshareType(string $screenshareType) : Layout

Paramètres

$screenshareType : chaîne de caractères

Valeurs de retour

Mise en page —

toArray()

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

Valeurs de retour

tableau<chaîne|entier, type mixte> —

toJson()

Renvoie une représentation sous forme de chaîne de caractères encodée au format JSON de la mise en page

public toJson() : string

Valeurs de retour

chaîne de caractères —