Our new developer documentation is now available. Please check it out!
Classes
The Unity SDK consists of these classes:
Unity Components
You typically interact with these components directly in the Unity Editor. Check out the manual on how to use these components in the Unity editor.
| Component | Description |
|---|---|
| MicrophoneReader | Handles microphone input data and sends input to ODIN |
| OdinBanner | |
| OdinEditorConfig | UnityEditor UI component for instance config of Odin |
| OdinHandler | The OdinHandler class is the global ODIN manager within Unity. It’s built as a singleton. Create an empty game object in your scene and add this script to it. OdinHandler uses DontDestroyOnLoad to keep the singleton alive even if the scene changes. |
| PlaybackComponent | Handles the Playback for received ODIN audio data. |
| PlaybackStats |
Utility Classes
Many of these classes are used internally or you rarely need to work with these.
| Component | Description |
|---|---|
| ConnectionStateChangedEventArgs | Arguments for ConnectionStateChanged events in the current room |
| ConnectionStateChangedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| MediaActiveStateChangedEventArgs | Arguments for MediaActiveStateChanged events in the current room |
| MediaActiveStateChangedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| MediaAddedEventArgs | Arguments for MediaAdded events in the current room |
| MediaAddedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| MediaCollection | Internal collection of available media streams |
| MediaRemovedEventArgs | Arguments for MediaRemoved events in the current room |
| MediaRemovedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| MediaStream | Base stream |
| MessageReceivedEventArgs | Arguments for MessageReceived events in the current room |
| MessageReceivedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| MicrophoneStream | Representation of a write only audio stream |
| NativeBindings | C# bindings for the native ODIN runtime |
| OdinClient | Client Wrapper for ODIN ffi OdinLibrary |
| OdinDefaults | ODIN default configuration |
| OdinException | Exception type for the native ODIN runtime |
| OdinLibrary | Main lib entry class |
| OdinLibraryParameters | A set of values that are used when initializing the native ODIN runtime |
| OdinMediaConfig | ODIN audio stream configuration |
| OdinRoomConfig | Audio processing configuration of an ODIN room |
| Peer | Client/Remote peer |
| PeerCollection | Intern peer dictionary |
| PeerJoinedEventArgs | Arguments for PeerJoined events in the current room |
| PeerJoinedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| PeerLeftEventArgs | Arguments for PeerLeft events in the current room |
| PeerLeftProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| PeerUserDataChangedEventArgs | Arguments for PeerUserDataChanged events in the current room |
| PeerUserDataChangedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| PlaybackStream | Representation of a read only audio stream |
| Room | Main Room |
| RoomCollection | Intern room dictionary |
| RoomConfig | A set of values that are used when creating Rooms |
| RoomJoinEventArgs | Arguments for RoomJoin events right before the room is joined |
| RoomJoinProxy | This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. |
| RoomJoinedEventArgs | Arguments for RoomJoined events when the room was joined successfully |
| RoomJoinedProxy | This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. |
| RoomLeaveEventArgs | Arguments for RoomLeave events right before the room handle is destroyed |
| RoomLeaveProxy | This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. |
| RoomLeftEventArgs | Arguments for RoomLeft events when the room handle was destroyed |
| RoomLeftProxy | This class provides the base functionality for ODIN SDK UnityEvents. A persistent callback that can be saved with the Scene. |
| RoomUserDataChangedEventArgs | Arguments for RoomUserDataChanged events in the current room |
| RoomUserDataChangedProxy | This class provides the base functionality for UnityEvents based Room. A persistent callback that can be saved with the Scene. Unity Inspector event wrapper (UnityEvent) |
| UnityCreatedMediaObject | |
| UnityDeleteMediaObject | Unity Inspector event wrapper (UnityEvent) |
| UserData | Odin UserData helper for marshal byte arrays |
| Utility |