Troubleshooting

The following tables provide a reference to assist you in understanding and troubleshooting any error or warning messages that may appear when exporting files or when playing Timeline effects. The tables also provide suggestions for addressing any problems that may occur.

License Activation Errors

There are several error messages that may be displayed by the licensing mechanism used by . The following table describes each of these messages and explains how to resolve the problem.

ERROR MESSAGE DESCRIPTION SOLUTION
This license key has already expired. This error is displayed when attempting to install a license key after the date it was set to expire. Follow the License Activation instructions and request a new license key. Enter the new license key and verify that your email address is correct.

If the problem persists, download and install the latest version of and request a new license key.
This license key is invalid. This error is displayed when is unable to authenticate the license key you entered. This may occur if the email address or license key was not entered exactly as given to you or if the system time of your PC is incorrect. Be sure the email address you entered is the same as the address you used when registering at developer.immersion.com and be sure that you entered the key exactly as given to you.

If the email address and key are correct, check your system time to make sure your PC is set to the correct date.

If the problem persists, download and install the latest version of and request a new license key.
Your system clock appears to have been changed, possibly in an attempt to defeat the licensing mechanism protecting . This error appears when detects a change in the PC's clock. The trial license for is time-limited. If you have changed the date on you PC, first try changing it back to the correct date and then launch again. If this does not solve the problem, send an email to TouchSenseSupport@immersion.com and request a clock-fix key. Immersion will process your request and reply with a clock-fix key if your request is approved. When you receive a clock-fix key, verify that your PC's date and time are correct and enter your clock-fix key in the Clock Error dialog box.

The clock error may have caused your trial license to expire immediately. If this is the case, you must request a new license key by following the License Activation instructions.
The clock-fix key you entered is either invalid or has expired. Clock-fix keys must be entered the same day that then are created. Verify that your PC is set to the correct date and request a new clock-fix key. When you receive the clock-fix key, enter it immediately.
Expired automatically due to clock error This message may be displayed in the "Expires" field of the License dialog after a clock error is detected, even if a clock-fix key is successfully installed. When a clock error is detected, the currently installed license key may expire immediately. After setting the clock back to the correct date and entering a valid clock-fix key, you must request a new license key by following the License Activation instructions.

Error Messages During Your Session

might provide valuable information in case of unexpected errors. When error messages pop-up on the screen, your attempted operation is automatically halted and you should address the issue with the proposed solution in the message pop-up.

Here are some typical errors in .

WARNING MESSAGE DESCRIPTION SOLUTION
The is too busy to perform the requested operation. cannot perform the operation because the is busy with another request. Wait a few seconds and try again. If the problem persists, reboot your computer.
The is not initialized. Please re-start the service or reboot your computer. could not query the list of devices to be displayed in the dropdown list of the Toolbar, since the does not seem to be running on your computer. Verify that the is still running on your PC.
General failure. Please check that the is running and that the device is properly plugged in. Then, refresh the device list and try again. failed to start or stop an effect on the selected device. Verify that your phone is still connected to your PC and that the is still running.
The actuator assigned to this effect is not attached to the system. Please make sure an available actuator is selected and play the effect again. If this problem persists, make sure the device is plugged in, refresh the device list and try again. This error message is displayed when you play an effect targeting an actuator that is not available in the selected handset. Edit the effect and select an available Actuator Index for the effect.
Failed to play the Waveform effect.

Insufficient memory to perform the requested operation.
This message may be issued when the selected handset does not have enough memory available for the entire Waveform effect data. Reduce the Waveform effect's Sampling Rate and/or Bit Depth in the Waveform Editor and try again. It is possible that the Waveform effect will still not play if the handset does not have enough available memory to fit the effect data even at the lower Sampling Rate and Bit Depth.
Failed to play the Timeline effect.

Insufficient memory to perform the requested operation.
This message may be issued when the selected handset does not have enough memory available for the entire Timeline effect data. This may happen if the Timeline effect references one or more Waveform effects. Reduce the Waveform effects' Sampling Rate and/or Bit Depth in the Waveform Editor and try again. It is possible that the Timeline effect will still not play if the handset does not have enough available memory to fit the effect data even even at the lower Sampling Rate and Bit Depth.

Warning Messages

Warning messages are conditions that are not terminal. If a warning message appears, the operation will still be carried out, but with the limitations outlined in the warning message.

WARNING MESSAGE DESCRIPTION SOLUTION
One or more samples in the Timeline contain too many effects and cannot be played. Would you like to play the Timeline anyway? Before playback begins, the Timeline is divided into segments that are synchronized with the audio. Each segment is limited in the amount of data that it can hold. This warning message means that one or more of these segments contains too many effects.

