Class SiriAudioSession

Represents an ongoing audio transmission

Hierarchy

EventEmitter
- SiriAudioSession

Index

Constructors

Properties

connection endOfStream streamId?

Methods

emit handleDataSendAckEvent handleDataSendCloseEvent isClosing on start stop

Constructors

constructor

new SiriAudioSession(connection: DataStreamConnection, selectedAudioConfiguration: AudioCodecConfiguration, producerConstructor: SiriAudioStreamProducerConstructor, producerOptions?: any): SiriAudioSession
Parameters
- connection: DataStreamConnection
- selectedAudioConfiguration: AudioCodecConfiguration
- producerConstructor: SiriAudioStreamProducerConstructor
- Optional producerOptions: any
Returns SiriAudioSession
- Defined in lib/controller/RemoteController.ts:1443

Properties

`Readonly` connection

connection: DataStreamConnection

endOfStream

endOfStream: boolean = false

`Optional` streamId

streamId?: number

Methods

emit

emit(event: "close"): boolean
Parameters
- event: "close"
Returns boolean
- Defined in lib/controller/RemoteController.ts:1415

handleDataSendAckEvent

handleDataSendAckEvent(endOfStream: boolean): void
Parameters
- endOfStream: boolean
Returns void
- Defined in lib/controller/RemoteController.ts:1612

handleDataSendCloseEvent

handleDataSendCloseEvent(reason: HDSProtocolSpecificErrorReason): void
Parameters
- reason: HDSProtocolSpecificErrorReason
Returns void
- Defined in lib/controller/RemoteController.ts:1620

isClosing

isClosing(): boolean
Returns
if the audio session is closing

Returns boolean
- Defined in lib/controller/RemoteController.ts:1502

on

on(event: "close", listener: (() => void)): SiriAudioSession
Parameters
- event: "close"
- listener: (() => void)
  - - (): void
    - Returns void
Returns SiriAudioSession
- Defined in lib/controller/RemoteController.ts:1413

start

start(): void
Called when siri button is pressed

Returns void
- Defined in lib/controller/RemoteController.ts:1462

stop

stop(): void
Called when siri button is released (or active identifier is changed to another device)

Returns void
- Defined in lib/controller/RemoteController.ts:1509