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

ホーム

【記事Topへ】

ライブプロファイル取得APIを利用することで、ライブプロファイルの設定情報を取得することができます。

■JavaScriptによるAPI呼び出し関数書式

loadEqMeta(param, callback)

param：各パラメータをオブジェクト型で生成
callback：戻りjsonp名

■API呼び出しURL

http(s)://api01-platform.stream.co.jp/apiservice/getLiveProfile/?token=xxxx&各パラメータ

■パラメータ

項目名	必須	説明	フォーマット	デフォルト値
token	○	アカウント（CID）毎に発行されたトークン	文字列	無し
type	---	返却形式のタイプを指定「jsonp」「json」が指定可能	文字列	jsonp
callback	---	JSONPコールバック関数名 ※jsonp時のみ有効	文字列	searchResultEq
pageSize	---	取得する件数	半角数字（上限100）	10
pageNumber	---	取得を開始するページ番号	半角数字	1
lpid	---	取得するライブID 「,」区切りで指定することで複数指定可能 Javascript利用の場合は配列に格納	半角数字	無し
liveName	---	ライブ設定名 ※部分一致	文字列	無し
status	---	ライブのステータス stop：配信停止中 prepare：配信準備中 open：本番配信中	文字列	無し
p1,p2,p3	---	指定の引数を戻り値としてそのまま返却	文字列	無し

■レスポンス

項目名				説明	備考
response_status				APIレスポンスステータス	「レスポンスステータス」ー「■レスポンスステータス」を参照
livesum				ライブ履歴全件数
profiles	lpid			ライブID
	status			ライブステータス
	live_name			ライブ配信設定名
	live_description			ライブ設定説明
	group_id			グループ設定（録画ファイルアップロード先）
	mpid			トランスコード設定
	max_client			同時接続数制限
	liveapp_flg			EQライブキャスト利用
	bitrate_fhd			配信帯域 - フルHD画質
	bitrate_hd			配信帯域 - HD画質
	bitrate_high			配信帯域 - 高画質
	bitrate_standard			配信帯域 - 標準画質
	bitrate_low			配信帯域 - 低画質
	encoder_type			ご使用のライブエンコーダー台数	1:1台 2:2台
	vod_flg			VODの使用可否
	exlink	enabled		関連リンク利用可否
		settings	index	関連リンク番号（1～3）
			text	リンクテキスト
			url	リンクURL
	vlpid			セキュリティプロファイルID
	server_number			ライブエンコーダーを１台のみご利用頂く際の詳細設定	1:1系統 2:2系統
	chat	enabled		チャット設定利用可否	0:利用しない 1:利用する
		auto_resize_flg		自動リサイズ	0:無効 1:有効
		width		表示サイズ - width
		height		表示サイズ - height
		enter_msg		投稿されるメッセージ管理	0:表示する 1:入室メッセージのみ表示する 2:表示しない
		good_btn		[いいね]ボタン表示	0:無効 1:有効
		trouble_btn		[わかりません]ボタン表示	0:無効 1:有効
		admin_displayname		管理者表示名	管理者運営事務局
		block_words		ブロックする文字列
	live_permalink			ライブパーマリンク
	thumb_feedout			サムネイル - 配信停止URL
	thumb_feedin			サムネイル - 配信準備URL
	thumb_liveopen			サムネイル - 配信終了URL

■レスポンス例：正常時

{
  "response_status": "2000",
  "livesum": 1,
  "profiles": [
    {
      "lpid": 2,
      "status": "stop",
      "live_name": "test",
      "live_description": "",
      "group_id": 0,
      "mpid": 1,
      "max_client": 1022,
      "liveapp_flg": 0,
      "bitrate_fhd": 0,
      "bitrate_hd": 1,
      "bitrate_high": 1,
      "bitrate_standard": 1,
      "bitrate_low": 1,
      "encoder_type": 1,
      "vod_flg": 1,
      "exlink": {
        "enabled": 1,
        "settings":[
          {
            "index":1,
            "text":"",
            "url":""
          },
          {
            "index": 2,
            "text": "",
            "url": ""
          },
          {
            "index": 3,
            "text": "",
            "url": ""
          }
        ]
      },
      "vlpid": 0,
      "server_number": 1,
      "chat": {
        "enabled": 0,
        "auto_resize_flg": 0,
        "width": 400,
        "height": 600,
        "enter_msg": 0,
        "good_btn": 1,
        "trouble_btn": 1,
        "admin_display_name": "管理者",
        "block_type": 0,
        "block_words": [
          ""
        ]
      },
      "live_permalink": "https://apiXX-platform.stream.co.jp/apiservice/lplt3/XXXXXXXXXX",
      "thumb_feedout": "http://eqXXXXXXXX.eq.webcdn.stream.ne.jp/wwwXX/eqXXXXXXXX/jmc_pub/thumbnail/live/XXXX_X_X.jpg",
      "thumb_feedin": "http://eqXXXXXXXX.eq.webcdn.stream.ne.jp/wwwXX/eqXXXXXXXX/jmc_pub/thumbnail/live/XXXX_X_X.jpg",
      "thumb_liveopen": "http://eqXXXXXXXX.eq.webcdn.stream.ne.jp/wwwXX/eqXXXXXXXX/jmc_pub/thumbnail/live/XXXX_X_X.jpg"
    }
  ]
}

■レスポンス例：エラー時

{
"response_status":"1001"
}

■JavaScriptによるAPI呼び出しサンプル

