Overview
A media object represents a piece of content uploaded to a FanHero channel to be used in a post.
A media object can have type Video, Audio or Image.
Media object properties
| Name | Type | Description |
|---|---|---|
id | String | The media ID |
filename | String | Name of the media file |
channel | String | The channel ID |
account | String | The ID of the account that uploaded the media |
type | String | Media type. Can be Video, Audio or Image. |
status | String | The current status of the media. |
upload | String | The upload ID. |
isAvatar | Boolean | If True, this media is used as an avatar. |
deleted | Boolean | If True, this media has been deleted. This will be the case in the response of a successful Delete media endpoint. |
createdAt | DateTime String | Date and time when the media object was created. |
updatedAt | DateTime String | Date and time when the media object was last updated. |
baseUrl | String | The base URL of the cloud storage where the media file is located. |
imgPath | String | For media of type Image. The relative path to the image file in the storage. File can be accessed by concatenating the base URL with the relative path. |
mp3Path | String | For media of type Audio. The relative path to the MP3 file in the storage. File can be accessed by concatenating the base URL with the relative path. |
dashPath | String | For media of type Video. The relative path used in a DASH URL. |
hlsPath | String | For media of type Video. The relative path to the HLS file in the storage. File can be accessed by concatenating the base URL with the relative path. |
mp4Path | String | For media of type Video. The relative path to the MP4 file in the storage. File can be accessed by concatenating the base URL with the relative path. |
duration | Number | For media of type Video. The duration of the content. |
height | Number | For media of type Video. The video height. |
width | Number | For media of type Video. The video width. |
orientation | String | For media of type Video. The video orientation. Can be landscape or portrait. |
thumbnailPath | String | For media of type Video. Path to the thumbnail image in the cloud storage. |