Product icon Help book icon Sound Mill X3 : User's Guide

Ids (Identifiers)

Locator: Sound List Editor > Edit Sound Item > Change Id .


Note: Check the Show Ids (Id symbol) checkbox in the Options > Report tab to expose all Ids.

Whenever you create a new object it will be assigned a unique Id (an integer Identifier). Objects with Ids include: Sound Items, Scripts, Playlists or External Program definitions. Under normal circumstances you should not need to know this Id, nor should you change the Id unless you are trying to fix an Invalid Id Reference condition.

Some elements will keep a reference to this Target object Id and use it to find the object when an action is requested. For example, a Play Step in a Script will locate the Sound Item to play by the Sound Item's Id.

Some Elements That Keep Target Id References
  • Run-Script Sound Items - Keep a Id reference to the Script that should run.
  • Start-External-Program Sound Items - Keep a Id reference to the External Program that should be started.
  • Script Steps - Keep an Id reference to Sound Items, Scripts and External Programs.
  • Easy Player Cues - Keep a Id reference to Sound Items.

Invalid Target Id References

An Id Reference can become invalid when the referenced object can no longer be found. Usually this occurs when the object is deleted or the user changes the Id. You could also find duplicate Ids after Importing another Sound List. You can check for Invalid Target Id References and Duplicate Ids by running a List Validation Check in the Sound List Editor > Tools menu.

Cut/Copy/Paste Considerations

If you Cut a Sound Item (or Script), then Paste it back into the List, it will maintain the same Id. However, the second time it is pasted back to the list, the subsequent pasted objects will have different unique Ids. Remember that Cut saves the cut object in the Clipboard, but Delete does NOT save a copy in the Clipboard.

Fixing Invalid Target Id References

If you end up with an Invalid Target Id Reference, you can fix it by recreating the referenced object (a Sound Item or Script), then use the Change Id menu item to set its Id to the missing Id.

For example, say you have a Sound Item with Id=123. And a Script 'Play' Step has a Target Id=123. If the Sound Item is deleted, the Script 'Play' Step will no longer be able to locate the target Sound Item. To fix this, create a new Sound Item for the Media File. Then use the Edit Sound Item > Change Id menu item to set the Sound Item Id to "123".

  1. Locate the Target object or create a new one if the object is missing (ie it may have been deleted).
  2. Set its Id to the Invalid Target Id shown in Validation error messages.
  3. Re-run the Tools > Sound List Validation Check to confirm that the error was resolved.

Report Sample with Ids

Listing 1 shows a fragement of a report with the Ids exposed. Note how the Target Ids point to the objects that are the target of the action to be performed.

Report Explanaiton:

  • Sound Item #2 is a Run-Script Sound Item to run "Script 2. Opening Scene Theme".
  • Sound Item #7 is a standard Sound Item to play an MP3 file named "Hello Goodbye.mp3".
  • Script #2 contains one Play-Step to play Sound Item #7.
Listing 1. Report Sample with Ids Exposed
Sound Items

2. Run: Opening Scene Theme Id: 322436199
	Type: Run Script
	Target Id: 353796267
	Act 1, Scene1, Page 1
	Category: 1 Sound-Cue
	Filename: Is blank.
	Play Modifiers: Output 0
7. Hello Goodbye Id: 654006940
	Act 1, Scene1, Page 1
	Category: 1 Sound-Cue
	Filename: Hello Goodbye.mp3
	Time: 3:26
	Play Modifiers: Output 0

Automation Scripts

Script: 2. Opening Scene Theme Id: 353796267

1. Play (7. Hello Goodbye, Target Id: 654006940)