1. イントロダクション

Streaks APIのドキュメントへようこそ。

2. 共通仕様

2.1. レート制限

APIごとに実行できるリクエスト回数はプロジェクト単位で異なります。 営業担当までお問い合わせください。
デフォルト設定は下記の通りです。

プラン	APIリクエスト
デフォルト	50/分

ただし、プレイバックAPIに限りリクエスト回数の上限はありません。

2.2. リクエストヘッダー

特に記載のない限りリクエストヘッダーで下記を指定する必要があります。

フィールド	タイプ	説明
Content-Type	String	Content-Type: application/json
X-Streaks-Api-Key	String	X-Streaks-Api-Key:

2.3. 認証

API一部はアクセスするために、アクセストークンを設定する必要があります。
アカウントごとに認証APIリクエストをすることで、一定期間有効なアクセストークンが発行されます。

2.3.1. HTTPリクエスト

POST https://auth.api.streaks.jp/v1/projects/:project_id/auth-token/

2.3.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic

リクエストボディの例

{
  "mail_address": "streaks@logiclogic.jp",
  "password": "logiclogic12345"
}

2.3.2. リクエストボディ

フィールド	タイプ	説明
mail_address	String	メールアドレス
password	String	パスワード

レスポンスの例

{
  "token": "20iLCJleHAiOjE0NDc4MzMyMjl9.Ik_yi4lHbNbrRGhqmRpsW82Nls_O9lg12ijij234i2hikjbkjbhbkjnlai4ugq-",
  "expired_at": "2017-10-01T00:00:00.000Z"
}

2.3.3. レスポンス

フィールド	タイプ	サンプル
token	String	アクセストークン
expired_at	DateString	アクセストークンの有効期間

2.3.4. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
500	SERVER_ERROR	予期せぬエラーが発生しました

3. プレイバックAPI

3.1. IDもしくは参照IDによるメディアの取得

メディアの情報をIDもしくは参照IDで取得するAPIです。

3.1.1. HTTPリクエスト

GET https://playback.api.streaks.jp/v1/projects/:project_id/medias/:media_id

OR

GET https://playback.api.streaks.jp/v1/projects/:project_id/medias/ref:ref_id

3.1.2. リクエストヘッダー

フィールド	タイプ	説明
Content-Type	String	Content-Type: application/json
X-Streaks-Api-Key	String	X-Streaks-Api-Key:

3.1.3. URLパラメータ

フィールド	タイプ	説明	サンプル
media_id	String	メディアID	40459b7e6e414652828f98af788f3abc
project_id	String	プロジェクトID	logiclogic
ec_url	UrlString	エンタイトルメントチェックURL	https://xxxxx...
ref_id	String	参照ID	video1
user_id	String	ユーザーID	1

3.1.4. レスポンス

フィールド	タイプ	説明
project_id	String	プロジェクトID
id	String	メディアID
ref_id	String	参照ID (プロジェクト内部でユニークである必要がある)
type	String	種別（ファイル or ライブ or クリップ など）
name	String	名前
description	Text	説明文
duration	Number	尺(milliseconds)
profile	Object	プロファイル
poster	Object	ポスター画像
src	String	ポスター画像のURL
thumbnaill	Object	サムネイル画像
src	String	サムネイルのURL
sources	Object[]	動画ソースの配列
tracks	Object[]	トラックの配列
cue_points	Object[]	キューポイントの配列
chapters	Object[]	チャプターの配列
ads	Object[]	広告配信スケジュールの配列
ad_fields	Object[]	広告フィールドの配列
tags	String[]	タグの配列
offline_enabled	Boolean	オフライン再生許可フラグ
resolution	String	解像度
created_at	DateString	作成日時
updated_at	DateString	更新日時
metrics	JSON	メトリクス
epg_id	String	番組表ID
program_id	String	番組ID

レスポンスの例

{
  "project_id": "play",
  "id": "f3582050b168450faf40919b074a80b7",
  "ref_id": "streaksstg_linear_173_vp_1ch_04_002",
  "type": "clip",
  "name": "vp_1ch_04_002テスト",
  "description": null,
  "duration": null,
  "profile": null,
  "poster": {
    "src": null
  },
  "thumbnail": {
    "src": null
  },
  "sources": [
    {
      "id": "f148cb374efc4b479d66eb537347b4f5",
      "label": null,
      "type": "application/x-mpegURL",
      "resolution": "960x540",
      "ext_x_version": 3,
      "src": "https://manifest.streaks.jp/v3/play/f3582050b168450faf40919b074a80b7/f148cb374efc4b479d66eb537347b4f5/hls/v3/manifest.m3u8?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwcCI6Ijk1MjU2NDkxMjQ3MjRiMTJhNDNlY2M2OWI5NWZhMTYyIiwiZGMiOiJjZDE0YzA4MDQzYTQ0N2IzYWE2YzU1ZjkwZWU2NjU5NyIsImVkZ2UiOiJmNzkwYWIxYjFlZGQ0ZmFiOGY0NGE1NzBjNzk0MjI5YSIsImNvZGVjcyI6ImF1dG8iLCJleHAiOjE2OTY1NzkyMDAsInN0YXJ0IjoxNjk2Mzk4MDAwLCJ2cDkiOjF9.t2AtS2nNceO535_xk-PhKxrJbKZywGnQM9d5Qubntdg",
      "policy": "9525649124724b12a43ecc69b95fa162"
    }
  ],
  "tracks": [
    {
      "autoselect": false,
      "default": false,
      "forced": false,
      "group_id": null,
      "id": "2e466bac83d2457fac58c148d4c73a1c",
      "kind": "thumbnails",
      "label": "thumbnails",
      "m3u8_embeded": false,
      "src": "https://live-uvp.streaks.jp/536d01d5fc87495d964fea98402ff209/thumbnail_tile/15335b2738f421b5f160e388ab810e32/live_thumbnails.vtt",
      "srclang": null,
      "type": "text/vtt"
    }
  ],
  "cue_points": [],
  "chapters": [],
  "ads": [],
  "ad_fields": {},
  "tags": [],
  "offline_enabled": true,
  "resolution": "960x540",
  "created_at": "2023-10-04T14:40:09.933+0900",
  "updated_at": "2023-10-04T14:40:13.601+0900",
  "metrics": {
    "host": "metrics.streaks.jp/v1",
    "sessionExpire": 1800000,
    "session_expire": 1800000,
    "pingTime": 10,
    "ping_time": 10,
    "sessionMaxAge": 86400,
    "session_max_age": 86400
  },
  "epg_id": "vp_1ch",
  "program_id": "20231004:AD"
}

3.1.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
404	MEDIA_NOT_FOUND	該当するメディアが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

4. インジェストAPI(ビデオ)

4.1. 共通処理

4.1. リクエストヘッダー

リクエストヘッダーで下記を指定する。

リクエストヘッダー	タイプ	説明
Authorization	String	Authorization: Bearer access_token
Content-Type	String	Content-Type: application/json
X-Streaks-Api-Key	String	X-Streaks-Api-Key:

4.2. リモートアセットのインジェスト

http(s)://でアクセスすることができる素材を指定してビデオを作成することができます。

4.2.1. HTTPリクエスト

POST https://ingest.api.streaks.jp/v1/projects/:project_id/jobs

4.2.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic

4.2.3. リクエストボディ

