API docs by Redocly

Equipmedia 旧EQライブ（v1） (1.0.0)

Download OpenAPI specification:Download

旧EQライブ（v1）APIはライブ関連の操作を、管理画面を利用せず、API経由で行うことができます。
ライブ情報の読み込みを行うReadAPIと、ライブ情報の書き込みやライブ関連の操作を行うWriteAPIに分けられます。

APIの概要についてはマニュアルをご覧ください。

EQAPI一覧に戻る

ReadAPI

ライブプロファイル取得API

ライブ配信におけるプロファイル設定情報を取得するための API です。
指定された条件に基づき、ライブ配信設定や配信状態、チャット設定、
配信帯域などの詳細な構成情報を一覧形式で取得することができます。

本 API は ReadAPI トークンによる認証を必要とし、
ページングや検索条件の指定により対象のライブプロファイルを絞り込んで取得することが可能です。
また、JSON または JSONP 形式でレスポンスを取得することができます。

利用上の注意事項：

  • 本 API は GET メソッド専用です。
  • API の実行には ReadAPI トークンが必要です。
  • レスポンス形式は json または jsonp を指定可能です。
  • 取得結果は指定した条件およびライブステータスに依存します。
  • 一部の情報はライブ設定やオプション機能により含まれない場合があります。
  • 不正なパラメータが指定された場合、エラーステータスが返却されます。

マニュアル

query Parameters
token
required
string

ReadAPIトークン

type
string
Default: "jsonp"
Enum: "jsonp" "json"

返却形式（jsonp / json）

callback
string
Default: "searchResultEq"

JSONP コールバック関数名（jsonp時のみ）

pageSize
integer <= 100
Default: 10

取得件数（最大100）

pageNumber
integer
Default: 1

取得開始ページ番号

lpid
string

ライブID
カンマ区切りで複数指定可能
JavaScript利用時は配列で指定可能

liveName
string

ライブ設定名（部分一致）

status
string
Enum: "stop" "prepare" "open"

ライブステータス

  • stop：配信停止中
  • prepare：配信準備中
  • open：本番配信中
p1
string

任意パラメータ1（そのまま返却）

p2
string

任意パラメータ2（そのまま返却）

p3
string

任意パラメータ3（そのまま返却）

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/getLiveProfile/?token='

Response samples

Content type
application/json
Example
{
  • "response_status": "2000",
  • "livesum": 1,
  • "profiles": [
    ]
}

ライブ同時接続取得API

ライブ配信中の同時接続数を取得するための API です。
指定されたライブIDに紐づく視聴者の同時接続数を、
時系列データとして取得することができます。

本 API は ReadAPI トークンによる認証を必要とし、
取得形式の指定に応じてテキスト形式またはファイル形式でデータが返却されます。

利用上の注意事項：

  • 本 API は GET メソッド専用です。
  • API の実行には ReadAPI トークンが必要です。
  • ライブ配信中または対象期間のデータが存在する場合にのみ取得可能です。
  • 返却されるデータは一定間隔の時系列形式で提供されます。
  • 不正なリクエストまたは対象データが存在しない場合は、
    HTTPステータスエラーが返却されます。

マニュアル

query Parameters
token
required
string

ReadAPIトークン

lpid
required
integer

ライブID。
同時接続数を取得する対象のライブを指定。

type
string
Default: "file"
Enum: "text" "file"

ダウンロードタイプ。デフォルトは file。

  • text：ブラウザ表示
  • file：ファイルダウンロード

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/getLiveConnection/?token=&lpid=1'

Response samples

Content type
text/plain
2019-11-07 17:55:30,0
2019-11-07 17:56:00,0
2019-11-07 17:56:30,255
2019-11-07 17:57:00,444
2019-11-07 17:57:30,514
2019-11-07 17:58:00,603
2019-11-07 17:58:30,680
2019-11-07 17:59:00,777
2019-11-07 17:59:30,905
2019-11-07 18:00:00,1017

ライブ同時接続履歴取得API

過去に実施されたライブ配信の同時接続数の履歴情報を取得するための API です。
指定されたライブログIDに紐づく視聴者数の推移を、
時系列データとして取得することができます。

本 API は ReadAPI トークンによる認証を必要とし、
取得形式の指定に応じてテキスト形式またはファイル形式で履歴データが返却されます。

利用上の注意事項：

  • 本 API は GET メソッド専用です。
  • API の実行には ReadAPI トークンが必要です。
  • 指定したライブログIDに対応する履歴データのみ取得可能です。
  • 返却されるデータは一定間隔の時系列形式で提供されます。
  • 不正なリクエストまたは対象データが存在しない場合は、
    HTTPステータスエラーが返却されます。

マニュアル

query Parameters
token
required
string

ReadAPIトークン

lplid
required
string

ライブログID（例：12-3）。
「ライブID-ライブ回数」の形式で指定。

type
string
Default: "file"
Enum: "text" "file"

ダウンロードタイプ。デフォルトは file。 - text：ブラウザ表示 - file：ファイルダウンロード

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/getLiveConnectionArch/?token=&lplid='

Response samples

Content type
text/plain
2019-11-07 17:55:30,0
2019-11-07 17:56:00,0
2019-11-07 17:56:30,255
2019-11-07 17:57:00,444
2019-11-07 17:57:30,514
2019-11-07 17:58:00,603
2019-11-07 17:58:30,680
2019-11-07 17:59:00,777
2019-11-07 17:59:30,905
2019-11-07 18:00:00,1017

ライブ履歴取得API

過去に実施されたライブ配信の履歴情報を取得するための API です。
指定された条件に基づき、ライブイベントの開催日時や配信状態、
使用された設定情報などの履歴データを一覧形式で取得することができます。

本 API は ReadAPI トークンによる認証を必要とし、
ページングや検索条件の指定により対象のライブ履歴を絞り込んで取得することが可能です。
また、JSON または JSONP 形式でレスポンスを取得することができます。

利用上の注意事項：

  • 本 API は GET メソッド専用です。
  • API の実行には ReadAPI トークンが必要です。
  • 取得可能な履歴期間には制限があり、一定期間以前のデータは取得できません。
  • レスポンス内容は指定した検索条件および対象データの状態に依存します。
  • 一部の情報は設定やオプションにより含まれない場合があります。
  • 不正なパラメータが指定された場合、エラーステータスが返却されます。

マニュアル

query Parameters
token
required
string

ReadAPIトークン

type
string
Default: "jsonp"
Enum: "jsonp" "json"

返却形式（jsonp / json）

callback
string
Default: "searchResultEq"

JSONP コールバック関数名（jsonp時のみ）

pageSize
integer <= 100
Default: 10

取得件数（最大100）

pageNumber
integer
Default: 1

取得開始ページ番号

lpid
string

ライブプロファイルID
カンマ区切りで複数指定可能
JavaScript 利用時は配列で指定可能

event_date_from
string

ライブ開催日（開始）
YYYYMMDD / YYYY/MM/DD / YYYY-MM-DD
※26ヶ月以前は指定不可（エラーコード 1026）

event_date_to
string

ライブ開催日（終了）
YYYYMMDD / YYYY/MM/DD / YYYY-MM-DD

liveName
string

ライブ設定名（部分一致）

eventName
string

ライブイベント名（部分一致）

p1
string

任意パラメータ1（そのまま返却）

p2
string

任意パラメータ2（そのまま返却）

p3
string

任意パラメータ3（そのまま返却）

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/getLiveProfileArch/?token='

Response samples

Content type
application/json
Example
{
  • "response_status": "2000",
  • "livesum": 1,
  • "events": [
    ]
}

ライブチャット投稿履歴取得API

過去に実施されたライブ配信におけるチャット投稿履歴を取得するための API です。
指定されたライブログIDに紐づくチャットメッセージの履歴を、
時系列データとして一覧形式で取得することができます。

本 API は ReadAPI トークンによる認証を必要とし、
取得形式の指定に応じてテキスト形式またはファイル形式で履歴データが返却されます。

利用上の注意事項：

  • 本 API は GET メソッド専用です。
  • API の実行には ReadAPI トークンが必要です。
  • チャット履歴は指定したライブログIDに紐づくデータのみ取得可能です。
  • 返却されるデータはCSV形式のテキストデータとして提供されます。
  • 対象データが存在しない場合や不正なリクエストの場合は、
    HTTPステータスエラーが返却されます。

