Acquisition of timeline order based fv

This API generate a fv in descending order of registration time.
Tile configuration of fv is with only level 1 and same tile type.
GET /api/1/videos/fv/timeline

Parameters

  • key [required]

    • Client authorization key

  • output_type

    • Response type
      • x: Output in XML format
      • blank: Output in JSON format

  • duration

    • Time of fv to generate (1〜900seconds)
      An integer [Appendix]

  • loop

    • parameter for determining the length of fv [Appendix]

  • row [required]

    • Number of rows of fv to generate

  • col [required]

    • Number of columns of fv to generate

  • tile_type [required]

    • Tile type
      hd 16:9 / sd 4:3 / r 3:2 / s 1:1

  • tile_quality [required]

    • Tile Quality. Single Tile Quality can be specified.
      1 :High / 2 :Middle / 3 :Low

  • sound_ids

    • The media ID to add the sound into the fv. [Appendix]

  • page

    • Page which will be rendered. Integer greater than 1. [Appendix]

  • keywords [オプション]

    • 検索キーワード（実際には中括弧{}は入れません。）
      • #{string} : タグ検索（完全一致検索）
        • 文字列キーワードの直前に#をつけて下さい。
      • {string} （OR検索指定）または {“string”} （AND検索指定）: キャプション，デスクリプション検索（部分一致AND/OR検索）
      • &{integer} : ID検索（部分一致検索）
    • 但し，#(シャープ)は%23とURLエンコードされている必要があり、&(アンパサンド)は%26とURLエンコードされている必要があることに注意して下さい。
    • またスペースは%20です。
    • ルールや指定方法詳細については，[詳細]を参照

Response

  • status

    • result of process
      success: success
      other: failure

  • has_next

    • existence on the next page
      true: exist
      false: not exist

  • video_url

    • fv URL

  • thumbnail_url

    • fv thumbnail URL

  • cahched_data

    • This is the flag whether fabric video’s mp4 file already have been genearted or not. If fabric video’s mp4 file alread have been generated, this flag should specify “1”, if generating process is running, this flag should specify “0”.

  • black_edge

    • 生成されたfvのmp4ファイルの周り（上と左右）に16pixの黒色の帯が入っている場合には、”1”が返り、16pixの黒色の帯が入っていないならば、”0”が入る。
      黒帯を入れるか否かはfvLIBRARY環境作成時にのみ決定可能であり、途中からの変更は出来ないので、留意して下さい。（詳細はお問い合わせ下さい。）
      本パラメータは基本的にバージョン互換性を持たせるためのパラメータであり、基本的にはblack_edgeパラメータには”0”が入る。

  • map_data

    • map data

Request Example

GET
http://example.com/api/1/videos/fv/timeline?
key=xxx&duration=6&row=2&col=2&tile_type=s&tile_quality=2

Sample Curl Command

curl "https://example.com/api/1/videos/fv/timeline?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-xxxxxxxxxxx.mp4",
  "thumbnail_url":"http:\/\/example.com\/fvt\/gnzo-xxxxxxxxxxx.png",
  "cached_data":"1",
  "black_edge":"0",
  "map_data":[
    [
      {
        "id":"59",
        "lev":"1",
        "all-lev":[
         "1",
         "2"
        ],
        "audio":"1",
        "rx":"0",
        "ry":"0",
        "caption":"caption test",
        "description":"description test"
      },
      {
        "id":"58",
        "lev":"1",
        "all-lev":[
         "1",
         "2"
        ],
        "audio":"1",
        "rx":"0",
        "ry":"0",
        "caption":"",
        "description":""
      }
    ],
    [
      {
        "id":"57",
        "lev":"1",
        "all-lev":[
         "1",
         "2"
        ],
        "audio":"1",
        "rx":"0",
        "ry":"0",
        "caption":"",
        "description":""
      },
      {
        "id":"52",
        "lev":"1",
        "all-lev":[
         "1",
         "2"
        ],
        "audio":"1",
        "rx":"0",
        "ry":"0",
        "caption":"",
        "description":""
      }
    ]
  ]
}

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-xxxxxxxxxx.mp4</video_url>
<thumbnail_url>http://example.com/fvt/gnzo-xxxxxxxxxxxxxx.png</thumbnail_url>
<cached_data>1</cached_data>
<black_edge>0</bloack_edge>
<map_data>
<entry>
  <entry>
  <id>59</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 caption</caption>
  <description>test description</description>
  </entry>
  <entry>
  <id>58</id>
  <lev>1</lev>
  <all-leve>
    <entry>1</entry>
    <entry>2</entry>
  </all-leve>
  <audio>1</audio>
  <rx>0</rx>
  <ry>0</ry>
  <caption />
  <description />
  </entry>
</entry>
<entry>
  <entry>
  <id>57</id>
  <lev>1</lev>
  <all-leve>
    <entry>1</entry>
    <entry>2</entry>
  </all-leve>
  <audio>1</audio>
  <rx>0</rx>
  <ry>0</ry>
  <caption />
  <description />
  </entry>
  <entry>
  <id>52</id>
  <lev>1</lev>
  <all-leve>
    <entry>1</entry>
    <entry>2</entry>
  </all-leve>
  <audio>1</audio>
  <rx>0</rx>
  <ry>0</ry>
  <caption />
  <description />
  </entry>
</entry>
</map_data>
</response>