キーワード検索結果のfvの取得¶
入力されたキーワードの検索結果で fv を生成します。
タグは完全一致、キャプションは部分一致で検索されます。fv のタイル構成は、指定したタイル種別のレベル1 のみを使用した構成となります。
GET /api/1/videos/fv/search
Parameters¶
key [必須]
- クライアント認証キー
output_type
- Response 形式
- x : XML 形式で出力
- 指定無し : JSON 形式で出力
- Response 形式
duration
- 生成する fv の時間(1〜900秒)。整数で指定。[詳細]
loop
- fv の長さを決定するパラメータ [詳細]
row [必須]
- 生成する fv の行数
col [必須]
- 生成する fv の列数
tile_type [必須]
- タイル種別。1 種類のみ指定可能。hd 16:9 / sd 4:3 / r 3:2 / s 1:1
tile_quality [必須]
- タイル品質。1 種類のみ指定可能。1 :高 / 2 :中 / 3 :低
sound_ids
- fv に埋め込む音声をメディアID で指定。[詳細]
page
- 表示するページ位置。1 以上の整数。[詳細]
keywords [必須]
- 検索キーワード(実際には中括弧{}は入れません。)
- #{string} : タグ検索(完全一致検索)
- 文字列キーワードの直前に#をつけて下さい。
- {string} (OR検索指定)または {“string”} (AND検索指定): キャプション,デスクリプション検索(部分一致AND/OR検索)
- &{integer} : ID検索(部分一致検索)
- 但し,#(シャープ)は%23とURLエンコードされている必要があり、&(アンパサンド)は%26とURLエンコードされている必要があることに注意して下さい。
- またスペースは%20です。
- ルールや指定方法詳細については,[詳細]を参照
Response¶
status
- 処理結果success : 成功それ以外 : 失敗
has_next
- 次ページの有無true : 有false : 無
video_url
- 生成された fv のURL
thumbnail_url
- 生成された fv のサムネイルのURL
map_data
- マップデータ
cached_data
- fvのmp4ファイルが既に作成されているかどうかを示すフラグ.既に作成されているならば”1”が入り,作成中ならば”0”が入る.
black_edge
- 生成されたfvのmp4ファイルの周り(上と左右)に16pixの黒色の帯が入っている場合には、”1”が返り、16pixの黒色の帯が入っていないならば、”0”が入る。黒帯を入れるか否かはfvLIBRARY環境作成時にのみ決定可能であり、途中からの変更は出来ないので、留意して下さい。(詳細はお問い合わせ下さい。)本パラメータは基本的にバージョン互換性を持たせるためのパラメータであり、基本的にはblack_edgeパラメータには”0”が入る。
Request Example¶
GET
http://example.com/api/1/videos/fv/search?
key=xxxxxx&duration=30&row=2&col=2&tile_type=hd&tile_quality=2&
sound_ids=171&page=1&keywords=Movie
Sample Curl Command¶
curl "https://example.com/api/1/videos/fv/search?key={your api key}&duration=10&row=2&col=2&tile_type=hd&tile_quality=2&keywords=%23hogehoge"
Response Example - JSON¶
{
"status":"success",
"has_next":true,
"video_url":"http:\/\/example.com\/fv\/gnzo-xxxxxxxxxx.mp4",
"thumbnail_url":"http:\/\/example.com\/fvt\/gnzo-xxxxxxxxxxxxxx.png",
"cached_data":"1",
"black_edge":"0",
"map_data":[
[
{
"id":"17",
"lev":"1",
"all-lev":[
"1",
"2"
],
"audio":"1",
"rx":"0",
"ry":"0",
"caption":" Test Movie 1",
"description":" Description 17"
"map_id":null
},
{
"id":"16",
"lev":"1",
"all-lev":[
"1",
"2"
],
"audio":"1",
"rx":"0",
"ry":"0",
"caption":" Test Movie 2",
"description":" Description 16"
"map_id":null
}
],
[
{
"id":"15",
"lev":"1",
"all-lev":[
"1",
"2"
],
"audio":"1",
"rx":"0",
"ry":"0",
"caption":" Test Movie 3",
"description":" Description 15"
"map_id":null
},
{
"id":"14",
"lev":"1",
"all-lev":[
"1",
"2"
],
"audio":"1",
"rx":"0",
"ry":"0",
"caption":" Test Movie 4",
"description":" Description 14"
"map_id":null
}
]
]
}
Response Example - XML¶
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>success</status>
<has_next>1</has_next>
<video_url>http://example.com/fv/gnzo-xxxxxxxxxxxxxx.mp4</video_url>
<thumbnail_url>http://example.com/fvt/gnzo-xxxxxxxxxxxxxxxxx.png</thumbnail_url>
<cached_data>1</cached_data>
<black_edge>0</bloack_edge>
<map_data>
<entry>
<entry>
<id>17</id>
<lev>1</lev>
<all-leve>
<entry>1</entry>
<entry>2</entry>
</all-leve>
<audio>1</audio>
<rx>0</rx>
<ry>0</ry>
<caption>Test Movie 1</caption>
<description>Description 17</description>
</map_id>
</entry>
<entry>
<id>16</id>
<lev>1</lev>
<all-leve>
<entry>1</entry>
<entry>2</entry>
</all-leve>
<audio>1</audio>
<rx>0</rx>
<ry>0</ry>
<caption> Test Movie 2</caption>
<description> Description 16</description>
</map_id>
</entry>
</entry>
<entry>
<entry>
<id>15</id>
<lev>1</lev>
<all-leve>
<entry>1</entry>
<entry>2</entry>
</all-leve>
<audio>1</audio>
<rx>0</rx>
<ry>0</ry>
<caption> Test Movie 3</caption>
<description> Description 15</description>
</map_id>
</entry>
<entry>
<id>14</id>
<lev>1</lev>
<all-leve>
<entry>1</entry>
<entry>2</entry>
</all-leve>
<audio>1</audio>
<rx>0</rx>
<ry>0</ry>
<caption> Test Movie 4</caption>
<description> Description 14</description>
</map_id>
</entry>
</entry>
</map_data>
</response>