70 lines
4.5 KiB
Markdown
70 lines
4.5 KiB
Markdown
# VideoDetails
|
|
|
|
|
|
## Properties
|
|
|
|
Name | Type | Description | Notes
|
|
------------ | ------------- | ------------- | -------------
|
|
**id** | **int** | object id for the video | [optional]
|
|
**uuid** | **str** | universal identifier for the video, that can be used across instances | [optional]
|
|
**short_uuid** | **str** | translation of a uuid v4 with a bigger alphabet to have a shorter uuid | [optional]
|
|
**is_live** | **bool** | | [optional]
|
|
**created_at** | **datetime** | time at which the video object was first drafted | [optional]
|
|
**published_at** | **datetime** | time at which the video was marked as ready for playback (with restrictions depending on `privacy`). Usually set after a `state` evolution. | [optional]
|
|
**updated_at** | **datetime** | last time the video's metadata was modified | [optional]
|
|
**originally_published_at** | **datetime** | used to represent a date of first publication, prior to the practical publication date of `publishedAt` | [optional]
|
|
**category** | [**VideoConstantNumberCategory**](VideoConstantNumberCategory.md) | category in which the video is classified | [optional]
|
|
**licence** | [**VideoConstantNumberLicence**](VideoConstantNumberLicence.md) | licence under which the video is distributed | [optional]
|
|
**language** | [**VideoConstantStringLanguage**](VideoConstantStringLanguage.md) | main language used in the video | [optional]
|
|
**privacy** | [**VideoPrivacyConstant**](VideoPrivacyConstant.md) | privacy policy used to distribute the video | [optional]
|
|
**description** | **str** | truncated description of the video, written in Markdown. Resolve `descriptionPath` to get the full description of maximum `10000` characters. | [optional]
|
|
**duration** | **int** | duration of the video in seconds | [optional]
|
|
**is_local** | **bool** | | [optional]
|
|
**name** | **str** | title of the video | [optional]
|
|
**thumbnail_path** | **str** | | [optional]
|
|
**preview_path** | **str** | | [optional]
|
|
**embed_path** | **str** | | [optional]
|
|
**views** | **int** | | [optional]
|
|
**likes** | **int** | | [optional]
|
|
**dislikes** | **int** | | [optional]
|
|
**nsfw** | **bool** | | [optional]
|
|
**wait_transcoding** | **bool** | | [optional]
|
|
**state** | [**VideoStateConstant**](VideoStateConstant.md) | represents the internal state of the video processing within the PeerTube instance | [optional]
|
|
**scheduled_update** | [**VideoScheduledUpdate**](VideoScheduledUpdate.md) | | [optional]
|
|
**blacklisted** | **bool** | | [optional]
|
|
**blacklisted_reason** | **str** | | [optional]
|
|
**account** | [**Account**](Account.md) | | [optional]
|
|
**channel** | [**VideoChannel**](VideoChannel.md) | | [optional]
|
|
**user_history** | [**VideoUserHistory**](VideoUserHistory.md) | | [optional]
|
|
**viewers** | **int** | If the video is a live, you have the amount of current viewers | [optional]
|
|
**description_path** | **str** | path at which to get the full description of maximum `10000` characters | [optional]
|
|
**support** | **str** | A text tell the audience how to support the video creator | [optional]
|
|
**tags** | **List[str]** | | [optional]
|
|
**comments_enabled** | **bool** | | [optional]
|
|
**download_enabled** | **bool** | | [optional]
|
|
**input_file_updated_at** | **datetime** | Latest input file update. Null if the file has never been replaced since the original upload | [optional]
|
|
**tracker_urls** | **List[str]** | | [optional]
|
|
**files** | [**List[VideoFile]**](VideoFile.md) | Web compatible video files. If Web Video is disabled on the server: - field will be empty - video files will be found in `streamingPlaylists[].files` field | [optional]
|
|
**streaming_playlists** | [**List[VideoStreamingPlaylists]**](VideoStreamingPlaylists.md) | HLS playlists/manifest files. If HLS is disabled on the server: - field will be empty - video files will be found in `files` field | [optional]
|
|
|
|
## Example
|
|
|
|
```python
|
|
from peertube.models.video_details import VideoDetails
|
|
|
|
# TODO update the JSON string below
|
|
json = "{}"
|
|
# create an instance of VideoDetails from a JSON string
|
|
video_details_instance = VideoDetails.from_json(json)
|
|
# print the JSON string representation of the object
|
|
print VideoDetails.to_json()
|
|
|
|
# convert the object into a dict
|
|
video_details_dict = video_details_instance.to_dict()
|
|
# create an instance of VideoDetails from a dict
|
|
video_details_form_dict = video_details.from_dict(video_details_dict)
|
|
```
|
|
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
|
|
|