ブロードキャスト
OpenTokセッションのブロードキャストを表します。
目次
$broadcastUrls : オブジェクト
$createdAt : int
$id : 文字列
$isDvr : bool
$isHls : bool
$isLowLatency : bool
$isStopped : bool
$maxBitRate : 文字列
$multiBroadcastTag : 文字列
$partnerId : 文字列
$resolution : 文字列
$sessionId : 文字列
$status : 文字列
$streamMode : 文字列
$updatedAt : int
__construct() : 混合
addStreamToBroadcast() : bool : ストリームモードが StreamMode.Manual に設定されて開始された、現在実行中の放送にストリームを追加します。 同じストリーム ID に対してこのメソッドを繰り返し呼び出すことで、 放送におけるそのストリームの音声または映像の表示/非表示を切り替えることができます。
jsonSerialize() : 混合
removeStreamFromBroadcast() : bool : 現在実行中の、 streamMode が StreamMode.Manual に設定されて開始された放送から、ストリームを削除します。
stop() : 混合 : ブロードキャストを停止します。
updateLayout() : 混合 : 放送のレイアウトを更新します。
プロパティ
$broadcastUrls
public object $broadcastUrls
HLSおよびRTMP配信ストリームの詳細。HLSストリームについては、URLが記載されています。詳しくは、 OpenTok ライブストリーミング開発者ガイド このURLの使用方法に関する詳細については、こちらをご覧ください。各RTMPストリームについて、RTMPサーバーのURLとストリーム 名、およびRTMPストリームのステータスが表示されます。
$createdAt
public int $createdAt
放送が作成された時点のタイムスタンプ。Unixエポックからの経過秒数で表されます。
$id
public string $id
その放送の固有ID。
$isDvr
public bool $isDvr
その放送が、HLSストリームに対するDVR機能をサポートしているかどうか。
$isHls
public bool $isHls
その放送がHLSに対応しているかどうか。
$isLowLatency
public bool $isLowLatency
その配信が、HLSストリームの低遅延モードに対応しているかどうか。
$isStopped
public bool $isStopped
放送が停止中（true）か、進行中（false）か。
$maxBitRate
public string $maxBitRate
放送用コンテンツの作成で許可される最大ビットレート。400000～2000000の範囲でなければなりません。
$multiBroadcastTag
public string $multiBroadcastTag
「マルチキャスト」が有効になっているかどうか。有効になっている場合、進行中のセッションの同時ブロードキャストごとに一意の文字列が割り当てられます。 参照 https://tokbox.com/developer/guides/archiving/#simultaneous-archives をご覧ください。
$partnerId
public string $partnerId
OpenTokのAPIキー。
$resolution
public string $resolution
アーカイブの解像度は、「640x480」（SD 横向き、デフォルト）、「1280x720」（HD 横向き）、 「1920x1080」（FHD 横向き）、「480x640」（SD 縦向き）、「720x1280」（HD 縦向き）、または「1080x1920」（FHD 縦向き）のいずれかです。 モバイルデバイスからの動画ストリーム（多くの場合、縦向きアスペクト比が使用されます）を含むアーカイブについては、縦向きアスペクト比を使用することをお勧めします。
$sessionId
public string $sessionId
OpenTokのセッションID。
$status
public string $status
ブロードキャスト状態。次のいずれか started または stopped
$streamMode
public string $streamMode
放送に含まれるストリームが自動的に選択されるかどうか（StreamMode.AUTO)
または手動で (StreamMode.MANUAL). ストリームが自動的に選択される場合（StreamMode.AUTO),
そのセッション内のすべての配信を放送に含めることができます。配信を手動で選択する場合
(StreamMode.MANUAL)、`
Broadcast.addStreamToBroadcast() そして Broadcast.removeStreamFromBroadcast() 方法。
手動モードでは、ストリームの音声、動画、あるいはその両方を
配信に含めるかどうかを指定できます。自動モードと手動モードのいずれにおいても、配信コンポーザーは以下に基づいてストリームを含めます。
ストリーム
優先順位付けルール.
$updatedAt
public int $updatedAt
放送の開始時刻または終了時刻。Unixエポックからの経過秒数で表されます。
方法
__construct()
public __construct(mixed $broadcastData[, mixed $options = array() ]) : mixed
パラメータ
$broadcastData : mixed
$options : mixed = array()
戻り値
混合 —
addStreamToBroadcast()
streamMode が StreamMode.Manual に設定された状態で開始された、現在実行中の放送にストリームを追加します。 同じストリーム ID を使用してこのメソッドを繰り返し呼び出すことで、 放送におけるそのストリームの音声または映像の表示/非表示を切り替えることができます。
public addStreamToBroadcast(string $streamId, bool $hasAudio, bool $hasVideo) : bool
パラメータ
$streamId : string : ストリームID。
$hasAudio : bool : 配信にストリームの音声を含まれるかどうか（true：デフォルト） または含まれないか（false）。
$hasVideo : bool : 放送にストリームの動画を組み込むかどうか（true：デフォルト） または組み込まないか（false）。
戻り値
bool —
成功した場合は true を返します。
jsonSerialize()
public jsonSerialize() : mixed
戻り値
混合 —
removeStreamFromBroadcast()
streamMode が StreamMode.Manual に設定された状態で開始された、現在配信中の放送からストリームを削除します。
public removeStreamFromBroadcast(string $streamId) : bool
パラメータ
$streamId : string : ストリームID。
戻り値
bool —
成功した場合は true を返します。
stop()
ブロードキャストを停止します。
public stop() : mixed
戻り値
混合 —
updateLayout()
放送のレイアウトを更新します。
public updateLayout(Layout $layout) : mixed
パラメータ
$layout : レイアウト : ブロードキャストのレイアウトタイプを定義するオブジェクト。
戻り値
混合 —