Releases: microsoft/live-share-sdk
Release v1.4.0
What's Changed
- Improved docs on
LivePresence
by @huntj88 in #755 MediaPlayerSynchronizer
groupaction events now emit ignored actions during suspension, with ignored reason by @huntj88 in #754- Fixed
localUser
inLivePresence
not getting set up properly whencanSendBackgroundUpdates
was false by @huntj88 in #758 - Fix some hooks in React SDK not supporting
uniqueKey
changes by @ryanbliss in #757 - Variable rate playback for
LiveMediaSession
with newsetPlaybackRate
function inMediaPlayerSynchronizer
by @huntj88 in #756
Full Changelog: v1.3.1...v1.4.0
Release v1.3.1
What's Changed
- Add
canSendBackgroundUpdates
check on initial background presence update to prevent sending initial update on.initialize()
when background updates are disabled. - Fixed suspensions not working when
canSendPositionUpdates
is false. - Added
enableBackgroundUpdates
option for each instanceLiveObjectSynchronizer
and refactoredconnect
event fromLiveMediaSession
to useLiveObjectSynchronizer
to reduce redundant signals.
Full Changelog: v1.3.0...v1.3.1
Release v1.3.0
What's Changed
- Renamed
getLiveContainerSchemaProxy
togetLiveContainerSchema
- Overhaul for error messages across the board
- Improved typedocs for some of our APIs
Live Share Media
Full Changelog: v1.2.2...v1.3.0
Release v1.2.2
What's Changed
- Improved errors & typedocs for live-share-react by @ryanbliss in #730
- Fixed
LiveState
andLivePresence
logger bug where success was being marked as error by @ryanbliss in #732 - Release v1.2.2 by @ryanbliss in #733
Full Changelog: v1.2.1...v1.2.2
Release v1.2.1
What's Changed
- Added
canSendPositionUpdates
prop touseMediaSynchronizer
hook by @ryanbliss in #726 - Add
local
andsource
toExtendedMediaSessionActionDetails
for thegroupaction
listener inMediaPlayerSynchronizer
by @ryanbliss in #728 - Updated to v1.2.1 by @ryanbliss in #729
Full Changelog: v1.2.0...v1.2.1
v1.2.0 release
@microsoft/live-share
- Replay events from other clients that existed before registering DDS, which fixes a bug where
LiveState
,LivePresence
, andLiveTimer
may not have correct state when initialized late by @huntj88 in #719 - New
LiveFollowMode
DDS for presenting to everyone & following specific users (beta) by @ryanbliss in #720 - Exposed
getClientInfo
inLiveDataObject
by @huntj88 in #722 canSendBackgroundUpdates
setting inLiveShareClient
/LiveShareRuntime
for efficient signal usage in large meetings by @ryanbliss in #724
Warning
This update changed props of LiveShareRuntime
constructor. This isn't something we expect external developers to use in normal circumstances, but it is technically a public class. If you use this and used some of the optional props in the constructor (non-normative), this will be a breaking change for you. Normally we wouldn't make a breaking change to a public class, but these optional props for the constructor were really only added for our unit tests, and this class is publicly exposed primarily for use in live-share-turbo. But in the off chance this does impact you, we are attaching a guide here for your convenience.
To fix this, change this:
// Create your host, such as AzureLiveShareHost
const host = AzureLiveShareHost.create();
// Create your timestampProvider (optional)
const timestampProvider = new CustomTimestampProvider();
// Create your role verifier (optional)
const roleVerifier = new CustomRoleVerifier();
// Create the LiveShareRuntime
const runtime = new LiveShareRuntime(this._host, timestampProvider, roleVerifier);
To this:
// Create your host, such as AzureLiveShareHost
const host = AzureLiveShareHost.create();
// Create your options (optional)
const options = {
timestampProvider: new CustomTimestampProvider(),
roleVerifier: new CustomRoleVerifier(),
};
// Create the LiveShareRuntime
const runtime = new LiveShareRuntime(this._host, options);
@microsoft/live-share-react
- New
useLiveFollowMode
hook by @ryanbliss in #720
@microsoft/live-share-turbo
- Cache dynamic DDS in memory so that multiple calls to
getDDS
do not return different instances by @ryanbliss in #718
Full Changelog: v1.1.0...v1.2.0
v1.1.0 release
What's Changed
- Added flag to disable sending position updates for
LiveMediaSession
by @huntj88 in #708 - Handle Android bug by checking types instead of keys by @huntj88 in #716
- Expose clientId in ExtendedMediaSessionActionDetails for LiveMediaSession by @huntj88 in #715
- v1.1.0 release by @ryanbliss in #717
Full Changelog: v1.0.2...v1.1.0
v1.0.2 release
This update includes a critical bug fix for Android devices, which was causing role verification and LivePresence
to fail in some cases. If you are running into any issues, please update immediately.
What's Changed
- Removed role check on unrestricted scope in media by @ryanbliss in #646
- Fixed local user being able to draw on canvas without correct role by @huntj88 in #677
- Fixed Media syncing when pause event is emitted by a player immediately before ended by @huntj88 in #672
- Fixed getClientInfo receiving wrong format from android by @huntj88 in #705
- Release for v1.0.2 and v1.0.2-preview.1 by @ryanbliss in #706
Full Changelog: v1.0.1...v1.0.2
v1.0.1 release
What's Changed
This is a minor patch release with bug fixes and additional flexibility.
live-share-media (1.0.1)
- Fixed MediaPlayerSynchronizer returning incorrect metadata by @huntj88 in #620
- Created new and fixed existing live-share-media unit tests by @huntj88 in #611
live-share-react (1.0.1-preview.1)
- Fixed generic types for Live Share React hooks by @ryanbliss in #618
- useMediaSynchronizer more flexible mediaPlayerElement types by @ryanbliss in #619
Full Changelog: v1.0.0...v1.0.1
v1.0.0 release - Live Share is generally available!
What's changed
Live Share is officially generally available! This means Microsoft can now recommend for production scenarios. We have published the v1.0.0 version of @microsoft/live-share
, @microsoft/live-share-media
, and @microsoft/live-share-canvas
to npm. Since we use semantic versioning, this means that we are committed to no breaking changes to our interfaces until our next major release (2.0.0).
Our general availability comes with the following officially supported LiveDataObject
classes:
LivePresence
LiveState
LiveTimer
LiveEvent
LiveMediaSession
LiveCanvas
For those still using our Preview versions of the SDK, please refer to previous release notes for guides on how to upgrade. A lot of APIs were renamed, removed, or reworked (for example, updatePresence
was renamed to update
in LivePresence
, and now returns Promise<void>
instead of void
). If you need any help, feel free to ask us questions in our discussion board.
Our general availability has been a long time coming, and we're so excited to see what apps you release in the coming months.
Changes from this release (compared to preview.23
)
userId
,clientId
,state
, anddata
were replaced with alocalUser
getter inLivePresence
.- We have updated our license to reflect our general availability.
Known issues
- When using the
teams-js
LiveShareHost
,LivePresenceUser
'sdisplayName
field will currently show as undefined. This will change in the next week or two once the Teams desktop client completes its May rollout. - Similar to above, the
userId
ofLivePresenceUser
will temporarily be equal toclientId
. This will be replaced with a realuserId
once the Teams desktop client completes its May rollout. Guest
users in calendar & meet now meetings (aka "anonymous" users) will not be supported until the Teams desktop client completes its May rollout.Guest
users in channel meetings are not yet supported.- Like other Teams platform capabilities, Live Share does not yet support "the new Teams", with availability planned for later this summer.
Live Share Turbo and React previews
While the three packages mentioned above are generally available, live-share-turbo
and live-share-react
remain in preview. Those are published as as version 1.0.0-preview.24
. We will keep the minor versions in sync with the core SDK versions (e.g., 1.0.1
of live-share
will be released as 1.0.1-preview.1
of live-share-react
). We hope to make those packages generally available in the coming months, so please give it a try and let us know what you think!
Commits since last release notes
- Added command to test for race conditions by @huntj88 in #586
- Sample updates 5.12 by @ryanbliss in #576
- Release 1.0.0 preview.17 by @ryanbliss in #589
- Release v1.0.0 preview.23 by @ryanbliss in #593
- readme updates by @ryanbliss in #599
- Updated README with workaround for tinylicious error by @ryanbliss in #604
- updated IReceiveLiveEvent response by @ryanbliss in #606
- Updated license for production by @ryanbliss in #605
- Dependency updgrades by @ryanbliss in #607
- Changed how local information is exposed in LivePresence by @huntj88 in #608
- Release v1.0.0 by @ryanbliss in #609
Full Changelog: v1.0.0-preview.15...v1.0.0