The Media Object

Nearly all of the functions within the API work exclusively with the Media Object. The main purpose of the media object is to maintain a placeholder for an original piece of media uploaded to FrameSocket, and to link to the appropriately encoded images and/or videos for that file. The encoded images/videos are linked through an attached Image Object and Video Object. When querying for media, you will always be returned a full description of the Media Object, meaning that it will also include all of the details for the Image Object and Video Object that are attached to that Media Object. If they do not exist, you will simply be returned null values for the Image Object and/or Video Object.

All of the following object descriptions have a proper name followed by the JSON variable name so that you can appropriately interpret JSON response code without having to first see several requests with your own eyes. Please note that all return objects are, at their root, a success value, error string, warnings string, and array of medias.

Please Note: All storage sizes are returned in KB, and that MB are computed as 1024 KB.

The Media Object

  • Hash Code : hash
    • The unique identifier for this media within all of FrameSocket.
  • Status Code : status_code
  • Status Message : status_message
  • Title : title
  • Description : description
  • Keywords : keywords
  • Custom ID : customid
  • Storage Size : storage_size
  • Original HTTP URL : original_http_url
    • The URL where the original file can be fetched from.
  • Original File : original
    • The filename for the original file.
  • Image Object : image
    • If none is present, this is equal to null.
  • Video Object : video
    • If none is present, this is equal to null.

The Image Object

  • Hash Code : hash
    • The unique identifier for this image within all of FrameSocket.
  • HTTP URL : http_url
    • The URL where you can retrieve this object's files.
  • Icon Image Filename : icon
  • Square Image Filename : square
  • Small Image Filename : small
  • Medium Image Filename : medium
  • Large Image Filename : large
  • Storage Size : storage_size

The Video Object

  • Hash Code : hash
    • The unique identifier for this video within all of FrameSocket.
  • HTTP URL : http_url
    • URL to retrieve this object's files via HTTP GET.
  • RTMP URL : rtmp_url
    • URL to access this object's files via RTMP / Flash Media Server.
  • 270p Mobile Video Filename : v270p
  • 360p Low Quality Video Filename : v360p
  • 480p Normal Quality Video Filename : v480p
  • 720p HD Video Filename : v720p
  • 1080p HD Video Filename : v1080p
  • Storage Size : storage_size
Have a question? We are currently: