VDJPedia



 Skin SDK Textzone

Back to Skin SDK

Skin SDK: The <textzone> element



The syntax of the textzone element is <textzone deck="" resetcounter="" panel="" action"">.
Properties:
  • deck can take its value between "1", "2", "left", "right", "leftvideo", "rightvideo", "default" (default), or "active".
  • resetcounter : if set to "true", the counter will be reset if this textzone is clicked
  • panel can put the textzone into a specific panel
  • action textzone can not also be any VDJScript action
  • os : use os="mac" or os="pc" if you need to display the element only when VirtualDJ is running on Window or Mac Do not include os="" if you want the element to be displayed on both platforms.

Children:
  • <size width="" height=""> : Give the width and height of the textzone
  • <pos x="" y=""> : Give the position of the textzone on the screen
  • <text font="" weight="" size="" color="" align="" format="" or action=""> : Specify the text to be displayed with these properties:
    • font : select the font to be used (default: arial)
    • weight : possible values: "normal" (default) or "bold"
    • size : give the font size (default: 12)
    • color : give the font color (default: white). The color can be written in numerical format (#0000FF) or with the color name ("blue")
    • align : possible values: "left", "right", "center" (or "middle")
    • format : this string defines what will be written using %..... (see the exact format below)
    • action : this string defines what will be written but using VDJ script "get...."
    • scroll : if set to "yes", the text will scroll if it can't fit in the box
  • <text2 font="" weight="" size="" color="" align="" format="" or action=""> : Specify an alternate text to be displayed if the user clicks on the textzone.
  • <text3>, <text4>, <text5> : Same as text2 (the display will cycle through the defined text each time the user clicks the textzone).
New in VDJ8 is action instead of format. You can still use format in exactly the same way as in V7 (explained next) but with action you can just write the VDJ Script in without the ` ` marks. So action="get loaded_song 'Title'" is the same as format="%title".
The format is a string that describes how the text will be displayed. You can still use a VDJ Script action with backward single quotes `` for example format="`get sample_slot_name X`" which displays the name of the sample in slot X, or you can use one of the special textzone commands:
  • \\: print a single \ character
  • \n : print a line feed
  • \r : print a carriage return
  • \t : print a tab character
  • \x : print the ascii character xx
  • %% : print a single % character
  • %yy : goto to the yy line
  • %xx,yy : goto to the xx,yy position
  • %title : print the song's title
  • %author : print the song's author
  • %comment : print the song's comment if any
  • %fullhour : display the time in a hh:mm:ss format
  • %hour : display the time in a hh:mm format
  • %hour12 : display the time in a h:mm am/pm format
  • %counter : display a counter
  • %pitch : print the pitch value
  • %time : print the length of the song (can use modifiers - see below)
  • %spent : print the spent time of the song (can use modifiers)
  • %left : print the left time of the song (can use modifiers)
  • %cueX : print the time position of the Xth cue point (can use modifiers)
  • %tocueX : print the time to the Xth cue point (can use modifiers)
  • %fromcueX : print the time elapsed from the Xth cue point (can use modifiers)
  • %start : print the time position of the first beat (can use modifiers)
  • %end : print the time position of the last beat (can use modifiers)
  • %tostart : print the time to the first beat (can use modifiers)
  • %toend : print the time to the last beat (can use modifiers)
  • %fromstart : print the time elapsed from the first beat (can use modifiers)
  • %fromend : print the time elapsed from the last beat (can use modifiers)
  • %bpm : print the bpm of the song (can use modifiers)
  • %bpmex : print the bpm of the song (can use modifiers)
  • %bpmexx : print the bpm of the song (can use modifiers)
  • %level : print the song's level in dB (can use modifiers)
  • %key : print the song's key
  • %camelot : print the song's key (numeric)
  • %keyoffset
  • %cpu
  • %status
  • %maineffect
  • %effectslotX
  • %mainsample
  • %videofx
  • %videotransition
  • %linkedvideo
  • %loop
  • %name
  • %namecueX
  • %pitchrange
  • %djc_buttonX
    New
  • %nextcue : print the time of the next cue point
  • %prevcue : print the time of the last cue point
  • %nextcuename : print the name of the next cue point
  • %prevcuename : print the name of the last cue point

Some of the % commands can be used with modifiers. Modifiers are capitalized letters you insert between the % and the command. You can use:
  • P : modify the value to reflect the pitch change
  • L : use the local value instead of the global value (only used by %level)
  • B : display the value as a number of beat instead of a time





Back to Skin SDK