Playback
Playback は、あるユーザーによるある配信(= Broadcast)の視聴を表現するエンティティで、ユーザーが視聴を開始したタイミングで生成されます。
PlaybackKey
Broadcast と違い Playback を特定する ID は自動的には作成されません。代わりに 視聴 URL のクエリーパラメーター key にランダムな文字列を付与することで、 その視聴 URL での視聴に対応した Playback を特定するキーにすることができます。このキーは PlaybackKey と呼ばれます。
アプリはこの PlaybackKey を通して特定の視聴に対し、以下のようなアクションを行います:
視聴に関わる情報を API に問い合わせる(それが対象としている Broadcast や視聴時間など) 視聴を強制停止する 視聴者数のカウント
Web API の GET broadcasts/{id} から取得できるプロパティは、それぞれ以下のような意味を示します:
streamer.currentPlaybackCount: 現在の視聴者数streamer.overallPlaybackCount: 累計の視聴者数
留意すべきことは、この 視聴者数 は Playback エンティティの数のことであり、 同一の PlaybackKey が設定された視聴は、それが複数の物理クライアントによるものでも 1 としてカウントされます。
したがって、これらのプロパティを正しく機能させるには、アプリ側で、アプリ自身が定めたスコープに応じて、 正しく key を分配/設定する必要があることにご注意ください。
一例として 視聴者数 を有意な情報する最も簡単な方法は、 物理クライアントやブラウザ毎にランダムに生成された UUID を割り振り、これを PlaybackKey とすることです。 生成した UUID はクライアントのストレージ領域 (ブラウザの LocalStorage や Cookie など) に保存しておき、 以降の処理ではこの UUID を必ず利用するようにします。