フィールド	タイプ	説明
source_url	String	ビデオソースのURL(http(s)://)
job_profile_id	Integer	ジョブプロファイル ID

4.2.4. レスポンス

フィールド	タイプ	説明
id	String	ジョブID
ref_id	String	参照ID
name	String	ジョブ名
project_id	String	プロジェクトID
job_profile_id	String	ジョブプロファイルID
media_id	String	メディアID
description	String	説明文
encode_status	Integer	エンコード状態
source_type	String	取得元タイプ
source_url	String	取得元URL
created_at	DateString	作成日時
updated_at	DateString	更新日時

4.2.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
404	JOB_PROFILE_NOT_FOUND	該当するジョブプロファイルが存在しません
404	STORAGE_NOT_FOUND	該当するストレージが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

4.3. IDもしくは参照IDによるジョブ情報の取得

ジョブ情報をIDまたは参照IDを指定して1件取得するAPIです。

4.3.1. HTTPリクエスト

GET https://ingest.api.streaks.jp/v1/projects/:project_id/jobs/:job_id

OR

GET https://ingest.api.streaks.jp/v1/projects/:project_id/jobs/ref:ref_id

4.3.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
job_id	String	ジョブID	40459b7e6e414652828f98af788f3abc
ref_id	String	参照ID	job_1

4.3.3. レスポンス

フィールド	タイプ	説明
id	String	ジョブID
ref_id	String	参照ID
name	String	ジョブ名
project_id	String	プロジェクトID
job_profile_id	String	ジョブプロファイルID
media_id	String	メディアID
description	String	説明文
encode_status	Integer	エンコード状態
source_type	String	取得元タイプ
source_url	String	取得元URL
created_at	DateString	作成日時
updated_at	DateString	更新日時

4.3.4 エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
404	JOB_NOT_FOUND	該当するジョブが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

4.4. ジョブ情報一覧の取得

ジョブ情報を一括取得するAPIです。

4.4.1. HTTPリクエスト

GET https://ingest.api.streaks.jp/v1/projects/:project_id/jobs

4.4.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic

4.4.3. クエリパラメータ

フィールド	タイプ	説明	サンプル
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

4.4.4. レスポンス

フィールド	タイプ	説明
id	String	ジョブID
ref_id	String	参照ID
name	String	ジョブ名
project_id	String	プロジェクトID
job_profile_id	String	ジョブプロファイルID
media_id	String	メディアID
description	String	説明文
encode_status	Integer	エンコード状態
source_type	String	取得元タイプ
source_url	String	取得元URL
created_at	DateString	作成日時
updated_at	DateString	更新日時

4.4.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
500	SERVER_ERROR	予期せぬエラーが発生しました

4.5. IDもしくは参照IDによるジョブプロファイル情報の取得

プロファイル情報をIDまたは参照IDを指定して1件取得するAPIです。

4.5.1 エラーコード

GET https://ingest.api.streaks.jp/v1/projects/:project_id/job_profiles/:job_profile_id

OR

GET https://ingest.api.streaks.jp/v1/projects/:project_id/job_profiles/ref:ref_id

4.5.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
job_profile_id	String	ジョブプロファイルID	40459b7e6e414652828f98af788f3abc
ref_id	String	参照ID	job_profile_1

4.5.3. レスポンス

フィールド	タイプ	説明
project_id	String	プロジェクトID
id	String	ジョブプロファイルID
ref_id	String	参照ID
name	String	ジョブプロファイル名
description	String	説明文
created_at	String	作成日時
updated_at	String	更新日時

4.5.4. エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
404	JOB_PROFILE_NOT_FOUND	該当するジョブプロファイルが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

4.6. ジョブプロファイル情報一覧の取得

プロファイル情報を一括取得するAPIです。

4.6.1. HTTPリクエスト

GET https://ingest.api.streaks.jp/v1/projects/:project_id/job_profiles

4.6.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic

4.6.3. クエリパラメータ

フィールド	タイプ	説明	サンプル
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

4.6.4. レスポンス

フィールド	タイプ	説明
project_id	String	プロジェクトID
id	String	ジョブプロファイルID
ref_id	String	参照ID
name	String	ジョブプロファイル名
description	String	説明文
created_at	String	作成日時
updated_at	String	更新日時

レスポンスの例

HTTP/1.1 200 OK

{
  "count": 30,
  "job_profiles":
    [
      {<job_profile1 fields>},
      {<job_profile2 fields>},
      ...
    ]
}

4.6.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
502	SERVER_ERROR	予期せぬエラーが発生しました

5. ライブAPI

5.1. 共通処理

5.1.1. リクエストヘッダー

リクエストヘッダーで下記を指定する。

フィールド	タイプ	説明
Authorization	String	Authorization: Bearer access_token
Content-Type	String	Content-Type: application/json
X-Streaks-Api-Key	String	X-Streaks-Api-Key:

5.2. IDもしくは参照IDによるライブイベントの取得

ライブイベント情報をIDまたは参照IDを指定して1件取得するAPI

5.2.1. HTTPリクエスト

GET https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id

OR

GET https://live.api.streaks.jp/v1/projects/:project_id/live_events/ref:ref_id

5.2.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id
ref_id	String	参照ID	id

5.2.3. レスポンス

フィールド	タイプ	説明
project_id	String	契約者ID
id	String	ライブイベントID
ref_id	String	参照ID
name	String	ライブイベント名
description	String	説明
enable_blackout_flag	Boolean	ブラックアウトフラグ
enable_ad_insertion_flag	Boolean	広告挿入フラグ
live_event_profile_id	String	ライブイベントプロファイルID
input_sources	Object[]	インジェストURL
enable_ad_insertion_flag	Boolean	広告挿入フラグ
media_id	String	メディアID
enable_live_to_file_flag	Boolean	アーカイブ機能有効フラグ
encode_status	String	エンコード状態
reserved_start_at	String	ライブ起動予約日時
launch_started_at	String	ライブ起動開始日時
launch_completed_at	String	ライブ起動完了日時
created_at	String	作成日時
updated_at	String	更新日時
running_at	String	エンコード開始日時
finished_at	String	エンコード停止日時
preview_image	Object	ライブプレビュー画像
src	String	プレビュー画像のURL

レスポンスの例

HTTP/1.1 200 OK

{
    "project_id": "logiclogic",
    "id":"ea74ba39162f49d89221daebd02c215a",
    "ref_id":"test_live01",
    "name":"テストライブ",
    "description":"",
    "enable_blackout_flag":false,
    "enable_ad_insertion_flag":false,
    "live_event_profile_id":"c2e31a9d22d9487dae8d837c38231f81",
    "input_sources":["rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"],
    "media_id":"6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status":"encode_status_running",
    "enable_live_to_file_flag":false,
    "reserved_start_at":"2020-07-31 07:20:09",
    "launch_started_at":"2020-07-31 07:20:09",
    "launch_completed_at":"2020-07-31 07:21:56",
    "created_at":"2020/05/29 21:31:11",
    "updated_at":"2020/07/07 13:11:17",
    "finished_at":"2020-07-31 07:24:05",
    "preview_image":
    {
      "src":"https://stg-vod-logiclogic.streaks.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}

5.2.4. エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当するライブイベントが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.3. ライブイベントの一覧取得

ライブイベント情報を一括で取得するAPI

5.3.1. HTTPリクエスト

GET https://live.api.streaks.jp/v1/projects/:project_id/live_events

5.3.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic

5.3.3. クエリパラメータ

フィールド	タイプ	説明	サンプル
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

5.3.4. レスポンス

フィールド	タイプ	説明
project_id	String	契約者ID
id	String	ライブイベントID
ref_id	String	参照ID
name	String	ライブイベント名
description	String	説明
enable_blackout_flag	Boolean	ブラックアウトフラグ
enable_ad_insertion_flag	Boolean	広告挿入フラグ
live_event_profile_id	String	ライブイベントプロファイルID
input_sources	Object[]	インジェストURL
enable_ad_insertion_flag	Boolean	広告挿入フラグ
media_id	String	メディアID
enable_live_to_file_flag	Boolean	アーカイブ機能有効フラグ
encode_status	String	エンコード状態
reserved_start_at	String	ライブ起動予約日時
launch_started_at	String	ライブ起動開始日時
launch_completed_at	String	ライブ起動完了日時
created_at	String	作成日時
updated_at	String	更新日時
running_at	String	エンコード開始日時
finished_at	String	エンコード停止日時
preview_image	Object	ライブプレビュー画像
src	String	プレビュー画像のURL

レスポンスの例

HTTP/1.1 200 OK

{
  "count": 30,
  "live_events":
    [
      {<live_event1 fields>},
      {<live_event2 fields>},
      ...
    ]
}

5.3.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
500	SERVER_ERROR	予期せぬエラーが発生しました

5.4. ライブイベントの作成

ライブイベントを作成するAPIです。

5.4.1. HTTPリクエスト

POST https://live.api.streaks.jp/v1/projects/:project_id/live_events

5.4.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic

5.4.3. リクエスト

フィールド	タイプ	説明
name	String	ライブイベント名
description	String	説明
ref_id	String	参照ID
enable_blackout_flag	Boolean	ブラックアウトフラグ
enable_ad_insertion_flag	Boolean	広告挿入フラグ
live_event_profile_id	String	ライブイベントプロファイルID
enable_dvr_flag	Boolean	DVR機能フラグ(true: ビデオクリップおよびライブアーカイブを利用可能)
enable_live_to_file_flag	Boolean	ライブアーカイブフラグ(true: ビデオクリップを利用可能)
enable_video_clip_flag	Boolean	ビデオクリップフラグ(true: ビデオクリップ機能を利用可能)
max_window_size_seconds	Integer	最大DVRウィンドウサイズ(DVR機能を利用する場合は指定する。最大86400秒)
source_type	String	入力プロトコル(rtmp, rtp, udpのいずれか)
input_soruces	Object[]	インジェストURL(source_typeがhlsまたはmp4の場合は要入力)
deployment_id	String	デプロイメントID
live_type	String	ライブ種別(live_type_event, live_type_linearのいずれか)
reserved_start_at	String	起動予約日時
reserved_stop_at	String	停止予約日時
enable_multi_source_flag	Boolean	入力切り替えフラグ(true:ライブ入力の切り替えが可能)
enable_multi_pipeline_flag	Boolean	マルチパイプライン機能フラグ(true: ライブインジェストを冗長にする)
media_attributes_reservation	Object[]	メディア属性情報
name	String	メディア名
description	String	メディア説明文
ref_id	String	メディア参照ID
tag_list	String	メディアタグ
ssai_config_id	String	広告設定ID
media_uuid	String	メディアID
videoclip_config	Object[]	ビデオクリップのメディア属性情報
tag_list	String	ビデオクリップのメディアタグ
edge_behavior	String	ビデオクリップのエッジセグメントを含めるかどうか(inside, include_edgeのいずれか)

リクエストの例

{
  "name":"test",
  "ref_id": "test1",
  "live_event_profile_id":"9ae0c039a6d948d0b747572660bc1b7d",
  "deployment_id":"c05eb87a1003472291d1710cca968ed3",
  "media_attributes_reservation":{
    "name":"test",
    "ref_id": "ref",
    "tag_list": "tag_name0",
    "ssai_config_id": "31d69c3c19744179822b34b7a0c9e053",
    "media_uuid": "d4d00a0ba24545df9e30d1ac77baebca"
  },
  "max_window_size_seconds": 43200,
  "source_type": "rtmp",
  "live_type": "live_type_linear",
  "enable_multi_source_flag": true,
  "reserved_start_at": "2021-07-03 10:00:00",
  "reserved_stop_at": "2021-07-03 13:00:00",
  "enable_dvr_flag": true,
  "enable_live_to_file_flag": true,
  "enable_video_clip_flag": true,
  "enable_multi_pipeline_flag": true,
  "videoclip_config":{
    "media_attributes_reservation":{
      "edge_behavior": "inside",
      "tag_list": "tag_name",
      "ssai_config_id": "31d69c3c19744179822b34b7a0c9e053"
    }
  }
}

5.4.4. レスポンス

フィールド	タイプ	説明
project_id	String	契約者ID
id	String	ライブイベントID
ref_id	String	参照ID
name	String	ライブイベント名
description	String	説明
enable_blackout_flag	Boolean	ブラックアウトフラグ
enable_ad_insertion_flag	Boolean	広告挿入フラグ
live_event_profile_id	String	ライブイベントプロファイルID
input_sources	Object[]	インジェストURL
enable_ad_insertion_flag	Boolean	広告挿入フラグ
media_id	String	メディアID
enable_live_to_file_flag	Boolean	アーカイブ機能有効フラグ
encode_status	String	エンコード状態
reserved_start_at	String	ライブ起動予約日時
launch_started_at	String	ライブ起動開始日時
launch_completed_at	String	ライブ起動完了日時
created_at	String	作成日時
updated_at	String	更新日時
running_at	String	エンコード開始日時
finished_at	String	エンコード停止日時
preview_image	Object	ライブプレビュー画像
src	String	プレビュー画像のURL

レスポンスの例

HTTP/1.1 200 OK

{
    "project_id": "logiclogic",
    "id":"ea74ba39162f49d89221daebd02c215a",
    "ref_id":"test_live01",
    "name":"テストライブ",
    "description":"",
    "enable_blackout_flag":false,
    "enable_ad_insertion_flag":false,
    "live_event_profile_id":"c2e31a9d22d9487dae8d837c38231f81",
    "input_sources":["rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"],
    "media_id":"6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status":"encode_status_running",
    "enable_live_to_file_flag":false,
    "reserved_start_at":"2020-07-31 07:20:09",
    "launch_started_at":"2020-07-31 07:20:09",
    "launch_completed_at":"2020-07-31 07:21:56",
    "created_at":"2020/05/29 21:31:11",
    "updated_at":"2020/07/07 13:11:17",
    "finished_at":"2020-07-31 07:24:05",
    "preview_image":
    {
      "src":"https://stg-vod-logiclogic.streaks.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}

5.4.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_PROFILE_NOT_FOUND	該当するライブイベントプロファイルが存在しません
400	FAILED_TO_SAVE	保存処理に失敗しました
500	SERVER_ERROR	予期せぬエラーが発生しました

5.5. ライブイベントの開始

ライブイベントを開始するAPIです。

POST https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/start

OR

POST https://live.api.streaks.jp/v1/projects/:project_id/live_events/ref:ref_id/start

5.5.1. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id
ref_id	String	参照ID	ref_id

5.5.2. レスポンス

フィールド	タイプ	説明
project_id	String	契約者ID
id	String	ライブイベントID
ref_id	String	参照ID
name	String	ライブイベント名
description	String	説明
enable_blackout_flag	Boolean	ブラックアウトフラグ
enable_ad_insertion_flag	Boolean	広告挿入フラグ
live_event_profile_id	String	ライブイベントプロファイルID
input_sources	Object[]	インジェストURL
enable_ad_insertion_flag	Boolean	広告挿入フラグ
media_id	String	メディアID
enable_live_to_file_flag	Boolean	アーカイブ機能有効フラグ
encode_status	String	エンコード状態
reserved_start_at	String	ライブ起動予約日時
launch_started_at	String	ライブ起動開始日時
launch_completed_at	String	ライブ起動完了日時
created_at	String	作成日時
updated_at	String	更新日時
running_at	String	エンコード開始日時
finished_at	String	エンコード停止日時
preview_image	Object	ライブプレビュー画像
src	String	プレビュー画像のURL

レスポンスの例

HTTP/1.1 200 OK

{
    "project_id": "logiclogic",
    "id":"ea74ba39162f49d89221daebd02c215a",
    "ref_id":"test_live01",
    "name":"テストライブ",
    "description":"",
    "enable_blackout_flag":false,
    "enable_ad_insertion_flag":false,
    "live_event_profile_id":"c2e31a9d22d9487dae8d837c38231f81",
    "input_sources":["rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"],
    "media_id":"6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status":"encode_status_running",
    "enable_live_to_file_flag":false,
    "reserved_start_at":"2020-07-31 07:20:09",
    "launch_started_at":"2020-07-31 07:20:09",
    "launch_completed_at":"2020-07-31 07:21:56",
    "created_at":"2020/05/29 21:31:11",
    "updated_at":"2020/07/07 13:11:17",
    "finished_at":"2020-07-31 07:24:05",
    "preview_image":
    {
      "src":"https://stg-vod-logiclogic.streaks.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}

5.5.3. エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当のライブイベントが存在しません
400	FAILED_TO_SAVE	保存処理に失敗しました
400	FAILED_TO_START	開始処理に失敗しました
500	SERVER_ERROR	予期せぬエラーが発生しました

5.6. ライブイベントの停止

ライブイベントを停止するAPIです。ライブを再開すためには停止後リセットする必要があります。

5.6.1. HTTPリクエスト

POST https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/stop

OR

POST https://live.api.streaks.jp/v1/projects/:project_id/live_events/ref:ref_id/stop

5.6.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id
ref_id	String	参照ID	ref_id

5.6.3. レスポンス

フィールド	タイプ	説明
project_id	String	契約者ID
id	String	ライブイベントID
ref_id	String	参照ID
name	String	ライブイベント名
description	String	説明
enable_blackout_flag	Boolean	ブラックアウトフラグ
enable_ad_insertion_flag	Boolean	広告挿入フラグ
live_event_profile_id	String	ライブイベントプロファイルID
input_sources	Object[]	インジェストURL
enable_ad_insertion_flag	Boolean	広告挿入フラグ
media_id	String	メディアID
enable_live_to_file_flag	Boolean	アーカイブ機能有効フラグ
encode_status	String	エンコード状態
reserved_start_at	String	ライブ起動予約日時
launch_started_at	String	ライブ起動開始日時
launch_completed_at	String	ライブ起動完了日時
created_at	String	作成日時
updated_at	String	更新日時
running_at	String	エンコード開始日時
finished_at	String	エンコード停止日時
preview_image	Object	ライブプレビュー画像
src	String	プレビュー画像のURL

レスポンスの例

HTTP/1.1 200 OK

{
    "project_id": "logiclogic",
    "id":"ea74ba39162f49d89221daebd02c215a",
    "ref_id":"test_live01",
    "name":"テストライブ",
    "description":"",
    "enable_blackout_flag":false,
    "enable_ad_insertion_flag":false,
    "live_event_profile_id":"c2e31a9d22d9487dae8d837c38231f81",
    "input_sources":["rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"],
    "media_id":"6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status":"encode_status_running",
    "enable_live_to_file_flag":false,
    "reserved_start_at":"2020-07-31 07:20:09",
    "launch_started_at":"2020-07-31 07:20:09",
    "launch_completed_at":"2020-07-31 07:21:56",
    "created_at":"2020/05/29 21:31:11",
    "updated_at":"2020/07/07 13:11:17",
    "finished_at":"2020-07-31 07:24:05",
    "preview_image":
    {
      "src":"https://stg-vod-logiclogic.streaks.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}

5.6.4. エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当のライブイベントが存在しません
400	FAILED_TO_STOP	停止処理に失敗しました
500	SERVER_ERROR	予期せぬエラーが発生しました

5.7. ライブイベントのリセット

ライブイベントをリセットするAPIです。

5.7.1. HTTPリクエスト

POST https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/reset

OR

POST https://live.api.streaks.jp/v1/projects/:project_id/live_events/ref:ref_id/reset

5.7.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id
ref_id	String	参照ID	id

5.7.3. レスポンス

HTTP/1.1 200 OK

5.7.4. エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当するライブイベントが存在しません
400	FAILED_TO_RESET	リセット処理に失敗しました
500	SERVER_ERROR	予期せぬエラーが発生しました

5.8. ライブイベントのキャンセル

ライブイベントをキャンセルするAPIです。

5.8.1. HTTPリクエスト

POST https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/cancel

OR

POST https://live.api.streaks.jp/v1/projects/:project_id/live_events/ref:ref_id/cancel

5.8.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id
ref_id	String	参照ID	id

5.8.3. レスポンス

HTTP/1.1 200 OK

5.8.4. エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当するライブイベントが存在しません
400	FAILED_TO_CANCEL	キャンセル処理に失敗しました
500	SERVER_ERROR	予期せぬエラーが発生しました

5.9. ライブイベントの更新

ライブイベント情報を更新するAPIです。

5.9.1. HTTPリクエスト

PUT https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id

OR

PUT https://live.api.streaks.jp/v1/projects/:project_id/live_events/ref:ref_id

5.9.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id
ref_id	String	参照ID	id

5.9.3. リクエスト

フィールド	タイプ	説明
name	String	ライブイベント名
description	String	説明
ref_id	String	参照ID
enable_blackout_flag	Boolean	ブラックアウトフラグ
enable_ad_insertion_flag	Boolean	広告挿入フラグ
live_event_profile_id	String	ライブイベントプロファイルID
enable_live_to_file_flag	Boolean	クリップフラグ
live_encode_start_at	String	エンコード開始日時
live_encode_end_at	String	エンコード終了日時
enable_dvr_flag	Boolean	DVR機能フラグ
source_type	String	入力プロトコル
input_soruces	Array	入力ソースURL(source_typeがhlsまたはmp4の場合は要入力)
live_type	String	ライブ種別
deployment_id	String	デプロイメントID
media_attributes_reservation	Json	メディア属性情報

5.9.4. レスポンス

HTTP/1.1 200 OK

{
    "project_id": "logiclogic",
    "id":"ea74ba39162f49d89221daebd02c215a",
    "ref_id":"test_live01",
    "name":"テストライブ",
    "description":"",
    "enable_blackout_flag":false,
    "enable_ad_insertion_flag":false,
    "live_event_profile_id":"c2e31a9d22d9487dae8d837c38231f81",
    "input_sources":["rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"],
    "media_id":"6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status":"encode_status_running",
    "enable_live_to_file_flag":false,
    "reserved_start_at":"2020-07-31 07:20:09",
    "launch_started_at":"2020-07-31 07:20:09",
    "launch_completed_at":"2020-07-31 07:21:56",
    "created_at":"2020/05/29 21:31:11",
    "updated_at":"2020/07/07 13:11:17",
    "finished_at":"2020-07-31 07:24:05",
    "preview_image":
    {
      "src":"https://stg-vod-logiclogic.streaks.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}

5.9.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当するライブイベントが存在しません
404	LIVE_EVENT_PROFILE_NOT_FOUND	該当するライブイベントプロファイルが存在しません
400	FAILED_TO_UPDATE	更新処理に失敗しました
500	SERVER_ERROR	予期せぬエラーが発生しました

5.10. ライブイベントの削除

ライブイベントを削除するAPIです。ライブ配信中に削除をする場合、停止されてから削除されます。

5.10.1. HTTPリクエスト

DELETE https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id

OR

DELETE https://live.api.streaks.jp/v1/projects/:project_id/live_events/ref:ref_id

5.10.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id
ref_id	String	参照ID	id

5.10.3. レスポンス

HTTP/1.1 200 OK

{
    "project_id": "logiclogic",
    "id":"ea74ba39162f49d89221daebd02c215a",
    "ref_id":"test_live01",
    "name":"テストライブ",
    "description":"",
    "enable_blackout_flag":false,
    "enable_ad_insertion_flag":false,
    "live_event_profile_id":"c2e31a9d22d9487dae8d837c38231f81",
    "input_sources":["rtmp://52.199.87.59:1935/live/ea74ba39162f49d89221daebd02c215a"],
    "media_id":"6dd29e197f0f4a2ab7161db94b44b8c6",
    "encode_status":"encode_status_running",
    "enable_live_to_file_flag":false,
    "reserved_start_at":"2020-07-31 07:20:09",
    "launch_started_at":"2020-07-31 07:20:09",
    "launch_completed_at":"2020-07-31 07:21:56",
    "created_at":"2020/05/29 21:31:11",
    "updated_at":"2020/07/07 13:11:17",
    "finished_at":"2020-07-31 07:24:05",
    "preview_image":
    {
      "src":"https://stg-vod-logiclogic.streaks.jp/live/preview_ea74ba39162f49d89221daebd02c215a_image.jpg"
    }
}

5.10.4. エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当するライブイベントが存在しません
400	FAILED_TO_DELETE	削除処理に失敗しました
500	SERVER_ERROR	予期せぬエラーが発生しました

5.11. IDもしくは参照IDによるライブイベントプロファイルの取得

ライブイベントプロファイル情報をIDまたは参照IDを指定して1件取得するAPIです。

5.11.1. HTTPリクエスト

GET https://live.api.streaks.jp/v1/projects/:project_id/live_event_profiles/:live_event_profile_id

OR

GET https://live.api.streaks.jp/v1/projects/:project_id/live_event_profiles/ref:ref_id

5.11.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_profile_id	String	ライブイベントプロファイルID	id
ref_id	String	参照ID	ref_id

5.11.3. レスポンス

フィールド	タイプ	説明
project_id	String	プロジェクトID
id	String	ライブイベントプロファイルID
ref_id	String	ライブイベントプロファイルの参照ID
name	String	ライブイベントプロファイル名
description	String	説明文
created_at	String	作成日時
updated_at	String	更新日時

5.11.4. エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_PROFILE_NOT_FOUND	該当するライブイベントプロファイルが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.12. ライブイベントプロファイルの一覧取得

ライブイベントプロファイルを一括で取得するAPIです。

5.12.1. HTTPリクエスト

GET https://live.api.streaks.jp/v1/projects/:project_id/live_event_profiles

5.12.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic

5.12.3. クエリパラメータ

フィールド	タイプ	説明	サンプル
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

5.12.4. レスポンス

フィールド	タイプ	説明
project_id	String	プロジェクトID
id	String	ライブイベントプロファイルID
ref_id	String	参照ID
name	String	ライブイベントプロファイル名
description	String	説明文
created_at	String	作成日時
updated_at	String	更新日時

レスポンスの例

HTTP/1.1 200 OK

{
  "count": 30,
  "profiles":
    [
      {<profile1 fields>},
      {<profile2 fields>},
      ...
    ]
}

5.12.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_PROFILE_NOT_FOUND	該当するライブイベントプロファイルが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.13. IDもしくは参照IDによるクリップスケジュールの取得

指定したライブイベントに登録されているクリップスケジュールをIDまたは参照IDにより1件取得することができます。

5.13.1. HTTPリクエスト

GET https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/video_clip_schedules/:video_clip_schedule_id

OR

GET https://live.api.streaks.jp/v1/projects/:project_id/live_events/ref:live_event_ref_id/video_clip_schedules/:video_clip_schedule_id

OR

GET https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/video_clip_schedules/ref:video_clip_schedule_ref_id

OR

GET https://live.api.streaks.jp/v1/projects/:project_id/live_events/ref:live_event_ref_id/video_clip_schedules/ref:video_clip_schedule_ref_id

5.13.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id
video_clip_schedule_id	String	ビデオクリップスケジュールID	id
live_event_ref_id	String	ライブイベント参照ID
video_clip_schedule_ref_id	String	ビデオクリップスケジュール参照ID

5.13.3. レスポンス

フィールド	タイプ	説明
id	String	クリップスケジュールID
ref_id	String	参照ID
project_id	String	プロジェクトID
live_event_id	String	ライブイベントID
profile_id	String	プロファイルID
media_id	String	メディアID
clip_type	String	クリップタイプ
clip_start_at	DateString	クリップ開始時刻
clip_end_at	DateString	クリップ終了時刻
start_timecode	String	クリップ開始タイムコード
end_timecode	String	クリップ終了タイムコード
created_at	DateString	作成日時
updated_at	DateString	更新日時

5.13.4. エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当するライブイベントが存在しません
404	VIDEO_CLIP_SCHEDULE_NOT_FOUND	該当するクリップスケジュールが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.14. クリップスケジュール一覧の取得

指定したライブイベントに登録されているクリップスケジュールの一覧を取得することができます。

5.14.1. HTTPリクエスト

GET https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/video_clip_schedules

OR

GET https://live.api.streaks.jp/v1/projects/:project_id/live_events/ref:ref_id/video_clip_schedules

5.14.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id
ref_id	String	参照ID

5.14.3. クエリパラメータ

フィールド	タイプ	説明	サンプル
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

5.14.4. レスポンス

フィールド	タイプ	説明
id	String	クリップスケジュールID
ref_id	String	参照ID
project_id	String	プロジェクトID
live_event_id	String	ライブイベントID
profile_id	String	プロファイルID
media_id	String	メディアID
clip_type	String	クリップタイプ
clip_start_at	DateString	クリップ開始時刻
clip_end_at	DateString	クリップ終了時刻
start_timecode	String	クリップ開始タイムコード
end_timecode	String	クリップ終了タイムコード
created_at	DateString	作成日時
updated_at	DateString	更新日時

レスポンスの例

HTTP/1.1 200 OK

{
  "count": 9,
  "video_clip_schedules":
    [
    ]
}

5.14.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当するライブイベントが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.15. クリップスケジュールの作成

指定したライブイベントの一部をクリップしてビデオとして保存する予約を行います。

5.15.1. HTTPリクエスト

POST https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/video_clip_schedules

OR

POST https://live.api.streaks.jp/v1/projects/:project_id/live_events/ref:ref_id/video_clip_schedules

5.15.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID
ref_id	String	ライブイベント参照ID

5.15.3. リクエスト

フィールド	タイプ	説明	サンプル
clip_type	String	クリップタイプ	timecode, or system_clock
start_timecode	String	クリップ開始タイムコード	hh:mm:ss
end_timecode	String	終了タイムコード	hh:mm:ss
clip_start_at	String	クリップ開始日時	YYYY-MM-DD hh:mm:ss
clip_end_at	String	クリップ開始日時	YYYY-MM-DD hh:mm:ss
profile_id	String	プロファイルID

リクエストの例

タイムコード指定の場合

{
  "clip_type": "timecode",
  "start_timecode": "00:10:00",
  "end_timecode": "00:12:00"
}

日本時間指定の場合

{
  "clip_type": "system_clock",
  "start_timecode": "2018-01-01 00:10:00",
  "end_timecode": "2018-01-01 00:12:00"
}

5.15.4. レスポンス

フィールド	タイプ	説明
id	String	クリップスケジュールID
ref_id	String	参照ID
project_id	String	プロジェクトID
live_event_id	String	ライブイベントID
profile_id	String	プロファイルID
media_id	String	メディアID
clip_type	String	クリップタイプ
clip_start_at	DateString	クリップ開始時刻
clip_end_at	DateString	クリップ終了時刻
start_timecode	String	クリップ開始タイムコード
end_timecode	String	クリップ終了タイムコード
created_at	DateString	作成日時
updated_at	DateString	更新日時

レスポンスの例

HTTP/1.1 200 OK

{
  "ref_id": null,
  "project_id": "logiclogic",
  "live_event_id": "ea74ba39162f49d89221daebd02c215a",
  "id": "4ec289ad859e4917af88fab662914311",
  "clip_type": "system_clock",
  "clip_start_at": "2018-03-15T19:35:00.000+09:00",
  "clip_end_at": "2018-03-15T19:37:00.000+09:00",
  "start_timecode": null,
  "end_timecode": null,
  "profile_id": "c2e31a9d22d9487dae8d837c38231f81",
  "media_id": "084d02833a98498dae407dca5998b814",
  "created_at": "2018-03-15T16:28:35.598+09:00",
  "updated_at": "2018-03-15T16:28:35.598+09:00",
  "deleted_at": null
}

5.15.5. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当するライブイベントが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました
500	LIVE_EVENT_DOESNT_HAVE_PROFILE	指定したライブイベントはどのプロファイルにも紐づいていません

5.16. クリップスケジュールの削除

指定されたライブイベントに登録されているクリップスケジュールを削除します。

5.16.1. HTTPリクエスト

DELETE https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/video_clip_schedules/:video_clip_schedule_id

OR

DELETE https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/video_clip_schedules/ref:video_clip_schedule_ref_id

OR

DELETE https://live.api.streaks.jp/v1/projects/:project_id/live_events/ref:live_event_ref_id/video_clip_schedules/:video_clip_schedule_id

OR

DELETE https://live.api.streaks.jp/v1/projects/:project_id/live_events/ref:live_event_ref_id/video_clip_schedules/ref:video_clip_schedule_ref_id

5.16.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID
live_event_ref_id	String	ライブイベント参照ID
video_clip_schedule_id	String	クリップスケジュールID
video_clip_schedule_ref_id	String	クリップスケジュール参照ID

5.16.3. レスポンス

フィールド	タイプ	説明
id	String	クリップスケジュールID
ref_id	String	参照ID
project_id	String	プロジェクトID
live_event_id	String	ライブイベントID
profile_id	String	プロファイルID
media_id	String	メディアID
clip_type	String	クリップタイプ
clip_start_at	DateString	クリップ開始時刻
clip_end_at	DateString	クリップ終了時刻
start_timecode	String	クリップ開始タイムコード
end_timecode	String	クリップ終了タイムコード
created_at	DateString	作成日時
updated_at	DateString	更新日時

レスポンスの例

HTTP/1.1 200 OK

{
  "ref_id": null,
  "project_id": "logiclogic",
  "live_event_id": "ea74ba39162f49d89221daebd02c215a",
  "id": "4ec289ad859e4917af88fab662914311",
  "clip_type": "system_clock",
  "clip_start_at": "2018-03-15T19:35:00.000+09:00",
  "clip_end_at": "2018-03-15T19:37:00.000+09:00",
  "start_timecode": null,
  "end_timecode": null,
  "profile_id": "c2e31a9d22d9487dae8d837c38231f81",
  "media_id": "084d02833a98498dae407dca5998b814",
  "created_at": "2018-03-15T16:28:35.598+09:00",
  "updated_at": "2018-03-15T16:28:35.598+09:00",
  "deleted_at": null
}

5.16.4. エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
404	LIVE_EVENT_NOT_FOUND	該当するライブイベントが存在しません
404	VIDEO_CLIP_SCHEDULE_NOT_FOUND	該当するクリップスケジュールが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.17. SCTE-35信号のライブスケジュールの一覧取得

SCTE-35信号のライブスケジュールの一覧を取得するAPIです。ライブ入力切り替えのライブスケジュールはこのAPIでは取得できません。

5.17.1. HTTPリクエスト

GET https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/scte_35_live_event_schedules

5.17.2. URLパラメータ

フィールド	タイプ	説明	サンプル
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

5.17.3. レスポンス

フィールド	タイプ	説明
id	String	ライブスケジュールID
project_id	String	プロジェクトID
live_event_id	String	ライブイベントID
live_input_source_id	String	ライブ入力ソースID
status	String	状態
start_type	String	SCTE35挿入タイミング指定方法(fixed, immediate, follow)
start_at	String	SCTE35挿入日時(start_typeがfixedの場合のみ要入力)
action_type	String	挿入信号タイプ(splice_insertまたはtime_signal)
duration	String	1秒=90000で入力すること
splice_event_id	String
segment_num	String	最小値0、最大値255
segmentation_upid	String	最小値0、最大値255
segment_expected	String	最小値0、最大値255
segmentation_type_id	String	小値0、最大値255
delivery_restrictions	Object[]
device_restrictions	String	NONE, RESTRICT_GROUP0, RESTRICT_GROUP1, RESTRICT_GROUP2のいずれか
archive_allowed_flag	String	ARCHIVE_ALLOWED, ARCHIVE_NOT_ALLOWEDのいずれか
no_regional_blackout_flag	String	REGIONAL_BLACKOUT, NO_REGIONAL_BLACKOUTのいずれか
web_delivery_allowed_flag	String	WEB_DELIVERY_ALLOWED, WEB_DELIVERY_NOT_ALLOWEDのいずれか
segmentation_duration	String	1秒=90000で入力すること
segmentation_event_id	String	最小値0、最大値4294967295

レスポンスの例

HTTP/1.1 200 OK

{ "count": 3,
  "live_event_schedules":
  [{
    "id":"0386da27df0c46c6a5a383a0cf924938",
    "project_id":"logiclogic",
    "live_event_id":"481d82bcc51f41419578cfbd22dc5140",
    "live_input_source_id":null,
    "status":"completed",
    "start_type":"immediate",
    "start_at":"2021-05-10T16:24:53.635+09:00",
    "action_type":"splice_insert",
    "splice_event_id":"636363",
    "duration":1
  },
  {<live_event_schedule2 field>},
  {<live_event_schedule3 field>}]
}

5.17.4. エラーコード

ステータスコード	コード	メッセージ
404	LIVE_EVENT_NOT_FOUND	該当するライブイベントが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

5.18. ライブスケジュールの一覧取得

ライブ入力切り替えのライブスケジュールの一覧を取得するAPIです。

5.18.1. HTTPリクエスト

GET https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/live_event_schedules

5.18.2. URLパラメータ

フィールド	タイプ	説明	サンプル
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

5.18.3. レスポンス

フィールド	タイプ	説明
id	String	ライブスケジュールID
project_id	String	プロジェクトID
live_event_id	String	ライブイベントID
live_input_source_id	String	ライブ入力ソースID
status	String	状態
start_type	String	挿入タイミング指定方法
start_at	String	挿入日時

レスポンスの例

HTTP/1.1 200 OK

{ "count": 3,
  "live_event_schedules":
  [{
    "id":"95009708734648f8ad52e7c671a5278f",
    "project_id":"logiclogic",
    "live_event_id":"d3f91782b3d940c8b42715d191bc1c17",
    "live_input_source_id":"441086befdd04a61a723404292d74cb5",
    "status":"completed",
    "start_type":"immediate",
    "start_at":"2021-06-28T14:58:30.541+09:00"
  },
  {<live_event_schedule2 field>},
  {<live_event_schedule3 field>}]
}

5.19. IDによるライブスケジュールの取得

ライブ入力切り替えのライブスケジュール情報をIDを指定して1件取得するAPI

5.19.1. HTTPリクエスト

GET https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/live_event_schedules/:live_event_schedule_id

5.19.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id
live_event_schedule_id	String	ライブイベントスケジュールID	id

5.19.3. レスポンス

フィールド	タイプ	説明
id	String	ライブスケジュールID
project_id	String	プロジェクトID
live_event_id	String	ライブイベントID
live_input_source_id	String	ライブ入力ソースID
status	String	状態
start_type	String	挿入タイミング指定方法
start_at	String	挿入日時

レスポンスの例

HTTP/1.1 200 OK

{
  "id":"95009708734648f8ad52e7c671a5278f",
  "project_id":"logiclogic",
  "live_event_id":"d3f91782b3d940c8b42715d191bc1c17",
  "live_input_source_id":"441086befdd04a61a723404292d74cb5",
  "status":"completed",
  "start_type":"immediate",
  "start_at":"2021-06-28T14:58:30.541+09:00"
}

5.20. ライブスケジュールの作成

ライブスケジュールを作成するAPIです。時間指定または即時に、あらかじめ登録したライブ入力切り替えまたはSCTE35挿入ができます。

5.20.1. HTTPリクエスト

POST https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/live_event_schedules

5.20.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id

5.20.3. リクエスト

フィールド	タイプ	説明
start_type	String	挿入タイミング指定方法(fixed, immediate, follow)
live_input_source_id	String	ライブ入力ソースID
action_type	String	挿入信号タイプ(splice_insertまたはtime_signal)
start_at	String	挿入日時(start_typeがfixedの場合のみ要入力)
duration	String	1秒=90000で入力すること
splice_event_id	String
segment_num	String	最小値0、最大値255
segmentation_upid	String	最小値0、最大値255
segment_expected	String	最小値0、最大値255
segmentation_type_id	String	小値0、最大値255
delivery_restrictions	Object[]
device_restrictions	String	NONE, RESTRICT_GROUP0, RESTRICT_GROUP1, RESTRICT_GROUP2のいずれか
archive_allowed_flag	String	ARCHIVE_ALLOWED, ARCHIVE_NOT_ALLOWEDのいずれか
no_regional_blackout_flag	String	REGIONAL_BLACKOUT, NO_REGIONAL_BLACKOUTのいずれか
web_delivery_allowed_flag	String	WEB_DELIVERY_ALLOWED, WEB_DELIVERY_NOT_ALLOWEDのいずれか
segmentation_duration	String	1秒=90000で入力すること
segmentation_event_id	String	最小値0、最大値4294967295

リクエストの例 (splice_insert挿入)

{
  "start_type":"fixed",
  "live_input_source_id":"441086befdd04a61a723404292d74cb5",
  "action_type":"splice_insert",
  "start_at":"2021-06-28T14:58:30.541+09:00",
  "duration":"900000",
  "splice_event_id":"6513507"
}

リクエストの例 (time_signal挿入)

{
  "start_type":"fixed",
  "action_type":"time_signal",
  "start_at":"2021-06-28T14:58:30.541+09:00",
  "segment_num":"0",
  "segmentation_upid":"546",
  "segments_expected":"0",
  "segmentation_type_id":"48",
  "delivery_restrictions":{
    "device_restrictions":"NONE",
    "archive_allowed_flag":"ARCHIVE_NOT_ALLOWED",
    "no_regional_blackout_flag":"NO_REGIONAL_BLACKOUT",
    "web_delivery_allowed_flag":"WEB_DELIVERY_NOT_ALLOWED"
  },
  "segmentation_duration":"60",
  "segmentation_event_id":"3"
}

リクエストの例 (登録画像挿入)

{
  "live_input_source_id":"e4ec00b5ca25418592a3e1c290b9953a",
  "start_type": "immediate"
}

5.20.4 レスポンス

フィールド	タイプ	説明
id	String	ライブスケジュールID
project_id	String	プロジェクトID
live_event_id	String	ライブイベントID
live_input_source_id	String	ライブ入力ソースID
status	String	状態
start_type	String	挿入タイミング指定方法
start_at	String	挿入日時

レスポンスの例

HTTP/1.1 200 OK

{
  "id":"fce27221d04c457db44300d67402ce13",
  "project_id":"logiclogic",
  "live_event_id":"3888f5a1c26a4a80bd7356b8b8ffdf2c",
  "live_input_source_id":null,
  "status":"preparing",
  "start_type":"fixed",
  "start_at":"2021-06-30T15:58:30.541+09:00",
  "action_type":"time_signal",
  "segmentation_type_id":"48",
  "segmentation_upid":"546",
  "segmentation_event_id":"3",
  "segmentation_duration":"60",
  "segment_num":"0",
  "segments_expected":"0",
  "delivery_restrictions":{
    "device_restrictions":"NONE",
    "archive_allowed_flag":"ARCHIVE_NOT_ALLOWED",
    "no_regional_blackout_flag":"NO_REGIONAL_BLACKOUT",
    "web_delivery_allowed_flag":"WEB_DELIVERY_NOT_ALLOWED"
  }
}

5.21. ライブスケジュールの更新

ライブスケジュールを更新するAPIです。

5.21.1. HTTPリクエスト

PUT https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/live_event_schedules/:live_event_schedule_id

5.21.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id
live_event_schedule_id	String	ライブスケジュールID	ID

5.21.3. リクエスト

フィールド	タイプ	説明
start_type	String	挿入タイミング指定方法(fixed, immediate, follow)
live_input_source_id	String	ライブ入力ソースID
action_type	String	挿入信号タイプ(splice_insertまたはtime_signal)
start_at	String	挿入日時(start_typeがfixedの場合のみ要入力)
duration	String	1秒=90000で入力すること
splice_event_id	String
segment_num	String	最小値0、最大値255
segmentation_upid	String	最小値0、最大値255
segment_expected	String	最小値0、最大値255
segmentation_type_id	String	小値0、最大値255
delivery_restrictions	Object[]
device_restrictions	String	NONE, RESTRICT_GROUP0, RESTRICT_GROUP1, RESTRICT_GROUP2のいずれか
archive_allowed_flag	String	ARCHIVE_ALLOWED, ARCHIVE_NOT_ALLOWEDのいずれか
no_regional_blackout_flag	String	REGIONAL_BLACKOUT, NO_REGIONAL_BLACKOUTのいずれか
web_delivery_allowed_flag	String	WEB_DELIVERY_ALLOWED, WEB_DELIVERY_NOT_ALLOWEDのいずれか
segmentation_duration	String	1秒=90000で入力すること
segmentation_event_id	String	最小値0、最大値4294967295

リクエストの例 (splice_insert挿入)

{
  "start_type":"fixed",
  "live_input_source_id":"441086befdd04a61a723404292d74cb5",
  "action_type":"splice_insert",
  "start_at":"2021-06-28T14:58:30.541+09:00",
  "duration":"900000",
  "splice_event_id":"6513507"
}

リクエストの例 (time_signal挿入)

{
  "start_type":"fixed",
  "action_type":"time_signal",
  "start_at":"2021-06-28T14:58:30.541+09:00",
  "segment_num":"0",
  "segmentation_upid":"546",
  "segments_expected":"0",
  "segmentation_type_id":"48",
  "delivery_restrictions":{
    "device_restrictions":"NONE",
    "archive_allowed_flag":"ARCHIVE_NOT_ALLOWED",
    "no_regional_blackout_flag":"NO_REGIONAL_BLACKOUT",
    "web_delivery_allowed_flag":"WEB_DELIVERY_NOT_ALLOWED"
  },
  "segmentation_duration":"60",
  "segmentation_event_id":"3"
}

リクエストの例 (登録画像挿入)

{
  "live_input_source_id":"e4ec00b5ca25418592a3e1c290b9953a",
  "start_type": "immediate"
}

5.21.4 レスポンス

フィールド	タイプ	説明
id	String	ライブスケジュールID
project_id	String	プロジェクトID
live_event_id	String	ライブイベントID
live_input_source_id	String	ライブ入力ソースID
status	String	状態
start_type	String	挿入タイミング指定方法
start_at	String	挿入日時

レスポンスの例

HTTP/1.1 200 OK

{
  "id":"fce27221d04c457db44300d67402ce13",
  "project_id":"logiclogic",
  "live_event_id":"3888f5a1c26a4a80bd7356b8b8ffdf2c",
  "live_input_source_id":null,
  "status":"preparing",
  "start_type":"fixed",
  "start_at":"2021-06-30T15:58:30.541+09:00",
  "action_type":"time_signal",
  "segmentation_type_id":"48",
  "segmentation_upid":"546",
  "segmentation_event_id":"3",
  "segmentation_duration":"60",
  "segment_num":"0",
  "segments_expected":"0",
  "delivery_restrictions":{
    "device_restrictions":"NONE",
    "archive_allowed_flag":"ARCHIVE_NOT_ALLOWED",
    "no_regional_blackout_flag":"NO_REGIONAL_BLACKOUT",
    "web_delivery_allowed_flag":"WEB_DELIVERY_NOT_ALLOWED"
  }
}

5.22. ライブスケジュールの削除

ライブスケジュールを更新するAPIです。

5.22.1. HTTPリクエスト

DELETE https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/live_event_schedules/:live_event_schedule_id

5.22.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id
live_event_schedule_id	String	ライブスケジュールID	id

5.22.3 レスポンス

HTTP/1.1 200 OK

{
  "id":"4191d2e986764c64b6e2f275273cf905",
  "project_id":"logiclogic",
  "live_event_id":"eeb0627376e044998e8450b82ff078f8",
  "live_input_source_id":"e4ec00b5ca25418592a3e1c290b9953a",
  "status":"preparing",
  "start_type":"immediate",
  "start_at":"2021-07-01T18:36:53.115+09:00"
}

5.23. IDによるライブ入力の取得

ライブ入力のIDを指定して1件取得するAPIです。

5.23.1. HTTPリクエスト

GET https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/live_input_sources/:live_input_source_id

5.23.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id
live_input_source_id	String	ライブ入力ID	id

5.23.3 レスポンス

フィールド	タイプ	説明
id	String	ライブ入力ID
project_id	String	プロジェクトID
live_event_id	String	ライブイベントID
storage_id	String	ストレージID
name	String	ライブ入力名
source_type	String	ライブ入力のタイプ(入力プロトコルまたはmp4)
source_url1	String	挿入画像/動画のURL
created_at	String	作成日時
updated_at	String	更新日時
deleted_at	String	削除日時

レスポンスの例

HTTP/1.1 200 OK

{
  "id":"abc10c39e9914723b4bd7e9e25352287",
  "project_id":"logiclogic",
  "live_event_id":"63b6d4ec6e374298b9059a635b03f079",
  "storage_id":"57492cf0c6484dc285efc1abaa3b8c07",
  "name":"bigbuck",
  "source_type":"mp4",
  "source_url1":"s3://test/sample.mp4",
  "created_at":"2020-11-27T21:02:00.265+09:00",
  "updated_at":"2020-11-27T21:02:00.265+09:00",
  "deleted_at":null
}

5.24. ライブ入力の一覧取得

ライブ入力の一覧を取得するAPIです。

5.24.1. HTTPリクエスト

GET https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/live_input_sources

5.24.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id

5.24.3. クエリパラメータ

フィールド	タイプ	説明	サンプル
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

5.24.4. レスポンス

フィールド	タイプ	説明
id	String	ライブ入力ID
project_id	String	プロジェクトID
live_event_id	String	ライブイベントID
storage_id	String	ストレージID
name	String	ライブ入力名
source_type	String	ライブ入力のタイプ(入力プロトコルまたはmp4)
source_url1	String	挿入画像/動画のURL
created_at	String	作成日時
updated_at	String	更新日時
deleted_at	String	削除日時

レスポンスの例

HTTP/1.1 200 OK

{
  "count": 30,
  "live_input_sources":
    [
      {<live_input_source1 fields>},
      {<live_input_source2 fields>},
      ...
    ]
}

5.25. ライブ入力の登録

ライブ入力を登録するAPIです。登録したライブ入力を使ってライブ配信する場合は、ライブスケジュール作成APIをご利用ください。

5.25.1. HTTPリクエスト

POST https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/live_input_sources

5.25.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id

5.25.3. リクエスト

フィールド	タイプ	説明
name	String	ライブ入力名
description	String	説明
source_url	String	挿入画像/動画のURL
storage_id	String	ストレージID
source_type	String	ソースタイプ(mp4のみ)

リクエストの例

{
  "name": "入力",
  "source_url": "s3://ll-streaks-4af6ec2b0ef44be0b15d3d198dfbe636-upload-file-storage/3793.png",
  "storage_id": "57492cf0c6484dc285efc1abaa3b8c07",
  "source_type": "mp4"
}

5.25.4. レスポンス

フィールド	タイプ	説明
id	String	ライブ入力ID
project_id	String	プロジェクトID
live_event_id	String	ライブイベントID
storage_id	String	ストレージID
name	String	ライブ入力名
source_type	String	ライブ入力のタイプ(入力プロトコルまたはmp4)
source_url1	String	挿入画像/動画のURL
created_at	String	作成日時
updated_at	String	更新日時
deleted_at	String	削除日時

レスポンスの例

HTTP/1.1 200 OK

{
  "id":"efb43485f06945498f2762f7716da451",
  "project_id":"logiclogic",
  "live_event_id":"8995c485535c44719b4c95554ac24afb",
  "storage_id":"57492cf0c6484dc285efc1abaa3b8c07",
  "name":"入力",
  "source_type":"mp4",
  "source_url1":"s3://test-storage/test.png",
  "created_at":"2021-07-01T02:25:56.840+09:00",
  "updated_at":"2021-07-01T02:25:56.840+09:00",
  "deleted_at":null
}

5.26. ライブ入力の更新

ライブ入力を更新するAPIです。ライブ起動中は更新できません。

5.26.1. HTTPリクエスト

PUT https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/live_input_sources/:live_input_source_id

5.26.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id
live_input_source_id	String	ライブ入力ID	id

5.26.3. リクエスト

フィールド	タイプ	説明
name	String	ライブ入力名
description	String	説明
source_url	String	参照ID
storage_id	String	ストレージID
source_type	String	ソースタイプ(mp4のみ)

リクエストの例

{
  "name": "入力", 
  "source_url": "s3://ll-streaks-4af6ec2b0ef44be0b15d3d198dfbe636-upload-file-storage/3793.png", 
  "storage_id": "57492cf0c6484dc285efc1abaa3b8c07", 
  "source_type": "mp4"
}

5.26.4. レスポンス

フィールド	タイプ	説明
id	String	ライブ入力ID
project_id	String	プロジェクトID
live_event_id	String	ライブイベントID
storage_id	String	ストレージID
name	String	ライブ入力名
source_type	String	ライブ入力のタイプ(入力プロトコルまたはmp4)
source_url1	String	挿入画像/動画のURL
created_at	String	作成日時
updated_at	String	更新日時
deleted_at	String	削除日時

レスポンスの例

HTTP/1.1 200 OK

{
  "id":"efb43485f06945498f2762f7716da451",
  "project_id":"logiclogic",
  "live_event_id":"8995c485535c44719b4c95554ac24afb",
  "storage_id":"57492cf0c6484dc285efc1abaa3b8c07",
  "name":"入力",
  "source_type":"mp4",
  "source_url1":"s3://test-storage/test.png",
  "created_at":"2021-07-01T02:25:56.840+09:00",
  "updated_at":"2021-07-01T02:25:56.840+09:00",
  "deleted_at":null
}

5.27. ライブ入力の削除

ライブ入力を削除するAPIです。

5.27.1. HTTPリクエスト

DELETE https://live.api.streaks.jp/v1/projects/:project_id/live_events/:live_event_id/live_input_sources/:live_input_source_id

5.27.2. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
live_event_id	String	ライブイベントID	id
live_input_source_id	String	ライブ入力ID	id

5.27.3. レスポンス

フィールド	タイプ	説明
id	String	ライブ入力ID
project_id	String	プロジェクトID
live_event_id	String	ライブイベントID
storage_id	String	ストレージID
name	String	ライブ入力名
source_type	String	ライブ入力のタイプ(入力プロトコルまたはmp4)
source_url1	String	挿入画像/動画のURL
created_at	String	作成日時
updated_at	String	更新日時
deleted_at	String	削除日時

レスポンスの例

HTTP/1.1 200 OK

{
  "id":"efb43485f06945498f2762f7716da451",
  "project_id":"logiclogic",
  "live_event_id":"8995c485535c44719b4c95554ac24afb",
  "storage_id":"57492cf0c6484dc285efc1abaa3b8c07",
  "name":"入力",
  "source_type":"mp4",
  "source_url1":"s3://test-storage/test.png",
  "created_at":"2021-07-01T02:25:56.840+09:00",
  "updated_at":"2021-07-01T02:25:56.840+09:00",
  "deleted_at":null
}

6. カタログAPI

6.1. IDもしくは参照IDによるメディアの取得

メディア情報を1件取得するAPIです。

6.1.1. HTTPリクエスト

GET https://catalog.api.streaks.jp/v1/projects/:project_id/medias/:media_id

OR

GET https://catalog.api.streaks.jp/v1/projects/:project_id/medias/ref:ref_id

6.1.2. リクエストヘッダー

このAPIはプロジェクト単位で認証の有無を設定することができます。 認証を必要とする場合、リクエストヘッダーにAuthorizationを追加してください。

フィールド	タイプ	説明
Authorization	String	Authorization: Bearer access_token
Content-Type	String	Content-Type: application/json
X-Streaks-Api-Key	String	X-Streaks-Api-Key:

6.1.3. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic
media_id	String	メディアID	1
ref_id	String	参照ID	video1

6.1.4. レスポンス

フィールド	タイプ	説明
project_id	String	プロジェクトID
id	String	メディアID
ref_id	String	参照ID (プロジェクト内部でユニークである必要がある)
live_event_id	String	ライブイベントID
name	String	名前
description	String	説明文
duration	Number	尺(milliseconds)
encode_type	String	エンコードタイプ (ファイル or ライブ or スケジュールライブ
custom_fields	Object	カスタムフィールドの値、デフォルト値は{}
publish_geo_rule	String	公開地域ルール
poster	Object	ポスター画像
src	String	ポスター画像のURL
thumbnaill	Object	サムネイル画像
src	String	サムネイルのURL
seek_preview_config	JSON	シークプレビュー設定
tags	String[]	タグの配列
offline_enabled	Boolean	オフライン再生が可能か
text_tracks	Object[]	テキストデータの配列
created_at	DateString	作成日時
updated_at	DateString	更新日時

レスポンスの例

HTTP/1.1 200 OK

{
"project_id": "logiclogic",
"id": "7f8d4baf20f244fca34acbe3452886ac",
"ref_id": null,
"live_event_id": "6126a01db6744dca93aa2af575e9ba0c",
"name": "live_event_6126a01db6744dca93aa2af575e9ba0c",
"description": "",
"duration": null,
"encode_type": null,
"custom_fields": {
   "keywords": "live, test",
   "link": "http://test_link"
 },
"publish_geo_rule": [
  "jp"
],
"poster": {
  "src": "/uploads/logiclogic/sample_poster.gif"
},
"thumbnail": {
  "src": "/uploads/logiclogic/sample_thumbnail.jpg"
},
"seek_preview_config": null,
"tags": [],
"offline_enabled": false,
"text_tracks": [
  {
    "kind": "subtitles",
    "lang": "ja",
    "mime_type": "type/vtt",
    "src": "https://s3-ap-northeast-1.amazonaws.com/sample.mp3"
  }
],
"created_at": "2018-02-22T12:03:36.427+09:00",
"updated_at": "2018-02-22T18:44:38.839+09:00"
}

6.1.5. エラーコード

ステータスコード	コード	メッセージ
401	UNAUTHORIZED	認証に失敗しました
403	GEO_RULE	アクセス元のIPアドレスは許可されていません
404	MEDIA_NOT_FOUND	該当するメディアが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

6.2. メディア一覧の取得

メディア情報の一覧を取得するAPIです。

6.2.1. HTTPリクエスト

GET https://catalog.api.streaks.jp/v1/projects/:project_id/medias/

6.2.2. リクエストヘッダー

このAPIはプロジェクト単位で認証の有無を設定することができます。 認証を必要とする場合、リクエストヘッダーにAuthorizationを追加してください。

フィールド	タイプ	説明
Authorization	String	Authorization: Bearer access_token
Content-Type	String	Content-Type: application/json
X-Streaks-Api-Key	String	X-Streaks-Api-Key:

6.2.3. URLパラメータ

フィールド	タイプ	説明	サンプル
project_id	String	プロジェクトID	logiclogic

6.2.4. クエリパラメータ

フィールド	タイプ	説明	サンプル
limit	Integer	取得件数	30
page	Integer	ページ番号	1
sort	String	ソート指定カラム	updated_at
order	String	並び順	ASC

6.2.5. レスポンス

フィールド	タイプ	説明
project_id	String	プロジェクトID
id	String	メディアID
ref_id	String	参照ID (プロジェクト内部でユニークである必要がある)
live_event_id	String	ライブイベントID
name	String	名前
description	String	説明文
duration	Number	尺(milliseconds)
encode_type	String	エンコードタイプ (ファイル or ライブ or スケジュールライブ
custom_fields	Object	カスタムフィールドの値、デフォルト値は{}
publish_geo_rule	String	公開地域ルール
poster	Object	ポスター画像
src	String	ポスター画像のURL
thumbnaill	Object	サムネイル画像
src	String	サムネイルのURL
seek_preview_config	JSON	シークプレビュー設定
tags	String[]	タグの配列
offline_enabled	Boolean	オフライン再生が可能か
text_tracks	Object[]	テキストデータの配列
created_at	DateString	作成日時
updated_at	DateString	更新日時

レスポンスの例

HTTP/1.1 200 OK

{
  "count": 30,
  "medias":
    [
      {<media1 fields>},
      {<media2 fields>},
      ...
    ]
}

6.2.6. エラーコード

ステータスコード	コード	メッセージ
400	BAD_REQUEST	リクエストパラメーターが不正です
401	UNAUTHORIZED	認証に失敗しました
404	MEDIA_NOT_FOUND	該当するメディアが存在しません
500	SERVER_ERROR	予期せぬエラーが発生しました

7. DRM関連処理

7.1. 初期設定

DRMを利用するためには、プロジェクト単位での有効化が必要です。有効化のためには、カスタマーサポートまでお問い合わせください。 コンテンツをiOSデバイス（Apple TVなど）やブラウザのSafariに配信したい場合は、AppleからリリースされているFairPlayデプロイメントパッケージを取得する必要があります。FairPlayデプロイメントパッケージを請求するには、AppleのデベロッパーサイトからAppleにご連絡ください。パッケージには、以下の4つの重要な情報が含まれていますので、それをカスタマーサポートに伝えてください。 通常DRMの有効化は5営業日以内に対応されます。

7.1.1. FairPlayに必要な情報

• CSR（証明書署名要求） ファイル形式: .csr
• ASK（アプリケーションシークレットキー） ファイル形式: 128bitの文字列
• 証明書 ファイル形式: .derもしくは.cer
• キー（スタンダードプレイベートキー） ファイル形式: .pem

ステージング環境においてFairplayの実装テストをしていたとしても、Apple社からプロダクション証明を取得する必要があります。

7.2. 権限チェック

StreaksではPlayback APIまたはBack-end Entitlemnt System(BEES)を通して、それぞれ視聴用URLリクエスト、プレイヤーからの鍵のリクエストの際にそのリクエストは有効なのかを確認する機構を提供しています。

権限チェックを行う場合は、権利判定処理を用意して頂く必要があります。

7.2.1. EC_URLの登録

Playback APIでec_urlをキーとして対象のURLを渡すかあらかじめ設定しておくことで、そのURLに対して権限チェックのリクエストを行います。

7.2.1.1. HTTPリクエスト

POST <ec_url>

7.2.1.2. リクエストヘッダー

以下のリクエストヘッダーを権限チェックリクエスト時に付加することにより、権利判定処理にヘッダー情報が渡ります。

フィールド	タイプ	説明
X-BEES-Authorization	String	任意の文字列

7.2.1.3. リクエストボディ

フィールド	タイプ	説明
project_id	String	プロジェクトID
user_id	String	プロジェクトがPlayback APIで指定したuser_id
session_id	String	Playback APIで発行されたsession_id
media_id	String	メディアID
referer	UrlString	キーリクエストヘッダーのOrigin

これらのフィールドに加えて、ライセンスURLに付与されたクエリパラメータも受け渡されます。

7.2.1.4 レスポンス

フィールド	タイプ	説明	サンプル
entitled	Boolean	視聴可能かどうか	true/false
key_absolute_expired_at	DateString	(OPTION) キーの有効期限	2017-12-25T00:00:00Z
key_duration	Number	(OPTION) キーの有効期間。秒で指定	86400、なおkey_absolute_expiredAtを指定した場合は無視される
profile_type	String	rentalもしくはpurchaseを指定する。何も指定しない場合はrentalとなる。purchaseが指定された場合はkey_absolute_expired_atとkey_durationは無視される。	rental/purchase
expiration	DateString	(OPTION) 権利の有効期間、有効期間まではキーローテーションを行っても再度リクエストされなくなる。なおこの権利の有効期間をすぎた後にローテーションされると再度リクエスされる	2017-12-25T00:00:00Z
play_range	JSON	(OPTION) 動画の視聴可能な範囲の指定(単位はsec)	{from: 60, to: 180}

このレスポンスはHTTPステータスコードが2xx以外の場合と、expirationが指定されない場合を除き、expirationに指定された時間の間、キャッシュされます。