レイアウト

OpenTok->setArchiveLayout() および OpenTok->updateBroadcastLayout() メソッドの $layout パラメータとして渡されたオブジェクトを定義します。

Layout オブジェクトをインスタンス化するには、Layout クラスの静的メソッドのいずれかを呼び出します。 getBestFit(), getPIP(), getVerticalPresentation(), getHorizontalPresentation()あるいは createCustom().

参照 OpenTok->setArchiveLayout(), OpenTok->updateBroadcastLayout(), アーカイブ内の 動画レイアウトのカスタマイズそして OpenTokライブ配信の ビデオレイアウトの設定.

インターフェース、クラス、トレイト、および列挙型

JsonSerializable

目次

LAYOUT_BESTFIT  = 'bestFit'

LAYOUT_CUSTOM  = 'カスタム'

LAYOUT_HORIZONTAL  = 'horizontalPresentation'

LAYOUT_PIP  = 'pip'

LAYOUT_VERTICAL  = 'verticalPresentation'

createCustom()  : レイアウト : カスタムレイアウト型を定義するLayoutオブジェクトを返します。

getBestFit()  : レイアウト : 「ベストフィット」という事前定義されたレイアウトタイプを定義するLayoutオブジェクトを返します。

getHorizontalPresentation()  : レイアウト : 「水平表示」という事前定義されたレイアウトタイプを定義するLayoutオブジェクトを返します。

getPIP()  : レイアウト : 「ピクチャー・イン・ピクチャー」という事前定義されたレイアウトタイプを定義するLayoutオブジェクトを返します。

getVerticalPresentation()  : レイアウト : 「垂直表示」という事前定義されたレイアウトタイプを定義するLayoutオブジェクトを返します。

jsonSerialize()  : 混合

setScreenshareType()  : レイアウト

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

toJson()  : 文字列 : レイアウトのJSONエンコードされた文字列表現を返す

定数

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'

方法

createCustom()

カスタムレイアウト型を定義するLayoutオブジェクトを返します。

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

パラメータ

$options : array<string|int, mixed> : 1つのプロパティを含む配列： $stylesheet, which is a string containing the stylesheet to be used for the layout.

戻り値

レイアウト —

getBestFit()

「最適」な事前定義済みレイアウトタイプを定義するLayoutオブジェクトを返します。

public static getBestFit() : Layout

戻り値

レイアウト —

getHorizontalPresentation()

「水平表示」という事前定義されたレイアウトタイプを定義するLayoutオブジェクトを返します。

public static getHorizontalPresentation() : Layout

戻り値

レイアウト —

getPIP()

「ピクチャー・イン・ピクチャー」という定義済みレイアウトタイプを定義するLayoutオブジェクトを返します。

public static getPIP() : Layout

戻り値

レイアウト —

getVerticalPresentation()

「垂直表示」という事前定義されたレイアウトタイプを定義するLayoutオブジェクトを返します。

public static getVerticalPresentation() : Layout

戻り値

レイアウト —

jsonSerialize()

public jsonSerialize() : mixed

戻り値

混合 —

setScreenshareType()

public setScreenshareType(string $screenshareType) : Layout

パラメータ

$screenshareType : 文字列

戻り値

レイアウト —

toArray()

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

戻り値

array<string|int, mixed> —

toJson()

レイアウトのJSONエンコードされた文字列表現を返す

public toJson() : string

戻り値

文字列 —