TTSMessagePriority

public struct TTSMessagePriority

Defines the priority level and timeout of a text-to-speech message. The purpose is to help manage and prioritize messages in a queue.

These parameters are used to establish both the priority and duration that a message remains in the queue before processing. Lower priority values indicate higher importance. Use this struct to prioritize the processing of critical messages over less important ones, potentially timing out the latter when necessary.

Important

This is a Public Preview API. It may be changed or removed at any time.
  • Initializes the TtsMessagePriority with the priority and the timeout.

    Declaration

    Swift

    public init(priorityLevel: UInt = 0, timeout: TimeInterval)

    Parameters

    priorityLevel

    Defines the importance of the message. Lower value means higher priority. The default value is 0, which means the highest priority.

    timeout

    Specifies the maximum duration a message can remain in the queue. If no value is specified, a default duration is applied.

  • The priority level of the message, where a lower value indicates a higher priority.

    Declaration

    Swift

    public let priorityLevel: UInt
  • The timeout duration, specified in seconds, determines how long a message can remain in the queue.

    Declaration

    Swift

    public let timeout: TimeInterval