AWS.Transcribe.EventStream

Event stream encoding provides bidirectional communication using messages between a client and a server. Data frames sent to the Amazon Transcribe streaming service are encoded in this format. The response from Amazon Transcribe also uses this encoding.

Each message consists of two sections: the prelude and the data. The prelude consists of:

The total byte length of the message

The combined byte length of all of the headers

The data section consists of:

The headers

A payload

Each section ends with a 4-byte big-endian integer CRC checksum. The message CRC checksum is for both the prelude section and the data section. Amazon Transcribe uses CRC32 (often referred to as GZIP CRC32) to calculate both CRCs. For more information about CRC32, see GZIP file format specification version 4.3

.

Total message overhead, including the prelude and both checksums, is 16 bytes.

documentation source: https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html

Documentation

data Message

Constructors

MkMessage

Fields

• _hContentType :: !Header
• _hEventType :: !Header
• _hMessageType :: !Header
• _payload :: !ByteString

Instances

Eq Message

Defined in AWS.Transcribe.EventStream

Methods

(==) :: Message -> Message -> Bool

(/=) :: Message -> Message -> Bool

Show Message

Defined in AWS.Transcribe.EventStream

Methods

showsPrec :: Int -> Message -> ShowS

show :: Message -> String

showList :: [Message] -> ShowS

Binary Message

Defined in AWS.Transcribe.EventStream

Methods

put :: Message -> Put

get :: Get Message

putList :: [Message] -> Put

data Header

Event stram encoding header

Constructors

MkHeader

Fields

• _hNameLength :: !Word8
• _hName :: !Text
• _hValueType :: !Word8
• _hValueStringLength :: !Int16
• _hValueString :: !Text

Instances

Eq Header

Defined in AWS.Transcribe.EventStream

Methods

(==) :: Header -> Header -> Bool

(/=) :: Header -> Header -> Bool

Show Header

Defined in AWS.Transcribe.EventStream

Methods

showsPrec :: Int -> Header -> ShowS

show :: Header -> String

showList :: [Header] -> ShowS

Binary Header

Defined in AWS.Transcribe.EventStream

Methods

put :: Header -> Put

get :: Get Header

putList :: [Header] -> Put

payload :: Lens' Message ByteString

hMessageType :: Lens' Message Header

hEventType :: Lens' Message Header

hContentType :: Lens' Message Header

hValueType :: Lens' Header Word8

hValueStringLength :: Lens' Header Int16

hValueString :: Lens' Header Text

hNameLength :: Lens' Header Word8

hName :: Lens' Header Text

classifyHeaders :: Header -> Header -> Header -> (Header, Header, Header)

tbl :: Message -> Int32

hbl :: Int32

pbl :: Message -> Int32

headerBuilder :: Header -> Builder

getHeader :: Get Header

crcBuilder :: Builder -> Builder

hContentTypeRequest :: Header

hContentTypeRequestBL :: Int32

hEventTypeRequest :: Header

hEventTypeRequestBL :: Int32

hMessageTypeRequest :: Header

hMessageTypeRequestBL :: Int32

requestMessageHeaders :: Builder

mkStreamingMessage :: ByteString -> Message

Make a streaming message, using the default request headers