Document force_alpha.
[pyTivo/TheBayer.git] / plugins / admin / help.txt
blob9c77249e3a82601d6039550c4c488effacd2774d
1 ###################### pyTivo Web Admin Help #########################\r
2 #\r
3 # Description: This file contains the information displayed in the\r
4 # settings help section of the web admin. Most users will never need\r
5 # to edit or view this file.\r
6 #\r
7 # Format: Blank lines and lines beginning with '#' are ignored.\r
8 # The name of a section should appear on its own line and should NOT\r
9 # contain a colon.  Subsequent lines should contain the portion to be\r
10 # bolded, followed by a colon, followed by the descriptive text.\r
11 # Each line will be read into the previously named section until a\r
12 # blank line or the EOF is reached. Lines containing colons that\r
13 # don't mark a new subhead must be escaped by placing '>' in the\r
14 # first position.\r
15 #\r
16 # In order for the web config plugin to know which settings are \r
17 # available in which sections, the following line should be present in \r
18 # each setting:\r
19 #\r
20 # Available In:\r
21 #\r
22 # This entry should be a comma seperated list of the sections which\r
23 # this setting should be shown in. For example:\r
24 #\r
25 # Available In: Server, Tivos, HD_tivos, SD_tivos, Shares\r
26 #\r
27 ######################################################################\r
29 Instructions\r
31 To Edit a Share: Select the share in the left hand menu.\r
32 To Delete a Share: Select the share in the left hand menu and click \r
33 delete.\r
34 To Add a Share/Tivo/Section: Click the "Add Section" button.  Then \r
35 provide the name of the share or TiVo. You must save your changes before \r
36 you can edit settings in the new share.\r
37 To Add a Setting: Select your share first.  If the setting is a known \r
38 setting simply add the value to the appropriate setting. If the setting \r
39 is not listed you can add a "User Defined Setting".  Simple click add \r
40 setting and provide the name and value of this new setting.\r
41 To Delete a Setting: Delete the value of the setting so that it is \r
42 blank.  If this is a known share the name will remain after a save. If \r
43 the setting is a user defined setting the name will be deleted after the \r
44 save.\r
45 Save Settings: Clicking Save Settings will write your changes to the \r
46 pyTivo.conf file. These settings will not have an effect on your pyTivo \r
47 server until it is Soft Reset or restarted.\r
48 Soft Reset: Soft Reset allows your new settings to take effect without \r
49 manually restarting the TiVo.  The Soft Reset will cause a re-read of \r
50 the pyTivo.conf file so your changes must be saved to the file before \r
51 the reset.\r
52 Note: The only setting that will not take effect until a hard restart is \r
53 the Port setting.  Changing the Port setting requires a full restart.\r
55 Add a New Section\r
57 Add the name of a new section: If you want to add a TiVo section, \r
58 remember it must start with "_tivo_". You must save your settings before \r
59 the new section will be editable.\r
61 port\r
63 Default Setting: 9032\r
64 Valid Entries: 1-65535\r
65 Required: No\r
66 Skill: Basic\r
67 Description: The port which pyTivo uses to serve your files. Can be\r
68 changed if it conflicts with another program.\r
69 Example Settings: 9032\r
70 Available In: Server\r
72 ffmpeg\r
74 Default Setting: None\r
75 Valid Entries: Operating system path\r
76 Required: No\r
77 Skill: Basic\r
78 Description: This is the full path to your ffmpeg binary. If not set, \r
79 pyTivo checks for it in a "bin" subdirectory, and then in the PATH. If \r
80 no ffmpeg is found, pyTivo will operate in a limited mode, serving only \r
81 MPEG and TiVo files in video shares, and only MP3 files in music shares, \r
82 with no seek capability.\r
83 Example Settings: Linux = /usr/bin/ffmpeg |\r
84 >Windows = c:\Program Files\pyTivo\bin\ffmpeg.exe\r
85 Available In: Server\r
87 tivodecode\r
89 Default Setting: None\r
90 Valid Entries: Operating system path\r
91 Required: No\r
92 Skill: Basic\r
93 Description: This is the full path to your tivodecode binary. If not \r
94 set, pyTivo checks for it in a "bin" subdirectory, and then in the PATH.\r
95 tivodecode is only needed for certain functions (currently pushing .TiVo \r
96 files or transcoding HD .TiVo files to SD).\r
97 Example Settings: Linux = /usr/bin/tivodecode |\r
98 >Windows = c:\Program Files\pyTivo\bin\tivodecode.exe\r
99 Available In: Server\r
101 beacon\r
103 Default Setting: 255.255.255.255\r
104 Valid Entries: Beacon IP address(es) or "listen".  Can contain multiple\r
105 IPs separated by spaces.\r
106 Required: No\r
107 Skill: Advanced\r
108 Description: The addresses on which the beacon should broadcast.  Most\r
109 people can leave this at the default. If set to "listen", will accept\r
110 incoming TCP beacons. If you're having issues with your shares not\r
111 appearing on TiVo, try using the broadcast address of your LAN. For\r
112 example, if your gateway (router) used address 192.168.1.1, your\r
113 broadcast address would be 192.168.1.255.  Alternatively, you can\r
114 specify the exact addresses of your TiVos, e.g. 192.168.1.150\r
115 192.168.1.151.\r
116 Example Settings: 192.168.1.255\r
117 Available In: Server\r
119 debug\r
121 Default Setting: False\r
122 Valid Entries: True/False\r
123 Required: No\r
124 Skill: Advanced\r
125 Description: Will generate more output for debugging purposes.\r
126 Example Settings: True/False\r
127 Available In: Server\r
129 type\r
131 Default Setting: None\r
132 Valid Entries: video, music, photo, or any other valid plugin name.\r
133 Required: Yes\r
134 Skill: Basic\r
135 Description: Sets the type of share that this will be. This must be set\r
136 to something otherwise pyTivo will not start. NOTE plugins names are\r
137 generally lowercase.\r
138 Example Settings: video, music, photo\r
139 Available In: Shares\r
141 path\r
143 Default Setting: None\r
144 Valid Entries: Any operating system path\r
145 Required: Yes\r
146 Skill: Basic\r
147 Description: Sets the base path to your media content. While pyTivo will\r
148 start with an invalid path your shares will not work at all.\r
149 Example Settings: Windows = C:\videos | Linux = /home/user/media\r
150 Available In: Shares\r
152 force_alpha\r
154 Default Setting: False\r
155 Valid Entries: True/False\r
156 Required: No\r
157 Skill: Basic\r
158 Description: Only meaningful in shares of type "video". When false, \r
159 pyTivo will display videos in the order requested by the TiVo, as \r
160 described at the bottom of the screen. When true, pyTivo will ignore the \r
161 sort options and revert to its "classic" behavior, using an alphabetical \r
162 sort always, with folders listed first. Note that the TiVo doesn't \r
163 request alpha sorts for folders below the top level, so if you want them \r
164 alpha-sorted, you need this option.\r
165 Example Settings: True/False\r
166 Availale In: Shares\r
168 precache\r
170 Default Setting: False\r
171 Valid Entries: True/False\r
172 Required: No\r
173 Skill: Moderate\r
174 Description: In order to verify that the video files present on your\r
175 computer were compatible with ffmpeg in older versions pyTivo would\r
176 query ffmpeg for each file. While this information was cached it still\r
177 caused a delay in the initial loading of a list of files. This precache\r
178 setting forced pyTivo to inspect each video prior to starting the pyTivo\r
179 server. However, this had two drawbacks. 1. It took time as much as two\r
180 minutes before pyTivo was ready to accept requests. 2. It did not update\r
181 the cache if new files were added while the pyTivo server was\r
182 running.<br><br>\r
183 In the more recent releases, anything after Feb 16, 2008, pyTivo no\r
184 longer needs to query ffmpeg when creating a file list. Instead pyTivo\r
185 has a list of accepted video format extensions. If the file extension\r
186 falls within this list it is displayed on the TiVo. This achieves the\r
187 same speed increase as the precache method without the delay in loading\r
188 the pyTivo server.<br><br>\r
189 There are still two drawbacks to this method. 1. The video file must\r
190 have an extension that is in the list. There is a possibility that a new\r
191 video file extension could come out before pyTivo is updated. 2.\r
192 Incomplete or video files with errors will still appear in the TiVo\r
193 listing if they have the correct extension, even though they are not\r
194 valid files. Both of these concerns are minimal. 1. Very few new formats\r
195 of video files come out very often. And all extensions are stored in the\r
196 video.ext file which is easily edited. 2. When viewing the file details\r
197 before transferring the pyTivo server queries ffmpeg to make sure it is\r
198 valid. If the file is not valid it will show up as a copyrighted file\r
199 and transferring it will be prevented by TiVo.<br><br>\r
200 It is recommended that you leave precaching turned off as it is no\r
201 longer needed.\r
202 Example Settings: True/False\r
203 Available In: Shares\r
205 optres\r
207 Default Setting: False\r
208 Valid Entries: True/False\r
209 Required: No\r
210 Skill: Moderate\r
211 Description: Allows for the use of the Optimal Resolution in\r
212 transcoding. By setting optres = true pyTivo will treat the height and\r
213 width settings in the conf file as a maximum. If the video to be\r
214 transcoded has smaller dimensions that are closer to other acceptable\r
215 TiVo dimensions then pyTivo will use these dimensions. This allows for\r
216 faster transcoding and small files when the initial video is a lower\r
217 quality. pyTivo uses the same resolution as the source file on HD Tivos\r
218 for optimal transcoding efficiency. It is not necessay to to set this\r
219 option with HD TiVos unles you wish to force pyTivo to change the\r
220 resolution to an "S2 compatible" resolution.\r
221 Example Settings: True/False\r
222 Available In: Tivos, HD_tivos, SD_tivos\r
224 par\r
226 Default Setting: 1.0\r
227 Valid Entries: any valid par\r
228 Required: No\r
229 Skill: Very Advanced\r
230 Description: Set pixel aspect ratio. Applies to S3 Tivos only. OPTRES\r
231 must be false to use PAR. For some videofiles (e.g., AVC files), ffmpeg\r
232 >cannot determine the pixel aspect ratio correctly and assumes 1:1 which\r
233 leads to a distorted image on anamorphically encoded video files. This\r
234 setting allows you to override this default. If you do not understand\r
235 this setting, and you observe no distortions, you can ignore it. Set\r
236 par=1.0 to tell pyTivo to automatically adjust the pixel aspect ratio\r
237 whenever possible.<br><br>\r
238 >par=1.18518519 (32:27, usually the correct setting for wide-screen\r
239 anamorphically encoded DVD content)<br><br>\r
240 >par=0.88888889 (8:9, usually the correct setting for anamorphically\r
241 encoded DVDs from TV shows)\r
242 Example Settings: 1.0, 1.18518519, 0.88888889\r
243 Alternative option: Specify par in metadata txt files by adding\r
244 >"Override_par : x.xxxx" to a metadata file associated with the video\r
245 file.  If all files in the folder have the same par, add the option to a\r
246 file called default.txt instead of creating individual metadata files.\r
247 Available In: Server\r
249 video_fps\r
251 Default Setting: 29.97 for S2 Tivo, same as source for S3/HD TiVo\r
252 Valid Entries: 29.97, 23.98, 25, 59.94\r
253 Required: No\r
254 Skill: Advanced\r
255 Description: Sets the frame rate used by ffmpeg. pyTivo uses 29.97 for\r
256 S2's, and uses the same frame rate as the source on HD TiVos. The\r
257 default setting should work fine for most transfers.\r
258 Example Settings: 29.97, 23.98, 25, 59.94\r
259 Available In: Tivos, HD_tivos, SD_tivos\r
261 video_br\r
263 Default Setting: 4096K for SD TiVo's, 16384K for HD TiVo's\r
264 Valid Entries: Any valid Bit rate. 1024K = 1Mi\r
265 Required: No\r
266 Skill: Advanced\r
267 Description: This allows you to choose the default server video bit rate\r
268 used in transcoding. FFmpeg does not strictly follow this bit rate,\r
269 there is a certain level of tolerance that is allowed. Also a low\r
270 quality file will always have a low bit rate. The default is likely fine\r
271 for most users. Higher values may slow down transcoding and will\r
272 increase the file size. Increased file sizes take up more room on the\r
273 TiVo and take longer to transfer over the network. (Higher settings are\r
274 >recommended for screen sizes above 47" such as: video_br=20Mi, width=1920,\r
275 height=1080)\r
276 Example Settings: 4096K, 8Mi, 12Mi, 16Mi, 20Mi\r
277 Available In: Tivos, HD_tivos, SD_tivos\r
279 video_pct\r
281 Default Setting: 85 (percent of source bitrate)\r
282 Valid Entries: Any number (set this to 0 to disable this option)\r
283 Required: No\r
284 Skill: Advanced\r
285 Description: This sets video_br to a percent of the source video\r
286 bitrate.  pyTivo will multiply the source video bitrate by this\r
287 percentage setting, compare it to the video_br setting and use whichever\r
288 is greater as the video_br.  This allows for setting higher bitrates\r
289 automatically when transcoding High Definition sources.  For example, if\r
290 your source file has a bitrate of 22000k and video_pct is set to 70,\r
291 pyTivo will use 15400k for video_br instead of the default 8192k\r
292 setting.  With this setting enabled, the video_br setting essentially\r
293 becomes the minimum video bitrate.  This setting only applies to S3\r
294 tivos.\r
295 Example Settings: 60, 70, 85, 100, 125\r
296 Available In: Tivos, HD_tivos, SD_tivos\r
298 max_video_br\r
300 Default Setting: 30000k\r
301 Valid Entries: Any valid Bit rate. 1024K = 1Mi\r
302 Required: No\r
303 Skill: Advanced\r
304 Description: This allows you to choose the maximum bit rate and is more\r
305 strict than the video_br setting above. However setting this can cause\r
306 buffer overflows and can cause issues with ffmpeg. In addition to\r
307 setting the ffmpeg maxrate option, this setting is used to determine if\r
308 the video bitrate of the source video file is too high for the TiVo.\r
309 Otherwise compatible mpeg's with a video bitrate above this setting will\r
310 be transcoded rather than sent to the TiVo untouched.  Lower this\r
311 setting below the bitrate of your source file if you wish to force high\r
312 bitrate sources to be transcoded.  Recommended only for skilled users.\r
313 Note: there is a report that ffmpeg throws an error with 17Mi but\r
314 accepts 17408K just fine.\r
315 Example Settings: 17408k, 30000k\r
316 Available In: Tivos, HD_tivos, SD_tivos\r
318 bufsize\r
320 Default Setting: 1024k for S2, 4096k for S3\r
321 Valid Entries: Any valid byte size\r
322 Required: No\r
323 Skill: Very Advanced\r
324 Description: Allows you to set the buffer size used by ffmpeg.\r
325 Increasing this setting will allow higher bitrates during transcoding\r
326 (see video_br setting), especially when transcoding to HD resolutions.\r
327 But it may result in pixelation or audio sync issues with some sources.\r
328 1024k is fine for the resolutions used by S2 tivos.  But 2048k or 4096k\r
329 is preferred for HD tivos.  Leave this setting blank unless you are\r
330 experiencing audio/video sync issues and wish to test a different value.\r
331 Example Settings: 1024k, 2048k, 4096k\r
332 Available In: Tivos, HD_tivos, SD_tivos\r
334 width\r
336 Default Setting: 544 for S2, 1920 for S3\r
337 Valid Entries: Any valid pixel dimension. Setting will be rounded to\r
338 nearest acceptable TiVo dimension.\r
339 Required: No\r
340 Skill: Moderate\r
341 Description: Allows you to choose the output dimension of the transcoded\r
342 videos. SD units are limited to 720 and below. Likely HD users will want\r
343 to choose a higher value. Higher values may slow down transcoding and\r
344 will increase the file size. Increased file sizes take up more room on\r
345 the TiVo and take longer to transfer over the network.\r
346 Example Settings: 1920, 1440, 1280, 720, 704, 544, 480, 352.\r
347 Available In: Tivos, HD_tivos, SD_tivos\r
349 height\r
351 Default Setting: 480 for S2, 1080 for S3\r
352 Valid Entries: Any valid pixel dimension. Setting will be rounded to\r
353 nearest acceptable TiVo dimension\r
354 Required: No\r
355 Skill: Moderate\r
356 Description: Allows you to choose the output dimension of the transcoded\r
357 videos. SD units are limited to 480 and below. Likely HD users will want\r
358 to choose a higher value. Higher values may slow down transcoding and\r
359 will increase the file size. Increased file sizes take up more room on\r
360 the TiVo and take longer to transfer over the network.\r
361 Example Settings: 1080, 720, 480\r
362 Available In: Tivos, HD_tivos, SD_tivos\r
364 audio_br\r
366 Default Setting: same bitrate as source or 448k\r
367 Valid Entries: Any valid bitrate up to 448k\r
368 Required: No\r
369 Skill: Advanced\r
370 Description: This allows you to choose the default audio bit rate used\r
371 for transcoding. The default is likely fine for most users. 384k is the\r
372 minimum recommended for ac3 audio. For S2 Tivos, you may want to lower\r
373 this setting to 192k and set audio_ch=2 to slightly reduce the file\r
374 size. See audio_codec for more info.\r
375 Example Settings: 192K, 384K, 448K.\r
376 Available In: Tivos, HD_tivos, SD_tivos\r
378 max_audio_br\r
380 Default Setting: 448k\r
381 Valid Entries: Any valid bitrate\r
382 Required: No\r
383 Skill: Advanced\r
384 Description: This sets the maximum audio bit rate that can be sent to\r
385 the TiVo. Files having a higher bit rate will be transcoded to ensure\r
386 TiVo compatibility.\r
387 Example Settings: 384K, 448K\r
388 Available In: Tivos, HD_tivos, SD_tivos\r
390 audio_fr\r
392 Default Setting: same frequency as source\r
393 Valid Entries: 44100, 48000\r
394 Required: No\r
395 Skill: Advanced\r
396 Description: Sets the audio sampling frequency. Defaults to frequency of\r
397 the source file for better audio sync if it is 44100 or 48000. Otherwise\r
398 48000 is used.\r
399 Example Settings: 44100, 48000\r
400 Available In: Tivos, HD_tivos, SD_tivos\r
402 audio_ch\r
404 Default Setting: same channels as source\r
405 Valid Entries: any number compatible with ffmpeg and the audio codec selected\r
406 Required: No\r
407 Skill: Advanced\r
408 Description: Sets the number of audio channels used by ffmpeg. ffmpeg\r
409 will retain the same number of channels as the source file by default.\r
410 The default setting should work fine for most transfers unless the\r
411 default audio_codec is changed. Change this setting to 2 if you do not\r
412 want to retain 5.1 audio. A bug in ffmpeg will sometimes move the center\r
413 audio channel to the left or right speaker. Setting this option to 2, on\r
414 an as needed basis, or permanently, will correct this at the loss of 5.1\r
415 audio. But this should only be necessary on rare occasions where the\r
416 source file is an mkv or xvid with ac3 5.1 audio bitrate above 448k.\r
417 Example Settings: 2, 6\r
418 Available In: Tivos, HD_tivos, SD_tivos\r
420 audio_codec\r
422 Default Setting: ac3 or copy\r
423 Valid Entries: mp2, ac3\r
424 Required: No\r
425 Skill: Advanced\r
426 Description: Sets the audio codec used by ffmpeg during transcoding.\r
427 pyTivo defaults to ac3 in order to retain 5.1 audio should the source\r
428 contain it. pyTivo also checks the audio codec and bitrate of the source\r
429 and uses '-acodec copy' if it is compatible. Otherwise the Default\r
430 Setting is used. Specifying an audio codec will disable these features\r
431 and pyTivo will re-encode all audio using the codec specified.<br><br>\r
432 Allowing pyTivo to select '-acodec copy' whenever possible will\r
433 generally produce the best results. This is meant to eliminate garbled\r
434 audio during transcoding when the source contains audio glitches that\r
435 cause ffmpeg to lose synchronization. This will also prevent the center\r
436 audio channel from being moved to the right front speaker by ffmpeg when\r
437 transferring mkv's and xvid's with audio bitrate of 448k or\r
438 less.<br><br>\r
439 You may want to change this setting to mp2 if you only have an S2, or\r
440 have specified a per tivo section for an S2, and do not wish to retain\r
441 5.1 audio for possible transfer to an S3 Tivo or back to the PC should\r
442 the need arise. This will slightly reduce the amount of disk space used\r
443 and allow for more recordings on an S2 Tivo. In this case, you will want\r
444 to specify audio_codec=mp2, audio_ch=2, and audio_br=192k. These are the\r
445 settings normally used by the S2 for recordings.\r
446 Example Settings: mp2, ac3\r
447 Available In: Tivos, HD_tivos, SD_tivos\r
449 audio_lang\r
451 Recommended Setting: 5.1, DTS, en  (entire string including commas)\r
452 pyTivo Defaults To: first audio stream\r
453 Valid Entries: any language tag or audio stream number reported by ffmpeg\r
454 Required: No\r
455 Skill: Basic\r
456 Description: Sets the preferred language track used by pyTivo.\r
457 ffmpeg/pytivo defaults to the first audio stream.  Specifying this\r
458 parameter, tells pyTivo to use the first audio stream that matches this\r
459 entry if more than one audio stream exists.  If your video source does\r
460 not have language tags, you may specify the audio stream number reported\r
461 by ffmpeg (ie. 0.1, 0.2 ect.). Stream references like 0x80, 0x81, etc.\r
462 may also be specified.  pyTivo will transcode the file if necessary to\r
463 obtain the preferred language track.<br><br>\r
464 You can also assign new language tags to your files by adding Override\r
465 lines to your metadata txt files.  This will enable pytivo to detect\r
466 your audio language setting in files that do not contain language tags.\r
467 The syntax is<br>\r
468 Override_mapAudio 0.1 colon eng (replace the word colon with a colon)<br>\r
469 Where 0.1 is the audio stream number reported by ffmpeg and eng is the\r
470 new audio tag to assign to that stream.  Add a separate Override line\r
471 for each audio stream that you want to replace with a new tag.\r
472 Example Settings: eng, ger, spa, en, ge, 0.0, 0.1, 0.2, 0x80, 0x81 etc...\r
473 Available In: Tivos, HD_tivos, SD_tivos\r
475 copy_ts\r
477 Default Setting: True\r
478 Valid Entries: True/False\r
479 Required: No\r
480 Skill: Basic\r
481 Description: Adds the copy timestamps setting (-copyts) to the ffmpeg\r
482 command.  This setting helps correct audio synchronization problems that\r
483 commonly occur during transcoding.  You can leave this field blank\r
484 unless you wish to disable it. pyTivo defaults to True except when\r
485 pyTivo uses acodec copy, in which case copyts is not needed, and a\r
486 conflict could also occur if the source file has really corrupt\r
487 sections.\r
488 Example Settings: True, False\r
489 Available In: Tivos, HD_tivos, SD_tivos\r
491 ffmpeg_pram\r
493 Default Setting: blank\r
494 Valid Entries: A valid ffmpeg command\r
495 Required: No\r
496 Skill: Very Advanced\r
497 Description: This allows you to append additional raw ffmpeg commands to\r
498 the ffmpeg template. For example, you would enter '-threads 2' here if\r
499 you have multiple processors and want ffmpeg to use both processors to\r
500 speed up transcoding.\r
501 Example Settings: -threads 2\r
502 Available In: Server, Tivos, HD_tivos, SD_tivos\r
504 ffmpeg_tmpl\r
506 Default Setting: %(video_codec)s %(video_fps)s %(video_br)s\r
507 %(max_video_br)s %(buff_size)s %(aspect_ratio)s\r
508 %(audio_br)s %(audio_fr)s %(audio_ch)s %(audio_codec)s %(audio_lang)s\r
509 %(ffmpeg_pram)s %(format)s\r
510 Valid Entries: A valid ffmpeg command\r
511 Required: No\r
512 Skill: Very Advanced\r
513 Description: This is a template used by pyTivo to control the parameters\r
514 passed to ffmpeg. It should not be necessary to modify this template\r
515 unless there is a particular parameter you do not wish ffmpeg to use and\r
516 it cannot be overridden by specifying that parameter in the pyTivo.conf\r
517 file.\r
518 Example Settings: See Above and the forum.\r
519 Available In: Server, Tivos, HD_tivos, SD_tivos\r
521 aspect169\r
523 Default Setting: True\r
524 Valid Entries: True/False\r
525 Required: No\r
526 Skill: Moderate\r
527 Description: Most TiVos, even S2, can handle 16:9 videos perfectly. Some\r
528 >S2s are known not to handle 16:9 and will default to false in this\r
529 setting. If you are experiencing major distortion you can try setting\r
530 this to false. Likely most users will not have to mess with this.\r
531 Example Settings: True/False\r
532 Available In: Tivos\r
534 shares\r
536 Default Setting: Blank, which is equivalent to allow all shares on this TiVo.\r
537 Valid Entries: The names of any shares in your pyTivo.conf file, in a\r
538 comma-separated list.\r
539 Required: No\r
540 Skill: Easy\r
541 Description: Only the shares listed in this setting will be visible on\r
542 this TiVo. Will ignore invalid shares. If no valid shares are listed or\r
543 the setting does not exist, all shares will be visible on this TiVo.\r
544 Example Settings: Movies, Kids Stuff\r
545 Available In: Tivos\r
547 ffmpeg_wait\r
549 Default Setting: 10 (seconds)\r
550 Valid Entries: any integer\r
551 Required: No\r
552 Skill: Advanced\r
553 Description: Slow computers or NAS servers may result in pytivo\r
554 reporting supported videos as not supported (copy protected).\r
555 Increasing this setting will give ffmpeg more time to scan the file.\r
556 Example Settings: 10, 15, 20.\r
557 Available In: Server\r
559 tivo_username\r
561 Default Setting: blank\r
562 Valid Entries: tivo.com username\r
563 Required: No\r
564 Skill: Basic\r
565 Description: Your username (email address) at tivo.com. This is required \r
566 for the "Push" feature. If you don't plan to use Push, you don't need to \r
567 set this.\r
568 Example Settings: user@example.com\r
569 Available In: Server\r
571 tivo_password\r
573 Default Setting: blank\r
574 Valid Entries: tivo.com password\r
575 Required: No\r
576 Skill: Basic\r
577 Description: Your password at tivo.com. This is required for the "Push" \r
578 feature. If you don't plan to use Push, you don't need to set this.\r
579 Example Settings: password\r
580 Available In: Server\r
582 tivo_mak\r
584 Default Setting: blank\r
585 Valid Entries: Your Media Access Key\r
586 Required: No\r
587 Skill: Basic\r
588 Description: Your Media Access Key -- find it on your TiVo under \r
589 Messages and Settings, Account and System information, Media Access Key. \r
590 This is required for the "ToGo" feature, and for anything that uses \r
591 tivodecode (pushing .TiVo files, transcoding HD .TiVo files to SD \r
592 TiVos). If you don't plan to use these features, you don't need to set \r
593 this.\r
594 Example Settings: 012345678\r
595 Available In: Server\r