Share via

RemoteOrderDisplay.VideoSound Method

  • Article

2/27/2008

Sounds the video enunciator for the specified units.

Namespace: Microsoft.PointOfService
Assembly: Microsoft.PointOfService (in microsoft.pointofservice.dll)

Syntax

'Declaration
Public MustOverride Sub VideoSound ( _
    units As DeviceUnits, _
    frequency As Integer, _
    duration As Integer, _
    numberOfCycles As Integer, _
    interSoundWait As Integer _
)

public abstract void VideoSound (
    DeviceUnits units,
    int frequency,
    int duration,
    int numberOfCycles,
    int interSoundWait
)

public:
virtual void VideoSound (
    DeviceUnits units, 
    int frequency, 
    int duration, 
    int numberOfCycles, 
    int interSoundWait
) abstract

public abstract void VideoSound (
    DeviceUnits units, 
    int frequency, 
    int duration, 
    int numberOfCycles, 
    int interSoundWait
)

public abstract function VideoSound (
    units : DeviceUnits, 
    frequency : int, 
    duration : int, 
    numberOfCycles : int, 
    interSoundWait : int
)

Parameters

  • units
    The unit(s) to operate on.
  • frequency
    Tone frequency in Hertz.
  • duration
    Tone duration in milliseconds.
  • numberOfCycles
    If WaitForever, then start tone sounding and, repeat continuously. Otherwise, perform the specified number of cycles.
  • interSoundWait
    When numberOfCycles is not 1, then pause for interSoundWait milliseconds before repeating the tone cycle (that is, before playing the tone again).

Remarks

The duration of a video tone cycle is as follows:

duration parameter +

After the video has started an asynchronous sound, then the ClearOutput method stops the sound. (When an interSoundWait value of WaitForever is used to start the sound, then the application must use ClearOutput to stop the continuous sounding of tones.)

If the CapTone property is false for the selected unit(s), an Illegal exception is thrown.

VideoSound may cause a PosControlException exception to be thrown with the following ErrorCode:

Value

Description

Illegal

One of the following errors occurred:

  • numberOfCycles is not a positive, nonzero value or WaitForever.

  • numberOfCycles is WaitForever, when AsyncMode is false.

  • A negative interSoundWait was specified.

  • units is zero or a nonexistent unit was specified.

  • A unit in units does not support the CapTone capability.

  • The ErrorUnits and ErrorString properties may be updated before return.

Failure

An error occurred while communicating with one of the video units specified by units. The ErrorUnits and ErrorString properties are updated before return. (Can only occur if AsyncMode is false.)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread-safe. Any instance members are not guaranteed to be thread-safe.

See Also

Reference

RemoteOrderDisplay Class
RemoteOrderDisplay Members
Microsoft.PointOfService Namespace
AsyncMode
CapTone
RemoteOrderDisplay.ClearOutput Method
ErrorString
ErrorUnits