XmlWaveAnnouncer Class |
Namespace: Telogis.GeoBase.Navigation.Announcements
The XmlWaveAnnouncer type exposes the following members.
Name | Description | |
---|---|---|
XmlWaveAnnouncer |
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.
| |
XmlWaveAnnouncer(String) |
Create an XmlWaveAnnouncer that uses the specified languages directory and a culture
set to CurrentCulture.
| |
XmlWaveAnnouncer(String, CultureInfo) |
Create an XmlWaveAnnouncer that uses the specified sounds directory and culture.
| |
XmlWaveAnnouncer(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.
| |
XmlWaveAnnouncer(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.
|
Name | Description | |
---|---|---|
BellEnabled |
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.) | |
IsAnnouncementScheduled |
Returns whether or not AnnouncerPlayItem is scheduled.
(Inherited from Announcer.) | |
LongWay | 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.) | |
Units |
The unit system to use in announcing the directions.
(Inherited from Announcer.) | |
Volume |
Gets or sets the volume at which announcements are played.
(Inherited from WaveAnnouncer.) |
Name | Description | |
---|---|---|
AbortPlay |
Allow the currently playing phrase to finish, then abort the announcement.
(Inherited from Announcer.) | |
Bell |
Play a 'bell' sound.
(Overrides AnnouncerBell.) | |
Click |
Play a 'click' sound.
(Overrides AnnouncerClick.) | |
CreatePlayItem(String) |
Create a PlayItem from a sound file, or a series of sound files located in the
default langs folder.
(Inherited from WaveAnnouncer.) | |
CreatePlayItem(String, String) |
Create a PlayItem from a sound file, or a series of sound files.
(Inherited from WaveAnnouncer.) | |
CreatePlayItem(String, String, Object) |
Generate a PlayItem from a Phrase tag within a Phrases node.
| |
Dispose |
Disposes of the announcement or sound.
(Inherited from Announcer.) | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
GetAvailableCultures |
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.
| |
GetAvailableCultures(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".
| |
GetDefaultCulture |
Get the full name of the default culture. The sounds directory used is the default
"langs" directory in the GeoBase system's
data path.
| |
GetDefaultCulture(String) |
Get the full name of the default culture.
| |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetMaxAnnouncementDistance |
Gets the maximum distance to announce the instruction for the next turn.
(Inherited from Announcer.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
Play(AnnouncerPlayItem) |
Add a PlayItem to the play list.
(Inherited from Announcer.) | |
Play(AnnouncerPlayItem, String) | Obsolete.
Add a sound file to a PlayItem.
(Inherited from WaveAnnouncer.) | |
SayArrival |
Announces arrival at the destination.
(Inherited from Announcer.) | |
SayMovement(NavigationEvent, NavigationEvent) |
Announce the next (pending) navigation movement to the user.
(Inherited from Announcer.) | |
SayMovement(NavigationEvent, NavigationEvent, Boolean) |
Announce the next (pending) navigation movement to the user.
(Inherited from Announcer.) | |
SetMaxAnnouncementDistance |
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.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Name | Description | |
---|---|---|
BeginPhrase |
An event raised when an play item begins playing.
(Inherited from Announcer.) | |
BeginSound |
An event raised when a sound file begins playing.
(Inherited from Announcer.) | |
EndPhrase |
An event raised when an play item finishes playing.
(Inherited from Announcer.) | |
EndSound |
An event raised when a sound file finishes playing.
(Inherited from Announcer.) |
Name | Description | |
---|---|---|
MinTimeBetweenCloseDirections |
The minimum time between which consecutive directions are played, if the directions are close (within 200 meters)
(Inherited from Announcer.) | |
MinTimeBetweenDirections |
The minimum time between which consecutive directions are played
(Inherited from Announcer.) | |
TimeLastSoundFinished |
Records the time that the last announcement finished playing.
(Inherited from Announcer.) |
Related articles: Using an XmlWaveAnnouncer, Using Languages and Cultures.