Look for “busy” places in the Timeline and remove some Launch Events. Also look for duplicate events and remove them. Optimizing in this way will have the extra benefit of reducing the size of the final output file. Click Yes to play the Timeline. Click No to cancel playback and edit the effect.
effects starting after the audio ends are not played. This warning message is displayed when the Timeline contains effects that start after the end of the audio file in the Timeline. Since playback is synchronized to the audio in the audio file, effects occurring after the end of the audio are not played. If the Timeline was intentionally designed with effects occurring after the audio file has ended, they will not play and this message appears. If the effects that are located after the audio file are unintentional, remove the effects and this warning will not appear.
One or more tracks in this Timeline are assigned to actuators that are not available on the currently selected device. Only the tracks assigned to valid actuators will be played. This warning message is displayed when you play a Timeline that has effects targeting unavailable actuators. If you want to feel all the effects in the Timeline you will need to make sure that all tracks are assigned to available actuators.
This file contains effects designed for a TouchSense 4000 or 5000 Series handset and may not play corrently on the device currently selected in the handset list. This warning message is displayed when you export your file to C, BREW, or Java code, and the currently selected device does not support all the effects in the file. For example, this message will be displayed if you have defined effects for multiple actuators and the currently selected device does not support multiple actuators. Select a different device or ensure that the device on which you will run the exported code supports the effects that you have created.
Changing the Actuator for a track in a Timeline effect will modify the corresponding basis effect and all Timelines that this basis effect is a part of. This warning message is displayed when you change the Actuator for a Track in the Timeline Editor. The Actuator Index is a property of the Basis effect. Changing the Actuator in the Timeline track changes the Actuator Index that is stored in the Basis effect definition, and affects any other Timeline that depends on the Basis effect. Continue if the stated side-effects are acceptable. Cancel the operation if the side-effects are not desired.
The file being imported contains objects with names that are currently in use. Rename imported objects and continue? When importing a file (from the File Menu, select Import and then select a file), looks for effects contained in the file. If effects are present in the file, they are added to the current document. If the document that they are being added to already contains effects, it is possible that there will be conflicts with the names of the effects. If this occurs, click Yes if you would like the new effects to be given unique names. Click No to cancel the import operation.

Media File Export Error Messages

When exporting files, will validate the data being saved. If the data is found to be invalid for media file use, the export process will fail. The reason for the failure will be indicated by an error message. If you receive an error message the export process ends. The following table lists the possible error messages that may appear.

WARNING MESSAGE DESCRIPTION SOLUTION
Export to file type (SKM, MP4 or K3G) failed. No Timeline exists in the current document. Only Timeline effects can be exported to SKM, K3G or MP4 files. You must define one Timeline effect in the document before you can export to SKM, MP4, or K3G format.

Click the New Timeline button on the Toolbar to create a Timeline effect. Drag the media object into it, then add basis effects and launch events. After you are finished designing your Timeline effect, try exporting to either SKM, MP4, or K3G format again.
Export to SKM, K3G or MP4 failed. The current document contains more than one Timeline effect. SKM, K3G or MP4 files can only contain one Timeline effect. Remove all other Timeline effects that are in the document before exporting to SKM, K3G or MP4 format.
Export to SKM, K3G or MP4 failed. The Timeline effect in the current document does not contain a reference to an existing SKM, K3G or MP4 file. The Timeline effect must reference one SKM, K3G or MP4 file. The SKM, K3G or MP4 media object in the Timeline represents the source SKM, K3G or MP4 file. The Timeline data will be merged with the audio and video data from the source SKM, K3G or MP4 file and written out to the destination file selected in the Save As dialog box. If there is no source SKM, K3G or MP4 file, the destination SKM, K3G or MP4 file cannot be created. Use the New Media Link Toolbar button to add an SKM, K3G or MP4 media object to the document, then drag this object into the Timeline and try exporting again.
Export to SKM, K3G or MP4 failed. This is a generic error message that indicates that the export process failed for an unknown reason. If you receive this error, make sure that the source SKM file is valid that the destination SKM file or path is not write-protected.
Export to SKM, K3G or MP4 failed. IVS file error. This error message indicates that the data in the document that is being exported is invalid. Re-save the document as an IVS file and close . Restart and open the IVS file again.
Export to SKM, K3G or MP4 failed. The SKM, K3G or MP4 file referenced in the Timeline is the same as the destination file. Please select a different filename to save to. This error message indicates that the SKM, K3G or MP4 file referenced in the Timeline is the same as the one selected in the Save As dialog when exporting to SKM, K3G or MP4. Enter a different filename to save to when exporting.

