チャプター / アノテーション / 字幕 の共通要素はこちら参照してください。
目次
- GET : /contents/chapter_get（chapterconfigを取得）
- GET : /contents/chapter_begin（chapterconfigを読み込む）
- POST : /contents/chapter_set（chapterconfigを設定）
- POST : /contents/chapter_commit（chapterconfigを保存）
- POST : /contents/chapter_upload（動画と連携させるPDFファイルのアップロード）
- GET : /contents/annotation_load（動画・音声のannotationconfigを読み込む）
- POST : /contents/annotation_save（動画・音声のannotationconfigを保存）
- GET : /contents/subtitle_get_sub（サブ字幕の詳細を取得）
- GET : /contents/subtitle_begin（動画・音声のsubtitleconfigを読み込む）
- POST : /contents/subtitle_add_sub（新しくサブ字幕を登録）
- POST : /contents/subtitle_commit（動画・音声のsubtitleconfigを保存）
- POST : /contents/delete_subtitle（コンテンツに設定された字幕を削除する）
- GET : /contents/subtitle_preview_file（字幕ファイルをプレビュー）
- GET : /contents/subtitle_get_param_subtitle（param_subtitleを取得）
GET : /contents/chapter_get
概要
chapterconfigを取得。
カテゴリ
コンテンツ
入力
クエリー
| 名前 | 値 |
|---|---|
| ticket (required) | loginメソッドで取得できるチケット文字列 |
| id_contents (required) | コンテンツID |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| chapterconfig | チャプターコンフィグ |
| id_contents | コンテンツID |
| object | チャプター(複数) |
| title | チャプタータイトル |
| start | 開始位置 |
説明
contents/chapter_begin後～contents/chapter_commit前のみ有効。
利用にはチャプター機能を有効にする必要があります。
ステータス
有効
GET : /contents/chapter_begin
概要
chapterconfigを読み込む。
カテゴリ
コンテンツ
入力
クエリー
| 名前 | 値 |
|---|---|
| ticket (required) | loginメソッドで取得できるチケット文字列 |
| id_contents (required) | コンテンツID |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| chapterconfig | チャプターコンフィグ |
| chapterconfig | チャプターコンフィグ |
| id_contents | コンテンツID |
| object | チャプター(複数) |
| title | チャプタータイトル |
| start | 開始位置 |
説明
他のcontents/chapter_*系のAPIを使用する前に呼ぶ。呼ぶ度にサーバー上の一時保存内容をクリアする。利用にはチャプター機能を有効にする必要があります。
ステータス
有効
POST : /contents/chapter_set
概要
chapterconfigを設定。
カテゴリ
コンテンツ
入力
クエリー
| 名前 | 値 |
|---|---|
| ticket (required) | loginメソッドで取得できるチケット文字列 |
| id_contents (required) | コンテンツID |
| chapterconfig (required) | チャプターコンフィグ(JSON) |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| chapterconfig | チャプターコンフィグ |
| id_contents | コンテンツID |
| object | チャプター(複数) |
| title | チャプタータイトル |
| start | 開始位置 |
説明
contents/chapter_begin後～contents/chapter_commit前のみ有効。
利用にはチャプター機能を有効にする必要があります。
ステータス
有効
POST : /contents/chapter_commit
概要
chapterconfigを保存。
カテゴリ
コンテンツ
入力
クエリー
| 名前 | 値 |
|---|---|
| ticket (required) | loginメソッドで取得できるチケット文字列 |
| id_contents (required) | コンテンツID |
| chapterconfig (required) | チャプターコンフィグ(JSON) |
説明
contents/chapter_begin後のみ有効。
利用にはチャプター機能を有効にする必要があります。
ステータス
有効
POST : /contents/chapter_upload
概要
動画と連携させるPDFファイルのアップロード
カテゴリ
コンテンツ
入力
クエリー
| 名前 | 値 |
|---|---|
| ticket (required) | loginメソッドで取得できるチケット文字列 |
| id_contents (required) | コンテンツID |
| filekey (required) | PDFファイルのファイルキー |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| chapterconfig | チャプターコンフィグ |
| id_contents | コンテンツID |
| object | チャプター(複数) |
| title | チャプタータイトル |
| start | 開始位置 |
説明
contents/chapter_begin後～contents/chapter_commit前のみ有効。
利用にはチャプター機能を有効にする必要があります。
ステータス
有効
GET : /contents/annotation_load
概要
動画・音声のannotationconfigを読み込む。
カテゴリ
コンテンツ
入力
クエリー
| 名前 | 値 |
|---|---|
| ticket (required) | loginメソッドで取得できるチケット文字列 |
| id_contents (required) | コンテンツID |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| annotationconfig | アノテーション情報 |
| object | バナー情報(複数可) |
| id_contents | バナー画像のコンテンツID |
| url | バナー画像のURL |
| x | x座標(見た目の動画表示領域のwidthを1.0としたときの割合) |
| y | y座標(見た目の動画表示領域のheightを1.0としたときの割合) |
| start | 開始時間 |
| end | 終了時間 |
| linkurl | リンクURL |
ステータス
有効
POST : /contents/annotation_save
概要
動画・音声のannotationconfigを保存。
カテゴリ
コンテンツ
入力
クエリー
| 名前 | 値 |
|---|---|
| ticket (required) | loginメソッドで取得できるチケット文字列 |
| id_contents (required) | コンテンツID |
| annotationconfig (required) | アノテーション情報(JSON) |
ステータス
有効
GET : /contents/subtitle_get_sub
概要
サブ字幕の詳細を取得。
カテゴリ
コンテンツ
入力
クエリー
| 名前 | 値 |
|---|---|
| ticket (required) | loginメソッドで取得できるチケット文字列 |
| id_contents (required) | コンテンツID |
| id_subtitle_sub (required) | サブ字幕のID |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| sub | サブ字幕 |
| id_subtitle_sub | サブ字幕ID |
| name | 名前(言語名) |
| description | 説明文(トラック名) |
| date | 日付YYYY-MM-DD |
| enabled | 字幕の設定値 ・ 0 : 無効・ 1 : 有効 |
| object | (複数) |
| start | 開始時間 |
| end | 終了時間 |
| text | 表示するテキスト |
説明
contents/subtitle_begin後～contents/subtitle_commit前のみ有効。
ステータス
有効
GET : /contents/subtitle_begin
概要
動画・音声のsubtitleconfigを読み込む。
カテゴリ
コンテンツ
入力
クエリー
| 名前 | 値 |
|---|---|
| ticket (required) | loginメソッドで取得できるチケット文字列 |
| id_contents (required) | コンテンツID |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| subtitleconfig | 字幕情報 |
| sub | 字幕情報 |
| id_subtitle_sub | サブ字幕ID |
| name | 名前(言語名) |
| description | 説明(トラック名) |
| date | 日付YYYY-MM-DD HH:II:SS |
| enabled | 字幕の設定値 ・ 0 : 無効・ 1 : 有効 |
説明
他のcontents/subtitle_*系のAPIを使用する前に呼ぶ。呼ぶ度にサーバー上の一時保存内容をクリアする。
ステータス
有効
POST : /contents/subtitle_add_sub
概要
新しくサブ字幕を登録。
カテゴリ
コンテンツ
入力
クエリー
| 名前 | 値 |
|---|---|
| ticket (required) | loginメソッドで取得できるチケット文字列 |
| id_contents (required) | コンテンツID |
| filekey (required) | 字幕ファイルのファイルキー |
| name (required) | サブ字幕の名前(言語名) |
| description | 説明文(トラック名)(省略可) |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| subtitleconfig | 字幕情報 |
| subtitleconfig | 字幕情報 |
| sub | 字幕情報 |
| id_subtitle_sub | サブ字幕ID |
| name | 名前(言語名) |
| description | 説明(トラック名) |
| date | 日付YYYY-MM-DD |
| enabled | 字幕の設定値 ・ 0 : 無効・ 1 : 有効 |
説明
contents/subtitle_begin後～contents/subtitle_commit前のみ有効。
ステータス
有効
POST : /contents/subtitle_commit
概要
動画・音声のsubtitleconfigを保存。
カテゴリ
コンテンツ
入力
クエリー
| 名前 | 値 |
|---|---|
| ticket (required) | loginメソッドで取得できるチケット文字列 |
| id_contents (required) | コンテンツID |
| subtitleconfig (required) | 字幕情報(JSON) |
説明
contents/subtitle_begin後のみ有効。
ステータス
有効
POST : /contents/delete_subtitle
概要
コンテンツに設定された字幕を削除する。
カテゴリ
コンテンツ
入力
クエリー
| 名前 | 値 |
|---|---|
| ticket (required) | loginメソッドで取得できるチケット文字列 |
| id_contents (required) | コンテンツID |
| autocommit | 自動公開処理 ・ 0 : 無効・ 1 : 有効 |
ステータス
有効
GET : /contents/subtitle_preview_file
概要
字幕ファイルをプレビュー。
カテゴリ
コンテンツ
入力
クエリー
| 名前 | 値 |
|---|---|
| ticket (required) | loginメソッドで取得できるチケット文字列 |
| filekey (required) | 字幕ファイルのファイルキー |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| object(複数) | 字幕ファイル |
| start | 開始時間 |
| end | 終了時間 |
| text | 表示するテキスト |
説明
contents/subtitle_begin後～contents/subtitle_commit前のみ有効。
ステータス
有効
GET : /contents/subtitle_get_param_subtitle
概要
param_subtitleを取得。
カテゴリ
コンテンツ
入力
クエリー
| 名前 | 値 |
|---|---|
| ticket (required) | loginメソッドで取得できるチケット文字列 |
| id_contents (required) | コンテンツID |
出力
レスポンス内容
| 名前(要素名) | 値(要素の内容) |
|---|---|
| param_subtitle | サブ字幕のパラメータ |
| sub | サブ字幕 |
| id_subtitle_sub | サブ字幕ID |
| name | 名前(言語名) |
| description | 説明文(トラック名) |
| date | 日付YYYY-MM-DD |
| enabled | 字幕の設定値 ・ 0 : 無効・ 1 : 有効 |
| object | (複数) |
| start | 開始時間 |
| end | 終了時間 |
| text | 表示するテキスト |
| vtt | vttファイルのプレビューファイル |
説明
contents/subtitle_begin後～contents/subtitle_commit前のみ有効。
ステータス
有効