contents(コンテンツ1:フォルダ、一覧画面の操作)

共通の出力要素

 

コンテンツ要素(contents)

名前(要素名) 値(要素の内容)
id_contents コンテンツID
category folder、broadcast、video、image、pdf
(2015.11.16追加)
type folder=フォルダ、video=動画、audio=音声、image=画像、pdf=PDF
name コンテンツ名
description コンテンツ説明文
folder_name フォルダ名
parent_id_contents 親フォルダのコンテンツID
create_date 投稿日時
image イメージ画像(videoの場合サムネイル画像、audioの場合カバー画像、imageの場合画像本体、pdfの場合1枚目の画像)
contents_visible コンテンツに設定された公開設定において表示可能かどうか
id_recipe エンコード設定のID
settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。
画像などの変換設定が存在しないコンテンツの場合NULLが返ります。
process_status コンテンツ登録ステータス
video_common_process_status PC⁄スマホ動画・音声登録ステータス (type=video,audioのみ) ※未作成時は空
video_keitai_process_status keitai動画・音声登録ステータス (type=video,audioのみ) ※未作成時は空
video_youtube_process_status youtube動画・音声登録ステータス (type=video,audioのみ) ※未作成時は空
gid コンテンツユニークID
usermeta USERMETA ※未指定時は空文字

USERMETA形式

名前(要素名) 値(要素の内容)
usermeta キー及び値が文字列型である1次元連想配列データ(JSON形式)

DATE,DATE形式

名前(要素名) 値(要素の内容)
visible YYYY-MM-DD もしくは YYYY-MM-DD HH:II:SS
どちらかを省略可能。
例)
2011/12/15,2011/12/15 16:00:00 => 12/15の0時から16時まで公開。
,2011/12/15 => 12/15まで公開。
2011/12/15, => 12/15から公開。

PROCESS_STATUS形式

名前(要素名) 値(要素の内容)
PROCESS_STATUS idle,processing=変換中 done=変換完了 failure=変換失敗 (空)=未作成

ケータイ動画・音声のencoding_quality

要素の内容
1 最高
2
3
4
5 最低

annotationconfig

要素の内容
annotationconfig アノテーション情報
 object バナー情報(複数可)
  id_contents バナー画像のコンテンツID
  url バナー画像のURL
  x x座標(見た目の動画表示領域のwidthを1.0としたときの割合)
  y y座標(見た目の動画表示領域のheightを1.0としたときの割合)
  start 開始時間
  end 終了時間
  linkurl リンクURL

subtitleconfig

要素の内容
subtitleconfig 字幕情報
 sub サブ字幕(複数)
  id_subtitle_sub サブ字幕ID
  name 名前(言語名)
  description 説明(トラック名)
  date 日付
  enabled 有効:1、無効:0

chapterconfig

要素の内容
chapterconfig チャプター情報
  id_contents PDFのコンテンツID
  urls PDFのURL情報
  object チャプター(複数)
    start 開始位置
    title チャプタータイトル

encodeconfig

要素の内容
encodeconfig エンコード設定
 option オプション
  secure 暗号化の有無 1:暗号化、0:なし
  onetime ワンタイムの有無 1:ワンタイム、0:なし
  rtmp RTMPでの動画 1:RTMP(Flash)、0:なし
  hls HLSでの動画 1:HTTP Live Streaming、0:なし
  http HTTP Progressiveでの動画 1:HTTP Progressive、0:なし
 video 映像設定
  format フォーマット
  codec 映像コーデック
  bitrate 映像ビットレート
  pixel 解像度
  width
  height 高さ
  fps フレームレート
  audiocodec 音声コーデック
  audiobitrate 音声ビットレート

元動画・元音声・元画像のexif情報

要素の内容
gps_latitude 緯度
gps_longitude 経度
gps_altitude 高度
create_date, date_time, content_create_date 作成日時※前方一致になります

 

contents/get_all_items

概要

全ての動画・音声・画像・PDFを取得。

カテゴリ

コンテンツ

入力

※limit,filters,order対応

出力

コンテンツ要素のリスト。(type=folderは含まない)

ステータス

有効

 

contents/get_folder_layout

概要

全てのフォルダをツリー構造化したデータを取得。

カテゴリ

コンテンツ

出力

レスポンス内容

名前(要素名) 値(要素の内容)
folder フォルダ(※ツリー)
 id_contents フォルダのコンテンツID
 name フォルダ名
 folder* サブフォルダのリスト

ステータス

有効

 

contents/create_folder

概要

フォルダを作成。

カテゴリ

コンテンツ

入力

クエリー

名前
id_contents 親フォルダのコンテンツID
name フォルダ名

出力

レスポンス内容

名前(要素名) 値(要素の内容)
id_contents 作成したフォルダのコンテンツID

ステータス

有効

 

contents/get_folder_contents

概要

フォルダに含まれる、全てのコンテンツの情報を取得。

カテゴリ

コンテンツ

入力

※limit,filters,order対応

クエリー

名前
id_contents フォルダのコンテンツID

出力

コンテンツ要素のリスト。

ステータス

有効

 

contents/move_contents

概要

コンテンツを別のフォルダへ移動。

カテゴリ

コンテンツ

入力

クエリー

名前
id_contents 移動させるコンテンツのID
parent_id_contents 移動先のフォルダのコンテンツID

ステータス

有効

 

contents/delete_contents

概要

コンテンツを削除。

カテゴリ

コンテンツ

入力

クエリー

名前
id_contents 削除するコンテンツのID
autocommit 1を指定した場合、削除後に自動公開処理を行う

説明

対象がフォルダの場合は、フォルダの中身が空でないと削除に失敗する。

ステータス

有効

 

contents/search_contents

