<doc>
	<legacy_id></legacy_id>
	<name>play video</name>
	<type>command</type>

	<syntax>
		<example>play video (<i>video-file</i> | <i>video-url</i>)</example>
	</syntax>

	<synonyms>
	</synonyms>

	<summary>Plays a full screen video.</summary>

	<examples>
<example>play video myVideoFile</example>
<example><p>put specialFolderPath("engine) &amp; "/intro_movie.mp4" into tVideoFile</p><p>play video tVideoFile</p></example>
<example><p>play video "http://www.runrev.com/buildanapp.mp4"</p></example>
	</examples>

	<history>
		<introduced version="4.5.2">Added. </introduced>
		<deprecated version=""></deprecated>
		<removed version=""></removed>
		
		<experimental version=""></experimental>
		<nonexperimental version=""></nonexperimental>
	</history>

	<objects>
	</objects>

	<platforms>
		<ios/>
		<android/>
	</platforms>

	<classes>
		<mobile/>
	</classes>

	<security>
	</security>


	<classification>
		<category>Images  Multimedia</category>
	</classification>

	<references>
		<command tag="play">play Command</command>
		<message tag="movieTouched">movieTouched Message</message>
	</references>

	<description>
	<overview>Use the <b>play video</b> command to play a full screen video.</overview>

		<parameters>
  <parameter>
    <name>video-file</name>
    <description>If a path is specified it will be interpreted as a local file. If a URL is specified then it must either be an 'http' or 'https' url. In this case the content will be streamed.</description>
  </parameter>		</parameters>

	<value>The <b>play video</b> command will not return until it is complete or the user dismisses it.</value>
	<comments>The playback uses iOS's built-in video playback support (MPMoviePlayer), and as such can use any video file supported by MPMoviePlayer, including MP4s.<p></p><p>On iOS 3.1.3 the video always plays with landscape orientation. On iOS 3.2 and later the orientation of the video is tied to the current interface orientation.</p><p></p><p>Appearance of the controller is tied to the <property tag="showController">showController</property> property of the <keyword tag="templatePlayer">templatePlayer</keyword>. Changing this property to true or false will cause the controller to be shown or hidden.</p><p></p><p>When a movie is played without a controller any touch on the screen results in a <message tag="movieTouched">movieTouched</message> message being sent to the object whose script started the video. The principal purpose of this message is to allow the <command tag="play">play stop</command> command to be used.</p><p></p><p></p><p></p><note> The <message tag="movieTouched">movieTouched</message> message is not sent if the video is playing with <property tag="showController">showController</property> set to true.</note><p></p><p>Playing a video can be made to loop by setting the <property tag="looping">looping</property> property of the <keyword tag="templatePlayer">templatePlayer</keyword> to true before executing the <b>play video</b> command. Looping a video is only supported on iOS 3.2 and later.</p><p></p><p>A section of a video can be played by setting the <property tag="playSelection">playSelection</property> property of the <keyword tag="templatePlayer">templatePlayer</keyword> to true before executing the play video command. This will use the <property tag="startTime">startTime</property> and <property tag="endTime">endTime</property> properties of the <keyword tag="templatePlayer">templatePlayer</keyword> to determine what section to play. The values of these properties are interpreted as the number of milliseconds from the beginning of the video. </p></comments>
	</description>
</doc>