Diseño

Define el objeto pasado como parámetro $layout de los métodos OpenTok->setArchiveLayout() y OpenTok->updateBroadcastLayout().

Para crear una instancia de un objeto `Layout`, llama a uno de los métodos estáticos de la clase `Layout`: getBestFit(), getPIP(), getVerticalPresentation(), getHorizontalPresentation(), o createCustom().

Véase OpenTok->setArchiveLayout(), OpenTok->updateBroadcastLayout(), Personalización del diseño de vídeo para los archivos compuestos, y Configuración del diseño de vídeo para las retransmisiones en directo de OpenTok.

Interfaces, clases, rasgos y enumeraciones

JsonSerializable

Índice

LAYOUT_BESTFIT  = 'bestFit'

DISPOSICIÓN_PERSONALIZADA  = 'personalizado'

DISPOSICIÓN_HORIZONTAL  = 'horizontalPresentation'

LAYOUT_PIP  = 'pip'

DISPOSICIÓN_VERTICAL  = 'verticalPresentation'

createCustom()  : Diseño : Devuelve un objeto `Layout` que define un tipo de diseño personalizado.

getBestFit()  : Diseño : Devuelve un objeto Layout que define el tipo de diseño predefinido «que mejor se adapta».

getHorizontalPresentation()  : Diseño : Devuelve un objeto Layout que define el tipo de diseño predefinido «presentación horizontal».

getPIP()  : Diseño : Devuelve un objeto Layout que define el tipo de diseño predefinido «picture-in-picture».

getVerticalPresentation()  : Diseño : Devuelve un objeto Layout que define el tipo de diseño predefinido «presentación vertical».

jsonSerialize()  : variado

setScreenshareType()  : Diseño

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

toJson()  : cadena : Devuelve una representación en forma de cadena codificada en JSON del diseño

Constantes

LAYOUT_BESTFIT

public mixed LAYOUT_BESTFIT = 'bestFit'

DISPOSICIÓN_PERSONALIZADA

public mixed LAYOUT_CUSTOM = 'custom'

DISPOSICIÓN_HORIZONTAL

public mixed LAYOUT_HORIZONTAL = 'horizontalPresentation'

LAYOUT_PIP

public mixed LAYOUT_PIP = 'pip'

DISPOSICIÓN_VERTICAL

public mixed LAYOUT_VERTICAL = 'verticalPresentation'

Métodos

createCustom()

Devuelve un objeto «Layout» que define un tipo de diseño personalizado.

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

Parámetros

$options : array<string|int, mixed> : Un array que contiene una propiedad: $stylesheet, which is a string containing the stylesheet to be used for the layout.

Valores de retorno

Diseño —

getBestFit()

Devuelve un objeto Layout que define el tipo de diseño predefinido «que mejor se adapta».

public static getBestFit() : Layout

Valores de retorno

Diseño —

getHorizontalPresentation()

Devuelve un objeto Layout que define el tipo de diseño predefinido «presentación horizontal».

public static getHorizontalPresentation() : Layout

Valores de retorno

Diseño —

getPIP()

Devuelve un objeto Layout que define el tipo de diseño predefinido «picture-in-picture».

public static getPIP() : Layout

Valores de retorno

Diseño —

getVerticalPresentation()

Devuelve un objeto Layout que define el tipo de diseño predefinido «presentación vertical».

public static getVerticalPresentation() : Layout

Valores de retorno

Diseño —

jsonSerialize()

public jsonSerialize() : mixed

Valores de retorno

mixto —

setScreenshareType()

public setScreenshareType(string $screenshareType) : Layout

Parámetros

$screenshareType: cadena

Valores de retorno

Diseño —

toArray()

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

Valores de retorno

array<string|int, mixed> —

toJson()

Devuelve una representación en forma de cadena codificada en JSON del diseño

public toJson() : string

Valores de retorno

cadena —