Table 208 – Additional entries specific to a sound action

Key

Type

Value

S

name

(Required) The type of action that this dictionary describes; shall be Sound for a sound action.

Sound

stream

(Required) A sound object defining the sound that shall be played (see 13.3, “Sounds” ).

Volume

number

(Optional) The volume at which to play the sound, in the range −1.0 to 1.0. Default value: 1.0.

Synchronous

boolean

(Optional) A flag specifying whether to play the sound synchronously or asynchronously. If this flag is true, the conforming reader retains control, allowing no further user interaction other than canceling the sound, until the sound has been completely played. Default value: false.

Repeat

boolean

(Optional) A flag specifying whether to repeat the sound indefinitely. If this entry is present, the Synchronous entry shall be ignored. Default value: false.

Mix

boolean

(Optional) A flag specifying whether to mix this sound with any other sound already playing. If this flag is false, any previously playing sound shall be stopped before starting this sound; this can be used to stop a repeating sound (see Repeat). Default value: false.