<auto_clear>

Determines whether a video defined in <media_overlay> clears automatically after it has ended or whether it must be cleared explicitly using <file>CLEAR</file>.

Accepted values are YES and NO.

Default value: YES

Child of: <media_overlay>

Parent of: Nothing

Example:

<auto_clear>NO</auto_clear>

<background_color>

The background color for the popup playback bar for a video, represented by a hexadecimal code preceded by 0x.

To find the hexadecimal code for the color you want, use a color picker such as this one.

Child of: <popup>

Parent of: Nothing

See also: <background_opacity>

Example:

<background_color>0xDDDDDD</background_color>

<background_opacity>

TK

The value must be between 0 (transparent) and 1 (opaque).

Child of: <popup>

Parent of: Nothing

Example:

<background_opacity>.5</background_opacity>

<bar>

A progress bar indicating the current playback location of a video, defined within <video_defaults>.

Child of: <video_defaults>

Parent of: <x>, <y>, <height>, <width>, <edge>, <fill_color>, <file>

See also: <popup>, <slider>

Example:

<bar>

            <x>10</x>

            <y>220</y>

            <height>26</height>

            <width>280</width>

            <edge>4</edge>

            <fill_color>0x6BA668</fill_color>

            <file>http://www.my_site.com/my_progress_bar.png</file>

</bar>

<current_time_color>

The color of the current time (elapsed time) in a video playback popup.

Child of: <popup>

Parent of: Nothing

See also: <total_time_color>

Example:

<current_time_color>#5A5A5A</current_time_color>

<custom_event>

The number of seconds from the start of media playback when the application will advance to the node specified in <media_custom_event node=""/>.

Multiple <custom_event> tags may be defined within a <media> tag. They will be executed in succession and will look for a <media_custom_event node=""/> that is defined in the current node at that point in time.

The value may contain a decimal.

Child of: <media>

Parent of: Nothing

See also: <media_custom_event node=""/>

Example:

<custom_event>7</custom_event>

Working example: Search for <custom_event>...</custom_event> in the file trivia_demo.xml.

<custom_event_polling_time>

Allows the developer to set how often the application will poll a video playback to determine more precisely when a custom event should be executed (see <custom_event>).

The value is in milliseconds.

Note that the more often the polling takes place, the more strain is placed on the end user's machine.

Default value: 250

Child of: <settings>

Parent of: Nothing

Example:

<custom_event_polling_time>100</custom_event_polling_time>

<edge>

The number of pixels of padding on the left and right of a video bar to accommodate the slider.

Child of: <bar>

Parent of: Nothing

See also: <slider>

Example:

<edge>4</edge>

<file>

An asset defined within a <bar>, <image name="">, <media>, <media_overlay> or <slider> tag, a file to preload within a <preload> tag, or the path to the Flash library file containing the images to load using <medialibrary_load name="">.

When <file> is used within <media>, <media_overlay> or <image name="">: if the specified file is not defined by a full path, the default path defined in <media_path> or <image_path> (if <file> is within <image name="">) will be assumed.

Child of: <bar>, <image name="">, <media>, <media_overlay>, <medialibrary_load name="">, <preload>, <slider>

Parent of: Nothing

See also: <image_path>, <media_path>

Example:

<file>my_video.mp4</file>

Working example: Search for <file></file> in the file trivia_demo.xml.

<fill_color>

The fill color for a bar, defined within <video_defaults>, indicating how much of a video has loaded.

The color is represented by a hexadecimal code preceded by 0x. To find the hexadecimal code for the color you want, use a color picker such as this one.

Child of: <bar>

Parent of: Nothing

Example:

<fill_color>0x6BA668</fill_color>

<full_screen>

Upon user click within a <button> or <click> tag, makes the video full-screen or returns the video from full-screen to normal size.

The video will return to normal size if the user presses Esc on their computer or if <full_screen>NO<full_screen> is executed.

Note that if the application is running on a Web page, <full_screen>YES</full_screen> must be initiated by a user click within a <button> or <click> tag. It will only work without a user click (i.e., within <node name="">) if the application is running in a standalone Flash player. However, <full_screen>NO</full_screen> does not require a user click in either case.

Accepted values are YES and NO.

Child of: <button>, <click>, <node name="">, <press>, <release>

Parent of: Nothing

Example:

<full_screen>YES</full_screen>

<initialize>

Defines a node to advance to where a YouTube video is to be played.

In order for YouTube videos to play properly, the <initialize> tag must be used in the previous node.

The YouTube video(s) should be defined within a <media> tag that is defined within a <youtube_medias> tag in the specified node. The URL defined within the <file> tag must be the embed URL for the video. To obtain the embed URL, click the "Embed" button below the video on the YouTube site. The embed URL is in the value attribute within the param tag.