※当サンプルは、弊社一部環境で動作確認をいたしましたが、全環境にて動作保障するものではございませんので、予めご了承ください。
　また、当サンプルを使ったお客様ページの構成等はサポート対象外となりますので、併せてご理解くださいますようお願いいたします。

HTMLサンプル

<html>

  <head>

    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

    <script type="text/Javascript" src="sample.js"></script>

    <script type="text/Javascript">

      function callApi() {

        const param = new Object();

        // callback
        const callback = document.getElementById('callback').value == "" ? null : document.getElementById('callback').value;

        // pageSize
        param.pageSize = document.getElementById('pageSize').value == "" ? null : document.getElementById('pageSize').value;

        // pageNumber
        param.pageNumber = document.getElementById('pageNumber').value == "" ? null : document.getElementById('pageNumber').value;

        // lpid
        const lpidString= document.getElementById('lpid').value == "" ? null : document.getElementById('lpid').value;
        let lpidArray= null;
        if (lpidString != null) {
          lpidArray = lpidString.split(",");
        }
        param.lpid = lpidArray;

        // liveName
        param.liveName = document.getElementById('liveName').value == "" ? null : document.getElementById('liveName').value;

        // status
        param.status = document.getElementById('status').value == "" ? null : document.getElementById('status').value;

        // p1
        param.eventName = document.getElementById('p1').value == "" ? null : document.getElementById('p1').value;

        // p2
        param.eventName = document.getElementById('p2').value == "" ? null : document.getElementById('p2').value;

        // p3
        param.eventName = document.getElementById('p3').value == "" ? null : document.getElementById('p3').value;

        const result= loadEqMeta(param,callback);

      }

      function searchResultEq(result){
        if (result.profiles[0].exlink[1] == null){
          document.getElementById("result").src = document.getElementById('apiUrl').getAttribute('src');
        }
      }

    </script>

  </head>

  <body>

    <table border="0">

      <p>---API引数---</p>

      <tr>
        <td width="100">callback:</td>
        <td width="200">
          <input id="callback" type="text" value="" />
        </td>
      </tr>

      <tr>
        <td width="100">pageSize:</td>
        <td width="200">
          <input id="pageSize" type="text" value="" />
        </td>
      </tr>

      <tr>
        <td width="100">pageNumber:</td>
        <td width="200">
          <input id="pageNumber" type="text" value="" />
        </td>
      </tr>

      <tr>
        <td width="100">lpid:</td>
        <td width="200">
          <input id="lpid" type="text" value=""/>
        </td>
      </tr>

      <tr>
        <td width="100">liveName:</td>
        <td width="200">
          <input id="liveName" type="text" value=""/>
        </td>
      </tr>

      <tr>
        <td>status:</td>
        <td>
          <select name="status" id="status" value="">
            <option value=""></option>
            <option value="stop">stop</option>
            <option value="prepare">prepare</option>
            <option value="open">open</option>
          </select>
        </td>
      </tr>

      <tr>
        <td width="100">p1:</td>
        <td width="200">
          <input id="p1" type="text" value=""/>
        </td>
      </tr>

      <tr>
        <td width="100">p2:</td>
        <td width="200">
          <input id="p2" type="text" value=""/>
        </td>
      </tr>

      <tr>
        <td width="100">p3:</td>
        <td width="200">
          <input id="p3" type="text" value=""/>
        </td>
      </tr>

    </table>

    <br>

    <form name="test">
      <input type="button" onClick="callApi()" value="getLiveProfile" />
    </form>

    <br>

    <p>---API取得値---</p>

    <iframe id="result" width="100%" height="50%" frameborder="0"></iframe>

  </body>

</html>

JSサンプル

※下記サンプルコードをご利用になる場合は、「const token = “”;」の「””」の中に、EQ管理画面の「契約会社情報」に表示されている「ReadAPIのToken」を追記してください。

　確認方法について詳細は、「ReadAPIを呼び出す方式」－「■Token情報確認方法について」をご参照ください。

/**
* jsonp loadEqMeta
* @param param getLiveProfile
* @param callbackname jsonp
*/

function loadEqMeta(param, callback) {

  // API reference
  const protocol = (window.location.protocol == 'https:' ? 'https://' : 'http://');
  const apiBase = protocol + "api01-platform.stream.co.jp";

  // token
  const token = "";

  // api name
  const apiPathByParam = "/apiservice/getLiveProfile/";

  // URL create
  let apiUrl = apiBase;
  apiUrl += apiPathByParam;
  apiUrl += "?token=" + token;

  // callback
  apiUrl += (callback == null) ? "" : "&callback=" + callback;

  // pageSize
  apiUrl += (param.pageSize == null) ? "" : "&pageSize=" + param.pageSize;

  // pageNumber
  apiUrl += (param.pageNumber == null) ? "" : "&pageNumber=" + param.pageNumber;

  // lpid
  apiUrl += (param.lpid == null) ? "" :"&lpid=" + param.lpid;

  // liveName
  apiUrl += (param.liveName == null) ? "" : "&liveName=" + param.liveName;

  // status
  apiUrl += (param.status == null) ? "" : "&status=" + param.status;

  // p1
  apiUrl += (param.p1 == null) ? "" : "&p1=" + p1;

  // p2
  apiUrl += (param.p2 == null) ? "" : "&p2=" + p2;

  // p3
  apiUrl += (param.p3 == null) ? "" : "&p3=" + p3;

  // add to header
  const objScript = document.createElement("script");
  objScript.src = apiUrl;
  objScript.id = "apiUrl";
  document.getElementsByTagName("head")[0].appendChild(objScript);

}

ReadAPIの仕様