マニュアル

query Parameters
token
required
string

ReadAPIトークン

lplid
required
string

ライブログID（例：12-3）。
「ライブID-ライブ回数」の形式で指定。

type
string
Default: "file"
Enum: "text" "file"

ダウンロードタイプ。デフォルトは file。

  • text：ブラウザ表示
  • file：ファイルダウンロード

Responses

Request samples 

curl 'https://api01-platform.stream.co.jp/apiservice/getLiveChatMsgArch/?token=&lplid='

Response samples

Content type
text/plain
number,delete,time,soket_id,name,message
1,false,2019/06/17 15:48:54,master,システム,【○○】さんが入室しました
2,false,2019/06/17 15:49:05,master,システム,【aaa】さんが入室しました
3,true,2019/06/17 15:49:27,HUHHi_dXv0MbyMBBAAAC,○○,△△部の○○開いてます。
4,false,2019/06/17 15:49:47,master,システム,【○○】さんが退室しました
5,false,2019/06/17 15:51:15,master,システム,【テストです】さんが入室しました
6,true,2019/06/17 15:51:28,ZF_b0ZXgHScWrAUIAAAE,テストです,テストです
7,true,2019/06/17 15:51:32,ZF_b0ZXgHScWrAUIAAAE,テストです,:trouble:よくわかりません。
8,true,2019/06/17 15:52:09,W8iS8tD8piUyaur4AAAF,aaa,EQライブプレイヤーのサイズをレスポンシブ設定にしておくと、チャットを含んだ画面が使いやすくなりますよ。
9,true,2019/06/17 15:52:28,ZF_b0ZXgHScWrAUIAAAE,テストです,:nice:いいね！しました。
10,false,2019/06/17 15:52:33,master,システム,【aaa】さんが退室しました

WriteAPI

アップロードキー取得

認証API以外の各 WriteAPI を利用する際に必要となる、
アップロードキーを取得するための API です。
本 API を実行することで、一時的に有効なアップロードキーが発行されます。

本 API は契約会社IDおよび API トークンを用いた認証を行い、
発行されたアップロードキーは指定された WriteAPI の呼び出しに利用されます。

利用上の注意事項：

  • 発行されるアップロードキーの有効期限は 3 時間です。
  • 有効期限を過ぎたアップロードキーは使用できません。
  • 本 API は GET および POST の両メソッドに対応しています。
  • レスポンスは text/plain 形式で返却されます。
  • 認証に失敗した場合はアップロードキーは発行されません。

マニュアル

query Parameters
cid
required
integer

契約会社ID

API
required
string

WriteAPIトークン

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/WriteApiLocation.aspx?cid=1&API='

ライブプロファイル作成・更新API

ライブ配信のプロファイル設定を新規作成または更新するための API です。
指定された配信設定に基づき、配信品質、同時接続数制限、チャット設定、
サムネイル、関連リンクなどの各種ライブ設定を登録・変更することができます。

本 API はアップロードキーを用いて実行され、
ライブIDを指定しない場合は新規作成、指定した場合は既存プロファイルの更新が行われます。

利用上の注意事項：

  • 本 API は POST メソッド（multipart/form-data）専用です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • 新規作成と更新で指定可能なパラメータが異なります。
  • 配信品質設定では、少なくとも1つ以上の画質を有効に設定する必要があります。
  • 一部の設定は他の設定（例：ライブキャスト利用）により制限される場合があります。
  • チャット設定や関連リンク、サムネイルは任意で指定可能です。
  • 不正なパラメータが指定された場合、プロファイルの登録または更新は行われません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
integer

ライブID。
新規：指定不要（自動連番）
更新：必須

name
string

ライブ配信設定名（必須）。
全角半角100文字以内。

description
string

ライブ設定説明（任意）。
全角半角500文字以内。

group_id
integer

グループ設定（録画ファイルアップロード先）。

transcode_id
integer

トランスコードID。
新規時はデフォルト設定が適用。

max_client
integer

同時接続数制限。
ライブの同時接続上限。

liveapp_flg
integer
Default: 0
Enum: 0 1

