OpenTokのライブストリーミング配信を表すオブジェクト。

を呼ばないでください。 new() コンストラクタ。ライブストリーミング配信を開始するには、 OpenTok.startBroadcast() メソッドを使用する。

特性：
名称 タイプ 説明
id ストリング 放送ID。
sessionId ストリング この放送に関連付けられている OpenTok セッションのセッション ID。
projectId ストリング その放送に関連付けられているAPIキー。
createdAt Numbers 放送が作成された時刻（UNIXエポックからの経過時間、ミリ秒単位）。
resolution ストリング 放送の解像度：以下のいずれか： - 「640x480」 - 「1280x720」 - 「1920x1080」 - 「480x640」 - 「720x1280」 - 「1080x1920」 モバイルデバイスからの動画ストリーム（多くの場合、縦向きアスペクト比が使用されます）を含む配信では、縦向きアスペクト比を使用することをお勧めします。このプロパティはオプションです。
broadcastUrls 目的 HLSおよびRTMPの配信に関する詳細情報を格納するオブジェクト。 - hls (文字列) — HLS エンドポイントを指定した場合、このオブジェクトには hls プロパティが含まれ、その値は HLS 配信の URL に設定されます。 この HLS ブロードキャスト URL は、.ts メディアセグメントファイル（MPEG-2 トランスポートストリームファイル）への URL リストを含む、.M3U8 形式のプレイリストであるインデックスファイルを指していることに注意してください。 プレイリストインデックスファイルとメディアセグメントファイルの両方の URL は、HTTP レスポンスが返されるとすぐに提供されますが、OpenTok セッションにおける HLS ブロードキャストとライブストリームの間には遅延があるため、HLS ブロードキャストの開始から 15 ～ 20 秒経過するまで、これらの URL にアクセスしてはなりません。 参照 https://developer.apple.com/library/ios/technotes/tn2288/\\_index.html HLS用のプレイリストインデックスファイルおよびメディアセグメントファイルに関する詳細については、以下をご覧ください。 - hlsStatus (文字列) — 「hlsStatus」フィールドの取り得る状態は以下の通りです。 - 'connecting'：OpenTok サーバーがトランスコーダーの起動処理中です。 これが初期状態です - 'ready': OpenTokサーバーの初期化は成功しましたが、CDNはメディアを消費していません - 'live」：OpenTokサーバーの初期化は正常に完了し、CDNがメディアを配信中です。 - 「ended」：ソースストリームが終了しました（DVRが有効で、事前録画されたメディアがリクエストされた場合、ステータスは「live」に移行します）。 - 「error」：OpenTokプラットフォームでエラーが発生しています。 - rtmp (オブジェクト配列) — RTMP ストリームのエンドポイントを指定した場合、このオブジェクトには rtmp プロパティが含まれます。これは、各 RTMP ストリームに関する情報を含むオブジェクトの配列です。これらの各オブジェクトには、以下のプロパティがあります： - id RTMPストリームに割り当てたID - serverUrl サーバーのURL - streamName ストリーム名 - status ストリームの状態
maxDuration Numbers ブロードキャストの最大許容時間（秒単位）。この時間が経過してもブロードキャストが開始されたままである場合、自動的に停止されます。
streamMode ストリング 放送のストリームモード。以下のいずれかに設定できます。 - 「auto」 — 放送に含まれるストリームは自動的に選択されます （デフォルト）。 - 「manual」 — への呼び出しに基づいて、含めるストリームを指定します。 OpenTok.addBroadcastStream() そして OpenTok.removeBroadcastStream() のメソッドがある。
streams 配列 現在配信中のストリームに対応するオブジェクトの配列です。これは、ステータスが「started」に設定され、streamModeが「manual」に設定されている配信に対してのみ設定されます。配列内の各オブジェクトには、以下のプロパティが含まれます： - streamId -- 放送に含まれるストリームのストリームID。 - hasAudio -- ストリームの音声が放送に含まれているかどうか。 - hasVideo -- ストリームの動画が放送に含まれているかどうか。
multiBroadcastTag ストリング 同じセッションに対して複数の同時配信をサポートするには、この設定を行ってください。進行中のセッションの同時配信ごとに、一意の文字列を設定してください。なお、 multiBroadcastTag ライブ配信の一覧を表示するメソッドおよびライブ配信に関する情報を取得するメソッドのレスポンスには、この値は含まれていません。

方法

名称 説明
stop(callback) ライブ配信を停止します。

stop(callback)

ライブ配信を停止します。

配信は、120分経過するか、配信中のセッションからすべてのクライアントが切断されると、 自動的に録画が停止します。

パラメータ：
名称 タイプ 説明
callback 機能 操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。 - broadcast — Broadcast オブジェクト。