Click or drag to resize

XmlWaveAnnouncer Class

Verizon Connect Logo
Print this page
Learn more about Verizon Connect GeoBase.
Get information about the latest release
Announces NavigationEvents using a set of customizable sound files, supporting different cultures through configurable XML files.
Inheritance Hierarchy

Namespace:  Telogis.GeoBase.Navigation.Announcements
Assembly:  geobase.net (in geobase.net.dll) Version: 4.99.0.0
Syntax
public class XmlWaveAnnouncer : WaveAnnouncer

The XmlWaveAnnouncer type exposes the following members.

Constructors
  NameDescription
Public methodXmlWaveAnnouncer
Create an XmlWaveAnnouncer that uses a sounds directory set to the default "langs" directory in the GeoBase system's data path and a culture set to CurrentCulture.
Public methodXmlWaveAnnouncer(String)
Create an XmlWaveAnnouncer that uses the specified languages directory and a culture set to CurrentCulture.
Public methodXmlWaveAnnouncer(String, CultureInfo)
Create an XmlWaveAnnouncer that uses the specified sounds directory and culture.
Public methodXmlWaveAnnouncer(String, CultureInfo, Boolean)
Create an XmlWaveAnnouncer that uses the specified sounds directory and culture, with the option to turn debug mode on. In debug mode, MessagesBundleExceptions will be thrown when errors are encountered in the culture's configuration file.
Public methodXmlWaveAnnouncer(String, String, Boolean)
Create an XmlWaveAnnouncer that uses the specified sounds directory and culture, with the option to turn debug mode on. In debug mode, MessagesBundleExceptions will be thrown when errors are encountered in the culture's configuration file.
Top
Properties
  NameDescription
Public propertyBellEnabled
When enabled, a bell sound is played if we are within 3 seconds of a turn and it has been previously announced
(Inherited from Announcer.)
Public propertyIsAnnouncementScheduled (Inherited from Announcer.)
Public propertyLongWay Obsolete.
Gets or sets the maximum distance to announce the instruction for the next turn. If the distance to the next turn is greater than this distance, the driver will simply be told to 'continue'
(Inherited from Announcer.)
Public propertyUnits
The unit system to use in announcing the directions.
(Inherited from Announcer.)
Public propertyVolume
Gets or sets the volume at which announcements are played.
(Inherited from WaveAnnouncer.)
Top
Methods
  NameDescription
Public methodAbortPlay
Allow the currently playing phrase to finish, then abort the announcement.
(Inherited from Announcer.)
Public methodBell
Play a 'bell' sound.
(Overrides AnnouncerBell.)
Public methodClick
Play a 'click' sound.
(Overrides AnnouncerClick.)
Public methodCreatePlayItem(String)
Create a PlayItem from a sound file, or a series of sound files located in the default langs folder.
(Inherited from WaveAnnouncer.)
Public methodCreatePlayItem(String, String)
Create a PlayItem from a sound file, or a series of sound files.
(Inherited from WaveAnnouncer.)
Public methodCreatePlayItem(String, String, Object)
Generate a PlayItem from a Phrase tag within a Phrases node.
Public methodDispose
Disposes of the announcement or sound.
(Inherited from Announcer.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodStatic memberGetAvailableCultures
Get a Dictionary containing details of the available cultures. The keys in the Dictionary are the formal names of the cultures, for example "en-US". The values in the dictionary are their descriptions, for example "US English". The sounds directory used is the default "langs" directory in the GeoBase system's data path.
Public methodStatic memberGetAvailableCultures(String)
Get a Dictionary containing details of the available cultures. The keys in the Dictionary are the formal names of the cultures, for example "en-US". The values in the dictionary are their descriptions, for example "US English".
Public methodStatic memberGetDefaultCulture
Get the full name of the default culture. The sounds directory used is the default "langs" directory in the GeoBase system's data path.
Public methodStatic memberGetDefaultCulture(String)
Get the full name of the default culture.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetMaxAnnouncementDistance
Gets the maximum distance to announce the instruction for the next turn.
(Inherited from Announcer.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodPlay(AnnouncerPlayItem)
Add a PlayItem to the play list.
(Inherited from Announcer.)
Public methodPlay(AnnouncerPlayItem, String) Obsolete.
Add a sound file to a PlayItem.
(Inherited from WaveAnnouncer.)
Public methodSayArrival
Announces arrival at the destination.
(Inherited from Announcer.)
Public methodSayMovement(NavigationEvent, NavigationEvent)
Announce the next (pending) navigation movement to the user.
(Inherited from Announcer.)
Public methodSayMovement(NavigationEvent, NavigationEvent, Boolean)
Announce the next (pending) navigation movement to the user.
(Inherited from Announcer.)
Public methodSetMaxAnnouncementDistance
Sets the maximum distance to announce the instruction for the next turn. If the distance to the next turn is greater than this distance, the driver will simply be told to 'continue'
(Inherited from Announcer.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventBeginPhrase
An event raised when an play item begins playing.
(Inherited from Announcer.)
Public eventBeginSound
An event raised when a sound file begins playing.
(Inherited from Announcer.)
Public eventEndPhrase
An event raised when an play item finishes playing.
(Inherited from Announcer.)
Public eventEndSound
An event raised when a sound file finishes playing.
(Inherited from Announcer.)
Top
Fields
  NameDescription
Public fieldMinTimeBetweenCloseDirections
The minimum time between which consecutive directions are played, if the directions are close (within 200 meters)
(Inherited from Announcer.)
Public fieldMinTimeBetweenDirections
The minimum time between which consecutive directions are played
(Inherited from Announcer.)
Public fieldTimeLastSoundFinished
Records the time that the last announcement finished playing.
(Inherited from Announcer.)
Top
Remarks
See Also