EQライブキャスト利用
0：利用しない（デフォルト）
1：利用する
※利用する場合、最高画質のみ選択される

quality_fhd
integer
Default: 0
Enum: 0 1

フルHD画質（必須）
※ 5画質の内、最低1つは「有効」に設定する必要があります。
（画質が一つも「有効」に設定されていない場合はエラーとなります。）
0：無効
1：有効

quality_hd
integer
Default: 0
Enum: 0 1

HD画質（必須）
※ 5画質の内、最低1つは「有効」に設定する必要があります。
（画質が一つも「有効」に設定されていない場合はエラーとなります。）
0：無効
1：有効

quality_high
integer
Default: 0
Enum: 0 1

高画質（必須）
※ 5画質の内、最低1つは「有効」に設定する必要があります。
（画質が一つも「有効」に設定されていない場合はエラーとなります。）
0：無効
1：有効

quality_standard
integer
Default: 0
Enum: 0 1

標準画質（必須）
※ 5画質の内、最低1つは「有効」に設定する必要があります。
（画質が一つも「有効」に設定されていない場合はエラーとなります。）
0：無効
1：有効

quality_low
integer
Default: 0
Enum: 0 1

低画質（必須）
※ 5画質の内、最低1つは「有効」に設定する必要があります。
（画質が一つも「有効」に設定されていない場合はエラーとなります。）
0：無効
1：有効

encoder_type
integer
Default: 2
Enum: 1 2

使用するライブエンコーダー台数
1：1台
2：2台
※ライブキャスト利用時は 1 固定

vod_flg
integer
Default: 1
Enum: 0 1

VOD使用可否
0：無効
1：有効（デフォルト）

exlink_flg
integer
Default: 1
Enum: 0 1

動画からのリンク利用
0：利用しない
1：利用する（デフォルト）

exlink1_txt
string

関連ページリンク(1) テキスト（100文字以内）

exlink1_url
string

関連ページリンク(1) URL（1000文字以内）

exlink2_txt
string

関連ページリンク(2) テキスト（100文字以内）

exlink2_url
string

関連ページリンク(2) URL（1000文字以内）

exlink3_txt
string

関連ページリンク(3) テキスト（100文字以内）

exlink3_url
string

関連ページリンク(3) URL（1000文字以内）

vlp_id
integer

セキュリティプロファイルID
新規時は「制限なし」で登録。

thumb_feedout
string <binary>

配信停止サムネイル（2MB以下）
*.gif / *.jpeg / *.jpg / *.png

thumb_feedin
string <binary>

配信準備サムネイル（2MB以下）

thumb_liveopen
string <binary>

配信終了サムネイル（2MB以下）

server_number
integer
Default: 2
Enum: 1 2

ライブエンコーダー1台利用時の詳細設定
1：1系統
2：2系統
※ライブキャスト利用時は 1 固定

chat_flg
integer
Default: 0
Enum: 0 1

チャット利用可否
0：利用しない
1：利用する

chat_auto_resize
integer
Default: 0
Enum: 0 1

チャット自動リサイズ
0：無効
1：有効

chat_width
integer
Default: 600

チャット幅
300〜1920（デフォルト600）

chat_height
integer
Default: 400

チャット高さ
320〜1080（デフォルト400）

chat_block_type
integer
Default: 0
Enum: 0 1 2

投稿メッセージ管理
0：すべて許可
1：不適切の可能性があるものを保留
2：すべて保留

chat_enter_msg
integer
Default: 0
Enum: 0 1 2

入退室メッセージ表示
0：表示
1：入室のみ
2：非表示

chat_good_btn
integer
Default: 1
Enum: 0 1

いいねボタン
0：無効
1：有効

chat_trouble_btn
integer
Default: 1
Enum: 0 1

わかりませんボタン
0：無効
1：有効

chat_display_name
string
Default: "admin"

管理者表示名
"admin" / "operator" / "secretariat" / 任意15文字以内

chat_block_words
string

