Release Notes for LiveSwitch Server v1.16

1.16.0.18248

Release date: June 22, 2022

Client SDK

New Features
  • [LS1-1015] Added RtmpLayoutZones which has static properties that return the zone names for the RTMP layout.
  • [LS1-1026] LayoutZone and LayoutPriority can now be set on the Connection object prior to calling connection.Open() to specify where in the MCU layout the upstream connection should be displayed.
Bug Fixes
  • [LS1-532] Fixed a bug in the JavaScript client which prevented projects using webpack and depending on fm.liveswitch from building.
  • [LS1-938] An app built using the iOS SDK could crash when the app was sent to the background. This issue has been fixed and the app will no longer crash when sent to the background.

Gateway

New Features
  • [LS1-609] Added content-type attributes for recording endpoints that return plain text.
Bug Fixes
  • [LS1-1016] Fixed a bug where the Site Initialization API call always returned the 204 Success response regardless of the site initialization status.
Breaking Changes
  • [LS1-551] The following ConnectionRecording endpoints have been deprecated:
    • applications/{applicationId}/user/{userId}/connectionRecordings
    • applications/{applicationId}/user/{userId}/device/{deviceId}/connectionRecordings
    • applications/{applicationId}/user/{userId}/device/{deviceId}/client/{clientId}/connectionRecordings
    • applications/{applicationId}/channels/{channelId}/connectionRecordings
    • applications/{applicationId}/channels/{channelId}/user/{userId}/connectionRecordings
    • applications/{applicationId}/channels/{channelId}/user/{userId}/device/{deviceId}/connectionRecordings
    • applications/{applicationId}/channels/{channelId}/user/{userId}/device/{deviceId}/client/{clientId}/connectionRecordings
    • applications/{applicationId}/channels/{channelId}/user/{userId}/device/{deviceId}/client/{clientId}/connection/{connectionId}/connectionRecordings
    • applications/{applicationId}/channels/{channelId}/user/{userId}/device/{deviceId}/client/{clientId}/connection/{connectionId}/connectionRecordings/{connectionRecordingId}
    • applications/{applicationId}/channels/{channelId}/user/{userId}/device/{deviceId}/client/{clientId}/connection/{connectionId}/connectionRecordings/{connectionRecordingId}/json
    • applications/{applicationId}/channels/{channelId}/channelRecordings/{channelRecordingId}/connectionRecordings
    • applications/{applicationId}/channels/{channelId}/channelRecordings/{channelRecordingId}/user/{userId}/connectionRecordings
    • applications/{applicationId}/channels/{channelId}/channelRecordings/{channelRecordingId}/user/{userId}/device/{deviceId}/connectionRecordings
    • applications/{applicationId}/channels/{channelId}/channelRecordings/{channelRecordingId}/user/{userId}/device/{deviceId}/client/{clientId}/connectionRecordings
    • applications/{applicationId}/channels/{channelId}/channelRecordings/{channelRecordingId}/user/{userId}/device/{deviceId}/client/{clientId}/connection/{connectionId}/connectionRecordings
    • applications/{applicationId}/channels/{channelId}/user/{userId}/device/{deviceId}/client/{clientId}/connection/{connectionId}/connectionRecordings/{connectionRecordingId}/audioUrl
    • applications/{applicationId}/channels/{channelId}/user/{userId}/device/{deviceId}/client/{clientId}/connection/{connectionId}/connectionRecordings/{connectionRecordingId}/videoUrl

Media Server

Bug Fixes
  • [LS1-746] Clients connecting to remote clients with poor-performing networks have had their audio/video bitrates reduced, causing remote clients on suitable networks to receive low-quality audio/video. Now the bitrates won't be reduced, and remote clients on good-performing networks will receive the appropriate quality audio/video.
  • [LS1-747] Fixed bug where the ConnectionTag wasn't available in custom layouts for upstream connections proxied from other media servers.
  • [LS1-1032] Ordering of Inputs in custom MCU layouts was unpredictable. Added CreatedOn property to Inputs of custom MCU layouts. CreatedOn will be the time (in ticks) that the input was added to the mixer.
  • [LS1-1055] When RTMP was configured with a service that allowed an RTMP connection but failed to send any frames, then excessive logging occurred. If frames fail to send over RTMP, the DEBUG log level will be used instead of the ERROR log level.

LiveSwitch Console

Breaking Changes
  • [LS1-853] Deprecated the Reporting Interval feature from the Deployments page on LiveSwitch Console.

Recording

New Features
  • [LS1-388] Added two new DeploymentConfig parameters, RecordingManagement.FilterPayload and RecordingManagement.FilterPayloadUrls, to remove unnecessary data from the payload in the ChannelRecording and ConnectionRecording webhook events and REST APIs.
  • [LS1-557] Added a new recording webhook event connection.recordings.ready which is sent when all recordings for a session are ready.
Improvements
  • [LS1-410] The /RecordingMover and /RecordingMuxer REST API endpoints will now return a lastUsedTime value, showing the Unix timestamp of the time the last job finished.
  • [LS1-551] Updated the connection recording REST API to allow using optional query parameters to filter connection recordings by channelId, userId, deviceId, clientId, channelRecordingId, or connectionId.
  • [LS1-806] Updated the Recording Muxer with a new algorithm that fixes numerous issues with the muxed output and improves the time for the muxing to complete. This new algorithm changes the layout of the output and also no longer uses any of the following recording mux settings: Layout, Custom Layout Function, Margin, Dynamic, and Crop. These settings have been removed from the LiveSwitch Console. The old muxing algorithm is still available by setting UseLegacyMuxer = true in the Media Server-specific configuration.
Bug Fixes
  • [LS1-615] Inaccurate recording search results were observed when filtering recordings by muxed on LiveSwitch Console. Updated the ChannelRecordings endpoints to be filterable by whether the channel recordings have completed muxing.
  • [LS1-1047] Each Recording Mover and Muxer will only have one job pushed to it at a time. This will ensure that all servers are fully utilized and will also allow for auto-scaling strategies to increase throughput.
Breaking Changes
  • [LS1-893] Deprecated the Recording Mux parameters including codecs, containers, custom layouts, crop, and margin.