SKM, K3G or MP4 Export Warning Messages

Under certain circumstances you may receive warning messages when attempting to export files. Warning messages, unlike error messages, are conditions that are not terminal. If a warning message appears, the media file will still be created, but with the limitations outlined in the warning message. The following table lists the possible warning messages that may appear.

WARNING MESSAGE DESCRIPTION SOLUTION
One or more samples in the Timeline contain too many effects and can not be exported. Please reduce the effect density and try exporting again. This warning message may appear when trying to export a file.

During the export process, the Timeline effect is divided into segments to be synchronized with the audio. Each segment is limited in the amount of data it can hold. This error message means that one or more of these segments contains too many effects.

Note: Since this is a warning and not an error message, the file will still be generated. The samples encoded into the file, however, will be limited to the size restriction, so some effects will be dropped during the export process.

Look for “busy” places in the Timeline and remove some launch events. Also, look for duplicate events and remove them. Optimizing in this way will have the extra benefit of reducing the size of the final file.
effects starting after audio ends won't be played. This warning message is displayed when the Timeline contains effects that start after the end of the audio file in the Timeline. Since playback is synchronized to the audio in the file, effects occurring after the end of the audio are not played. If the Timeline was intentionally designed with effects occurring after the audio file has ended, they will not play and this warning will appear. If the effects that are located after the audio file are unintentional, remove the effects and this warning will not appear.

MIDI File Synchronization Issues

If a MIDI file is not synchronized with the vibration on a handset, but the same MIDI file is synchronized with the vibration in , try changing the Skip Leading Silence option. For example, if the Skip Leading Silence option is selected, deselect it and see the results.

For more information, refer to the Skip Leading Silence option in MIDI Converted:Main Window and MultiMedia Editors.

Minimum Seek Time for MIDI Files

If the Requested Seek Time is less than the Minimum Seek Time, may stop responding for the duration of the Requested Seek Time when you play a MIDI file. If, for example, the first note in a MIDI file starts at 1500 ms and a Start Offset is indicated at 300 ms, the MIDI file will play from the beginning, however, the screen will freeze for 1800 ms. The haptics start at 1800 ms when the MIDI playback reaches that point. After that the MIDI file and the haptics are synchronized. If the Requested Seek Time is greater than the Minimum Seek Time, will play the audio starting from the previous Legitimate Seek Time while haptic playback and the time cursor will not resume until the audio playback reaches the Requested Seek Time. For example, if you unselect SKip Leading Silence,and set a Start Offset of 3700 ms, audio playback will begin at 3000 ms (the previous Legitimate Seek Time). will appear to be frozen for the next 700 ms until playback reaches 3700 ms. At that point, haptic playback and time cursor movement will resume. Refer to the glossary for definitions of Leading Silence, Requested Seek Time, Minimum Seek Time, and Legitimate Seek Time.

Known Issues with MIDI Files

MIDI files may not play on Microsoft Windows 2000 Korean with the default sound card driver. If problems are experienced with MIDI file playback on Windows 2000, please download and install the latest sound card driver from the sound card manufacturer’s Web site.

Timeline Playback Out of Synch

The first time a Timeline is played with an MP3 referenced media file in the Timeline, the audio starts late and effects start early, which results in lack of synchronization. However, this only occurs the first time you press Play. Each subsequent time Play is pressed this synchronization issue does not occur.

This issue also occurs the first time Start Offset is selected, however, it does not occur after the first Start Offset.

Handset Does Not Appear in the Device List

If you have a enabled handset attached to the system and it is not listed in the device list of , follow these steps to establish the connection. If the handset appears in the device list at any point during this process, there is no need to continue with the remaining steps.

  1. Make sure the correct drivers for your device are installed and operating correctly.
  2. Click the refresh button in to re-scan the PC for available devices.
  3. Unplug the handset’s USB cable, then plug it in again, wait a few seconds and press the refresh button in .
  4. Reboot the handset. After the handset finishes booting, wait a few seconds and press the refresh button in .
  5. Reboot the PC.

If the handset still is not listed, contact Immersion technical support at developer.immersion.com


Immersion and are trademarks of Immersion Corporation.
All other trademarks are the property of their respective owners.
© 2010 Immersion Corporation.
Visit developer.immersion.com for the latest in news and information.