Skip to Content
DocumentationAPI Referenceライブストリーム

ライブ ストリーム API

ライブ ストリーム API は、ライブ イベントの情報を検索および取得するためのエンドポイントを提供します。これにより、「ライブ中」ディレクトリを作成し、アプリケーションにライブ プレイヤーを埋め込むことができます。

現在のライブ ストリームを取得

このエンドポイントは、現在「オンエア」状態にあるストリームを検索するために使用されます。エンコードから信号を受け取っているストリームのみが返されます。

GET /live-streams/active

パラメーター

このエンドポイントにはパラメーターはありません。アカウントのすべての有効なストリームを取得します。

例の要求

GET /api/client/v1/live-streams/active
Host: https://your-app.com
Authorization: Bearer sk-your-api-key-here

レスポンス: GET /live-streams/active

ストリームが有効な場合、LiveStream オブジェクトの配列が返されます。status は active になり、manifest オブジェクトも含まれます。

Response: 200 OK (Streams Active)
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Weekly Q&A Session",
      "description": "Answering your questions live.",
      "status": "active",
      "manifest": {
        "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
      },
      "metadata": {
        "category": "Tech Talk",
        "host": "Jane Doe"
      },
      "tags": ["live", "q&a"],
      "created_at": "2024-08-01T10:00:00Z"
    }
  ]
}

ストリームが有効でない場合、API は空のデータ配列を返します。

Response: 200 OK (No Streams Active)
{
  "data": []
}

全ライブ ストリームを取得

このエンドポイントは、アカウント内のすべてのライブ ストリームを、現在のステータスに関係なく（有効または無効）取得するために使用されます。これは、スケジュールを作成したり、完全なチャンネルリストを作成したりするのに役立ちます。

GET /live-streams

パラメーター

名前タイプ必須説明
per_pageintegerオプション1 ページに返すストリームの数。デフォルトは 15、最大値は 100 です。

例の要求

GET /api/client/v1/live-streams?per_page=2

レスポンス: GET /live-streams

レスポンスは標準的なページネーション リストです。status は active または inactive になり、有効なストリームの場合にのみ manifest オブジェクトが含まれます。

Response: 200 OK
{
  "data": [
    {
      "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
      "title": "Weekly Q&A Session",
      "description": "Answering your questions live.",
      "status": "active",
      "manifest": {
        "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
      },
      "metadata": {
        "category": "Tech Talk"
      },
      "tags": ["live", "q&a"],
      "created_at": "2024-08-01T10:00:00Z"
    },
    {
      "id": "9c1a9e3e-1a2b-3c4d-5e6f-7g8h9i0j1k2l",
      "title": "Upcoming Product Launch",
      "description": "Join us for the big reveal.",
      "status": "inactive",
      "metadata": {
        "category": "Product"
      },
      "tags": ["launch", "event"],
      "created_at": "2024-07-25T15:00:00Z"
    }
  ],
  "links": {
    "first": "https://your-app.com/api/client/v1/live-streams?page=1",
    "last": "https://your-app.com/api/client/v1/live-streams?page=3",
    "prev": null,
    "next": "https://your-app.com/api/client/v1/live-streams?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 3,
    "path": "https://your-app.com/api/client/v1/live-streams",
    "per_page": 2,
    "to": 2,
    "total": 6
  }
}

ライブ ストリームを取得

このエンドポイントは、指定された ID のライブ ストリームの詳細情報を取得するために使用されます。これは、ストリームをプレイヤーに読み込むための必要な情報を取得するために使用します。

GET /live-streams/{streamId}

パス パラメーター

名前タイプ説明
streamIduuid必須。 ライブ ストリームのユニーク ID。

例の要求

GET /api/client/v1/live-streams/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f

レスポンス: GET /live-streams/{streamId}

レスポンスは単一の LiveStream オブジェクトです。ストリームが有効な場合にのみ、manifest が含まれます。

Response: 200 OK (Stream is Active)
{
  "data": {
    "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f",
    "title": "Weekly Q&A Session",
    "description": "Answering your questions live.",
    "status": "active",
    "manifest": {
      "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8"
    },
    "metadata": {
      "category": "Tech Talk",
      "host": "Jane Doe"
    },
    "tags": ["live", "q&a"],
    "created_at": "2024-08-01T10:00:00Z"
  }
}
ビデオ動画のアップロード