home *** CD-ROM | disk | FTP | other *** search
/ Australian Personal Computer 2004 September / APC0409D1.iso / powerkit / homethea / files / DW070.exe / docs / Functions.txt < prev    next >
Encoding:
Text File  |  2004-04-12  |  5.1 KB  |  141 lines
  1. ----------------------
  2. DigitalWatch Functions
  3. ----------------------
  4.  
  5. These are the predefined functions that you can assign to keys, mouse-clicks,
  6. control bar buttons, and channels.
  7. If you assign a function that is not one of these then DigitalWatch will
  8. look in osd.ini for an event of the same name to trigger.
  9.  
  10. Channel functions have no effect in channels.ini
  11.  
  12.  
  13. SetChannel(int network, int program = -1)
  14.     network - A network number from the channels.ini file.
  15.     program - A program number from the channels.ini file or,
  16.               -1 for the default program of the network.
  17.               -2 for the next program in the network if not changing network.
  18.                  otherwise selects the default program of the network.
  19.  
  20. ManualChannel(int frequency, int vpid, int apid)
  21.     frequency - tune to this frequency
  22.     vpid      - use this video PID
  23.     apid      - use this audio PID. prefix with A for ac3
  24.     This is primarily for use by external programs like WebSchedulerMod.
  25.  
  26. NetworkUp() - Changes to the next network and uses the default program.
  27.  
  28. NetworkDown() - Changes to the previsous network and uses the default program.
  29.  
  30. ProgramUp() - Changes to the next program of the current network.
  31.  
  32. ProgramDown() - Changes to the previous program of the current network.
  33.  
  34. LastChannel() - Changes to the network and program selected prior to the
  35.                 current one.
  36.  
  37. TVPlaying(int playing)
  38.     playing - 0 to turn off live viewing (also pauses timeshifting)
  39.               1 to turn on live viewing (also resumes timeshifting)
  40.               2 to toggle on/off (also pauses/resumes timeshifting)
  41.  
  42. Recording(int recording, string filename)
  43.     recording - 0 to Stop
  44.                 1 to Start
  45.                 2 to Toggle
  46.     filename  - (optional) full path and filename of destination file
  47.                 if this is omitted then settings.ini will be used to name the file
  48.  
  49. RecordingTimer(int minutes)
  50.     minutes - adds a number of minutes to the timer to stop recording.
  51.               If called when not recording then it's the same as Recording(1)
  52.  
  53. VolumeUp(int percentage)
  54.     percentage - increase volume by this percentage.
  55.  
  56. VolumeDown(int percentage)
  57.     percentage - decrease volume by this percentage.
  58.  
  59. SetVolume(int percentage)
  60.     percentage - set the volume to this percentage. 100% is the default.
  61.  
  62. Mute(int mute)
  63.     mute - 0 for off
  64.            1 for on
  65.            2 for toggle
  66.  
  67. VideoDecoderEntry(int index)
  68.     index - choose 0 to use automatic video graph building
  69.             choose 1+ to choose an entry from the VideoDecoders.ini file
  70.             choose -1 to cycle through entries.
  71.  
  72. AudioDecoderEntry(int nIndex)
  73.     index - choose 0 to use automatic audio graph building
  74.             choose 1+ to choose an entry from the AudioDecoders.ini file
  75.             choose -1 to cycle through entries.
  76.  
  77. ResolutionEntry(int nIndex)
  78.     index = choose 0 to resize to the default size
  79.             choose 1+ to choose an entry from the Resolutions.ini file
  80.             choose -1 to cycle through entries.
  81.  
  82. Resolution(int left, int top, int width, int height, int move, int resize)
  83.     left, top     - the new upper left corner of the window.
  84.     width, height - the new width and height of the video area.
  85.     move   - if non-zero moves the window to the left, top position
  86.     resize - if non-zero resizes the window to be width by height
  87.  
  88. SetColorControls(int brightness, int contrast, int hue, int saturation, int gamma)
  89.     brightness - value from    0 to 10000. default 750
  90.     contrast   - value from    0 to 20000. default 10000
  91.     hue        - value from -180 to   180. default 0
  92.     saturation - value from    0 to 20000. default 10000
  93.     gamma      - value from    1 to   500. default 1
  94.  
  95. AlwaysOnTop(int alwaysOnTop)
  96.     alwaysOnTop - 0 for off
  97.                   1 for on
  98.                   2 for toggle
  99.  
  100. Fullscreen(int fullscreen)
  101.     fullscreen - 0 for off
  102.                  1 for on
  103.                  2 for toggle
  104.  
  105. Zoom(int percentage)
  106.     percentage - zoom factor. (see ZoomMode for value meanings)
  107.  
  108. ZoomIn(int percentage)
  109.     percentage - value to add to the zoom factor
  110.  
  111. ZoomOut(int percentage)
  112.     percentage - value to subtract from the zoom factor
  113.  
  114. ZoomMode(int mode)
  115.     mode - if  0, then 100% zoom fits all the video in the window
  116.            if  1, then 100% zoom makes the video the full height of the window (center-cut)
  117.            if -1, then cycles through modes.
  118.  
  119. AspectRatio(int width, int height)
  120.     width  - value greater than 0. (eg. 4)
  121.     height - value greater than 0. (eg. 3)
  122.  
  123. ShowFilterProperties() - Shows the properties dialogs for each filter
  124.  
  125. TimeShift(int mode)
  126.     mode - 0 for pause
  127.            1 for play
  128.            2 for toggle
  129.  
  130. TimeShiftJump(int seconds)
  131.     seconds - The number of seconds to jump.
  132.               Can be negative to jump backwards
  133.  
  134. Key(int keycode, int shift, int ctrl, int alt)
  135.     keycode - keycode of key, or key inside single quotes. eg. 'T'
  136.     shift   - non-zero means shift is down
  137.     ctrl    - non-zero means ctrl is down
  138.     alt     - non-zero means alt is down
  139.  
  140. Exit()
  141.