Skip to main content
Version: v1.15.0

Variable: BroadcastClientEvents

const BroadcastClientEvents: object

An enumeration describing the events emitted from the AmazonIVSBroadcastClient.

Type declaration

ACTIVE_STATE_CHANGE

readonly ACTIVE_STATE_CHANGE: "activeStateChange" = 'activeStateChange'

Indicates that the broadcast start/stop state has changed.

Param

[[boolean]] activeStateChanged

CONNECTION_STATE_CHANGE

readonly CONNECTION_STATE_CHANGE: "connectionStateChange" = 'connectionStateChange'

Indicates that the webRTC connection state has changed.

Param

[[ConnectionState]] connectionStateChange

ERROR

readonly ERROR: "clientError" = 'clientError'

Indicates that the client has encountered an error.

Param

[[BroadcastClientError]] clientError