ブロックする文字列（カンマ区切り、1000文字以内）

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/live/setProfile/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=' \
  --form 'name=' \
  --form 'description=' \
  --form 'group_id=' \
  --form 'transcode_id=' \
  --form 'max_client=' \
  --form 'liveapp_flg=0' \
  --form 'quality_fhd=0' \
  --form 'quality_hd=0' \
  --form 'quality_high=0' \
  --form 'quality_standard=0' \
  --form 'quality_low=0' \
  --form 'encoder_type=2' \
  --form 'vod_flg=1' \
  --form 'exlink_flg=1' \
  --form 'exlink1_txt=' \
  --form 'exlink1_url=' \
  --form 'exlink2_txt=' \
  --form 'exlink2_url=' \
  --form 'exlink3_txt=' \
  --form 'exlink3_url=' \
  --form 'vlp_id=' \
  --form 'thumb_feedout=' \
  --form 'thumb_feedin=' \
  --form 'thumb_liveopen=' \
  --form 'server_number=2' \
  --form 'chat_flg=0' \
  --form 'chat_auto_resize=0' \
  --form 'chat_width=600' \
  --form 'chat_height=400' \
  --form 'chat_block_type=0' \
  --form 'chat_enter_msg=0' \
  --form 'chat_good_btn=1' \
  --form 'chat_trouble_btn=1' \
  --form 'chat_display_name=admin' \
  --form 'chat_block_words='

Response samples

Content type
application/json
Example
{
  • "error_code": 0,
  • "message": "OK",
  • "lpid": 1
}

ライブプロファイル削除API

ライブ配信プロファイルの設定情報を削除するための API です。
指定されたライブIDに紐づく配信設定を削除し、
該当するライブプロファイルを利用できない状態にします。

本 API はアップロードキーを用いて実行され、
不要なライブ設定の削除や運用整理の用途で利用されます。

利用上の注意事項：

  • 本 API は POST メソッド（multipart/form-data）専用です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • ライブIDには既存のライブプロファイルを指定する必要があります。
  • 削除されたライブプロファイルは元に戻すことができません。
  • 配信中または関連機能で使用中のプロファイルは削除できない場合があります。
  • 不正なパラメータが指定された場合、削除処理は実行されません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

削除対象のライブID（必須）。
半角数字で指定。

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/live/deleteProfile/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=1'

Response samples

Content type
application/json
Example
{
  • "error_code": 0,
  • "message": "OK"
}

ライブ開始停止API

ライブ配信の開始および停止を制御するための API です。
指定されたライブIDに紐づく配信を開始または停止し、
ライブ配信の状態を変更することができます。

本 API はアップロードキーを用いて実行され、
ライブ配信の運用制御（配信開始・終了）を行う用途で利用されます。

利用上の注意事項：

  • 本 API は POST メソッド（multipart/form-data）専用です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • ライブIDには既存のライブプロファイルを指定する必要があります。
  • enable パラメータにより開始（1）または停止（0）を制御します。
  • イベント名はライブ開始時のみ指定が可能です。
  • 不正なパラメータが指定された場合、配信状態は変更されません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブID（必須）。
半角数字で指定します。

enable
required
integer
Enum: 0 1

ライブ配信開始／停止（必須）。
0：ライブ停止
1：ライブ開始

event_name
string

ライブイベント名（任意）。
yyyyMMdd hh:mm:ss 形式で指定。
※ライブ開始時のみ指定可能。全角半角200文字以内。

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/live/setStatus/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=1' \
  --form 'enable=0' \
  --form 'event_name='

Response samples

Content type
application/json
Example
{
  • "error_code": 0,
  • "message": "OK"
}

ライブイベント名変更API

ライブ配信中のイベント名を変更するための API です。
指定されたライブIDに紐づくライブ配信のイベント名を、
配信中に動的に更新することができます。

本 API はアップロードキーを用いて実行され、
ライブ配信のタイトルやイベント表記を運用中に変更する用途で利用されます。

利用上の注意事項：

  • 本 API は POST メソッド（multipart/form-data）専用です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • ライブIDには既存のライブプロファイルを指定する必要があります。
  • イベント名はライブ配信中の変更用途で使用されます。
  • 文字数やフォーマットの制限があります。
  • 不正なパラメータが指定された場合、イベント名の変更は行われません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブID（必須）。
半角数字で指定します。

event_name
string

ライブイベント名（必須）。
全角半角200文字以内で指定します。

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/live/setEventName/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=1' \
  --form 'event_name=0'

