> For the complete documentation index, see [llms.txt](https://kinematicsoup.gitbook.io/scene-fusion/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kinematicsoup.gitbook.io/scene-fusion/api-reference/ks.scenefusion.client.md).

# KS.SceneFusion.Client

### Namespaces

[KS.SceneFusion.Client.Unity](/scene-fusion/api-reference/ks.scenefusion.client.unity.md)

### Classes

[sfAnalytics.Events](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfanalytics/ks.scenefusion.client.sfanalytics.events.md)

Analytics events

[FrameRPCData](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.framerpcdata.md)

Holds RPC data for a server frame.

[sfAnalytics](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfanalytics.md)

Scene Fusion analytics class for sending Scene Fusion analytics events. This is intended for internal use only.

[sfBasePropertyExtension](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfbasepropertyextension.md)

Provides client-side extension methods for sfBaseProperty

[sfBaseService](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfbaseservice.md)

Base class for the Scene Fusion service from which authenticated and unauthenticated variants are derived. Provides methods for joining, leaving, starting, and stopping LAN sessions.

[sfObject](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfobject.md)

Objects are synced between server and clients. Objects have an id, a user-defined string type, and a property which may be a collection of properties. Objects are arranged in a hierarchy and can be locked by users. When objects are constructed they are not automatically synced. To begin syncing an object, call sfSession.Create(sfObject).

[sfPackageInfo](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfpackageinfo.md)

[sfProjectInfo](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfprojectinfo.md)

Project name and sessions.

[sfPropertyChangeData](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfpropertychangedata.md)

Contain property data before it is sent to a server

[sfPropertyChangePath](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfpropertychangepath.md)

Class that wraps a ksMultiType property path so it can be used in maps and hashsets.

[sfService](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfservice.md)

Scene Fusion service. Provides methods for authenticating, retrieving, joining, leaving, starting, and stopping sessions.

[sfSession](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession.md)

Provides functions for accessing and manipulating synced objects and session data for a Scene Fusion session.

[sfSessionInfo](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsessioninfo.md)

Session data that is available without connecting to a room. Consists of room info and scene creator.

[sfUIUserInfo](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfuiuserinfo.md)

User info.

[sfUser](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfuser.md)

A user who is connected to the session.

[sfUtils](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfutils.md)

Utility functions.

[sfWebServiceCallbacks](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfwebservicecallbacks.md)

Web service callback delegates

### Structs

[RPCData](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.rpcdata.md)

Data for an RPC.

### Interfaces

[sfIActivityIndicator](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfiactivityindicator.md)

Activity indicator interface

[sfILocalSession](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfilocalsession.md)

Local session interface.

[sfIWebService](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfiwebservice.md)

Interface for communicating with the CoEdit web service.

### Enums

[sfWebServiceCallbacks.ResultType](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfwebservicecallbacks/ks.scenefusion.client.sfwebservicecallbacks.resulttype.md)

Result types

[sfBaseService.UserInfoChangeType](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfbaseservice/ks.scenefusion.client.sfbaseservice.userinfochangetype.md)

User info change type.

### Delegates

[sfSession.AddReferenceHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.addreferencehandler.md)

Add reference event handler.

[sfSession.ConfirmCreateHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.confirmcreatehandler.md)

Confirm create event handler.

[sfSession.ConfirmDeleteHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.confirmdeletehandler.md)

Confirm delete event handler.

[sfSession.ConfirmSubscriptionHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.confirmsubscriptionhandler.md)

Confirm subscription event handler.

[sfBaseService.ConnectHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfbaseservice/ks.scenefusion.client.sfbaseservice.connecthandler.md)

Connect event handler.

[sfSession.CreateHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.createhandler.md)

Create event handler.

[sfSession.DeleteHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.deletehandler.md)

Delete event handler.

[sfSession.DirectLockChangeHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.directlockchangehandler.md)

Direct lock change event handler.

[sfBaseService.DisconnectHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfbaseservice/ks.scenefusion.client.sfbaseservice.disconnecthandler.md)

Disconnect event handler.

[sfWebServiceCallbacks.DownloadLANServer](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfwebservicecallbacks/ks.scenefusion.client.sfwebservicecallbacks.downloadlanserver.md)

Callback for downloading a SF LAN server

[sfWebServiceCallbacks.GetFeedbackQuestions](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfwebservicecallbacks/ks.scenefusion.client.sfwebservicecallbacks.getfeedbackquestions.md)

Callback for get feedback questions.

[sfWebServiceCallbacks.GetSessions](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfwebservicecallbacks/ks.scenefusion.client.sfwebservicecallbacks.getsessions.md)

Callback for get sessions requests.

[sfSession.ListAddHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.listaddhandler.md)

List add event handler.

[sfSession.ListRemoveHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.listremovehandler.md)

List remove event handler.

[sfSession.LockHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.lockhandler.md)

Lock event handler.

[sfSession.LockOwnerChangeHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.lockownerchangehandler.md)

Lock owner change event handler.

[sfWebServiceCallbacks.LogResults](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfwebservicecallbacks/ks.scenefusion.client.sfwebservicecallbacks.logresults.md)

Callback for sending unity log information

[sfWebServiceCallbacks.Login](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfwebservicecallbacks/ks.scenefusion.client.sfwebservicecallbacks.login.md)

Callback for login requests.

[sfService.LogoutHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfservice/ks.scenefusion.client.sfservice.logouthandler.md)

Logout event handler.

[sfSession.ParentChangeHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.parentchangehandler.md)

Parent change event handler.

[sfSession.PostProcessFrameHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.postprocessframehandler.md)

Post process frame handler.

[sfBaseService.PreConnectHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfbaseservice/ks.scenefusion.client.sfbaseservice.preconnecthandler.md)

Pre connect event handler.

[sfSession.PropertyChangeHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.propertychangehandler.md)

Property change event handler.

[sfSession.RemoveFieldHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.removefieldhandler.md)

Remove field event handler.

[sfSession.RemoveReferenceHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.removereferencehandler.md)

Remove reference event handler.

[sfWebServiceCallbacks.SetUserColor](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfwebservicecallbacks/ks.scenefusion.client.sfwebservicecallbacks.setusercolor.md)

Callback for SerUserColor function.

[sfILocalSession.StartCallback](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfilocalsession/ks.scenefusion.client.sfilocalsession.startcallback.md)

Callback to call when the local server starts or fails to start.

[sfWebServiceCallbacks.StartSession](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfwebservicecallbacks/ks.scenefusion.client.sfwebservicecallbacks.startsession.md)

Callback for start session requests.

[sfWebServiceCallbacks.StopSession](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfwebservicecallbacks/ks.scenefusion.client.sfwebservicecallbacks.stopsession.md)

Callback for stop session requests.

[sfSession.UnlockHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.unlockhandler.md)

Unlock event handler.

[sfSession.UserColorChangeHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.usercolorchangehandler.md)

User color change event handler.

[sfBaseService.UserInfoChangeCallback](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfbaseservice/ks.scenefusion.client.sfbaseservice.userinfochangecallback.md)

User info change callback.

[sfSession.UserJoinHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.userjoinhandler.md)

User join event handler.

[sfSession.UserLeaveHandler](/scene-fusion/api-reference/ks.scenefusion.client/ks.scenefusion.client.sfsession/ks.scenefusion.client.sfsession.userleavehandler.md)

User leave event handler.