共通の出力要素

playbackrateconfig形式

名前(要素名) 値(要素の内容)
rate 倍速の設定値(JSON形式)

 

settings/get_external_block

概要

国外アクセス設定を取得。

カテゴリ

設定

出力

名前(要素名)
type 0:なし
1:全ての埋め込みコードに対して禁止
2:個別の埋め込みコードに対して禁止
denytags 埋め込み禁止コード
  tag 個別の埋め込み禁止コード(※リスト)
    id_tag 埋め込みコードID
    name 埋め込みコード名
    blocked 1:禁止 0:許可

ステータス

有効

 

settings/set_external_block

概要

国外アクセスの設定。

カテゴリ

設定

入力

名前
type 0:なし
1:全ての埋め込みコードに対して禁止 2:個別の埋め込みコードに対して禁止
denytags type=2の場合の、禁止する埋め込みコードのIDをカンマ区切りで指定

ステータス

有効

 

settings/list_domain_block

概要

ドメイン指定の一覧を取得。

カテゴリ

設定

入力

名前
mode “exists”登録済みの埋め込みコード一覧。
”noexists”登録されてない埋め込みコード一覧。

出力

名前(要素名)
tag 埋め込みコード(※リスト)
  id_tag 埋め込みコードID(0で「全ての埋め込みコード」)
  name 埋め込みコード名
  domain 指定されたドメイン(カンマ区切りのドメイン)

ステータス

有効

 

settings/set_domain_block

概要

ドメイン指定を追加/編集

カテゴリ

設定

入力

名前
id_tag 埋め込みコードID
domain カンマ区切りのドメイン

説明

指定されたid_tagが登録されていなかったら追加、されていたら編集。

ステータス

有効

 

settings/delete_domain_block

概要

ドメイン指定を削除。

カテゴリ

設定

入力

名前
id_tag 埋め込みコードID

ステータス

有効

 

settings/list_allowed_ip

概要

IPアドレス指定の一覧を取得。

カテゴリ

設定

入力

名前
mode “exists”登録済みの埋め込みコード一覧。
”noexists”登録されてない埋め込みコード一覧。

出力

名前(要素名)
tag 埋め込みコード(※リスト)
  id_tag 埋め込みコードID(0で「全ての埋め込みコード」)
  name 埋め込みコード名
  ip 指定されたIPアドレス(カンマ区切りのIPアドレス)

ステータス

有効

 

settings/set_allowed_ip

概要

IPアドレス指定を追加/編集。

カテゴリ

設定

入力

名前
id_tag 埋め込みコードID
ip カンマ区切りのIPアドレス

説明

指定されたid_tagが登録されていなかったら追加、されていたら編集。
指定できるIPアドレスの形式はIPv4(xxx.xxx.xxx.xxx)。

ステータス

有効

 

settings/delete_allowed_ip

概要

IPアドレス指定を削除。

カテゴリ

設定

入力

名前
id_tag 埋め込みコードID

ステータス

有効

 

settings/list_metatag

概要

メタタグの一覧を取得。

カテゴリ

設定

出力

名前(要素名)
metatag メタタグ名(※リスト)

ステータス

有効

 

settings/add_metatag

概要

メタタグを追加。

カテゴリ

設定

入力

名前
metatag 追加するメタタグ名

ステータス

有効

 

settings/delete_metatag

概要

メタタグの削除。

カテゴリ

設定

入力

名前
metatag 削除するメタタグ名

ステータス

有効

 

settings/get_youtube

概要

YouTubeの情報を取得。

カテゴリ

設定

出力

名前(要素名)
authorized 1:有効 0:無効
account YouTubeアカウント(リスト)
  userid ユーザーID
  email メールアドレス

ステータス

有効

 

settings/get_youtube_auth_url

概要

YouTube連携用Googleアカウント認証URLを取得。

カテゴリ

設定

入力

名前
redirect_uri 認証後にリダイレクトされるURI

出力

名前(要素名)
url Googleアカウント認証URL

ステータス

有効

 

settings/deauthorize_youtube_api

概要

Youtube連携用Googleアカウントの認証を解除

カテゴリ

設定

ステータス

有効

 

settings/get_mail

概要

メール情報を取得。

カテゴリ

設定

出力

名前(要素名)
enable_mail 1:メール有効 0:無効
mail_address メールアドレス
mail_encode 1:変換完了時通知 0:しない
mail_error 1:エラー時通知 0:しない

ステータス

有効

 

settings/set_mail

概要

メール情報を設定。

カテゴリ

設定

入力

名前
enable_mail 1:メール有効 0:無効(省略可)
mail_address メールアドレス(省略可)
mail_encode 1:変換完了時通知 0:しない(省略可)
mail_error 1:エラー時通知 0:しない(省略可)

ステータス

有効

 

settings/change_password

概要

パスワードを変更。

カテゴリ

設定

入力

名前
password_current パスワード変更(現在のパスワード)
password_new パスワード変更(新しいパスワード)

ステータス

有効

 

settings/list_recipe

概要

レシピ一覧を取得。

カテゴリ

設定

入力

名前
type video=動画、audio=音声

出力