概要

アイテムを検索。

カテゴリ

コンテンツ

入力

※limit,filters,order対応

クエリー

名前
freeword 検索する文字列
(freeword、usermetaいずれか、または両方を指定)
type folder=フォルダ、video=動画、audio=音声、image=画像、pdf=PDF
usermeta USERMETA
(freeword、usermetaいずれか、または両方を指定)

出力

コンテンツ要素のリスト。

ステータス

有効

 

contents/create_video

概要

動画・音声を登録。

カテゴリ

コンテンツ

入力

クエリー

名前
filekey 登録する動画・音声のファイルキー
name コンテンツ名
type video=動画、audio=音声。省略時は”video”。
音声ファイルを登録する場合はtype=audioを指定する必要がある。
disuse_thumbnail typeがaudioの場合のみ有効。1: サムネイル無し / 0: サムネイル有り変換(黒画像) (省略可)
parent_id_contents 親フォルダのコンテンツID
description 説明(省略可)
metatag タグ(省略可)
visible 1=常に表示。0=常に非表示。DATE,DATE=期間公開。(省略可)
meta_url メタURL(省略可)
update_date 更新日(省略可)※未使用
common_create 配信用動画・音声を作成。1で固定。
common_id_recipe エンコード設定のID
settings/list_recipeもしくは管理画面「トランスコード設定」の一覧よりご確認ください。
common_pc_nt 1を指定した場合、PC向け配信用動画として元動画をそのまま利用します(元動画がmp4/flv/f4vファイルのときのみ)
※ ただしflv,f4vはhtml5プレイヤーに対応しておりません。
common_sp_nt 1を指定した場合、SP向け配信用動画として元動画をそのまま利用します(元動画がmp4ファイルのときのみ)
keitai_create 1:ケータイ動画・音声を作成、0:作成しない(省略可:デフォルト:0)
keitai_keitaimeta_name 名前(keitai_create=0なら省略可)
keitai_keitaimeta_description 説明文(省略可)
keitai_keitaimeta_author 作成者(省略可)
keitai_keitaimeta_copyright コピーライト(省略可)
keitai_encoding_quality 品質(ケータイ)(keitai_create=0なら省略可)
keitai_thumbnailattime サムネイル画像とする時間を正の整数で秒指定が可能(省略可:デフォルト値3)
youtube_create 1:YouTube動画・音声を作成、0:作成しない(省略可:デフォルト:0)
youtube_youtubemeta_name 名前(youtube_create=0なら省略可)
youtube_youtubemeta_description 説明文(youtube_create=0なら省略可)
youtube_youtube_privacy_status YouTube公開ステータス
public=公開、unlisted=限定公開、private=非公開
autocommit 1を指定した場合、変換完了後に自動公開処理を行う
usermeta USERMETA(省略可)

出力

レスポンス内容

名前(要素名) 値(要素の内容)
id_contents コンテンツID

ステータス

有効

 

contents/create_image

概要

画像を登録。

カテゴリ

コンテンツ

入力

クエリー

名前
filekey 登録する画像のファイルキー
parent_id_contents 親フォルダのコンテンツID
name コンテンツ名
description 内容(省略可)
metatag タグ(省略可)
meta_url meta_url(省略可)
visible 1=常に表示、0=常に非表示、DATE,DATE=期間公開。(省略可)
autocommit 1を指定した場合、変換完了後に自動公開処理を行う
usermeta USERMETA(省略可)

出力

レスポンス内容

名前(要素名) 値(要素の内容)
id_contents コンテンツID

ステータス

有効

 

contents/create_thumbnail

概要

サムネイルを登録。

カテゴリ

コンテンツ

入力

クエリー

名前
id_contents コンテンツID
filekey 登録する画像のファイルキー

出力

レスポンス内容

名前(要素名) 値(要素の内容)
id_video_thumbnail サムネイルID
url URL

ステータス

有効

 

contents/create_thumbnail_attime

概要

動画の時間を指定してサムネイルを登録。

カテゴリ

コンテンツ

入力

クエリー

名前
id_contents コンテンツID
time 時間(秒)

出力

レスポンス内容

名前(要素名) 値(要素の内容)
id_video_thumbnail サムネイルID
url URL

ステータス

有効

 

contents/create_pdf

概要

PDFを登録。

カテゴリ

コンテンツ

入力

クエリー

名前
filekey 登録するPDFのファイルキー
name コンテンツ名
type pdf=PDF。省略時は” pdf”。
parent_id_contents 親フォルダのコンテンツID
description 説明(省略可)
metatag タグ(省略可)
visible 1=常に表示。0=常に非表示。DATE,DATE=期間公開。(省略可)
update_date 更新日(省略可)※未使用
autocommit 1を指定した場合、変換完了後に自動公開処理を行う
usermeta USERMETA(省略可)
domaincontrol ドメイン制御(省略可)

出力

レスポンス内容

名前(要素名) 値(要素の内容)
id_contents コンテンツID

ステータス

有効

  

contents/create_video_keitai

概要

ケータイ動画・音声を作成。

カテゴリ

コンテンツ

入力

クエリー

名前
id_contents コンテンツID
keitaimeta_name 名前(省略可)
keitaimeta_description 説明文(省略可)
keitaimeta_author 作成者(省略可)
keitaimeta_copyright コピーライト(省略可)
encoding_quality 品質(ケータイ)
keitai_thumbnailattime サムネイル画像とする時間を正の整数で秒指定が可能(省略可:デフォルト値3)
autocommit 1を指定した場合、変換完了後に自動公開処理を行う
(省略可能だが、その場合は管理画面上での[公開]処理が必要となるため、APIで完結させるべく利用を強く推奨)

ステータス

有効

 

 

 

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