unreal.ScreenReaderAnnouncement

class unreal.ScreenReaderAnnouncement(announcement_string='', announcement_info=[False, True, ScreenReaderAnnouncementPriority.MEDIUM])

Bases: unreal.StructBase

A screen reader announcement represents a localized message that a user wants to speak to an end user. This class is used to request announcements to be spoken to an end user via the FScreenReaderUser class. FScreenReaderUser::RequestSpeak() for instructions on how to use the class. See: FScreenReaderUser

C++ Source:

  • Plugin: ScreenReader

  • Module: ScreenReader

  • File: ScreenReaderAnnouncement.h

Editor Properties: (see get_editor_property/set_editor_property)

  • announcement_info (ScreenReaderAnnouncementInfo): [Read-Write] Announcement Info: The announcement info associated with the announcement which controls how the announcement behaves when a user requests this announcement to be spoken to an end user

  • announcement_string (str): [Read-Write] Announcement String: A localized string that represents the message to be spoken to a end user

property announcement_info

[Read-Write] Announcement Info: The announcement info associated with the announcement which controls how the announcement behaves when a user requests this announcement to be spoken to an end user

Type

(ScreenReaderAnnouncementInfo)

property announcement_string

[Read-Write] Announcement String: A localized string that represents the message to be spoken to a end user

Type

(str)