Showing posts with label settings. Show all posts
Showing posts with label settings. Show all posts

<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>

<button_defaults>

Default settings for the appearance of clickable buttons on the screen.

Can be overridden as necessary.

Child of: <settings>
Parent of: <font>, <font_size>, <text_color>, <word_wrap>, <height>, <width>, <button_color>, <bold>, <opacity>

Example:

<button_defaults>
            <font>Arial</font>
            <font_size>16</font_size>
            <text_color>0x000000</text_color>
            <word_wrap>OFF</word_wrap>
            <height>35</height>
            <width>50</width>
            <button_color>0xDDDDDD</button_color>
            <bold>YES</bold>
            <opacity>.5</opacity>
</button_defaults>

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

<button_template name="">

An individual set of buttons defined within <button_templates>.

Child of: <button_templates>
Parent of: <buttons>

Examples:

<button_template name="abc">
            <buttons>
                        <button>
            <text>Button A</text>
            <font>Arial</font>
            <font_size>12</font_size>
            <text_color>0x000000</text_color>
<word_wrap>OFF</word_wrap>
<x>30</x>
<y>60</y>
<height>35</height>
<width>75</width>
            <button_color>0xDDDDDD</button_color>
            <bold>YES</bold>
            <opacity>.5</opacity>
            <next_node>node_a</next_node>
            <assign name="user_clicked_a" expr="'1'"/>
                        </button>
                        <button>
            <text>Button B</text>
            <font>Arial</font>
            <font_size>12</font_size>
            <text_color>0x000000</text_color>
<word_wrap>OFF</word_wrap>
<x>30</x>
<y>110</y>
<height>35</height>
<width>75</width>
            <button_color>0xDDDDDD</button_color>
            <bold>YES</bold>
            <opacity>.5</opacity>
            <next_node>node_b</next_node>
            <assign name="user_clicked_b" expr="'1'"/>
                        </button>
                        <button>
            <text>Button C</text>
            <font>Arial</font>
            <font_size>12</font_size>
            <text_color>0x000000</text_color>
<word_wrap>OFF</word_wrap>
<x>30</x>
<y>160</y>
<height>35</height>
<width>75</width>
            <button_color>0xDDDDDD</button_color>
            <bold>YES</bold>
            <opacity>.5</opacity>
            <next_node>node_c</next_node>
            <assign name="user_clicked_c" expr="'1'"/>
                        </button>
            </buttons>
</button_template>

To call a defined button template from a node:

<button_template name="abc"/>

Anything added or changed in the template call will override the template definition in <settings>. For example, to override the font size of a button template:

<button_template name="abc">
            <buttons>
                        <button>
                                    <font_size>16</font_size>
                        </button>
                        <button>
                                    <font_size>16</font_size>
                        </button>
                        <button>
                                    <font_size>16</font_size>
                        </button>
            </buttons>
</button_template>

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

<button_templates>

Contains one or more templates for sets of buttons that can be defined once in settings and called from any node.

Child of: <settings>
Parent of: <button_template name=""/>

Example:

<button_templates>
<button_template name="abc">
            <buttons>
                        …
            </buttons>
</button_template>
<button_template name="true_or_false">
            <buttons>
                        …
            </buttons>
</button_template>
</button_templates>

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

<client_id>

A unique identifier for the application for use in logging, for example.

Child of: <settings>
Parent of: Nothing

Example:

<client_id>123456</client_id>

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

<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_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>

<frame>

Establishes the correct dimensions for the frame in case the application runs on a page that is not magnified at 100%.

Child of: <settings>
Parent of: <height>, <width>

Example:

<frame>
            <height>250</height>
            <width>300</width>
</frame>

<image_path>

Specifies the full default path for images (.jpg or .png files).

The URL must end in a slash (/).

Child of: <settings>
Parent of: Nothing

Example:

<image_path>http://www.my_site.com/my_images/</image_path>

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

<media_retries>

Specifies the number of times Flash should try to retrieve a media asset before sending a "file not found" error.

This tag is useful for managing server overload.

This tag applies to background mp3 files, images and media files except those defined within <youtube_medias>.

Default value: 5
Child of: <settings>
Parent of: Nothing

Example:

<media_retries>10</media_retries>

<mute_button>

Determines whether a mute button appears in the upper right corner of the screen.

Accepted values are ON or OFF.

Default value: OFF
Child of: <settings>
Parent of: Nothing

Examples:

<mute_button>ON</mute_button>

<mute_button>OFF</mute_button>

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

<mute_down_image>

The image to display when the mute button in a video playback popup is clicked.

Child of: <popup>
Parent of: Nothing
See also: <mute_over_image>, <mute_up_image>

Example:

<mute_down_image>player_button_mute.png</mute_down_image>

<mute_over_image>

The image to display when the cursor is over the mute button in a video playback popup.

Child of: <popup>
Parent of: Nothing
See also: <mute_down_image>, <mute_up_image>

Example:

<mute_over_image>player_button_mute_on.png</mute_over_image>

<mute_up_image>

The default image to display for the mute button in a video playback popup.

Child of: <popup>
Parent of: Nothing
See also: <mute_down_image>, <mute_over_image>

Example:

<mute_up_image>player_button_mute.png</mute_up_image>

<muteunmute_x>

The X axis value of the position of the mute/unmute button in a video playback popup.

Using RELATIVE as the value will make the mute/unmute button placement relative to the pause/play button.

Child of: <popup>
Parent of: Nothing
See also: <muteunmute_y>, <pauseplay_x>, <pauseplay_y>

Example:

<muteunmute_x>RELATIVE</muteunmute_x>

<muteunmute_y>

The Y axis value of the position of the mute/unmute button in a video playback popup.

Child of: <popup>
Parent of: Nothing
See also: <muteunmute_x>, <pauseplay_x>, <pauseplay_y>

Example:

<muteunmute_y>315</muteunmute_y>

<on_error node=""/>

The node to advance to when there is an error in the application (e.g., a reference to an undefined node, variable, etc.).

This feature allows applications to fail more gracefully and to continue running in spite of errors.

When an error occurs, a description of the error is automatically written into the variable ERROR_MSG, which can be displayed or evaluated for logging or other purposes.

Child of: <settings>
Parent of: Nothing

Example:

<on_error node="error_node"/>

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

<pause_button>

Determines whether a pause button appears in the upper right corner of the screen.

Accepted values are ON or OFF.

Default value: OFF
Child of: <settings>
Parent of: Nothing

Examples:

<pause_button>ON</pause_button>

<pause_button>OFF</pause_button>

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

<pause_down_image>

The image to display when the pause button in a video playback popup is clicked.

Child of: <popup>
Parent of: Nothing
See also: <pause_over_image>, <pause_up_image>

Example:

<pause_down_image>player_button_pause.png</pause_down_image>

<pause_over_image>

The image to display when the cursor is over the pause button in a video playback popup.

Child of: <popup>
Parent of: Nothing
See also: <pause_down_image>, <pause_up_image>

Example:

<pause_over_image>player_button_pause_on.png</pause_ over_image>