Child of: <youtube_medias>

Parent of: Nothing

Example:

<node name="youtube_setup">

            <youtube_medias>

                        <initialize>youtube_node</initialize>

            </youtube_medias>

</node>

<node name="youtube_node">

            <youtube_medias>

                        <media>

                                    <file>http://www.youtube.com/...</file>

                        </media>

                        <media>

                                    <file>http://www.youtube.com/...</file>

                        </media>

            </youtube_medias>

</node>

<loop>

Determines whether one or more videos defined in <medias> or <youtube_medias>, or a video defined in <media_overlay>, loops or not.

Accepted values are YES and NO.

Default value: NO

Child of: <media_overlay>, <medias>, <youtube_medias> 

Parent of: Nothing

Example:

<loop>YES</loop>

<media>

A video or image to play or display.

The media will remain on the screen until it is explicitly cleared with <media>CLEAR</media> or another media file is played.

Allowed file types are .mp4, .jpg, .png or a YouTube video*.

Unless a complete file path beginning with "http://" is specified, the file path from <media_path> in <settings> will be assumed.

<x>, <y>, <height> and <width> need only be defined in order to override the settings in <video_defaults>.

* To play a YouTube video:

• In order for YouTube videos to play properly, the <initialize> tag must be used in the previous node.
• The URL defined within the <file> tag must be the embed URL for the video. To obtain the embed URL, click the "Embed" button below the video on the YouTube site. The embed URL is in the value attribute within the param tag.

Child of: <medias>, <youtube_medias>

Parent of: <initialize>, <file>, <custom_event>, <x>, <y>, <height>, <width>, <next_node>, <link>, <assign name="" expr=""/>

See also: <media_path>, <video_defaults>

Example:

<media>

            <file>my_video.mp4</file>

            <custom_event>7</custom_event>

<x>10</x>

<y>30</y>

<height>240</height>

            <width>230</width>

            <next_node>node_1</next_node>

<link>http://www.my_site.com</link>

<assign name="user_clicked_my_video" expr="1"/>

</media>

To clear the media currently playing, use CLEAR as follows:

<media>

<file>CLEAR</file>

</media>

Working example: Search for <media>...</media> in the file trivia_demo.xml.

<media_clicked node=""/>

The node to advance to if a media asset with a <link> tag specified is clicked.

Child of: <node name="">

Parent of: Nothing

Example:

<media_clicked node="a_node"/>

<media_custom_event node=""/>

The node to advance to after the media has played for the number of seconds specified in the <custom_event> tag.

Child of: <node name="">

Parent of: Nothing

See also: <custom_event>, <media>

Example:

<media_custom_event node="a_node"/>

Working example: Search for <media_custom_event node=""/> in the file trivia_demo.xml.

<media_end node=""/>

The node to advance to after all media playback ends.

Child of: <node name="">

Parent of: Nothing

See also: <media>

Example:

<media_end node="a_node"/>

Working example: Search for <media_end node=""/> in the file trivia_demo.xml.

<media_overlay>

A video to play with options to loop or to clear automatically when it has ended.

If <assign name="" expr=""/> is used within <media_overlay>, the assign will be executed only if a <link> tag is also present and the user clicks the media.

Child of: <click>, <drag_drop>, <drag_move>, <mouse_click>, <mouse_down>, <mouse_move>, <mouse_out>, <mouse_over>, <node name="">, <press>, <release>

Parent of: <file>, <loop>, <auto_clear>, <x>, <y>, <height>, <width>, <next_node>, <link>, <assign name="" expr=""/>

Examples:

<media_overlay>

            <file>my_video.mp4</file>

            <loop>NO</loop>

            <auto_clear>YES</auto_clear>

            <x>0</x>

            <y>50</y>

            <height>150</height>

            <width>225</width>

<next_node>node_1</next_node>

<link>http://www.my_site.com</link>

<assign name="user_clicked_overlay" expr="1"/>

</media_overlay>

To clear the media overlay currently playing, use CLEAR as follows:

<media_overlay>

            <file>CLEAR</file>

</media_overlay>

<media_overlay_end node="">

The node to advance to after a media overlay playback ends.

Note: If <loop> is set to YES in the media overlay, <media_overlay_end node=""/> will not be executed.

Child of: <node name="">

Parent of: Nothing

See also: <media_overlay>

Example:

<media_overlay_end node="a_node"/>

<media_path>

Specifies the full default path for media (e.g., .mp4 files).

The URL must end in a slash (/).

Child of: <settings>

Parent of: Nothing

Example:

<media_path>http://www.my_site.com/media/</media_path>

Working example: Search for <media_path></media_path> in the file trivia_demo.xml.