Response samples

Content type
application/json
Example
{
  • "error_code": 0,
  • "message": "OK"
}

ライブエンコーダー設定取得API

ライブ配信に使用するエンコーダーの設定情報を取得するための API です。
指定されたライブIDに紐づく配信サーバ情報やストリーム名、
映像・音声のビットレートや解像度などのエンコード設定を取得することができます。

本 API はアップロードキーを用いて実行され、
エンコーダーソフト（WireCast、LiveU Solo、LiveShell など）に応じた形式で
接続情報および設定情報を取得することが可能です。

利用上の注意事項：

  • 本 API は POST メソッド（multipart/form-data）専用です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • ライブIDには既存のライブプロファイルを指定する必要があります。
  • type パラメータによりレスポンス形式（json または各エンコーダー専用形式）が切り替わります。
  • 返却される情報には配信URLやトークンが含まれるため、取り扱いには注意してください。
  • 不正なパラメータが指定された場合、設定情報は取得されません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブID（必須）。
半角数字で指定します。

type
string
Enum: "json" "wirecast" "liveusolo" "liveshell"

ライブエンコーダー形式（任意）。
"json"：JSONフォーマット（デフォルト）
"wirecast"：WireCastフォーマット
"liveusolo"：LiveUSoloフォーマット
"liveshell"：LiveShellフォーマット

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/live/getEncoder/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=1'

Response samples

Content type
Example
{
  • "error_code": 0,
  • "message": "OK",
  • "lpid": 1,
  • "encoder_setting": {
    }
}

ライブ分割API

ライブ配信中の録画ファイルを分割するための API です。
指定されたライブIDに紐づく配信において、
録画中の動画ファイルを任意のタイミングで分割することができます。

本 API はアップロードキーを用いて実行され、
長時間配信の録画ファイルを区切る用途や、アーカイブ管理を目的として利用されます。

利用上の注意事項：

  • 本 API は POST メソッド（multipart/form-data）専用です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • ライブIDには配信中のライブプロファイルを指定する必要があります。
  • 配信中のみ有効であり、停止中のライブに対しては実行できません。
  • 分割された録画ファイルはそれぞれ独立したアーカイブとして処理されます。
  • 不正なパラメータが指定された場合、録画分割処理は実行されません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブID（必須）。
半角数字で指定します。

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/live/setExtension/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=1'

Response samples

Content type
application/json
Example
{
  • "error_code": 0,
  • "message": "OK"
}

ライブ中イベント情報取得API

ライブ配信中のイベント情報および配信状態を取得するための API です。
指定されたライブIDに紐づく現在の配信状況や視聴者数、
録画ファイル数などのリアルタイム情報を取得することができます。

本 API はアップロードキーを用いて実行され、
ライブ配信中の状態確認やモニタリング用途で利用されます。

利用上の注意事項：

  • 本 API は POST メソッド（multipart/form-data）専用です。
  • API の実行には事前に取得したアップロードキーが必要です。
  • ライブIDには既存のライブプロファイルを指定する必要があります。
  • 取得される情報はライブ配信の状態に応じて変化します。
  • 配信状態や視聴者数などの値はリアルタイムに更新されます。
  • 不正なパラメータが指定された場合、情報は取得されません。

マニュアル

path Parameters
uploadKey
required
string

WriteAPI 用 アップロードキー（認証API で取得）

Request Body schema: multipart/form-data
lpid
required
integer

ライブID（必須）。
半角数字で指定します。

Responses

Request samples 

curl 'https://file-platform.stream.co.jp/writeapi/live/getNowInfo/{uploadKey}' \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'lpid=1'

Response samples

Content type
application/json
Example
{
  • "error_code": 0,
  • "message": "OK",
  • "lpid": 1,
  • "live_name": "テスト用ライブ配信設定",
  • "status": 100,
  • "event_name": "テスト配信",
  • "recfile_cnt": 1,
  • "recfile_cnt_limit": 9,
  • "current_viewing_cnt": 0,
  • "max_viewing_cnt": 0,
  • "cumulative_cnt": 0,
  • "onair_time": "2020/01/01 00:00:00"
}