RealtimeMessageAckAudio¶

class oci.ai_speech.models.RealtimeMessageAckAudio(**kwargs)¶

Bases: oci.ai_speech.models.realtime_message.RealtimeMessage

The websocket ack message received from service.

Attributes

`EVENT_ACKAUDIO`	str(object=’’) -> str
`EVENT_CONNECT`	str(object=’’) -> str
`EVENT_ERROR`	str(object=’’) -> str
`EVENT_RESULT`	str(object=’’) -> str
`details`	[Required] Gets the details of this RealtimeMessageAckAudio.
`event`	[Required] Gets the event of this RealtimeMessage.
`session_id`	Gets the session_id of this RealtimeMessage.

Methods

`__init__`(**kwargs)	Initializes a new RealtimeMessageAckAudio object with values from keyword arguments.
`get_subtype`(object_dictionary)	Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

EVENT_ACKAUDIO = 'ACKAUDIO'¶

EVENT_CONNECT = 'CONNECT'¶

EVENT_ERROR = 'ERROR'¶

EVENT_RESULT = 'RESULT'¶

__init__(**kwargs)¶

Initializes a new RealtimeMessageAckAudio object with values from keyword arguments. The default value of the event attribute of this class is ACKAUDIO and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

event (str) – The value to assign to the event property of this RealtimeMessageAckAudio. Allowed values for this property are: “RESULT”, “ACKAUDIO”, “ERROR”, “CONNECT”
session_id (str) – The value to assign to the session_id property of this RealtimeMessageAckAudio.
details (oci.ai_speech.models.RealtimeMessageAckAudioDetails) – The value to assign to the details property of this RealtimeMessageAckAudio.

details¶

[Required] Gets the details of this RealtimeMessageAckAudio.

Returns:	The details of this RealtimeMessageAckAudio.
Return type:	oci.ai_speech.models.RealtimeMessageAckAudioDetails

event¶

[Required] Gets the event of this RealtimeMessage. Incoming Types of message event sent from Service -> Client - RESULT - result - ACKAUDIO - ackAudio - ERROR - error - CONNECT - connect Outgoing Types of message event sent from Client -> Service - SEND_FINAL_RESULT - sendFinalResult

Allowed values for this property are: “RESULT”, “ACKAUDIO”, “ERROR”, “CONNECT”

Returns:	The event of this RealtimeMessage.
Return type:	str

static get_subtype(object_dictionary)¶: Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

session_id¶

Gets the session_id of this RealtimeMessage. Session ID for the connected session.

Returns:	The session_id of this RealtimeMessage.
Return type:	str