Appearance
API Reference
EaseLive
Configurable props
easeLiveConfig
Sets the program to load in the EaseLive overlay
| Attribute | Description | Type | Required |
|---|---|---|---|
| accountId | Account ID | String | Required |
| projectId | Project ID | String | Optional. If not set, it will load the project the program belongs to |
| programId | Program ID | String | Required |
| env | Which environment to load. "prod", "staging" or "dev". Defaults to "prod" | String | Optional |
| params | Parameters to the Ease Live web app | Object | Optional |
playerControlsVisible
Sends a message to EaseLive when the visibility of player controls changed. value: true if visible, false if hidden
playerTime
Sends a message to EaseLive with the timecode of the current playback position when it is read from the player.
This event should be set when the player reads the timecode of the current playback position. The timecode should be milliseconds since 1970-01-01T00:00:00Z.
value: The current timecode as UTC milliseconds
playerState
Sends a message to EaseLive with the current player state when the state changes in player value: The new player state: 'playing', 'paused', 'stopped', 'seeking', 'buffering'
playerSpeed
Sends a message to EaseLive with the current playback speed value: Speed at which the media is playing, 0 stopped, 1.0 normal speed, other values slowed down or sped up
playerVolume
Sends a message to EaseLive with the current audio volume value: The current audio volume. 0 - 100
playerVideoScale
Sends a message to EaseLive with the current size of the video relative to its original size
| Value | Description | Type | Required |
|---|---|---|---|
| scaleX | Horizontal scale factor, between 0 and 1. | Float | Required |
| scaleY | Vertical scale factor, between 0 and 1. | Float | Required |
| pivotX | Horizontal anchor for the scaling animation, between 0 and 1. | Float | Required |
| pivotY | Vertical anchor of the scaling animation, between 0 and 1. | Float | Required |
| duration | Duration of the scale animation in milliseconds. | Integer | Required |
Events
onEaseLiveReady
Overlay loaded successfully
onEaseLiveError
Error when loading overlay Payload:
| Value | Description | Type | Required |
|---|---|---|---|
| level | 'fatal' or 'warning' | String | Required |
| description | Error message | String | Required |
| code | Error code | Integer | Required |
| component | String | Optional | |
| programId | String | Optional |
onEaseLiveStatus
Called when the producer has changed status of the overlay. If the status is disabled the EaseLive instance can be removed.
| Value | Description | Type | Required |
|---|---|---|---|
| status | 'disabled', 'hidden' or 'enabled' | String | Required |
onEaseLiveMessage
Received custom message
| Value | Description | Type | Required |
|---|---|---|---|
| json | JSON formatted string | String | Required |
onPlayerControls
Called when the overlay UI sends an event to change the player controls visibility.
| Value | Description | Type | Required |
|---|---|---|---|
| visible | Visible or hidden | Boolean | Required |
onPlayerTime
Called when the overlay UI sends an event to seek to a player position. The timecode is milliseconds since 1970-01-01T00:00:00Z.
| Value | Description | Type | Required |
|---|---|---|---|
| timecode | UTC timecode for the wanted seek position | Integer | Required |
onPlayerState
Called when the overlay UI sends an event to set the player state. "state" is one of "playing", "paused", "stopped", "seeking" and "buffering".
| Value | Description | Type | Required |
|---|---|---|---|
| state | The new player state | String | Required |
onPlayerSpeed
Called when the overlay UI sends an event to set the playback speed.
| Value | Description | Type | Required |
|---|---|---|---|
| speed | A playback speed factor greater than 0 | Float | Required |
onPlayerVolume
Called when the overlay UI sends an event to set the audio volume.
| Value | Description | Type | Required |
|---|---|---|---|
| volume | The volume to set between 0 and 100 | Integer | Required |
onPlayerMute
Called when the overlay UI sends an event to set the audio mute status.
| Value | Description | Type | Required |
|---|---|---|---|
| mute | The mute status, true or false | Boolean | Required |
onPlayerVideoScale
Called when the overlay UI sends an event to change the video scale and position.
| Value | Description | Type | Required |
|---|---|---|---|
| scaleX | Horizontal scale factor, between 0 and 1. | Float | Required |
| scaleY | Vertical scale factor, between 0 and 1. | Float | Required |
| pivotX | Horizontal anchor for the scaling animation, between 0 and 1. | Float | Required |
| pivotY | Vertical anchor of the scaling animation, between 0 and 1. | Float | Required |
| duration | Duration of the scale animation in milliseconds. | Integer | Required |
Methods
sendEaseLiveMessage(event, metadata)
Send a custom message to EaseLive overlay.
| Value | Description | Type | Required |
|---|---|---|---|
| event | Event name | String | Required |
| metadata | Metadata about the event | Object | Required |