Skip to content

Channel

gatecrasher777 edited this page Sep 13, 2021 · 16 revisions

Channel

Information Options

--filename      -f string - supply a filename without path or extension - you can use the placeholders in your filename string,  
                   such as:
                    * ${author}             - channel display name
                    * ${date}               - YYYYMMDD - current date 
                    * ${datetime}           - YYYYMMDD HHMMSS - current date & time 
                    * ${id}                 - channel id
                    * ${timestamp}          - unix timestamp - seconds since the epoch, current timestamp
                    * ${...}                - you can use any other video/channel/search info properties
                   The default filename is "${author}_${id}_${datetime}_channel"
                   
--path          -p string - channel data path - defaults to the current directory  

--save          -S all|info|raw|none - data save options 
                    * all                   - save ytcog and raw yt generated json files
                    * info                  - save ytcog generated json files only
                    * raw                   - save raw yt generated json files only
                    * none                  - save nothing

Result Options

--filename      -f string - supply a filename without path or extension - you can use the placeholders in your filename    
                   string, such as:
                    * ${author}             - channel display name
                    * ${date}               - YYYYMMDD - current date
                    * ${datetime}           - YYYYMMDD HHMMSS - current date & time
                    * ${id}                 - channel id
                    * ${order}              - result order
                    * ${timestamp}          - unix timestamp - seconds since the epoch, current timestamp
                    * ${...}                - you can use any other video/channel/search info properties
                   The default filename is "${author}_${id}_${datetime}_${order}_channel"

--items         -I videos|playlists|channels|search - what items to fetch - default: videos
                    * videos                 - returns videos only
                    * playlists              - returns channel playlists only
                    * channels               - returns channels related to this channel
                    * search                 - returns videos that match the search query

--order         -o new|old|views - order of results - default: new 
                    * new                    - newest to oldest
                    * old                    - oldest to newest
                    * views                  - most to least number of views

--path          -p string - defaults to the current directory  

--query         -q string - provide a search term - default: "video" (applies only to items:search)

--quantity      -Q number - minimum number of results to fetch (if available) - default: 60 

--repeat        -R number - number of seconds between repeated requests. (Ctrl-C required to end the session)

--save          -S all|info|raw|none - data save options 
                    * all                   - save ytcog and raw yt generated json files
                    * info                  - save ytcog generated json files only
                    * raw                   - save raw yt generated json files only
                    * none                  - save nothing

Download Options

--audioFormat   -A number - specific audio stream number to download - default: -1 (use preference algorithm and fallback   
                   streams)

--audioQuality  -a highest|medium|lowest|none - audio quality preference - none for video only - default: medium
    
--cfilename     -cf string - supply filename for channel data - you can use the placeholders in your filename    
                   string, such as:
                    * ${author}             - channel display name
                    * ${date}               - YYYYMMDD - current date
                    * ${datetime}           - YYYYMMDD HHMMSS - current date & time
                    * ${id}                 - channel id
                    * ${order}              - result order
                    * ${timestamp}          - unix timestamp - seconds since the epoch, current timestamp
                    * ${...}                - you can use any other video/channel/search info properties
                   The default filename is "${author}_${id}_${datetime}_${order}_channel"

--container     -C any|mp4|webm|mkv - provide your container preference - default: any
                    * any                   - no preference between mp4 (h264 with aac) or webm (vp9 with opus) (default)
                    * mp4                   - prefers mp4 codecs to webm codecs when quality is equal
                    * webm                  - prefers webm codecs to mp4 codecs when quality is equal 
                    * mkv                   - no preference and can additionally allow mixed formats (vp9 with aac) or (h264 with opus). 

--cpath         -cp string - path for channel data files - defaults to the current directory

--filename      -f string - supply a download filename - you can use the following placeholders in your filename string, 
                   such as:
                    * ${audioCodec}         - aac or opus
                    * ${author}             - channel display name
                    * ${channel}            - channel id of video
                    * ${date}               - YYYYMMDD - published date for video
                    * ${datetime}           - YYYYMMDD HHMMSS - published date & time for video
                    * ${id}                 - video id        
                    * ${timestamp}          - unix timestamp - seconds since the epoch, published timestamp for video
                    * ${title}              - video title
                    * ${videoCodec}         - h264 or vp9
                    * ${videoQuality}       - i.e. 1080p, 360p, etc
                    * ${...}                - you can use any other video/channel/search info properties
                   The default filename is "${author}_${datetime}_${title}_${id}_${videoQuality}_${videoCodec}_${audioCodec}"

--items         -I videos|search - what items to fetch - default: videos
                    * videos                 - returns videos only
                    * search                 - returns videos that match the search query

--limit         -L number [number] - limit concurrent downloads (default 1) and the total number of downloads (optional)

--mediaBitrate  -M highest|lowest - prefered bitrate when quality of two streams is equal - default: highest

--metadata      -m author|title|description|keywords|published|comment|key [string] - video property to embed in downloaded file  
                   one or more (i.e. -m author -m title) of  
                    * author          - reflects as AUTHOR in webm/mkv containers, as artist in mp4 containers
                    * title           - reflects as TITLE in webm/mkv containers, as title in mp4 containers
                    * description     - reflects as DESCRIPTION in webm/mkv containers, as description in mp4 containers
                    * keywords        - reflects as KEYWORDS in webm/mkv containers, as synopsis in mp4 containers
                    * published       - reflects as DATE in webm/mkv containers, as date in mp4 containers
                    * comment text    - custom text, reflects as COMMENT in webm/mkv, as comment in mp4 containers
                    * key value       - custom key, custom value. key must be a single word without spaces
                   [string] is required for a comment metadata, and if specified for any other metadata fields its value  
                   will be used to override the fetched video property. 
                   
--overwrite     -O yes|no - whether to download existing files again.
                    * yes - video will be downloaded again and overwrite the existing file.
                    * no - video downloading will be skipped if the video already exists. (default) This is not true if 
                    "better" streams (as per your preferences) become available and the filename changes as a consequence.

--order         -o new|old|views - order of results - default: new 
                    * new                    - newest to oldest
                    * old                    - oldest to newest
                    * views                  - most to least number of views

--path          -p string - specify the path to the video download folder. Defaults to the current directory. 

--query         -q string - provide a search term - default: "video" (applies only to items:search)

--quantity      -Q number - minimum number of results to fetch (if available) - default: 60 

--repeat        -R number - number of seconds between repeated requests. (Ctrl-C required to end the session)  
                   Default: 0 - does not repeat, exits on completion. 
 
--save          -S all|info|raw|none - data save options 
                    * all                   - save ytcog and raw yt generated json files
                    * info                  - save ytcog generated json files only
                    * raw                   - save raw yt generated json files only
                    * none                  - save nothing
                 
--videoFormat   -V number - specific video stream to download. Default: -1 (use preference algorithm and fallback streams)

--videoQuality  -v highest|1080p|720p|480p|medium|360p|240p|144p|lowest|none - video quality preference - none for audio only  
                   default 1080p
Clone this wiki locally