Acquisition of media information list¶

This API returns a media information list.

GET /api/1/videos/media

Note

This API’s behavior depends on the authentication.
If the digest authentication is passed, this API returns a list of media that has “not deleted media”.
If the Referrer + Kye authentication is passed, this API returns a list of media that has “activated media”.

Parameters¶

output_type
- Response type
  - x: Output in XML format
  - blank: Output in JSON format
page [required]
- Page which will be rendered. Integer greater than 1.[Appendix]
num [required]
- Number per page [Appendix]
  
  Ascending order if num is positive value
  
  Descending order if num is negative value
tile_type
- Tile type to get medias
  
  All tile type is applied if tile_type is not set.
  
  hd 16:9 / sd 4:3 / r 3:2 / s 1:1
tile_quality
- Tile quality to get medias
  
  All tile quality is applied if tile_type is not set.
  
  There are three optional tile quality. 1 / 2 / 3
level
- Level to get medias
  
  All level is applied if level is not set.
  
  There are four optional level 1 / 2 / 3 / 4.
media_id
- Media id to get medias (Partial match)
  
  Medias for the specified integer number containing media ids will be target.

Response¶

status
- Result of process
  
  success: success
  
  other: failure
has_next
- existence on the next page
  
  true: exist
  
  false: not exist
total
- total media number
info
- media information
  - id
    - media id
  - caption
    - caption
  - description
    - description
  - tags
    - tag
  - thumbnail_url
    - URL for fv thumbnail that is generated
    - File name of the thumbnail will be “(MediaID)_(length of thumbnail)_(frame_position).jpg”. Video frame rate is fixed automatically to 30fps when you register video, so the frame position of video you have and the frame position of media may be different.
  - sound_url
    - URL for fv sound that is generated
  - tile_info
    - tile information
      - version
        
        version of fv encoder
      - type
        
        tile type
      - fps
        
        fps
      - frames
        
        total frame of tile
      - level
        
        tile level (array style)
      - tile_quality
        
        tile quality (array style)
      - create_date
        
        creation date of tile
      - update_date
        
        updated date of tile
      - status
        
        tile status
  - create_date
    - creation date of media
  - update_date
    - updated date of media
  - status
    - media status
      
      0: invalid
      
      1: valid

Request Example¶

GET
https://example.com/api/1/videos/media?page=30&num=2

Sample Curl Command¶

Basic認証を使用した方法

curl --basic -u {your account}:{your password} "https://example.com/api/1/videos/media?page=1&num=-10"

AccessToken認証を使用した方法

curl "https://example.com/api/1/videos/media?page=1&num=-10" \
-H "Authorization: Bearer {your access_token}"

Response Example - JSON¶

{
  "status":"success",
  "has_next":true,
  "total":59,
  "info":[
    {
      "id":"2",
      "caption":"test caption",
      "tags":[
      "tag1",
      "tag2"
      ],
      "thumbnail_url":[
        "http:\/\/example.com\/r\/p\/images\/tt\/2_144_0.jpg"
      ],
      "sound_url":[
        "http:\/\/example.com\/r\/p\/audios\/ta\/2_1.m4a"
      ],
      "tile_info":{
        "version":"3",
        "type":"hd144",
        "fps":30,
        "frames":420,
        "level":[
          1
        ],
        "tile_quality":[
         1,
         2
        ],
        "create_date":"2013-01-11 12:15:41",
        "update_date":"2013-01-11 12:15:44",
        "status":1
      },
      "create_date":"2013-01-11 12:15:41",
      "update_date":"2013-01-30 13:49:26",
      "status":"1"
      },
      {
        "id":"3",
        "caption":"caption test",
        "tags":[
        "test tag1",
        "test tag2"
        ],
        "thumbnail_url":[
        "http:\/\/example.com\/r\/p\/images\/tt\/3_144_0.jpg"
        ],
        "sound_url":[
        "http:\/\/example.com\/r\/p\/audios\/ta\/3_1.m4a"
        ],
        "tile_info":{
        "version":"3",
        "type":"hd144",
        "fps":30,
        "frames":360,
        "level":[
          1
        ],
        "tile_quality":[
         2
        ],
        "create_date":"2013-01-11 12:16:12",
        "update_date":"2013-01-11 12:16:16",
        "status":1
      },
      "create_date":"2013-01-11 12:16:12",
      "update_date":"2013-01-11 12:16:15",
      "status":"1"
    }
  ]
}

Response Example - XML¶

<?xml version="1.0" encoding="UTF-8"?>
<response>
<status>success</status>
<has_next>1</has_next>
<total>59</total>
<info>
  <entry>
    <id>2</id>
    <caption>test caption</caption>
    <tags>
      <entry>tag1</entry>
      <entry>tag2</entry>
    </tags>
    <thumbnail_url>
      <entry>http://example.com/r/p/images/tt/2_144_0.jpg</entry>
    </thumbnail_url>
    <sound_url>
      <entry>http://example.com/r/p/audios/ta/2_1.m4a</entry>
    </sound_url>
    <tile_info>
      <version>3</version>
      <type>hd144</type>
      <fps>30</fps>
      <frames>420</frames>
      <level>
       <entry>1</entry>
      </level>
      <tile_quality>
       <entry>1</entry>
       <entry>2</entry>
      </tile_quality>
      <create_date>2013-01-11 12:15:41</create_date>
      <update_date>2013-01-11 12:15:44</update_date>
      <status>1</status>
    </tile_info>
    <create_date>2013-01-11 12:15:41</create_date>
    <update_date>2013-01-30 13:49:26</update_date>
    <status>1</status>
  </entry>
  <entry>
    <id>3</id>
    <caption>test caption</caption>
    <tags>
      <entry>test tag1</entry>
      <entry>test tag2</entry>
    </tags>
    <thumbnail_url>
      <entry>http://example.com/r/p/images/tt/3_144_0.jpg</entry>
    </thumbnail_url>
    <sound_url>
      <entry>http://example.com/r/p/audios/ta/3_1.m4a</entry>
    </sound_url>
    <tile_info>
      <version>3</version>
      <type>hd144</type>
      <fps>30</fps>
      <frames>360</frames>
      <level>
        <entry>1</entry>
      </level>
      <tile_quality>
        <entry>1</entry>
      </tile_quality>
      <create_date>2013-01-11 12:16:12</create_date>
      <update_date>2013-01-11 12:16:16</update_date>
      <status>1</status>
    </tile_info>
    <create_date>2013-01-11 12:16:12</create_date>
    <update_date>2013-01-11 12:16:15</update_date>
    <status>1</status>
  </entry>
</info>
</response>

fvLIBRARY API

Acquisition of media information list¶

Parameters¶

Response¶

Request Example¶

Sample Curl Command¶

Response Example - JSON¶

Response Example - XML¶

Gnzo HP

fv solution API

Previous topic

Next topic

fvLIBRARY API