v1.5 Documentation

These reference documents are designed to help you when things don't go as planned. The individual screen type documents are useful for looking up availalbe JSON properties.

Menus
Content Screens
Settings Screens
Splash Screens
Other Actions
Multiple Choice Quiz
Use a quiz screen for eduction, entertainment, or anything else you can think of. The questions for the quiz can be included in the screens data directly or they can come from a remote server. This sample text file shows the format of a remote file of quiz questions. Quiz questions can include an image along with the question text or an image only.
Sample JSON
{"itemId":"99999", "itemType":"BT_screen_quiz", "itemNickname":"My Quiz", "navBarTitleText":"Test your smarts", "dataURL":"http://mywebsite.com/questionsForQuiz.php", "scoreboardURL":"http://mywebsite.com/scoreboardData.php"}
* Required     * Overrides Global Theme
Multiple Choice Quiz Properties
Item Id * "itemId":"a unique id"
A unique number or string identifiying this item from all other items in the configuration file.
Item Type * "itemType":"BT_screen_quiz"
Used by the mobile app to determine what type of item to create.
Item Nickname * "itemNickname":"A unique nickname"
The nickname of the item in the buzztouch control panel.
Child Items "childItems":[Array of Quiz Questions]
An array of Child Item JSON objects representing each question. Do not use a childItems array if the screen pulls it's questions from a dataURL.
Data URL "dataURL":"http://www.mysite.com/questionsForQuiz.php"
A URL pointing to a file containing an array of Child Item JSON objects representing each question. Do not use a dataURL if the screen uses a childItems array.
Status Bar, Navigation Bar
Status Bar Style * "statusBarStyle":"default"
Options: default, solid, transparent, hidden.
Navigation Bar Title "navBarTitleText":"The Screen Title"
The title text that shows in the navigation bar.
Navigation Bar Style * "navBarStyle":"solid"
Options: solid, transparent, hidden.
Navigation Bar Color * "navBarBackgroundColor":"#000000"
Hexidecimal color.
Left Button Text "navBarBackButtonText":"Back"
Keep this short.
Right Button Type "navBarRightButtonType":"infoLight"
Omit this property or leave the value blank for no right button.
Options: home, next, infoLight, infoDark, details, done, cancel, save, add, addBlue, compose, reply, action, organize, bookmark, search, refresh, camera, trash, play, pause, stop, rewind, fastForward
This property sets the image's type, it does not determine what happens when the button is tapped. The Right Button Load Screen is what determines what happens when the button is tapped.
Right Button Load Screen "navBarRightButtonTapLoadScreenItemId":"Another screen itemId"
OR
"navBarRightButtonTapLoadScreenNickname":"Another screen nickname"
OR
"navBarRightButtonTapLoadScreenObject":{a JSON sreen object}
The itemId, or the nickname, or the the JSON data for a screen or menu or feature. Only one of these three properties will be used.
Keywords: Set the navBarRightButtonTapLoadScreenItemId to "back", "home" or "showAudioControls" for special behaviors. These option will not load a screen but will perform the action associated with the keyword.
Right Button Transition Type "navBarRightButtonTapTransitionType":"flip"
Leave this blank for devices default transition. Or, use one of these values: fade, flip, curl, grow, slideUp, slideDown.
Hide Bottom Tab Bar "hideBottomTabBarWhenScreenLoads":"0"
Options: 0 or 1 where 1 = yes. This property is ignored when this screen is set as the home screen for a tab or if the app does not use a tabbed layout.
Quiz Behavior
Number of Questions "quizNumberOfQuestions":"10"
The number of questions to present when the user takes a quiz. This does not need to be the same number as the total number of questions configured for the quiz.
Question Delay "quizQuestionDelay":"2"
The number of seconds between each question.
Randomize Questions "quizRandomizeQuestions":"1"
Options: 0 or 1 where 1 = yes.
Show Correct Answers "quizShowCorrectAnswers":"1"
Options: 0 or 1 where 1 = yes.
Points per Correct Answer "quizPointsPerAnswer":"100"
The number of points the user earns for each correct answer.
Show Reward if Points Over "quizRewardIfPointsOver":"500"
If a user earns this many points you may want to show a reward screen.
Finish Screen "quizFinishScreenItemId":"Another screen itemId"
OR
"quizFinishScreenNickname":"Another screen nickname"
OR
"quizFinishScreenObject":{a JSON sreen object}
The itemId, or the nickname, or the the JSON data for a screen or menu to display when the quiz ends. This is ignored if the user earns enough points to see a reward screen.
Finish Screen Transition Type "quizFinishScreenTransitionType":"curl"
Leave this blank for devices default transition. Or, use one of these values: fade, flip, curl, grow, slideUp, slideDown.
Reward Screen "quizRewardScreenItemId":"Another screen itemId"
OR
"quizRewardScreenNickname":"Another screen nickname"
OR
"quizRewardScreenObject":{a JSON sreen object}
The itemId, or the nickname, or the the JSON data for a screen or menu to display if the user earns enough points. In this case, the finish screen is ignored.
Reward Screen Transition Type "quizRewardScreenTransitionType":"curl"
Leave this blank for devices default transition. Or, use one of these values: fade, flip, curl, grow, slideUp, slideDown.
Show Scoreboard "showScoreboard":"1"
Options: 0 or 1 where 1 = yes. It may or may not be appropriate to show a scoreboard.
Scoreboard URL "scoreboardURL":"http://mywebsite.com/scoreboardData.php"
A URL pointing to a backend script capable of receiving quiz results and outputting quiz scores. This is a sample PHP script that shows how to manage scoreboard data.
Sound Effect Correct "quizSoundEffectFileNameCorrect":"correct.mp3"
The file name of a very short audio file to play when the user answers a question correctly. This sound effect should be no longer than about 1 second and must exist in the Xcode or Android project.
Sound Effect Incorrect "quizSoundEffectFileNameIncorrect":"incorrect.mp3"
The file name of a very short audio file to play when the user answers a question incorrectly. This sound effect should be no longer than about 1 second and must exist in the Xcode or Android project.
Sound Effect Finished "quizSoundEffectFileNameFinished":"finished.mp3"
The file name of a very short audio file to play when the user finishes a quiz. This sound effect should be no longer than about 1 second and must exist in the Xcode or Android project.
Sound Effect Reward "quizSoundEffectFileNameReward":"reward.mp3"
The file name of a very short audio file to play when the user finishes a quiz and earns a reward. This sound effect should be no longer than about 1 second and must exist in the Xcode or Android project.
Quiz Layout
Show Quiz Timer "quizShowTimer":"0"
Options: 0 or 1 where 1 = yes. Shows a running timer while the user takes the quiz.
Quiz Image Corner Radius "quizImageCornerRadius":"8"
The rounded corner radius to apply to question images. Ignored if no question images are used.
Font Color Questions "quizFontColorQuestions":"#FFFFFF"
Hexidecimal color for the question text on top of the question image (if an image is used for each question).
Font Size Questions Small Device "quizQuestionFontSizeSmallDevice":"25"
Number. Default is 25.
Font Size Questions Large Device "quizQuestionFontSizeLargeDevice":"55"
Number. Default is 55.
Font Color Answers "quizFontColorAnswers":"#FFFFFF"
Hexidecimal color for the answer text on top of the answer buttons.
Font Size Answers Small Device "quizButtonFontSizeSmallDevice":"14"
Number. Default is 14.
Font Size Answers Large Device "quizButtonFontSizeLargeDevice":"40"
Number. Default is 40.
Button Color Answers "quizButtonColorAnswers":"#000000"
Hexidecimal color. The color of the buttons under the answer text.
Button Color Correct "quizButtonColorCorrect":"#00BB11"
Hexidecimal color. The color of the button to highlight the correct answer. If showCorrectAnswers is 0 this is ignored.
Button Color Incorrect "quizButtonColorIncorrect":"#CC0000"
Hexidecimal color. The color of the button to highlight the incorrect answers. If showCorrectAnswers is 0 this is ignored.
Questions Transition Type "quizQuestionTransitionType":"flip"
Options: flip, curl. The transition style to use when moving from one question to the next.
Questions Transition Type "quizAnswersTransitionType":"flip"
Options: flip, curl. The transition style to use when moving from one set of answers to the next.
Background Color, Image
Background Color * "backgroundColor":"#000000"
Hexidecimal color or a keyword: "clear" or "stripes" (do not enter quotes).
Background Color Transparency * "backgroundColorOpacity":"100"
Numeric Value: 1 - 100, 1 is totally transparent.
Background Color Gradient Top * "backgroundColorGradientTop":"#000000"
Hexidecimal color. Background gradients flow top-to-bottom and are placed "on-top" of a possible background color.
Background Color Gradient Bottom * "backgroundColorGradientTop":"#FFFFFF"
Hexidecimal color. Background gradients flow top-to-bottom and are placed "on-top" of a possible background color.
Background Image Small Device * "backgroundImageNameSmallDevice":"background-small.png"
OR
"backgroundImageURLSmallDevice":"URL to background-small.png"
The file name of the image added to the project or the URL to the image. Background images are placed "on-top" of possible background colors. Use an image name OR a URL, not both.
Background Image Large Device * "backgroundImageNameLargeDevice":"background-large.png"
OR
"backgroundImageURLLargeDevice":"URL to background-large.png"
The file name of the image added to the project or the URL to the image. Background images are placed "on-top" of possible background colors. Use an image name OR a URL, not both.
Background Image Transparency * "backgroundImageOpacity":"100"
Number: 1 - 100, 1 is totally transparent.
Background Image Scale * "backgroundImageScale":"center"
Options: center, fullScreen, fullScreenPreserve, top, bottom, topLeft, topRight, bottomLeft, bottomRight.
Background Audio
Audio File Location * "audioFileName":"sampleAudio.mp3"
OR
"audioFileURL":"http://mysite.com/sampleAudio.mp3"
The filename of the file included in the project or the URL to the file. If a audioFileURL is used then audioFileName should not be included. The audioFileURL is an internet address pointing to an actual file, not an an address the loads an HTML or Flash webpage with an embedded media player.
Audio Stops on Screen Exit "audioStopsOnScreenExit":"1"
Options: 0 or 1 where 1 = yes.
Audio Number of Loops "audioNumberOfLoops":"1"
Set this to 1 to play the audio track once. Set this to -1 to play the track indefinitely.
Other
Login Required "loginRequired":"0"
Options: 0 or 1 where 1 = yes. App must implement a Login screen.
Hide From Search "hideFromSearch":"0"
Options: 0 or 1 where 1 = yes. Hides from search results if the app implements a Search Menu screen.