Class: default
IVSBroadcastClient is a class that allows you to create a broadcast client
Constructors
constructor
• new default()
Properties
BASIC_FULL_HD_LANDSCAPE
▪ Static BASIC_FULL_HD_LANDSCAPE: StreamConfig = BASIC_FULL_HD_LANDSCAPE
BASIC_FULL_HD_PORTRAIT
▪ Static BASIC_FULL_HD_PORTRAIT: StreamConfig = BASIC_FULL_HD_PORTRAIT
BASIC_LANDSCAPE
▪ Static BASIC_LANDSCAPE: StreamConfig = BASIC_LANDSCAPE
BASIC_PORTRAIT
▪ Static BASIC_PORTRAIT: StreamConfig = BASIC_PORTRAIT
BroadcastClientEvents
▪ Static BroadcastClientEvents: Object = BroadcastClientEvents
Type declaration
| Name | Type | Description |
|---|---|---|
ACTIVE_STATE_CHANGE | "activeStateChange" | Indicates that the broadcast start/stop state has changed. param [[boolean]] |
CONNECTION_STATE_CHANGE | "connectionStateChange" | Indicates that the webRTC connection state has changed. param ConnectionState |
ERROR | "clientError" | Indicates that the client has encountered an error. param [[BroadcastClientError]] |
ConnectionState
▪ Static ConnectionState: typeof ConnectionState = ConnectionState
Errors
▪ Static Errors: Errors = Errors
LOG_LEVEL
▪ Static LOG_LEVEL: typeof LogLevels = LogLevels
STANDARD_LANDSCAPE
▪ Static STANDARD_LANDSCAPE: StreamConfig = STANDARD_LANDSCAPE
STANDARD_PORTRAIT
▪ Static STANDARD_PORTRAIT: StreamConfig = STANDARD_PORTRAIT
__version
▪ Static __version: string
Methods
create
▸ Static create(config): AmazonIVSBroadcastClient
Creates an instance of the AmazonIVSBroadcastClient.
Parameters
| Name | Type | Description |
|---|---|---|
config | BroadcastClientConfig | BroadcastClientConfig |
Returns
isSupported
▸ Static isSupported(): boolean
Checks the current environment for broadcast support.
Returns
boolean