Layout

Define o objeto passado como parâmetro $layout dos métodos OpenTok->setArchiveLayout() e OpenTok->updateBroadcastLayout().

Para instanciar um objeto Layout, chame um dos métodos estáticos da classe Layout: getBestFit(), getPIP(), getVerticalPresentation(), getHorizontalPresentation(), ou createCustom().

Veja OpenTok->setArchiveLayout(), OpenTok->updateBroadcastLayout(), Personalização do layout do vídeo para arquivos compostos, e Configurando o layout de vídeo para transmissões ao vivo pelo OpenTok.

Interfaces, classes, traits e enums

JsonSerializable

Índice

LAYOUT_BESTFIT  = 'bestFit'

LAYOUT_CUSTOM  = 'personalizado'

LAYOUT_HORIZONTAL  = 'apresentação horizontal'

LAYOUT_PIP  = 'pip'

LAYOUT_VERTICAL  = 'verticalPresentation'

createCustom()  : Layout : Retorna um objeto Layout que define um tipo de layout personalizado.

getBestFit()  : Layout : Retorna um objeto Layout que define o tipo de layout predefinido de “melhor ajuste”.

getHorizontalPresentation()  : Layout : Retorna um objeto Layout que define o tipo de layout predefinido “apresentação horizontal”.

getPIP()  : Layout : Retorna um objeto Layout que define o tipo de layout predefinido “picture-in-picture”.

getVerticalPresentation()  : Layout : Retorna um objeto Layout que define o tipo de layout predefinido “apresentação vertical”.

jsonSerialize()  : misto

setScreenshareType()  : Layout

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

toJson()  : string : Retorna uma representação em string codificada em JSON do layout

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étodos

createCustom()

Retorna um objeto Layout que define um tipo de layout personalizado.

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

Parâmetros

$options : array<string|int, mixed> : Um array contendo uma propriedade: $stylesheet, which is a string containing the stylesheet to be used for the layout.

Valores de retorno

Layout —

getBestFit()

Retorna um objeto Layout que define o tipo de layout predefinido de “melhor ajuste”.

public static getBestFit() : Layout

Valores de retorno

Layout —

getHorizontalPresentation()

Retorna um objeto Layout que define o tipo de layout predefinido “apresentação horizontal”.

public static getHorizontalPresentation() : Layout

Valores de retorno

Layout —

getPIP()

Retorna um objeto Layout que define o tipo de layout predefinido “picture-in-picture”.

public static getPIP() : Layout

Valores de retorno

Layout —

getVerticalPresentation()

Retorna um objeto Layout que define o tipo de layout predefinido “apresentação vertical”.

public static getVerticalPresentation() : Layout

Valores de retorno

Layout —

jsonSerialize()

public jsonSerialize() : mixed

Valores de retorno

misto —

setScreenshareType()

public setScreenshareType(string $screenshareType) : Layout

Parâmetros

$screenshareType : string

Valores de retorno

Layout —

toArray()

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

Valores de retorno

array<string|int, mixed> —

toJson()

Retorna uma representação do layout na forma de uma string codificada em JSON

public toJson() : string

Valores de retorno

string —