player共通

プレイヤータイプ

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

プレイヤー設定JSON – playerconfig

要素の内容
basic 基本設定
player_type プレイヤー種別
normal : 標準プレイヤー
chromeless : クロムレスプレイヤー
player_controlpanel コントロールパネル
0 : 無効
1 : 有効
player_controlpanel_initial_view プレイヤー種別
0 : 無効
1 : 有効
player_responsive レスポンシブ対応
0 : 無効
1 : 有効
player_responsive_aspect_ratio  レスポンシブ比率
4:3 : 4:3
16:9 : 16:9
autoplay 自動再生
0 : 無効
1 : 有効
show_title 再生前の表示内容(タイトル)
0 : 無効
1 : 有効
show_description 再生前の表示内容(説明文)
0 : 無効
1 : 有効
sequential 連続再生(説明文)
0 : 無効
1 : 有効
2 : リピート再生
repeat リピート再生
0 : 無効
1 : 有効
fullscreen フルスクリーン
0 : 無効
1 : 有効
volume 音量(初期値)
0~100 : 0~100
show_settingsbutton プレイヤー設定ボタン
0 : 無効
1 : 有効
use_customhtml5player 現在使用できません
use_customplayer 音声プレイヤーのカスタム設定
0 : 無効
1 : 有効
hide_subtitle 字幕(初期表示)
0 : 無効
1 : 有効
show_card  テロップ
0 : 無効
1 : 有効
slideshow スライドショー
0 : 無効
1 : 有効
play_mark 再生/一時停止マークの表示
0 : 無効
1 : 有効
replay_mark リプレイマークの表示
0 : 無効
1 : 有効
enable_playbackrate 倍速再生
0 : 無効
1 : 有効
seekable シーク
0 : 無効
1 : 有効
skippable スキップ機能
0 : 無効
1 : 有効
skipTime スキップ時間の設定(任意の秒数)
player_auto_fullscreen 自動フルスクリーン
0 : 無効
1 : 有効
player_auto_fullscreen_device 自動フルスクリーンの対象デバイス
allDevice : 全てのデバイス
PC : PCのみ
Smartphone : スマホのみ
playsinline 特定OSでのインライン再生可否
0 : 無効
1 : 有効
volume_mute 初期状態からミュート
0 : 無効
1 : 有効
preload 再生前に読み込みを開始する
0 : 無効
1 : 有効
exit_popup_player 再生終了時にプレイヤーを閉じる
0 : 無効
1 : 有効
player_related_movies_display 関連動画表示
0 : 無効
1 : 有効
watermark 現在使用できません
enabled 現在使用できません
id_contents 現在使用できません
position 現在使用できません
alpha 現在使用できません
social 現在使用できません
enabled 現在使用できません
mail_enabled 現在使用できません
mail_header 現在使用できません
mail_footer 現在使用できません
link_enabled 現在使用できません
embed_enabled 現在使用できません
embed_id_tag 現在使用できません
twitter_enabled 現在使用できません
twitter_text 現在使用できません
facebook_enabled 現在使用できません
mixi_enabled 現在使用できません
mixi_mixikey 現在使用できません
thumbnail ライブ用サムネイル設定
listen/established/closed ライブ状態
listen : 配信前
established : 一時停止中
closed : 配信終了後
type サムネイルタイプ
message : message
image : 画像
disabled : 無効
message 設定されているメッセージが表示
image 設定されている画像のid_contents
layout レイアウト
width プレイヤー全体のwidth
height プレイヤー全体のheight
components コンポーネント設定
component 個々のコンポーネント(リスト)
  componentid コンポーネントID
  x 座標x
  y 座標y
  width 座標width
  height 座標height
  color コンポーネントテーマカラー
  require_playlist プレイリスト設定
0 : プレイリスト必要なし
1 : 1階層のプレイリストが必要
2 : 2階層のプレイリストが必要
  removable コンポーネントを削除できるか
0 : できない
1 : できる
  componentinstanceid コンポーネントインスタンスID
※playerconfig作成/編集時は、適切にユニークなcomponentinstanceidを振る。

 

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

要素の内容
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

 

GET : /player/list

概要

プレイヤー一覧を取得。

カテゴリ

プレイヤー

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。

出力

レスポンス内容

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

ステータス

有効

 

GET : /player/get_player

概要

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

カテゴリ

プレイヤー

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
id_player (required) プレイヤーID

出力

レスポンス内容

名前(要素名) 値(要素の内容)
name プレイヤー名
playerconfig プレイヤー設定JSON
playerconfig参照
templateid テンプレートID
テンプレートID参照
type プレイヤータイプ
common : 標準プレイヤー
subtype プレイヤーサブタイプ
video : 動画
pdf : PDF
design プレイヤーデザイン
video : 動画プレイヤー
audio : 音声プレイヤー
※subtypeがpdfでない場合のみ

ステータス

有効

 

POST : /player/modify

概要

プレイヤー情報を変更。

カテゴリ

プレイヤー

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
id_contents (required) 移動させるコンテンツのID
name (required) 変更するプレイヤー名

ステータス

有効

 

POST : /player/delete

概要

プレイヤーを削除。

カテゴリ

プレイヤー

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
id_contents (required) 移動させるコンテンツのID

ステータス

有効

 

GET : /player/get_default_playerconfig

概要

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

カテゴリ

プレイヤー

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
templateid (required) テンプレートID

出力

レスポンス内容

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

ステータス

有効

 

GET : /player/get_components

概要

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

カテゴリ

プレイヤー

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
templateid (required) テンプレートID

出力

レスポンス内容

名前(要素名) 値(要素の内容)
component コンポーネント(リスト)
componentinstanceid コンポーネントインスタンスID
※playerconfig作成/編集時は、適切にユニークなcomponentinstanceidを振る。
componentid コンポーネントの種類
info
small_info
chapter
pdfslide
x 座標x
y 座標y
width 座標width
height 座標height
color コンポーネントテーマカラー
require_playlist プレイリスト設定
0 : プレイリスト必要なし
1 : 1階層のプレイリストが必要
2 : 2階層のプレイリストが必要
removable コンポーネントを削除できるか
0 : できない
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}

ステータス

有効

 

POST : /player/create

概要

プレイヤー名とプレイヤータイプを作成

カテゴリ

プレイヤー

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
name (required) プレイヤー名
type (required) プレイヤータイプ

出力

レスポンス内容

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

注意

/player/create後、/player/modify_playerconfigでプレイヤー情報を設定してください

ステータス

有効

 

POST : /player/modify_playerconfig

概要

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

カテゴリ

プレイヤー

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
id_player (required) プレイヤーID
playerconfig (required) プレイヤー設定(JSON)
playerconfig参照

ステータス

有効

 

GET : /player/list_template

概要

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

カテゴリ

プレイヤー

入力

クエリー

名前
ticket (required) loginメソッドで取得できるチケット文字列。
type (required) プレイヤータイプ

出力

レスポンス内容

名前(要素名) 値(要素の内容)
template テンプレート(リスト)
templateid テンプレートID
image サムネイルのファイル

ステータス

有効

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