ResultVariable
When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.
See also: Related Actions
Video.GetProperties
OverviewExamples
table Video.GetProperties ( string ObjectName )
De s cr ip t ion
Returns a table containing the properties of a video object.
P arame t er s
ObjectName
(string) The name of the video object.
Re t u r n s
(table) A table containing the video's properties, indexed by the following keys:
|
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. |
|
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. |
|
KEY |
TYPE DESCRIPTION |
|
|
ObjectName |
string |
The name of the video object. |
|
VideoFile |
string |
The currently loaded video file. |
|
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 will 'fit' inside the video object: |
|
CPStyle |
number |
How the control panel will appear: |
|
SkinFile |
string |
The path to the skin file to be used if CPStyle is set to |
|
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. |
|
CONTROL_PANEL_CUSTOM. |
||
|
CPTime |
number |
How the time information will 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 will be displayed on the control panel, false if it will not be. |
|
Slider |
boolean |
True if a slider will be displayed on the control panel, false if it will not be. |
|
AutoStart |
boolean |
True if the video object will automatically play the loaded movie as soon as the page or dialog is shown, false if it will not. |
|
Loop |
boolean |
True if the movie will restart when it ends, false if it will not. |
|
Border |
boolean |
True if a border will be shown around the video object, false if one will not be shown. |
|
Enabled |
boolean |
True if the video object is enabled, false if it is not. |
|
Visible |
boolean |
True if the video object is visible, false if it is not. |
|
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 |
|
CONSTANT |
VALUE DESCRIPTION |
|
|
CURSOR_ARROW |
0 |
Standard mouse arrow cursor. |
|
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. |
|
CURSOR_UP_ARROW |
13 |
Up arrow cursor. |
|
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 will be displayed when the mouse is over the video object: |
|
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. |
|
ResizeLeft |
boolean |
True if the left side of the object will move when the application is resized, false if it is not. |
|
ResizeRight |
boolean |
True if the right side of the object will move when the application is resized, false if it is not. |
|
ResizeTop |
boolean |
True if the top of the object will move when the application is resized, false if it is not. |
|
ResizeBottom |
boolean |
True if the bottom of the object will move when the application is resized, false if it is not. |
|
HighlightSound |
number |
The type of sound that will be played when the mouse moves over the video object. |
|
HighlightSoundFile |
string |
The path to the video object's custom highlight sound file. If the video object does not use a custom sound, this value will be an empty string (""). |
|
ClickSound |
number |
The type of sound that will be played when the mouse clicks the video object. |
|
ClickSoundFile |
string |
The path to the video object's custom click sound file. If the video object does not use a custom sound, this value will be an empty string (""). |
|
WindowHandle |
number |
The integer value that represents the object's window. (Commonly referred to as an hWnd.) |
If the object cannot be found, nil will be returned. You can use Application.GetLastError to determine whether this action failed, and why.