Properties
CONSTANT |
VALUE DESCRIPTION |
|
STRETCH_MODE |
0 |
The movie loaded in the video object will stretch to fill the entire region of the video object (the aspect ratio of the movie will match the aspect ratio of the video object). |
MAINTAIN_ASPECT |
1 |
The movie loaded will maintain it's aspect ratio regardless of the aspect ratio of the video object. |
CONSTANT |
VALUE DESCRIPTION |
|
CONTROL_PANEL_NONE |
0 |
The video object will have no control panel. |
CONTROL_PANEL_STANDARD |
1 |
The standard control panel will be shown. |
CONTROL_PANEL_CUSTOM |
2 |
A custom 'skin' will be applied to the standard control panel. |
(table) A table containing the video object's properties indexed by the following keys:
KEY |
TYPE DESCRIPTION |
|
VideoFile |
string |
The movie file to load into the video object. |
MaskFile |
string |
The path of the image to be used as the object mask. |
ApplyCustomMask |
boolean |
True if a mask file should be used, false if it should not be. |
ScalingMode |
number |
How the movie should 'fit' inside the video object: |
CPStyle |
number |
How the control panel should appear: |
CONSTANT |
VALUE DESCRIPTION |
|
TIME_NONE |
0 |
No time display will be shown. |
TIME_ELAPSED |
1 |
The time elapsed will be displayed. |
TIME_LENGTH |
2 |
The length of the movie loaded will be displayed. |
TIME_BOTH |
3 |
Both the time elapsed and the movie length will be displayed. |
SkinFile |
string |
The path to the skin file to be used if CPStyle is set to CONTROL_PANEL_CUSTOM. |
CPTime |
number |
How the time information should be displayed on the control panel: |
PanelColor |
number |
The color of the control panel. |
TextColor |
number |
The color of the text (e.g. displayed time) displayed on the control panel. |
ControlButtons |
boolean |
True if buttons should be displayed on the control panel, false if it should not be. |
Slider |
boolean |
True if a slider should be displayed on the control panel, false if it should not be. |
AutoStart |
boolean |
True if the video object should automatically play the loaded movie as soon as the page or dialog is shown, false if it should not. |
Loop |
boolean |
True if the movie should restart when it ends, false if it should not. |
Border |
boolean |
True if a border should be shown around the video object, false if one should not be shown. |
Enabled |
boolean |
True if the video object should be enabled, false if it should not be. |
Visible |
boolean |
True if the video object should be visible, false if it should not be. |
X |
number |
The horizontal position (in pixels) of the top left corner of the |
video object in relation to the current page or dialog. Note: The top left corner of the current page or dialog has an X value of 0 |
||||||
Y |
number |
The vertical position (in pixels) of the top left corner of the video object in relation to the current page or dialog. Note: The top left corner of the current page or dialog has a Y value of 0 |
||||
Width |
number |
The width (in pixels) of the video object. |
||||
Height |
number |
The height (in pixels) of the video object. |
||||
Cursor |
number |
The mouse cursor that should be displayed when the mouse is over the video object: |
||||
CONSTANT |
VALUE DESCRIPTION |
|||||
CURSOR_ARROW |
0 |
Standard mouse |
||||
CURSOR_HAND |
1 |
Hand cursor. |
||||
CURSOR_BLACK_ARROW |
2 |
Black arrow cursor. |
||||
CURSOR_CROSSHAIR |
3 |
Crosshair cursor. |
||||
CURSOR_EXPLORE |
4 |
Explore cursor. |
||||
CURSOR_HELP |
5 |
Help cursor. |
||||
CURSOR_MAGNIFY |
6 |
Magnify cursor. |
||||
CURSOR_MEDIA |
7 |
Media cursor. |
||||
CURSOR_MONEY |
8 |
Money cursor. |
||||
CURSOR_NOTEPAD |
9 |
Notepad cursor. |
||||
CURSOR_PENCIL |
10 |
Pencil cursor. |
||||
CURSOR_PRINTER |
11 |
Printer cursor. |
||||
CURSOR_SPEAKER |
12 |
Speaker cursor. |
||||
CONSTANT |
VALUE DESCRIPTION |
|
SND_NONE |
0 |
No click sound. |
SND_STANDARD |
1 |
Standard click sound. |
SND_CUSTOM |
2 |
Custom click sound. |
CONSTANT |
VALUE DESCRIPTION |
|
SND_NONE |
0 |
No highlight sound. |
SND_STANDARD |
1 |
Standard highlight sound. |
SND_CUSTOM |
2 |
Custom highlight sound. |
CURSOR_SPEAKER |
12 |
Speaker cursor. |
CURSOR_UP_ARROW |
13 |
Up arrow cursor. |
ResizeLeft |
boolean |
True if the left side of the object should move when the application is resized, false if it should not. |
ResizeRight |
boolean |
True if the right side of the object should move when the application is resized, false if it should not. |
ResizeTop |
boolean |
True if the top of the object should move when the application is resized, false if it should not. |
ResizeBottom |
boolean |
True if the bottom of the object should move when the application is resized, false if it should not. |
HighlightSound |
number |
The type of sound that should be played when the mouse moves over the video object. |
HighlightSoundFile |
string |
The path to the video object's custom highlight sound file if it uses one. |
ClickSound |
number |
The type of sound that should be played when the mouse clicks the video object. |
ClickSoundFile |
string |
The path to the video object's custom click sound file if it uses one. |
Re t u r n s
Nothing. You can use Application.GetLastError to determine whether this action failed, and why.
See also: Related Actions
Video.SetSize
OverviewExamples
Video.SetSize ( string ObjectName,
number Width,
number Height )
De s cr ip t ion
Sets the size of a video object.
P arame t er s
ObjectName
(string) The name of the video object.