Acquisition of specified order based fv

This API generate a fv in specified tile order.
The tile to be displayed using this API are tiles which is activated with media activation API.
GET /api/1/videos/fv

Note

There are two ways to specify the order of tile that make up the fv.
Required parameters change as follows according to each way. It is not possible to mix medias which have different tile type and different tile quality.

1. The way to create a fv with comma-separated media ID and level [Appendix]
　Required parameters: media_ids and (levels or level)
2. The way to create a fv with a map of JSON format [Appendix]
　Required parameters: map_data

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

  • media_ids

    • media ID that constitutes the fv

  • levels

    • Specifies the level of each media ID specified in media_ids

  • level

    • Specifies a level collectively for each media ID specified in media_ids

  • map_data

    • map data in JSON format

  • sound_ids

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

  • tile_type

    • Tile type
      hd 16:9 / sd 4:3 / r 3:2 / s 1:1
      For fv creation with map_data, if media ID is not specified in the map_data, tile_type can be retrieved. Thus tile_type is required in this case.

  • tile_quality

    • Tile Quality
      1 :High / 2 :Middle / 3 :Low
      For fv creation with map_data, if media ID is not specified in the map_data, tile_quality is needed. Thus tile_quality is required in this case.

  • start_time

    • specifies the start time of each media that is specified in the media_ids. [Appendix]

  • media_duration

    • specifies the time of each media that is specified in the media_ids. [Appendix]

Response

  • status

    • result of process
      success: success
      other: failure

  • 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

Media_ids and levels

GET
http://example.com/api/1/videos/fv?
key=xxxx&output_type=x&duration=60&row=1&col=2&
media_ids=59,58&levels=1,1&sound_ids=87

Map data

GET
http://example.com/api/1/videos/fv?
key=xxxx&output_type=x&duration=60&row=1&col=2&
map_data=[[ { "id":"59", "lev":"1", "rx":"0", "ry":"0" },
{ "id":"58", "lev":"1", "rx":"0", "ry":"0" } ]]
&sound_ids=87

Sample Curl Command

  • Basic認証を使用した方法(media_idsとlevelsで指定)
curl --basic -u {your account}:{your password} "https://example.com/api/1/videos/fv?duration=10&row=2&col=2&tile_type=hd&tile_quality=2&media_ids=472,473,474,475&levels=1,1,1,1"
  • AccessToken認証を使用した方法(media_idsとlevelsで指定)
curl "https://example.com/api/1/videos/fv?duration=10&row=2&col=2&tile_type=hd&tile_quality=2&media_ids=472,473,474,475&level=1" \
-H "Authorization: Bearer {your access_token}"

Response Example - JSON

{
  "status":"success",
  "video_url":"http:\/\/example.com\/fv\/gnzo-xxxxxxxxxxxxx.mp4",
  "thumbnail_url":"http:\/\/example.com\/fvt\/gnzo-xxxxxxxxxx.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":""
      }
    ]
  ]
}

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>