player(プレイヤー)

player共通

プレイヤータイプ

値	要素の内容
common	標準プレイヤー

プレイヤー設定JSON – playerconfig

値	要素の内容
layout	★レイアウト
width	プレイヤー全体のwidth
height	プレイヤー全体のheight
basic	★基本設定
autoplay	自動再生： 1:有効 0:無効
player_type	プレイヤー種別：normal:標準プレイヤー chromeless:クロムレスプレイヤー
player_controlpanel	コントロールパネル：1:有効 0:無効
player_controlpanel_initial_view	初期表示の有無：1:有効 0:無効
player_responsive	レスポンシブ：1:有効 0:無効
player_responsive_aspect_ratio	レスポンシブ比率：4:3 16:9
show_title	再生前の表示内容（タイトル）： 1:有効 0:無効
fullscreen	フルスクリーン： 1:有効 0:無効
player_auto_fullscreen	自動フルスクリーン： 1:有効 0:無効
player_auto_fullscreen_device	自動フルスクリーンの対象デバイス： allDevice:全てのデバイス PC:PCのみ Smartphone:スマホのみ
playsinline	特定OSでのインライン再生可否： 1:有効 0:無効
show_settingsbutton	プレイヤー設定ボタン：1:有効 0:無効
volume	音量（初期値）： 0～100
volume_mute	初期状態からミュート：1:有効 0:無効
play_mark	再生／一時停止マークの表示： 1:有効 0:無効
replay_mark	リプレイマークの表示： 1:有効 0:無効
seekable	シーク： 1:有効 0:無効
preload	再生前に読み込みを開始する： 1:有効 0:無効
sequential	連続再生：　1:有効 0:無効 2:リピート再生
repeat	リピート再生： 1:有効 0:無効
slideshow	スライドショー： 1:有効 0:無効
hide_subtitle	字幕（初期表示）： 1:有効 0:無効
show_card	テロップ： 1:有効 0:無効
exit_popup_player	再生終了時にプレイヤーを閉じる： 1:有効 0:無効
player_related_movies_display	関連動画表示： 1:有効 0:無効
enable_playbackrate	倍速再生： 1:有効 0:無効
social	★ソーシャル設定
enabled	1:有効 0:無効
mail_enabled	メール機能： 1:有効 0:無効
mail_header	メールヘッダ
mail_footer	メールフッタ
link_enabled	リンク機能： 1:有効 0:無効
embed_enabled	貼り付け機能： 1:有効 0:無効
embed_id_tag	埋め込みタグID
twitter_enabled	twitter： 1:有効 0:無効
twitter_text	twitterのテキスト
facebook_enabled	Facebook： 1:有効 0:無効
mixi_enabled	mixi： 1:有効 0:無効
mixi_mixikey	mixiのmixikey
components	★コンポーネント設定
component	個々のコンポーネント（あるだけ複数）
componentid	コンポーネントID
componentinstanceid	コンポーネントインスタンスID ※playerconfig作成/編集時は、適切にユニークなcomponentinstanceidを振る。
require_playlist	0 => プレイリスト必要なし。1 => 1階層のプレイリストが必要。2 => 2階層のプレイリストが必要。
x	座標x
y	座標y
width	座標width
height	座標height
color	コンポーネントテーマカラー

コンポーネントテーマカラー

値	要素の内容
COLOR01	ブラック
COLOR02	グレー
COLOR03	ライトグレー
COLOR04	ピンク
COLOR05	ブルー
COLOR06	イエロー
COLOR07	グリーン
COLOR08	レッド
COLOR09	オレンジ
COLOR10	パープル

テンプレートID

値	要素の内容
COMMON01	動画プレイヤーその1
COMMON02	動画プレイヤーその2
COMMON03	動画プレイヤーその3
COMMON04	動画プレイヤーその4
COMMON05	動画プレイヤーその5
COMMON06	動画プレイヤーその6
COMMON07	動画プレイヤーその7
COMMON08	動画プレイヤーその8
COMMON09	音声プレイヤー
COMMON10	PDFプレイヤー
COMMON11	動画+PDFプレイヤー
COMMON12	動画プレイヤーその9

player/list

概要

プレイヤー一覧を取得。

カテゴリ

プレイヤー

出力

レスポンス内容

名前(要素名)	値(要素の内容)
player	プレイヤー（※リスト）
id_player	プレイヤーID
name	プレイヤー名
type	プレイヤータイプ

ステータス

有効

player/get_player

概要

プレイヤーの詳細情報を取得。

カテゴリ

プレイヤー

入力

クエリー

名前	値
id_player	プレイヤーID

出力

レスポンス内容

名前(要素名)	値(要素の内容)
name	プレイヤー名
playerconfig	プレイヤー設定JSON
type	プレイヤータイプ
subtype	プレイヤーサブタイプ。video、またはpdf
design	プレイヤーデザイン。video、またはaudio ※subtypeがpdfでない場合のみ

ステータス

有効

player/modify

概要

プレイヤー情報を変更。

カテゴリ

プレイヤー

入力

クエリー

名前	値
id_player	プレイヤーID
name	変更するプレイヤー名

ステータス

有効

player/delete

概要

プレイヤーを削除。

カテゴリ

プレイヤー

入力

クエリー

名前	値
id_player	プレイヤーID

ステータス

有効

player/get_default_playerconfig

概要

デフォルト状態のプレイヤー設定JSONを取得。

カテゴリ

プレイヤー

入力

クエリー

名前	値
templateid	テンプレートID

出力

レスポンス内容

名前(要素名)	値(要素の内容)
playerconfig	プレイヤー設定JSON

ステータス

有効

player/get_components

概要

コンポーネント情報を取得。

カテゴリ

プレイヤー

入力

クエリー

名前	値
templateid	テンプレートID

出力

レスポンス内容

名前(要素名)	値(要素の内容)
component	コンポーネント ※1

※1 templateidによって変化します。

■COMMON03、COMMON05

{“componentid”:”info”,”x”:”0″,”y”:”0″,”width”:”270″,”height”:”360″,”color”:”COLOR01″,”require_playlist”:0,”removable”:1}

■COMMON02、COMMON04、COMMON06、COMMON07

{“componentid”:”info”,”x”:”0″,”y”:”0″,”width”:”640″,”height”:”120″,”color”:”COLOR01″,”require_playlist”:0,”removable”:1}

■COMMON08

{“componentid”:”small_info”,”x”:”0″,”y”:”0″,”width”:”272″,”height”:”90″,”color”:”COLOR01″,”require_playlist”:0,”removable”:1}

ステータス

有効

player/create

概要

プレイヤーを作成。

カテゴリ

プレイヤー

入力

クエリー

名前	値
name	プレイヤー名
type	プレイヤータイプ

出力

レスポンス内容

名前(要素名)	値(要素の内容)
id_player	作成したプレイヤーのプレイヤーID

ステータス

有効

player/modify_playerconfig

概要

プレイヤー設定JSONを変更。

カテゴリ

プレイヤー

入力

クエリー

名前	値
id_player	プレイヤーID
playerconfig	プレイヤー設定JSON

ステータス

有効

player/list_template

概要

テンプレート一覧を取得。

カテゴリ

プレイヤー

入力

クエリー

名前	値
type	プレイヤータイプ

出力

レスポンス内容

名前(要素名)	値(要素の内容)
template	※あるだけ複数
templateid	テンプレートID
image	サムネイルのURL

ステータス

有効