=====ViewMedia=====

====Summary====

This script command allows you to display an image or playback a movie using the ARDI Interface.
====Parameters====

===Media===

//Type: Path
Default: None//

This is the name of the image or movie file to be viewed. The media file must be placed in the proper folder location as defined by the ARDI VE System.

The default location is:

**C:\users\<username>\documents\Optrix\ARDI\<scene name>\scripts**

Where <username> is your windows username and <scene name> is the name of the scene being loaded from within ARDI VE.

===WaitForClick===

//Type: [[bool]]
Default: **True**//

If this parameter is set to true, the interface will wait for the user to click before showing the media.

===LoopPlay===

//Type: [[bool]]
Default: **True**//

If this parameter is set to true, the chosen movie media will be played in a loop until the user stops playback manually.

===Caption===

//Type: Text
Default: **Observe the image**//

This text will be shown in a caption below the viewed media. Any descriptive comments about the chosen media should be specified here.

====Examples====

<code>

<viewmedia media="mymovie.mp4" />

</code>

> The above code will find the movie file named **mymovie.mp4** and play it on a loop.

<code>

<viewmedia media="mymovie.mp4" loopplay="false" waitforclick="false" />

</code>

> The above code will find the movie file named **mymovie.mp4** and play it immediately without waiting for the user to click. It will play it once and once only.

<code>

<viewmedia media="myimage.png" />

</code>

> The above code will display the image file called **myimage.png**.


====See Also====
[[addimage]] [[removeimage]]