ScriptingPlaySound Method

Public Shared Function PlaySound ( 
	strSoundFile As String,
	sinVolume As Single,
	Optional sctCancelToken As CancellationToken = Nothing
) As Task

public static Task PlaySound(
	string strSoundFile,
	float sinVolume,
	CancellationToken sctCancelToken = default
)

Parameters

strSoundFile

Type: SystemString
Qualified path and file name of the sound file. Supported file types are: .wav and .mp3

sinVolume

Type: SystemSingle
Volume of this sound channel. Full volume is 1.0 and 0.5 is half volume.

sctCancelToken (Optional)

Type: System.ThreadingCancellationToken
Token provided by a controlling source to notify this method that it should cancel its execution.

Return Value

Reference