From dc4eafe33f724d33412f108ef60e8373a406b793 Mon Sep 17 00:00:00 2001 From: Pierre Rudloff Date: Sun, 21 Apr 2019 19:10:37 +0200 Subject: [PATCH] docs: Document magic properties --- classes/Video.php | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/classes/Video.php b/classes/Video.php index f1247e5..e39decb 100644 --- a/classes/Video.php +++ b/classes/Video.php @@ -14,7 +14,14 @@ use Symfony\Component\Process\Process; /** * Extract info about videos. * - * Due to the way youtube-dl, this class can also contain a playlist. + * Due to the way youtube-dl behaves, this class can also contain information about a playlist. + * + * @property-read string $title Title + * @property-read string $protocol Network protocol (HTTP, RTMP, etc.) + * @property-read string $url File URL + * @property-read string $ext File extension + * @property-read string $extractor_key youtube-dl extractor class used + * @property-read array $entries List of videos (if the object contains information about a playlist) */ class Video { @@ -46,6 +53,13 @@ class Video */ private $password; + /** + * JSON object returned by youtube-dl. + * + * @var stdClass + */ + private $json; + /** * VideoDownload constructor. *