名前(要素名)
recipe (※リスト)
  id_host ホストのID
  id_recipe エンコード設定のID
  name レシピ名
  default デフォルトとして設定されている場合は1。それ以外は0。
  config (※リスト)
      format  フォーマット
      codec  映像コーデック
      bitrate  映像ビットレート
      pixel  解像度
      width  幅
      hight  高さ
      fps  フレームレート
      audiocodec  音声コーデック
      audiobitrate  音声ビットレート

ステータス

有効

 

settings/set_default_recipe

概要

デフォルトのレシピを設定。

カテゴリ

設定

入力

名前
type video=動画、audio=音声
id_recipe エンコード設定のID
settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。
動画登録には動画用の、音声登録には音声用のレシピを設定頂く必要があります。

ステータス

有効

 

settings/get_plconfig

概要

PC再生時の初期画質設定を取得。

カテゴリ

設定

出力

名前(要素名)
plconfig PLCONFIG
 id_recipe エンコード設定のID
settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。
 default 初期選択される画質です
0が最低画質で最高画質のindexはレシピによって変わります

ステータス

有効

 

settings/set_plconfig

概要

PC再生時の初期画質設定を設定。

カテゴリ

設定

入力

名前
plconfig PLCONFIG
 id_recipe エンコード設定のID
settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。
 default 初期選択される画質です
0が最低画質で最高画質のindexはレシピによって変わります

ステータス

有効

 

settings/add_recipe

概要

トランスコード設定にレシピを追加。

カテゴリ

設定

入力

名前
config レシピ設定でjson形式による指定が必須。
内容はsettings/get_recipe_template_configを参考にしてください。
name レシピ名で必須。
subtype videoもしくはaudio。デフォルトはvideo。

エラー

  • config の形式が不正な場合

ステータス

有効

 

settings/delete_recipe

概要

トランスコード設定からレシピを削除。
ただし一度でも使用したレシピは削除できません。

カテゴリ

設定

入力

名前
id_recipe レシピIDで必須。エンコード設定のID。
settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。

エラー

  • id_recipe が存在しない場合
  • id_recipe がデフォルト設定されている場合
  • id_recipe が既に利用されている場合

ステータス

有効

 

settings/modify_recipe

概要

トランスコード設定からレシピを編集。
ただし一度でも使用したレシピは編集できません。

カテゴリ

設定

入力

名前
id_recipe レシピIDで必須。エンコード設定のID。
settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。
config レシピ設定。
name レシピ名。

エラー

  • id_recipe が存在しない場合
  • id_recipe が既に利用されている場合
  • config の形式が不正な場合

ステータス

有効

 

settings/get_recipe_template_config

概要

レシピのテンプレートを取得。

カテゴリ

設定

入力

名前
subtype videoもしくはaudio。デフォルトはvideo。

出力

名前(要素名)
config レシピ設定でjson形式。 {“config”:{“format”:….}, “status”:true}

ステータス

有効

 

settings/get_transferconfig

概要

配信設定情報を取得。

カテゴリ

設定

出力

名前(要素名)
transferconfig 配信設定情報
  secure 1:暗号化 0:なし
  onetime 1:ワンタイム 0:なし
  rtmp 1:RTMP(Flash) 0:なし
  hls 1:HTTP Live Streaming 0:なし
  http 1:HTTP Progressive 0:なし

説明

現状、hds(HTTP dynamic Streaming)の項目はありません。
また、デバイス環境(PC/iOS/Android)の区別はありません。

ステータス

有効

 

settings/get_deliverymatrix

概要

詳細な配信設定情報を取得

カテゴリ

設定

出力

名前
matrix 配信設定情報
  http プログレッシブダウンロード
    pc それぞれ 1:有効 0:無効 -:端末が未対応
    android2 Android2系
    android4 Android4系
    ios iOS系
    secure セキュア機能
  rtmp RTMP
    pc それぞれ 1:有効 0:無効 -:端末が未対応
    android2 Android2系
    android4 Android4系
    ios iOS系
    secure セキュア機能
  hls HLS
    pc それぞれ 1:有効 0:無効 -:端末が未対応
    android2 Android2系
    android4 Android4系
    ios iOS系
    secure セキュア機能
onetime 1:ワンタイム 0:なし

ステータス

有効

 

settings/get_playbackrateconfig

概要

倍速の設定値を取得。

カテゴリ

設定

出力

名前
playbackrateconfig 倍速の設定でjson形式。

ステータス

有効

 

settings/set_playbackrateconfig

概要

倍速の設定値を追加。

カテゴリ

設定

入力

名前
playbackrateconfig 倍速の設定でjson形式による指定が必須。

ステータス

有効

 

settings/create_unique_accesskey

概要

accesskeyを発行。

カテゴリ

設定

入力

名前
id_user 対象ユーザーID ※1

出力

名前(要素名)
accesskey アクセスキー

備考

※1 対象となるユーザーを指定しない場合はticketのユーザーに対して作成されます。
対象となるユーザーを指定するにはticketのユーザーが管理者(typeがadmin)である必要があります。
管理者ユーザーを利用して一般ユーザーのaccesskeyを発行できます。

accesskeyを発行した際には最新のaccesskeyのみ有効となります。
accesskeyの発行に必要なsecretkeyは事前に発行された署名用秘密キーで、契約書類のみに記載されております。

ステータス

有効

この記事は役に立ちましたか?
1人中0人がこの記事が役に立ったと言っています