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 [required]

  • search keyword

    # (characters): tag search (Perfect match)

    (characters): caption and description search (Partial match)

• keywords [required]

  • search keyword (middle-bracket{} is not required in practice.)
    • #{string} : Tag search (Exact match)
      • Append # just before keyword string.
    • {string} (OR search) / {“string”} (AND search) : search string in caption/description (AND/OR partial search)
    • &{integer} : ID search (Partial search)
  • Provided that, # should be URL encoded to %23, and &, ampersand, should be URL encoded to %26
  • In addition, Space should be URL encoded to %20.
  • Please refer to [Detail] for search rule detail.

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
  • 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”.

• 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/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>