player（共通要素）はこちらを参照してください。
目次
- GET : /player/list（プレイヤー一覧を取得）
- GET : /player/get_player（プレイヤーの詳細情報を取得）
- POST : /player/modify（プレイヤー情報を変更）
- POST : /player/delete（プレイヤーを削除）
- GET : /player/get_default_playerconfig（デフォルト状態のプレイヤー設定JSONを取得）
- GET : /player/get_components（コンポーネント情報を取得）
- POST : /player/create（プレイヤー名とプレイヤータイプを作成）
- POST : /player/modify_playerconfig（プレイヤー設定JSONを変更）
- GET : /player/list_template（テンプレート一覧を取得）
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 | サムネイルのファイル |
ステータス
有効